Placements

For a list of methods for this resource, see the end of this page.

Resource representations

Contains properties of a placement.

{
  "kind": "dfareporting#placement",
  "id": long,
  "idDimensionValue": dimensionValues Resource,
  "accountId": long,
  "subaccountId": long,
  "advertiserId": long,
  "advertiserIdDimensionValue": dimensionValues Resource,
  "campaignId": long,
  "campaignIdDimensionValue": dimensionValues Resource,
  "name": string,
  "siteId": long,
  "siteIdDimensionValue": dimensionValues Resource,
  "keyName": string,
  "directorySiteId": long,
  "directorySiteIdDimensionValue": dimensionValues Resource,
  "paymentSource": string,
  "compatibility": string,
  "size": sizes Resource,
  "additionalSizes": [
    sizes Resource
  ],
  "archived": boolean,
  "paymentApproved": boolean,
  "pricingSchedule": {
    "testingStartDate": date,
    "startDate": date,
    "endDate": date,
    "pricingType": string,
    "capCostOption": string,
    "disregardOverdelivery": boolean,
    "flighted": boolean,
    "pricingPeriods": [
      {
        "startDate": date,
        "endDate": date,
        "units": long,
        "rateOrCostNanos": long,
        "pricingComment": string
      }
    ],
    "floodlightActivityId": long
  },
  "placementGroupId": long,
  "placementGroupIdDimensionValue": dimensionValues Resource,
  "primary": boolean,
  "tagSetting": {
    "additionalKeyValues": string,
    "includeClickTracking": boolean,
    "includeClickThroughUrls": boolean,
    "keywordOption": string
  },
  "tagFormats": [
    string
  ],
  "contentCategoryId": long,
  "placementStrategyId": long,
  "lookbackConfiguration": {
    "clickDuration": integer,
    "postImpressionActivitiesDuration": integer
  },
  "comment": string,
  "status": string,
  "publisherUpdateInfo": {
    "time": long
  },
  "createInfo": {
    "time": long
  },
  "lastModifiedInfo": {
    "time": long
  },
  "sslRequired": boolean,
  "externalId": string,
  "videoSettings": {
    "kind": "dfareporting#videoSettings",
    "companionSettings": {
      "kind": "dfareporting#companionSetting",
      "companionsDisabled": boolean,
      "enabledSizes": [
        sizes Resource
      ],
      "imageOnly": boolean
    },
    "transcodeSettings": {
      "kind": "dfareporting#transcodeSetting",
      "enabledVideoFormats": [
        integer
      ]
    },
    "skippableSettings": {
      "kind": "dfareporting#skippableSetting",
      "skippable": boolean,
      "skipOffset": {
        "offsetSeconds": integer,
        "offsetPercentage": integer
      },
      "progressOffset": {
        "offsetSeconds": integer,
        "offsetPercentage": integer
      }
    },
    "orientation": string
  },
  "videoActiveViewOptOut": boolean,
  "vpaidAdapterChoice": string,
  "adBlockingOptOut": boolean
}

