List

23 variables

120 variables

Retrieves a list of placements, possibly filtered. This method supports paging

Authorization

To use this building block you will have to grant access to at least one of the following scopes:

View and manage your DoubleClick Campaign Manager's (DCM) display ad campaigns

Input

This building block consumes 23 input parameters

Name	Format	Description
`profileId` Required	`INTEGER`	User profile ID associated with this request
`advertiserIds`	`INTEGER`	Select only placements that belong to these advertisers
`archived`	`BOOLEAN`	Select only archived placements. Don't set this field to select both archived and non-archived placements
`campaignIds`	`INTEGER`	Select only placements that belong to these campaigns
`compatibilities`	`ENUMERATION`	Select only placements that are associated with these compatibilities. DISPLAY and DISPLAY_INTERSTITIAL refer to rendering either on desktop or on mobile devices for regular or interstitial ads respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps. IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard
`contentCategoryIds`	`INTEGER`	Select only placements that are associated with these content categories
`directorySiteIds`	`INTEGER`	Select only placements that are associated with these directory sites
`groupIds`	`INTEGER`	Select only placements that belong to these placement groups
`ids`	`INTEGER`	Select only placements with these IDs
`maxEndDate`	`STRING`	Select only placements or placement groups whose end date is on or before the specified maxEndDate. The date should be formatted as "yyyy-MM-dd"
`maxResults`	`INTEGER`	Maximum number of results to return
`maxStartDate`	`STRING`	Select only placements or placement groups whose start date is on or before the specified maxStartDate. The date should be formatted as "yyyy-MM-dd"
`minEndDate`	`STRING`	Select only placements or placement groups whose end date is on or after the specified minEndDate. The date should be formatted as "yyyy-MM-dd"
`minStartDate`	`STRING`	Select only placements or placement groups whose start date is on or after the specified minStartDate. The date should be formatted as "yyyy-MM-dd"
`pageToken`	`STRING`	Value of the nextPageToken from the previous result page
`paymentSource`	`ENUMERATION`	Select only placements with this payment source
`placementStrategyIds`	`INTEGER`	Select only placements that are associated with these placement strategies
`pricingTypes`	`ENUMERATION`	Select only placements with these pricing types
`searchString`	`STRING`	Allows searching for placements by name or ID. Wildcards () are allowed. For example, "placement2015" will return placements with names like "placement June 2015", "placement May 2015", or simply "placements 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "placement" will match placements with name "my placement", "placement 2015", or simply "placement"
`siteIds`	`INTEGER`	Select only placements that are associated with these sites
`sizeIds`	`INTEGER`	Select only placements that are associated with these sizes
`sortField`	`ENUMERATION`	Field by which to sort the list
`sortOrder`	`ENUMERATION`	Order of sorted results

= Parameter name
= Format

profileId INTEGER Required

User profile ID associated with this request

advertiserIds INTEGER

Select only placements that belong to these advertisers

archived BOOLEAN

Select only archived placements. Don't set this field to select both archived and non-archived placements

campaignIds INTEGER

Select only placements that belong to these campaigns

compatibilities ENUMERATION

Select only placements that are associated with these compatibilities. DISPLAY and DISPLAY_INTERSTITIAL refer to rendering either on desktop or on mobile devices for regular or interstitial ads respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps. IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard

contentCategoryIds INTEGER

Select only placements that are associated with these content categories

directorySiteIds INTEGER

Select only placements that are associated with these directory sites

groupIds INTEGER

Select only placements that belong to these placement groups

ids INTEGER

Select only placements with these IDs

maxEndDate STRING

Select only placements or placement groups whose end date is on or before the specified maxEndDate. The date should be formatted as "yyyy-MM-dd"

maxResults INTEGER

Maximum number of results to return

maxStartDate STRING

Select only placements or placement groups whose start date is on or before the specified maxStartDate. The date should be formatted as "yyyy-MM-dd"

minEndDate STRING

Select only placements or placement groups whose end date is on or after the specified minEndDate. The date should be formatted as "yyyy-MM-dd"

minStartDate STRING

Select only placements or placement groups whose start date is on or after the specified minStartDate. The date should be formatted as "yyyy-MM-dd"

pageToken STRING

Value of the nextPageToken from the previous result page

paymentSource ENUMERATION

Select only placements with this payment source

placementStrategyIds INTEGER

