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 inStreamVideoTracking Placement Object

inStreamVideoTracking Placement 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

actualStartDate

First impression date (Date epoch).

Long

Read-only

allowHTML5DynamicExpansion

Enables the system to automatically detect the direction in which HTML5 expandable ads should expand during serving.

Boolean

Required

Required in a programmatic environment, where the location of the ad that will be displayed is not known in advance.

analyticsData

Contains a set of analytics metrics. Appears in a box on the placements page.

placementAnalyticsData Object

Read-only

attached

Determines whether placement is attached to an ad.

Boolean

Read-only

brandTimeZone

Time zone for brand. Used in the Delivery Group that is attached to the placement.

String

Read-only
View values

  • GMT_Minus_12

  • GMT_Minus_11

  • GMT_Minus_10

  • GMT_Minus_09

  • GMT_Minus_08

  • GMT_Minus_07

  • GMT_Minus_06

  • GMT_Minus_05

  • GMT_Minus_04

  • GMT_Minus_03

  • GMT_Minus_02

  • GMT_Minus_01

  • GMT

  • GMT_Plus_01

  • GMT_Plus_02

  • GMT_Plus_03

  • GMT_Plus_04

  • GMT_Plus_05

  • GMT_Plus_06

  • GMT_Plus_07

  • GMT_Plus_08

  • GMT_Plus_09

  • GMT_Plus_10

  • GMT_Plus_11

  • GMT_Plus_12

campaignId

Placement's campaign ID.

Long

Required

Searchable field for placement.

campaignName

Placement campaign name.

String

Read-only

Searchable field for placement.

cookieSyncType

Internal.

Internal

Internal

createdBy

ID of the user who created the placement.

Long

Read-only

createdByAccount

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

Long

Read-only

createdByAccountName

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

String

Read-only

createdByName

Name of the user who created the placement.

Long

Read-only

createdOn

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

Long

Read-only

customFields

Custom fields display custom metadata that can be used, for example, as a token on click-throughs and 3rd party events, or in AAS reporting.

customFields Object

Optional

disableCookies

Disable or enable cookies for placement.

Boolean

Optional

id

ID of the placement.

Long

Read-only

lastPublished

Last time placement was published.

Long

Read-only

Stored in Epoch time.

lastUpdatedBy

ID of the user who last updated the placement.

Long

Read-only

lastUpdatedByAccount

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

Long

Read-only

lastUpdatedByAccountName

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

String

Read-only

lastUpdatedByName

Name of the user who last updated the placement.

String

Read-only

lastUpdateOn

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

Long

Read-only

mobileApplicationAdEnabler

Type of mobile support .

String

Required
View values

  • AdMarvel

  • DFP

  • MOCEAN

  • MRAID

  • MRAID2

  • ORMMA

  • Custom

name

Name of the placement.

String

Required

packageId

Placement package ID.

Long

Optional

Searchable field for placement.

packageName

Name of package for this placement. AAS creates a default package if none exists for the placement.

String

Read-only

Searchable field for placement.

placementAdCount

Number of ads attached to placement.

Integer

Read-only

placementAttachmentData

Object that describes the placement's attachment.

placementAttachmentData Object

Read-only

placementMV

Determines whether placement is mass version.

Boolean

Required

True when a placement is attached to a DCO ad.

placementType

Type of placement.

String

Required

Value: IN_STREAM_VIDEO_TRACKING

relationsBag

Internal.

relationsBag Object

Internal

sectionId

ID of Site section where the placement will serve.

Long

Optional

sectionName

Name of Site section where the placement will serve.

String

Read-only

servingAndCostData

Serving and cost data for placement.

servingAndCostData Object

Required

siteId

Placement site ID.

Long

Required

Searchable field for placement and placement package.

status

Placement status.

String

Read-only
View values

  • New

  • Published

  • Enabled

  • PendingIO

  • Live

  • Idle

Searchable field for placement.

tagBuilderParams

Parameters to build tag for placement.

tagBuilderParams Object

Optional

trackingAds

Internal.

Internal

Internal

type

Type of entity.

String

Required