Property name	Value	Description
`accountId`	`long`	Account ID of this placement. This field can be left blank.
`adBlockingOptOut`	`boolean`	Whether this placement opts out of ad blocking. When true, ad blocking is disabled for this placement. When false, the campaign and site settings take effect.
`additionalSizes[]`	`list`	Additional sizes associated with this placement. When inserting or updating a placement, only the size ID field is used.
`advertiserId`	`long`	Advertiser ID of this placement. This field can be left blank.
`advertiserIdDimensionValue`	`nested object`	Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
`archived`	`boolean`	Whether this placement is archived.
`campaignId`	`long`	Campaign ID of this placement. This field is a required field on insertion.
`campaignIdDimensionValue`	`nested object`	Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
`comment`	`string`	Comments for this placement.
`compatibility`	`string`	Placement compatibility. `DISPLAY` and `DISPLAY_INTERSTITIAL` refer to rendering on desktop, on mobile devices or in mobile apps for regular or interstitial ads respectively. `APP` and `APP_INTERSTITIAL` are no longer allowed for new placement insertions. Instead, use `DISPLAY` or `DISPLAY_INTERSTITIAL`. `IN_STREAM_VIDEO` refers to rendering in in-stream video ads developed with the VAST standard. This field is required on insertion. Acceptable values are: "`APP`" "`APP_INTERSTITIAL`" "`DISPLAY`" "`DISPLAY_INTERSTITIAL`" "`IN_STREAM_AUDIO`" "`IN_STREAM_VIDEO`"
`contentCategoryId`	`long`	ID of the content category assigned to this placement.
`createInfo`	`nested object`	Information about the creation of this placement. This is a read-only field.
`createInfo.time`	`long`	Timestamp of the last change in milliseconds since epoch.
`directorySiteId`	`long`	Directory site ID of this placement. On insert, you must set either this field or the `siteId` field to specify the site associated with this placement. This is a required field that is read-only after insertion.
`directorySiteIdDimensionValue`	`nested object`	Dimension value for the ID of the directory site. This is a read-only, auto-generated field.
`externalId`	`string`	External ID for this placement.
`id`	`long`	ID of this placement. This is a read-only, auto-generated field.
`idDimensionValue`	`nested object`	Dimension value for the ID of this placement. This is a read-only, auto-generated field.
`keyName`	`string`	Key name of this placement. This is a read-only, auto-generated field.
`kind`	`string`	Identifies what kind of resource this is. Value: the fixed string `"dfareporting#placement"`.
`lastModifiedInfo`	`nested object`	Information about the most recent modification of this placement. This is a read-only field.
`lastModifiedInfo.time`	`long`	Timestamp of the last change in milliseconds since epoch.
`lookbackConfiguration`	`nested object`	Lookback window settings for this placement.
`lookbackConfiguration.clickDuration`	`integer`	Lookback window, in days, from the last time a given user clicked on one of your ads. If you enter 0, clicks will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used. Acceptable values are `0` to `90`, inclusive.
`lookbackConfiguration.postImpressionActivitiesDuration`	`integer`	Lookback window, in days, from the last time a given user viewed one of your ads. If you enter 0, impressions will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used. Acceptable values are `0` to `90`, inclusive.
`name`	`string`	Name of this placement.This is a required field and must be less than or equal to 256 characters long.
`paymentApproved`	`boolean`	Whether payment was approved for this placement. This is a read-only field relevant only to publisher-paid placements.
`paymentSource`	`string`	Payment source for this placement. This is a required field that is read-only after insertion. Acceptable values are: "`PLACEMENT_AGENCY_PAID`" "`PLACEMENT_PUBLISHER_PAID`"
`placementGroupId`	`long`	ID of this placement's group, if applicable.
`placementGroupIdDimensionValue`	`nested object`	Dimension value for the ID of the placement group. This is a read-only, auto-generated field.
`placementStrategyId`	`long`	ID of the placement strategy assigned to this placement.
`pricingSchedule`	`nested object`	Pricing schedule of this placement. This field is required on insertion, specifically subfields `startDate`, `endDate` and `pricingType`.
`pricingSchedule.capCostOption`	`string`	Placement cap cost option. Acceptable values are: "`CAP_COST_CUMULATIVE`" "`CAP_COST_MONTHLY`" "`CAP_COST_NONE`"
`pricingSchedule.disregardOverdelivery`	`boolean`	Whether cap costs are ignored by ad serving.
`pricingSchedule.endDate`	`date`	Placement end date. This date must be later than, or the same day as, the placement start date, but not later than the campaign end date. If, for example, you set 6/25/2015 as both the start and end dates, the effective placement date is just that day only, 6/25/2015. The hours, minutes, and seconds of the end date should not be set, as doing so will result in an error. This field is required on insertion.
`pricingSchedule.flighted`	`boolean`	Whether this placement is flighted. If true, pricing periods will be computed automatically.
`pricingSchedule.floodlightActivityId`	`long`	Floodlight activity ID associated with this placement. This field should be set when placement pricing type is set to `PRICING_TYPE_CPA`.
`pricingSchedule.pricingPeriods[]`	`list`	Pricing periods for this placement.
`pricingSchedule.pricingPeriods[].endDate`	`date`	Pricing period end date. This date must be later than, or the same day as, the pricing period start date, but not later than the placement end date. The period end date can be the same date as the period start date. If, for example, you set 6/25/2015 as both the start and end dates, the effective pricing period date is just that day only, 6/25/2015. The hours, minutes, and seconds of the end date should not be set, as doing so will result in an error.
`pricingSchedule.pricingPeriods[].pricingComment`	`string`	Comments for this pricing period.
`pricingSchedule.pricingPeriods[].rateOrCostNanos`	`long`	Rate or cost of this pricing period in nanos (i.e., multipled by 1000000000). Acceptable values are `0` to `1000000000000000000`, inclusive.
`pricingSchedule.pricingPeriods[].startDate`	`date`	Pricing period start date. This date must be later than, or the same day as, the placement start date. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error.
`pricingSchedule.pricingPeriods[].units`	`long`	Units of this pricing period. Acceptable values are `0` to `10000000000`, inclusive.
`pricingSchedule.pricingType`	`string`	Placement pricing type. This field is required on insertion. Acceptable values are: "`PRICING_TYPE_CPA`" "`PRICING_TYPE_CPC`" "`PRICING_TYPE_CPM`" "`PRICING_TYPE_CPM_ACTIVEVIEW`" "`PRICING_TYPE_FLAT_RATE_CLICKS`" "`PRICING_TYPE_FLAT_RATE_IMPRESSIONS`"
`pricingSchedule.startDate`	`date`	Placement start date. This date must be later than, or the same day as, the campaign start date. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error. This field is required on insertion.
`pricingSchedule.testingStartDate`	`date`	Testing start date of this placement. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error.
`primary`	`boolean`	Whether this placement is the primary placement of a roadblock (placement group). You cannot change this field from true to false. Setting this field to true will automatically set the `primary` field on the original primary placement of the roadblock to false, and it will automatically set the roadblock's `primaryPlacementId` field to the ID of this placement.
`publisherUpdateInfo`	`nested object`	Information about the last publisher update. This is a read-only field.
`publisherUpdateInfo.time`	`long`	Timestamp of the last change in milliseconds since epoch.
`siteId`	`long`	Site ID associated with this placement. On insert, you must set either this field or the `directorySiteId` field to specify the site associated with this placement. This is a required field that is read-only after insertion.
`siteIdDimensionValue`	`nested object`	Dimension value for the ID of the site. This is a read-only, auto-generated field.
`size`	`nested object`	Size associated with this placement. When inserting or updating a placement, only the size ID field is used. This field is required on insertion.
`sslRequired`	`boolean`	Whether creatives assigned to this placement must be SSL-compliant.
`status`	`string`	Third-party placement status. Acceptable values are: "`ACKNOWLEDGE_ACCEPTANCE`": Advertiser has accepted acceptance of placement ad serving fee. "`ACKNOWLEDGE_REJECTION`": Advertiser has accepted rejection of placement ad serving fee. "`DRAFT`": Placement is not yet reviewed by publisher. "`PAYMENT_ACCEPTED`": Placement Ad Serving fee is accepted by publisher. "`PAYMENT_REJECTED`": Placement Ad Serving fee is rejected by publisher. "`PENDING_REVIEW`": Placement is not yet reviewed by publisher.
`subaccountId`	`long`	Subaccount ID of this placement. This field can be left blank.
`tagFormats[]`	`list`	Tag formats to generate for this placement. This field is required on insertion. Acceptable values are: "`PLACEMENT_TAG_STANDARD`" "`PLACEMENT_TAG_IFRAME_JAVASCRIPT`" "`PLACEMENT_TAG_IFRAME_ILAYER`" "`PLACEMENT_TAG_INTERNAL_REDIRECT`" "`PLACEMENT_TAG_JAVASCRIPT`" "`PLACEMENT_TAG_INTERSTITIAL_IFRAME_JAVASCRIPT`" "`PLACEMENT_TAG_INTERSTITIAL_INTERNAL_REDIRECT`" "`PLACEMENT_TAG_INTERSTITIAL_JAVASCRIPT`" "`PLACEMENT_TAG_CLICK_COMMANDS`" "`PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH`" "`PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH_VAST_3`" "`PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH_VAST_4`" "`PLACEMENT_TAG_TRACKING`" "`PLACEMENT_TAG_TRACKING_IFRAME`" "`PLACEMENT_TAG_TRACKING_JAVASCRIPT`"
`tagSetting`	`nested object`	Tag settings for this placement.
`tagSetting.additionalKeyValues`	`string`	Additional key-values to be included in tags. Each key-value pair must be of the form `key=value`, and pairs must be separated by a semicolon (`;`). Keys and values must not contain commas. For example, `id=2;color=red` is a valid value for this field.
`tagSetting.includeClickThroughUrls`	`boolean`	Whether static landing page URLs should be included in the tags. This setting applies only to placements.
`tagSetting.includeClickTracking`	`boolean`	Whether click-tracking string should be included in the tags.
`tagSetting.keywordOption`	`string`	Option specifying how keywords are embedded in ad tags. This setting can be used to specify whether keyword placeholders are inserted in placement tags for this site. Publishers can then add keywords to those placeholders. Acceptable values are: "`GENERATE_SEPARATE_TAG_FOR_EACH_KEYWORD`" "`IGNORE`" "`PLACEHOLDER_WITH_LIST_OF_KEYWORDS`"
`videoActiveViewOptOut`	`boolean`	Whether Verification and ActiveView are disabled for in-stream video creatives for this placement. The same setting `videoActiveViewOptOut` exists on the site level -- the opt out occurs if either of these settings are true. These settings are distinct from `DirectorySites.settings.activeViewOptOut` or `Sites.siteSettings.activeViewOptOut` which only apply to display ads. However, `Accounts.activeViewOptOut` opts out both video traffic, as well as display ads, from Verification and ActiveView.
`videoSettings`	`nested object`	A collection of settings which affect video creatives served through this placement. Applicable to placements with `IN_STREAM_VIDEO` compatibility.
`videoSettings.companionSettings`	`nested object`	Settings for the companion creatives of video creatives served to this placement.
`videoSettings.companionSettings.companionsDisabled`	`boolean`	Whether companions are disabled for this placement.
`videoSettings.companionSettings.enabledSizes[]`	`list`	Allowlist of companion sizes to be served to this placement. Set this list to null or empty to serve all companion sizes.
`videoSettings.companionSettings.imageOnly`	`boolean`	Whether to serve only static images as companions.
`videoSettings.companionSettings.kind`	`string`	Identifies what kind of resource this is. Value: the fixed string `"dfareporting#companionSetting"`.
`videoSettings.kind`	`string`	Identifies what kind of resource this is. Value: the fixed string `"dfareporting#videoSettings"`.
`videoSettings.orientation`	`string`	Orientation of a video placement. If this value is set, placement will return assets matching the specified orientation. Acceptable values are: "`ANY`" "`LANDSCAPE`" "`PORTRAIT`"
`videoSettings.skippableSettings`	`nested object`	Settings for the skippability of video creatives served to this placement. If this object is provided, the creative-level skippable settings will be overridden.
`videoSettings.skippableSettings.kind`	`string`	Identifies what kind of resource this is. Value: the fixed string `"dfareporting#skippableSetting"`.
`videoSettings.skippableSettings.progressOffset`	`nested object`	Amount of time to play videos served to this placement before counting a view. Applicable when `skippable` is true.
`videoSettings.skippableSettings.progressOffset.offsetPercentage`	`integer`	Duration, as a percentage of video duration. Do not set when `offsetSeconds` is set. Acceptable values are `0` to `100`, inclusive.
`videoSettings.skippableSettings.progressOffset.offsetSeconds`	`integer`	Duration, in seconds. Do not set when `offsetPercentage` is set. Acceptable values are `0` to `86399`, inclusive.
`videoSettings.skippableSettings.skipOffset`	`nested object`	Amount of time to play videos served to this placement before the skip button should appear. Applicable when `skippable` is true.
`videoSettings.skippableSettings.skipOffset.offsetPercentage`	`integer`	Duration, as a percentage of video duration. Do not set when `offsetSeconds` is set. Acceptable values are `0` to `100`, inclusive.
`videoSettings.skippableSettings.skipOffset.offsetSeconds`	`integer`	Duration, in seconds. Do not set when `offsetPercentage` is set. Acceptable values are `0` to `86399`, inclusive.
`videoSettings.skippableSettings.skippable`	`boolean`	Whether the user can skip creatives served to this placement.
`videoSettings.transcodeSettings`	`nested object`	Settings for the transcodes of video creatives served to this placement. If this object is provided, the creative-level transcode settings will be overridden.
`videoSettings.transcodeSettings.enabledVideoFormats[]`	`list`	Allowlist of video formats to be served to this placement. Set this list to null or empty to serve all video formats.
`videoSettings.transcodeSettings.kind`	`string`	Identifies what kind of resource this is. Value: the fixed string `"dfareporting#transcodeSetting"`.
`vpaidAdapterChoice`	`string`	VPAID adapter setting for this placement. Controls which VPAID format the measurement adapter will use for in-stream video creatives assigned to this placement. Note: Flash is no longer supported. This field now defaults to `HTML5` when the following values are provided: `FLASH`, `BOTH`. Acceptable values are: "`BOTH`" "`DEFAULT`" "`FLASH`" "`HTML5`"

Methods

generatetags: Generates tags for a placement.
get: Gets one placement by ID.
insert: Inserts a new placement.
list: Retrieves a list of placements, possibly filtered. This method supports paging.
patch: Updates an existing placement. This method supports patch semantics.
update: Updates an existing placement.