Select only placements that are associated with these placement strategies

pricingTypes ENUMERATION

Select only placements with these pricing types

searchString STRING

Allows searching for placements by name or ID. Wildcards () are allowed. For example, "placement2015" will return placements with names like "placement June 2015", "placement May 2015", or simply "placements 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "placement" will match placements with name "my placement", "placement 2015", or simply "placement"

siteIds INTEGER

Select only placements that are associated with these sites

sizeIds INTEGER

Select only placements that are associated with these sizes

sortField ENUMERATION

Field by which to sort the list

sortOrder ENUMERATION

Order of sorted results

Output

This building block provides 120 output parameters

Name	Format	Description
`kind`	`STRING`	Identifies what kind of resource this is. Value: the fixed string "dfareporting#placementsListResponse"
`nextPageToken`	`STRING`	Pagination token to be used for the next list operation
`placements[]`	`OBJECT`	Contains properties of a placement
`placements[].accountId`	`INTEGER`	Account ID of this placement. This field can be left blank
`placements[].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
`placements[].additionalSizes[]`	`OBJECT`	Represents the dimensions of ads, placements, creatives, or creative assets
`placements[].additionalSizes[].height`	`INTEGER`	Height of this size. Acceptable values are 0 to 32767, inclusive
`placements[].additionalSizes[].iab`	`BOOLEAN`	IAB standard size. This is a read-only, auto-generated field
`placements[].additionalSizes[].id`	`INTEGER`	ID of this size. This is a read-only, auto-generated field
`placements[].additionalSizes[].kind`	`STRING`	Identifies what kind of resource this is. Value: the fixed string "dfareporting#size"
`placements[].additionalSizes[].width`	`INTEGER`	Width of this size. Acceptable values are 0 to 32767, inclusive
`placements[].advertiserId`	`INTEGER`	Advertiser ID of this placement. This field can be left blank
`placements[].advertiserIdDimensionValue`	`OBJECT`	Represents a DimensionValue resource
`placements[].advertiserIdDimensionValue.dimensionName`	`STRING`	The name of the dimension
`placements[].advertiserIdDimensionValue.etag`	`STRING`	The eTag of this response for caching purposes
`placements[].advertiserIdDimensionValue.id`	`STRING`	The ID associated with the value if available
`placements[].advertiserIdDimensionValue.kind`	`STRING`	The kind of resource this is, in this case dfareporting#dimensionValue
`placements[].advertiserIdDimensionValue.matchType`	`ENUMERATION`	Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch') allow a matchType other than EXACT
`placements[].advertiserIdDimensionValue.value`	`STRING`	The value of the dimension
`placements[].archived`	`BOOLEAN`	Whether this placement is archived
`placements[].campaignId`	`INTEGER`	Campaign ID of this placement. This field is a required field on insertion
`placements[].campaignIdDimensionValue`	`OBJECT`	Represents a DimensionValue resource
`placements[].campaignIdDimensionValue.dimensionName`	`STRING`	The name of the dimension
`placements[].campaignIdDimensionValue.etag`	`STRING`	The eTag of this response for caching purposes
`placements[].campaignIdDimensionValue.id`	`STRING`	The ID associated with the value if available
`placements[].campaignIdDimensionValue.kind`	`STRING`	The kind of resource this is, in this case dfareporting#dimensionValue
`placements[].campaignIdDimensionValue.matchType`	`ENUMERATION`	Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch') allow a matchType other than EXACT
`placements[].campaignIdDimensionValue.value`	`STRING`	The value of the dimension
`placements[].comment`	`STRING`	Comments for this placement
`placements[].compatibility`	`ENUMERATION`	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
`placements[].contentCategoryId`	`INTEGER`	ID of the content category assigned to this placement
`placements[].createInfo`	`OBJECT`	Modification timestamp
`placements[].createInfo.time`	`INTEGER`	Timestamp of the last change in milliseconds since epoch
`placements[].directorySiteId`	`INTEGER`	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
`placements[].directorySiteIdDimensionValue`	`OBJECT`	Represents a DimensionValue resource
`placements[].directorySiteIdDimensionValue.dimensionName`	`STRING`	The name of the dimension
`placements[].directorySiteIdDimensionValue.etag`	`STRING`	The eTag of this response for caching purposes
`placements[].directorySiteIdDimensionValue.id`	`STRING`	The ID associated with the value if available
`placements[].directorySiteIdDimensionValue.kind`	`STRING`	The kind of resource this is, in this case dfareporting#dimensionValue
`placements[].directorySiteIdDimensionValue.matchType`	`ENUMERATION`	Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch') allow a matchType other than EXACT
`placements[].directorySiteIdDimensionValue.value`	`STRING`	The value of the dimension
`placements[].externalId`	`STRING`	External ID for this placement
`placements[].id`	`INTEGER`	ID of this placement. This is a read-only, auto-generated field
`placements[].idDimensionValue`	`OBJECT`	Represents a DimensionValue resource
`placements[].idDimensionValue.dimensionName`	`STRING`	The name of the dimension
`placements[].idDimensionValue.etag`	`STRING`	The eTag of this response for caching purposes
`placements[].idDimensionValue.id`	`STRING`	The ID associated with the value if available
`placements[].idDimensionValue.kind`	`STRING`	The kind of resource this is, in this case dfareporting#dimensionValue
`placements[].idDimensionValue.matchType`	`ENUMERATION`	Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch') allow a matchType other than EXACT
`placements[].idDimensionValue.value`	`STRING`	The value of the dimension
`placements[].keyName`	`STRING`	Key name of this placement. This is a read-only, auto-generated field
`placements[].kind`	`STRING`	Identifies what kind of resource this is. Value: the fixed string "dfareporting#placement"
`placements[].lastModifiedInfo`	`OBJECT`	Modification timestamp
`placements[].lastModifiedInfo.time`	`INTEGER`	Timestamp of the last change in milliseconds since epoch
`placements[].lookbackConfiguration`	`OBJECT`	Lookback configuration settings
`placements[].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
`placements[].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
`placements[].name`	`STRING`	Name of this placement.This is a required field and must be less than 256 characters long
`placements[].paymentApproved`	`BOOLEAN`	Whether payment was approved for this placement. This is a read-only field relevant only to publisher-paid placements
`placements[].paymentSource`	`ENUMERATION`	Payment source for this placement. This is a required field that is read-only after insertion
`placements[].placementGroupId`	`INTEGER`	ID of this placement's group, if applicable
`placements[].placementGroupIdDimensionValue`	`OBJECT`	Represents a DimensionValue resource
`placements[].placementGroupIdDimensionValue.dimensionName`	`STRING`	The name of the dimension
`placements[].placementGroupIdDimensionValue.etag`	`STRING`	The eTag of this response for caching purposes
`placements[].placementGroupIdDimensionValue.id`	`STRING`	The ID associated with the value if available
`placements[].placementGroupIdDimensionValue.kind`	`STRING`	The kind of resource this is, in this case dfareporting#dimensionValue
`placements[].placementGroupIdDimensionValue.matchType`	`ENUMERATION`	Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch') allow a matchType other than EXACT
`placements[].placementGroupIdDimensionValue.value`	`STRING`	The value of the dimension
`placements[].placementStrategyId`	`INTEGER`	ID of the placement strategy assigned to this placement
`placements[].pricingSchedule`	`OBJECT`	Pricing Schedule
`placements[].pricingSchedule.capCostOption`	`ENUMERATION`	Placement cap cost option
`placements[].pricingSchedule.disregardOverdelivery`	`BOOLEAN`	Whether cap costs are ignored by ad serving
`placements[].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
`placements[].pricingSchedule.flighted`	`BOOLEAN`	Whether this placement is flighted. If true, pricing periods will be computed automatically
`placements[].pricingSchedule.floodlightActivityId`	`INTEGER`	Floodlight activity ID associated with this placement. This field should be set when placement pricing type is set to PRICING_TYPE_CPA
`placements[].pricingSchedule.pricingPeriods[]`	`OBJECT`	Pricing Period
`placements[].pricingSchedule.pricingType`	`ENUMERATION`	Placement pricing type. This field is required on insertion
`placements[].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
`placements[].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
`placements[].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
`placements[].publisherUpdateInfo`	`OBJECT`	Modification timestamp
`placements[].publisherUpdateInfo.time`	`INTEGER`	Timestamp of the last change in milliseconds since epoch
`placements[].siteId`	`INTEGER`	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
`placements[].siteIdDimensionValue`	`OBJECT`	Represents a DimensionValue resource
`placements[].siteIdDimensionValue.dimensionName`	`STRING`	The name of the dimension
`placements[].siteIdDimensionValue.etag`	`STRING`	The eTag of this response for caching purposes
`placements[].siteIdDimensionValue.id`	`STRING`	The ID associated with the value if available
`placements[].siteIdDimensionValue.kind`	`STRING`	The kind of resource this is, in this case dfareporting#dimensionValue
`placements[].siteIdDimensionValue.matchType`	`ENUMERATION`	Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch') allow a matchType other than EXACT
`placements[].siteIdDimensionValue.value`	`STRING`	The value of the dimension
`placements[].size`	`OBJECT`	Represents the dimensions of ads, placements, creatives, or creative assets
`placements[].size.height`	`INTEGER`	Height of this size. Acceptable values are 0 to 32767, inclusive
`placements[].size.iab`	`BOOLEAN`	IAB standard size. This is a read-only, auto-generated field
`placements[].size.id`	`INTEGER`	ID of this size. This is a read-only, auto-generated field
`placements[].size.kind`	`STRING`	Identifies what kind of resource this is. Value: the fixed string "dfareporting#size"
`placements[].size.width`	`INTEGER`	Width of this size. Acceptable values are 0 to 32767, inclusive
`placements[].sslRequired`	`BOOLEAN`	Whether creatives assigned to this placement must be SSL-compliant
`placements[].status`	`ENUMERATION`	Third-party placement status
`placements[].subaccountId`	`INTEGER`	Subaccount ID of this placement. This field can be left blank
`placements[].tagFormats[]`	`ENUMERATION`
`placements[].tagSetting`	`OBJECT`	Tag Settings
`placements[].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
`placements[].tagSetting.includeClickThroughUrls`	`BOOLEAN`	Whether static landing page URLs should be included in the tags. This setting applies only to placements
`placements[].tagSetting.includeClickTracking`	`BOOLEAN`	Whether click-tracking string should be included in the tags
`placements[].tagSetting.keywordOption`	`ENUMERATION`	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
`placements[].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
`placements[].videoSettings`	`OBJECT`	Video Settings
`placements[].videoSettings.companionSettings`	`OBJECT`	Companion Settings
`placements[].videoSettings.companionSettings.companionsDisabled`	`BOOLEAN`	Whether companions are disabled for this placement
`placements[].videoSettings.companionSettings.imageOnly`	`BOOLEAN`	Whether to serve only static images as companions
`placements[].videoSettings.companionSettings.kind`	`STRING`	Identifies what kind of resource this is. Value: the fixed string "dfareporting#companionSetting"
`placements[].videoSettings.kind`	`STRING`	Identifies what kind of resource this is. Value: the fixed string "dfareporting#videoSettings"
`placements[].videoSettings.orientation`	`ENUMERATION`	Orientation of a video placement. If this value is set, placement will return assets matching the specified orientation
`placements[].videoSettings.skippableSettings`	`OBJECT`	Skippable Settings
`placements[].videoSettings.skippableSettings.kind`	`STRING`	Identifies what kind of resource this is. Value: the fixed string "dfareporting#skippableSetting"
`placements[].videoSettings.skippableSettings.skippable`	`BOOLEAN`	Whether the user can skip creatives served to this placement
`placements[].videoSettings.transcodeSettings`	`OBJECT`	Transcode Settings
`placements[].videoSettings.transcodeSettings.enabledVideoFormats[]`	`INTEGER`
`placements[].videoSettings.transcodeSettings.kind`	`STRING`	Identifies what kind of resource this is. Value: the fixed string "dfareporting#transcodeSetting"
`placements[].vpaidAdapterChoice`	`ENUMERATION`	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

= Parameter name
= Format

kind STRING

Identifies what kind of resource this is. Value: the fixed string "dfareporting#placementsListResponse"

nextPageToken STRING

Pagination token to be used for the next list operation

placements[] OBJECT

Contains properties of a placement

placements[].accountId INTEGER

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

placements[].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

placements[].additionalSizes[] OBJECT

Represents the dimensions of ads, placements, creatives, or creative assets

placements[].additionalSizes[].height INTEGER

Height of this size. Acceptable values are 0 to 32767, inclusive

placements[].additionalSizes[].iab BOOLEAN

IAB standard size. This is a read-only, auto-generated field

placements[].additionalSizes[].id INTEGER

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

placements[].additionalSizes[].kind STRING

Identifies what kind of resource this is. Value: the fixed string "dfareporting#size"

placements[].additionalSizes[].width INTEGER

Width of this size. Acceptable values are 0 to 32767, inclusive

placements[].advertiserId INTEGER

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

placements[].advertiserIdDimensionValue OBJECT

Represents a DimensionValue resource

placements[].advertiserIdDimensionValue.dimensionName STRING

The name of the dimension

placements[].advertiserIdDimensionValue.etag STRING

The eTag of this response for caching purposes

placements[].advertiserIdDimensionValue.id STRING

The ID associated with the value if available

placements[].advertiserIdDimensionValue.kind STRING

The kind of resource this is, in this case dfareporting#dimensionValue

placements[].advertiserIdDimensionValue.matchType ENUMERATION

Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch') allow a matchType other than EXACT

placements[].advertiserIdDimensionValue.value STRING

The value of the dimension

placements[].archived BOOLEAN

Whether this placement is archived

placements[].campaignId INTEGER

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

placements[].campaignIdDimensionValue OBJECT

Represents a DimensionValue resource

placements[].campaignIdDimensionValue.dimensionName STRING

The name of the dimension

placements[].campaignIdDimensionValue.etag STRING

The eTag of this response for caching purposes

placements[].campaignIdDimensionValue.id STRING

The ID associated with the value if available

placements[].campaignIdDimensionValue.kind STRING

The kind of resource this is, in this case dfareporting#dimensionValue

placements[].campaignIdDimensionValue.matchType ENUMERATION

placements[].campaignIdDimensionValue.value STRING

The value of the dimension

placements[].comment STRING

Comments for this placement

placements[].compatibility ENUMERATION

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

placements[].contentCategoryId INTEGER

ID of the content category assigned to this placement

placements[].createInfo OBJECT

Modification timestamp

placements[].createInfo.time INTEGER

Timestamp of the last change in milliseconds since epoch

placements[].directorySiteId INTEGER

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

placements[].directorySiteIdDimensionValue OBJECT

Represents a DimensionValue resource

placements[].directorySiteIdDimensionValue.dimensionName STRING

The name of the dimension

placements[].directorySiteIdDimensionValue.etag STRING

The eTag of this response for caching purposes

placements[].directorySiteIdDimensionValue.id STRING

The ID associated with the value if available

placements[].directorySiteIdDimensionValue.kind STRING

The kind of resource this is, in this case dfareporting#dimensionValue

placements[].directorySiteIdDimensionValue.matchType ENUMERATION

placements[].directorySiteIdDimensionValue.value STRING

The value of the dimension

placements[].externalId STRING

External ID for this placement

placements[].id INTEGER

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

placements[].idDimensionValue OBJECT

Represents a DimensionValue resource

placements[].idDimensionValue.dimensionName STRING

The name of the dimension

placements[].idDimensionValue.etag STRING

The eTag of this response for caching purposes

placements[].idDimensionValue.id STRING

The ID associated with the value if available

placements[].idDimensionValue.kind STRING

The kind of resource this is, in this case dfareporting#dimensionValue

placements[].idDimensionValue.matchType ENUMERATION

placements[].idDimensionValue.value STRING

The value of the dimension

placements[].keyName STRING

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

placements[].kind STRING

Identifies what kind of resource this is. Value: the fixed string "dfareporting#placement"

placements[].lastModifiedInfo OBJECT

Modification timestamp

placements[].lastModifiedInfo.time INTEGER

Timestamp of the last change in milliseconds since epoch

placements[].lookbackConfiguration OBJECT

Lookback configuration settings

placements[].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

placements[].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

placements[].name STRING

Name of this placement.This is a required field and must be less than 256 characters long

placements[].paymentApproved BOOLEAN

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

placements[].paymentSource ENUMERATION

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

placements[].placementGroupId INTEGER

ID of this placement's group, if applicable

placements[].placementGroupIdDimensionValue OBJECT

Represents a DimensionValue resource

placements[].placementGroupIdDimensionValue.dimensionName STRING

The name of the dimension

placements[].placementGroupIdDimensionValue.etag STRING

The eTag of this response for caching purposes

placements[].placementGroupIdDimensionValue.id STRING

The ID associated with the value if available

placements[].placementGroupIdDimensionValue.kind STRING

The kind of resource this is, in this case dfareporting#dimensionValue

placements[].placementGroupIdDimensionValue.matchType ENUMERATION

placements[].placementGroupIdDimensionValue.value STRING

The value of the dimension

placements[].placementStrategyId INTEGER

ID of the placement strategy assigned to this placement

placements[].pricingSchedule OBJECT

Pricing Schedule

placements[].pricingSchedule.capCostOption ENUMERATION

Placement cap cost option

placements[].pricingSchedule.disregardOverdelivery BOOLEAN

Whether cap costs are ignored by ad serving

placements[].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

placements[].pricingSchedule.flighted BOOLEAN

Whether this placement is flighted. If true, pricing periods will be computed automatically

placements[].pricingSchedule.floodlightActivityId INTEGER

Floodlight activity ID associated with this placement. This field should be set when placement pricing type is set to PRICING_TYPE_CPA

placements[].pricingSchedule.pricingPeriods[] OBJECT

Pricing Period

placements[].pricingSchedule.pricingType ENUMERATION

Placement pricing type. This field is required on insertion

placements[].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

placements[].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

placements[].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

placements[].publisherUpdateInfo OBJECT

Modification timestamp

placements[].publisherUpdateInfo.time INTEGER

Timestamp of the last change in milliseconds since epoch

placements[].siteId INTEGER

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

placements[].siteIdDimensionValue OBJECT

Represents a DimensionValue resource

placements[].siteIdDimensionValue.dimensionName STRING

The name of the dimension

placements[].siteIdDimensionValue.etag STRING

The eTag of this response for caching purposes

placements[].siteIdDimensionValue.id STRING

The ID associated with the value if available

placements[].siteIdDimensionValue.kind STRING

The kind of resource this is, in this case dfareporting#dimensionValue

placements[].siteIdDimensionValue.matchType ENUMERATION

placements[].siteIdDimensionValue.value STRING

The value of the dimension

placements[].size OBJECT

Represents the dimensions of ads, placements, creatives, or creative assets

placements[].size.height INTEGER

Height of this size. Acceptable values are 0 to 32767, inclusive

placements[].size.iab BOOLEAN

IAB standard size. This is a read-only, auto-generated field

placements[].size.id INTEGER

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

placements[].size.kind STRING

Identifies what kind of resource this is. Value: the fixed string "dfareporting#size"

placements[].size.width INTEGER

Width of this size. Acceptable values are 0 to 32767, inclusive

placements[].sslRequired BOOLEAN

Whether creatives assigned to this placement must be SSL-compliant

placements[].status ENUMERATION

Third-party placement status

placements[].subaccountId INTEGER

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

placements[].tagFormats[] ENUMERATION

placements[].tagSetting OBJECT

Tag Settings

placements[].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

placements[].tagSetting.includeClickThroughUrls BOOLEAN

Whether static landing page URLs should be included in the tags. This setting applies only to placements

placements[].tagSetting.includeClickTracking BOOLEAN

Whether click-tracking string should be included in the tags

placements[].tagSetting.keywordOption ENUMERATION

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

placements[].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

placements[].videoSettings OBJECT

Video Settings

placements[].videoSettings.companionSettings OBJECT

Companion Settings

placements[].videoSettings.companionSettings.companionsDisabled BOOLEAN

Whether companions are disabled for this placement

placements[].videoSettings.companionSettings.imageOnly BOOLEAN

Whether to serve only static images as companions

placements[].videoSettings.companionSettings.kind STRING

Identifies what kind of resource this is. Value: the fixed string "dfareporting#companionSetting"

placements[].videoSettings.kind STRING

Identifies what kind of resource this is. Value: the fixed string "dfareporting#videoSettings"

placements[].videoSettings.orientation ENUMERATION

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

placements[].videoSettings.skippableSettings OBJECT

Skippable Settings

placements[].videoSettings.skippableSettings.kind STRING

Identifies what kind of resource this is. Value: the fixed string "dfareporting#skippableSetting"

placements[].videoSettings.skippableSettings.skippable BOOLEAN

Whether the user can skip creatives served to this placement

placements[].videoSettings.transcodeSettings OBJECT

Transcode Settings

placements[].videoSettings.transcodeSettings.enabledVideoFormats[] INTEGER

placements[].videoSettings.transcodeSettings.kind STRING

Identifies what kind of resource this is. Value: the fixed string "dfareporting#transcodeSetting"

placements[].vpaidAdapterChoice ENUMERATION

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

Placements

List

Authorization

Input

Output