<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="dfareporting_v2_8.html">DCM/DFA Reporting And Trafficking API</a> . <a href="dfareporting_v2_8.placements.html">placements</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#generatetags">generatetags(profileId, campaignId=None, tagFormats=None, placementIds=None)</a></code></p>
<p class="firstline">Generates tags for a placement.</p>
<p class="toc_element">
<code><a href="#get">get(profileId, id)</a></code></p>
<p class="firstline">Gets one placement by ID.</p>
<p class="toc_element">
<code><a href="#insert">insert(profileId, body)</a></code></p>
<p class="firstline">Inserts a new placement.</p>
<p class="toc_element">
<code><a href="#list">list(profileId, siteIds=None, paymentSource=None, pricingTypes=None, campaignIds=None, advertiserIds=None, sizeIds=None, pageToken=None, maxStartDate=None, sortOrder=None, maxEndDate=None, placementStrategyIds=None, contentCategoryIds=None, archived=None, maxResults=None, minStartDate=None, compatibilities=None, searchString=None, minEndDate=None, directorySiteIds=None, sortField=None, ids=None, groupIds=None)</a></code></p>
<p class="firstline">Retrieves a list of placements, possibly filtered. This method supports paging.</p>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
<code><a href="#patch">patch(profileId, id, body)</a></code></p>
<p class="firstline">Updates an existing placement. This method supports patch semantics.</p>
<p class="toc_element">
<code><a href="#update">update(profileId, body)</a></code></p>
<p class="firstline">Updates an existing placement.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="generatetags">generatetags(profileId, campaignId=None, tagFormats=None, placementIds=None)</code>
<pre>Generates tags for a placement.
Args:
profileId: string, User profile ID associated with this request. (required)
campaignId: string, Generate placements belonging to this campaign. This is a required field.
tagFormats: string, Tag formats to generate for these placements. (repeated)
Allowed values
PLACEMENT_TAG_CLICK_COMMANDS -
PLACEMENT_TAG_IFRAME_ILAYER -
PLACEMENT_TAG_IFRAME_JAVASCRIPT -
PLACEMENT_TAG_IFRAME_JAVASCRIPT_LEGACY -
PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH -
PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH_VAST_3 -
PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH_VAST_4 -
PLACEMENT_TAG_INTERNAL_REDIRECT -
PLACEMENT_TAG_INTERSTITIAL_IFRAME_JAVASCRIPT -
PLACEMENT_TAG_INTERSTITIAL_IFRAME_JAVASCRIPT_LEGACY -
PLACEMENT_TAG_INTERSTITIAL_INTERNAL_REDIRECT -
PLACEMENT_TAG_INTERSTITIAL_JAVASCRIPT -
PLACEMENT_TAG_INTERSTITIAL_JAVASCRIPT_LEGACY -
PLACEMENT_TAG_JAVASCRIPT -
PLACEMENT_TAG_JAVASCRIPT_LEGACY -
PLACEMENT_TAG_STANDARD -
PLACEMENT_TAG_TRACKING -
PLACEMENT_TAG_TRACKING_IFRAME -
PLACEMENT_TAG_TRACKING_JAVASCRIPT -
placementIds: string, Generate tags for these placements. (repeated)
Returns:
An object of the form:
{ # Placement GenerateTags Response
"kind": "dfareporting#placementsGenerateTagsResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#placementsGenerateTagsResponse".
"placementTags": [ # Set of generated tags for the specified placements.
{ # Placement Tag
"tagDatas": [ # Tags generated for this placement.
{ # Placement Tag Data
"clickTag": "A String", # Tag string to record a click.
"impressionTag": "A String", # Tag string for serving an ad.
"creativeId": "A String", # Creative associated with this placement tag. Applicable only when format is PLACEMENT_TAG_TRACKING.
"adId": "A String", # Ad associated with this placement tag. Applicable only when format is PLACEMENT_TAG_TRACKING.
"format": "A String", # TagData tag format of this tag.
},
],
"placementId": "A String", # Placement ID
},
],
}</pre>
</div>
<div class="method">
<code class="details" id="get">get(profileId, id)</code>
<pre>Gets one placement by ID.
Args:
profileId: string, User profile ID associated with this request. (required)
id: string, Placement ID. (required)
Returns:
An object of the form:
{ # Contains properties of a placement.
"comment": "A String", # Comments for this placement.
"videoActiveViewOptOut": True or False, # 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.
"campaignId": "A String", # Campaign ID of this placement. This field is a required field on insertion.
"paymentSource": "A String", # Payment source for this placement. This is a required field that is read-only after insertion.
"directorySiteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field.
"kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
"value": "A String", # The value of the dimension.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"matchType": "A String", # 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.
"id": "A String", # The ID associated with the value if available.
},
"advertiserId": "A String", # Advertiser ID of this placement. This field can be left blank.
"keyName": "A String", # Key name of this placement. This is a read-only, auto-generated field.
"directorySiteId": "A String", # 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.
"advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
"kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
"value": "A String", # The value of the dimension.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"matchType": "A String", # 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.
"id": "A String", # The ID associated with the value if available.
},
"id": "A String", # ID of this placement. This is a read-only, auto-generated field.
"accountId": "A String", # Account ID of this placement. This field can be left blank.
"archived": True or False, # Whether this placement is archived.
"videoSettings": { # Video Settings # A collection of settings which affect video creatives served through this placement. Applicable to placements with IN_STREAM_VIDEO compatibility.
"skippableSettings": { # Skippable Settings # Settings for the skippability of video creatives served to this placement. If this object is provided, the creative-level skippable settings will be overridden.
"skippable": True or False, # Whether the user can skip creatives served to this placement.
"kind": "dfareporting#skippableSetting", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#skippableSetting".
"skipOffset": { # Video Offset # Amount of time to play videos served to this placement before the skip button should appear. Applicable when skippable is true.
"offsetPercentage": 42, # Duration, as a percentage of video duration. Do not set when offsetSeconds is set. Acceptable values are 0 to 100, inclusive.
"offsetSeconds": 42, # Duration, in seconds. Do not set when offsetPercentage is set. Acceptable values are 0 to 86399, inclusive.
},
"progressOffset": { # Video Offset # Amount of time to play videos served to this placement before counting a view. Applicable when skippable is true.
"offsetPercentage": 42, # Duration, as a percentage of video duration. Do not set when offsetSeconds is set. Acceptable values are 0 to 100, inclusive.
"offsetSeconds": 42, # Duration, in seconds. Do not set when offsetPercentage is set. Acceptable values are 0 to 86399, inclusive.
},
},
"kind": "dfareporting#videoSettings", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#videoSettings".
"companionSettings": { # Companion Settings # Settings for the companion creatives of video creatives served to this placement.
"kind": "dfareporting#companionSetting", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#companionSetting".
"companionsDisabled": True or False, # Whether companions are disabled for this placement.
"imageOnly": True or False, # Whether to serve only static images as companions.
"enabledSizes": [ # Whitelist of companion sizes to be served to this placement. Set this list to null or empty to serve all companion sizes.
{ # Represents the dimensions of ads, placements, creatives, or creative assets.
"width": 42, # Width of this size. Acceptable values are 0 to 32767, inclusive.
"kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
"iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
"id": "A String", # ID of this size. This is a read-only, auto-generated field.
"height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive.
},
],
},
"transcodeSettings": { # Transcode Settings # Settings for the transcodes of video creatives served to this placement. If this object is provided, the creative-level transcode settings will be overridden.
"kind": "dfareporting#transcodeSetting", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#transcodeSetting".
"enabledVideoFormats": [ # Whitelist of video formats to be served to this placement. Set this list to null or empty to serve all video formats.
42,
],
},
},
"publisherUpdateInfo": { # Modification timestamp. # Information about the last publisher update. This is a read-only field.
"time": "A String", # Timestamp of the last change in milliseconds since epoch.
},
"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"
"A String",
],
"paymentApproved": True or False, # Whether payment was approved for this placement. This is a read-only field relevant only to publisher-paid placements.
"tagSetting": { # Tag Settings # Tag settings for this placement.
"includeClickThroughUrls": True or False, # Whether static landing page URLs should be included in the tags. This setting applies only to placements.
"includeClickTracking": True or False, # Whether click-tracking string should be included in the tags.
"additionalKeyValues": "A 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.
"keywordOption": "A 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.
},
"contentCategoryId": "A String", # ID of the content category assigned to this placement.
"adBlockingOptOut": True or False, # 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.
"externalId": "A String", # External ID for this placement.
"idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this placement. This is a read-only, auto-generated field.
"kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
"value": "A String", # The value of the dimension.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"matchType": "A String", # 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.
"id": "A String", # The ID associated with the value if available.
},
"size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size associated with this placement. When inserting or updating a placement, only the size ID field is used. This field is required on insertion.
"width": 42, # Width of this size. Acceptable values are 0 to 32767, inclusive.
"kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
"iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
"id": "A String", # ID of this size. This is a read-only, auto-generated field.
"height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive.
},
"sslRequired": True or False, # Whether creatives assigned to this placement must be SSL-compliant.
"status": "A String", # Third-party placement status.
"campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
"kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
"value": "A String", # The value of the dimension.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"matchType": "A String", # 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.
"id": "A String", # The ID associated with the value if available.
},
"primary": True or False, # 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.
"placementGroupId": "A String", # ID of this placement's group, if applicable.
"createInfo": { # Modification timestamp. # Information about the creation of this placement. This is a read-only field.
"time": "A String", # Timestamp of the last change in milliseconds since epoch.
},
"siteId": "A String", # 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": { # Represents a DimensionValue resource. # Dimension value for the ID of the site. This is a read-only, auto-generated field.
"kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
"value": "A String", # The value of the dimension.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"matchType": "A String", # 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.
"id": "A String", # The ID associated with the value if available.
},
"compatibility": "A 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.
"placementStrategyId": "A String", # ID of the placement strategy assigned to this placement.
"placementGroupIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the placement group. This is a read-only, auto-generated field.
"kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
"value": "A String", # The value of the dimension.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"matchType": "A String", # 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.
"id": "A String", # The ID associated with the value if available.
},
"kind": "dfareporting#placement", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#placement".
"subaccountId": "A String", # Subaccount ID of this placement. This field can be left blank.
"name": "A String", # Name of this placement.This is a required field and must be less than 256 characters long.
"lookbackConfiguration": { # Lookback configuration settings. # Lookback window settings for this placement.
"clickDuration": 42, # 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.
"postImpressionActivitiesDuration": 42, # 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.
},
"lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this placement. This is a read-only field.
"time": "A String", # Timestamp of the last change in milliseconds since epoch.
},
"pricingSchedule": { # Pricing Schedule # Pricing schedule of this placement. This field is required on insertion, specifically subfields startDate, endDate and pricingType.
"startDate": "A String", # 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.
"endDate": "A String", # 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.
"flighted": True or False, # Whether this placement is flighted. If true, pricing periods will be computed automatically.
"disregardOverdelivery": True or False, # Whether cap costs are ignored by ad serving.
"capCostOption": "A String", # Placement cap cost option.
"pricingPeriods": [ # Pricing periods for this placement.
{ # Pricing Period
"units": "A String", # Units of this pricing period. Acceptable values are 0 to 10000000000, inclusive.
"rateOrCostNanos": "A String", # Rate or cost of this pricing period in nanos (i.e., multipled by 1000000000). Acceptable values are 0 to 1000000000000000000, inclusive.
"startDate": "A String", # 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.
"endDate": "A String", # 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.
"pricingComment": "A String", # Comments for this pricing period.
},
],
"pricingType": "A String", # Placement pricing type. This field is required on insertion.
"testingStartDate": "A String", # 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.
"floodlightActivityId": "A String", # Floodlight activity ID associated with this placement. This field should be set when placement pricing type is set to PRICING_TYPE_CPA.
},
"vpaidAdapterChoice": "A 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.
}</pre>
</div>
<div class="method">
<code class="details" id="insert">insert(profileId, body)</code>
<pre>Inserts a new placement.
Args:
profileId: string, User profile ID associated with this request. (required)
body: object, The request body. (required)
The object takes the form of:
{ # Contains properties of a placement.
"comment": "A String", # Comments for this placement.
"videoActiveViewOptOut": True or False, # 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.
"campaignId": "A String", # Campaign ID of this placement. This field is a required field on insertion.
"paymentSource": "A String", # Payment source for this placement. This is a required field that is read-only after insertion.
"directorySiteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field.
"kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
"value": "A String", # The value of the dimension.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"matchType": "A String", # 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.
"id": "A String", # The ID associated with the value if available.
},
"advertiserId": "A String", # Advertiser ID of this placement. This field can be left blank.
"keyName": "A String", # Key name of this placement. This is a read-only, auto-generated field.
"directorySiteId": "A String", # 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.
"advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
"kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
"value": "A String", # The value of the dimension.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"matchType": "A String", # 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.
"id": "A String", # The ID associated with the value if available.
},
"id": "A String", # ID of this placement. This is a read-only, auto-generated field.
"accountId": "A String", # Account ID of this placement. This field can be left blank.
"archived": True or False, # Whether this placement is archived.
"videoSettings": { # Video Settings # A collection of settings which affect video creatives served through this placement. Applicable to placements with IN_STREAM_VIDEO compatibility.
"skippableSettings": { # Skippable Settings # Settings for the skippability of video creatives served to this placement. If this object is provided, the creative-level skippable settings will be overridden.
"skippable": True or False, # Whether the user can skip creatives served to this placement.
"kind": "dfareporting#skippableSetting", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#skippableSetting".
"skipOffset": { # Video Offset # Amount of time to play videos served to this placement before the skip button should appear. Applicable when skippable is true.
"offsetPercentage": 42, # Duration, as a percentage of video duration. Do not set when offsetSeconds is set. Acceptable values are 0 to 100, inclusive.
"offsetSeconds": 42, # Duration, in seconds. Do not set when offsetPercentage is set. Acceptable values are 0 to 86399, inclusive.
},
"progressOffset": { # Video Offset # Amount of time to play videos served to this placement before counting a view. Applicable when skippable is true.
"offsetPercentage": 42, # Duration, as a percentage of video duration. Do not set when offsetSeconds is set. Acceptable values are 0 to 100, inclusive.
"offsetSeconds": 42, # Duration, in seconds. Do not set when offsetPercentage is set. Acceptable values are 0 to 86399, inclusive.
},
},
"kind": "dfareporting#videoSettings", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#videoSettings".
"companionSettings": { # Companion Settings # Settings for the companion creatives of video creatives served to this placement.
"kind": "dfareporting#companionSetting", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#companionSetting".
"companionsDisabled": True or False, # Whether companions are disabled for this placement.
"imageOnly": True or False, # Whether to serve only static images as companions.
"enabledSizes": [ # Whitelist of companion sizes to be served to this placement. Set this list to null or empty to serve all companion sizes.
{ # Represents the dimensions of ads, placements, creatives, or creative assets.
"width": 42, # Width of this size. Acceptable values are 0 to 32767, inclusive.
"kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
"iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
"id": "A String", # ID of this size. This is a read-only, auto-generated field.
"height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive.
},
],
},
"transcodeSettings": { # Transcode Settings # Settings for the transcodes of video creatives served to this placement. If this object is provided, the creative-level transcode settings will be overridden.
"kind": "dfareporting#transcodeSetting", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#transcodeSetting".
"enabledVideoFormats": [ # Whitelist of video formats to be served to this placement. Set this list to null or empty to serve all video formats.
42,
],
},
},
"publisherUpdateInfo": { # Modification timestamp. # Information about the last publisher update. This is a read-only field.
"time": "A String", # Timestamp of the last change in milliseconds since epoch.
},
"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"
"A String",
],
"paymentApproved": True or False, # Whether payment was approved for this placement. This is a read-only field relevant only to publisher-paid placements.
"tagSetting": { # Tag Settings # Tag settings for this placement.
"includeClickThroughUrls": True or False, # Whether static landing page URLs should be included in the tags. This setting applies only to placements.
"includeClickTracking": True or False, # Whether click-tracking string should be included in the tags.
"additionalKeyValues": "A 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.
"keywordOption": "A 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.
},
"contentCategoryId": "A String", # ID of the content category assigned to this placement.
"adBlockingOptOut": True or False, # 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.
"externalId": "A String", # External ID for this placement.
"idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this placement. This is a read-only, auto-generated field.
"kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
"value": "A String", # The value of the dimension.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"matchType": "A String", # 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.
"id": "A String", # The ID associated with the value if available.
},
"size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size associated with this placement. When inserting or updating a placement, only the size ID field is used. This field is required on insertion.
"width": 42, # Width of this size. Acceptable values are 0 to 32767, inclusive.
"kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
"iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
"id": "A String", # ID of this size. This is a read-only, auto-generated field.
"height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive.
},
"sslRequired": True or False, # Whether creatives assigned to this placement must be SSL-compliant.
"status": "A String", # Third-party placement status.
"campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
"kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
"value": "A String", # The value of the dimension.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"matchType": "A String", # 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.
"id": "A String", # The ID associated with the value if available.
},
"primary": True or False, # 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.
"placementGroupId": "A String", # ID of this placement's group, if applicable.
"createInfo": { # Modification timestamp. # Information about the creation of this placement. This is a read-only field.
"time": "A String", # Timestamp of the last change in milliseconds since epoch.
},
"siteId": "A String", # 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": { # Represents a DimensionValue resource. # Dimension value for the ID of the site. This is a read-only, auto-generated field.
"kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
"value": "A String", # The value of the dimension.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"matchType": "A String", # 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.
"id": "A String", # The ID associated with the value if available.
},
"compatibility": "A 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.
"placementStrategyId": "A String", # ID of the placement strategy assigned to this placement.
"placementGroupIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the placement group. This is a read-only, auto-generated field.
"kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
"value": "A String", # The value of the dimension.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"matchType": "A String", # 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.
"id": "A String", # The ID associated with the value if available.
},
"kind": "dfareporting#placement", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#placement".
"subaccountId": "A String", # Subaccount ID of this placement. This field can be left blank.
"name": "A String", # Name of this placement.This is a required field and must be less than 256 characters long.
"lookbackConfiguration": { # Lookback configuration settings. # Lookback window settings for this placement.
"clickDuration": 42, # 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.
"postImpressionActivitiesDuration": 42, # 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.
},
"lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this placement. This is a read-only field.
"time": "A String", # Timestamp of the last change in milliseconds since epoch.
},
"pricingSchedule": { # Pricing Schedule # Pricing schedule of this placement. This field is required on insertion, specifically subfields startDate, endDate and pricingType.
"startDate": "A String", # 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.
"endDate": "A String", # 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.
"flighted": True or False, # Whether this placement is flighted. If true, pricing periods will be computed automatically.
"disregardOverdelivery": True or False, # Whether cap costs are ignored by ad serving.
"capCostOption": "A String", # Placement cap cost option.
"pricingPeriods": [ # Pricing periods for this placement.
{ # Pricing Period
"units": "A String", # Units of this pricing period. Acceptable values are 0 to 10000000000, inclusive.
"rateOrCostNanos": "A String", # Rate or cost of this pricing period in nanos (i.e., multipled by 1000000000). Acceptable values are 0 to 1000000000000000000, inclusive.
"startDate": "A String", # 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.
"endDate": "A String", # 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.
"pricingComment": "A String", # Comments for this pricing period.
},
],
"pricingType": "A String", # Placement pricing type. This field is required on insertion.
"testingStartDate": "A String", # 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.
"floodlightActivityId": "A String", # Floodlight activity ID associated with this placement. This field should be set when placement pricing type is set to PRICING_TYPE_CPA.
},
"vpaidAdapterChoice": "A 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.
}
Returns:
An object of the form:
{ # Contains properties of a placement.
"comment": "A String", # Comments for this placement.
"videoActiveViewOptOut": True or False, # 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.
"campaignId": "A String", # Campaign ID of this placement. This field is a required field on insertion.
"paymentSource": "A String", # Payment source for this placement. This is a required field that is read-only after insertion.
"directorySiteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field.
"kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
"value": "A String", # The value of the dimension.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"matchType": "A String", # 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.
"id": "A String", # The ID associated with the value if available.
},
"advertiserId": "A String", # Advertiser ID of this placement. This field can be left blank.
"keyName": "A String", # Key name of this placement. This is a read-only, auto-generated field.
"directorySiteId": "A String", # 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.
"advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
"kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
"value": "A String", # The value of the dimension.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"matchType": "A String", # 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.
"id": "A String", # The ID associated with the value if available.
},
"id": "A String", # ID of this placement. This is a read-only, auto-generated field.
"accountId": "A String", # Account ID of this placement. This field can be left blank.
"archived": True or False, # Whether this placement is archived.
"videoSettings": { # Video Settings # A collection of settings which affect video creatives served through this placement. Applicable to placements with IN_STREAM_VIDEO compatibility.
"skippableSettings": { # Skippable Settings # Settings for the skippability of video creatives served to this placement. If this object is provided, the creative-level skippable settings will be overridden.
"skippable": True or False, # Whether the user can skip creatives served to this placement.
"kind": "dfareporting#skippableSetting", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#skippableSetting".
"skipOffset": { # Video Offset # Amount of time to play videos served to this placement before the skip button should appear. Applicable when skippable is true.
"offsetPercentage": 42, # Duration, as a percentage of video duration. Do not set when offsetSeconds is set. Acceptable values are 0 to 100, inclusive.
"offsetSeconds": 42, # Duration, in seconds. Do not set when offsetPercentage is set. Acceptable values are 0 to 86399, inclusive.
},
"progressOffset": { # Video Offset # Amount of time to play videos served to this placement before counting a view. Applicable when skippable is true.
"offsetPercentage": 42, # Duration, as a percentage of video duration. Do not set when offsetSeconds is set. Acceptable values are 0 to 100, inclusive.
"offsetSeconds": 42, # Duration, in seconds. Do not set when offsetPercentage is set. Acceptable values are 0 to 86399, inclusive.
},
},
"kind": "dfareporting#videoSettings", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#videoSettings".
"companionSettings": { # Companion Settings # Settings for the companion creatives of video creatives served to this placement.
"kind": "dfareporting#companionSetting", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#companionSetting".
"companionsDisabled": True or False, # Whether companions are disabled for this placement.
"imageOnly": True or False, # Whether to serve only static images as companions.
"enabledSizes": [ # Whitelist of companion sizes to be served to this placement. Set this list to null or empty to serve all companion sizes.
{ # Represents the dimensions of ads, placements, creatives, or creative assets.
"width": 42, # Width of this size. Acceptable values are 0 to 32767, inclusive.
"kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
"iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
"id": "A String", # ID of this size. This is a read-only, auto-generated field.
"height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive.
},
],
},
"transcodeSettings": { # Transcode Settings # Settings for the transcodes of video creatives served to this placement. If this object is provided, the creative-level transcode settings will be overridden.
"kind": "dfareporting#transcodeSetting", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#transcodeSetting".
"enabledVideoFormats": [ # Whitelist of video formats to be served to this placement. Set this list to null or empty to serve all video formats.
42,
],
},
},
"publisherUpdateInfo": { # Modification timestamp. # Information about the last publisher update. This is a read-only field.
"time": "A String", # Timestamp of the last change in milliseconds since epoch.
},
"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"
"A String",
],
"paymentApproved": True or False, # Whether payment was approved for this placement. This is a read-only field relevant only to publisher-paid placements.
"tagSetting": { # Tag Settings # Tag settings for this placement.
"includeClickThroughUrls": True or False, # Whether static landing page URLs should be included in the tags. This setting applies only to placements.
"includeClickTracking": True or False, # Whether click-tracking string should be included in the tags.
"additionalKeyValues": "A 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.
"keywordOption": "A 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.
},
"contentCategoryId": "A String", # ID of the content category assigned to this placement.
"adBlockingOptOut": True or False, # 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.
"externalId": "A String", # External ID for this placement.
"idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this placement. This is a read-only, auto-generated field.
"kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
"value": "A String", # The value of the dimension.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"matchType": "A String", # 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.
"id": "A String", # The ID associated with the value if available.
},
"size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size associated with this placement. When inserting or updating a placement, only the size ID field is used. This field is required on insertion.
"width": 42, # Width of this size. Acceptable values are 0 to 32767, inclusive.
"kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
"iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
"id": "A String", # ID of this size. This is a read-only, auto-generated field.
"height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive.
},
"sslRequired": True or False, # Whether creatives assigned to this placement must be SSL-compliant.
"status": "A String", # Third-party placement status.
"campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
"kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
"value": "A String", # The value of the dimension.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"matchType": "A String", # 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.
"id": "A String", # The ID associated with the value if available.
},
"primary": True or False, # 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.
"placementGroupId": "A String", # ID of this placement's group, if applicable.
"createInfo": { # Modification timestamp. # Information about the creation of this placement. This is a read-only field.
"time": "A String", # Timestamp of the last change in milliseconds since epoch.
},
"siteId": "A String", # 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": { # Represents a DimensionValue resource. # Dimension value for the ID of the site. This is a read-only, auto-generated field.
"kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
"value": "A String", # The value of the dimension.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"matchType": "A String", # 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.
"id": "A String", # The ID associated with the value if available.
},
"compatibility": "A 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.
"placementStrategyId": "A String", # ID of the placement strategy assigned to this placement.
"placementGroupIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the placement group. This is a read-only, auto-generated field.
"kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
"value": "A String", # The value of the dimension.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"matchType": "A String", # 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.
"id": "A String", # The ID associated with the value if available.
},
"kind": "dfareporting#placement", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#placement".
"subaccountId": "A String", # Subaccount ID of this placement. This field can be left blank.
"name": "A String", # Name of this placement.This is a required field and must be less than 256 characters long.
"lookbackConfiguration": { # Lookback configuration settings. # Lookback window settings for this placement.
"clickDuration": 42, # 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.
"postImpressionActivitiesDuration": 42, # 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.
},
"lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this placement. This is a read-only field.
"time": "A String", # Timestamp of the last change in milliseconds since epoch.
},
"pricingSchedule": { # Pricing Schedule # Pricing schedule of this placement. This field is required on insertion, specifically subfields startDate, endDate and pricingType.
"startDate": "A String", # 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.
"endDate": "A String", # 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.
"flighted": True or False, # Whether this placement is flighted. If true, pricing periods will be computed automatically.
"disregardOverdelivery": True or False, # Whether cap costs are ignored by ad serving.
"capCostOption": "A String", # Placement cap cost option.
"pricingPeriods": [ # Pricing periods for this placement.
{ # Pricing Period
"units": "A String", # Units of this pricing period. Acceptable values are 0 to 10000000000, inclusive.
"rateOrCostNanos": "A String", # Rate or cost of this pricing period in nanos (i.e., multipled by 1000000000). Acceptable values are 0 to 1000000000000000000, inclusive.
"startDate": "A String", # 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.
"endDate": "A String", # 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.
"pricingComment": "A String", # Comments for this pricing period.
},
],
"pricingType": "A String", # Placement pricing type. This field is required on insertion.
"testingStartDate": "A String", # 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.
"floodlightActivityId": "A String", # Floodlight activity ID associated with this placement. This field should be set when placement pricing type is set to PRICING_TYPE_CPA.
},
"vpaidAdapterChoice": "A 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.
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(profileId, siteIds=None, paymentSource=None, pricingTypes=None, campaignIds=None, advertiserIds=None, sizeIds=None, pageToken=None, maxStartDate=None, sortOrder=None, maxEndDate=None, placementStrategyIds=None, contentCategoryIds=None, archived=None, maxResults=None, minStartDate=None, compatibilities=None, searchString=None, minEndDate=None, directorySiteIds=None, sortField=None, ids=None, groupIds=None)</code>
<pre>Retrieves a list of placements, possibly filtered. This method supports paging.
Args:
profileId: string, User profile ID associated with this request. (required)
siteIds: string, Select only placements that are associated with these sites. (repeated)
paymentSource: string, Select only placements with this payment source.
Allowed values
PLACEMENT_AGENCY_PAID -
PLACEMENT_PUBLISHER_PAID -
pricingTypes: string, Select only placements with these pricing types. (repeated)
Allowed values
PRICING_TYPE_CPA -
PRICING_TYPE_CPC -
PRICING_TYPE_CPM -
PRICING_TYPE_CPM_ACTIVEVIEW -
PRICING_TYPE_FLAT_RATE_CLICKS -
PRICING_TYPE_FLAT_RATE_IMPRESSIONS -
campaignIds: string, Select only placements that belong to these campaigns. (repeated)
advertiserIds: string, Select only placements that belong to these advertisers. (repeated)
sizeIds: string, Select only placements that are associated with these sizes. (repeated)
pageToken: string, Value of the nextPageToken from the previous result page.
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".
sortOrder: string, Order of sorted results.
Allowed values
ASCENDING -
DESCENDING -
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".
placementStrategyIds: string, Select only placements that are associated with these placement strategies. (repeated)
contentCategoryIds: string, Select only placements that are associated with these content categories. (repeated)
archived: boolean, Select only archived placements. Don't set this field to select both archived and non-archived placements.
maxResults: integer, Maximum number of results to return.
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".
compatibilities: string, 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. (repeated)
Allowed values
APP -
APP_INTERSTITIAL -
DISPLAY -
DISPLAY_INTERSTITIAL -
IN_STREAM_VIDEO -
searchString: string, Allows searching for placements by name or ID. Wildcards (*) are allowed. For example, "placement*2015" 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".
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".
directorySiteIds: string, Select only placements that are associated with these directory sites. (repeated)
sortField: string, Field by which to sort the list.
Allowed values
ID -
NAME -
ids: string, Select only placements with these IDs. (repeated)
groupIds: string, Select only placements that belong to these placement groups. (repeated)
Returns:
An object of the form:
{ # Placement List Response
"nextPageToken": "A String", # Pagination token to be used for the next list operation.
"kind": "dfareporting#placementsListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#placementsListResponse".
"placements": [ # Placement collection.
{ # Contains properties of a placement.
"comment": "A String", # Comments for this placement.
"videoActiveViewOptOut": True or False, # 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.
"campaignId": "A String", # Campaign ID of this placement. This field is a required field on insertion.
"paymentSource": "A String", # Payment source for this placement. This is a required field that is read-only after insertion.
"directorySiteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field.
"kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
"value": "A String", # The value of the dimension.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"matchType": "A String", # 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.
"id": "A String", # The ID associated with the value if available.
},
"advertiserId": "A String", # Advertiser ID of this placement. This field can be left blank.
"keyName": "A String", # Key name of this placement. This is a read-only, auto-generated field.
"directorySiteId": "A String", # 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.
"advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
"kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
"value": "A String", # The value of the dimension.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"matchType": "A String", # 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.
"id": "A String", # The ID associated with the value if available.
},
"id": "A String", # ID of this placement. This is a read-only, auto-generated field.
"accountId": "A String", # Account ID of this placement. This field can be left blank.
"archived": True or False, # Whether this placement is archived.
"videoSettings": { # Video Settings # A collection of settings which affect video creatives served through this placement. Applicable to placements with IN_STREAM_VIDEO compatibility.
"skippableSettings": { # Skippable Settings # Settings for the skippability of video creatives served to this placement. If this object is provided, the creative-level skippable settings will be overridden.
"skippable": True or False, # Whether the user can skip creatives served to this placement.
"kind": "dfareporting#skippableSetting", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#skippableSetting".
"skipOffset": { # Video Offset # Amount of time to play videos served to this placement before the skip button should appear. Applicable when skippable is true.
"offsetPercentage": 42, # Duration, as a percentage of video duration. Do not set when offsetSeconds is set. Acceptable values are 0 to 100, inclusive.
"offsetSeconds": 42, # Duration, in seconds. Do not set when offsetPercentage is set. Acceptable values are 0 to 86399, inclusive.
},
"progressOffset": { # Video Offset # Amount of time to play videos served to this placement before counting a view. Applicable when skippable is true.
"offsetPercentage": 42, # Duration, as a percentage of video duration. Do not set when offsetSeconds is set. Acceptable values are 0 to 100, inclusive.
"offsetSeconds": 42, # Duration, in seconds. Do not set when offsetPercentage is set. Acceptable values are 0 to 86399, inclusive.
},
},
"kind": "dfareporting#videoSettings", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#videoSettings".
"companionSettings": { # Companion Settings # Settings for the companion creatives of video creatives served to this placement.
"kind": "dfareporting#companionSetting", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#companionSetting".
"companionsDisabled": True or False, # Whether companions are disabled for this placement.
"imageOnly": True or False, # Whether to serve only static images as companions.
"enabledSizes": [ # Whitelist of companion sizes to be served to this placement. Set this list to null or empty to serve all companion sizes.
{ # Represents the dimensions of ads, placements, creatives, or creative assets.
"width": 42, # Width of this size. Acceptable values are 0 to 32767, inclusive.
"kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
"iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
"id": "A String", # ID of this size. This is a read-only, auto-generated field.
"height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive.
},
],
},
"transcodeSettings": { # Transcode Settings # Settings for the transcodes of video creatives served to this placement. If this object is provided, the creative-level transcode settings will be overridden.
"kind": "dfareporting#transcodeSetting", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#transcodeSetting".
"enabledVideoFormats": [ # Whitelist of video formats to be served to this placement. Set this list to null or empty to serve all video formats.
42,
],
},
},
"publisherUpdateInfo": { # Modification timestamp. # Information about the last publisher update. This is a read-only field.
"time": "A String", # Timestamp of the last change in milliseconds since epoch.
},
"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"
"A String",
],
"paymentApproved": True or False, # Whether payment was approved for this placement. This is a read-only field relevant only to publisher-paid placements.
"tagSetting": { # Tag Settings # Tag settings for this placement.
"includeClickThroughUrls": True or False, # Whether static landing page URLs should be included in the tags. This setting applies only to placements.
"includeClickTracking": True or False, # Whether click-tracking string should be included in the tags.
"additionalKeyValues": "A 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.
"keywordOption": "A 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.
},
"contentCategoryId": "A String", # ID of the content category assigned to this placement.
"adBlockingOptOut": True or False, # 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.
"externalId": "A String", # External ID for this placement.
"idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this placement. This is a read-only, auto-generated field.
"kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
"value": "A String", # The value of the dimension.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"matchType": "A String", # 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.
"id": "A String", # The ID associated with the value if available.
},
"size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size associated with this placement. When inserting or updating a placement, only the size ID field is used. This field is required on insertion.
"width": 42, # Width of this size. Acceptable values are 0 to 32767, inclusive.
"kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
"iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
"id": "A String", # ID of this size. This is a read-only, auto-generated field.
"height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive.
},
"sslRequired": True or False, # Whether creatives assigned to this placement must be SSL-compliant.
"status": "A String", # Third-party placement status.
"campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
"kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
"value": "A String", # The value of the dimension.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"matchType": "A String", # 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.
"id": "A String", # The ID associated with the value if available.
},
"primary": True or False, # 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.
"placementGroupId": "A String", # ID of this placement's group, if applicable.
"createInfo": { # Modification timestamp. # Information about the creation of this placement. This is a read-only field.
"time": "A String", # Timestamp of the last change in milliseconds since epoch.
},
"siteId": "A String", # 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": { # Represents a DimensionValue resource. # Dimension value for the ID of the site. This is a read-only, auto-generated field.
"kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
"value": "A String", # The value of the dimension.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"matchType": "A String", # 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.
"id": "A String", # The ID associated with the value if available.
},
"compatibility": "A 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.
"placementStrategyId": "A String", # ID of the placement strategy assigned to this placement.
"placementGroupIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the placement group. This is a read-only, auto-generated field.
"kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
"value": "A String", # The value of the dimension.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"matchType": "A String", # 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.
"id": "A String", # The ID associated with the value if available.
},
"kind": "dfareporting#placement", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#placement".
"subaccountId": "A String", # Subaccount ID of this placement. This field can be left blank.
"name": "A String", # Name of this placement.This is a required field and must be less than 256 characters long.
"lookbackConfiguration": { # Lookback configuration settings. # Lookback window settings for this placement.
"clickDuration": 42, # 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.
"postImpressionActivitiesDuration": 42, # 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.
},
"lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this placement. This is a read-only field.
"time": "A String", # Timestamp of the last change in milliseconds since epoch.
},
"pricingSchedule": { # Pricing Schedule # Pricing schedule of this placement. This field is required on insertion, specifically subfields startDate, endDate and pricingType.
"startDate": "A String", # 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.
"endDate": "A String", # 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.
"flighted": True or False, # Whether this placement is flighted. If true, pricing periods will be computed automatically.
"disregardOverdelivery": True or False, # Whether cap costs are ignored by ad serving.
"capCostOption": "A String", # Placement cap cost option.
"pricingPeriods": [ # Pricing periods for this placement.
{ # Pricing Period
"units": "A String", # Units of this pricing period. Acceptable values are 0 to 10000000000, inclusive.
"rateOrCostNanos": "A String", # Rate or cost of this pricing period in nanos (i.e., multipled by 1000000000). Acceptable values are 0 to 1000000000000000000, inclusive.
"startDate": "A String", # 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.
"endDate": "A String", # 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.
"pricingComment": "A String", # Comments for this pricing period.
},
],
"pricingType": "A String", # Placement pricing type. This field is required on insertion.
"testingStartDate": "A String", # 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.
"floodlightActivityId": "A String", # Floodlight activity ID associated with this placement. This field should be set when placement pricing type is set to PRICING_TYPE_CPA.
},
"vpaidAdapterChoice": "A 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.
},
],
}</pre>
</div>
<div class="method">
<code class="details" id="list_next">list_next(previous_request, previous_response)</code>
<pre>Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
<div class="method">
<code class="details" id="patch">patch(profileId, id, body)</code>
<pre>Updates an existing placement. This method supports patch semantics.
Args:
profileId: string, User profile ID associated with this request. (required)
id: string, Placement ID. (required)
body: object, The request body. (required)
The object takes the form of:
{ # Contains properties of a placement.
"comment": "A String", # Comments for this placement.
"videoActiveViewOptOut": True or False, # 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.
"campaignId": "A String", # Campaign ID of this placement. This field is a required field on insertion.
"paymentSource": "A String", # Payment source for this placement. This is a required field that is read-only after insertion.
"directorySiteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field.
"kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
"value": "A String", # The value of the dimension.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"matchType": "A String", # 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.
"id": "A String", # The ID associated with the value if available.
},
"advertiserId": "A String", # Advertiser ID of this placement. This field can be left blank.
"keyName": "A String", # Key name of this placement. This is a read-only, auto-generated field.
"directorySiteId": "A String", # 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.
"advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
"kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
"value": "A String", # The value of the dimension.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"matchType": "A String", # 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.
"id": "A String", # The ID associated with the value if available.
},
"id": "A String", # ID of this placement. This is a read-only, auto-generated field.
"accountId": "A String", # Account ID of this placement. This field can be left blank.
"archived": True or False, # Whether this placement is archived.
"videoSettings": { # Video Settings # A collection of settings which affect video creatives served through this placement. Applicable to placements with IN_STREAM_VIDEO compatibility.
"skippableSettings": { # Skippable Settings # Settings for the skippability of video creatives served to this placement. If this object is provided, the creative-level skippable settings will be overridden.
"skippable": True or False, # Whether the user can skip creatives served to this placement.
"kind": "dfareporting#skippableSetting", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#skippableSetting".
"skipOffset": { # Video Offset # Amount of time to play videos served to this placement before the skip button should appear. Applicable when skippable is true.
"offsetPercentage": 42, # Duration, as a percentage of video duration. Do not set when offsetSeconds is set. Acceptable values are 0 to 100, inclusive.
"offsetSeconds": 42, # Duration, in seconds. Do not set when offsetPercentage is set. Acceptable values are 0 to 86399, inclusive.
},
"progressOffset": { # Video Offset # Amount of time to play videos served to this placement before counting a view. Applicable when skippable is true.
"offsetPercentage": 42, # Duration, as a percentage of video duration. Do not set when offsetSeconds is set. Acceptable values are 0 to 100, inclusive.
"offsetSeconds": 42, # Duration, in seconds. Do not set when offsetPercentage is set. Acceptable values are 0 to 86399, inclusive.
},
},
"kind": "dfareporting#videoSettings", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#videoSettings".
"companionSettings": { # Companion Settings # Settings for the companion creatives of video creatives served to this placement.
"kind": "dfareporting#companionSetting", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#companionSetting".
"companionsDisabled": True or False, # Whether companions are disabled for this placement.
"imageOnly": True or False, # Whether to serve only static images as companions.
"enabledSizes": [ # Whitelist of companion sizes to be served to this placement. Set this list to null or empty to serve all companion sizes.
{ # Represents the dimensions of ads, placements, creatives, or creative assets.
"width": 42, # Width of this size. Acceptable values are 0 to 32767, inclusive.
"kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
"iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
"id": "A String", # ID of this size. This is a read-only, auto-generated field.
"height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive.
},
],
},
"transcodeSettings": { # Transcode Settings # Settings for the transcodes of video creatives served to this placement. If this object is provided, the creative-level transcode settings will be overridden.
"kind": "dfareporting#transcodeSetting", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#transcodeSetting".
"enabledVideoFormats": [ # Whitelist of video formats to be served to this placement. Set this list to null or empty to serve all video formats.
42,
],
},
},
"publisherUpdateInfo": { # Modification timestamp. # Information about the last publisher update. This is a read-only field.
"time": "A String", # Timestamp of the last change in milliseconds since epoch.
},
"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"
"A String",
],
"paymentApproved": True or False, # Whether payment was approved for this placement. This is a read-only field relevant only to publisher-paid placements.
"tagSetting": { # Tag Settings # Tag settings for this placement.
"includeClickThroughUrls": True or False, # Whether static landing page URLs should be included in the tags. This setting applies only to placements.
"includeClickTracking": True or False, # Whether click-tracking string should be included in the tags.
"additionalKeyValues": "A 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.
"keywordOption": "A 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.
},
"contentCategoryId": "A String", # ID of the content category assigned to this placement.
"adBlockingOptOut": True or False, # 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.
"externalId": "A String", # External ID for this placement.
"idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this placement. This is a read-only, auto-generated field.
"kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
"value": "A String", # The value of the dimension.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"matchType": "A String", # 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.
"id": "A String", # The ID associated with the value if available.
},
"size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size associated with this placement. When inserting or updating a placement, only the size ID field is used. This field is required on insertion.
"width": 42, # Width of this size. Acceptable values are 0 to 32767, inclusive.
"kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
"iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
"id": "A String", # ID of this size. This is a read-only, auto-generated field.
"height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive.
},
"sslRequired": True or False, # Whether creatives assigned to this placement must be SSL-compliant.
"status": "A String", # Third-party placement status.
"campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
"kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
"value": "A String", # The value of the dimension.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"matchType": "A String", # 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.
"id": "A String", # The ID associated with the value if available.
},
"primary": True or False, # 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.
"placementGroupId": "A String", # ID of this placement's group, if applicable.
"createInfo": { # Modification timestamp. # Information about the creation of this placement. This is a read-only field.
"time": "A String", # Timestamp of the last change in milliseconds since epoch.
},
"siteId": "A String", # 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": { # Represents a DimensionValue resource. # Dimension value for the ID of the site. This is a read-only, auto-generated field.
"kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
"value": "A String", # The value of the dimension.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"matchType": "A String", # 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.
"id": "A String", # The ID associated with the value if available.
},
"compatibility": "A 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.
"placementStrategyId": "A String", # ID of the placement strategy assigned to this placement.
"placementGroupIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the placement group. This is a read-only, auto-generated field.
"kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
"value": "A String", # The value of the dimension.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"matchType": "A String", # 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.
"id": "A String", # The ID associated with the value if available.
},
"kind": "dfareporting#placement", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#placement".
"subaccountId": "A String", # Subaccount ID of this placement. This field can be left blank.
"name": "A String", # Name of this placement.This is a required field and must be less than 256 characters long.
"lookbackConfiguration": { # Lookback configuration settings. # Lookback window settings for this placement.
"clickDuration": 42, # 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.
"postImpressionActivitiesDuration": 42, # 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.
},
"lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this placement. This is a read-only field.
"time": "A String", # Timestamp of the last change in milliseconds since epoch.
},
"pricingSchedule": { # Pricing Schedule # Pricing schedule of this placement. This field is required on insertion, specifically subfields startDate, endDate and pricingType.
"startDate": "A String", # 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.
"endDate": "A String", # 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.
"flighted": True or False, # Whether this placement is flighted. If true, pricing periods will be computed automatically.
"disregardOverdelivery": True or False, # Whether cap costs are ignored by ad serving.
"capCostOption": "A String", # Placement cap cost option.
"pricingPeriods": [ # Pricing periods for this placement.
{ # Pricing Period
"units": "A String", # Units of this pricing period. Acceptable values are 0 to 10000000000, inclusive.
"rateOrCostNanos": "A String", # Rate or cost of this pricing period in nanos (i.e., multipled by 1000000000). Acceptable values are 0 to 1000000000000000000, inclusive.
"startDate": "A String", # 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.
"endDate": "A String", # 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.
"pricingComment": "A String", # Comments for this pricing period.
},
],
"pricingType": "A String", # Placement pricing type. This field is required on insertion.
"testingStartDate": "A String", # 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.
"floodlightActivityId": "A String", # Floodlight activity ID associated with this placement. This field should be set when placement pricing type is set to PRICING_TYPE_CPA.
},
"vpaidAdapterChoice": "A 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.
}
Returns:
An object of the form:
{ # Contains properties of a placement.
"comment": "A String", # Comments for this placement.
"videoActiveViewOptOut": True or False, # 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.
"campaignId": "A String", # Campaign ID of this placement. This field is a required field on insertion.
"paymentSource": "A String", # Payment source for this placement. This is a required field that is read-only after insertion.
"directorySiteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field.
"kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
"value": "A String", # The value of the dimension.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"matchType": "A String", # 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.
"id": "A String", # The ID associated with the value if available.
},
"advertiserId": "A String", # Advertiser ID of this placement. This field can be left blank.
"keyName": "A String", # Key name of this placement. This is a read-only, auto-generated field.
"directorySiteId": "A String", # 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.
"advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
"kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
"value": "A String", # The value of the dimension.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"matchType": "A String", # 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.
"id": "A String", # The ID associated with the value if available.
},
"id": "A String", # ID of this placement. This is a read-only, auto-generated field.
"accountId": "A String", # Account ID of this placement. This field can be left blank.
"archived": True or False, # Whether this placement is archived.
"videoSettings": { # Video Settings # A collection of settings which affect video creatives served through this placement. Applicable to placements with IN_STREAM_VIDEO compatibility.
"skippableSettings": { # Skippable Settings # Settings for the skippability of video creatives served to this placement. If this object is provided, the creative-level skippable settings will be overridden.
"skippable": True or False, # Whether the user can skip creatives served to this placement.
"kind": "dfareporting#skippableSetting", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#skippableSetting".
"skipOffset": { # Video Offset # Amount of time to play videos served to this placement before the skip button should appear. Applicable when skippable is true.
"offsetPercentage": 42, # Duration, as a percentage of video duration. Do not set when offsetSeconds is set. Acceptable values are 0 to 100, inclusive.
"offsetSeconds": 42, # Duration, in seconds. Do not set when offsetPercentage is set. Acceptable values are 0 to 86399, inclusive.
},
"progressOffset": { # Video Offset # Amount of time to play videos served to this placement before counting a view. Applicable when skippable is true.
"offsetPercentage": 42, # Duration, as a percentage of video duration. Do not set when offsetSeconds is set. Acceptable values are 0 to 100, inclusive.
"offsetSeconds": 42, # Duration, in seconds. Do not set when offsetPercentage is set. Acceptable values are 0 to 86399, inclusive.
},
},
"kind": "dfareporting#videoSettings", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#videoSettings".
"companionSettings": { # Companion Settings # Settings for the companion creatives of video creatives served to this placement.
"kind": "dfareporting#companionSetting", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#companionSetting".
"companionsDisabled": True or False, # Whether companions are disabled for this placement.
"imageOnly": True or False, # Whether to serve only static images as companions.
"enabledSizes": [ # Whitelist of companion sizes to be served to this placement. Set this list to null or empty to serve all companion sizes.
{ # Represents the dimensions of ads, placements, creatives, or creative assets.
"width": 42, # Width of this size. Acceptable values are 0 to 32767, inclusive.
"kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
"iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
"id": "A String", # ID of this size. This is a read-only, auto-generated field.
"height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive.
},
],
},
"transcodeSettings": { # Transcode Settings # Settings for the transcodes of video creatives served to this placement. If this object is provided, the creative-level transcode settings will be overridden.
"kind": "dfareporting#transcodeSetting", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#transcodeSetting".
"enabledVideoFormats": [ # Whitelist of video formats to be served to this placement. Set this list to null or empty to serve all video formats.
42,
],
},
},
"publisherUpdateInfo": { # Modification timestamp. # Information about the last publisher update. This is a read-only field.
"time": "A String", # Timestamp of the last change in milliseconds since epoch.
},
"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"
"A String",
],
"paymentApproved": True or False, # Whether payment was approved for this placement. This is a read-only field relevant only to publisher-paid placements.
"tagSetting": { # Tag Settings # Tag settings for this placement.
"includeClickThroughUrls": True or False, # Whether static landing page URLs should be included in the tags. This setting applies only to placements.
"includeClickTracking": True or False, # Whether click-tracking string should be included in the tags.
"additionalKeyValues": "A 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.
"keywordOption": "A 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.
},
"contentCategoryId": "A String", # ID of the content category assigned to this placement.
"adBlockingOptOut": True or False, # 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.
"externalId": "A String", # External ID for this placement.
"idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this placement. This is a read-only, auto-generated field.
"kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
"value": "A String", # The value of the dimension.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"matchType": "A String", # 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.
"id": "A String", # The ID associated with the value if available.
},
"size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size associated with this placement. When inserting or updating a placement, only the size ID field is used. This field is required on insertion.
"width": 42, # Width of this size. Acceptable values are 0 to 32767, inclusive.
"kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
"iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
"id": "A String", # ID of this size. This is a read-only, auto-generated field.
"height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive.
},
"sslRequired": True or False, # Whether creatives assigned to this placement must be SSL-compliant.
"status": "A String", # Third-party placement status.
"campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
"kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
"value": "A String", # The value of the dimension.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"matchType": "A String", # 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.
"id": "A String", # The ID associated with the value if available.
},
"primary": True or False, # 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.
"placementGroupId": "A String", # ID of this placement's group, if applicable.
"createInfo": { # Modification timestamp. # Information about the creation of this placement. This is a read-only field.
"time": "A String", # Timestamp of the last change in milliseconds since epoch.
},
"siteId": "A String", # 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": { # Represents a DimensionValue resource. # Dimension value for the ID of the site. This is a read-only, auto-generated field.
"kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
"value": "A String", # The value of the dimension.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"matchType": "A String", # 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.
"id": "A String", # The ID associated with the value if available.
},
"compatibility": "A 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.
"placementStrategyId": "A String", # ID of the placement strategy assigned to this placement.
"placementGroupIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the placement group. This is a read-only, auto-generated field.
"kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
"value": "A String", # The value of the dimension.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"matchType": "A String", # 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.
"id": "A String", # The ID associated with the value if available.
},
"kind": "dfareporting#placement", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#placement".
"subaccountId": "A String", # Subaccount ID of this placement. This field can be left blank.
"name": "A String", # Name of this placement.This is a required field and must be less than 256 characters long.
"lookbackConfiguration": { # Lookback configuration settings. # Lookback window settings for this placement.
"clickDuration": 42, # 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.
"postImpressionActivitiesDuration": 42, # 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.
},
"lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this placement. This is a read-only field.
"time": "A String", # Timestamp of the last change in milliseconds since epoch.
},
"pricingSchedule": { # Pricing Schedule # Pricing schedule of this placement. This field is required on insertion, specifically subfields startDate, endDate and pricingType.
"startDate": "A String", # 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.
"endDate": "A String", # 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.
"flighted": True or False, # Whether this placement is flighted. If true, pricing periods will be computed automatically.
"disregardOverdelivery": True or False, # Whether cap costs are ignored by ad serving.
"capCostOption": "A String", # Placement cap cost option.
"pricingPeriods": [ # Pricing periods for this placement.
{ # Pricing Period
"units": "A String", # Units of this pricing period. Acceptable values are 0 to 10000000000, inclusive.
"rateOrCostNanos": "A String", # Rate or cost of this pricing period in nanos (i.e., multipled by 1000000000). Acceptable values are 0 to 1000000000000000000, inclusive.
"startDate": "A String", # 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.
"endDate": "A String", # 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.
"pricingComment": "A String", # Comments for this pricing period.
},
],
"pricingType": "A String", # Placement pricing type. This field is required on insertion.
"testingStartDate": "A String", # 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.
"floodlightActivityId": "A String", # Floodlight activity ID associated with this placement. This field should be set when placement pricing type is set to PRICING_TYPE_CPA.
},
"vpaidAdapterChoice": "A 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.
}</pre>
</div>
<div class="method">
<code class="details" id="update">update(profileId, body)</code>
<pre>Updates an existing placement.
Args:
profileId: string, User profile ID associated with this request. (required)
body: object, The request body. (required)
The object takes the form of:
{ # Contains properties of a placement.
"comment": "A String", # Comments for this placement.
"videoActiveViewOptOut": True or False, # 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.
"campaignId": "A String", # Campaign ID of this placement. This field is a required field on insertion.
"paymentSource": "A String", # Payment source for this placement. This is a required field that is read-only after insertion.
"directorySiteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field.
"kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
"value": "A String", # The value of the dimension.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"matchType": "A String", # 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.
"id": "A String", # The ID associated with the value if available.
},
"advertiserId": "A String", # Advertiser ID of this placement. This field can be left blank.
"keyName": "A String", # Key name of this placement. This is a read-only, auto-generated field.
"directorySiteId": "A String", # 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.
"advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
"kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
"value": "A String", # The value of the dimension.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"matchType": "A String", # 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.
"id": "A String", # The ID associated with the value if available.
},
"id": "A String", # ID of this placement. This is a read-only, auto-generated field.
"accountId": "A String", # Account ID of this placement. This field can be left blank.
"archived": True or False, # Whether this placement is archived.
"videoSettings": { # Video Settings # A collection of settings which affect video creatives served through this placement. Applicable to placements with IN_STREAM_VIDEO compatibility.
"skippableSettings": { # Skippable Settings # Settings for the skippability of video creatives served to this placement. If this object is provided, the creative-level skippable settings will be overridden.
"skippable": True or False, # Whether the user can skip creatives served to this placement.
"kind": "dfareporting#skippableSetting", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#skippableSetting".
"skipOffset": { # Video Offset # Amount of time to play videos served to this placement before the skip button should appear. Applicable when skippable is true.
"offsetPercentage": 42, # Duration, as a percentage of video duration. Do not set when offsetSeconds is set. Acceptable values are 0 to 100, inclusive.
"offsetSeconds": 42, # Duration, in seconds. Do not set when offsetPercentage is set. Acceptable values are 0 to 86399, inclusive.
},
"progressOffset": { # Video Offset # Amount of time to play videos served to this placement before counting a view. Applicable when skippable is true.
"offsetPercentage": 42, # Duration, as a percentage of video duration. Do not set when offsetSeconds is set. Acceptable values are 0 to 100, inclusive.
"offsetSeconds": 42, # Duration, in seconds. Do not set when offsetPercentage is set. Acceptable values are 0 to 86399, inclusive.
},
},
"kind": "dfareporting#videoSettings", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#videoSettings".
"companionSettings": { # Companion Settings # Settings for the companion creatives of video creatives served to this placement.
"kind": "dfareporting#companionSetting", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#companionSetting".
"companionsDisabled": True or False, # Whether companions are disabled for this placement.
"imageOnly": True or False, # Whether to serve only static images as companions.
"enabledSizes": [ # Whitelist of companion sizes to be served to this placement. Set this list to null or empty to serve all companion sizes.
{ # Represents the dimensions of ads, placements, creatives, or creative assets.
"width": 42, # Width of this size. Acceptable values are 0 to 32767, inclusive.
"kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
"iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
"id": "A String", # ID of this size. This is a read-only, auto-generated field.
"height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive.
},
],
},
"transcodeSettings": { # Transcode Settings # Settings for the transcodes of video creatives served to this placement. If this object is provided, the creative-level transcode settings will be overridden.
"kind": "dfareporting#transcodeSetting", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#transcodeSetting".
"enabledVideoFormats": [ # Whitelist of video formats to be served to this placement. Set this list to null or empty to serve all video formats.
42,
],
},
},
"publisherUpdateInfo": { # Modification timestamp. # Information about the last publisher update. This is a read-only field.
"time": "A String", # Timestamp of the last change in milliseconds since epoch.
},
"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"
"A String",
],
"paymentApproved": True or False, # Whether payment was approved for this placement. This is a read-only field relevant only to publisher-paid placements.
"tagSetting": { # Tag Settings # Tag settings for this placement.
"includeClickThroughUrls": True or False, # Whether static landing page URLs should be included in the tags. This setting applies only to placements.
"includeClickTracking": True or False, # Whether click-tracking string should be included in the tags.
"additionalKeyValues": "A 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.
"keywordOption": "A 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.
},
"contentCategoryId": "A String", # ID of the content category assigned to this placement.
"adBlockingOptOut": True or False, # 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.
"externalId": "A String", # External ID for this placement.
"idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this placement. This is a read-only, auto-generated field.
"kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
"value": "A String", # The value of the dimension.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"matchType": "A String", # 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.
"id": "A String", # The ID associated with the value if available.
},
"size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size associated with this placement. When inserting or updating a placement, only the size ID field is used. This field is required on insertion.
"width": 42, # Width of this size. Acceptable values are 0 to 32767, inclusive.
"kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
"iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
"id": "A String", # ID of this size. This is a read-only, auto-generated field.
"height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive.
},
"sslRequired": True or False, # Whether creatives assigned to this placement must be SSL-compliant.
"status": "A String", # Third-party placement status.
"campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
"kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
"value": "A String", # The value of the dimension.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"matchType": "A String", # 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.
"id": "A String", # The ID associated with the value if available.
},
"primary": True or False, # 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.
"placementGroupId": "A String", # ID of this placement's group, if applicable.
"createInfo": { # Modification timestamp. # Information about the creation of this placement. This is a read-only field.
"time": "A String", # Timestamp of the last change in milliseconds since epoch.
},
"siteId": "A String", # 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": { # Represents a DimensionValue resource. # Dimension value for the ID of the site. This is a read-only, auto-generated field.
"kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
"value": "A String", # The value of the dimension.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"matchType": "A String", # 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.
"id": "A String", # The ID associated with the value if available.
},
"compatibility": "A 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.
"placementStrategyId": "A String", # ID of the placement strategy assigned to this placement.
"placementGroupIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the placement group. This is a read-only, auto-generated field.
"kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
"value": "A String", # The value of the dimension.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"matchType": "A String", # 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.
"id": "A String", # The ID associated with the value if available.
},
"kind": "dfareporting#placement", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#placement".
"subaccountId": "A String", # Subaccount ID of this placement. This field can be left blank.
"name": "A String", # Name of this placement.This is a required field and must be less than 256 characters long.
"lookbackConfiguration": { # Lookback configuration settings. # Lookback window settings for this placement.
"clickDuration": 42, # 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.
"postImpressionActivitiesDuration": 42, # 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.
},
"lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this placement. This is a read-only field.
"time": "A String", # Timestamp of the last change in milliseconds since epoch.
},
"pricingSchedule": { # Pricing Schedule # Pricing schedule of this placement. This field is required on insertion, specifically subfields startDate, endDate and pricingType.
"startDate": "A String", # 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.
"endDate": "A String", # 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.
"flighted": True or False, # Whether this placement is flighted. If true, pricing periods will be computed automatically.
"disregardOverdelivery": True or False, # Whether cap costs are ignored by ad serving.
"capCostOption": "A String", # Placement cap cost option.
"pricingPeriods": [ # Pricing periods for this placement.
{ # Pricing Period
"units": "A String", # Units of this pricing period. Acceptable values are 0 to 10000000000, inclusive.
"rateOrCostNanos": "A String", # Rate or cost of this pricing period in nanos (i.e., multipled by 1000000000). Acceptable values are 0 to 1000000000000000000, inclusive.
"startDate": "A String", # 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.
"endDate": "A String", # 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.
"pricingComment": "A String", # Comments for this pricing period.
},
],
"pricingType": "A String", # Placement pricing type. This field is required on insertion.
"testingStartDate": "A String", # 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.
"floodlightActivityId": "A String", # Floodlight activity ID associated with this placement. This field should be set when placement pricing type is set to PRICING_TYPE_CPA.
},
"vpaidAdapterChoice": "A 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.
}
Returns:
An object of the form:
{ # Contains properties of a placement.
"comment": "A String", # Comments for this placement.
"videoActiveViewOptOut": True or False, # 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.
"campaignId": "A String", # Campaign ID of this placement. This field is a required field on insertion.
"paymentSource": "A String", # Payment source for this placement. This is a required field that is read-only after insertion.
"directorySiteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field.
"kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
"value": "A String", # The value of the dimension.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"matchType": "A String", # 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.
"id": "A String", # The ID associated with the value if available.
},
"advertiserId": "A String", # Advertiser ID of this placement. This field can be left blank.
"keyName": "A String", # Key name of this placement. This is a read-only, auto-generated field.
"directorySiteId": "A String", # 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.
"advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
"kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
"value": "A String", # The value of the dimension.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"matchType": "A String", # 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.
"id": "A String", # The ID associated with the value if available.
},
"id": "A String", # ID of this placement. This is a read-only, auto-generated field.
"accountId": "A String", # Account ID of this placement. This field can be left blank.
"archived": True or False, # Whether this placement is archived.
"videoSettings": { # Video Settings # A collection of settings which affect video creatives served through this placement. Applicable to placements with IN_STREAM_VIDEO compatibility.
"skippableSettings": { # Skippable Settings # Settings for the skippability of video creatives served to this placement. If this object is provided, the creative-level skippable settings will be overridden.
"skippable": True or False, # Whether the user can skip creatives served to this placement.
"kind": "dfareporting#skippableSetting", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#skippableSetting".
"skipOffset": { # Video Offset # Amount of time to play videos served to this placement before the skip button should appear. Applicable when skippable is true.
"offsetPercentage": 42, # Duration, as a percentage of video duration. Do not set when offsetSeconds is set. Acceptable values are 0 to 100, inclusive.
"offsetSeconds": 42, # Duration, in seconds. Do not set when offsetPercentage is set. Acceptable values are 0 to 86399, inclusive.
},
"progressOffset": { # Video Offset # Amount of time to play videos served to this placement before counting a view. Applicable when skippable is true.
"offsetPercentage": 42, # Duration, as a percentage of video duration. Do not set when offsetSeconds is set. Acceptable values are 0 to 100, inclusive.
"offsetSeconds": 42, # Duration, in seconds. Do not set when offsetPercentage is set. Acceptable values are 0 to 86399, inclusive.
},
},
"kind": "dfareporting#videoSettings", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#videoSettings".
"companionSettings": { # Companion Settings # Settings for the companion creatives of video creatives served to this placement.
"kind": "dfareporting#companionSetting", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#companionSetting".
"companionsDisabled": True or False, # Whether companions are disabled for this placement.
"imageOnly": True or False, # Whether to serve only static images as companions.
"enabledSizes": [ # Whitelist of companion sizes to be served to this placement. Set this list to null or empty to serve all companion sizes.
{ # Represents the dimensions of ads, placements, creatives, or creative assets.
"width": 42, # Width of this size. Acceptable values are 0 to 32767, inclusive.
"kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
"iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
"id": "A String", # ID of this size. This is a read-only, auto-generated field.
"height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive.
},
],
},
"transcodeSettings": { # Transcode Settings # Settings for the transcodes of video creatives served to this placement. If this object is provided, the creative-level transcode settings will be overridden.
"kind": "dfareporting#transcodeSetting", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#transcodeSetting".
"enabledVideoFormats": [ # Whitelist of video formats to be served to this placement. Set this list to null or empty to serve all video formats.
42,
],
},
},
"publisherUpdateInfo": { # Modification timestamp. # Information about the last publisher update. This is a read-only field.
"time": "A String", # Timestamp of the last change in milliseconds since epoch.
},
"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"
"A String",
],
"paymentApproved": True or False, # Whether payment was approved for this placement. This is a read-only field relevant only to publisher-paid placements.
"tagSetting": { # Tag Settings # Tag settings for this placement.
"includeClickThroughUrls": True or False, # Whether static landing page URLs should be included in the tags. This setting applies only to placements.
"includeClickTracking": True or False, # Whether click-tracking string should be included in the tags.
"additionalKeyValues": "A 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.
"keywordOption": "A 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.
},
"contentCategoryId": "A String", # ID of the content category assigned to this placement.
"adBlockingOptOut": True or False, # 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.
"externalId": "A String", # External ID for this placement.
"idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this placement. This is a read-only, auto-generated field.
"kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
"value": "A String", # The value of the dimension.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"matchType": "A String", # 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.
"id": "A String", # The ID associated with the value if available.
},
"size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size associated with this placement. When inserting or updating a placement, only the size ID field is used. This field is required on insertion.
"width": 42, # Width of this size. Acceptable values are 0 to 32767, inclusive.
"kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
"iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
"id": "A String", # ID of this size. This is a read-only, auto-generated field.
"height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive.
},
"sslRequired": True or False, # Whether creatives assigned to this placement must be SSL-compliant.
"status": "A String", # Third-party placement status.
"campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
"kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
"value": "A String", # The value of the dimension.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"matchType": "A String", # 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.
"id": "A String", # The ID associated with the value if available.
},
"primary": True or False, # 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.
"placementGroupId": "A String", # ID of this placement's group, if applicable.
"createInfo": { # Modification timestamp. # Information about the creation of this placement. This is a read-only field.
"time": "A String", # Timestamp of the last change in milliseconds since epoch.
},
"siteId": "A String", # 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": { # Represents a DimensionValue resource. # Dimension value for the ID of the site. This is a read-only, auto-generated field.
"kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
"value": "A String", # The value of the dimension.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"matchType": "A String", # 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.
"id": "A String", # The ID associated with the value if available.
},
"compatibility": "A 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.
"placementStrategyId": "A String", # ID of the placement strategy assigned to this placement.
"placementGroupIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the placement group. This is a read-only, auto-generated field.
"kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
"value": "A String", # The value of the dimension.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"matchType": "A String", # 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.
"id": "A String", # The ID associated with the value if available.
},
"kind": "dfareporting#placement", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#placement".
"subaccountId": "A String", # Subaccount ID of this placement. This field can be left blank.
"name": "A String", # Name of this placement.This is a required field and must be less than 256 characters long.
"lookbackConfiguration": { # Lookback configuration settings. # Lookback window settings for this placement.
"clickDuration": 42, # 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.
"postImpressionActivitiesDuration": 42, # 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.
},
"lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this placement. This is a read-only field.
"time": "A String", # Timestamp of the last change in milliseconds since epoch.
},
"pricingSchedule": { # Pricing Schedule # Pricing schedule of this placement. This field is required on insertion, specifically subfields startDate, endDate and pricingType.
"startDate": "A String", # 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.
"endDate": "A String", # 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.
"flighted": True or False, # Whether this placement is flighted. If true, pricing periods will be computed automatically.
"disregardOverdelivery": True or False, # Whether cap costs are ignored by ad serving.
"capCostOption": "A String", # Placement cap cost option.
"pricingPeriods": [ # Pricing periods for this placement.
{ # Pricing Period
"units": "A String", # Units of this pricing period. Acceptable values are 0 to 10000000000, inclusive.
"rateOrCostNanos": "A String", # Rate or cost of this pricing period in nanos (i.e., multipled by 1000000000). Acceptable values are 0 to 1000000000000000000, inclusive.
"startDate": "A String", # 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.
"endDate": "A String", # 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.
"pricingComment": "A String", # Comments for this pricing period.
},
],
"pricingType": "A String", # Placement pricing type. This field is required on insertion.
"testingStartDate": "A String", # 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.
"floodlightActivityId": "A String", # Floodlight activity ID associated with this placement. This field should be set when placement pricing type is set to PRICING_TYPE_CPA.
},
"vpaidAdapterChoice": "A 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.
}</pre>
</div>
</body></html>