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

Parent Objects

targetingInfo 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

AdSmartVersionTargetingInfo

id

ID of the master ad

Long

Required

relationsBag

Internal.

relationsBag Object

Read-only

subDeliveryGroupId

Internal.

Internal

Internal

sdgNumericId

Internal.

Internal

Internal

targetAudienceId

Internal.

Internal

Internal

targetAudienceName

Internal.

Internal

Internal

targetAudienceExternalName

Internal.

Internal

Internal

rotationType

Determines the rotation methods by which to serve the ad versions.

String

Read-Only

Note

Note: The values for the rotationType field are derived from the master ad settings.

View values

  • EvenDistribution

  • Weighted

  • TimeBased

  • Sequence

  • AdvancedSequence

  • AutomaticOptimaztion

versionTargetingType

Internal.

Internal

Internal

startDate

Internal.

Internal

Internal

endDate

Internal.

Internal

Internal

weight

Serving weight of a version in an ad when it is set to the weighted rotation method.

Long

Optional

mediaTargetingName

Name of targeted placement audience.

String

Optional

mediaTargetingId

ID of targeted placement audience.

Long

Optional

datesRange

List of serving date ranges.

datesRange Object

Optional

targetAudienceMetaData

List of versions' target audiences.

targetAudienceMetaData Object

Optional

Object JSON Example

Example
,
        "targetingInfo": {
            "type": "AdSmartVersionTargetingInfo",
            "id": 1074157238,
            "relationsBag": null,
            "subDeliveryGroupId": "b45445878f1a0926f4aba4672e9692ec",
            "sdgNumericId": 1073803583,
            "targetAudienceId": -1,
            "targetAudienceName": "None",
            "targetAudienceExternalName": "None",
            "rotationType": "EvenDistribution",
            "versionTargetingType": null,
            "startDate": 0,
            "endDate": 1924934749000,
            "weight": 1.0,
            "mediaTargetingName": "None",
            "mediaTargetingId": -1,
            "datesRange": [],
            "targetAudienceMetaData": []
        },

datesRange Object

datesRange 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

Read-only

APIDateRange

startDate

Serving start date (epoch) of the entity.

Long

Required

endDate

Serving end date (epoch) of the entity.

Long

Required

Object JSON Example

Example
...,
"datesRange": [{
    "type": "APIDateRange",
    "startDate": 1576627200000,
    "endDate": 1577231999999
}]

targetAudienceMetaData Object

targetAudienceMetaData 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

Read-only

APITargetAudienceMetaData

id

ID of the target audience.

Long

Read-only

targetAudienceName

Name of target audience.

String

Required

targetAudienceExternalName

External name of the target audience.

String

Optional

clientRefId

Internal.

Internal

Internal

Object JSON Example

Example
"targetAudienceMetaData": [{
    "type": "APITargetAudienceMetaData",
    "id": 1073765273,
    "targetAudienceName": "1 OR 2",
    "targetAudienceExternalName": "MyTargetAudience",
    "clientRefId": null
}, {
    "type": "APITargetAudienceMetaData",
    "id": 1073775379,
    "targetAudienceName": "1",
    "targetAudienceExternalName": "",
    "clientRefId": null
}]
}
Was this article helpful?
0 out of 0 found this helpful
Have more questions? Submit a request

Comments