profileId INTEGER Required

User profile ID associated with this request

id INTEGER Required

Placement ID

accountId INTEGER

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[] OBJECT

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

additionalSizes[].height INTEGER

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

additionalSizes[].iab BOOLEAN

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

additionalSizes[].id INTEGER

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

additionalSizes[].kind STRING

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

additionalSizes[].width INTEGER

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

advertiserId INTEGER

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

advertiserIdDimensionValue OBJECT

Represents a DimensionValue resource

advertiserIdDimensionValue.dimensionName STRING

The name of the dimension

advertiserIdDimensionValue.etag STRING

The eTag of this response for caching purposes

advertiserIdDimensionValue.id STRING

The ID associated with the value if available

advertiserIdDimensionValue.kind STRING

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

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

advertiserIdDimensionValue.value STRING

The value of the dimension

archived BOOLEAN

Whether this placement is archived

campaignId INTEGER

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

campaignIdDimensionValue OBJECT

Represents a DimensionValue resource

campaignIdDimensionValue.dimensionName STRING

The name of the dimension

campaignIdDimensionValue.etag STRING

The eTag of this response for caching purposes

campaignIdDimensionValue.id STRING

The ID associated with the value if available

campaignIdDimensionValue.kind STRING

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

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

campaignIdDimensionValue.value STRING

The value of the dimension

comment STRING

Comments for this placement

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

contentCategoryId INTEGER

ID of the content category assigned to this placement

createInfo OBJECT

Modification timestamp

createInfo.time INTEGER

Timestamp of the last change in milliseconds since epoch

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

directorySiteIdDimensionValue OBJECT

Represents a DimensionValue resource

directorySiteIdDimensionValue.dimensionName STRING

The name of the dimension

directorySiteIdDimensionValue.etag STRING

The eTag of this response for caching purposes

directorySiteIdDimensionValue.id STRING

The ID associated with the value if available

directorySiteIdDimensionValue.kind STRING

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

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

directorySiteIdDimensionValue.value STRING

The value of the dimension

externalId STRING

External ID for this placement

id INTEGER

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

idDimensionValue OBJECT

Represents a DimensionValue resource

idDimensionValue.dimensionName STRING

The name of the dimension

idDimensionValue.etag STRING

The eTag of this response for caching purposes

idDimensionValue.id STRING

The ID associated with the value if available

idDimensionValue.kind STRING

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

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

idDimensionValue.value STRING

The value of the dimension

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 OBJECT

Modification timestamp

lastModifiedInfo.time INTEGER

Timestamp of the last change in milliseconds since epoch

lookbackConfiguration OBJECT

Lookback configuration settings

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

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

placementGroupId INTEGER

ID of this placement's group, if applicable

placementGroupIdDimensionValue OBJECT

Represents a DimensionValue resource

placementGroupIdDimensionValue.dimensionName STRING

The name of the dimension

placementGroupIdDimensionValue.etag STRING

The eTag of this response for caching purposes

placementGroupIdDimensionValue.id STRING

The ID associated with the value if available

placementGroupIdDimensionValue.kind STRING

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

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

placementGroupIdDimensionValue.value STRING

The value of the dimension

placementStrategyId INTEGER

ID of the placement strategy assigned to this placement

pricingSchedule OBJECT

Pricing Schedule

pricingSchedule.capCostOption ENUMERATION

Placement cap cost option

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 INTEGER

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

pricingSchedule.pricingPeriods[] OBJECT

Pricing Period

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 INTEGER

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 INTEGER

Units of this pricing period. Acceptable values are 0 to 10000000000, inclusive

pricingSchedule.pricingType ENUMERATION

Placement pricing type. This field is required on insertion

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 OBJECT

Modification timestamp

publisherUpdateInfo.time INTEGER

Timestamp of the last change in milliseconds since epoch

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

siteIdDimensionValue OBJECT

Represents a DimensionValue resource

siteIdDimensionValue.dimensionName STRING

The name of the dimension

siteIdDimensionValue.etag STRING

The eTag of this response for caching purposes

siteIdDimensionValue.id STRING

The ID associated with the value if available

siteIdDimensionValue.kind STRING

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

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

siteIdDimensionValue.value STRING

The value of the dimension

size OBJECT

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

size.height INTEGER

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

size.iab BOOLEAN

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

size.id INTEGER

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

size.kind STRING

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

size.width INTEGER

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

sslRequired BOOLEAN

Whether creatives assigned to this placement must be SSL-compliant

status ENUMERATION

Third-party placement status

subaccountId INTEGER

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

tagFormats[] ENUMERATION

tagSetting OBJECT

Tag Settings

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

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 OBJECT

Video Settings

videoSettings.companionSettings OBJECT

Companion Settings

videoSettings.companionSettings.companionsDisabled BOOLEAN

Whether companions are disabled for this placement

videoSettings.companionSettings.enabledSizes[] OBJECT

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

videoSettings.companionSettings.enabledSizes[].height INTEGER

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

videoSettings.companionSettings.enabledSizes[].iab BOOLEAN

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

videoSettings.companionSettings.enabledSizes[].id INTEGER

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

videoSettings.companionSettings.enabledSizes[].kind STRING

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

videoSettings.companionSettings.enabledSizes[].width INTEGER

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

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 ENUMERATION

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

videoSettings.skippableSettings OBJECT

Skippable Settings

videoSettings.skippableSettings.kind STRING

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

videoSettings.skippableSettings.progressOffset OBJECT

Video Offset

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 OBJECT

Video Offset

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 OBJECT

Transcode Settings

videoSettings.transcodeSettings.enabledVideoFormats[] INTEGER

videoSettings.transcodeSettings.kind STRING

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

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