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 was disabled.

Follow
Last Update:
  viewable by end users
  editable by agents

Related Entities

Endpoints Using the retargetingActivity Object

retargetingActivity 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

RetargetingActivity

id

ID of the entity.

Long

Read-only

Auto-generated, read-only value

relationsBag

Internal.

relationsBag Object

Internal

version

Internal.

String

Internal

createdBy

ID of the user who created the entity.

Long

Read-only

createdByName

Name of the user who 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 who was the last to update the entity.

Long

Read-only

lastUpdatedByName

Name of the user who was the last to updated the entity.

String

Read-only

lastUpdatedByAccount

ID of the account that was the last to update the entity.

Long

Read-only

lastUpdatedByAccountName

Name of the account that was the last to update the entity.

String

Read-only

lastUpdatedOn

Date of the last update (date epoch).

Long

Read-only

name

Name of entity.

String

Required

activityType

Type of activity.

String

Read-only

Retargeting

advertiserId

ID of the advertiser to which the retargeting activity belongs.

Long

Read-only

rulesCount

Number of activity rules defined for the retargeting activity.

Integer

Read-only

tagManagersCount

Number of tag managers that use this retargeting activity.

Integer

Read-only

conversionsCount

Number of conversions that use this retargeting activity.

Integer

Read-only

tagManagerIds

Array of IDs for tag managers that use this retargeting activity.

Array of integer

Read-only

accessLevel

Internal.

Internal

Internal

nxtTagManagement

Flag that indicates whether the activity was migrated from MDX2.

Boolean

Read-only

variableId

ID of the variable in the retargeting activity.

Long

Optional

variableName

Name of the variable.

String

Optional

Object JSON Example

Example
{
  "result": {
    "type": "RetargetingActivity",
    "id": 1088886200,
    "relationsBag": {
      "parents": {
        "account": {
          "id": 2,
          "name": "Testing Account",
          "internal": true
        },
        "advertiser": {
          "id": 1073758800,
          "name": "Test Advertiser"
        },
        "brand": null,
        "campaign": null,
        "site": null
      },
      "children": {
        "advertisers": {
          "count": 0
        },
        "brands": {
          "count": 0
        },
        "campaigns": {
          "count": 0
        },
        "users": {
          "count": 0
        }
      },
      "creativeAccountContact": false
    },
    "version": 1549984419555901402,
    "createdBy": 389372,
    "createdByName": "Jane Smith",
    "createdByAccount": 2,
    "createdByAccountName": "Testing Account",
    "createdOn": 1549984419542,
    "lastUpdatedBy": 389370,
    "lastUpdatedByName": "Jane Smith",
    "lastUpdatedByAccount": 2,
    "lastUpdatedByAccountName": "Testing Account",
    "lastUpdateOn": 1549984419542,
    "name": "Classic Cars Retargeting",
    "activityType": "Retargeting",
    "advertiserId": 1073758832,
    "rulesCount": 1,
    "tagManagersCount": 1,
    "conversionsCount": null,
    "tagManagerIds": [
      1073742895
    ],
    "accessLevel": "Full",
    "nxtTagManagement": true,
    "variableId": null,
    "variableName": 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
        }
}
Was this article helpful?
0 out of 0 found this helpful
Have more questions? Submit a request

Comments