InstreamVideoTrackingPlacement

placementDGData

Internal.

Internal

Internal

controlOverDelivery

Internal.

Internal

Internal

supportMobileApplications

Internal.

Internal

Internal

deliveryRate

Internal.

Internal

Internal

publisherTargetingIds

Media targeting audience assigned to placement.

Long

Optional

mode

Internal.

Internal

Internal

specialInstructions

Internal.

String

Optional

allowServingInAutoRefreshSite

Internal.

Internal

Internal

defaultTrackingAd

Internal.

Internal

Internal

hardStop

Internal.

Internal

Internal

bandwidth

Internal.

Internal

Internal

Object JSON Example

Example
{
  "result": {
    "type": "InstreamVideoTrackingPlacement",
    "id": 1083950803,
    "relationsBag": {
      "parents": {
        "account": {
          "id": 1073746545,
          "name": "Testing Account",
          "internal": true
        },
        "advertiser": {
          "id": 1083748396,
          "name": "check"
        },
        "brand": {
          "id": 1083754554,
          "name": "check"
        },
        "campaign": {
          "id": 1083793752,
          "name": "ItzikCampaign"
        },
        "site": {
          "id": 1083768135,
          "name": "DataGovernanceWithSpecifecData"
        }
      },
      "children": {
        "advertisers": {
          "count": 0
        },
        "brands": {
          "count": 0
        },
        "campaigns": {
          "count": 0
        },
        "users": {
          "count": 0
        }
      },
      "creativeAccountContact": false
    },
    "version": 1561881044582989800,
    "createdBy": 1073741831,
    "createdByName": "User",
    "createdByAccount": 1073741826,
    "createdByAccountName": "Account",
    "createdOn": 1537431552174,
    "lastUpdatedBy": 1073741831,
    "lastUpdatedByName": "User",
    "lastUpdatedByAccount": 1073741826,
    "lastUpdatedByAccountName": "Account",
    "lastUpdateOn": 1561881044585,
    "name": "name",
    "campaignId": 1083793752,
    "campaignName": "Campaign",
    "siteId": 1083768135,
    "sectionId": null,
    "placementType": "IN_STREAM_VIDEO_TRACKING",
    "status": "Published",
    "packageId": 1083947436,
    "servingAndCostData": {
      "mediaServingData": {
        "units": 50000,
        "hardStopMethod": "KEEP_SERVING_AS_USUAL",
        "startDate": 1537401600000,
        "endDate": 1538524799999
      },
      "mediaCostData": {
        "type": "MediaCost",
        "costModel": "CPM",
        "rate": 1,
        "orderedUnits": null,
        "actionType": null,
        "customInteraction": null,
        "conversionId": null,
        "interactionId": null,
        "ignoreOverDelivery": true,
        "conversionActivityId": null
      },
      "placementLevel": true,
      "isHardStop": false,
      "id": 1083947436
    },
    "mediaServingAndCostData": null,
    "hardStopMethod": null,
    "tagBuilderParams": {
      "type": "TagBuilderParams",
      "id": null,
      "relationsBag": null,
      "placementId": null,
      "builderTagTypes": [
        "AUTO_DETECT"
      ],
      "siteServing": {
        "secureServingProtocol": "HTTP",
        "lineIdToken": "1",
        "customToken": "FALK",
        "zipCodeToken": null,
        "countryToken": null,
        "serverDomainName": "bs.serving-sys-int.com",
        "cacheBustingToken": "+Ads_Timestamp+",
        "publisherCustomParam": "k1AGpmq7To",
        "minZIndex": "1",
        "impTracking": "uacSAsIvLn",
        "clickTracking": "W9NH9xTALx",
        "escapeNoScript": true,
        "generateMultipleTags": true,
        "generateIMGTag": true,
        "firstPartyAdIdToken": null,
        "disableCookies": false,
        "generateKeywords": false
      },
      "placementType": "IN_STREAM_VIDEO_TRACKING",
      "exposeKwTag": null
    },
    "analyticsData": {
      "impressions": 0,
      "clicks": 255,
      "lastUpdated": 1560140023000,
      "ctr": "Infinity",
      "actualStartDate": 1548665644000
    },
    "sectionName": null,
    "placementDGData": [],
    "lastPublished": 1561881044568,
    "adEnableBaseUrl": "",
    "placementMV": false,
    "testImpressions": 1000,
    "targetingValue": "",
    "disableCookies": false,
    "startTimeOfDay": 0,
    "endTimeOfDay": 0,
    "controlOverDelivery": false,
    "collectWebPage": false,
    "impressionForWholePlacement": -1,
    "mobileApplicationAdEnabler": "AdMarvel",
    "supportMobileApplications": false,
    "placementAdCount": 1,
    "placementAttachmentData": {
      "attachedToUntargeted": false,
      "targetAudienceIds": []
    },
    "packageName": "PKG",
    "actualStartDate": 1548665644000,
    "allowHTML5DynamicExpansion": false,
    "brandTimeZone": "GMT_Plus_12",
    "customFields": null,
    "deliveryRate": null,
    "publisherTargetingIds": null,
    "mode": "ENABLED",
    "specialInstructions": null,
    "cookieSyncType": "INHERIT_FROM_PLACEMENT",
    "allowServingInAutoRefreshSite": false,
    "adInsertion": "InheritFromSite",
    "startDate": 1537444800000,
    "endDate": 1538567999999,
    "defaultTrackingAd": {
      "type": "InstreamVideoTrackingPixelAd",
      "id": 1084436845,
      "relationsBag": null,
      "version": 1545741726414733300,
      "createdBy": 1073741831,
      "createdByName": "User",
      "createdByAccount": 1073741826,
      "createdByAccountName": "Account",
      "createdOn": 1537431552147,
      "lastUpdatedBy": 1073741831,
      "lastUpdatedByName": "User",
      "lastUpdatedByAccount": 1073741826,
      "lastUpdatedByAccountName": "Account",
      "lastUpdateOn": 1538987418536,
      "name": "name",
      "masterAdId": 1084436843,
      "changed": true,
      "adStatus": "PUBLISHED",
      "enabled": true,
      "adFormat": "INSTREAM_VIDEO_TRACKING_PIXEL_AD",
      "adFormatId": 24,
      "adFormatName": "In-Stream Video Tracking Pixel",
      "accountId": 1073746545,
      "accountName": "Testing Account",
      "placementId": 1083950803,
      "placementName": "name",
      "placementType": "IN_STREAM_VIDEO_TRACKING",
      "siteId": 1083768135,
      "siteName": "DataGovernanceWithSpecifecData",
      "adAssignmentData": {
        "type": "AdAssignmentData",
        "accountId": 1073746545,
        "accountName": "Testing Account",
        "advertiserId": 1083748396,
        "advertiserName": "check",
        "brandId": 1083754554,
        "brandName": "check",
        "campaignId": 1083793752,
        "campaignName": "Campaign"
      },
      "mainClickthrough": null,
      "adURLs": null,
      "pricingSize": 0,
      "overallSize": 0,
      "initialSize": 0,
      "width": 1,
      "height": 1,
      "dimensions": "1x1",
      "templateScriptName": "Tracking",
      "urlTokens": null,
      "minAudioVersion": 0,
      "fourthPartyTag": "",
      "adChoicesStatus": false,
      "adChoicesLocation": null,
      "qaStatus": "NOT_SUBMITTED",
      "numberOfPlacementAds": 0,
      "overallNumberOfPlacementAds": 0,
      "servingMethod": null,
      "analyticsData": {
        "impressions": null,
        "clicks": null,
        "lastUpdated": null,
        "ctr": null,
        "actualStartDate": null
      },
      "analyticsSettings": null,
      "customFields": null,
      "massVersioning": false,
      "usedAsTemplate": false,
      "unSavedTemplateAd": false,
      "adTemplateId": null,
      "feedEnabled": null,
      "feedStatus": null,
      "enableTimeBasedServing": false,
      "servingTimeZoneType": null,
      "videoAudioAdAssetData": [],
      "priorityPolicy": "Server",
      "adFeatures": [],
      "firstPartyAdId": "",
      "firstPartyAdName": null,
      "default": true,
      "native": false,
      "containsNonWorkspaceAssets": true,
      "trackingType": "ImpressionsAndClicks"
    },
    "asyncMode": false,
    "bandwidth": false,
    "adBlocking": false,
    "supportMobileApplication": false,
    "hardStop": false,
    "attached": true,
    "trackingAds": [
      {
        "type": "InstreamVideoTrackingPixelAd",
        "id": 1084436844,
        "relationsBag": null,
        "version": 1559043402119708700,
        "createdBy": 1073741831,
        "createdByName": "User",
        "createdByAccount": 1073741826,
        "createdByAccountName": "Account",
        "createdOn": 1537431552142,
        "lastUpdatedBy": 1073741831,
        "lastUpdatedByName": "User",
        "lastUpdatedByAccount": 1073741826,
        "lastUpdatedByAccountName": "Account",
        "lastUpdateOn": 1559043402121,
        "name": "name",
        "masterAdId": 1084436843,
        "changed": true,
        "adStatus": "PUBLISHED",
        "enabled": true,
        "adFormat": "INSTREAM_VIDEO_TRACKING_PIXEL_AD",
        "adFormatId": 24,
        "adFormatName": "In-Stream Video Tracking Pixel",
        "accountId": 1073746545,
        "accountName": "Testing Account",
        "placementId": 1083950803,
        "placementName": "name",
        "placementType": "IN_STREAM_VIDEO_TRACKING",
        "siteId": 1083768135,
        "siteName": "DataGovernanceWithSpecifecData",
        "adAssignmentData": {
          "type": "AdAssignmentData",
          "accountId": 1073746545,
          "accountName": "Testing Account",
          "advertiserId": 1083748396,
          "advertiserName": "check",
          "brandId": 1083754554,
          "brandName": "check",
          "campaignId": 1083793752,
          "campaignName": "ItzikCampaign"
        },
        "mainClickthrough": {
          "type": "MainClickthrough",
          "id": null,
          "relationsBag": null,
          "url": "",
          "targetWindowType": null,
          "showAddressBar": false,
          "showMenuBar": false,
          "closeAllAdParts": false
        },
        "adURLs": [
          {
            "type": "ThirdPartyURL",
            "id": 69274938262343,
            "relationsBag": null,
            "url": "https://blasdadasls.com",
            "urlType": "CLICK_TRACKING",
            "enabled": false,
            "urlSource": "AD",
            "externalId": "1",
            "uniqueIdentifier": "CLICK_TRACKING_1",
            "customScriptId": null,
            "disableServing": true
          }
        ],
        "pricingSize": 0,
        "overallSize": 0,
        "initialSize": 0,
        "width": 1,
        "height": 1,
        "dimensions": "1x1",
        "templateScriptName": "Tracking",
        "urlTokens": null,
        "minAudioVersion": 0,
        "fourthPartyTag": "",
        "adChoicesStatus": false,
        "adChoicesLocation": null,
        "qaStatus": "NOT_SUBMITTED",
        "numberOfPlacementAds": 0,
        "overallNumberOfPlacementAds": 0,
        "servingMethod": null,
        "analyticsData": {
          "impressions": null,
          "clicks": null,
          "lastUpdated": null,
          "ctr": null,
          "actualStartDate": null
        },
        "analyticsSettings": null,
        "customFields": null,
        "massVersioning": false,
        "usedAsTemplate": false,
        "unSavedTemplateAd": false,
        "adTemplateId": null,
        "feedEnabled": null,
        "feedStatus": null,
        "enableTimeBasedServing": false,
        "servingTimeZoneType": null,
        "videoAudioAdAssetData": [],
        "priorityPolicy": "Server",
        "adFeatures": [],
        "firstPartyAdId": "",
        "firstPartyAdName": "",
        "default": false,
        "native": false,
        "containsNonWorkspaceAssets": true,
        "trackingType": "ImpressionsAndClicks"
      }
    ]
  }
}
Was this article helpful?
0 out of 0 found this helpful
Have more questions? Submit a request

Comments