1<html><body> 2<style> 3 4body, h1, h2, h3, div, span, p, pre, a { 5 margin: 0; 6 padding: 0; 7 border: 0; 8 font-weight: inherit; 9 font-style: inherit; 10 font-size: 100%; 11 font-family: inherit; 12 vertical-align: baseline; 13} 14 15body { 16 font-size: 13px; 17 padding: 1em; 18} 19 20h1 { 21 font-size: 26px; 22 margin-bottom: 1em; 23} 24 25h2 { 26 font-size: 24px; 27 margin-bottom: 1em; 28} 29 30h3 { 31 font-size: 20px; 32 margin-bottom: 1em; 33 margin-top: 1em; 34} 35 36pre, code { 37 line-height: 1.5; 38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; 39} 40 41pre { 42 margin-top: 0.5em; 43} 44 45h1, h2, h3, p { 46 font-family: Arial, sans serif; 47} 48 49h1, h2, h3 { 50 border-bottom: solid #CCC 1px; 51} 52 53.toc_element { 54 margin-top: 0.5em; 55} 56 57.firstline { 58 margin-left: 2 em; 59} 60 61.method { 62 margin-top: 1em; 63 border: solid 1px #CCC; 64 padding: 1em; 65 background: #EEE; 66} 67 68.details { 69 font-weight: bold; 70 font-size: 14px; 71} 72 73</style> 74 75<h1><a href="dfareporting_v3_3.html">Campaign Manager 360 API</a> . <a href="dfareporting_v3_3.placements.html">placements</a></h1> 76<h2>Instance Methods</h2> 77<p class="toc_element"> 78 <code><a href="#close">close()</a></code></p> 79<p class="firstline">Close httplib2 connections.</p> 80<p class="toc_element"> 81 <code><a href="#generatetags">generatetags(profileId, campaignId=None, placementIds=None, tagFormats=None, x__xgafv=None)</a></code></p> 82<p class="firstline">Generates tags for a placement.</p> 83<p class="toc_element"> 84 <code><a href="#get">get(profileId, id, x__xgafv=None)</a></code></p> 85<p class="firstline">Gets one placement by ID.</p> 86<p class="toc_element"> 87 <code><a href="#insert">insert(profileId, body=None, x__xgafv=None)</a></code></p> 88<p class="firstline">Inserts a new placement.</p> 89<p class="toc_element"> 90 <code><a href="#list">list(profileId, advertiserIds=None, archived=None, campaignIds=None, compatibilities=None, contentCategoryIds=None, directorySiteIds=None, groupIds=None, ids=None, maxEndDate=None, maxResults=None, maxStartDate=None, minEndDate=None, minStartDate=None, pageToken=None, paymentSource=None, placementStrategyIds=None, pricingTypes=None, searchString=None, siteIds=None, sizeIds=None, sortField=None, sortOrder=None, x__xgafv=None)</a></code></p> 91<p class="firstline">Retrieves a list of placements, possibly filtered. This method supports paging.</p> 92<p class="toc_element"> 93 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> 94<p class="firstline">Retrieves the next page of results.</p> 95<p class="toc_element"> 96 <code><a href="#patch">patch(profileId, id, body=None, x__xgafv=None)</a></code></p> 97<p class="firstline">Updates an existing placement. This method supports patch semantics.</p> 98<p class="toc_element"> 99 <code><a href="#update">update(profileId, body=None, x__xgafv=None)</a></code></p> 100<p class="firstline">Updates an existing placement.</p> 101<h3>Method Details</h3> 102<div class="method"> 103 <code class="details" id="close">close()</code> 104 <pre>Close httplib2 connections.</pre> 105</div> 106 107<div class="method"> 108 <code class="details" id="generatetags">generatetags(profileId, campaignId=None, placementIds=None, tagFormats=None, x__xgafv=None)</code> 109 <pre>Generates tags for a placement. 110 111Args: 112 profileId: string, User profile ID associated with this request. (required) 113 campaignId: string, Generate placements belonging to this campaign. This is a required field. 114 placementIds: string, Generate tags for these placements. (repeated) 115 tagFormats: string, Tag formats to generate for these placements. *Note:* PLACEMENT_TAG_STANDARD can only be generated for 1x1 placements. (repeated) 116 Allowed values 117 PLACEMENT_TAG_STANDARD - 118 PLACEMENT_TAG_IFRAME_JAVASCRIPT - 119 PLACEMENT_TAG_IFRAME_ILAYER - 120 PLACEMENT_TAG_INTERNAL_REDIRECT - 121 PLACEMENT_TAG_JAVASCRIPT - 122 PLACEMENT_TAG_INTERSTITIAL_IFRAME_JAVASCRIPT - 123 PLACEMENT_TAG_INTERSTITIAL_INTERNAL_REDIRECT - 124 PLACEMENT_TAG_INTERSTITIAL_JAVASCRIPT - 125 PLACEMENT_TAG_CLICK_COMMANDS - 126 PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH - 127 PLACEMENT_TAG_TRACKING - 128 PLACEMENT_TAG_TRACKING_IFRAME - 129 PLACEMENT_TAG_TRACKING_JAVASCRIPT - 130 PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH_VAST_3 - 131 PLACEMENT_TAG_IFRAME_JAVASCRIPT_LEGACY - 132 PLACEMENT_TAG_JAVASCRIPT_LEGACY - 133 PLACEMENT_TAG_INTERSTITIAL_IFRAME_JAVASCRIPT_LEGACY - 134 PLACEMENT_TAG_INTERSTITIAL_JAVASCRIPT_LEGACY - 135 PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH_VAST_4 - 136 x__xgafv: string, V1 error format. 137 Allowed values 138 1 - v1 error format 139 2 - v2 error format 140 141Returns: 142 An object of the form: 143 144 { # Placement GenerateTags Response 145 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#placementsGenerateTagsResponse". 146 "placementTags": [ # Set of generated tags for the specified placements. 147 { # Placement Tag 148 "placementId": "A String", # Placement ID 149 "tagDatas": [ # Tags generated for this placement. 150 { # Placement Tag Data 151 "adId": "A String", # Ad associated with this placement tag. Applicable only when format is PLACEMENT_TAG_TRACKING. 152 "clickTag": "A String", # Tag string to record a click. 153 "creativeId": "A String", # Creative associated with this placement tag. Applicable only when format is PLACEMENT_TAG_TRACKING. 154 "format": "A String", # TagData tag format of this tag. 155 "impressionTag": "A String", # Tag string for serving an ad. 156 }, 157 ], 158 }, 159 ], 160}</pre> 161</div> 162 163<div class="method"> 164 <code class="details" id="get">get(profileId, id, x__xgafv=None)</code> 165 <pre>Gets one placement by ID. 166 167Args: 168 profileId: string, User profile ID associated with this request. (required) 169 id: string, Placement ID. (required) 170 x__xgafv: string, V1 error format. 171 Allowed values 172 1 - v1 error format 173 2 - v2 error format 174 175Returns: 176 An object of the form: 177 178 { # Contains properties of a placement. 179 "accountId": "A String", # Account ID of this placement. This field can be left blank. 180 "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. 181 "additionalSizes": [ # Additional sizes associated with this placement. When inserting or updating a placement, only the size ID field is used. 182 { # Represents the dimensions of ads, placements, creatives, or creative assets. 183 "height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive. 184 "iab": True or False, # IAB standard size. This is a read-only, auto-generated field. 185 "id": "A String", # ID of this size. This is a read-only, auto-generated field. 186 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size". 187 "width": 42, # Width of this size. Acceptable values are 0 to 32767, inclusive. 188 }, 189 ], 190 "advertiserId": "A String", # Advertiser ID of this placement. This field can be left blank. 191 "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field. 192 "dimensionName": "A String", # The name of the dimension. 193 "etag": "A String", # The eTag of this response for caching purposes. 194 "id": "A String", # The ID associated with the value if available. 195 "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue. 196 "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. 197 "value": "A String", # The value of the dimension. 198 }, 199 "archived": True or False, # Whether this placement is archived. 200 "campaignId": "A String", # Campaign ID of this placement. This field is a required field on insertion. 201 "campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field. 202 "dimensionName": "A String", # The name of the dimension. 203 "etag": "A String", # The eTag of this response for caching purposes. 204 "id": "A String", # The ID associated with the value if available. 205 "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue. 206 "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. 207 "value": "A String", # The value of the dimension. 208 }, 209 "comment": "A String", # Comments for this placement. 210 "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. 211 "contentCategoryId": "A String", # ID of the content category assigned to this placement. 212 "createInfo": { # Modification timestamp. # Information about the creation of this placement. This is a read-only field. 213 "time": "A String", # Timestamp of the last change in milliseconds since epoch. 214 }, 215 "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. 216 "directorySiteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field. 217 "dimensionName": "A String", # The name of the dimension. 218 "etag": "A String", # The eTag of this response for caching purposes. 219 "id": "A String", # The ID associated with the value if available. 220 "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue. 221 "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. 222 "value": "A String", # The value of the dimension. 223 }, 224 "externalId": "A String", # External ID for this placement. 225 "id": "A String", # ID of this placement. This is a read-only, auto-generated field. 226 "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this placement. This is a read-only, auto-generated field. 227 "dimensionName": "A String", # The name of the dimension. 228 "etag": "A String", # The eTag of this response for caching purposes. 229 "id": "A String", # The ID associated with the value if available. 230 "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue. 231 "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. 232 "value": "A String", # The value of the dimension. 233 }, 234 "keyName": "A String", # Key name of this placement. This is a read-only, auto-generated field. 235 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#placement". 236 "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this placement. This is a read-only field. 237 "time": "A String", # Timestamp of the last change in milliseconds since epoch. 238 }, 239 "lookbackConfiguration": { # Lookback configuration settings. # Lookback window settings for this placement. 240 "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. 241 "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. 242 }, 243 "name": "A String", # Name of this placement.This is a required field and must be less than or equal to 256 characters long. 244 "paymentApproved": True or False, # Whether payment was approved for this placement. This is a read-only field relevant only to publisher-paid placements. 245 "paymentSource": "A String", # Payment source for this placement. This is a required field that is read-only after insertion. 246 "placementGroupId": "A String", # ID of this placement's group, if applicable. 247 "placementGroupIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the placement group. This is a read-only, auto-generated field. 248 "dimensionName": "A String", # The name of the dimension. 249 "etag": "A String", # The eTag of this response for caching purposes. 250 "id": "A String", # The ID associated with the value if available. 251 "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue. 252 "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. 253 "value": "A String", # The value of the dimension. 254 }, 255 "placementStrategyId": "A String", # ID of the placement strategy assigned to this placement. 256 "pricingSchedule": { # Pricing Schedule # Pricing schedule of this placement. This field is required on insertion, specifically subfields startDate, endDate and pricingType. 257 "capCostOption": "A String", # Placement cap cost option. 258 "disregardOverdelivery": True or False, # Whether cap costs are ignored by ad serving. 259 "endDate": "A String", 260 "flighted": True or False, # Whether this placement is flighted. If true, pricing periods will be computed automatically. 261 "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. 262 "pricingPeriods": [ # Pricing periods for this placement. 263 { # Pricing Period 264 "endDate": "A String", 265 "pricingComment": "A String", # Comments for this pricing period. 266 "rateOrCostNanos": "A String", # Rate or cost of this pricing period in nanos (i.e., multipled by 1000000000). Acceptable values are 0 to 1000000000000000000, inclusive. 267 "startDate": "A String", 268 "units": "A String", # Units of this pricing period. Acceptable values are 0 to 10000000000, inclusive. 269 }, 270 ], 271 "pricingType": "A String", # Placement pricing type. This field is required on insertion. 272 "startDate": "A String", 273 "testingStartDate": "A String", 274 }, 275 "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. 276 "publisherUpdateInfo": { # Modification timestamp. # Information about the last publisher update. This is a read-only field. 277 "time": "A String", # Timestamp of the last change in milliseconds since epoch. 278 }, 279 "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. 280 "siteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the site. This is a read-only, auto-generated field. 281 "dimensionName": "A String", # The name of the dimension. 282 "etag": "A String", # The eTag of this response for caching purposes. 283 "id": "A String", # The ID associated with the value if available. 284 "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue. 285 "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. 286 "value": "A String", # The value of the dimension. 287 }, 288 "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. 289 "height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive. 290 "iab": True or False, # IAB standard size. This is a read-only, auto-generated field. 291 "id": "A String", # ID of this size. This is a read-only, auto-generated field. 292 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size". 293 "width": 42, # Width of this size. Acceptable values are 0 to 32767, inclusive. 294 }, 295 "sslRequired": True or False, # Whether creatives assigned to this placement must be SSL-compliant. 296 "status": "A String", # Third-party placement status. 297 "subaccountId": "A String", # Subaccount ID of this placement. This field can be left blank. 298 "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" 299 "A String", 300 ], 301 "tagSetting": { # Tag Settings # Tag settings for this placement. 302 "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. 303 "includeClickThroughUrls": True or False, # Whether static landing page URLs should be included in the tags. This setting applies only to placements. 304 "includeClickTracking": True or False, # Whether click-tracking string should be included in the tags. 305 "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. 306 }, 307 "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. 308 "videoSettings": { # Video Settings # A collection of settings which affect video creatives served through this placement. Applicable to placements with IN_STREAM_VIDEO compatibility. 309 "companionSettings": { # Companion Settings # Settings for the companion creatives of video creatives served to this placement. 310 "companionsDisabled": True or False, # Whether companions are disabled for this placement. 311 "enabledSizes": [ # Allowlist of companion sizes to be served to this placement. Set this list to null or empty to serve all companion sizes. 312 { # Represents the dimensions of ads, placements, creatives, or creative assets. 313 "height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive. 314 "iab": True or False, # IAB standard size. This is a read-only, auto-generated field. 315 "id": "A String", # ID of this size. This is a read-only, auto-generated field. 316 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size". 317 "width": 42, # Width of this size. Acceptable values are 0 to 32767, inclusive. 318 }, 319 ], 320 "imageOnly": True or False, # Whether to serve only static images as companions. 321 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#companionSetting". 322 }, 323 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#videoSettings". 324 "orientation": "A String", # Orientation of a video placement. If this value is set, placement will return assets matching the specified orientation. 325 "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. 326 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#skippableSetting". 327 "progressOffset": { # Video Offset # Amount of time to play videos served to this placement before counting a view. Applicable when skippable is true. 328 "offsetPercentage": 42, # Duration, as a percentage of video duration. Do not set when offsetSeconds is set. Acceptable values are 0 to 100, inclusive. 329 "offsetSeconds": 42, # Duration, in seconds. Do not set when offsetPercentage is set. Acceptable values are 0 to 86399, inclusive. 330 }, 331 "skipOffset": { # Video Offset # Amount of time to play videos served to this placement before the skip button should appear. Applicable when skippable is true. 332 "offsetPercentage": 42, # Duration, as a percentage of video duration. Do not set when offsetSeconds is set. Acceptable values are 0 to 100, inclusive. 333 "offsetSeconds": 42, # Duration, in seconds. Do not set when offsetPercentage is set. Acceptable values are 0 to 86399, inclusive. 334 }, 335 "skippable": True or False, # Whether the user can skip creatives served to this placement. 336 }, 337 "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. 338 "enabledVideoFormats": [ # Allowlist of video formats to be served to this placement. Set this list to null or empty to serve all video formats. 339 42, 340 ], 341 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#transcodeSetting". 342 }, 343 }, 344 "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. *Note:* Flash is no longer supported. This field now defaults to HTML5 when the following values are provided: FLASH, BOTH. 345}</pre> 346</div> 347 348<div class="method"> 349 <code class="details" id="insert">insert(profileId, body=None, x__xgafv=None)</code> 350 <pre>Inserts a new placement. 351 352Args: 353 profileId: string, User profile ID associated with this request. (required) 354 body: object, The request body. 355 The object takes the form of: 356 357{ # Contains properties of a placement. 358 "accountId": "A String", # Account ID of this placement. This field can be left blank. 359 "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. 360 "additionalSizes": [ # Additional sizes associated with this placement. When inserting or updating a placement, only the size ID field is used. 361 { # Represents the dimensions of ads, placements, creatives, or creative assets. 362 "height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive. 363 "iab": True or False, # IAB standard size. This is a read-only, auto-generated field. 364 "id": "A String", # ID of this size. This is a read-only, auto-generated field. 365 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size". 366 "width": 42, # Width of this size. Acceptable values are 0 to 32767, inclusive. 367 }, 368 ], 369 "advertiserId": "A String", # Advertiser ID of this placement. This field can be left blank. 370 "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field. 371 "dimensionName": "A String", # The name of the dimension. 372 "etag": "A String", # The eTag of this response for caching purposes. 373 "id": "A String", # The ID associated with the value if available. 374 "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue. 375 "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. 376 "value": "A String", # The value of the dimension. 377 }, 378 "archived": True or False, # Whether this placement is archived. 379 "campaignId": "A String", # Campaign ID of this placement. This field is a required field on insertion. 380 "campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field. 381 "dimensionName": "A String", # The name of the dimension. 382 "etag": "A String", # The eTag of this response for caching purposes. 383 "id": "A String", # The ID associated with the value if available. 384 "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue. 385 "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. 386 "value": "A String", # The value of the dimension. 387 }, 388 "comment": "A String", # Comments for this placement. 389 "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. 390 "contentCategoryId": "A String", # ID of the content category assigned to this placement. 391 "createInfo": { # Modification timestamp. # Information about the creation of this placement. This is a read-only field. 392 "time": "A String", # Timestamp of the last change in milliseconds since epoch. 393 }, 394 "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. 395 "directorySiteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field. 396 "dimensionName": "A String", # The name of the dimension. 397 "etag": "A String", # The eTag of this response for caching purposes. 398 "id": "A String", # The ID associated with the value if available. 399 "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue. 400 "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. 401 "value": "A String", # The value of the dimension. 402 }, 403 "externalId": "A String", # External ID for this placement. 404 "id": "A String", # ID of this placement. This is a read-only, auto-generated field. 405 "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this placement. This is a read-only, auto-generated field. 406 "dimensionName": "A String", # The name of the dimension. 407 "etag": "A String", # The eTag of this response for caching purposes. 408 "id": "A String", # The ID associated with the value if available. 409 "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue. 410 "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. 411 "value": "A String", # The value of the dimension. 412 }, 413 "keyName": "A String", # Key name of this placement. This is a read-only, auto-generated field. 414 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#placement". 415 "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this placement. This is a read-only field. 416 "time": "A String", # Timestamp of the last change in milliseconds since epoch. 417 }, 418 "lookbackConfiguration": { # Lookback configuration settings. # Lookback window settings for this placement. 419 "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. 420 "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. 421 }, 422 "name": "A String", # Name of this placement.This is a required field and must be less than or equal to 256 characters long. 423 "paymentApproved": True or False, # Whether payment was approved for this placement. This is a read-only field relevant only to publisher-paid placements. 424 "paymentSource": "A String", # Payment source for this placement. This is a required field that is read-only after insertion. 425 "placementGroupId": "A String", # ID of this placement's group, if applicable. 426 "placementGroupIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the placement group. This is a read-only, auto-generated field. 427 "dimensionName": "A String", # The name of the dimension. 428 "etag": "A String", # The eTag of this response for caching purposes. 429 "id": "A String", # The ID associated with the value if available. 430 "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue. 431 "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. 432 "value": "A String", # The value of the dimension. 433 }, 434 "placementStrategyId": "A String", # ID of the placement strategy assigned to this placement. 435 "pricingSchedule": { # Pricing Schedule # Pricing schedule of this placement. This field is required on insertion, specifically subfields startDate, endDate and pricingType. 436 "capCostOption": "A String", # Placement cap cost option. 437 "disregardOverdelivery": True or False, # Whether cap costs are ignored by ad serving. 438 "endDate": "A String", 439 "flighted": True or False, # Whether this placement is flighted. If true, pricing periods will be computed automatically. 440 "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. 441 "pricingPeriods": [ # Pricing periods for this placement. 442 { # Pricing Period 443 "endDate": "A String", 444 "pricingComment": "A String", # Comments for this pricing period. 445 "rateOrCostNanos": "A String", # Rate or cost of this pricing period in nanos (i.e., multipled by 1000000000). Acceptable values are 0 to 1000000000000000000, inclusive. 446 "startDate": "A String", 447 "units": "A String", # Units of this pricing period. Acceptable values are 0 to 10000000000, inclusive. 448 }, 449 ], 450 "pricingType": "A String", # Placement pricing type. This field is required on insertion. 451 "startDate": "A String", 452 "testingStartDate": "A String", 453 }, 454 "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. 455 "publisherUpdateInfo": { # Modification timestamp. # Information about the last publisher update. This is a read-only field. 456 "time": "A String", # Timestamp of the last change in milliseconds since epoch. 457 }, 458 "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. 459 "siteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the site. This is a read-only, auto-generated field. 460 "dimensionName": "A String", # The name of the dimension. 461 "etag": "A String", # The eTag of this response for caching purposes. 462 "id": "A String", # The ID associated with the value if available. 463 "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue. 464 "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. 465 "value": "A String", # The value of the dimension. 466 }, 467 "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. 468 "height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive. 469 "iab": True or False, # IAB standard size. This is a read-only, auto-generated field. 470 "id": "A String", # ID of this size. This is a read-only, auto-generated field. 471 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size". 472 "width": 42, # Width of this size. Acceptable values are 0 to 32767, inclusive. 473 }, 474 "sslRequired": True or False, # Whether creatives assigned to this placement must be SSL-compliant. 475 "status": "A String", # Third-party placement status. 476 "subaccountId": "A String", # Subaccount ID of this placement. This field can be left blank. 477 "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" 478 "A String", 479 ], 480 "tagSetting": { # Tag Settings # Tag settings for this placement. 481 "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. 482 "includeClickThroughUrls": True or False, # Whether static landing page URLs should be included in the tags. This setting applies only to placements. 483 "includeClickTracking": True or False, # Whether click-tracking string should be included in the tags. 484 "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. 485 }, 486 "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. 487 "videoSettings": { # Video Settings # A collection of settings which affect video creatives served through this placement. Applicable to placements with IN_STREAM_VIDEO compatibility. 488 "companionSettings": { # Companion Settings # Settings for the companion creatives of video creatives served to this placement. 489 "companionsDisabled": True or False, # Whether companions are disabled for this placement. 490 "enabledSizes": [ # Allowlist of companion sizes to be served to this placement. Set this list to null or empty to serve all companion sizes. 491 { # Represents the dimensions of ads, placements, creatives, or creative assets. 492 "height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive. 493 "iab": True or False, # IAB standard size. This is a read-only, auto-generated field. 494 "id": "A String", # ID of this size. This is a read-only, auto-generated field. 495 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size". 496 "width": 42, # Width of this size. Acceptable values are 0 to 32767, inclusive. 497 }, 498 ], 499 "imageOnly": True or False, # Whether to serve only static images as companions. 500 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#companionSetting". 501 }, 502 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#videoSettings". 503 "orientation": "A String", # Orientation of a video placement. If this value is set, placement will return assets matching the specified orientation. 504 "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. 505 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#skippableSetting". 506 "progressOffset": { # Video Offset # Amount of time to play videos served to this placement before counting a view. Applicable when skippable is true. 507 "offsetPercentage": 42, # Duration, as a percentage of video duration. Do not set when offsetSeconds is set. Acceptable values are 0 to 100, inclusive. 508 "offsetSeconds": 42, # Duration, in seconds. Do not set when offsetPercentage is set. Acceptable values are 0 to 86399, inclusive. 509 }, 510 "skipOffset": { # Video Offset # Amount of time to play videos served to this placement before the skip button should appear. Applicable when skippable is true. 511 "offsetPercentage": 42, # Duration, as a percentage of video duration. Do not set when offsetSeconds is set. Acceptable values are 0 to 100, inclusive. 512 "offsetSeconds": 42, # Duration, in seconds. Do not set when offsetPercentage is set. Acceptable values are 0 to 86399, inclusive. 513 }, 514 "skippable": True or False, # Whether the user can skip creatives served to this placement. 515 }, 516 "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. 517 "enabledVideoFormats": [ # Allowlist of video formats to be served to this placement. Set this list to null or empty to serve all video formats. 518 42, 519 ], 520 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#transcodeSetting". 521 }, 522 }, 523 "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. *Note:* Flash is no longer supported. This field now defaults to HTML5 when the following values are provided: FLASH, BOTH. 524} 525 526 x__xgafv: string, V1 error format. 527 Allowed values 528 1 - v1 error format 529 2 - v2 error format 530 531Returns: 532 An object of the form: 533 534 { # Contains properties of a placement. 535 "accountId": "A String", # Account ID of this placement. This field can be left blank. 536 "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. 537 "additionalSizes": [ # Additional sizes associated with this placement. When inserting or updating a placement, only the size ID field is used. 538 { # Represents the dimensions of ads, placements, creatives, or creative assets. 539 "height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive. 540 "iab": True or False, # IAB standard size. This is a read-only, auto-generated field. 541 "id": "A String", # ID of this size. This is a read-only, auto-generated field. 542 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size". 543 "width": 42, # Width of this size. Acceptable values are 0 to 32767, inclusive. 544 }, 545 ], 546 "advertiserId": "A String", # Advertiser ID of this placement. This field can be left blank. 547 "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field. 548 "dimensionName": "A String", # The name of the dimension. 549 "etag": "A String", # The eTag of this response for caching purposes. 550 "id": "A String", # The ID associated with the value if available. 551 "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue. 552 "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. 553 "value": "A String", # The value of the dimension. 554 }, 555 "archived": True or False, # Whether this placement is archived. 556 "campaignId": "A String", # Campaign ID of this placement. This field is a required field on insertion. 557 "campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field. 558 "dimensionName": "A String", # The name of the dimension. 559 "etag": "A String", # The eTag of this response for caching purposes. 560 "id": "A String", # The ID associated with the value if available. 561 "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue. 562 "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. 563 "value": "A String", # The value of the dimension. 564 }, 565 "comment": "A String", # Comments for this placement. 566 "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. 567 "contentCategoryId": "A String", # ID of the content category assigned to this placement. 568 "createInfo": { # Modification timestamp. # Information about the creation of this placement. This is a read-only field. 569 "time": "A String", # Timestamp of the last change in milliseconds since epoch. 570 }, 571 "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. 572 "directorySiteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field. 573 "dimensionName": "A String", # The name of the dimension. 574 "etag": "A String", # The eTag of this response for caching purposes. 575 "id": "A String", # The ID associated with the value if available. 576 "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue. 577 "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. 578 "value": "A String", # The value of the dimension. 579 }, 580 "externalId": "A String", # External ID for this placement. 581 "id": "A String", # ID of this placement. This is a read-only, auto-generated field. 582 "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this placement. This is a read-only, auto-generated field. 583 "dimensionName": "A String", # The name of the dimension. 584 "etag": "A String", # The eTag of this response for caching purposes. 585 "id": "A String", # The ID associated with the value if available. 586 "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue. 587 "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. 588 "value": "A String", # The value of the dimension. 589 }, 590 "keyName": "A String", # Key name of this placement. This is a read-only, auto-generated field. 591 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#placement". 592 "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this placement. This is a read-only field. 593 "time": "A String", # Timestamp of the last change in milliseconds since epoch. 594 }, 595 "lookbackConfiguration": { # Lookback configuration settings. # Lookback window settings for this placement. 596 "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. 597 "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. 598 }, 599 "name": "A String", # Name of this placement.This is a required field and must be less than or equal to 256 characters long. 600 "paymentApproved": True or False, # Whether payment was approved for this placement. This is a read-only field relevant only to publisher-paid placements. 601 "paymentSource": "A String", # Payment source for this placement. This is a required field that is read-only after insertion. 602 "placementGroupId": "A String", # ID of this placement's group, if applicable. 603 "placementGroupIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the placement group. This is a read-only, auto-generated field. 604 "dimensionName": "A String", # The name of the dimension. 605 "etag": "A String", # The eTag of this response for caching purposes. 606 "id": "A String", # The ID associated with the value if available. 607 "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue. 608 "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. 609 "value": "A String", # The value of the dimension. 610 }, 611 "placementStrategyId": "A String", # ID of the placement strategy assigned to this placement. 612 "pricingSchedule": { # Pricing Schedule # Pricing schedule of this placement. This field is required on insertion, specifically subfields startDate, endDate and pricingType. 613 "capCostOption": "A String", # Placement cap cost option. 614 "disregardOverdelivery": True or False, # Whether cap costs are ignored by ad serving. 615 "endDate": "A String", 616 "flighted": True or False, # Whether this placement is flighted. If true, pricing periods will be computed automatically. 617 "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. 618 "pricingPeriods": [ # Pricing periods for this placement. 619 { # Pricing Period 620 "endDate": "A String", 621 "pricingComment": "A String", # Comments for this pricing period. 622 "rateOrCostNanos": "A String", # Rate or cost of this pricing period in nanos (i.e., multipled by 1000000000). Acceptable values are 0 to 1000000000000000000, inclusive. 623 "startDate": "A String", 624 "units": "A String", # Units of this pricing period. Acceptable values are 0 to 10000000000, inclusive. 625 }, 626 ], 627 "pricingType": "A String", # Placement pricing type. This field is required on insertion. 628 "startDate": "A String", 629 "testingStartDate": "A String", 630 }, 631 "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. 632 "publisherUpdateInfo": { # Modification timestamp. # Information about the last publisher update. This is a read-only field. 633 "time": "A String", # Timestamp of the last change in milliseconds since epoch. 634 }, 635 "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. 636 "siteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the site. This is a read-only, auto-generated field. 637 "dimensionName": "A String", # The name of the dimension. 638 "etag": "A String", # The eTag of this response for caching purposes. 639 "id": "A String", # The ID associated with the value if available. 640 "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue. 641 "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. 642 "value": "A String", # The value of the dimension. 643 }, 644 "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. 645 "height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive. 646 "iab": True or False, # IAB standard size. This is a read-only, auto-generated field. 647 "id": "A String", # ID of this size. This is a read-only, auto-generated field. 648 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size". 649 "width": 42, # Width of this size. Acceptable values are 0 to 32767, inclusive. 650 }, 651 "sslRequired": True or False, # Whether creatives assigned to this placement must be SSL-compliant. 652 "status": "A String", # Third-party placement status. 653 "subaccountId": "A String", # Subaccount ID of this placement. This field can be left blank. 654 "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" 655 "A String", 656 ], 657 "tagSetting": { # Tag Settings # Tag settings for this placement. 658 "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. 659 "includeClickThroughUrls": True or False, # Whether static landing page URLs should be included in the tags. This setting applies only to placements. 660 "includeClickTracking": True or False, # Whether click-tracking string should be included in the tags. 661 "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. 662 }, 663 "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. 664 "videoSettings": { # Video Settings # A collection of settings which affect video creatives served through this placement. Applicable to placements with IN_STREAM_VIDEO compatibility. 665 "companionSettings": { # Companion Settings # Settings for the companion creatives of video creatives served to this placement. 666 "companionsDisabled": True or False, # Whether companions are disabled for this placement. 667 "enabledSizes": [ # Allowlist of companion sizes to be served to this placement. Set this list to null or empty to serve all companion sizes. 668 { # Represents the dimensions of ads, placements, creatives, or creative assets. 669 "height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive. 670 "iab": True or False, # IAB standard size. This is a read-only, auto-generated field. 671 "id": "A String", # ID of this size. This is a read-only, auto-generated field. 672 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size". 673 "width": 42, # Width of this size. Acceptable values are 0 to 32767, inclusive. 674 }, 675 ], 676 "imageOnly": True or False, # Whether to serve only static images as companions. 677 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#companionSetting". 678 }, 679 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#videoSettings". 680 "orientation": "A String", # Orientation of a video placement. If this value is set, placement will return assets matching the specified orientation. 681 "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. 682 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#skippableSetting". 683 "progressOffset": { # Video Offset # Amount of time to play videos served to this placement before counting a view. Applicable when skippable is true. 684 "offsetPercentage": 42, # Duration, as a percentage of video duration. Do not set when offsetSeconds is set. Acceptable values are 0 to 100, inclusive. 685 "offsetSeconds": 42, # Duration, in seconds. Do not set when offsetPercentage is set. Acceptable values are 0 to 86399, inclusive. 686 }, 687 "skipOffset": { # Video Offset # Amount of time to play videos served to this placement before the skip button should appear. Applicable when skippable is true. 688 "offsetPercentage": 42, # Duration, as a percentage of video duration. Do not set when offsetSeconds is set. Acceptable values are 0 to 100, inclusive. 689 "offsetSeconds": 42, # Duration, in seconds. Do not set when offsetPercentage is set. Acceptable values are 0 to 86399, inclusive. 690 }, 691 "skippable": True or False, # Whether the user can skip creatives served to this placement. 692 }, 693 "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. 694 "enabledVideoFormats": [ # Allowlist of video formats to be served to this placement. Set this list to null or empty to serve all video formats. 695 42, 696 ], 697 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#transcodeSetting". 698 }, 699 }, 700 "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. *Note:* Flash is no longer supported. This field now defaults to HTML5 when the following values are provided: FLASH, BOTH. 701}</pre> 702</div> 703 704<div class="method"> 705 <code class="details" id="list">list(profileId, advertiserIds=None, archived=None, campaignIds=None, compatibilities=None, contentCategoryIds=None, directorySiteIds=None, groupIds=None, ids=None, maxEndDate=None, maxResults=None, maxStartDate=None, minEndDate=None, minStartDate=None, pageToken=None, paymentSource=None, placementStrategyIds=None, pricingTypes=None, searchString=None, siteIds=None, sizeIds=None, sortField=None, sortOrder=None, x__xgafv=None)</code> 706 <pre>Retrieves a list of placements, possibly filtered. This method supports paging. 707 708Args: 709 profileId: string, User profile ID associated with this request. (required) 710 advertiserIds: string, Select only placements that belong to these advertisers. (repeated) 711 archived: boolean, Select only archived placements. Don't set this field to select both archived and non-archived placements. 712 campaignIds: string, Select only placements that belong to these campaigns. (repeated) 713 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) 714 Allowed values 715 DISPLAY - 716 DISPLAY_INTERSTITIAL - 717 APP - 718 APP_INTERSTITIAL - 719 IN_STREAM_VIDEO - 720 IN_STREAM_AUDIO - 721 contentCategoryIds: string, Select only placements that are associated with these content categories. (repeated) 722 directorySiteIds: string, Select only placements that are associated with these directory sites. (repeated) 723 groupIds: string, Select only placements that belong to these placement groups. (repeated) 724 ids: string, Select only placements with these IDs. (repeated) 725 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". 726 maxResults: integer, Maximum number of results to return. 727 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". 728 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". 729 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". 730 pageToken: string, Value of the nextPageToken from the previous result page. 731 paymentSource: string, Select only placements with this payment source. 732 Allowed values 733 PLACEMENT_AGENCY_PAID - 734 PLACEMENT_PUBLISHER_PAID - 735 placementStrategyIds: string, Select only placements that are associated with these placement strategies. (repeated) 736 pricingTypes: string, Select only placements with these pricing types. (repeated) 737 Allowed values 738 PRICING_TYPE_CPM - 739 PRICING_TYPE_CPC - 740 PRICING_TYPE_CPA - 741 PRICING_TYPE_FLAT_RATE_IMPRESSIONS - 742 PRICING_TYPE_FLAT_RATE_CLICKS - 743 PRICING_TYPE_CPM_ACTIVEVIEW - 744 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" . 745 siteIds: string, Select only placements that are associated with these sites. (repeated) 746 sizeIds: string, Select only placements that are associated with these sizes. (repeated) 747 sortField: string, Field by which to sort the list. 748 Allowed values 749 ID - 750 NAME - 751 sortOrder: string, Order of sorted results. 752 Allowed values 753 ASCENDING - 754 DESCENDING - 755 x__xgafv: string, V1 error format. 756 Allowed values 757 1 - v1 error format 758 2 - v2 error format 759 760Returns: 761 An object of the form: 762 763 { # Placement List Response 764 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#placementsListResponse". 765 "nextPageToken": "A String", # Pagination token to be used for the next list operation. 766 "placements": [ # Placement collection. 767 { # Contains properties of a placement. 768 "accountId": "A String", # Account ID of this placement. This field can be left blank. 769 "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. 770 "additionalSizes": [ # Additional sizes associated with this placement. When inserting or updating a placement, only the size ID field is used. 771 { # Represents the dimensions of ads, placements, creatives, or creative assets. 772 "height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive. 773 "iab": True or False, # IAB standard size. This is a read-only, auto-generated field. 774 "id": "A String", # ID of this size. This is a read-only, auto-generated field. 775 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size". 776 "width": 42, # Width of this size. Acceptable values are 0 to 32767, inclusive. 777 }, 778 ], 779 "advertiserId": "A String", # Advertiser ID of this placement. This field can be left blank. 780 "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field. 781 "dimensionName": "A String", # The name of the dimension. 782 "etag": "A String", # The eTag of this response for caching purposes. 783 "id": "A String", # The ID associated with the value if available. 784 "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue. 785 "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. 786 "value": "A String", # The value of the dimension. 787 }, 788 "archived": True or False, # Whether this placement is archived. 789 "campaignId": "A String", # Campaign ID of this placement. This field is a required field on insertion. 790 "campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field. 791 "dimensionName": "A String", # The name of the dimension. 792 "etag": "A String", # The eTag of this response for caching purposes. 793 "id": "A String", # The ID associated with the value if available. 794 "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue. 795 "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. 796 "value": "A String", # The value of the dimension. 797 }, 798 "comment": "A String", # Comments for this placement. 799 "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. 800 "contentCategoryId": "A String", # ID of the content category assigned to this placement. 801 "createInfo": { # Modification timestamp. # Information about the creation of this placement. This is a read-only field. 802 "time": "A String", # Timestamp of the last change in milliseconds since epoch. 803 }, 804 "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. 805 "directorySiteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field. 806 "dimensionName": "A String", # The name of the dimension. 807 "etag": "A String", # The eTag of this response for caching purposes. 808 "id": "A String", # The ID associated with the value if available. 809 "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue. 810 "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. 811 "value": "A String", # The value of the dimension. 812 }, 813 "externalId": "A String", # External ID for this placement. 814 "id": "A String", # ID of this placement. This is a read-only, auto-generated field. 815 "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this placement. This is a read-only, auto-generated field. 816 "dimensionName": "A String", # The name of the dimension. 817 "etag": "A String", # The eTag of this response for caching purposes. 818 "id": "A String", # The ID associated with the value if available. 819 "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue. 820 "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. 821 "value": "A String", # The value of the dimension. 822 }, 823 "keyName": "A String", # Key name of this placement. This is a read-only, auto-generated field. 824 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#placement". 825 "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this placement. This is a read-only field. 826 "time": "A String", # Timestamp of the last change in milliseconds since epoch. 827 }, 828 "lookbackConfiguration": { # Lookback configuration settings. # Lookback window settings for this placement. 829 "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. 830 "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. 831 }, 832 "name": "A String", # Name of this placement.This is a required field and must be less than or equal to 256 characters long. 833 "paymentApproved": True or False, # Whether payment was approved for this placement. This is a read-only field relevant only to publisher-paid placements. 834 "paymentSource": "A String", # Payment source for this placement. This is a required field that is read-only after insertion. 835 "placementGroupId": "A String", # ID of this placement's group, if applicable. 836 "placementGroupIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the placement group. This is a read-only, auto-generated field. 837 "dimensionName": "A String", # The name of the dimension. 838 "etag": "A String", # The eTag of this response for caching purposes. 839 "id": "A String", # The ID associated with the value if available. 840 "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue. 841 "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. 842 "value": "A String", # The value of the dimension. 843 }, 844 "placementStrategyId": "A String", # ID of the placement strategy assigned to this placement. 845 "pricingSchedule": { # Pricing Schedule # Pricing schedule of this placement. This field is required on insertion, specifically subfields startDate, endDate and pricingType. 846 "capCostOption": "A String", # Placement cap cost option. 847 "disregardOverdelivery": True or False, # Whether cap costs are ignored by ad serving. 848 "endDate": "A String", 849 "flighted": True or False, # Whether this placement is flighted. If true, pricing periods will be computed automatically. 850 "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. 851 "pricingPeriods": [ # Pricing periods for this placement. 852 { # Pricing Period 853 "endDate": "A String", 854 "pricingComment": "A String", # Comments for this pricing period. 855 "rateOrCostNanos": "A String", # Rate or cost of this pricing period in nanos (i.e., multipled by 1000000000). Acceptable values are 0 to 1000000000000000000, inclusive. 856 "startDate": "A String", 857 "units": "A String", # Units of this pricing period. Acceptable values are 0 to 10000000000, inclusive. 858 }, 859 ], 860 "pricingType": "A String", # Placement pricing type. This field is required on insertion. 861 "startDate": "A String", 862 "testingStartDate": "A String", 863 }, 864 "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. 865 "publisherUpdateInfo": { # Modification timestamp. # Information about the last publisher update. This is a read-only field. 866 "time": "A String", # Timestamp of the last change in milliseconds since epoch. 867 }, 868 "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. 869 "siteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the site. This is a read-only, auto-generated field. 870 "dimensionName": "A String", # The name of the dimension. 871 "etag": "A String", # The eTag of this response for caching purposes. 872 "id": "A String", # The ID associated with the value if available. 873 "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue. 874 "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. 875 "value": "A String", # The value of the dimension. 876 }, 877 "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. 878 "height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive. 879 "iab": True or False, # IAB standard size. This is a read-only, auto-generated field. 880 "id": "A String", # ID of this size. This is a read-only, auto-generated field. 881 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size". 882 "width": 42, # Width of this size. Acceptable values are 0 to 32767, inclusive. 883 }, 884 "sslRequired": True or False, # Whether creatives assigned to this placement must be SSL-compliant. 885 "status": "A String", # Third-party placement status. 886 "subaccountId": "A String", # Subaccount ID of this placement. This field can be left blank. 887 "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" 888 "A String", 889 ], 890 "tagSetting": { # Tag Settings # Tag settings for this placement. 891 "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. 892 "includeClickThroughUrls": True or False, # Whether static landing page URLs should be included in the tags. This setting applies only to placements. 893 "includeClickTracking": True or False, # Whether click-tracking string should be included in the tags. 894 "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. 895 }, 896 "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. 897 "videoSettings": { # Video Settings # A collection of settings which affect video creatives served through this placement. Applicable to placements with IN_STREAM_VIDEO compatibility. 898 "companionSettings": { # Companion Settings # Settings for the companion creatives of video creatives served to this placement. 899 "companionsDisabled": True or False, # Whether companions are disabled for this placement. 900 "enabledSizes": [ # Allowlist of companion sizes to be served to this placement. Set this list to null or empty to serve all companion sizes. 901 { # Represents the dimensions of ads, placements, creatives, or creative assets. 902 "height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive. 903 "iab": True or False, # IAB standard size. This is a read-only, auto-generated field. 904 "id": "A String", # ID of this size. This is a read-only, auto-generated field. 905 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size". 906 "width": 42, # Width of this size. Acceptable values are 0 to 32767, inclusive. 907 }, 908 ], 909 "imageOnly": True or False, # Whether to serve only static images as companions. 910 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#companionSetting". 911 }, 912 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#videoSettings". 913 "orientation": "A String", # Orientation of a video placement. If this value is set, placement will return assets matching the specified orientation. 914 "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. 915 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#skippableSetting". 916 "progressOffset": { # Video Offset # Amount of time to play videos served to this placement before counting a view. Applicable when skippable is true. 917 "offsetPercentage": 42, # Duration, as a percentage of video duration. Do not set when offsetSeconds is set. Acceptable values are 0 to 100, inclusive. 918 "offsetSeconds": 42, # Duration, in seconds. Do not set when offsetPercentage is set. Acceptable values are 0 to 86399, inclusive. 919 }, 920 "skipOffset": { # Video Offset # Amount of time to play videos served to this placement before the skip button should appear. Applicable when skippable is true. 921 "offsetPercentage": 42, # Duration, as a percentage of video duration. Do not set when offsetSeconds is set. Acceptable values are 0 to 100, inclusive. 922 "offsetSeconds": 42, # Duration, in seconds. Do not set when offsetPercentage is set. Acceptable values are 0 to 86399, inclusive. 923 }, 924 "skippable": True or False, # Whether the user can skip creatives served to this placement. 925 }, 926 "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. 927 "enabledVideoFormats": [ # Allowlist of video formats to be served to this placement. Set this list to null or empty to serve all video formats. 928 42, 929 ], 930 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#transcodeSetting". 931 }, 932 }, 933 "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. *Note:* Flash is no longer supported. This field now defaults to HTML5 when the following values are provided: FLASH, BOTH. 934 }, 935 ], 936}</pre> 937</div> 938 939<div class="method"> 940 <code class="details" id="list_next">list_next(previous_request, previous_response)</code> 941 <pre>Retrieves the next page of results. 942 943Args: 944 previous_request: The request for the previous page. (required) 945 previous_response: The response from the request for the previous page. (required) 946 947Returns: 948 A request object that you can call 'execute()' on to request the next 949 page. Returns None if there are no more items in the collection. 950 </pre> 951</div> 952 953<div class="method"> 954 <code class="details" id="patch">patch(profileId, id, body=None, x__xgafv=None)</code> 955 <pre>Updates an existing placement. This method supports patch semantics. 956 957Args: 958 profileId: string, User profile ID associated with this request. (required) 959 id: string, Placement ID. (required) 960 body: object, The request body. 961 The object takes the form of: 962 963{ # Contains properties of a placement. 964 "accountId": "A String", # Account ID of this placement. This field can be left blank. 965 "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. 966 "additionalSizes": [ # Additional sizes associated with this placement. When inserting or updating a placement, only the size ID field is used. 967 { # Represents the dimensions of ads, placements, creatives, or creative assets. 968 "height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive. 969 "iab": True or False, # IAB standard size. This is a read-only, auto-generated field. 970 "id": "A String", # ID of this size. This is a read-only, auto-generated field. 971 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size". 972 "width": 42, # Width of this size. Acceptable values are 0 to 32767, inclusive. 973 }, 974 ], 975 "advertiserId": "A String", # Advertiser ID of this placement. This field can be left blank. 976 "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field. 977 "dimensionName": "A String", # The name of the dimension. 978 "etag": "A String", # The eTag of this response for caching purposes. 979 "id": "A String", # The ID associated with the value if available. 980 "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue. 981 "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. 982 "value": "A String", # The value of the dimension. 983 }, 984 "archived": True or False, # Whether this placement is archived. 985 "campaignId": "A String", # Campaign ID of this placement. This field is a required field on insertion. 986 "campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field. 987 "dimensionName": "A String", # The name of the dimension. 988 "etag": "A String", # The eTag of this response for caching purposes. 989 "id": "A String", # The ID associated with the value if available. 990 "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue. 991 "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. 992 "value": "A String", # The value of the dimension. 993 }, 994 "comment": "A String", # Comments for this placement. 995 "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. 996 "contentCategoryId": "A String", # ID of the content category assigned to this placement. 997 "createInfo": { # Modification timestamp. # Information about the creation of this placement. This is a read-only field. 998 "time": "A String", # Timestamp of the last change in milliseconds since epoch. 999 }, 1000 "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. 1001 "directorySiteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field. 1002 "dimensionName": "A String", # The name of the dimension. 1003 "etag": "A String", # The eTag of this response for caching purposes. 1004 "id": "A String", # The ID associated with the value if available. 1005 "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue. 1006 "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. 1007 "value": "A String", # The value of the dimension. 1008 }, 1009 "externalId": "A String", # External ID for this placement. 1010 "id": "A String", # ID of this placement. This is a read-only, auto-generated field. 1011 "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this placement. This is a read-only, auto-generated field. 1012 "dimensionName": "A String", # The name of the dimension. 1013 "etag": "A String", # The eTag of this response for caching purposes. 1014 "id": "A String", # The ID associated with the value if available. 1015 "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue. 1016 "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. 1017 "value": "A String", # The value of the dimension. 1018 }, 1019 "keyName": "A String", # Key name of this placement. This is a read-only, auto-generated field. 1020 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#placement". 1021 "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this placement. This is a read-only field. 1022 "time": "A String", # Timestamp of the last change in milliseconds since epoch. 1023 }, 1024 "lookbackConfiguration": { # Lookback configuration settings. # Lookback window settings for this placement. 1025 "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. 1026 "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. 1027 }, 1028 "name": "A String", # Name of this placement.This is a required field and must be less than or equal to 256 characters long. 1029 "paymentApproved": True or False, # Whether payment was approved for this placement. This is a read-only field relevant only to publisher-paid placements. 1030 "paymentSource": "A String", # Payment source for this placement. This is a required field that is read-only after insertion. 1031 "placementGroupId": "A String", # ID of this placement's group, if applicable. 1032 "placementGroupIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the placement group. This is a read-only, auto-generated field. 1033 "dimensionName": "A String", # The name of the dimension. 1034 "etag": "A String", # The eTag of this response for caching purposes. 1035 "id": "A String", # The ID associated with the value if available. 1036 "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue. 1037 "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. 1038 "value": "A String", # The value of the dimension. 1039 }, 1040 "placementStrategyId": "A String", # ID of the placement strategy assigned to this placement. 1041 "pricingSchedule": { # Pricing Schedule # Pricing schedule of this placement. This field is required on insertion, specifically subfields startDate, endDate and pricingType. 1042 "capCostOption": "A String", # Placement cap cost option. 1043 "disregardOverdelivery": True or False, # Whether cap costs are ignored by ad serving. 1044 "endDate": "A String", 1045 "flighted": True or False, # Whether this placement is flighted. If true, pricing periods will be computed automatically. 1046 "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. 1047 "pricingPeriods": [ # Pricing periods for this placement. 1048 { # Pricing Period 1049 "endDate": "A String", 1050 "pricingComment": "A String", # Comments for this pricing period. 1051 "rateOrCostNanos": "A String", # Rate or cost of this pricing period in nanos (i.e., multipled by 1000000000). Acceptable values are 0 to 1000000000000000000, inclusive. 1052 "startDate": "A String", 1053 "units": "A String", # Units of this pricing period. Acceptable values are 0 to 10000000000, inclusive. 1054 }, 1055 ], 1056 "pricingType": "A String", # Placement pricing type. This field is required on insertion. 1057 "startDate": "A String", 1058 "testingStartDate": "A String", 1059 }, 1060 "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. 1061 "publisherUpdateInfo": { # Modification timestamp. # Information about the last publisher update. This is a read-only field. 1062 "time": "A String", # Timestamp of the last change in milliseconds since epoch. 1063 }, 1064 "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. 1065 "siteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the site. This is a read-only, auto-generated field. 1066 "dimensionName": "A String", # The name of the dimension. 1067 "etag": "A String", # The eTag of this response for caching purposes. 1068 "id": "A String", # The ID associated with the value if available. 1069 "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue. 1070 "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. 1071 "value": "A String", # The value of the dimension. 1072 }, 1073 "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. 1074 "height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive. 1075 "iab": True or False, # IAB standard size. This is a read-only, auto-generated field. 1076 "id": "A String", # ID of this size. This is a read-only, auto-generated field. 1077 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size". 1078 "width": 42, # Width of this size. Acceptable values are 0 to 32767, inclusive. 1079 }, 1080 "sslRequired": True or False, # Whether creatives assigned to this placement must be SSL-compliant. 1081 "status": "A String", # Third-party placement status. 1082 "subaccountId": "A String", # Subaccount ID of this placement. This field can be left blank. 1083 "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" 1084 "A String", 1085 ], 1086 "tagSetting": { # Tag Settings # Tag settings for this placement. 1087 "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. 1088 "includeClickThroughUrls": True or False, # Whether static landing page URLs should be included in the tags. This setting applies only to placements. 1089 "includeClickTracking": True or False, # Whether click-tracking string should be included in the tags. 1090 "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. 1091 }, 1092 "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. 1093 "videoSettings": { # Video Settings # A collection of settings which affect video creatives served through this placement. Applicable to placements with IN_STREAM_VIDEO compatibility. 1094 "companionSettings": { # Companion Settings # Settings for the companion creatives of video creatives served to this placement. 1095 "companionsDisabled": True or False, # Whether companions are disabled for this placement. 1096 "enabledSizes": [ # Allowlist of companion sizes to be served to this placement. Set this list to null or empty to serve all companion sizes. 1097 { # Represents the dimensions of ads, placements, creatives, or creative assets. 1098 "height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive. 1099 "iab": True or False, # IAB standard size. This is a read-only, auto-generated field. 1100 "id": "A String", # ID of this size. This is a read-only, auto-generated field. 1101 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size". 1102 "width": 42, # Width of this size. Acceptable values are 0 to 32767, inclusive. 1103 }, 1104 ], 1105 "imageOnly": True or False, # Whether to serve only static images as companions. 1106 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#companionSetting". 1107 }, 1108 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#videoSettings". 1109 "orientation": "A String", # Orientation of a video placement. If this value is set, placement will return assets matching the specified orientation. 1110 "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. 1111 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#skippableSetting". 1112 "progressOffset": { # Video Offset # Amount of time to play videos served to this placement before counting a view. Applicable when skippable is true. 1113 "offsetPercentage": 42, # Duration, as a percentage of video duration. Do not set when offsetSeconds is set. Acceptable values are 0 to 100, inclusive. 1114 "offsetSeconds": 42, # Duration, in seconds. Do not set when offsetPercentage is set. Acceptable values are 0 to 86399, inclusive. 1115 }, 1116 "skipOffset": { # Video Offset # Amount of time to play videos served to this placement before the skip button should appear. Applicable when skippable is true. 1117 "offsetPercentage": 42, # Duration, as a percentage of video duration. Do not set when offsetSeconds is set. Acceptable values are 0 to 100, inclusive. 1118 "offsetSeconds": 42, # Duration, in seconds. Do not set when offsetPercentage is set. Acceptable values are 0 to 86399, inclusive. 1119 }, 1120 "skippable": True or False, # Whether the user can skip creatives served to this placement. 1121 }, 1122 "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. 1123 "enabledVideoFormats": [ # Allowlist of video formats to be served to this placement. Set this list to null or empty to serve all video formats. 1124 42, 1125 ], 1126 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#transcodeSetting". 1127 }, 1128 }, 1129 "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. *Note:* Flash is no longer supported. This field now defaults to HTML5 when the following values are provided: FLASH, BOTH. 1130} 1131 1132 x__xgafv: string, V1 error format. 1133 Allowed values 1134 1 - v1 error format 1135 2 - v2 error format 1136 1137Returns: 1138 An object of the form: 1139 1140 { # Contains properties of a placement. 1141 "accountId": "A String", # Account ID of this placement. This field can be left blank. 1142 "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. 1143 "additionalSizes": [ # Additional sizes associated with this placement. When inserting or updating a placement, only the size ID field is used. 1144 { # Represents the dimensions of ads, placements, creatives, or creative assets. 1145 "height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive. 1146 "iab": True or False, # IAB standard size. This is a read-only, auto-generated field. 1147 "id": "A String", # ID of this size. This is a read-only, auto-generated field. 1148 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size". 1149 "width": 42, # Width of this size. Acceptable values are 0 to 32767, inclusive. 1150 }, 1151 ], 1152 "advertiserId": "A String", # Advertiser ID of this placement. This field can be left blank. 1153 "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field. 1154 "dimensionName": "A String", # The name of the dimension. 1155 "etag": "A String", # The eTag of this response for caching purposes. 1156 "id": "A String", # The ID associated with the value if available. 1157 "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue. 1158 "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. 1159 "value": "A String", # The value of the dimension. 1160 }, 1161 "archived": True or False, # Whether this placement is archived. 1162 "campaignId": "A String", # Campaign ID of this placement. This field is a required field on insertion. 1163 "campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field. 1164 "dimensionName": "A String", # The name of the dimension. 1165 "etag": "A String", # The eTag of this response for caching purposes. 1166 "id": "A String", # The ID associated with the value if available. 1167 "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue. 1168 "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. 1169 "value": "A String", # The value of the dimension. 1170 }, 1171 "comment": "A String", # Comments for this placement. 1172 "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. 1173 "contentCategoryId": "A String", # ID of the content category assigned to this placement. 1174 "createInfo": { # Modification timestamp. # Information about the creation of this placement. This is a read-only field. 1175 "time": "A String", # Timestamp of the last change in milliseconds since epoch. 1176 }, 1177 "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. 1178 "directorySiteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field. 1179 "dimensionName": "A String", # The name of the dimension. 1180 "etag": "A String", # The eTag of this response for caching purposes. 1181 "id": "A String", # The ID associated with the value if available. 1182 "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue. 1183 "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. 1184 "value": "A String", # The value of the dimension. 1185 }, 1186 "externalId": "A String", # External ID for this placement. 1187 "id": "A String", # ID of this placement. This is a read-only, auto-generated field. 1188 "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this placement. This is a read-only, auto-generated field. 1189 "dimensionName": "A String", # The name of the dimension. 1190 "etag": "A String", # The eTag of this response for caching purposes. 1191 "id": "A String", # The ID associated with the value if available. 1192 "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue. 1193 "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. 1194 "value": "A String", # The value of the dimension. 1195 }, 1196 "keyName": "A String", # Key name of this placement. This is a read-only, auto-generated field. 1197 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#placement". 1198 "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this placement. This is a read-only field. 1199 "time": "A String", # Timestamp of the last change in milliseconds since epoch. 1200 }, 1201 "lookbackConfiguration": { # Lookback configuration settings. # Lookback window settings for this placement. 1202 "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. 1203 "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. 1204 }, 1205 "name": "A String", # Name of this placement.This is a required field and must be less than or equal to 256 characters long. 1206 "paymentApproved": True or False, # Whether payment was approved for this placement. This is a read-only field relevant only to publisher-paid placements. 1207 "paymentSource": "A String", # Payment source for this placement. This is a required field that is read-only after insertion. 1208 "placementGroupId": "A String", # ID of this placement's group, if applicable. 1209 "placementGroupIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the placement group. This is a read-only, auto-generated field. 1210 "dimensionName": "A String", # The name of the dimension. 1211 "etag": "A String", # The eTag of this response for caching purposes. 1212 "id": "A String", # The ID associated with the value if available. 1213 "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue. 1214 "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. 1215 "value": "A String", # The value of the dimension. 1216 }, 1217 "placementStrategyId": "A String", # ID of the placement strategy assigned to this placement. 1218 "pricingSchedule": { # Pricing Schedule # Pricing schedule of this placement. This field is required on insertion, specifically subfields startDate, endDate and pricingType. 1219 "capCostOption": "A String", # Placement cap cost option. 1220 "disregardOverdelivery": True or False, # Whether cap costs are ignored by ad serving. 1221 "endDate": "A String", 1222 "flighted": True or False, # Whether this placement is flighted. If true, pricing periods will be computed automatically. 1223 "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. 1224 "pricingPeriods": [ # Pricing periods for this placement. 1225 { # Pricing Period 1226 "endDate": "A String", 1227 "pricingComment": "A String", # Comments for this pricing period. 1228 "rateOrCostNanos": "A String", # Rate or cost of this pricing period in nanos (i.e., multipled by 1000000000). Acceptable values are 0 to 1000000000000000000, inclusive. 1229 "startDate": "A String", 1230 "units": "A String", # Units of this pricing period. Acceptable values are 0 to 10000000000, inclusive. 1231 }, 1232 ], 1233 "pricingType": "A String", # Placement pricing type. This field is required on insertion. 1234 "startDate": "A String", 1235 "testingStartDate": "A String", 1236 }, 1237 "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. 1238 "publisherUpdateInfo": { # Modification timestamp. # Information about the last publisher update. This is a read-only field. 1239 "time": "A String", # Timestamp of the last change in milliseconds since epoch. 1240 }, 1241 "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. 1242 "siteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the site. This is a read-only, auto-generated field. 1243 "dimensionName": "A String", # The name of the dimension. 1244 "etag": "A String", # The eTag of this response for caching purposes. 1245 "id": "A String", # The ID associated with the value if available. 1246 "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue. 1247 "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. 1248 "value": "A String", # The value of the dimension. 1249 }, 1250 "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. 1251 "height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive. 1252 "iab": True or False, # IAB standard size. This is a read-only, auto-generated field. 1253 "id": "A String", # ID of this size. This is a read-only, auto-generated field. 1254 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size". 1255 "width": 42, # Width of this size. Acceptable values are 0 to 32767, inclusive. 1256 }, 1257 "sslRequired": True or False, # Whether creatives assigned to this placement must be SSL-compliant. 1258 "status": "A String", # Third-party placement status. 1259 "subaccountId": "A String", # Subaccount ID of this placement. This field can be left blank. 1260 "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" 1261 "A String", 1262 ], 1263 "tagSetting": { # Tag Settings # Tag settings for this placement. 1264 "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. 1265 "includeClickThroughUrls": True or False, # Whether static landing page URLs should be included in the tags. This setting applies only to placements. 1266 "includeClickTracking": True or False, # Whether click-tracking string should be included in the tags. 1267 "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. 1268 }, 1269 "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. 1270 "videoSettings": { # Video Settings # A collection of settings which affect video creatives served through this placement. Applicable to placements with IN_STREAM_VIDEO compatibility. 1271 "companionSettings": { # Companion Settings # Settings for the companion creatives of video creatives served to this placement. 1272 "companionsDisabled": True or False, # Whether companions are disabled for this placement. 1273 "enabledSizes": [ # Allowlist of companion sizes to be served to this placement. Set this list to null or empty to serve all companion sizes. 1274 { # Represents the dimensions of ads, placements, creatives, or creative assets. 1275 "height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive. 1276 "iab": True or False, # IAB standard size. This is a read-only, auto-generated field. 1277 "id": "A String", # ID of this size. This is a read-only, auto-generated field. 1278 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size". 1279 "width": 42, # Width of this size. Acceptable values are 0 to 32767, inclusive. 1280 }, 1281 ], 1282 "imageOnly": True or False, # Whether to serve only static images as companions. 1283 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#companionSetting". 1284 }, 1285 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#videoSettings". 1286 "orientation": "A String", # Orientation of a video placement. If this value is set, placement will return assets matching the specified orientation. 1287 "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. 1288 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#skippableSetting". 1289 "progressOffset": { # Video Offset # Amount of time to play videos served to this placement before counting a view. Applicable when skippable is true. 1290 "offsetPercentage": 42, # Duration, as a percentage of video duration. Do not set when offsetSeconds is set. Acceptable values are 0 to 100, inclusive. 1291 "offsetSeconds": 42, # Duration, in seconds. Do not set when offsetPercentage is set. Acceptable values are 0 to 86399, inclusive. 1292 }, 1293 "skipOffset": { # Video Offset # Amount of time to play videos served to this placement before the skip button should appear. Applicable when skippable is true. 1294 "offsetPercentage": 42, # Duration, as a percentage of video duration. Do not set when offsetSeconds is set. Acceptable values are 0 to 100, inclusive. 1295 "offsetSeconds": 42, # Duration, in seconds. Do not set when offsetPercentage is set. Acceptable values are 0 to 86399, inclusive. 1296 }, 1297 "skippable": True or False, # Whether the user can skip creatives served to this placement. 1298 }, 1299 "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. 1300 "enabledVideoFormats": [ # Allowlist of video formats to be served to this placement. Set this list to null or empty to serve all video formats. 1301 42, 1302 ], 1303 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#transcodeSetting". 1304 }, 1305 }, 1306 "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. *Note:* Flash is no longer supported. This field now defaults to HTML5 when the following values are provided: FLASH, BOTH. 1307}</pre> 1308</div> 1309 1310<div class="method"> 1311 <code class="details" id="update">update(profileId, body=None, x__xgafv=None)</code> 1312 <pre>Updates an existing placement. 1313 1314Args: 1315 profileId: string, User profile ID associated with this request. (required) 1316 body: object, The request body. 1317 The object takes the form of: 1318 1319{ # Contains properties of a placement. 1320 "accountId": "A String", # Account ID of this placement. This field can be left blank. 1321 "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. 1322 "additionalSizes": [ # Additional sizes associated with this placement. When inserting or updating a placement, only the size ID field is used. 1323 { # Represents the dimensions of ads, placements, creatives, or creative assets. 1324 "height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive. 1325 "iab": True or False, # IAB standard size. This is a read-only, auto-generated field. 1326 "id": "A String", # ID of this size. This is a read-only, auto-generated field. 1327 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size". 1328 "width": 42, # Width of this size. Acceptable values are 0 to 32767, inclusive. 1329 }, 1330 ], 1331 "advertiserId": "A String", # Advertiser ID of this placement. This field can be left blank. 1332 "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field. 1333 "dimensionName": "A String", # The name of the dimension. 1334 "etag": "A String", # The eTag of this response for caching purposes. 1335 "id": "A String", # The ID associated with the value if available. 1336 "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue. 1337 "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. 1338 "value": "A String", # The value of the dimension. 1339 }, 1340 "archived": True or False, # Whether this placement is archived. 1341 "campaignId": "A String", # Campaign ID of this placement. This field is a required field on insertion. 1342 "campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field. 1343 "dimensionName": "A String", # The name of the dimension. 1344 "etag": "A String", # The eTag of this response for caching purposes. 1345 "id": "A String", # The ID associated with the value if available. 1346 "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue. 1347 "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. 1348 "value": "A String", # The value of the dimension. 1349 }, 1350 "comment": "A String", # Comments for this placement. 1351 "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. 1352 "contentCategoryId": "A String", # ID of the content category assigned to this placement. 1353 "createInfo": { # Modification timestamp. # Information about the creation of this placement. This is a read-only field. 1354 "time": "A String", # Timestamp of the last change in milliseconds since epoch. 1355 }, 1356 "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. 1357 "directorySiteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field. 1358 "dimensionName": "A String", # The name of the dimension. 1359 "etag": "A String", # The eTag of this response for caching purposes. 1360 "id": "A String", # The ID associated with the value if available. 1361 "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue. 1362 "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. 1363 "value": "A String", # The value of the dimension. 1364 }, 1365 "externalId": "A String", # External ID for this placement. 1366 "id": "A String", # ID of this placement. This is a read-only, auto-generated field. 1367 "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this placement. This is a read-only, auto-generated field. 1368 "dimensionName": "A String", # The name of the dimension. 1369 "etag": "A String", # The eTag of this response for caching purposes. 1370 "id": "A String", # The ID associated with the value if available. 1371 "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue. 1372 "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. 1373 "value": "A String", # The value of the dimension. 1374 }, 1375 "keyName": "A String", # Key name of this placement. This is a read-only, auto-generated field. 1376 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#placement". 1377 "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this placement. This is a read-only field. 1378 "time": "A String", # Timestamp of the last change in milliseconds since epoch. 1379 }, 1380 "lookbackConfiguration": { # Lookback configuration settings. # Lookback window settings for this placement. 1381 "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. 1382 "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. 1383 }, 1384 "name": "A String", # Name of this placement.This is a required field and must be less than or equal to 256 characters long. 1385 "paymentApproved": True or False, # Whether payment was approved for this placement. This is a read-only field relevant only to publisher-paid placements. 1386 "paymentSource": "A String", # Payment source for this placement. This is a required field that is read-only after insertion. 1387 "placementGroupId": "A String", # ID of this placement's group, if applicable. 1388 "placementGroupIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the placement group. This is a read-only, auto-generated field. 1389 "dimensionName": "A String", # The name of the dimension. 1390 "etag": "A String", # The eTag of this response for caching purposes. 1391 "id": "A String", # The ID associated with the value if available. 1392 "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue. 1393 "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. 1394 "value": "A String", # The value of the dimension. 1395 }, 1396 "placementStrategyId": "A String", # ID of the placement strategy assigned to this placement. 1397 "pricingSchedule": { # Pricing Schedule # Pricing schedule of this placement. This field is required on insertion, specifically subfields startDate, endDate and pricingType. 1398 "capCostOption": "A String", # Placement cap cost option. 1399 "disregardOverdelivery": True or False, # Whether cap costs are ignored by ad serving. 1400 "endDate": "A String", 1401 "flighted": True or False, # Whether this placement is flighted. If true, pricing periods will be computed automatically. 1402 "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. 1403 "pricingPeriods": [ # Pricing periods for this placement. 1404 { # Pricing Period 1405 "endDate": "A String", 1406 "pricingComment": "A String", # Comments for this pricing period. 1407 "rateOrCostNanos": "A String", # Rate or cost of this pricing period in nanos (i.e., multipled by 1000000000). Acceptable values are 0 to 1000000000000000000, inclusive. 1408 "startDate": "A String", 1409 "units": "A String", # Units of this pricing period. Acceptable values are 0 to 10000000000, inclusive. 1410 }, 1411 ], 1412 "pricingType": "A String", # Placement pricing type. This field is required on insertion. 1413 "startDate": "A String", 1414 "testingStartDate": "A String", 1415 }, 1416 "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. 1417 "publisherUpdateInfo": { # Modification timestamp. # Information about the last publisher update. This is a read-only field. 1418 "time": "A String", # Timestamp of the last change in milliseconds since epoch. 1419 }, 1420 "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. 1421 "siteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the site. This is a read-only, auto-generated field. 1422 "dimensionName": "A String", # The name of the dimension. 1423 "etag": "A String", # The eTag of this response for caching purposes. 1424 "id": "A String", # The ID associated with the value if available. 1425 "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue. 1426 "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. 1427 "value": "A String", # The value of the dimension. 1428 }, 1429 "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. 1430 "height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive. 1431 "iab": True or False, # IAB standard size. This is a read-only, auto-generated field. 1432 "id": "A String", # ID of this size. This is a read-only, auto-generated field. 1433 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size". 1434 "width": 42, # Width of this size. Acceptable values are 0 to 32767, inclusive. 1435 }, 1436 "sslRequired": True or False, # Whether creatives assigned to this placement must be SSL-compliant. 1437 "status": "A String", # Third-party placement status. 1438 "subaccountId": "A String", # Subaccount ID of this placement. This field can be left blank. 1439 "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" 1440 "A String", 1441 ], 1442 "tagSetting": { # Tag Settings # Tag settings for this placement. 1443 "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. 1444 "includeClickThroughUrls": True or False, # Whether static landing page URLs should be included in the tags. This setting applies only to placements. 1445 "includeClickTracking": True or False, # Whether click-tracking string should be included in the tags. 1446 "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. 1447 }, 1448 "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. 1449 "videoSettings": { # Video Settings # A collection of settings which affect video creatives served through this placement. Applicable to placements with IN_STREAM_VIDEO compatibility. 1450 "companionSettings": { # Companion Settings # Settings for the companion creatives of video creatives served to this placement. 1451 "companionsDisabled": True or False, # Whether companions are disabled for this placement. 1452 "enabledSizes": [ # Allowlist of companion sizes to be served to this placement. Set this list to null or empty to serve all companion sizes. 1453 { # Represents the dimensions of ads, placements, creatives, or creative assets. 1454 "height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive. 1455 "iab": True or False, # IAB standard size. This is a read-only, auto-generated field. 1456 "id": "A String", # ID of this size. This is a read-only, auto-generated field. 1457 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size". 1458 "width": 42, # Width of this size. Acceptable values are 0 to 32767, inclusive. 1459 }, 1460 ], 1461 "imageOnly": True or False, # Whether to serve only static images as companions. 1462 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#companionSetting". 1463 }, 1464 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#videoSettings". 1465 "orientation": "A String", # Orientation of a video placement. If this value is set, placement will return assets matching the specified orientation. 1466 "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. 1467 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#skippableSetting". 1468 "progressOffset": { # Video Offset # Amount of time to play videos served to this placement before counting a view. Applicable when skippable is true. 1469 "offsetPercentage": 42, # Duration, as a percentage of video duration. Do not set when offsetSeconds is set. Acceptable values are 0 to 100, inclusive. 1470 "offsetSeconds": 42, # Duration, in seconds. Do not set when offsetPercentage is set. Acceptable values are 0 to 86399, inclusive. 1471 }, 1472 "skipOffset": { # Video Offset # Amount of time to play videos served to this placement before the skip button should appear. Applicable when skippable is true. 1473 "offsetPercentage": 42, # Duration, as a percentage of video duration. Do not set when offsetSeconds is set. Acceptable values are 0 to 100, inclusive. 1474 "offsetSeconds": 42, # Duration, in seconds. Do not set when offsetPercentage is set. Acceptable values are 0 to 86399, inclusive. 1475 }, 1476 "skippable": True or False, # Whether the user can skip creatives served to this placement. 1477 }, 1478 "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. 1479 "enabledVideoFormats": [ # Allowlist of video formats to be served to this placement. Set this list to null or empty to serve all video formats. 1480 42, 1481 ], 1482 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#transcodeSetting". 1483 }, 1484 }, 1485 "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. *Note:* Flash is no longer supported. This field now defaults to HTML5 when the following values are provided: FLASH, BOTH. 1486} 1487 1488 x__xgafv: string, V1 error format. 1489 Allowed values 1490 1 - v1 error format 1491 2 - v2 error format 1492 1493Returns: 1494 An object of the form: 1495 1496 { # Contains properties of a placement. 1497 "accountId": "A String", # Account ID of this placement. This field can be left blank. 1498 "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. 1499 "additionalSizes": [ # Additional sizes associated with this placement. When inserting or updating a placement, only the size ID field is used. 1500 { # Represents the dimensions of ads, placements, creatives, or creative assets. 1501 "height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive. 1502 "iab": True or False, # IAB standard size. This is a read-only, auto-generated field. 1503 "id": "A String", # ID of this size. This is a read-only, auto-generated field. 1504 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size". 1505 "width": 42, # Width of this size. Acceptable values are 0 to 32767, inclusive. 1506 }, 1507 ], 1508 "advertiserId": "A String", # Advertiser ID of this placement. This field can be left blank. 1509 "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field. 1510 "dimensionName": "A String", # The name of the dimension. 1511 "etag": "A String", # The eTag of this response for caching purposes. 1512 "id": "A String", # The ID associated with the value if available. 1513 "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue. 1514 "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. 1515 "value": "A String", # The value of the dimension. 1516 }, 1517 "archived": True or False, # Whether this placement is archived. 1518 "campaignId": "A String", # Campaign ID of this placement. This field is a required field on insertion. 1519 "campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field. 1520 "dimensionName": "A String", # The name of the dimension. 1521 "etag": "A String", # The eTag of this response for caching purposes. 1522 "id": "A String", # The ID associated with the value if available. 1523 "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue. 1524 "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. 1525 "value": "A String", # The value of the dimension. 1526 }, 1527 "comment": "A String", # Comments for this placement. 1528 "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. 1529 "contentCategoryId": "A String", # ID of the content category assigned to this placement. 1530 "createInfo": { # Modification timestamp. # Information about the creation of this placement. This is a read-only field. 1531 "time": "A String", # Timestamp of the last change in milliseconds since epoch. 1532 }, 1533 "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. 1534 "directorySiteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field. 1535 "dimensionName": "A String", # The name of the dimension. 1536 "etag": "A String", # The eTag of this response for caching purposes. 1537 "id": "A String", # The ID associated with the value if available. 1538 "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue. 1539 "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. 1540 "value": "A String", # The value of the dimension. 1541 }, 1542 "externalId": "A String", # External ID for this placement. 1543 "id": "A String", # ID of this placement. This is a read-only, auto-generated field. 1544 "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this placement. This is a read-only, auto-generated field. 1545 "dimensionName": "A String", # The name of the dimension. 1546 "etag": "A String", # The eTag of this response for caching purposes. 1547 "id": "A String", # The ID associated with the value if available. 1548 "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue. 1549 "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. 1550 "value": "A String", # The value of the dimension. 1551 }, 1552 "keyName": "A String", # Key name of this placement. This is a read-only, auto-generated field. 1553 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#placement". 1554 "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this placement. This is a read-only field. 1555 "time": "A String", # Timestamp of the last change in milliseconds since epoch. 1556 }, 1557 "lookbackConfiguration": { # Lookback configuration settings. # Lookback window settings for this placement. 1558 "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. 1559 "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. 1560 }, 1561 "name": "A String", # Name of this placement.This is a required field and must be less than or equal to 256 characters long. 1562 "paymentApproved": True or False, # Whether payment was approved for this placement. This is a read-only field relevant only to publisher-paid placements. 1563 "paymentSource": "A String", # Payment source for this placement. This is a required field that is read-only after insertion. 1564 "placementGroupId": "A String", # ID of this placement's group, if applicable. 1565 "placementGroupIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the placement group. This is a read-only, auto-generated field. 1566 "dimensionName": "A String", # The name of the dimension. 1567 "etag": "A String", # The eTag of this response for caching purposes. 1568 "id": "A String", # The ID associated with the value if available. 1569 "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue. 1570 "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. 1571 "value": "A String", # The value of the dimension. 1572 }, 1573 "placementStrategyId": "A String", # ID of the placement strategy assigned to this placement. 1574 "pricingSchedule": { # Pricing Schedule # Pricing schedule of this placement. This field is required on insertion, specifically subfields startDate, endDate and pricingType. 1575 "capCostOption": "A String", # Placement cap cost option. 1576 "disregardOverdelivery": True or False, # Whether cap costs are ignored by ad serving. 1577 "endDate": "A String", 1578 "flighted": True or False, # Whether this placement is flighted. If true, pricing periods will be computed automatically. 1579 "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. 1580 "pricingPeriods": [ # Pricing periods for this placement. 1581 { # Pricing Period 1582 "endDate": "A String", 1583 "pricingComment": "A String", # Comments for this pricing period. 1584 "rateOrCostNanos": "A String", # Rate or cost of this pricing period in nanos (i.e., multipled by 1000000000). Acceptable values are 0 to 1000000000000000000, inclusive. 1585 "startDate": "A String", 1586 "units": "A String", # Units of this pricing period. Acceptable values are 0 to 10000000000, inclusive. 1587 }, 1588 ], 1589 "pricingType": "A String", # Placement pricing type. This field is required on insertion. 1590 "startDate": "A String", 1591 "testingStartDate": "A String", 1592 }, 1593 "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. 1594 "publisherUpdateInfo": { # Modification timestamp. # Information about the last publisher update. This is a read-only field. 1595 "time": "A String", # Timestamp of the last change in milliseconds since epoch. 1596 }, 1597 "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. 1598 "siteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the site. This is a read-only, auto-generated field. 1599 "dimensionName": "A String", # The name of the dimension. 1600 "etag": "A String", # The eTag of this response for caching purposes. 1601 "id": "A String", # The ID associated with the value if available. 1602 "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue. 1603 "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. 1604 "value": "A String", # The value of the dimension. 1605 }, 1606 "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. 1607 "height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive. 1608 "iab": True or False, # IAB standard size. This is a read-only, auto-generated field. 1609 "id": "A String", # ID of this size. This is a read-only, auto-generated field. 1610 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size". 1611 "width": 42, # Width of this size. Acceptable values are 0 to 32767, inclusive. 1612 }, 1613 "sslRequired": True or False, # Whether creatives assigned to this placement must be SSL-compliant. 1614 "status": "A String", # Third-party placement status. 1615 "subaccountId": "A String", # Subaccount ID of this placement. This field can be left blank. 1616 "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" 1617 "A String", 1618 ], 1619 "tagSetting": { # Tag Settings # Tag settings for this placement. 1620 "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. 1621 "includeClickThroughUrls": True or False, # Whether static landing page URLs should be included in the tags. This setting applies only to placements. 1622 "includeClickTracking": True or False, # Whether click-tracking string should be included in the tags. 1623 "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. 1624 }, 1625 "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. 1626 "videoSettings": { # Video Settings # A collection of settings which affect video creatives served through this placement. Applicable to placements with IN_STREAM_VIDEO compatibility. 1627 "companionSettings": { # Companion Settings # Settings for the companion creatives of video creatives served to this placement. 1628 "companionsDisabled": True or False, # Whether companions are disabled for this placement. 1629 "enabledSizes": [ # Allowlist of companion sizes to be served to this placement. Set this list to null or empty to serve all companion sizes. 1630 { # Represents the dimensions of ads, placements, creatives, or creative assets. 1631 "height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive. 1632 "iab": True or False, # IAB standard size. This is a read-only, auto-generated field. 1633 "id": "A String", # ID of this size. This is a read-only, auto-generated field. 1634 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size". 1635 "width": 42, # Width of this size. Acceptable values are 0 to 32767, inclusive. 1636 }, 1637 ], 1638 "imageOnly": True or False, # Whether to serve only static images as companions. 1639 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#companionSetting". 1640 }, 1641 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#videoSettings". 1642 "orientation": "A String", # Orientation of a video placement. If this value is set, placement will return assets matching the specified orientation. 1643 "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. 1644 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#skippableSetting". 1645 "progressOffset": { # Video Offset # Amount of time to play videos served to this placement before counting a view. Applicable when skippable is true. 1646 "offsetPercentage": 42, # Duration, as a percentage of video duration. Do not set when offsetSeconds is set. Acceptable values are 0 to 100, inclusive. 1647 "offsetSeconds": 42, # Duration, in seconds. Do not set when offsetPercentage is set. Acceptable values are 0 to 86399, inclusive. 1648 }, 1649 "skipOffset": { # Video Offset # Amount of time to play videos served to this placement before the skip button should appear. Applicable when skippable is true. 1650 "offsetPercentage": 42, # Duration, as a percentage of video duration. Do not set when offsetSeconds is set. Acceptable values are 0 to 100, inclusive. 1651 "offsetSeconds": 42, # Duration, in seconds. Do not set when offsetPercentage is set. Acceptable values are 0 to 86399, inclusive. 1652 }, 1653 "skippable": True or False, # Whether the user can skip creatives served to this placement. 1654 }, 1655 "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. 1656 "enabledVideoFormats": [ # Allowlist of video formats to be served to this placement. Set this list to null or empty to serve all video formats. 1657 42, 1658 ], 1659 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#transcodeSetting". 1660 }, 1661 }, 1662 "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. *Note:* Flash is no longer supported. This field now defaults to HTML5 when the following values are provided: FLASH, BOTH. 1663}</pre> 1664</div> 1665 1666</body></html>