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 |
Variable |
|
id |
ID of the ad. |
Long |
Read-only |
|
|
relationsBag |
Internal. |
Internal |
||
|
version |
Internal. |
Long |
Read-only |
|
|
key |
A variable key is used to match between the JavaScript variables (which are added to a custom ad format) and the variable settings in the platform. |
String |
Required |
|
|
dataType |
Data type of the defined variable. |
String |
Required |
|
|
displayName |
Name of variable in the platform. |
String |
Required |
|
|
description |
Description about the variable controls and how to use the variable. |
String |
Optional |
|
|
defaultValue |
Default value for the variable. This value will be passed to the ad when it is created. |
String |
Required (If the Mandatory option was selected.) |
|
|
mandatory |
Controls whether the variable is mandatory or optional. |
Boolean |
Required |
|
|
showInAdPage |
Controls whether a variable should be displayed on the ad page. |
Boolean |
Required |
|
|
variableSource |
Source entity from which the variable originated. |
String |
Read-only |
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