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 |
ActivityRule |
id |
ID of activity rule. |
Integer |
Read-only |
|
version |
Internal. |
Internal |
Internal |
|
createdBy |
ID of the user that created the activity rule. |
Long |
Read-only |
|
createdByName |
Name of user that created the account. |
Long |
Read-only |
|
createdByAccount |
ID of the account that created the entity. |
Long |
Read-only |
|
createdByAccountName |
Name of the account that created the entity. |
String |
Read-only |
|
createdOn |
Date of creation (Date epoch). |
Long |
Read-only |
|
lastUpdatedBy |
ID of the user that was last to update the entity. |
Long |
Read-only |
|
lastUpdatedByName |
Name of the user that was last to update the entity. |
String |
Read-only |
|
lastUpdatedByAccount |
ID of the account that was last to update the entity. |
Long |
Read-only |
|
lastUpdatedByAccountName |
Name of the account that was last to update the entity. |
String |
Read-only |
|
lastUpdateOn |
Date of last update (Date epoch). |
Long |
Read-only |
|
name |
Name of rule. |
String |
Required |
|
tagManagerId |
ID of the tag manager. |
Long |
Required |
|
advertiserId |
ID of advertiser. |
Integer |
Read-only |
|
tagManagerName |
Name of tag manager. |
String |
Required |
|
ruleType |
Type of activity rule. |
String |
Required |
For a POST request, ruleType must be set to Regular. |
isAlwaysRule |
Determines whether the rule is always fired. |
Boolean |
Read-only |
For a POST request, isAlwaysRule must be set to false. |
status |
Rule status. |
String |
Read-only |
|
conditions |
Conditions for the activity rule. |
Required |
||
urlSettings |
Determines url settings when analyzing the landing page. |
Required |
urlSettings are only relevant for the PageUrl type. |
|
conversionRelations |
Determines which conversion activity is triggered when a rule matches. |
Optional |
||
retargetingRelations |
Determines which retargeting activity is triggered when a rule matches. |
Optional |
||
thirdPartyRelations |
Determines which third-party activity is triggered when a rule matches. |
Optional |
||
siteActivityRelations |
Determines which site activity is triggered when a rule matches |
Optional |
||
globalData |
Includes data about the advertiser, if it is a global advertiser or a local advertiser and which advertisers are global or local. |
Optional |
||
accessLevel |
Internal. |
Internal |
Internal |
|
activityRuleMatchesInTheLast24Hours |
Total number of times that this activity rule matched in the last 24 hours |
Integer |
Read-only |
|
activityRuleTotalMatches |
Total number of times that this activity rule was matched. |
Integer |
Read only |
|
activityRuleLastMatch |
Last time that the activity rule was matched. (Date epoch) |
Long |
Read-only |
Comments