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