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 advancedRetargeting Object

Parent Objects

advancedRetargeting 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

AdvancedRetargeting

branchItemClientIds

Internal.

Internal

Internal

advertiserId

ID of the advertiser to which the ad is assigned, and to which the retargeting tags belong.

Integer

Required

tags

Lists the retargeting tags and values set to the version.

tags Object

Required

tagIds

Internal.

Internal

Internal

nodeType

Type of node.

String

Read-Only

AdvancedRetargeting

Object JSON Example

Example
...,
        "advancedRetargeting": {
            "type": "AdvancedRetargeting",
            "branchItemClientIds": [],
            "advertiserId": 146600,
            "tags": [],
            "tagIds": [],
            "nodeType": "AdvancedRetargeting"
        },

tags Object

tags 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

tagID

ID of the retargeting tag.

Integer

Required

name

Name of the retargeting tag.

String

Read-Only

viewerExpose

Internal.

Internal

Internal

logicalOperator

Internal.

Internal

Internal

values

Internal.

Internal

Internal

advancedRetargetingTagValue

Object containing the retargeting value ID and name.

advancedRetargetingTagValue Object

Required

advancedRetargetingTagValueAsString

Name of the retargeting value.

String

Read-Only

ordinalId

Internal.

Internal

Internal

valueOrdinal

Internal.

Internal

Internal

Object JSON Example

Example
"tags": [{
    "tagId": 40787,
    "name": null,
    "viewerExpose": null,
    "logicalOperator": null,
    "values": [],
    "advancedRetargetingTagValue": [{
        "id": 13033158,
        "value": "12"
    }, {
        "id": 13033160,
        "value": "888"
    }, {
        "id": 13033161,
        "value": "999"
    }, {
        "id": 13033159,
        "value": "MyValue"
    }],
    "advancedRetargetingTagValueAsString": "12,888,999,MyValue",
    "ordinalId": null,
    "valueOrdinal": null
}],

advancedRetargetingTagValue Object

advancedRetargetingTagValue 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

id

ID of the retargeting value.

Integer

Required

value

Name of the retargeting value.

String

Required
Object JSON Example
Example
...,
    "advancedRetargetingTagValue": [{
        "id": 13033158,
        "value": "12"
    }, {
        "id": 13033160,
        "value": "888"
    }, {
        "id": 13033161,
        "value": "999"
    }, {
        "id": 13033159,
        "value": "MyValue"
    }],...
Was this article helpful?
0 out of 0 found this helpful
Have more questions? Submit a request

Comments