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