Submit a request
 
PRODUCT
Privacy Policy |  AAS Advertising Policy | Terms of Use
Cookie Preference
✖

Amazon Ad Server will be sunset in Q4 2024, please visit this page (AAS offboarding information) for offboarding support resources and sunset FAQs. Details shared on that page represent the most up to date information in the Help Center, if you find disparate information in other resources please default to the information in the AAS offboarding information page accordingly.

Please note that on October 1, 2024, the ability to create new campaigns, placements, and tag managers will be disabled.

Follow
Last Update:
  viewable by end users
  editable by agents

Related Entities

Endpoints Using the customFields Object

Parent Objects

customFields 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

CustomFields

id

ID of entity. read-only parameter, auto-generated.

Integer

Read-only

relationsBag

Internal.

relationsBag Object

Internal

version

Internal.

Internal

Internal

createdBy

ID of the user that created the account.

Long

Read-only

createdByName

Name of the user that created the entity.

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 custom field.

String

Optional

fieldType

Type of field.

String

Required
View values

  • Test

  • ChoiceList

accountId

ID of the campaign manager account.

Long

Optional

typeSettings

Settings for a custom field choice list.

typeSettings Object

fieldSettings

Settings for custom fields.

fieldSettings Object

Object JSON Example

Example
...
"customFields": {
    "type": "CustomFields",
    "id": null,
    "textFields": {
        "1073742100": {
            "type": "CustomTextField",
            "id": 1073742100,
            "name": null,
            "fieldType": "Text",
            "accountId": null,
            "value": "abcd"
        },
        "1073741800": {
            "type": "CustomTextField",
            "id": 1073741800,
            "name": null,
            "fieldType": "Text",
            "accountId": null,
            "value": "efgh"
        }
    },
    "numericFields": null,
    "decimalFields": null,
    "choiceListFields": {
        "1073742400": {
            "type": "CustomTextField",
            "id": 1073742400,
            "name": null,
            "fieldType": "ChoiceList",
            "accountId": null,
            "value": "blue"
        }
    },
    "labelsFields": null
}

relationsBag Object

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.

relationsBag 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

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".

Parents Object

Read-only

children

Includes the count of the related entities.

Children Object

Read-only

creativeAccountContact

Internal.

Boolean

Read-only

Object JSON Example

Example
"relationsBag": {
        "parents": {
                "account": {
                        "id": 16674,
                        "name": "[TEST] migrated account",
                        "internal": true
                },
                "advertiser": null,
                "brand": null,
                "campaign": null,
                "site": null
        },
        "children": {
                "advertisers": {
                        "count": 0
                },
                "brands": {
                        "count": 1
                },
                "campaigns": {
                        "count": 231
                },
                "users": {
                        "count": 0
                }
        },
        "creativeAccountContact": false
},

Parents Object

Parents Object Definition

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"
 }
Object JSON Example
Example
"parents": {
        "account": {
                "id": 1072241834,
                "name": "testing account",
                "internal": false
        },
        "advertiser": {
                "id": 1073741822,
                "name": "AAA"
        },
        "brand": {
                "id": 1073741833,
                "name": "BBB"
        },
        "campaign": null,
        "site": null
},

Children Object

Children Object Definition

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
Object JSON Example
Example
"children": {
        "advertisers": {
                "count": 0
        },
        "brands": {
                "count": 1
        },
        "campaigns": {
                "count": 231
        },
        "users": {
                "count": 0
        }
}

typeSettings Object

typeSettings 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

min

Internal.

Internal

Internal

max

Internal.

Internal

Internal

decimalPrecision

Internal.

Internal

Internal

dropDownValues

Lists the values that are available when the field type is a choice list. For example, if the custom field is color, the values might be blue, green, or red.

Integer

Optional

allowUserAddValueToDropdown

Determines whether you can add new values to the choice list on a specific entity level. For example, if a custom field is defined on the Brand level, and the allowUserAddValueToDropdown value is True, you can add values.

Boolean

Required
View values

  • True

  • False

Object JSON Example

