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

targetAudience 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

relationsBag

Internal.

relationsBag Object

Internal

version

Internal.

Internal

Internal

Type

Object type.

String

Read-only

ID

ID of the target audience.

Long

Read-only

createdBy

ID of the user who created the object.

Long

Read-only

createdByName

Name of the user who created the object.

String

Read-only

createdByAccount

Account ID of the user who created the object.

Long

Read-only

createdByAccountName

Name of the account of the user who created the object.

String

Read-only

createdOn

Creation date.

Long

Read-only

lastUpdatedBy

ID of the user who last updated the object.

Long

Read-only

lastUpdatedByName

Name of the user who last updated the object.

String

Read-only

lastUpdatedByAccount

Account ID of the user who last updated the object.

Long

Read-only

lastUpdatedByAccountName

Account name of the user who last updated the object.

String

Read-only

lastUpdateOn

Date the object was last updated .

Long

Read-only

accountId

Account ID of the object.

Long

Read-only

accountName

Account name of the object.

String

Read-only

name

Name of the target audience.

String

Required

campaignId

ID of the campaign.

Long

Read-only

strategyId

ID of the strategy (if the target audience was created as part of an audience strategy).

Long

Read-only

strategyName

Name of the strategy (if the target audience was created as part of an audience strategy).

String

Read-only

advertiserId

ID of the advertiser the target audience belongs to. The advertiser ID is only added to the target audience if the target audience is using advertiser related objects, such as retargeting.

Long

Required

For target audiences that have retargeting.

advertiserName

Name of the advertiser to which the target audience belongs.

String

Read-only

targetingItemTypes

Decision rules that apply to this target audience.

Array of strings

External name

External name of the target audience.

String

Optional

campaignsData

Internal.

Internal

Internal

customCategoryMapIdNames

Names of the Peer39 custom categories used in this target audience.

String

Read-only

targetingItems

Targeting objects and the targeting values in the target audience.

Array of objects

Required

Objects include:

nodeType

Object type.

String

Required
View values

Value should be the same as the value for the Object type field.

  • Retargeting

  • SiteKeywordTargeting

  • GeoTargeting

  • ContextualTargeting

  • browsersAndOSs

itemIdToNameTranslate

Internal.

Internal

Internal

Names of the targeting objects, for example, countries, used in the target audience.

Object JSON Example

Example
{
    "result": {
        "type": "TargetAudience",
        "id": 1083799662,
        "relationsBag": {
            "parents": {
                "account": {
                    "id": 1073741826,
                    "name": "Account1",
                    "internal": false
                },
                "advertiser": null,
                "brand": null,
                "campaign": null,
                "site": null
            },
            "children": {
                "advertisers": {
                    "count": 0
                },
                "brands": {
                    "count": 0
                },
                "campaigns": {
                    "count": 0
                },
                "users": {
                    "count": 0
                }
            },
            "creativeAccountContact": false
        },
        "version": 1581328442997473280,
        "createdBy": 1073741831,
        "createdByName": "User1",
        "createdByAccount": 1073741826,
        "createdByAccountName": "Account1",
        "createdOn": 1581328443001,
        "lastUpdatedBy": 1073741831,
        "lastUpdatedByName": "User1",
        "lastUpdatedByAccount": 1073741826,
        "lastUpdatedByAccountName": "Account1",
        "lastUpdateOn": 1581328443001,
        "accountId": 1073741826,
        "accountName": "Account1",
        "name": "My Target Audience",
        "targetingItems": [{
            "type": "SiteKeywordTargeting",
            "branchItemClientIds": [],
            "siteKeywords": [{
                "site": "My Site",
                "keywords": "KeywordParam",
                "additionalKeywords": null
            }],
            "nodeType": "SiteKeywordTargeting"
        }, {
            "type": "Retargeting",
            "branchItemClientIds": [],
            "advertiserId": 1073746301,
            "cookieAge": 90,
            "retargetingViewers": [{
                "retargetingType": "Dynamic",
                "tagId": 1073742756,
                "viewerExpose": "EXPOSE_TO",
                "logicalOperator": "OR",
                "tagOrdinal": null,
                "values": [1073742757, 1073742758],
                "valuesOrdinal": []
            }],
            "nodeType": "ReTargeting"
        }, {
            "type": "BrowsersAndOperatingSystemsTargeting",
            "branchItemClientIds": [],
            "operatingSystemTargeting": ["Android2_1_Mobile", "Android10_Tablet", "Android10_Moblie"],
            "browserTargeting": ["Safari9", "Safari8"],
            "nodeType": "BrowsersAndOperatingSystemsTargeting"
        }, {
            "type": "ContextualTargeting",
            "branchItemClientIds": [],
            "subCategoriesIds": [6796],
            "nodeType": "ContextualTargeting"
        }, {
            "type": "GeoTargeting",
            "branchItemClientIds": [],
            "countries": [840],
            "cities": null,
            "regions": null,
            "areaCodes": null,
            "zipCodes": null,
            "nodeType": "GeoTargeting",
            "nielsenDMAs": null,
            "isps": null
        }],
        "campaignId": null,
        "campaignName": null,
        "strategyId": null,
        "strategyName": null,
        "advertiserId": 1073746301,
        "advertiserName": "retAdv",
        "strategyOrTACreationType": "TA_BUILDER",
        "defaultPriority": 1811995163561984,
        "itemIdToNameTranslate": {
            "1073742758": "bb",
            "840": "United States",
            "6796": "iPhones (Apple)",
            "1073742756": "ret",
            "1073742757": "aa"
        },
        "targetingItemTypes": ["ContextualTargeting", "GeoTargeting", "BrowsersAndOperatingSystemsTargeting", "SiteKeywordTargeting", "ReTargeting"],
        "externalName": "",
        "campaignsData": [],
        "adsPriorityData": [],
        "campaignsPriorityData": [],
        "numberOfCampaigns": 0,
        "customCategoryMapIdNames": null,
        "targetAudienceType": null
    }
}
Was this article helpful?
0 out of 0 found this helpful
Have more questions? Submit a request

Comments