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

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

Parameter

Description

Type

Required

Notes

Type

Type of entity.

String

Read-only

CustomFields

ID

Internal.

Internal

Internal

textFields

An object that contains all of the text fields defined on the entity that includes the custom field.

customTextField Object

Optional

numericFields

Internal.

Internal

Internal

decimalFields

Internal.

Internal

Internal

choiceListFields

An object that contains all of the choice list fields defined on the entity that includes the custom field.

customTextField Object

Optional

labelsFields

Internal.

Internal

Internal

Object JSON Example

Example
{
    "type": "CustomFields",
    "id": null,
    "textFields": {
        "1233741800": {
            "type": "CustomTextField",
            "id": 1233741800,
            "name": null,
            "fieldType": "Text",
            "accountId": null,
            "value": "qqq"
        }
    },
    "numericFields": null,
    "decimalFields": null,
    "choiceListFields": null,
    "labelsFields": null
}

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