Example
 "typeSettings": {
            "min": 0,
            "max": 0,
            "decimalPrecision": 5,
            "dropDownValues": [],
            "allowUserAddValueToDropDown": false
        },

fieldSettings Object

fieldSettings 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

readonly

Determines whether the custom field that is displayed on the entity level is read-only or editable.

Boolean

Required

displayLocation

Internal.

Internal

Internal

reportingSettings

Internal.

reportingSettings Object

Internal

tokenSettings

Object that determines whether to use the custom field as a token on click-throughs and 3rd party events.

tokenSettings Object

Required

entityType

Entity, for example, campaign level or placement level, using the custom field.

String

Required

includeInPlacementPackageExcel

For custom fields on the placement level, determines whether to include the custom field in the placement package spreadsheet.

Boolean

Required

required

Determines whether the custom field is mandatory.

Boolean

Required

Object JSON Example

Example
"fieldSettings": [{
            "readonly": false,
            "displayLocation": "CustomSettings",
            "reportingSettings": {
                "useInReporting": false,
                "reportingUsage": null
            },
            "tokenSettings": {
                "useAsToken": false,
                "token": ""
            },
            "entityType": "Ad",
            "includeInPlacementPackageExcel": false,
            "required": false
        }, {
            "readonly": false,
            "displayLocation": "CustomSettings",
            "reportingSettings": {
                "useInReporting": false,
                "reportingUsage": null
            },
            "tokenSettings": {
                "useAsToken": false,
                "token": ""
            },
            "entityType": "Placement",
            "includeInPlacementPackageExcel": false,
            "required": false
        }, {
            "readonly": false,
            "displayLocation": "CustomSettings",
            "reportingSettings": {
                "useInReporting": false,
                "reportingUsage": null
            },
            "tokenSettings": {
                "useAsToken": false,
                "token": ""
            },
            "entityType": "Advertiser",
            "includeInPlacementPackageExcel": false,
            "required": false
        }, {
            "readonly": false,
            "displayLocation": "CustomSettings",
            "reportingSettings": {
                "useInReporting": false,
                "reportingUsage": null
            },
            "tokenSettings": {
                "useAsToken": false,
                "token": ""
            },
            "entityType": "Brand",
            "includeInPlacementPackageExcel": false,
            "required": false
        }, {
            "readonly": false,
            "displayLocation": "CustomSettings",
            "reportingSettings": {
                "useInReporting": false,
                "reportingUsage": null
            },
            "tokenSettings": {
                "useAsToken": false,
                "token": ""
            },
            "entityType": "Campaign",
            "includeInPlacementPackageExcel": false,
            "required": false
        }]

reportingSettings Object

reportingSettings Object Definition

NAME

DESCRIPTION

TYPE

REQUIRED

NOTES

useInReporting

Internal.

Internal

Internal

reportingUsage

Internal.

Internal

Internal

tokenSettings Object

tokenSettings Object Definition

NAME

DESCRIPTION

TYPE

REQUIRED

NOTES

useAsToken

Determines whether to use the custom field as a token on click-throughs and 3rd party events.

Boolean

Required

token

Name of token.

String

Required

customTextField Object

customTextField Object Definition

Parameter

Description

Type

Required

Notes

A number that represents the ID of the custom field defined on the account.

Number that represents the ID of the custom field defined on the account.

String

Read-only

type

Type of entity.

String

Read-only

CustomTextField

id

ID of the custom field defined on the account.

String

Read-only

name

Internal.

Internal

Internal

fieldType

Type of custom field that was defined on the account.

String

Required
View values

  • Text

  • ChoiceList

accountId

Internal.

Internal

Internal

value

Value of the custom field as defined on the entity.

String

Optional

Object JSON Example

Example
...
"123456789": {
     "type": "CustomTextField",
     "id": 123456789,
     "name": null,
     "fieldType": "Text",
     "accountId": null,
     "value": "abcd"
}
...
Was this article helpful?
0 out of 0 found this helpful
Have more questions? Submit a request

Comments