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

Parent Objects

placementPackage 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 package.

String

Required

PlacementPackage

id

ID of the package.

Long

Read-only

relationsBag

Internal.

relationsBag Object

Internal

version

Internal.

Internal

Internal

createdBy

ID of the user who created the package.

Long

Read-only

createdByName

Name of the user who created the package.

String

Read-only

createdByAccount

ID of the account of the user who created the package.

Long

Read-only

createdByAccountName

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

String

Read-only

createdOn

Date and time on which the package was created (Date epoch).

Long

Read-only

lastUpdatedBy

ID of the user who last updated the package.

Long

Read-only

lastUpdatedByName

Name of the user who last updated the package.

String

Read-only

lastUpdatedByAccount

ID of the account of the user who last updated the package.

Long

Read-only

lastUpdatedByAccountName

Name of the account of the user who last updated the package.

Long

Read-only

lastUpdateOn

Date and time on which the package was last updated (Date epoch).

Long

Read-only

name

Name of the package.

String

Required

campaignId

Package's campaign ID

Long

Required

campaignName

Package's campaign name.

String

Read-only

siteId

Package's site ID.

Long

Required

mediaServingData

Object that describes the package's media serving data.

mediaServingData Object

Required

mediaCostData

Object that describes the package's media cost data.

mediaCostData Object

Required

placementLevel

Determines whether the placement is on a placement level or a package level.

Boolean

Required

True: Placement is on the placement level.

False: Placement is on the package level.

Object JSON Example

Example
...{
         "type":"PlacementPackage",
         "id":1074237000,       
         "relationsBag":{
            "parents":{
               "account":{
                  "id":1073742800,
                  "name":"Fake1",
                  "internal":false
               },
               "advertiser":{
                  "id":1073747804,
                  "name":"Fake2"
               },
               "brand":{
                  "id":1073812663,
                  "name":"Fake3"
               },
               "campaign":{
                  "id":1073870891,
                  "name":"Fake4"
               },
               "site":{
                  "id":70448,
                  "name":"Fake5"
               }
            },
            "children":{
               "advertisers":{
                  "count":0
               },
               "brands":{
                  "count":0
               },
               "campaigns":{
                  "count":0
               },
               "users":{
                  "count":0
               }
            },
            "creativeAccountContact":false
         },
         "version":1518441490909298688,
         "createdBy":1073746100,
         "createdByName":"Chris Chapman",
         "createdByAccount":1073742800,
         "createdByAccountName":"Fake",
         "createdOn":1518441490900,
         "lastUpdatedBy":1073746100,
         "lastUpdatedByName":"Chris Chapman",
         "lastUpdatedByAccount":1073742800,
         "lastUpdatedByAccountName":"Fake",
         "lastUpdateOn":1518441490900,
         "name":"Fake",
         "campaignId":1073870800,
         "campaignName":null,
         "siteId":70400,
         "mediaServingData":{
            "units":333,
            "hardStopMethod":"KEEP_SERVING_AS_USUAL",
            "startDate":1514782800000,
            "endDate":1546318799000
         },
         "mediaCostData":{
            "type":"MediaCost",
            "costModel":"CPM",
            "rate":5,
            "orderedUnits":null,
            "actionType":null,
            "customInteraction":null,
            "conversionId":null,
            "interactionId":null,
            "ignoreOverDelivery":false,
            "conversionActivityId":null
         },
         "placementLevel":false
      },...

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
        }
}

mediaCostData Object

mediaCostData 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

actionType

Type of action on the asset level.

String
View values

  • CLICKS

  • ALL_USER_INTERACTIONS

  • SELECT_CUSTOM_INTERACTION

  • ALL_CONVERSIONS

  • ALL_POST_IMPRESSION_CONVERSIONS

  • ALL_POST_CLICK_CONVERSIONS

  • SELECT_ACTIVITY

  • VIDEO_START

  • VIDEO_FULLY_PLAYED

  • VIDEO_PLAYED_25

  • VIDEO_PLAYED_50

  • VIDEO_PLAYED_75

  • IMPRESSIONS_WITH_INTERACTIONS

  • IMPRESSIONS_WITH_DWELL

conversionActivityId

For cost model CPA, ID of the conversion activity.

String

Required

In case of All Conversions, this value is -1.

conversionId

Internal.

Internal

Internal

costModel

Total cost for the ad for a specific period. Calculation depends on the Cost-Based Model.

  • CPA: Cost per Conversion

  • CPC: Cost per Click

  • CPCV: Cost per Video Fully Played

  • CPE: Cost per User Interaction

  • CPM: Cost per Impression

  • CPV: Cost per Video Starts

  • Flat Fee: Cost is fixed and calculated as ((booked cost)/(number of scheduled days or hours) * (Number of running days or hours past the start date - within time periods))

  • Time-Based: Cost is fixed for a prearranged time period. There is no cost for days without delivery.

  • Zero Cost: Placement cost is free (no cost for the advertiser).

String

Required
View values

  • CPA

  • CPC

  • CPCV

  • CPE

  • CPM

  • CPV

  • TIME_BASED_SPONSORSHIP

  • ZERO_COST

  • FLAT_FEE

customInteraction

Internal.

Internal

Internal

ignoreOverDelivery

For reporting purposes, determines whether the report should ignore over delivery in calculating media cost.

Boolean

Required

interactionId

Internal.

Internal

Internal

orderedUnits

Ordered units for costs set for the placement.

Integer

Optional

Value to set should be below 2 billion.

rate

Cost of the placement according to its cost model.

Optional

Optional

type

Type of entity.

String

Read-only

MediaCost

Object JSON Example

Example
...
"mediaCostData":{
            "type":"MediaCost",
            "costModel":"TIME_BASED_SPONSORSHIP",
            "rate":2.0,
            "orderedUnits":null,
            "actionType":null,
            "customInteraction":null,
            "conversionId":null,
            "interactionId":null,
            "ignoreOverDelivery":true,
            "conversionActivityId":null
         },
...

mediaServingData Object

mediaServingData 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

endDate

End date of placement.

Long

Required

Stored in Epoch time.

hardStopMethod

Continue serving settings according to end date or booked units.

String

Required
View values

  • KEEP_SERVING_AS_USUAL

  • BOTH_IMPRESSIONS_AND_END_DATE

  • IMPRESSIONS_OR_END_DATE

  • ON_END_DATE

  • ON_VOLUME_GOAL

startDate

Start date of placement.

Long

Required

units

Booked impressions.

Integer

Optional

Object JSON Example

Example
...
"mediaServingData":{
            "units":null,
            "hardStopMethod":"KEEP_SERVING_AS_USUAL",
            "startDate":1515110400000,//add millisecond sample 1515110400 + 000(milliseconds)
            "endDate":1525132799999
         },//add milliseconds sample 1525132799 + 999(milliseconds)
...
Was this article helpful?
0 out of 0 found this helpful
Have more questions? Submit a request

Comments