REST Resource: placements

{
  "id": string,
  "accountId": string,
  "subaccountId": string,
  "advertiserId": string,
  "campaignId": string,
  "name": string,
  "siteId": string,
  "keyName": string,
  "directorySiteId": string,
  "paymentSource": enum (PaymentSource),
  "compatibility": enum (Compatibility),
  "size": {
    object (Size)
  },
  "archived": boolean,
  "paymentApproved": boolean,
  "pricingSchedule": {
    object (PricingSchedule)
  },
  "placementGroupId": string,
  "primary": boolean,
  "tagSetting": {
    object (TagSetting)
  },
  "tagFormats": [
    enum (TagFormats)
  ],
  "contentCategoryId": string,
  "placementStrategyId": string,
  "lookbackConfiguration": {
    object (LookbackConfiguration)
  },
  "comment": string,
  "status": enum (Status),
  "publisherUpdateInfo": {
    object (LastModifiedInfo)
  },
  "lastModifiedInfo": {
    object (LastModifiedInfo)
  },
  "sslRequired": boolean,
  "kind": string,
  "idDimensionValue": {
    object (DimensionValue)
  },
  "advertiserIdDimensionValue": {
    object (DimensionValue)
  },
  "campaignIdDimensionValue": {
    object (DimensionValue)
  },
  "siteIdDimensionValue": {
    object (DimensionValue)
  },
  "directorySiteIdDimensionValue": {
    object (DimensionValue)
  },
  "placementGroupIdDimensionValue": {
    object (DimensionValue)
  },
  "externalId": string,
  "createInfo": {
    object (LastModifiedInfo)
  },
  "videoSettings": {
    object (VideoSettings)
  },
  "videoActiveViewOptOut": boolean,
  "vpaidAdapterChoice": enum (VpaidAdapterChoice),
  "adBlockingOptOut": boolean,
  "additionalSizes": [
    {
      object (Size)
    }
  ],
  "wrappingOptOut": boolean,
  "partnerWrappingData": {
    object (MeasurementPartnerWrappingData)
  }
}

string (int64 format)

ID of this placement. This is a read-only, auto-generated field.

string (int64 format)

Account ID of this placement. This field can be left blank.

string (int64 format)

Subaccount ID of this placement. This field can be left blank.

string (int64 format)

Advertiser ID of this placement. This field can be left blank.

string (int64 format)

Campaign ID of this placement. This field is a required field on insertion.

string

Name of this placement.This is a required field and must be less than or equal to 512 characters long.

string (int64 format)

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.

string

Key name of this placement. This is a read-only, auto-generated field.

string (int64 format)

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.

enum (PaymentSource)

Payment source for this placement. This is a required field that is read-only after insertion.

enum (Compatibility)

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.

object (Size)

Size associated with this placement. When inserting or updating a placement, only the size ID field is used. This field is required on insertion.

boolean

Whether this placement is archived.

boolean

Whether payment was approved for this placement. This is a read-only field relevant only to publisher-paid placements.

object (PricingSchedule)

Pricing schedule of this placement. This field is required on insertion, specifically subfields

startDate

,

endDate

and

pricingType

.

string (int64 format)

ID of this placement's group, if applicable.

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.

object (TagSetting)

Tag settings for this placement.

enum (TagFormats)

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

  "

string (int64 format)

ID of the content category assigned to this placement.

string (int64 format)

ID of the placement strategy assigned to this placement.

object (LookbackConfiguration)

Lookback window settings for this placement.

string

Comments for this placement.

enum (Status)

Third-party placement status.

object (LastModifiedInfo)

Information about the last publisher update. This is a read-only field.

object (LastModifiedInfo)

Information about the most recent modification of this placement. This is a read-only field.

boolean

Whether creatives assigned to this placement must be SSL-compliant.

string

Identifies what kind of resource this is. Value: the fixed string

"dfareporting#placement"

.

object (DimensionValue)

Dimension value for the ID of this placement. This is a read-only, auto-generated field.

