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_4.html">Campaign Manager 360 API</a> . <a href="dfareporting_v3_4.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 "endDate": "A String", 259 "flighted": True or False, # Whether this placement is flighted. If true, pricing periods will be computed automatically. 260 "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. 261 "pricingPeriods": [ # Pricing periods for this placement. 262 { # Pricing Period 263 "endDate": "A String", 264 "pricingComment": "A String", # Comments for this pricing period. 265 "rateOrCostNanos": "A String", # Rate or cost of this pricing period in nanos (i.e., multipled by 1000000000). Acceptable values are 0 to 1000000000000000000, inclusive. 266 "startDate": "A String", 267 "units": "A String", # Units of this pricing period. Acceptable values are 0 to 10000000000, inclusive. 268 }, 269 ], 270 "pricingType": "A String", # Placement pricing type. This field is required on insertion. 271 "startDate": "A String", 272 "testingStartDate": "A String", 273 }, 274 "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. 275 "publisherUpdateInfo": { # Modification timestamp. # Information about the last publisher update. This is a read-only field. 276 "time": "A String", # Timestamp of the last change in milliseconds since epoch. 277 }, 278 "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. 279 "siteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the site. This is a read-only, auto-generated field. 280 "dimensionName": "A String", # The name of the dimension. 281 "etag": "A String", # The eTag of this response for caching purposes. 282 "id": "A String", # The ID associated with the value if available. 283 "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue. 284 "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. 285 "value": "A String", # The value of the dimension. 286 }, 287 "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. 288 "height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive. 289 "iab": True or False, # IAB standard size. This is a read-only, auto-generated field. 290 "id": "A String", # ID of this size. This is a read-only, auto-generated field. 291 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size". 292 "width": 42, # Width of this size. Acceptable values are 0 to 32767, inclusive. 293 }, 294 "sslRequired": True or False, # Whether creatives assigned to this placement must be SSL-compliant. 295 "status": "A String", # Third-party placement status. 296 "subaccountId": "A String", # Subaccount ID of this placement. This field can be left blank. 297 "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" 298 "A String", 299 ], 300 "tagSetting": { # Tag Settings # Tag settings for this placement. 301 "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. 302 "includeClickThroughUrls": True or False, # Whether static landing page URLs should be included in the tags. This setting applies only to placements. 303 "includeClickTracking": True or False, # Whether click-tracking string should be included in the tags. 304 "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. 305 }, 306 "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. 307 "videoSettings": { # Video Settings # A collection of settings which affect video creatives served through this placement. Applicable to placements with IN_STREAM_VIDEO compatibility. 308 "companionSettings": { # Companion Settings # Settings for the companion creatives of video creatives served to this placement. 309 "companionsDisabled": True or False, # Whether companions are disabled for this placement. 310 "enabledSizes": [ # Allowlist of companion sizes to be served to this placement. Set this list to null or empty to serve all companion sizes. 311 { # Represents the dimensions of ads, placements, creatives, or creative assets. 312 "height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive. 313 "iab": True or False, # IAB standard size. This is a read-only, auto-generated field. 314 "id": "A String", # ID of this size. This is a read-only, auto-generated field. 315 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size". 316 "width": 42, # Width of this size. Acceptable values are 0 to 32767, inclusive. 317 }, 318 ], 319 "imageOnly": True or False, # Whether to serve only static images as companions. 320 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#companionSetting". 321 }, 322 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#videoSettings". 323 "obaEnabled": True or False, # Whether OBA icons are enabled for this placement. 324 "obaSettings": { # Online Behavioral Advertiser icon. # Settings for the OBA icon of video creatives served to this placement. If this object is provided, the creative-level OBA settings will be overridden. 325 "iconClickThroughUrl": "A String", # URL to redirect to when an OBA icon is clicked. 326 "iconClickTrackingUrl": "A String", # URL to track click when an OBA icon is clicked. 327 "iconViewTrackingUrl": "A String", # URL to track view when an OBA icon is clicked. 328 "program": "A String", # Identifies the industry initiative that the icon supports. For example, AdChoices. 329 "resourceUrl": "A String", # OBA icon resource URL. Campaign Manager only supports image and JavaScript icons. Learn more 330 "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # OBA icon size. 331 "height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive. 332 "iab": True or False, # IAB standard size. This is a read-only, auto-generated field. 333 "id": "A String", # ID of this size. This is a read-only, auto-generated field. 334 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size". 335 "width": 42, # Width of this size. Acceptable values are 0 to 32767, inclusive. 336 }, 337 "xPosition": "A String", # OBA icon x coordinate position. Accepted values are left or right. 338 "yPosition": "A String", # OBA icon y coordinate position. Accepted values are top or bottom. 339 }, 340 "orientation": "A String", # Orientation of a video placement. If this value is set, placement will return assets matching the specified orientation. 341 "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. 342 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#skippableSetting". 343 "progressOffset": { # Video Offset # Amount of time to play videos served to this placement before counting a view. Applicable when skippable is true. 344 "offsetPercentage": 42, # Duration, as a percentage of video duration. Do not set when offsetSeconds is set. Acceptable values are 0 to 100, inclusive. 345 "offsetSeconds": 42, # Duration, in seconds. Do not set when offsetPercentage is set. Acceptable values are 0 to 86399, inclusive. 346 }, 347 "skipOffset": { # Video Offset # Amount of time to play videos served to this placement before the skip button should appear. Applicable when skippable is true. 348 "offsetPercentage": 42, # Duration, as a percentage of video duration. Do not set when offsetSeconds is set. Acceptable values are 0 to 100, inclusive. 349 "offsetSeconds": 42, # Duration, in seconds. Do not set when offsetPercentage is set. Acceptable values are 0 to 86399, inclusive. 350 }, 351 "skippable": True or False, # Whether the user can skip creatives served to this placement. 352 }, 353 "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. 354 "enabledVideoFormats": [ # Allowlist of video formats to be served to this placement. Set this list to null or empty to serve all video formats. 355 42, 356 ], 357 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#transcodeSetting". 358 }, 359 }, 360 "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. 361}</pre> 362</div> 363 364<div class="method"> 365 <code class="details" id="insert">insert(profileId, body=None, x__xgafv=None)</code> 366 <pre>Inserts a new placement. 367 368Args: 369 profileId: string, User profile ID associated with this request. (required) 370 body: object, The request body. 371 The object takes the form of: 372 373{ # Contains properties of a placement. 374 "accountId": "A String", # Account ID of this placement. This field can be left blank. 375 "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. 376 "additionalSizes": [ # Additional sizes associated with this placement. When inserting or updating a placement, only the size ID field is used. 377 { # Represents the dimensions of ads, placements, creatives, or creative assets. 378 "height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive. 379 "iab": True or False, # IAB standard size. This is a read-only, auto-generated field. 380 "id": "A String", # ID of this size. This is a read-only, auto-generated field. 381 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size". 382 "width": 42, # Width of this size. Acceptable values are 0 to 32767, inclusive. 383 }, 384 ], 385 "advertiserId": "A String", # Advertiser ID of this placement. This field can be left blank. 386 "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field. 387 "dimensionName": "A String", # The name of the dimension. 388 "etag": "A String", # The eTag of this response for caching purposes. 389 "id": "A String", # The ID associated with the value if available. 390 "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue. 391 "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. 392 "value": "A String", # The value of the dimension. 393 }, 394 "archived": True or False, # Whether this placement is archived. 395 "campaignId": "A String", # Campaign ID of this placement. This field is a required field on insertion. 396 "campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field. 397 "dimensionName": "A String", # The name of the dimension. 398 "etag": "A String", # The eTag of this response for caching purposes. 399 "id": "A String", # The ID associated with the value if available. 400 "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue. 401 "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. 402 "value": "A String", # The value of the dimension. 403 }, 404 "comment": "A String", # Comments for this placement. 405 "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. 406 "contentCategoryId": "A String", # ID of the content category assigned to this placement. 407 "createInfo": { # Modification timestamp. # Information about the creation of this placement. This is a read-only field. 408 "time": "A String", # Timestamp of the last change in milliseconds since epoch. 409 }, 410 "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. 411 "directorySiteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field. 412 "dimensionName": "A String", # The name of the dimension. 413 "etag": "A String", # The eTag of this response for caching purposes. 414 "id": "A String", # The ID associated with the value if available. 415 "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue. 416 "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. 417 "value": "A String", # The value of the dimension. 418 }, 419 "externalId": "A String", # External ID for this placement. 420 "id": "A String", # ID of this placement. This is a read-only, auto-generated field. 421 "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this placement. This is a read-only, auto-generated field. 422 "dimensionName": "A String", # The name of the dimension. 423 "etag": "A String", # The eTag of this response for caching purposes. 424 "id": "A String", # The ID associated with the value if available. 425 "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue. 426 "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. 427 "value": "A String", # The value of the dimension. 428 }, 429 "keyName": "A String", # Key name of this placement. This is a read-only, auto-generated field. 430 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#placement". 431 "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this placement. This is a read-only field. 432 "time": "A String", # Timestamp of the last change in milliseconds since epoch. 433 }, 434 "lookbackConfiguration": { # Lookback configuration settings. # Lookback window settings for this placement. 435 "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. 436 "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. 437 }, 438 "name": "A String", # Name of this placement.This is a required field and must be less than or equal to 256 characters long. 439 "paymentApproved": True or False, # Whether payment was approved for this placement. This is a read-only field relevant only to publisher-paid placements. 440 "paymentSource": "A String", # Payment source for this placement. This is a required field that is read-only after insertion. 441 "placementGroupId": "A String", # ID of this placement's group, if applicable. 442 "placementGroupIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the placement group. This is a read-only, auto-generated field. 443 "dimensionName": "A String", # The name of the dimension. 444 "etag": "A String", # The eTag of this response for caching purposes. 445 "id": "A String", # The ID associated with the value if available. 446 "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue. 447 "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. 448 "value": "A String", # The value of the dimension. 449 }, 450 "placementStrategyId": "A String", # ID of the placement strategy assigned to this placement. 451 "pricingSchedule": { # Pricing Schedule # Pricing schedule of this placement. This field is required on insertion, specifically subfields startDate, endDate and pricingType. 452 "capCostOption": "A String", # Placement cap cost option. 453 "endDate": "A String", 454 "flighted": True or False, # Whether this placement is flighted. If true, pricing periods will be computed automatically. 455 "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. 456 "pricingPeriods": [ # Pricing periods for this placement. 457 { # Pricing Period 458 "endDate": "A String", 459 "pricingComment": "A String", # Comments for this pricing period. 460 "rateOrCostNanos": "A String", # Rate or cost of this pricing period in nanos (i.e., multipled by 1000000000). Acceptable values are 0 to 1000000000000000000, inclusive. 461 "startDate": "A String", 462 "units": "A String", # Units of this pricing period. Acceptable values are 0 to 10000000000, inclusive. 463 }, 464 ], 465 "pricingType": "A String", # Placement pricing type. This field is required on insertion. 466 "startDate": "A String", 467 "testingStartDate": "A String", 468 }, 469 "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. 470 "publisherUpdateInfo": { # Modification timestamp. # Information about the last publisher update. This is a read-only field. 471 "time": "A String", # Timestamp of the last change in milliseconds since epoch. 472 }, 473 "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. 474 "siteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the site. This is a read-only, auto-generated field. 475 "dimensionName": "A String", # The name of the dimension. 476 "etag": "A String", # The eTag of this response for caching purposes. 477 "id": "A String", # The ID associated with the value if available. 478 "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue. 479 "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. 480 "value": "A String", # The value of the dimension. 481 }, 482 "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. 483 "height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive. 484 "iab": True or False, # IAB standard size. This is a read-only, auto-generated field. 485 "id": "A String", # ID of this size. This is a read-only, auto-generated field. 486 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size". 487 "width": 42, # Width of this size. Acceptable values are 0 to 32767, inclusive. 488 }, 489 "sslRequired": True or False, # Whether creatives assigned to this placement must be SSL-compliant. 490 "status": "A String", # Third-party placement status. 491 "subaccountId": "A String", # Subaccount ID of this placement. This field can be left blank. 492 "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" 493 "A String", 494 ], 495 "tagSetting": { # Tag Settings # Tag settings for this placement. 496 "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. 497 "includeClickThroughUrls": True or False, # Whether static landing page URLs should be included in the tags. This setting applies only to placements. 498 "includeClickTracking": True or False, # Whether click-tracking string should be included in the tags. 499 "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. 500 }, 501 "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. 502 "videoSettings": { # Video Settings # A collection of settings which affect video creatives served through this placement. Applicable to placements with IN_STREAM_VIDEO compatibility. 503 "companionSettings": { # Companion Settings # Settings for the companion creatives of video creatives served to this placement. 504 "companionsDisabled": True or False, # Whether companions are disabled for this placement. 505 "enabledSizes": [ # Allowlist of companion sizes to be served to this placement. Set this list to null or empty to serve all companion sizes. 506 { # Represents the dimensions of ads, placements, creatives, or creative assets. 507 "height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive. 508 "iab": True or False, # IAB standard size. This is a read-only, auto-generated field. 509 "id": "A String", # ID of this size. This is a read-only, auto-generated field. 510 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size". 511 "width": 42, # Width of this size. Acceptable values are 0 to 32767, inclusive. 512 }, 513 ], 514 "imageOnly": True or False, # Whether to serve only static images as companions. 515 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#companionSetting". 516 }, 517 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#videoSettings". 518 "obaEnabled": True or False, # Whether OBA icons are enabled for this placement. 519 "obaSettings": { # Online Behavioral Advertiser icon. # Settings for the OBA icon of video creatives served to this placement. If this object is provided, the creative-level OBA settings will be overridden. 520 "iconClickThroughUrl": "A String", # URL to redirect to when an OBA icon is clicked. 521 "iconClickTrackingUrl": "A String", # URL to track click when an OBA icon is clicked. 522 "iconViewTrackingUrl": "A String", # URL to track view when an OBA icon is clicked. 523 "program": "A String", # Identifies the industry initiative that the icon supports. For example, AdChoices. 524 "resourceUrl": "A String", # OBA icon resource URL. Campaign Manager only supports image and JavaScript icons. Learn more 525 "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # OBA icon size. 526 "height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive. 527 "iab": True or False, # IAB standard size. This is a read-only, auto-generated field. 528 "id": "A String", # ID of this size. This is a read-only, auto-generated field. 529 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size". 530 "width": 42, # Width of this size. Acceptable values are 0 to 32767, inclusive. 531 }, 532 "xPosition": "A String", # OBA icon x coordinate position. Accepted values are left or right. 533 "yPosition": "A String", # OBA icon y coordinate position. Accepted values are top or bottom. 534 }, 535 "orientation": "A String", # Orientation of a video placement. If this value is set, placement will return assets matching the specified orientation. 536 "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. 537 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#skippableSetting". 538 "progressOffset": { # Video Offset # Amount of time to play videos served to this placement before counting a view. Applicable when skippable is true. 539 "offsetPercentage": 42, # Duration, as a percentage of video duration. Do not set when offsetSeconds is set. Acceptable values are 0 to 100, inclusive. 540 "offsetSeconds": 42, # Duration, in seconds. Do not set when offsetPercentage is set. Acceptable values are 0 to 86399, inclusive. 541 }, 542 "skipOffset": { # Video Offset # Amount of time to play videos served to this placement before the skip button should appear. Applicable when skippable is true. 543 "offsetPercentage": 42, # Duration, as a percentage of video duration. Do not set when offsetSeconds is set. Acceptable values are 0 to 100, inclusive. 544 "offsetSeconds": 42, # Duration, in seconds. Do not set when offsetPercentage is set. Acceptable values are 0 to 86399, inclusive. 545 }, 546 "skippable": True or False, # Whether the user can skip creatives served to this placement. 547 }, 548 "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. 549 "enabledVideoFormats": [ # Allowlist of video formats to be served to this placement. Set this list to null or empty to serve all video formats. 550 42, 551 ], 552 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#transcodeSetting". 553 }, 554 }, 555 "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. 556} 557 558 x__xgafv: string, V1 error format. 559 Allowed values 560 1 - v1 error format 561 2 - v2 error format 562 563Returns: 564 An object of the form: 565 566 { # Contains properties of a placement. 567 "accountId": "A String", # Account ID of this placement. This field can be left blank. 568 "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. 569 "additionalSizes": [ # Additional sizes associated with this placement. When inserting or updating a placement, only the size ID field is used. 570 { # Represents the dimensions of ads, placements, creatives, or creative assets. 571 "height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive. 572 "iab": True or False, # IAB standard size. This is a read-only, auto-generated field. 573 "id": "A String", # ID of this size. This is a read-only, auto-generated field. 574 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size". 575 "width": 42, # Width of this size. Acceptable values are 0 to 32767, inclusive. 576 }, 577 ], 578 "advertiserId": "A String", # Advertiser ID of this placement. This field can be left blank. 579 "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field. 580 "dimensionName": "A String", # The name of the dimension. 581 "etag": "A String", # The eTag of this response for caching purposes. 582 "id": "A String", # The ID associated with the value if available. 583 "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue. 584 "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. 585 "value": "A String", # The value of the dimension. 586 }, 587 "archived": True or False, # Whether this placement is archived. 588 "campaignId": "A String", # Campaign ID of this placement. This field is a required field on insertion. 589 "campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field. 590 "dimensionName": "A String", # The name of the dimension. 591 "etag": "A String", # The eTag of this response for caching purposes. 592 "id": "A String", # The ID associated with the value if available. 593 "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue. 594 "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. 595 "value": "A String", # The value of the dimension. 596 }, 597 "comment": "A String", # Comments for this placement. 598 "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. 599 "contentCategoryId": "A String", # ID of the content category assigned to this placement. 600 "createInfo": { # Modification timestamp. # Information about the creation of this placement. This is a read-only field. 601 "time": "A String", # Timestamp of the last change in milliseconds since epoch. 602 }, 603 "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. 604 "directorySiteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field. 605 "dimensionName": "A String", # The name of the dimension. 606 "etag": "A String", # The eTag of this response for caching purposes. 607 "id": "A String", # The ID associated with the value if available. 608 "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue. 609 "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. 610 "value": "A String", # The value of the dimension. 611 }, 612 "externalId": "A String", # External ID for this placement. 613 "id": "A String", # ID of this placement. This is a read-only, auto-generated field. 614 "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this placement. This is a read-only, auto-generated field. 615 "dimensionName": "A String", # The name of the dimension. 616 "etag": "A String", # The eTag of this response for caching purposes. 617 "id": "A String", # The ID associated with the value if available. 618 "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue. 619 "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. 620 "value": "A String", # The value of the dimension. 621 }, 622 "keyName": "A String", # Key name of this placement. This is a read-only, auto-generated field. 623 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#placement". 624 "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this placement. This is a read-only field. 625 "time": "A String", # Timestamp of the last change in milliseconds since epoch. 626 }, 627 "lookbackConfiguration": { # Lookback configuration settings. # Lookback window settings for this placement. 628 "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. 629 "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. 630 }, 631 "name": "A String", # Name of this placement.This is a required field and must be less than or equal to 256 characters long. 632 "paymentApproved": True or False, # Whether payment was approved for this placement. This is a read-only field relevant only to publisher-paid placements. 633 "paymentSource": "A String", # Payment source for this placement. This is a required field that is read-only after insertion. 634 "placementGroupId": "A String", # ID of this placement's group, if applicable. 635 "placementGroupIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the placement group. This is a read-only, auto-generated field. 636 "dimensionName": "A String", # The name of the dimension. 637 "etag": "A String", # The eTag of this response for caching purposes. 638 "id": "A String", # The ID associated with the value if available. 639 "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue. 640 "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. 641 "value": "A String", # The value of the dimension. 642 }, 643 "placementStrategyId": "A String", # ID of the placement strategy assigned to this placement. 644 "pricingSchedule": { # Pricing Schedule # Pricing schedule of this placement. This field is required on insertion, specifically subfields startDate, endDate and pricingType. 645 "capCostOption": "A String", # Placement cap cost option. 646 "endDate": "A String", 647 "flighted": True or False, # Whether this placement is flighted. If true, pricing periods will be computed automatically. 648 "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. 649 "pricingPeriods": [ # Pricing periods for this placement. 650 { # Pricing Period 651 "endDate": "A String", 652 "pricingComment": "A String", # Comments for this pricing period. 653 "rateOrCostNanos": "A String", # Rate or cost of this pricing period in nanos (i.e., multipled by 1000000000). Acceptable values are 0 to 1000000000000000000, inclusive. 654 "startDate": "A String", 655 "units": "A String", # Units of this pricing period. Acceptable values are 0 to 10000000000, inclusive. 656 }, 657 ], 658 "pricingType": "A String", # Placement pricing type. This field is required on insertion. 659 "startDate": "A String", 660 "testingStartDate": "A String", 661 }, 662 "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. 663 "publisherUpdateInfo": { # Modification timestamp. # Information about the last publisher update. This is a read-only field. 664 "time": "A String", # Timestamp of the last change in milliseconds since epoch. 665 }, 666 "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. 667 "siteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the site. This is a read-only, auto-generated field. 668 "dimensionName": "A String", # The name of the dimension. 669 "etag": "A String", # The eTag of this response for caching purposes. 670 "id": "A String", # The ID associated with the value if available. 671 "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue. 672 "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. 673 "value": "A String", # The value of the dimension. 674 }, 675 "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. 676 "height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive. 677 "iab": True or False, # IAB standard size. This is a read-only, auto-generated field. 678 "id": "A String", # ID of this size. This is a read-only, auto-generated field. 679 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size". 680 "width": 42, # Width of this size. Acceptable values are 0 to 32767, inclusive. 681 }, 682 "sslRequired": True or False, # Whether creatives assigned to this placement must be SSL-compliant. 683 "status": "A String", # Third-party placement status. 684 "subaccountId": "A String", # Subaccount ID of this placement. This field can be left blank. 685 "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" 686 "A String", 687 ], 688 "tagSetting": { # Tag Settings # Tag settings for this placement. 689 "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. 690 "includeClickThroughUrls": True or False, # Whether static landing page URLs should be included in the tags. This setting applies only to placements. 691 "includeClickTracking": True or False, # Whether click-tracking string should be included in the tags. 692 "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. 693 }, 694 "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. 695 "videoSettings": { # Video Settings # A collection of settings which affect video creatives served through this placement. Applicable to placements with IN_STREAM_VIDEO compatibility. 696 "companionSettings": { # Companion Settings # Settings for the companion creatives of video creatives served to this placement. 697 "companionsDisabled": True or False, # Whether companions are disabled for this placement. 698 "enabledSizes": [ # Allowlist of companion sizes to be served to this placement. Set this list to null or empty to serve all companion sizes. 699 { # Represents the dimensions of ads, placements, creatives, or creative assets. 700 "height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive. 701 "iab": True or False, # IAB standard size. This is a read-only, auto-generated field. 702 "id": "A String", # ID of this size. This is a read-only, auto-generated field. 703 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size". 704 "width": 42, # Width of this size. Acceptable values are 0 to 32767, inclusive. 705 }, 706 ], 707 "imageOnly": True or False, # Whether to serve only static images as companions. 708 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#companionSetting". 709 }, 710 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#videoSettings". 711 "obaEnabled": True or False, # Whether OBA icons are enabled for this placement. 712 "obaSettings": { # Online Behavioral Advertiser icon. # Settings for the OBA icon of video creatives served to this placement. If this object is provided, the creative-level OBA settings will be overridden. 713 "iconClickThroughUrl": "A String", # URL to redirect to when an OBA icon is clicked. 714 "iconClickTrackingUrl": "A String", # URL to track click when an OBA icon is clicked. 715 "iconViewTrackingUrl": "A String", # URL to track view when an OBA icon is clicked. 716 "program": "A String", # Identifies the industry initiative that the icon supports. For example, AdChoices. 717 "resourceUrl": "A String", # OBA icon resource URL. Campaign Manager only supports image and JavaScript icons. Learn more 718 "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # OBA icon size. 719 "height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive. 720 "iab": True or False, # IAB standard size. This is a read-only, auto-generated field. 721 "id": "A String", # ID of this size. This is a read-only, auto-generated field. 722 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size". 723 "width": 42, # Width of this size. Acceptable values are 0 to 32767, inclusive. 724 }, 725 "xPosition": "A String", # OBA icon x coordinate position. Accepted values are left or right. 726 "yPosition": "A String", # OBA icon y coordinate position. Accepted values are top or bottom. 727 }, 728 "orientation": "A String", # Orientation of a video placement. If this value is set, placement will return assets matching the specified orientation. 729 "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. 730 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#skippableSetting". 731 "progressOffset": { # Video Offset # Amount of time to play videos served to this placement before counting a view. Applicable when skippable is true. 732 "offsetPercentage": 42, # Duration, as a percentage of video duration. Do not set when offsetSeconds is set. Acceptable values are 0 to 100, inclusive. 733 "offsetSeconds": 42, # Duration, in seconds. Do not set when offsetPercentage is set. Acceptable values are 0 to 86399, inclusive. 734 }, 735 "skipOffset": { # Video Offset # Amount of time to play videos served to this placement before the skip button should appear. Applicable when skippable is true. 736 "offsetPercentage": 42, # Duration, as a percentage of video duration. Do not set when offsetSeconds is set. Acceptable values are 0 to 100, inclusive. 737 "offsetSeconds": 42, # Duration, in seconds. Do not set when offsetPercentage is set. Acceptable values are 0 to 86399, inclusive. 738 }, 739 "skippable": True or False, # Whether the user can skip creatives served to this placement. 740 }, 741 "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. 742 "enabledVideoFormats": [ # Allowlist of video formats to be served to this placement. Set this list to null or empty to serve all video formats. 743 42, 744 ], 745 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#transcodeSetting". 746 }, 747 }, 748 "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. 749}</pre> 750</div> 751 752<div class="method"> 753 <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> 754 <pre>Retrieves a list of placements, possibly filtered. This method supports paging. 755 756Args: 757 profileId: string, User profile ID associated with this request. (required) 758 advertiserIds: string, Select only placements that belong to these advertisers. (repeated) 759 archived: boolean, Select only archived placements. Don't set this field to select both archived and non-archived placements. 760 campaignIds: string, Select only placements that belong to these campaigns. (repeated) 761 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) 762 Allowed values 763 DISPLAY - 764 DISPLAY_INTERSTITIAL - 765 APP - 766 APP_INTERSTITIAL - 767 IN_STREAM_VIDEO - 768 IN_STREAM_AUDIO - 769 contentCategoryIds: string, Select only placements that are associated with these content categories. (repeated) 770 directorySiteIds: string, Select only placements that are associated with these directory sites. (repeated) 771 groupIds: string, Select only placements that belong to these placement groups. (repeated) 772 ids: string, Select only placements with these IDs. (repeated) 773 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". 774 maxResults: integer, Maximum number of results to return. 775 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". 776 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". 777 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". 778 pageToken: string, Value of the nextPageToken from the previous result page. 779 paymentSource: string, Select only placements with this payment source. 780 Allowed values 781 PLACEMENT_AGENCY_PAID - 782 PLACEMENT_PUBLISHER_PAID - 783 placementStrategyIds: string, Select only placements that are associated with these placement strategies. (repeated) 784 pricingTypes: string, Select only placements with these pricing types. (repeated) 785 Allowed values 786 PRICING_TYPE_CPM - 787 PRICING_TYPE_CPC - 788 PRICING_TYPE_CPA - 789 PRICING_TYPE_FLAT_RATE_IMPRESSIONS - 790 PRICING_TYPE_FLAT_RATE_CLICKS - 791 PRICING_TYPE_CPM_ACTIVEVIEW - 792 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" . 793 siteIds: string, Select only placements that are associated with these sites. (repeated) 794 sizeIds: string, Select only placements that are associated with these sizes. (repeated) 795 sortField: string, Field by which to sort the list. 796 Allowed values 797 ID - 798 NAME - 799 sortOrder: string, Order of sorted results. 800 Allowed values 801 ASCENDING - 802 DESCENDING - 803 x__xgafv: string, V1 error format. 804 Allowed values 805 1 - v1 error format 806 2 - v2 error format 807 808Returns: 809 An object of the form: 810 811 { # Placement List Response 812 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#placementsListResponse". 813 "nextPageToken": "A String", # Pagination token to be used for the next list operation. 814 "placements": [ # Placement collection. 815 { # Contains properties of a placement. 816 "accountId": "A String", # Account ID of this placement. This field can be left blank. 817 "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. 818 "additionalSizes": [ # Additional sizes associated with this placement. When inserting or updating a placement, only the size ID field is used. 819 { # Represents the dimensions of ads, placements, creatives, or creative assets. 820 "height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive. 821 "iab": True or False, # IAB standard size. This is a read-only, auto-generated field. 822 "id": "A String", # ID of this size. This is a read-only, auto-generated field. 823 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size". 824 "width": 42, # Width of this size. Acceptable values are 0 to 32767, inclusive. 825 }, 826 ], 827 "advertiserId": "A String", # Advertiser ID of this placement. This field can be left blank. 828 "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field. 829 "dimensionName": "A String", # The name of the dimension. 830 "etag": "A String", # The eTag of this response for caching purposes. 831 "id": "A String", # The ID associated with the value if available. 832 "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue. 833 "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. 834 "value": "A String", # The value of the dimension. 835 }, 836 "archived": True or False, # Whether this placement is archived. 837 "campaignId": "A String", # Campaign ID of this placement. This field is a required field on insertion. 838 "campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field. 839 "dimensionName": "A String", # The name of the dimension. 840 "etag": "A String", # The eTag of this response for caching purposes. 841 "id": "A String", # The ID associated with the value if available. 842 "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue. 843 "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. 844 "value": "A String", # The value of the dimension. 845 }, 846 "comment": "A String", # Comments for this placement. 847 "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. 848 "contentCategoryId": "A String", # ID of the content category assigned to this placement. 849 "createInfo": { # Modification timestamp. # Information about the creation of this placement. This is a read-only field. 850 "time": "A String", # Timestamp of the last change in milliseconds since epoch. 851 }, 852 "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. 853 "directorySiteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field. 854 "dimensionName": "A String", # The name of the dimension. 855 "etag": "A String", # The eTag of this response for caching purposes. 856 "id": "A String", # The ID associated with the value if available. 857 "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue. 858 "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. 859 "value": "A String", # The value of the dimension. 860 }, 861 "externalId": "A String", # External ID for this placement. 862 "id": "A String", # ID of this placement. This is a read-only, auto-generated field. 863 "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this placement. This is a read-only, auto-generated field. 864 "dimensionName": "A String", # The name of the dimension. 865 "etag": "A String", # The eTag of this response for caching purposes. 866 "id": "A String", # The ID associated with the value if available. 867 "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue. 868 "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. 869 "value": "A String", # The value of the dimension. 870 }, 871 "keyName": "A String", # Key name of this placement. This is a read-only, auto-generated field. 872 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#placement". 873 "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this placement. This is a read-only field. 874 "time": "A String", # Timestamp of the last change in milliseconds since epoch. 875 }, 876 "lookbackConfiguration": { # Lookback configuration settings. # Lookback window settings for this placement. 877 "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. 878 "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. 879 }, 880 "name": "A String", # Name of this placement.This is a required field and must be less than or equal to 256 characters long. 881 "paymentApproved": True or False, # Whether payment was approved for this placement. This is a read-only field relevant only to publisher-paid placements. 882 "paymentSource": "A String", # Payment source for this placement. This is a required field that is read-only after insertion. 883 "placementGroupId": "A String", # ID of this placement's group, if applicable. 884 "placementGroupIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the placement group. This is a read-only, auto-generated field. 885 "dimensionName": "A String", # The name of the dimension. 886 "etag": "A String", # The eTag of this response for caching purposes. 887 "id": "A String", # The ID associated with the value if available. 888 "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue. 889 "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. 890 "value": "A String", # The value of the dimension. 891 }, 892 "placementStrategyId": "A String", # ID of the placement strategy assigned to this placement. 893 "pricingSchedule": { # Pricing Schedule # Pricing schedule of this placement. This field is required on insertion, specifically subfields startDate, endDate and pricingType. 894 "capCostOption": "A String", # Placement cap cost option. 895 "endDate": "A String", 896 "flighted": True or False, # Whether this placement is flighted. If true, pricing periods will be computed automatically. 897 "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. 898 "pricingPeriods": [ # Pricing periods for this placement. 899 { # Pricing Period 900 "endDate": "A String", 901 "pricingComment": "A String", # Comments for this pricing period. 902 "rateOrCostNanos": "A String", # Rate or cost of this pricing period in nanos (i.e., multipled by 1000000000). Acceptable values are 0 to 1000000000000000000, inclusive. 903 "startDate": "A String", 904 "units": "A String", # Units of this pricing period. Acceptable values are 0 to 10000000000, inclusive. 905 }, 906 ], 907 "pricingType": "A String", # Placement pricing type. This field is required on insertion. 908 "startDate": "A String", 909 "testingStartDate": "A String", 910 }, 911 "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. 912 "publisherUpdateInfo": { # Modification timestamp. # Information about the last publisher update. This is a read-only field. 913 "time": "A String", # Timestamp of the last change in milliseconds since epoch. 914 }, 915 "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. 916 "siteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the site. This is a read-only, auto-generated field. 917 "dimensionName": "A String", # The name of the dimension. 918 "etag": "A String", # The eTag of this response for caching purposes. 919 "id": "A String", # The ID associated with the value if available. 920 "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue. 921 "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. 922 "value": "A String", # The value of the dimension. 923 }, 924 "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. 925 "height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive. 926 "iab": True or False, # IAB standard size. This is a read-only, auto-generated field. 927 "id": "A String", # ID of this size. This is a read-only, auto-generated field. 928 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size". 929 "width": 42, # Width of this size. Acceptable values are 0 to 32767, inclusive. 930 }, 931 "sslRequired": True or False, # Whether creatives assigned to this placement must be SSL-compliant. 932 "status": "A String", # Third-party placement status. 933 "subaccountId": "A String", # Subaccount ID of this placement. This field can be left blank. 934 "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" 935 "A String", 936 ], 937 "tagSetting": { # Tag Settings # Tag settings for this placement. 938 "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. 939 "includeClickThroughUrls": True or False, # Whether static landing page URLs should be included in the tags. This setting applies only to placements. 940 "includeClickTracking": True or False, # Whether click-tracking string should be included in the tags. 941 "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. 942 }, 943 "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. 944 "videoSettings": { # Video Settings # A collection of settings which affect video creatives served through this placement. Applicable to placements with IN_STREAM_VIDEO compatibility. 945 "companionSettings": { # Companion Settings # Settings for the companion creatives of video creatives served to this placement. 946 "companionsDisabled": True or False, # Whether companions are disabled for this placement. 947 "enabledSizes": [ # Allowlist of companion sizes to be served to this placement. Set this list to null or empty to serve all companion sizes. 948 { # Represents the dimensions of ads, placements, creatives, or creative assets. 949 "height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive. 950 "iab": True or False, # IAB standard size. This is a read-only, auto-generated field. 951 "id": "A String", # ID of this size. This is a read-only, auto-generated field. 952 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size". 953 "width": 42, # Width of this size. Acceptable values are 0 to 32767, inclusive. 954 }, 955 ], 956 "imageOnly": True or False, # Whether to serve only static images as companions. 957 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#companionSetting". 958 }, 959 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#videoSettings". 960 "obaEnabled": True or False, # Whether OBA icons are enabled for this placement. 961 "obaSettings": { # Online Behavioral Advertiser icon. # Settings for the OBA icon of video creatives served to this placement. If this object is provided, the creative-level OBA settings will be overridden. 962 "iconClickThroughUrl": "A String", # URL to redirect to when an OBA icon is clicked. 963 "iconClickTrackingUrl": "A String", # URL to track click when an OBA icon is clicked. 964 "iconViewTrackingUrl": "A String", # URL to track view when an OBA icon is clicked. 965 "program": "A String", # Identifies the industry initiative that the icon supports. For example, AdChoices. 966 "resourceUrl": "A String", # OBA icon resource URL. Campaign Manager only supports image and JavaScript icons. Learn more 967 "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # OBA icon size. 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 "xPosition": "A String", # OBA icon x coordinate position. Accepted values are left or right. 975 "yPosition": "A String", # OBA icon y coordinate position. Accepted values are top or bottom. 976 }, 977 "orientation": "A String", # Orientation of a video placement. If this value is set, placement will return assets matching the specified orientation. 978 "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. 979 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#skippableSetting". 980 "progressOffset": { # Video Offset # Amount of time to play videos served to this placement before counting a view. Applicable when skippable is true. 981 "offsetPercentage": 42, # Duration, as a percentage of video duration. Do not set when offsetSeconds is set. Acceptable values are 0 to 100, inclusive. 982 "offsetSeconds": 42, # Duration, in seconds. Do not set when offsetPercentage is set. Acceptable values are 0 to 86399, inclusive. 983 }, 984 "skipOffset": { # Video Offset # Amount of time to play videos served to this placement before the skip button should appear. Applicable when skippable is true. 985 "offsetPercentage": 42, # Duration, as a percentage of video duration. Do not set when offsetSeconds is set. Acceptable values are 0 to 100, inclusive. 986 "offsetSeconds": 42, # Duration, in seconds. Do not set when offsetPercentage is set. Acceptable values are 0 to 86399, inclusive. 987 }, 988 "skippable": True or False, # Whether the user can skip creatives served to this placement. 989 }, 990 "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. 991 "enabledVideoFormats": [ # Allowlist of video formats to be served to this placement. Set this list to null or empty to serve all video formats. 992 42, 993 ], 994 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#transcodeSetting". 995 }, 996 }, 997 "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. 998 }, 999 ], 1000}</pre> 1001</div> 1002 1003<div class="method"> 1004 <code class="details" id="list_next">list_next(previous_request, previous_response)</code> 1005 <pre>Retrieves the next page of results. 1006 1007Args: 1008 previous_request: The request for the previous page. (required) 1009 previous_response: The response from the request for the previous page. (required) 1010 1011Returns: 1012 A request object that you can call 'execute()' on to request the next 1013 page. Returns None if there are no more items in the collection. 1014 </pre> 1015</div> 1016 1017<div class="method"> 1018 <code class="details" id="patch">patch(profileId, id, body=None, x__xgafv=None)</code> 1019 <pre>Updates an existing placement. This method supports patch semantics. 1020 1021Args: 1022 profileId: string, User profile ID associated with this request. (required) 1023 id: string, Placement ID. (required) 1024 body: object, The request body. 1025 The object takes the form of: 1026 1027{ # Contains properties of a placement. 1028 "accountId": "A String", # Account ID of this placement. This field can be left blank. 1029 "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. 1030 "additionalSizes": [ # Additional sizes associated with this placement. When inserting or updating a placement, only the size ID field is used. 1031 { # Represents the dimensions of ads, placements, creatives, or creative assets. 1032 "height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive. 1033 "iab": True or False, # IAB standard size. This is a read-only, auto-generated field. 1034 "id": "A String", # ID of this size. This is a read-only, auto-generated field. 1035 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size". 1036 "width": 42, # Width of this size. Acceptable values are 0 to 32767, inclusive. 1037 }, 1038 ], 1039 "advertiserId": "A String", # Advertiser ID of this placement. This field can be left blank. 1040 "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field. 1041 "dimensionName": "A String", # The name of the dimension. 1042 "etag": "A String", # The eTag of this response for caching purposes. 1043 "id": "A String", # The ID associated with the value if available. 1044 "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue. 1045 "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. 1046 "value": "A String", # The value of the dimension. 1047 }, 1048 "archived": True or False, # Whether this placement is archived. 1049 "campaignId": "A String", # Campaign ID of this placement. This field is a required field on insertion. 1050 "campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field. 1051 "dimensionName": "A String", # The name of the dimension. 1052 "etag": "A String", # The eTag of this response for caching purposes. 1053 "id": "A String", # The ID associated with the value if available. 1054 "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue. 1055 "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. 1056 "value": "A String", # The value of the dimension. 1057 }, 1058 "comment": "A String", # Comments for this placement. 1059 "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. 1060 "contentCategoryId": "A String", # ID of the content category assigned to this placement. 1061 "createInfo": { # Modification timestamp. # Information about the creation of this placement. This is a read-only field. 1062 "time": "A String", # Timestamp of the last change in milliseconds since epoch. 1063 }, 1064 "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. 1065 "directorySiteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the directory 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 "externalId": "A String", # External ID for this placement. 1074 "id": "A String", # ID of this placement. This is a read-only, auto-generated field. 1075 "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this placement. This is a read-only, auto-generated field. 1076 "dimensionName": "A String", # The name of the dimension. 1077 "etag": "A String", # The eTag of this response for caching purposes. 1078 "id": "A String", # The ID associated with the value if available. 1079 "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue. 1080 "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. 1081 "value": "A String", # The value of the dimension. 1082 }, 1083 "keyName": "A String", # Key name of this placement. This is a read-only, auto-generated field. 1084 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#placement". 1085 "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this placement. This is a read-only field. 1086 "time": "A String", # Timestamp of the last change in milliseconds since epoch. 1087 }, 1088 "lookbackConfiguration": { # Lookback configuration settings. # Lookback window settings for this placement. 1089 "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. 1090 "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. 1091 }, 1092 "name": "A String", # Name of this placement.This is a required field and must be less than or equal to 256 characters long. 1093 "paymentApproved": True or False, # Whether payment was approved for this placement. This is a read-only field relevant only to publisher-paid placements. 1094 "paymentSource": "A String", # Payment source for this placement. This is a required field that is read-only after insertion. 1095 "placementGroupId": "A String", # ID of this placement's group, if applicable. 1096 "placementGroupIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the placement group. This is a read-only, auto-generated field. 1097 "dimensionName": "A String", # The name of the dimension. 1098 "etag": "A String", # The eTag of this response for caching purposes. 1099 "id": "A String", # The ID associated with the value if available. 1100 "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue. 1101 "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. 1102 "value": "A String", # The value of the dimension. 1103 }, 1104 "placementStrategyId": "A String", # ID of the placement strategy assigned to this placement. 1105 "pricingSchedule": { # Pricing Schedule # Pricing schedule of this placement. This field is required on insertion, specifically subfields startDate, endDate and pricingType. 1106 "capCostOption": "A String", # Placement cap cost option. 1107 "endDate": "A String", 1108 "flighted": True or False, # Whether this placement is flighted. If true, pricing periods will be computed automatically. 1109 "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. 1110 "pricingPeriods": [ # Pricing periods for this placement. 1111 { # Pricing Period 1112 "endDate": "A String", 1113 "pricingComment": "A String", # Comments for this pricing period. 1114 "rateOrCostNanos": "A String", # Rate or cost of this pricing period in nanos (i.e., multipled by 1000000000). Acceptable values are 0 to 1000000000000000000, inclusive. 1115 "startDate": "A String", 1116 "units": "A String", # Units of this pricing period. Acceptable values are 0 to 10000000000, inclusive. 1117 }, 1118 ], 1119 "pricingType": "A String", # Placement pricing type. This field is required on insertion. 1120 "startDate": "A String", 1121 "testingStartDate": "A String", 1122 }, 1123 "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. 1124 "publisherUpdateInfo": { # Modification timestamp. # Information about the last publisher update. This is a read-only field. 1125 "time": "A String", # Timestamp of the last change in milliseconds since epoch. 1126 }, 1127 "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. 1128 "siteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the site. This is a read-only, auto-generated field. 1129 "dimensionName": "A String", # The name of the dimension. 1130 "etag": "A String", # The eTag of this response for caching purposes. 1131 "id": "A String", # The ID associated with the value if available. 1132 "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue. 1133 "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. 1134 "value": "A String", # The value of the dimension. 1135 }, 1136 "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. 1137 "height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive. 1138 "iab": True or False, # IAB standard size. This is a read-only, auto-generated field. 1139 "id": "A String", # ID of this size. This is a read-only, auto-generated field. 1140 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size". 1141 "width": 42, # Width of this size. Acceptable values are 0 to 32767, inclusive. 1142 }, 1143 "sslRequired": True or False, # Whether creatives assigned to this placement must be SSL-compliant. 1144 "status": "A String", # Third-party placement status. 1145 "subaccountId": "A String", # Subaccount ID of this placement. This field can be left blank. 1146 "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" 1147 "A String", 1148 ], 1149 "tagSetting": { # Tag Settings # Tag settings for this placement. 1150 "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. 1151 "includeClickThroughUrls": True or False, # Whether static landing page URLs should be included in the tags. This setting applies only to placements. 1152 "includeClickTracking": True or False, # Whether click-tracking string should be included in the tags. 1153 "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. 1154 }, 1155 "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. 1156 "videoSettings": { # Video Settings # A collection of settings which affect video creatives served through this placement. Applicable to placements with IN_STREAM_VIDEO compatibility. 1157 "companionSettings": { # Companion Settings # Settings for the companion creatives of video creatives served to this placement. 1158 "companionsDisabled": True or False, # Whether companions are disabled for this placement. 1159 "enabledSizes": [ # Allowlist of companion sizes to be served to this placement. Set this list to null or empty to serve all companion sizes. 1160 { # Represents the dimensions of ads, placements, creatives, or creative assets. 1161 "height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive. 1162 "iab": True or False, # IAB standard size. This is a read-only, auto-generated field. 1163 "id": "A String", # ID of this size. This is a read-only, auto-generated field. 1164 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size". 1165 "width": 42, # Width of this size. Acceptable values are 0 to 32767, inclusive. 1166 }, 1167 ], 1168 "imageOnly": True or False, # Whether to serve only static images as companions. 1169 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#companionSetting". 1170 }, 1171 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#videoSettings". 1172 "obaEnabled": True or False, # Whether OBA icons are enabled for this placement. 1173 "obaSettings": { # Online Behavioral Advertiser icon. # Settings for the OBA icon of video creatives served to this placement. If this object is provided, the creative-level OBA settings will be overridden. 1174 "iconClickThroughUrl": "A String", # URL to redirect to when an OBA icon is clicked. 1175 "iconClickTrackingUrl": "A String", # URL to track click when an OBA icon is clicked. 1176 "iconViewTrackingUrl": "A String", # URL to track view when an OBA icon is clicked. 1177 "program": "A String", # Identifies the industry initiative that the icon supports. For example, AdChoices. 1178 "resourceUrl": "A String", # OBA icon resource URL. Campaign Manager only supports image and JavaScript icons. Learn more 1179 "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # OBA icon size. 1180 "height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive. 1181 "iab": True or False, # IAB standard size. This is a read-only, auto-generated field. 1182 "id": "A String", # ID of this size. This is a read-only, auto-generated field. 1183 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size". 1184 "width": 42, # Width of this size. Acceptable values are 0 to 32767, inclusive. 1185 }, 1186 "xPosition": "A String", # OBA icon x coordinate position. Accepted values are left or right. 1187 "yPosition": "A String", # OBA icon y coordinate position. Accepted values are top or bottom. 1188 }, 1189 "orientation": "A String", # Orientation of a video placement. If this value is set, placement will return assets matching the specified orientation. 1190 "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. 1191 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#skippableSetting". 1192 "progressOffset": { # Video Offset # Amount of time to play videos served to this placement before counting a view. Applicable when skippable is true. 1193 "offsetPercentage": 42, # Duration, as a percentage of video duration. Do not set when offsetSeconds is set. Acceptable values are 0 to 100, inclusive. 1194 "offsetSeconds": 42, # Duration, in seconds. Do not set when offsetPercentage is set. Acceptable values are 0 to 86399, inclusive. 1195 }, 1196 "skipOffset": { # Video Offset # Amount of time to play videos served to this placement before the skip button should appear. Applicable when skippable is true. 1197 "offsetPercentage": 42, # Duration, as a percentage of video duration. Do not set when offsetSeconds is set. Acceptable values are 0 to 100, inclusive. 1198 "offsetSeconds": 42, # Duration, in seconds. Do not set when offsetPercentage is set. Acceptable values are 0 to 86399, inclusive. 1199 }, 1200 "skippable": True or False, # Whether the user can skip creatives served to this placement. 1201 }, 1202 "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. 1203 "enabledVideoFormats": [ # Allowlist of video formats to be served to this placement. Set this list to null or empty to serve all video formats. 1204 42, 1205 ], 1206 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#transcodeSetting". 1207 }, 1208 }, 1209 "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. 1210} 1211 1212 x__xgafv: string, V1 error format. 1213 Allowed values 1214 1 - v1 error format 1215 2 - v2 error format 1216 1217Returns: 1218 An object of the form: 1219 1220 { # Contains properties of a placement. 1221 "accountId": "A String", # Account ID of this placement. This field can be left blank. 1222 "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. 1223 "additionalSizes": [ # Additional sizes associated with this placement. When inserting or updating a placement, only the size ID field is used. 1224 { # Represents the dimensions of ads, placements, creatives, or creative assets. 1225 "height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive. 1226 "iab": True or False, # IAB standard size. This is a read-only, auto-generated field. 1227 "id": "A String", # ID of this size. This is a read-only, auto-generated field. 1228 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size". 1229 "width": 42, # Width of this size. Acceptable values are 0 to 32767, inclusive. 1230 }, 1231 ], 1232 "advertiserId": "A String", # Advertiser ID of this placement. This field can be left blank. 1233 "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field. 1234 "dimensionName": "A String", # The name of the dimension. 1235 "etag": "A String", # The eTag of this response for caching purposes. 1236 "id": "A String", # The ID associated with the value if available. 1237 "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue. 1238 "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. 1239 "value": "A String", # The value of the dimension. 1240 }, 1241 "archived": True or False, # Whether this placement is archived. 1242 "campaignId": "A String", # Campaign ID of this placement. This field is a required field on insertion. 1243 "campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field. 1244 "dimensionName": "A String", # The name of the dimension. 1245 "etag": "A String", # The eTag of this response for caching purposes. 1246 "id": "A String", # The ID associated with the value if available. 1247 "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue. 1248 "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. 1249 "value": "A String", # The value of the dimension. 1250 }, 1251 "comment": "A String", # Comments for this placement. 1252 "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. 1253 "contentCategoryId": "A String", # ID of the content category assigned to this placement. 1254 "createInfo": { # Modification timestamp. # Information about the creation of this placement. This is a read-only field. 1255 "time": "A String", # Timestamp of the last change in milliseconds since epoch. 1256 }, 1257 "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. 1258 "directorySiteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field. 1259 "dimensionName": "A String", # The name of the dimension. 1260 "etag": "A String", # The eTag of this response for caching purposes. 1261 "id": "A String", # The ID associated with the value if available. 1262 "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue. 1263 "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. 1264 "value": "A String", # The value of the dimension. 1265 }, 1266 "externalId": "A String", # External ID for this placement. 1267 "id": "A String", # ID of this placement. This is a read-only, auto-generated field. 1268 "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this placement. This is a read-only, auto-generated field. 1269 "dimensionName": "A String", # The name of the dimension. 1270 "etag": "A String", # The eTag of this response for caching purposes. 1271 "id": "A String", # The ID associated with the value if available. 1272 "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue. 1273 "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. 1274 "value": "A String", # The value of the dimension. 1275 }, 1276 "keyName": "A String", # Key name of this placement. This is a read-only, auto-generated field. 1277 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#placement". 1278 "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this placement. This is a read-only field. 1279 "time": "A String", # Timestamp of the last change in milliseconds since epoch. 1280 }, 1281 "lookbackConfiguration": { # Lookback configuration settings. # Lookback window settings for this placement. 1282 "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. 1283 "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. 1284 }, 1285 "name": "A String", # Name of this placement.This is a required field and must be less than or equal to 256 characters long. 1286 "paymentApproved": True or False, # Whether payment was approved for this placement. This is a read-only field relevant only to publisher-paid placements. 1287 "paymentSource": "A String", # Payment source for this placement. This is a required field that is read-only after insertion. 1288 "placementGroupId": "A String", # ID of this placement's group, if applicable. 1289 "placementGroupIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the placement group. This is a read-only, auto-generated field. 1290 "dimensionName": "A String", # The name of the dimension. 1291 "etag": "A String", # The eTag of this response for caching purposes. 1292 "id": "A String", # The ID associated with the value if available. 1293 "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue. 1294 "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. 1295 "value": "A String", # The value of the dimension. 1296 }, 1297 "placementStrategyId": "A String", # ID of the placement strategy assigned to this placement. 1298 "pricingSchedule": { # Pricing Schedule # Pricing schedule of this placement. This field is required on insertion, specifically subfields startDate, endDate and pricingType. 1299 "capCostOption": "A String", # Placement cap cost option. 1300 "endDate": "A String", 1301 "flighted": True or False, # Whether this placement is flighted. If true, pricing periods will be computed automatically. 1302 "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. 1303 "pricingPeriods": [ # Pricing periods for this placement. 1304 { # Pricing Period 1305 "endDate": "A String", 1306 "pricingComment": "A String", # Comments for this pricing period. 1307 "rateOrCostNanos": "A String", # Rate or cost of this pricing period in nanos (i.e., multipled by 1000000000). Acceptable values are 0 to 1000000000000000000, inclusive. 1308 "startDate": "A String", 1309 "units": "A String", # Units of this pricing period. Acceptable values are 0 to 10000000000, inclusive. 1310 }, 1311 ], 1312 "pricingType": "A String", # Placement pricing type. This field is required on insertion. 1313 "startDate": "A String", 1314 "testingStartDate": "A String", 1315 }, 1316 "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. 1317 "publisherUpdateInfo": { # Modification timestamp. # Information about the last publisher update. This is a read-only field. 1318 "time": "A String", # Timestamp of the last change in milliseconds since epoch. 1319 }, 1320 "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. 1321 "siteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the site. This is a read-only, auto-generated field. 1322 "dimensionName": "A String", # The name of the dimension. 1323 "etag": "A String", # The eTag of this response for caching purposes. 1324 "id": "A String", # The ID associated with the value if available. 1325 "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue. 1326 "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. 1327 "value": "A String", # The value of the dimension. 1328 }, 1329 "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. 1330 "height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive. 1331 "iab": True or False, # IAB standard size. This is a read-only, auto-generated field. 1332 "id": "A String", # ID of this size. This is a read-only, auto-generated field. 1333 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size". 1334 "width": 42, # Width of this size. Acceptable values are 0 to 32767, inclusive. 1335 }, 1336 "sslRequired": True or False, # Whether creatives assigned to this placement must be SSL-compliant. 1337 "status": "A String", # Third-party placement status. 1338 "subaccountId": "A String", # Subaccount ID of this placement. This field can be left blank. 1339 "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" 1340 "A String", 1341 ], 1342 "tagSetting": { # Tag Settings # Tag settings for this placement. 1343 "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. 1344 "includeClickThroughUrls": True or False, # Whether static landing page URLs should be included in the tags. This setting applies only to placements. 1345 "includeClickTracking": True or False, # Whether click-tracking string should be included in the tags. 1346 "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. 1347 }, 1348 "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. 1349 "videoSettings": { # Video Settings # A collection of settings which affect video creatives served through this placement. Applicable to placements with IN_STREAM_VIDEO compatibility. 1350 "companionSettings": { # Companion Settings # Settings for the companion creatives of video creatives served to this placement. 1351 "companionsDisabled": True or False, # Whether companions are disabled for this placement. 1352 "enabledSizes": [ # Allowlist of companion sizes to be served to this placement. Set this list to null or empty to serve all companion sizes. 1353 { # Represents the dimensions of ads, placements, creatives, or creative assets. 1354 "height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive. 1355 "iab": True or False, # IAB standard size. This is a read-only, auto-generated field. 1356 "id": "A String", # ID of this size. This is a read-only, auto-generated field. 1357 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size". 1358 "width": 42, # Width of this size. Acceptable values are 0 to 32767, inclusive. 1359 }, 1360 ], 1361 "imageOnly": True or False, # Whether to serve only static images as companions. 1362 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#companionSetting". 1363 }, 1364 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#videoSettings". 1365 "obaEnabled": True or False, # Whether OBA icons are enabled for this placement. 1366 "obaSettings": { # Online Behavioral Advertiser icon. # Settings for the OBA icon of video creatives served to this placement. If this object is provided, the creative-level OBA settings will be overridden. 1367 "iconClickThroughUrl": "A String", # URL to redirect to when an OBA icon is clicked. 1368 "iconClickTrackingUrl": "A String", # URL to track click when an OBA icon is clicked. 1369 "iconViewTrackingUrl": "A String", # URL to track view when an OBA icon is clicked. 1370 "program": "A String", # Identifies the industry initiative that the icon supports. For example, AdChoices. 1371 "resourceUrl": "A String", # OBA icon resource URL. Campaign Manager only supports image and JavaScript icons. Learn more 1372 "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # OBA icon size. 1373 "height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive. 1374 "iab": True or False, # IAB standard size. This is a read-only, auto-generated field. 1375 "id": "A String", # ID of this size. This is a read-only, auto-generated field. 1376 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size". 1377 "width": 42, # Width of this size. Acceptable values are 0 to 32767, inclusive. 1378 }, 1379 "xPosition": "A String", # OBA icon x coordinate position. Accepted values are left or right. 1380 "yPosition": "A String", # OBA icon y coordinate position. Accepted values are top or bottom. 1381 }, 1382 "orientation": "A String", # Orientation of a video placement. If this value is set, placement will return assets matching the specified orientation. 1383 "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. 1384 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#skippableSetting". 1385 "progressOffset": { # Video Offset # Amount of time to play videos served to this placement before counting a view. Applicable when skippable is true. 1386 "offsetPercentage": 42, # Duration, as a percentage of video duration. Do not set when offsetSeconds is set. Acceptable values are 0 to 100, inclusive. 1387 "offsetSeconds": 42, # Duration, in seconds. Do not set when offsetPercentage is set. Acceptable values are 0 to 86399, inclusive. 1388 }, 1389 "skipOffset": { # Video Offset # Amount of time to play videos served to this placement before the skip button should appear. Applicable when skippable is true. 1390 "offsetPercentage": 42, # Duration, as a percentage of video duration. Do not set when offsetSeconds is set. Acceptable values are 0 to 100, inclusive. 1391 "offsetSeconds": 42, # Duration, in seconds. Do not set when offsetPercentage is set. Acceptable values are 0 to 86399, inclusive. 1392 }, 1393 "skippable": True or False, # Whether the user can skip creatives served to this placement. 1394 }, 1395 "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. 1396 "enabledVideoFormats": [ # Allowlist of video formats to be served to this placement. Set this list to null or empty to serve all video formats. 1397 42, 1398 ], 1399 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#transcodeSetting". 1400 }, 1401 }, 1402 "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. 1403}</pre> 1404</div> 1405 1406<div class="method"> 1407 <code class="details" id="update">update(profileId, body=None, x__xgafv=None)</code> 1408 <pre>Updates an existing placement. 1409 1410Args: 1411 profileId: string, User profile ID associated with this request. (required) 1412 body: object, The request body. 1413 The object takes the form of: 1414 1415{ # Contains properties of a placement. 1416 "accountId": "A String", # Account ID of this placement. This field can be left blank. 1417 "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. 1418 "additionalSizes": [ # Additional sizes associated with this placement. When inserting or updating a placement, only the size ID field is used. 1419 { # Represents the dimensions of ads, placements, creatives, or creative assets. 1420 "height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive. 1421 "iab": True or False, # IAB standard size. This is a read-only, auto-generated field. 1422 "id": "A String", # ID of this size. This is a read-only, auto-generated field. 1423 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size". 1424 "width": 42, # Width of this size. Acceptable values are 0 to 32767, inclusive. 1425 }, 1426 ], 1427 "advertiserId": "A String", # Advertiser ID of this placement. This field can be left blank. 1428 "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field. 1429 "dimensionName": "A String", # The name of the dimension. 1430 "etag": "A String", # The eTag of this response for caching purposes. 1431 "id": "A String", # The ID associated with the value if available. 1432 "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue. 1433 "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. 1434 "value": "A String", # The value of the dimension. 1435 }, 1436 "archived": True or False, # Whether this placement is archived. 1437 "campaignId": "A String", # Campaign ID of this placement. This field is a required field on insertion. 1438 "campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field. 1439 "dimensionName": "A String", # The name of the dimension. 1440 "etag": "A String", # The eTag of this response for caching purposes. 1441 "id": "A String", # The ID associated with the value if available. 1442 "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue. 1443 "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. 1444 "value": "A String", # The value of the dimension. 1445 }, 1446 "comment": "A String", # Comments for this placement. 1447 "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. 1448 "contentCategoryId": "A String", # ID of the content category assigned to this placement. 1449 "createInfo": { # Modification timestamp. # Information about the creation of this placement. This is a read-only field. 1450 "time": "A String", # Timestamp of the last change in milliseconds since epoch. 1451 }, 1452 "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. 1453 "directorySiteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field. 1454 "dimensionName": "A String", # The name of the dimension. 1455 "etag": "A String", # The eTag of this response for caching purposes. 1456 "id": "A String", # The ID associated with the value if available. 1457 "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue. 1458 "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. 1459 "value": "A String", # The value of the dimension. 1460 }, 1461 "externalId": "A String", # External ID for this placement. 1462 "id": "A String", # ID of this placement. This is a read-only, auto-generated field. 1463 "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this placement. This is a read-only, auto-generated field. 1464 "dimensionName": "A String", # The name of the dimension. 1465 "etag": "A String", # The eTag of this response for caching purposes. 1466 "id": "A String", # The ID associated with the value if available. 1467 "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue. 1468 "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. 1469 "value": "A String", # The value of the dimension. 1470 }, 1471 "keyName": "A String", # Key name of this placement. This is a read-only, auto-generated field. 1472 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#placement". 1473 "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this placement. This is a read-only field. 1474 "time": "A String", # Timestamp of the last change in milliseconds since epoch. 1475 }, 1476 "lookbackConfiguration": { # Lookback configuration settings. # Lookback window settings for this placement. 1477 "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. 1478 "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. 1479 }, 1480 "name": "A String", # Name of this placement.This is a required field and must be less than or equal to 256 characters long. 1481 "paymentApproved": True or False, # Whether payment was approved for this placement. This is a read-only field relevant only to publisher-paid placements. 1482 "paymentSource": "A String", # Payment source for this placement. This is a required field that is read-only after insertion. 1483 "placementGroupId": "A String", # ID of this placement's group, if applicable. 1484 "placementGroupIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the placement group. This is a read-only, auto-generated field. 1485 "dimensionName": "A String", # The name of the dimension. 1486 "etag": "A String", # The eTag of this response for caching purposes. 1487 "id": "A String", # The ID associated with the value if available. 1488 "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue. 1489 "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. 1490 "value": "A String", # The value of the dimension. 1491 }, 1492 "placementStrategyId": "A String", # ID of the placement strategy assigned to this placement. 1493 "pricingSchedule": { # Pricing Schedule # Pricing schedule of this placement. This field is required on insertion, specifically subfields startDate, endDate and pricingType. 1494 "capCostOption": "A String", # Placement cap cost option. 1495 "endDate": "A String", 1496 "flighted": True or False, # Whether this placement is flighted. If true, pricing periods will be computed automatically. 1497 "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. 1498 "pricingPeriods": [ # Pricing periods for this placement. 1499 { # Pricing Period 1500 "endDate": "A String", 1501 "pricingComment": "A String", # Comments for this pricing period. 1502 "rateOrCostNanos": "A String", # Rate or cost of this pricing period in nanos (i.e., multipled by 1000000000). Acceptable values are 0 to 1000000000000000000, inclusive. 1503 "startDate": "A String", 1504 "units": "A String", # Units of this pricing period. Acceptable values are 0 to 10000000000, inclusive. 1505 }, 1506 ], 1507 "pricingType": "A String", # Placement pricing type. This field is required on insertion. 1508 "startDate": "A String", 1509 "testingStartDate": "A String", 1510 }, 1511 "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. 1512 "publisherUpdateInfo": { # Modification timestamp. # Information about the last publisher update. This is a read-only field. 1513 "time": "A String", # Timestamp of the last change in milliseconds since epoch. 1514 }, 1515 "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. 1516 "siteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the site. This is a read-only, auto-generated field. 1517 "dimensionName": "A String", # The name of the dimension. 1518 "etag": "A String", # The eTag of this response for caching purposes. 1519 "id": "A String", # The ID associated with the value if available. 1520 "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue. 1521 "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. 1522 "value": "A String", # The value of the dimension. 1523 }, 1524 "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. 1525 "height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive. 1526 "iab": True or False, # IAB standard size. This is a read-only, auto-generated field. 1527 "id": "A String", # ID of this size. This is a read-only, auto-generated field. 1528 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size". 1529 "width": 42, # Width of this size. Acceptable values are 0 to 32767, inclusive. 1530 }, 1531 "sslRequired": True or False, # Whether creatives assigned to this placement must be SSL-compliant. 1532 "status": "A String", # Third-party placement status. 1533 "subaccountId": "A String", # Subaccount ID of this placement. This field can be left blank. 1534 "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" 1535 "A String", 1536 ], 1537 "tagSetting": { # Tag Settings # Tag settings for this placement. 1538 "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. 1539 "includeClickThroughUrls": True or False, # Whether static landing page URLs should be included in the tags. This setting applies only to placements. 1540 "includeClickTracking": True or False, # Whether click-tracking string should be included in the tags. 1541 "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. 1542 }, 1543 "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. 1544 "videoSettings": { # Video Settings # A collection of settings which affect video creatives served through this placement. Applicable to placements with IN_STREAM_VIDEO compatibility. 1545 "companionSettings": { # Companion Settings # Settings for the companion creatives of video creatives served to this placement. 1546 "companionsDisabled": True or False, # Whether companions are disabled for this placement. 1547 "enabledSizes": [ # Allowlist of companion sizes to be served to this placement. Set this list to null or empty to serve all companion sizes. 1548 { # Represents the dimensions of ads, placements, creatives, or creative assets. 1549 "height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive. 1550 "iab": True or False, # IAB standard size. This is a read-only, auto-generated field. 1551 "id": "A String", # ID of this size. This is a read-only, auto-generated field. 1552 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size". 1553 "width": 42, # Width of this size. Acceptable values are 0 to 32767, inclusive. 1554 }, 1555 ], 1556 "imageOnly": True or False, # Whether to serve only static images as companions. 1557 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#companionSetting". 1558 }, 1559 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#videoSettings". 1560 "obaEnabled": True or False, # Whether OBA icons are enabled for this placement. 1561 "obaSettings": { # Online Behavioral Advertiser icon. # Settings for the OBA icon of video creatives served to this placement. If this object is provided, the creative-level OBA settings will be overridden. 1562 "iconClickThroughUrl": "A String", # URL to redirect to when an OBA icon is clicked. 1563 "iconClickTrackingUrl": "A String", # URL to track click when an OBA icon is clicked. 1564 "iconViewTrackingUrl": "A String", # URL to track view when an OBA icon is clicked. 1565 "program": "A String", # Identifies the industry initiative that the icon supports. For example, AdChoices. 1566 "resourceUrl": "A String", # OBA icon resource URL. Campaign Manager only supports image and JavaScript icons. Learn more 1567 "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # OBA icon size. 1568 "height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive. 1569 "iab": True or False, # IAB standard size. This is a read-only, auto-generated field. 1570 "id": "A String", # ID of this size. This is a read-only, auto-generated field. 1571 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size". 1572 "width": 42, # Width of this size. Acceptable values are 0 to 32767, inclusive. 1573 }, 1574 "xPosition": "A String", # OBA icon x coordinate position. Accepted values are left or right. 1575 "yPosition": "A String", # OBA icon y coordinate position. Accepted values are top or bottom. 1576 }, 1577 "orientation": "A String", # Orientation of a video placement. If this value is set, placement will return assets matching the specified orientation. 1578 "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. 1579 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#skippableSetting". 1580 "progressOffset": { # Video Offset # Amount of time to play videos served to this placement before counting a view. Applicable when skippable is true. 1581 "offsetPercentage": 42, # Duration, as a percentage of video duration. Do not set when offsetSeconds is set. Acceptable values are 0 to 100, inclusive. 1582 "offsetSeconds": 42, # Duration, in seconds. Do not set when offsetPercentage is set. Acceptable values are 0 to 86399, inclusive. 1583 }, 1584 "skipOffset": { # Video Offset # Amount of time to play videos served to this placement before the skip button should appear. Applicable when skippable is true. 1585 "offsetPercentage": 42, # Duration, as a percentage of video duration. Do not set when offsetSeconds is set. Acceptable values are 0 to 100, inclusive. 1586 "offsetSeconds": 42, # Duration, in seconds. Do not set when offsetPercentage is set. Acceptable values are 0 to 86399, inclusive. 1587 }, 1588 "skippable": True or False, # Whether the user can skip creatives served to this placement. 1589 }, 1590 "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. 1591 "enabledVideoFormats": [ # Allowlist of video formats to be served to this placement. Set this list to null or empty to serve all video formats. 1592 42, 1593 ], 1594 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#transcodeSetting". 1595 }, 1596 }, 1597 "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. 1598} 1599 1600 x__xgafv: string, V1 error format. 1601 Allowed values 1602 1 - v1 error format 1603 2 - v2 error format 1604 1605Returns: 1606 An object of the form: 1607 1608 { # Contains properties of a placement. 1609 "accountId": "A String", # Account ID of this placement. This field can be left blank. 1610 "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. 1611 "additionalSizes": [ # Additional sizes associated with this placement. When inserting or updating a placement, only the size ID field is used. 1612 { # Represents the dimensions of ads, placements, creatives, or creative assets. 1613 "height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive. 1614 "iab": True or False, # IAB standard size. This is a read-only, auto-generated field. 1615 "id": "A String", # ID of this size. This is a read-only, auto-generated field. 1616 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size". 1617 "width": 42, # Width of this size. Acceptable values are 0 to 32767, inclusive. 1618 }, 1619 ], 1620 "advertiserId": "A String", # Advertiser ID of this placement. This field can be left blank. 1621 "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field. 1622 "dimensionName": "A String", # The name of the dimension. 1623 "etag": "A String", # The eTag of this response for caching purposes. 1624 "id": "A String", # The ID associated with the value if available. 1625 "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue. 1626 "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. 1627 "value": "A String", # The value of the dimension. 1628 }, 1629 "archived": True or False, # Whether this placement is archived. 1630 "campaignId": "A String", # Campaign ID of this placement. This field is a required field on insertion. 1631 "campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field. 1632 "dimensionName": "A String", # The name of the dimension. 1633 "etag": "A String", # The eTag of this response for caching purposes. 1634 "id": "A String", # The ID associated with the value if available. 1635 "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue. 1636 "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. 1637 "value": "A String", # The value of the dimension. 1638 }, 1639 "comment": "A String", # Comments for this placement. 1640 "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. 1641 "contentCategoryId": "A String", # ID of the content category assigned to this placement. 1642 "createInfo": { # Modification timestamp. # Information about the creation of this placement. This is a read-only field. 1643 "time": "A String", # Timestamp of the last change in milliseconds since epoch. 1644 }, 1645 "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. 1646 "directorySiteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field. 1647 "dimensionName": "A String", # The name of the dimension. 1648 "etag": "A String", # The eTag of this response for caching purposes. 1649 "id": "A String", # The ID associated with the value if available. 1650 "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue. 1651 "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. 1652 "value": "A String", # The value of the dimension. 1653 }, 1654 "externalId": "A String", # External ID for this placement. 1655 "id": "A String", # ID of this placement. This is a read-only, auto-generated field. 1656 "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this placement. This is a read-only, auto-generated field. 1657 "dimensionName": "A String", # The name of the dimension. 1658 "etag": "A String", # The eTag of this response for caching purposes. 1659 "id": "A String", # The ID associated with the value if available. 1660 "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue. 1661 "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. 1662 "value": "A String", # The value of the dimension. 1663 }, 1664 "keyName": "A String", # Key name of this placement. This is a read-only, auto-generated field. 1665 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#placement". 1666 "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this placement. This is a read-only field. 1667 "time": "A String", # Timestamp of the last change in milliseconds since epoch. 1668 }, 1669 "lookbackConfiguration": { # Lookback configuration settings. # Lookback window settings for this placement. 1670 "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. 1671 "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. 1672 }, 1673 "name": "A String", # Name of this placement.This is a required field and must be less than or equal to 256 characters long. 1674 "paymentApproved": True or False, # Whether payment was approved for this placement. This is a read-only field relevant only to publisher-paid placements. 1675 "paymentSource": "A String", # Payment source for this placement. This is a required field that is read-only after insertion. 1676 "placementGroupId": "A String", # ID of this placement's group, if applicable. 1677 "placementGroupIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the placement group. This is a read-only, auto-generated field. 1678 "dimensionName": "A String", # The name of the dimension. 1679 "etag": "A String", # The eTag of this response for caching purposes. 1680 "id": "A String", # The ID associated with the value if available. 1681 "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue. 1682 "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. 1683 "value": "A String", # The value of the dimension. 1684 }, 1685 "placementStrategyId": "A String", # ID of the placement strategy assigned to this placement. 1686 "pricingSchedule": { # Pricing Schedule # Pricing schedule of this placement. This field is required on insertion, specifically subfields startDate, endDate and pricingType. 1687 "capCostOption": "A String", # Placement cap cost option. 1688 "endDate": "A String", 1689 "flighted": True or False, # Whether this placement is flighted. If true, pricing periods will be computed automatically. 1690 "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. 1691 "pricingPeriods": [ # Pricing periods for this placement. 1692 { # Pricing Period 1693 "endDate": "A String", 1694 "pricingComment": "A String", # Comments for this pricing period. 1695 "rateOrCostNanos": "A String", # Rate or cost of this pricing period in nanos (i.e., multipled by 1000000000). Acceptable values are 0 to 1000000000000000000, inclusive. 1696 "startDate": "A String", 1697 "units": "A String", # Units of this pricing period. Acceptable values are 0 to 10000000000, inclusive. 1698 }, 1699 ], 1700 "pricingType": "A String", # Placement pricing type. This field is required on insertion. 1701 "startDate": "A String", 1702 "testingStartDate": "A String", 1703 }, 1704 "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. 1705 "publisherUpdateInfo": { # Modification timestamp. # Information about the last publisher update. This is a read-only field. 1706 "time": "A String", # Timestamp of the last change in milliseconds since epoch. 1707 }, 1708 "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. 1709 "siteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the site. This is a read-only, auto-generated field. 1710 "dimensionName": "A String", # The name of the dimension. 1711 "etag": "A String", # The eTag of this response for caching purposes. 1712 "id": "A String", # The ID associated with the value if available. 1713 "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue. 1714 "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. 1715 "value": "A String", # The value of the dimension. 1716 }, 1717 "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. 1718 "height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive. 1719 "iab": True or False, # IAB standard size. This is a read-only, auto-generated field. 1720 "id": "A String", # ID of this size. This is a read-only, auto-generated field. 1721 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size". 1722 "width": 42, # Width of this size. Acceptable values are 0 to 32767, inclusive. 1723 }, 1724 "sslRequired": True or False, # Whether creatives assigned to this placement must be SSL-compliant. 1725 "status": "A String", # Third-party placement status. 1726 "subaccountId": "A String", # Subaccount ID of this placement. This field can be left blank. 1727 "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" 1728 "A String", 1729 ], 1730 "tagSetting": { # Tag Settings # Tag settings for this placement. 1731 "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. 1732 "includeClickThroughUrls": True or False, # Whether static landing page URLs should be included in the tags. This setting applies only to placements. 1733 "includeClickTracking": True or False, # Whether click-tracking string should be included in the tags. 1734 "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. 1735 }, 1736 "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. 1737 "videoSettings": { # Video Settings # A collection of settings which affect video creatives served through this placement. Applicable to placements with IN_STREAM_VIDEO compatibility. 1738 "companionSettings": { # Companion Settings # Settings for the companion creatives of video creatives served to this placement. 1739 "companionsDisabled": True or False, # Whether companions are disabled for this placement. 1740 "enabledSizes": [ # Allowlist of companion sizes to be served to this placement. Set this list to null or empty to serve all companion sizes. 1741 { # Represents the dimensions of ads, placements, creatives, or creative assets. 1742 "height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive. 1743 "iab": True or False, # IAB standard size. This is a read-only, auto-generated field. 1744 "id": "A String", # ID of this size. This is a read-only, auto-generated field. 1745 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size". 1746 "width": 42, # Width of this size. Acceptable values are 0 to 32767, inclusive. 1747 }, 1748 ], 1749 "imageOnly": True or False, # Whether to serve only static images as companions. 1750 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#companionSetting". 1751 }, 1752 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#videoSettings". 1753 "obaEnabled": True or False, # Whether OBA icons are enabled for this placement. 1754 "obaSettings": { # Online Behavioral Advertiser icon. # Settings for the OBA icon of video creatives served to this placement. If this object is provided, the creative-level OBA settings will be overridden. 1755 "iconClickThroughUrl": "A String", # URL to redirect to when an OBA icon is clicked. 1756 "iconClickTrackingUrl": "A String", # URL to track click when an OBA icon is clicked. 1757 "iconViewTrackingUrl": "A String", # URL to track view when an OBA icon is clicked. 1758 "program": "A String", # Identifies the industry initiative that the icon supports. For example, AdChoices. 1759 "resourceUrl": "A String", # OBA icon resource URL. Campaign Manager only supports image and JavaScript icons. Learn more 1760 "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # OBA icon size. 1761 "height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive. 1762 "iab": True or False, # IAB standard size. This is a read-only, auto-generated field. 1763 "id": "A String", # ID of this size. This is a read-only, auto-generated field. 1764 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size". 1765 "width": 42, # Width of this size. Acceptable values are 0 to 32767, inclusive. 1766 }, 1767 "xPosition": "A String", # OBA icon x coordinate position. Accepted values are left or right. 1768 "yPosition": "A String", # OBA icon y coordinate position. Accepted values are top or bottom. 1769 }, 1770 "orientation": "A String", # Orientation of a video placement. If this value is set, placement will return assets matching the specified orientation. 1771 "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. 1772 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#skippableSetting". 1773 "progressOffset": { # Video Offset # Amount of time to play videos served to this placement before counting a view. Applicable when skippable is true. 1774 "offsetPercentage": 42, # Duration, as a percentage of video duration. Do not set when offsetSeconds is set. Acceptable values are 0 to 100, inclusive. 1775 "offsetSeconds": 42, # Duration, in seconds. Do not set when offsetPercentage is set. Acceptable values are 0 to 86399, inclusive. 1776 }, 1777 "skipOffset": { # Video Offset # Amount of time to play videos served to this placement before the skip button should appear. Applicable when skippable is true. 1778 "offsetPercentage": 42, # Duration, as a percentage of video duration. Do not set when offsetSeconds is set. Acceptable values are 0 to 100, inclusive. 1779 "offsetSeconds": 42, # Duration, in seconds. Do not set when offsetPercentage is set. Acceptable values are 0 to 86399, inclusive. 1780 }, 1781 "skippable": True or False, # Whether the user can skip creatives served to this placement. 1782 }, 1783 "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. 1784 "enabledVideoFormats": [ # Allowlist of video formats to be served to this placement. Set this list to null or empty to serve all video formats. 1785 42, 1786 ], 1787 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#transcodeSetting". 1788 }, 1789 }, 1790 "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. 1791}</pre> 1792</div> 1793 1794</body></html>