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