Condition Objects – API Help Center

Related Entities

Endpoints Using the Condition Objects

Activity Rule Resource

Parent Objects

Activity Rule Object

Condition Objects Definition

Note

Note: The Required column includes the following values:

Required: The field must be included in the POST call.
Read-only: The field is received in the GET call and required in the PUT call. It is not required in the POST call. You cannot edit this field.
Optional: If the field was received in the GET call, include it in the PUT call. This field is editable.
Internal: (For Amazon Ad Server (AAS) internal use) If the field was received in the GET call, include it in the PUT call.

NAME	DESCRIPTION	TYPE	REQUIRED	NOTES
type	Type of entity.	String	Required	View values PageUrlInnerCondition ReferralUrlInnerCondition VariableInnerCondition ClickedElementInnerCondition CurrentUserPageViewInnerCondition UserPageViewDuringSessionInnerCondition UserBrowsingHistoryInnerCondition
criteriaType	Entries that comprise the condition part of an activity rule.	String	Required	View values PageURL ReferralURL ClickedElement UserPageViewDuringSession CurrentUserPageView UserBrowsingHistory Variable
orConditions	Contains the type of entity, the operator used, and the value for the condition.	orConditions Object	Required

Object JSON Example

"conditions": [{
        "type": "PageUrlCondition",
        "criteriaType": "PageURL",
        "orConditions": [{
            "type": "PageUrlInnerCondition",
            "operator": "ContainsOneOfTheFollowing",
            "values": [
                "contains"
            ]
        }]
    },
    {
        "type": "PageUrlCondition",
        "criteriaType": "PageURL",
        "orConditions": [{
            "type": "PageUrlInnerCondition",
            "operator": "DoesNotContainOneOfTheFollowing",
            "values": [
                "notcontains"
            ]
        }]
    },
    {
        "type": "ReferralUrlCondition",
        "criteriaType": "ReferralURL",
        "orConditions": [{
            "type": "ReferralUrlInnerCondition",

            "operator": "EqualsOneOfTheFollowing",
            "values": [
                "http://www.google.com"
            ]
        }]
    },
    {
        "type": "ClickedElementCondition",
        "criteriaType": "ClickedElement",
        "orConditions": [{
            "type": "ClickedElementInnerCondition",
            "operator": "MatchesOneOfTheFollowingCSSselectors",
            "values": [
                "div"
            ]
        }]
    },
    {
        "type": "UserPageViewDuringSessionCondition",
        "criteriaType": "UserPageViewDuringSession",
        "orConditions": [{
            "type": "UserPageViewDuringSessionInnerCondition",
            "operator": "Equals",
            "values": [
                7
            ]
        }]
    },
    {
        "type": "CurrentUserPageViewCondition",
        "criteriaType": "CurrentUserPageView",
        "orConditions": [{
            "type": "CurrentUserPageViewInnerCondition",
            "operator": "Equals",
            "values": [
                6
            ]
        }]
    },
    {
        "type": "UserBrowsingHistoryCondition",
        "criteriaType": "UserBrowsingHistory",
        "orConditions": [{
            "type": "UserBrowsingHistoryInnerCondition",
            "operator": "IncludesAllOfTheFollowingActivities",
            "values": [{
                    "type": "ActivityRelation",
                    "id": 1091028200,
                    "entityType": "RetargetingActivity",
                    "name": 1091028200
                },
                {
                    "type": "ActivityRelation",
                    "id": 1083759900,
                    "entityType": "ConversionActivity",
                    "name": 1083759900
                }
            ]
        }]
    },
    {
        "type": "VariableCondition",
        "criteriaType": "Variable",
        "orConditions": [{
                "type": "VariableInnerCondition",
                "andConditions": [{
                        "type": "AndVariableInnerCondition",
                        "operator": "Equals",
                        "values": [
                            55
                        ],
                        "variableId": 1073742872,
                        "variableName": "intVar_1",
                        "variableDataType": "Integer"
                    },
                    {
                        "type": "AndVariableInnerCondition",
                        "operator": "EqualsOneOfTheFollowing",
                        "values": [
                            "66"
                        ],
                        "variableId": 1073742871,
                        "variableName": "strVar_1",
                        "variableDataType": "String"
                    }
                ]
            },
            {
                "type": "VariableInnerCondition",
                "andConditions": [{
                    "type": "AndVariableInnerCondition",
                    "operator": "EqualsOneOfTheFollowing",
                    "values": [
                        "123"
                    ],
                    "variableId": 1083752586,
                    "variableName": "var1",
                    "variableDataType": "String"
                }]
            }
            {
                "type": "TimeSpentOnPageCondition",
                "criteriaType": "TimeSpentOnPage",
                "orConditions": [
                {
                  "type": "TimeSpentOnPageInnerCondition",
                  "operator": "GreaterThanAndEquals",
                  "values": [
                    7
                  ],
                  "timeUnit": "Milliseconds"
                }
              ]
            }
        ]
    }
],

