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 |
SiteActivity |
id |
ID of site activity. |
Long |
Read-only |
|
relationsBag |
Internal. |
Internal |
||
version |
Internal. |
String |
Internal |
|
createdBy |
ID of the user that created the site activity.. |
Long |
Read-only |
|
createdByName |
Name of user that created the account. |
String |
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 activity. |
Long |
Required |
|
activityType |
Type of activity. |
String |
Required |
|
advertiserId |
ID of advertiser. |
Integer |
Read-only |
|
rulesCount |
Number of activity rules. |
Integer |
Read-only |
|
tagManagersCount |
Number of tag managers that use this site activity. |
Integer |
Read-only |
|
conversionsCount |
Number of conversions that use this site activity. |
Integer |
Read-only |
|
tagManagerIds |
Array of IDs for tag managers that use this site activity. |
Array of integers. |
Read-only |
|
accessLevel |
Internal. |
Internal |
Internal |
|
nxtTagManagement |
Flag that indicates whether the activity was migrated from MDX2. |
Boolean |
Read-only |
|
defaultActivity |
Type of default site activity. |
Boolean |
Read-only |
|
siteActivityType |
Custom site activity. |
String |
Optional |
This object enables you to view the parent object of an object, for example, the account ID and name of an advertiser. This saves time because you do not need to call another call to get these details.
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 |
---|---|---|---|---|
parents |
This is an object of the entities that are related to this object, and depends on the object type.For example, a campaign will include "account", "advertiser", and "brand" data. An advertiser will only include the "account". |
Read-only |
||
children |
Includes the count of the related entities. |
Read-only |
||
creativeAccountContact |
Internal. |
Boolean |
Read-only |
Name |
Description |
Type |
Required |
Notes |
---|---|---|---|---|
account |
Parent account of current entity (if applicable). |
Object |
Read-Only |
Example: { "id": 1072241834, "name": "testing account", "internal": false } |
advertiser |
Parent advertiser of current entity (if applicable). |
Object |
Read-Only |
Example: { "id": 1073741822, "name": "AAA" } |
brand |
Parent brand of current entity (if applicable). |
Object |
Read-Only |
Example: { "id": 1073741833, "name": "BBB" } |
campaign |
Parent campaign of current entity (if applicable). |
Object |
Read-Only |
Example: { "id": 1073741831, "name": "ccc" } |
site |
Parent site of current entity (if applicable). |
Object |
Read-Only |
Example: { "id": 1073741853, "name": "ddd" } |
Name |
Description |
Type |
Required |
Notes |
---|---|---|---|---|
advertisers |
Contains the count of child advertisers (if applicable). |
Object |
Read-Only |
|
brands |
Contains the count of child brands (if applicable). |
Object |
Read-Only |
|
campaigns |
Contains the count of child campaigns (if applicable). |
Object |
Read-Only |
|
users |
Contains the count of child users (if applicable). |
Object |
Read-Only |
Comments