object (DimensionValue)

Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.

object (DimensionValue)

Dimension value for the ID of the campaign. This is a read-only, auto-generated field.

object (DimensionValue)

Dimension value for the ID of the site. This is a read-only, auto-generated field.

object (DimensionValue)

Dimension value for the ID of the directory site. This is a read-only, auto-generated field.

object (DimensionValue)

Dimension value for the ID of the placement group. This is a read-only, auto-generated field.

string

External ID for this placement.

object (LastModifiedInfo)

Information about the creation of this placement. This is a read-only field.

object (VideoSettings)

A collection of settings which affect video creatives served through this placement. Applicable to placements with

IN_STREAM_VIDEO

compatibility.

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.

enum (VpaidAdapterChoice)

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

.

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.

object (Size)

Additional sizes associated with this placement. When inserting or updating a placement, only the size ID field is used.

boolean

Whether this placement opts out of tag wrapping.

object (MeasurementPartnerWrappingData)

Measurement partner provided settings for a wrapped placement.

{
  "companionSettings": {
    object (CompanionSetting)
  },
  "transcodeSettings": {
    object (TranscodeSetting)
  },
  "skippableSettings": {
    object (SkippableSetting)
  },
  "orientation": enum (Orientation),
  "kind": string,
  "obaSettings": {
    object (ObaIcon)
  },
  "obaEnabled": boolean,
  "durationSeconds": integer
}

object (CompanionSetting)

Settings for the companion creatives of video creatives served to this placement.

object (TranscodeSetting)

Settings for the transcodes of video creatives served to this placement. If this object is provided, the creative-level transcode settings will be overridden.

object (SkippableSetting)

Settings for the skippability of video creatives served to this placement. If this object is provided, the creative-level skippable settings will be overridden.

enum (Orientation)

Orientation of a video placement. If this value is set, placement will return assets matching the specified orientation.

string

Identifies what kind of resource this is. Value: the fixed string

"dfareporting#videoSettings"

.

object (ObaIcon)

Settings for the OBA icon of video creatives served to this placement. If this object is provided, the creative-level OBA settings will be overridden.

boolean

Whether OBA icons are enabled for this placement.

integer

Duration of a video placement in seconds.

{
  "companionsDisabled": boolean,
  "enabledSizes": [
    {
      object (Size)
    }
  ],
  "imageOnly": boolean,
  "kind": string
}

boolean

Whether companions are disabled for this placement.

object (Size)

Allowlist of companion sizes to be served to this placement. Set this list to null or empty to serve all companion sizes.

boolean

Whether to serve only static images as companions.

string

Identifies what kind of resource this is. Value: the fixed string

"dfareporting#companionSetting"

.

{
  "enabledVideoFormats": [
    integer
  ],
  "kind": string
}

integer

Allowlist of video formats to be served to this placement. Set this list to null or empty to serve all video formats.

string

Identifies what kind of resource this is. Value: the fixed string

"dfareporting#transcodeSetting"

.

{
  "skippable": boolean,
  "skipOffset": {
    object (VideoOffset)
  },
  "progressOffset": {
    object (VideoOffset)
  },
  "kind": string
}

boolean

Whether the user can skip creatives served to this placement.

object (VideoOffset)

Amount of time to play videos served to this placement before the skip button should appear. Applicable when

skippable

is true.

object (VideoOffset)

Amount of time to play videos served to this placement before counting a view. Applicable when

skippable

is true.

string

Identifies what kind of resource this is. Value: the fixed string

"dfareporting#skippableSetting"

.

{
  "measurementPartner": enum (MeasurementPartner),
  "linkStatus": enum (LinkStatus),
  "wrappedTag": string,
  "tagWrappingMode": enum (TagWrappingMode)
}

enum (MeasurementPartner)

Measurement partner used for wrapping the placement.

enum (LinkStatus)

Placement wrapping status.

string

Tag provided by the measurement partner during wrapping.

enum (TagWrappingMode)

Measurement mode for the wrapped placement.