orConditions Object

orConditions Object Definition

Note

Note: The Required column includes the following values:

Required: The field must be included in the POST call.
Read-only: The field is received in the GET call and required in the PUT call. It is not required in the POST call. You cannot edit this field.
Optional: If the field was received in the GET call, include it in the PUT call. This field is editable.
Internal: (For Amazon Ad Server (AAS) internal use) If the field was received in the GET call, include it in the PUT call.

NAME	DESCRIPTION	TYPE	REQUIRED	NOTES
type	Type of entity.	String	Read-only	View values PageUrlInnerCondition ReferralUrlInnerCondition VariableInnerCondition ClickedElementInnerCondition CurrentUserPageViewInnerCondition UserPageViewDuringSessionInnerCondition UserBrowsingHistoryInnerCondition
operator	Operator used in the condition.	String	Required	View values ContainsOneOfTheFollowing DoesNotContainOneOfTheFollowing EqualsOneOfTheFollowing MatchesOneOfTheFollowingCSSSelectors Equals IncludeAllOfTheFollowingActivities DoesNotEqualOneOfTheFollowing
values	Values for the condition.	Array of values	Required
andConditions	Conditions joined with an AND logic operator.	andConditions Object	Optional	Permitted only with URLs.
variableId	ID of the variable used in the condition.	Long	Required
variableName	Name of the variable used in the condition.	String	Required
variableDataType	Type of the variable.	String	Required	View values Integer String

Object JSON Example

andConditions Object

andCondition Object Definition

Note

Note: The Required column includes the following values:

Required: The field must be included in the POST call.
Read-only: The field is received in the GET call and required in the PUT call. It is not required in the POST call. You cannot edit this field.
Optional: If the field was received in the GET call, include it in the PUT call. This field is editable.
Internal: (For Amazon Ad Server (AAS) internal use) If the field was received in the GET call, include it in the PUT call.

NAME

DESCRIPTION

TYPE

REQUIRED

NOTES

type

Type of entity.

String

Required

AndVariableInnerCondition

operator

Available actions according to criteria type.

String

Required

Page URL/ReferralURL

ContainsOneOfTheFollowing
DoesNotContainOneOfTheFollowing
EqualsOneOfTheFollowing
EqualsAnyValue
DoesNotEqualOneOfTheFollowng(wildcardUsageSupported)
DoesNotEqualOneOfTheFollowing
EqualsOneOfTheFollowing(WildcardUsageSupported)

Variable

ContainsOneOfTheFollowing
DoesNotContainOneOfTheFollowing
EqualsOneOfTheFollowing
EqualsAnyValue
HasNoValue
DoesNotEqualOneOfTheFollowng(wildcardUsageSupported)
DoesNotEqualOneOfTheFollowing
EqualsOneOfTheFollowing(WildcardUsageSupported)

ClickedElements

MatchesOneOfTheFollowingCSSSelectors
DoesNotMatchOneOfTheFollowingCSSSelectors

NumberOfSessionPageViewsForCurrentUser/ NumberOfTotalPageViewsForCurrentUser

=
>
<

User'sBrowsingHistory

IncludesAllOfTheFollowingActivities
DoesNotIncludeAnyOfTheFollowingActivities

TimeSpentOnPage

>=

values

Values for which to assess the operator.

Array of items

Required

Criteria Type	Values
Page URL/Referral URL	URL.
Variable	Values depend on selected variable. See variableID, variableName, variableDataType.
Clicked Element	CSS selector.
Number of session page views/ Number of total page views	Integer.
User's Browsing History	IDs of retargeting and/or conversion activities.
Time spent on page	Integer and unit. Units include: Milliseconds Seconds Minutes

variableId

ID of the variable.

Long

Read-only

For Variable criteria only.

variableName

Name of the variable.

String

Required

For Variable criteria only.

variableDataType

Type of the variable data.

String

Required

For Variable criteria only.

Object JSON Example

Related Entities

Endpoints Using the Condition Objects

Parent Objects

Condition Objects Definition

Note

Object JSON Example

orConditions Object

orConditions Object Definition

Note

Object JSON Example

andConditions Object

andCondition Object Definition

Note

Object JSON Example

Comments