| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 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="displayvideo_v1.html">Display & Video 360 API</a> . <a href="displayvideo_v1.advertisers.html">advertisers</a> . <a href="displayvideo_v1.advertisers.creatives.html">creatives</a></h1> |
| 76 | <h2>Instance Methods</h2> |
| 77 | <p class="toc_element"> |
| 78 | <code><a href="#create">create(advertiserId, body=None, x__xgafv=None)</a></code></p> |
| 79 | <p class="firstline">Creates a new creative.</p> |
| 80 | <p class="toc_element"> |
| 81 | <code><a href="#delete">delete(advertiserId, creativeId, x__xgafv=None)</a></code></p> |
| 82 | <p class="firstline">Deletes a creative.</p> |
| 83 | <p class="toc_element"> |
| 84 | <code><a href="#get">get(advertiserId, creativeId, x__xgafv=None)</a></code></p> |
| 85 | <p class="firstline">Gets a creative.</p> |
| 86 | <p class="toc_element"> |
| 87 | <code><a href="#list">list(advertiserId, filter=None, pageToken=None, orderBy=None, pageSize=None, x__xgafv=None)</a></code></p> |
| 88 | <p class="firstline">Lists creatives in an advertiser.</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(advertiserId, creativeId, body=None, updateMask=None, x__xgafv=None)</a></code></p> |
| 94 | <p class="firstline">Updates an existing creative.</p> |
| 95 | <h3>Method Details</h3> |
| 96 | <div class="method"> |
| 97 | <code class="details" id="create">create(advertiserId, body=None, x__xgafv=None)</code> |
| 98 | <pre>Creates a new creative. |
| 99 | Returns the newly created creative if successful. |
| 100 | |
| 101 | Args: |
| 102 | advertiserId: string, Output only. The unique ID of the advertiser the creative belongs to. (required) |
| 103 | body: object, The request body. |
| 104 | The object takes the form of: |
| 105 | |
| 106 | { # A single Creative. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 107 | "creativeAttributes": [ # Output only. A list of attributes of the creative that is generated by the system. |
| 108 | "A String", |
| 109 | ], |
| 110 | "creativeId": "A String", # Output only. The unique ID of the creative. Assigned by the system. |
| 111 | "entityStatus": "A String", # Required. Controls whether or not the creative can serve. |
| 112 | # |
| 113 | # Accepted values are: |
| 114 | # |
| 115 | # * `ENTITY_STATUS_ACTIVE` |
| 116 | # * `ENTITY_STATUS_ARCHIVED` |
| 117 | # * `ENTITY_STATUS_PAUSED` |
| 118 | "skipOffset": { # The length an audio or a video has been played. # Amount of time to play the video before the skip button appears. |
| 119 | # |
| 120 | # This field is required when skippable is true. |
| 121 | # |
| 122 | # This field is only supported for the following |
| 123 | # creative_type: |
| 124 | # |
| 125 | # * `CREATIVE_TYPE_VIDEO` |
| 126 | "percentage": "A String", # The offset in percentage of the audio or video duration. |
| 127 | "seconds": "A String", # The offset in seconds from the start of the audio or video. |
| 128 | }, |
| 129 | "requireHtml5": True or False, # Optional. Indicates that the creative relies on HTML5 to render properly. |
| 130 | # |
| 131 | # Optional and only valid for third-party tag creatives. |
| 132 | # Third-party tag creatives are creatives with following |
| 133 | # hosting_source: |
| 134 | # |
| 135 | # * `HOSTING_SOURCE_THIRD_PARTY` |
| 136 | # |
| 137 | # combined with following creative_type: |
| 138 | # |
| 139 | # * `CREATIVE_TYPE_STANDARD` |
| 140 | # * `CREATIVE_TYPE_EXPANDABLE` |
| 141 | "name": "A String", # Output only. The resource name of the creative. |
| 142 | "skippable": True or False, # Whether the user can choose to skip a video creative. |
| 143 | # |
| 144 | # This field is only supported for the following |
| 145 | # creative_type: |
| 146 | # |
| 147 | # * `CREATIVE_TYPE_VIDEO` |
| 148 | "jsTrackerUrl": "A String", # JavaScript measurement URL from supported third-party verification |
| 149 | # providers (ComScore, DoubleVerify, IAS, Moat). HTML script tags are not |
| 150 | # supported. |
| 151 | # |
| 152 | # This field is only supported in following |
| 153 | # creative_type: |
| 154 | # |
| 155 | # * `CREATIVE_TYPE_NATIVE` |
| 156 | # * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` |
| 157 | # * `CREATIVE_TYPE_NATIVE_APP_INSTALL` |
| 158 | # * `CREATIVE_TYPE_NATIVE_APP_INSTALL_SQUARE` |
| 159 | # * `CREATIVE_TYPE_NATIVE_VIDEO` |
| 160 | "thirdPartyUrls": [ # Tracking URLs from third parties to track interactions with a video |
| 161 | # creative. |
| 162 | # |
| 163 | # This field is only supported for the following |
| 164 | # creative_type: |
| 165 | # |
| 166 | # * `CREATIVE_TYPE_AUDIO` |
| 167 | # * `CREATIVE_TYPE_VIDEO` |
| 168 | # * `CREATIVE_TYPE_NATIVE_VIDEO` |
| 169 | { # Tracking URLs from third parties to track interactions with an audio or a |
| 170 | # video creative. |
| 171 | "type": "A String", # The type of interaction needs to be tracked by the tracking URL |
| 172 | "url": "A String", # Tracking URL used to track the interaction. |
| 173 | # |
| 174 | # Provide a URL with optional path or query string, beginning with `https:`. |
| 175 | # For example, https://www.example.com/path |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 176 | }, |
| 177 | ], |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 178 | "expandOnHover": True or False, # Optional. Indicates the creative will automatically expand on hover. |
| 179 | # |
| 180 | # Optional and only valid for third-party expandable creatives. |
| 181 | # Third-party expandable creatives are creatives with following hosting |
| 182 | # source: |
| 183 | # |
| 184 | # * `HOSTING_SOURCE_THIRD_PARTY` |
| 185 | # |
| 186 | # combined with following creative_type: |
| 187 | # |
| 188 | # * `CREATIVE_TYPE_EXPANDABLE` |
| 189 | "exitEvents": [ # Required. Exit events for this creative. |
| 190 | # An exit (also known as a click tag) is any area in your creative that |
| 191 | # someone can click or tap to open an advertiser's landing page. |
| 192 | # Every creative must include at least one exit. |
| 193 | # You can add an exit to your creative in any of the following ways: |
| 194 | # |
| 195 | # * Use Google Web Designer's tap area. |
| 196 | # * Define a JavaScript variable called "clickTag". |
| 197 | # * Use the Enabler (Enabler.exit()) to track exits in rich media formats. |
| 198 | { # Exit event of the creative. |
| 199 | "url": "A String", # Required. The click through URL of the exit event. |
| 200 | # This is required when type is: |
| 201 | # |
| 202 | # * `EXIT_EVENT_TYPE_DEFAULT` |
| 203 | # * `EXIT_EVENT_TYPE_BACKUP` |
| 204 | "name": "A String", # The name of the click tag of the exit event. |
| 205 | # |
| 206 | # The name must be unique within one creative. |
| 207 | # |
| 208 | # Leave it empty or unset for creatives containing image assets only. |
| 209 | "type": "A String", # Required. The type of the exit event. |
| 210 | "reportingName": "A String", # The name used to identify this event in reports. |
| 211 | # Leave it empty or unset for creatives containing image assets only. |
| 212 | }, |
| 213 | ], |
| 214 | "additionalDimensions": [ # Additional dimensions. |
| 215 | # Applicable when creative_type is one of: |
| 216 | # |
| 217 | # * `CREATIVE_TYPE_STANDARD` |
| 218 | # * `CREATIVE_TYPE_EXPANDABLE` |
| 219 | # * `CREATIVE_TYPE_NATIVE` |
| 220 | # * `CREATIVE_TYPE_TEMPLATED_APP_INSTALL` |
| 221 | # * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` |
| 222 | # * `CREATIVE_TYPE_LIGHTBOX` |
| 223 | # * `CREATIVE_TYPE_NATIVE_APP_INSTALL` |
| 224 | # * `CREATIVE_TYPE_NATIVE_APP_INSTALL_SQUARE` |
| 225 | # * `CREATIVE_TYPE_PUBLISHER_HOSTED` |
| 226 | # |
| 227 | # If this field is specified, width_pixels and |
| 228 | # height_pixels are both required and must be |
| 229 | # greater than or equal to 0. |
| 230 | { # Dimensions. |
| 231 | "heightPixels": 42, # The height in pixels. |
| 232 | "widthPixels": 42, # The width in pixels. |
| 233 | }, |
| 234 | ], |
| 235 | "createTime": "A String", # Output only. The timestamp when the creative was created. Assigned by |
| 236 | # the system. |
| 237 | "trackerUrls": [ # Tracking URLs for analytics providers or third-party ad technology vendors. |
| 238 | # |
| 239 | # The URLs must start with https (except on inventory that doesn't require |
| 240 | # SSL compliance). |
| 241 | # If using macros in your URL, use only macros supported by Display & Video |
| 242 | # 360. |
| 243 | # |
| 244 | # Standard URLs only, no IMG or SCRIPT tags. |
| 245 | # |
| 246 | # This field is only supported in following |
| 247 | # creative_type: |
| 248 | # |
| 249 | # * `CREATIVE_TYPE_NATIVE` |
| 250 | # * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` |
| 251 | # * `CREATIVE_TYPE_NATIVE_APP_INSTALL` |
| 252 | # * `CREATIVE_TYPE_NATIVE_APP_INSTALL_SQUARE` |
| 253 | # * `CREATIVE_TYPE_NATIVE_VIDEO` |
| 254 | "A String", |
| 255 | ], |
| 256 | "iasCampaignMonitoring": True or False, # Indicates whether Integral Ad Science (IAS) campaign monitoring is enabled. |
| 257 | # To enable this for the creative, make sure the |
| 258 | # Advertiser.creative_config.ias_client_id |
| 259 | # has been set to your IAS client ID. |
| 260 | "integrationCode": "A String", # ID information used to link this creative to an external system. |
| 261 | # Must be UTF-8 encoded with a length of no more than 10,000 characters. |
| 262 | "cmPlacementId": "A String", # Output only. The unique ID of the Campaign Manager placement associated with the |
| 263 | # creative. |
| 264 | # This field is only applicable for creatives that are synced from Campaign |
| 265 | # Manager. |
| 266 | "requireMraid": True or False, # Optional. Indicates that the creative requires MRAID (Mobile Rich Media Ad Interface |
| 267 | # Definitions system). |
| 268 | # |
| 269 | # Set this if the creative relies on mobile gestures for interactivity, such |
| 270 | # as swiping or tapping. |
| 271 | # |
| 272 | # Optional and only valid for third-party tag creatives. |
| 273 | # |
| 274 | # Third-party tag creatives are creatives with following |
| 275 | # hosting_source: |
| 276 | # |
| 277 | # * `HOSTING_SOURCE_THIRD_PARTY` |
| 278 | # |
| 279 | # combined with following creative_type: |
| 280 | # |
| 281 | # * `CREATIVE_TYPE_STANDARD` |
| 282 | # * `CREATIVE_TYPE_EXPANDABLE` |
| 283 | "companionCreativeIds": [ # The IDs of companion creatives for a video creative. |
| 284 | # |
| 285 | # You can assign existing display creatives (with image or HTML5 assets) |
| 286 | # to serve surrounding the publisher's video player. Companions display |
| 287 | # around the video player while the video is playing and remain after the |
| 288 | # video has completed. |
| 289 | # |
| 290 | # Creatives contain additional dimensions |
| 291 | # can not be companion creatives. |
| 292 | # |
| 293 | # This field is only supported for following |
| 294 | # creative_type: |
| 295 | # |
| 296 | # * `CREATIVE_TYPE_AUDIO` |
| 297 | # * `CREATIVE_TYPE_VIDEO` |
| 298 | "A String", |
| 299 | ], |
| 300 | "creativeType": "A String", # Required. Immutable. The type of the creative. |
| 301 | "obaIcon": { # OBA Icon for a Creative # Specifies the OBA icon for a video creative. |
| 302 | # |
| 303 | # This field is only supported in following |
| 304 | # creative_type: |
| 305 | # |
| 306 | # * `CREATIVE_TYPE_VIDEO` |
| 307 | "dimensions": { # Dimensions. # The dimensions of the OBA icon. |
| 308 | "heightPixels": 42, # The height in pixels. |
| 309 | "widthPixels": 42, # The width in pixels. |
| 310 | }, |
| 311 | "resourceMimeType": "A String", # The MIME type of the OBA icon resource. |
| 312 | "viewTrackingUrl": "A String", # Required. The view tracking URL of the OBA icon. |
| 313 | # |
| 314 | # Only URLs of the following domains are allowed: |
| 315 | # |
| 316 | # * https://info.evidon.com |
| 317 | # * https://l.betrad.com |
| 318 | "clickTrackingUrl": "A String", # Required. The click tracking URL of the OBA icon. |
| 319 | # |
| 320 | # Only URLs of the following domains are allowed: |
| 321 | # |
| 322 | # * https://info.evidon.com |
| 323 | # * https://l.betrad.com |
| 324 | "position": "A String", # The position of the OBA icon on the creative. |
| 325 | "resourceUrl": "A String", # The URL of the OBA icon resource. |
| 326 | "landingPageUrl": "A String", # Required. The landing page URL of the OBA icon. |
| 327 | # |
| 328 | # Only URLs of the following domains are allowed: |
| 329 | # |
| 330 | # * https://info.evidon.com |
| 331 | # * https://l.betrad.com |
| 332 | "program": "A String", # The program of the OBA icon. For example: “AdChoices”. |
| 333 | }, |
| 334 | "timerEvents": [ # Timer custom events for a rich media creative. |
| 335 | # Timers track the time during which a user views and interacts with a |
| 336 | # specified part of a rich media creative. |
| 337 | # A creative can have multiple timer events, each timed independently. |
| 338 | # Leave it empty or unset for creatives containing image assets only. |
| 339 | { # Timer event of the creative. |
| 340 | "name": "A String", # Required. The name of the timer event. |
| 341 | "reportingName": "A String", # Required. The name used to identify this timer event in reports. |
| 342 | }, |
| 343 | ], |
| 344 | "notes": "A String", # User notes for this creative. |
| 345 | # Must be UTF-8 encoded with a length of no more than 20,000 characters. |
| 346 | "dynamic": True or False, # Output only. Indicates whether the creative is dynamic. |
| 347 | "assets": [ # Required. Assets associated to this creative. |
| 348 | # Assets can be associated to the creative in one of following roles: |
| 349 | # |
| 350 | # * `ASSET_ROLE_UNSPECIFIED` |
| 351 | # * `ASSET_ROLE_MAIN` |
| 352 | # * `ASSET_ROLE_BACKUP` |
| 353 | # * `ASSET_ROLE_POLITE_LOAD` |
| 354 | { # Asset association for the creative. |
| 355 | "asset": { # A single asset. # The associated asset. |
| 356 | "mediaId": "A String", # Media ID of the uploaded asset. This is a unique identifier for the asset. |
| 357 | # This ID can be passed to other API calls, e.g. |
| 358 | # CreateCreative to associate |
| 359 | # the asset with a creative. |
| 360 | "content": "A String", # The asset content. |
| 361 | # For uploaded assets, the content is the serving path. |
| 362 | }, |
| 363 | "role": "A String", # The role of this asset for the creative. |
| 364 | }, |
| 365 | ], |
| 366 | "vpaid": True or False, # Output only. Indicates the third-party VAST tag creative requires VPAID (Digital Video |
| 367 | # Player-Ad Interface). |
| 368 | # |
| 369 | # Output only and only valid for third-party VAST tag creatives. |
| 370 | # |
| 371 | # Third-party VAST tag creatives are creatives with following |
| 372 | # hosting_source: |
| 373 | # |
| 374 | # * `HOSTING_SOURCE_THIRD_PARTY` |
| 375 | # |
| 376 | # combined with following creative_type: |
| 377 | # |
| 378 | # * `CREATIVE_TYPE_VIDEO` |
| 379 | "expandingDirection": "A String", # Optional. Specifies the expanding direction of the creative. |
| 380 | # |
| 381 | # Required and only valid for third-party expandable creatives. |
| 382 | # |
| 383 | # Third-party expandable creatives are creatives with following hosting |
| 384 | # source: |
| 385 | # |
| 386 | # * `HOSTING_SOURCE_THIRD_PARTY` |
| 387 | # |
| 388 | # combined with following creative_type: |
| 389 | # |
| 390 | # * `CREATIVE_TYPE_EXPANDABLE` |
| 391 | "thirdPartyTag": "A String", # Optional. The original third-party tag used for the creative. |
| 392 | # |
| 393 | # Required and only valid for third-party tag creatives. |
| 394 | # |
| 395 | # Third-party tag creatives are creatives with following |
| 396 | # hosting_source: |
| 397 | # |
| 398 | # * `HOSTING_SOURCE_THIRD_PARTY` |
| 399 | # |
| 400 | # combined with following creative_type: |
| 401 | # |
| 402 | # * `CREATIVE_TYPE_STANDARD` |
| 403 | # * `CREATIVE_TYPE_EXPANDABLE` |
| 404 | "displayName": "A String", # Required. The display name of the creative. |
| 405 | # |
| 406 | # Must be UTF-8 encoded with a maximum size of 240 bytes. |
| 407 | "hostingSource": "A String", # Required. Indicates where the creative is hosted. |
| 408 | "mediaDuration": "A String", # Output only. Media duration of the creative. |
| 409 | # Applicable when creative_type |
| 410 | # is one of: |
| 411 | # |
| 412 | # * `CREATIVE_TYPE_VIDEO` |
| 413 | # * `CREATIVE_TYPE_AUDIO` |
| 414 | # * `CREATIVE_TYPE_NATIVE_VIDEO` |
| 415 | # * `CREATIVE_TYPE_PUBLISHER_HOSTED` |
| 416 | "vastTagUrl": "A String", # Optional. The URL of the VAST tag for a third-party VAST tag creative. |
| 417 | # |
| 418 | # Required and only valid for third-party VAST tag creatives. |
| 419 | # |
| 420 | # Third-party VAST tag creatives are creatives with following |
| 421 | # hosting_source: |
| 422 | # |
| 423 | # * `HOSTING_SOURCE_THIRD_PARTY` |
| 424 | # |
| 425 | # combined with following creative_type: |
| 426 | # |
| 427 | # * `CREATIVE_TYPE_VIDEO` |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 428 | "reviewStatus": { # Review statuses for the creative. # Output only. The current status of the creative review process. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 429 | "approvalStatus": "A String", # Represents the basic approval needed for a creative to begin serving. |
| 430 | # Summary of |
| 431 | # creative_and_landing_page_review_status |
| 432 | # and |
| 433 | # content_and_policy_review_status. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 434 | "creativeAndLandingPageReviewStatus": "A String", # Creative and landing page review status for the creative. |
| 435 | "exchangeReviewStatuses": [ # Exchange review statuses for the creative. |
| 436 | { # Exchange review status for the creative. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 437 | "status": "A String", # Status of the exchange review. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 438 | "exchange": "A String", # The exchange reviewing the creative. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 439 | }, |
| 440 | ], |
| 441 | "contentAndPolicyReviewStatus": "A String", # Content and policy review status for the creative. |
| 442 | "publisherReviewStatuses": [ # Publisher review statuses for the creative. |
| 443 | { # Publisher review status for the creative. |
| 444 | "status": "A String", # Status of the publisher review. |
| 445 | "publisherName": "A String", # The publisher reviewing the creative. |
| 446 | }, |
| 447 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 448 | }, |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 449 | "counterEvents": [ # Counter events for a rich media creative. |
| 450 | # Counters track the number of times that a user interacts with any part of a |
| 451 | # rich media creative in a specified way (mouse-overs, mouse-outs, clicks, |
| 452 | # taps, data loading, keyboard entries, etc.). |
| 453 | # Any event that can be captured in the creative can be recorded as a |
| 454 | # counter. |
| 455 | # Leave it empty or unset for creatives containing image assets only. |
| 456 | { # Counter event of the creative. |
| 457 | "name": "A String", # Required. The name of the counter event. |
| 458 | "reportingName": "A String", # Required. The name used to identify this counter event in reports. |
| 459 | }, |
| 460 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 461 | "progressOffset": { # The length an audio or a video has been played. # Amount of time to play the video before counting a view. |
| 462 | # |
| 463 | # This field is required when skippable is true. |
| 464 | # |
| 465 | # This field is only supported for the following |
| 466 | # creative_type: |
| 467 | # |
| 468 | # * `CREATIVE_TYPE_VIDEO` |
| 469 | "percentage": "A String", # The offset in percentage of the audio or video duration. |
| 470 | "seconds": "A String", # The offset in seconds from the start of the audio or video. |
| 471 | }, |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 472 | "updateTime": "A String", # Output only. The timestamp when the creative was last updated. Assigned by |
| 473 | # the system. |
| 474 | "advertiserId": "A String", # Output only. The unique ID of the advertiser the creative belongs to. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 475 | "universalAdId": { # A creative identifier provided by a registry that is unique across all # Optional. An optional creative identifier provided by a registry that is unique |
| 476 | # across all platforms. |
| 477 | # |
| 478 | # Universal Ad ID is part of the VAST 4.0 standard. It can be modified after |
| 479 | # the creative is created. |
| 480 | # |
| 481 | # This field is only supported for the following |
| 482 | # creative_type: |
| 483 | # |
| 484 | # * `CREATIVE_TYPE_VIDEO` |
| 485 | # platforms. This is part of the VAST 4.0 standard. |
| 486 | "id": "A String", # The unique creative identifier. |
| 487 | "registry": "A String", # The registry provides unique creative identifiers. |
| 488 | }, |
| 489 | "transcodes": [ # Output only. Audio/Video transcodes. |
| 490 | # |
| 491 | # Display & Video 360 transcodes the main asset into a number of alternative |
| 492 | # versions that use different file formats or have different properties |
| 493 | # (resolution, audio bit rate, and video bit rate), each designed for |
| 494 | # specific video players or bandwidths. |
| 495 | # |
| 496 | # These transcodes give a publisher's system more options to choose from for |
| 497 | # each impression on your video and ensures that the appropriate file serves |
| 498 | # based on the viewer’s connection and screen size. |
| 499 | # |
| 500 | # This field is only supported in following |
| 501 | # creative_type: |
| 502 | # |
| 503 | # * `CREATIVE_TYPE_VIDEO` |
| 504 | # * `CREATIVE_TYPE_NATIVE_VIDEO` |
| 505 | # * `CREATIVE_TYPE_AUDIO` |
| 506 | { # Represents information about the transcoded audio or video file. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 507 | "mimeType": "A String", # The MIME type of the transcoded file. |
| 508 | "bitRateKbps": "A String", # The transcoding bit rate of the transcoded video, in kilobits per second. |
| 509 | "dimensions": { # Dimensions. # The dimensions of the transcoded video. |
| 510 | "heightPixels": 42, # The height in pixels. |
| 511 | "widthPixels": 42, # The width in pixels. |
| 512 | }, |
| 513 | "frameRate": 3.14, # The frame rate of the transcoded video, in frames per second. |
| 514 | "audioSampleRateHz": "A String", # The sample rate for the audio stream of the transcoded video, or the sample |
| 515 | # rate for the transcoded audio, in hertz. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 516 | "transcoded": True or False, # Indicates if the transcoding was successful. |
| 517 | "audioBitRateKbps": "A String", # The bit rate for the audio stream of the transcoded video, or the bit rate |
| 518 | # for the transcoded audio, in kilobits per second. |
| 519 | "fileSizeBytes": "A String", # The size of the transcoded file, in bytes. |
| 520 | "name": "A String", # The name of the transcoded file. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 521 | }, |
| 522 | ], |
| 523 | "cmTrackingAd": { # A Campaign Manager tracking ad. # The Campaign Manager tracking ad associated with the creative. |
| 524 | # |
| 525 | # Optional for the following creative_type when |
| 526 | # created by an advertiser that uses both Campaign Manager and third-party ad |
| 527 | # serving: |
| 528 | # |
| 529 | # * `CREATIVE_TYPE_NATIVE` |
| 530 | # * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` |
| 531 | # * `CREATIVE_TYPE_NATIVE_APP_INSTALL` |
| 532 | # * `CREATIVE_TYPE_NATIVE_APP_INSTALL_SQUARE` |
| 533 | # |
| 534 | # Output only for other cases. |
| 535 | "cmCreativeId": "A String", # The creative ID of the campaign manager tracking Ad. |
| 536 | "cmAdId": "A String", # The ad ID of the campaign manager tracking Ad. |
| 537 | "cmPlacementId": "A String", # The placement ID of the campaign manager tracking Ad. |
| 538 | }, |
| 539 | "html5Video": True or False, # Output only. Indicates the third-party VAST tag creative requires HTML5 Video support. |
| 540 | # |
| 541 | # Output only and only valid for third-party VAST tag creatives. |
| 542 | # |
| 543 | # Third-party VAST tag creatives are creatives with following |
| 544 | # hosting_source: |
| 545 | # |
| 546 | # * `HOSTING_SOURCE_THIRD_PARTY` |
| 547 | # |
| 548 | # combined with following creative_type: |
| 549 | # |
| 550 | # * `CREATIVE_TYPE_VIDEO` |
| 551 | "requirePingForAttribution": True or False, # Optional. Indicates that the creative will wait for a return ping for attribution. |
| 552 | # |
| 553 | # Only valid when using a Campaign Manager tracking ad with a third-party ad |
| 554 | # server parameter and the ${DC_DBM_TOKEN} macro. |
| 555 | # |
| 556 | # Optional and only valid for third-party tag creatives or third-party VAST |
| 557 | # tag creatives. |
| 558 | # |
| 559 | # Third-party tag creatives are creatives with following |
| 560 | # hosting_source: |
| 561 | # |
| 562 | # * `HOSTING_SOURCE_THIRD_PARTY` |
| 563 | # |
| 564 | # combined with following creative_type: |
| 565 | # |
| 566 | # * `CREATIVE_TYPE_STANDARD` |
| 567 | # * `CREATIVE_TYPE_EXPANDABLE` |
| 568 | # |
| 569 | # Third-party VAST tag creatives are creatives with following |
| 570 | # hosting_source: |
| 571 | # |
| 572 | # * `HOSTING_SOURCE_THIRD_PARTY` |
| 573 | # |
| 574 | # combined with following creative_type: |
| 575 | # |
| 576 | # * `CREATIVE_TYPE_VIDEO` |
| 577 | "dimensions": { # Dimensions. # Required. Primary dimensions of the creative. |
| 578 | # Applicable to all creative types. The value of |
| 579 | # width_pixels and |
| 580 | # height_pixels defaults to `0` |
| 581 | # when creative_type is one of: |
| 582 | # |
| 583 | # * `CREATIVE_TYPE_VIDEO` |
| 584 | # * `CREATIVE_TYPE_TEMPLATED_APP_INSTALL_INTERSTITIAL` |
| 585 | # * `CREATIVE_TYPE_AUDIO` |
| 586 | # * `CREATIVE_TYPE_NATIVE_VIDEO` |
| 587 | # * `CREATIVE_TYPE_TEMPLATED_APP_INSTALL_VIDEO` |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 588 | "heightPixels": 42, # The height in pixels. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 589 | "widthPixels": 42, # The width in pixels. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 590 | }, |
| 591 | "appendedTag": "A String", # Third-party HTML tracking tag to be appended to the creative tag. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 592 | } |
| 593 | |
| 594 | x__xgafv: string, V1 error format. |
| 595 | Allowed values |
| 596 | 1 - v1 error format |
| 597 | 2 - v2 error format |
| 598 | |
| 599 | Returns: |
| 600 | An object of the form: |
| 601 | |
| 602 | { # A single Creative. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 603 | "creativeAttributes": [ # Output only. A list of attributes of the creative that is generated by the system. |
| 604 | "A String", |
| 605 | ], |
| 606 | "creativeId": "A String", # Output only. The unique ID of the creative. Assigned by the system. |
| 607 | "entityStatus": "A String", # Required. Controls whether or not the creative can serve. |
| 608 | # |
| 609 | # Accepted values are: |
| 610 | # |
| 611 | # * `ENTITY_STATUS_ACTIVE` |
| 612 | # * `ENTITY_STATUS_ARCHIVED` |
| 613 | # * `ENTITY_STATUS_PAUSED` |
| 614 | "skipOffset": { # The length an audio or a video has been played. # Amount of time to play the video before the skip button appears. |
| 615 | # |
| 616 | # This field is required when skippable is true. |
| 617 | # |
| 618 | # This field is only supported for the following |
| 619 | # creative_type: |
| 620 | # |
| 621 | # * `CREATIVE_TYPE_VIDEO` |
| 622 | "percentage": "A String", # The offset in percentage of the audio or video duration. |
| 623 | "seconds": "A String", # The offset in seconds from the start of the audio or video. |
| 624 | }, |
| 625 | "requireHtml5": True or False, # Optional. Indicates that the creative relies on HTML5 to render properly. |
| 626 | # |
| 627 | # Optional and only valid for third-party tag creatives. |
| 628 | # Third-party tag creatives are creatives with following |
| 629 | # hosting_source: |
| 630 | # |
| 631 | # * `HOSTING_SOURCE_THIRD_PARTY` |
| 632 | # |
| 633 | # combined with following creative_type: |
| 634 | # |
| 635 | # * `CREATIVE_TYPE_STANDARD` |
| 636 | # * `CREATIVE_TYPE_EXPANDABLE` |
| 637 | "name": "A String", # Output only. The resource name of the creative. |
| 638 | "skippable": True or False, # Whether the user can choose to skip a video creative. |
| 639 | # |
| 640 | # This field is only supported for the following |
| 641 | # creative_type: |
| 642 | # |
| 643 | # * `CREATIVE_TYPE_VIDEO` |
| 644 | "jsTrackerUrl": "A String", # JavaScript measurement URL from supported third-party verification |
| 645 | # providers (ComScore, DoubleVerify, IAS, Moat). HTML script tags are not |
| 646 | # supported. |
| 647 | # |
| 648 | # This field is only supported in following |
| 649 | # creative_type: |
| 650 | # |
| 651 | # * `CREATIVE_TYPE_NATIVE` |
| 652 | # * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` |
| 653 | # * `CREATIVE_TYPE_NATIVE_APP_INSTALL` |
| 654 | # * `CREATIVE_TYPE_NATIVE_APP_INSTALL_SQUARE` |
| 655 | # * `CREATIVE_TYPE_NATIVE_VIDEO` |
| 656 | "thirdPartyUrls": [ # Tracking URLs from third parties to track interactions with a video |
| 657 | # creative. |
| 658 | # |
| 659 | # This field is only supported for the following |
| 660 | # creative_type: |
| 661 | # |
| 662 | # * `CREATIVE_TYPE_AUDIO` |
| 663 | # * `CREATIVE_TYPE_VIDEO` |
| 664 | # * `CREATIVE_TYPE_NATIVE_VIDEO` |
| 665 | { # Tracking URLs from third parties to track interactions with an audio or a |
| 666 | # video creative. |
| 667 | "type": "A String", # The type of interaction needs to be tracked by the tracking URL |
| 668 | "url": "A String", # Tracking URL used to track the interaction. |
| 669 | # |
| 670 | # Provide a URL with optional path or query string, beginning with `https:`. |
| 671 | # For example, https://www.example.com/path |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 672 | }, |
| 673 | ], |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 674 | "expandOnHover": True or False, # Optional. Indicates the creative will automatically expand on hover. |
| 675 | # |
| 676 | # Optional and only valid for third-party expandable creatives. |
| 677 | # Third-party expandable creatives are creatives with following hosting |
| 678 | # source: |
| 679 | # |
| 680 | # * `HOSTING_SOURCE_THIRD_PARTY` |
| 681 | # |
| 682 | # combined with following creative_type: |
| 683 | # |
| 684 | # * `CREATIVE_TYPE_EXPANDABLE` |
| 685 | "exitEvents": [ # Required. Exit events for this creative. |
| 686 | # An exit (also known as a click tag) is any area in your creative that |
| 687 | # someone can click or tap to open an advertiser's landing page. |
| 688 | # Every creative must include at least one exit. |
| 689 | # You can add an exit to your creative in any of the following ways: |
| 690 | # |
| 691 | # * Use Google Web Designer's tap area. |
| 692 | # * Define a JavaScript variable called "clickTag". |
| 693 | # * Use the Enabler (Enabler.exit()) to track exits in rich media formats. |
| 694 | { # Exit event of the creative. |
| 695 | "url": "A String", # Required. The click through URL of the exit event. |
| 696 | # This is required when type is: |
| 697 | # |
| 698 | # * `EXIT_EVENT_TYPE_DEFAULT` |
| 699 | # * `EXIT_EVENT_TYPE_BACKUP` |
| 700 | "name": "A String", # The name of the click tag of the exit event. |
| 701 | # |
| 702 | # The name must be unique within one creative. |
| 703 | # |
| 704 | # Leave it empty or unset for creatives containing image assets only. |
| 705 | "type": "A String", # Required. The type of the exit event. |
| 706 | "reportingName": "A String", # The name used to identify this event in reports. |
| 707 | # Leave it empty or unset for creatives containing image assets only. |
| 708 | }, |
| 709 | ], |
| 710 | "additionalDimensions": [ # Additional dimensions. |
| 711 | # Applicable when creative_type is one of: |
| 712 | # |
| 713 | # * `CREATIVE_TYPE_STANDARD` |
| 714 | # * `CREATIVE_TYPE_EXPANDABLE` |
| 715 | # * `CREATIVE_TYPE_NATIVE` |
| 716 | # * `CREATIVE_TYPE_TEMPLATED_APP_INSTALL` |
| 717 | # * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` |
| 718 | # * `CREATIVE_TYPE_LIGHTBOX` |
| 719 | # * `CREATIVE_TYPE_NATIVE_APP_INSTALL` |
| 720 | # * `CREATIVE_TYPE_NATIVE_APP_INSTALL_SQUARE` |
| 721 | # * `CREATIVE_TYPE_PUBLISHER_HOSTED` |
| 722 | # |
| 723 | # If this field is specified, width_pixels and |
| 724 | # height_pixels are both required and must be |
| 725 | # greater than or equal to 0. |
| 726 | { # Dimensions. |
| 727 | "heightPixels": 42, # The height in pixels. |
| 728 | "widthPixels": 42, # The width in pixels. |
| 729 | }, |
| 730 | ], |
| 731 | "createTime": "A String", # Output only. The timestamp when the creative was created. Assigned by |
| 732 | # the system. |
| 733 | "trackerUrls": [ # Tracking URLs for analytics providers or third-party ad technology vendors. |
| 734 | # |
| 735 | # The URLs must start with https (except on inventory that doesn't require |
| 736 | # SSL compliance). |
| 737 | # If using macros in your URL, use only macros supported by Display & Video |
| 738 | # 360. |
| 739 | # |
| 740 | # Standard URLs only, no IMG or SCRIPT tags. |
| 741 | # |
| 742 | # This field is only supported in following |
| 743 | # creative_type: |
| 744 | # |
| 745 | # * `CREATIVE_TYPE_NATIVE` |
| 746 | # * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` |
| 747 | # * `CREATIVE_TYPE_NATIVE_APP_INSTALL` |
| 748 | # * `CREATIVE_TYPE_NATIVE_APP_INSTALL_SQUARE` |
| 749 | # * `CREATIVE_TYPE_NATIVE_VIDEO` |
| 750 | "A String", |
| 751 | ], |
| 752 | "iasCampaignMonitoring": True or False, # Indicates whether Integral Ad Science (IAS) campaign monitoring is enabled. |
| 753 | # To enable this for the creative, make sure the |
| 754 | # Advertiser.creative_config.ias_client_id |
| 755 | # has been set to your IAS client ID. |
| 756 | "integrationCode": "A String", # ID information used to link this creative to an external system. |
| 757 | # Must be UTF-8 encoded with a length of no more than 10,000 characters. |
| 758 | "cmPlacementId": "A String", # Output only. The unique ID of the Campaign Manager placement associated with the |
| 759 | # creative. |
| 760 | # This field is only applicable for creatives that are synced from Campaign |
| 761 | # Manager. |
| 762 | "requireMraid": True or False, # Optional. Indicates that the creative requires MRAID (Mobile Rich Media Ad Interface |
| 763 | # Definitions system). |
| 764 | # |
| 765 | # Set this if the creative relies on mobile gestures for interactivity, such |
| 766 | # as swiping or tapping. |
| 767 | # |
| 768 | # Optional and only valid for third-party tag creatives. |
| 769 | # |
| 770 | # Third-party tag creatives are creatives with following |
| 771 | # hosting_source: |
| 772 | # |
| 773 | # * `HOSTING_SOURCE_THIRD_PARTY` |
| 774 | # |
| 775 | # combined with following creative_type: |
| 776 | # |
| 777 | # * `CREATIVE_TYPE_STANDARD` |
| 778 | # * `CREATIVE_TYPE_EXPANDABLE` |
| 779 | "companionCreativeIds": [ # The IDs of companion creatives for a video creative. |
| 780 | # |
| 781 | # You can assign existing display creatives (with image or HTML5 assets) |
| 782 | # to serve surrounding the publisher's video player. Companions display |
| 783 | # around the video player while the video is playing and remain after the |
| 784 | # video has completed. |
| 785 | # |
| 786 | # Creatives contain additional dimensions |
| 787 | # can not be companion creatives. |
| 788 | # |
| 789 | # This field is only supported for following |
| 790 | # creative_type: |
| 791 | # |
| 792 | # * `CREATIVE_TYPE_AUDIO` |
| 793 | # * `CREATIVE_TYPE_VIDEO` |
| 794 | "A String", |
| 795 | ], |
| 796 | "creativeType": "A String", # Required. Immutable. The type of the creative. |
| 797 | "obaIcon": { # OBA Icon for a Creative # Specifies the OBA icon for a video creative. |
| 798 | # |
| 799 | # This field is only supported in following |
| 800 | # creative_type: |
| 801 | # |
| 802 | # * `CREATIVE_TYPE_VIDEO` |
| 803 | "dimensions": { # Dimensions. # The dimensions of the OBA icon. |
| 804 | "heightPixels": 42, # The height in pixels. |
| 805 | "widthPixels": 42, # The width in pixels. |
| 806 | }, |
| 807 | "resourceMimeType": "A String", # The MIME type of the OBA icon resource. |
| 808 | "viewTrackingUrl": "A String", # Required. The view tracking URL of the OBA icon. |
| 809 | # |
| 810 | # Only URLs of the following domains are allowed: |
| 811 | # |
| 812 | # * https://info.evidon.com |
| 813 | # * https://l.betrad.com |
| 814 | "clickTrackingUrl": "A String", # Required. The click tracking URL of the OBA icon. |
| 815 | # |
| 816 | # Only URLs of the following domains are allowed: |
| 817 | # |
| 818 | # * https://info.evidon.com |
| 819 | # * https://l.betrad.com |
| 820 | "position": "A String", # The position of the OBA icon on the creative. |
| 821 | "resourceUrl": "A String", # The URL of the OBA icon resource. |
| 822 | "landingPageUrl": "A String", # Required. The landing page URL of the OBA icon. |
| 823 | # |
| 824 | # Only URLs of the following domains are allowed: |
| 825 | # |
| 826 | # * https://info.evidon.com |
| 827 | # * https://l.betrad.com |
| 828 | "program": "A String", # The program of the OBA icon. For example: “AdChoices”. |
| 829 | }, |
| 830 | "timerEvents": [ # Timer custom events for a rich media creative. |
| 831 | # Timers track the time during which a user views and interacts with a |
| 832 | # specified part of a rich media creative. |
| 833 | # A creative can have multiple timer events, each timed independently. |
| 834 | # Leave it empty or unset for creatives containing image assets only. |
| 835 | { # Timer event of the creative. |
| 836 | "name": "A String", # Required. The name of the timer event. |
| 837 | "reportingName": "A String", # Required. The name used to identify this timer event in reports. |
| 838 | }, |
| 839 | ], |
| 840 | "notes": "A String", # User notes for this creative. |
| 841 | # Must be UTF-8 encoded with a length of no more than 20,000 characters. |
| 842 | "dynamic": True or False, # Output only. Indicates whether the creative is dynamic. |
| 843 | "assets": [ # Required. Assets associated to this creative. |
| 844 | # Assets can be associated to the creative in one of following roles: |
| 845 | # |
| 846 | # * `ASSET_ROLE_UNSPECIFIED` |
| 847 | # * `ASSET_ROLE_MAIN` |
| 848 | # * `ASSET_ROLE_BACKUP` |
| 849 | # * `ASSET_ROLE_POLITE_LOAD` |
| 850 | { # Asset association for the creative. |
| 851 | "asset": { # A single asset. # The associated asset. |
| 852 | "mediaId": "A String", # Media ID of the uploaded asset. This is a unique identifier for the asset. |
| 853 | # This ID can be passed to other API calls, e.g. |
| 854 | # CreateCreative to associate |
| 855 | # the asset with a creative. |
| 856 | "content": "A String", # The asset content. |
| 857 | # For uploaded assets, the content is the serving path. |
| 858 | }, |
| 859 | "role": "A String", # The role of this asset for the creative. |
| 860 | }, |
| 861 | ], |
| 862 | "vpaid": True or False, # Output only. Indicates the third-party VAST tag creative requires VPAID (Digital Video |
| 863 | # Player-Ad Interface). |
| 864 | # |
| 865 | # Output only and only valid for third-party VAST tag creatives. |
| 866 | # |
| 867 | # Third-party VAST tag creatives are creatives with following |
| 868 | # hosting_source: |
| 869 | # |
| 870 | # * `HOSTING_SOURCE_THIRD_PARTY` |
| 871 | # |
| 872 | # combined with following creative_type: |
| 873 | # |
| 874 | # * `CREATIVE_TYPE_VIDEO` |
| 875 | "expandingDirection": "A String", # Optional. Specifies the expanding direction of the creative. |
| 876 | # |
| 877 | # Required and only valid for third-party expandable creatives. |
| 878 | # |
| 879 | # Third-party expandable creatives are creatives with following hosting |
| 880 | # source: |
| 881 | # |
| 882 | # * `HOSTING_SOURCE_THIRD_PARTY` |
| 883 | # |
| 884 | # combined with following creative_type: |
| 885 | # |
| 886 | # * `CREATIVE_TYPE_EXPANDABLE` |
| 887 | "thirdPartyTag": "A String", # Optional. The original third-party tag used for the creative. |
| 888 | # |
| 889 | # Required and only valid for third-party tag creatives. |
| 890 | # |
| 891 | # Third-party tag creatives are creatives with following |
| 892 | # hosting_source: |
| 893 | # |
| 894 | # * `HOSTING_SOURCE_THIRD_PARTY` |
| 895 | # |
| 896 | # combined with following creative_type: |
| 897 | # |
| 898 | # * `CREATIVE_TYPE_STANDARD` |
| 899 | # * `CREATIVE_TYPE_EXPANDABLE` |
| 900 | "displayName": "A String", # Required. The display name of the creative. |
| 901 | # |
| 902 | # Must be UTF-8 encoded with a maximum size of 240 bytes. |
| 903 | "hostingSource": "A String", # Required. Indicates where the creative is hosted. |
| 904 | "mediaDuration": "A String", # Output only. Media duration of the creative. |
| 905 | # Applicable when creative_type |
| 906 | # is one of: |
| 907 | # |
| 908 | # * `CREATIVE_TYPE_VIDEO` |
| 909 | # * `CREATIVE_TYPE_AUDIO` |
| 910 | # * `CREATIVE_TYPE_NATIVE_VIDEO` |
| 911 | # * `CREATIVE_TYPE_PUBLISHER_HOSTED` |
| 912 | "vastTagUrl": "A String", # Optional. The URL of the VAST tag for a third-party VAST tag creative. |
| 913 | # |
| 914 | # Required and only valid for third-party VAST tag creatives. |
| 915 | # |
| 916 | # Third-party VAST tag creatives are creatives with following |
| 917 | # hosting_source: |
| 918 | # |
| 919 | # * `HOSTING_SOURCE_THIRD_PARTY` |
| 920 | # |
| 921 | # combined with following creative_type: |
| 922 | # |
| 923 | # * `CREATIVE_TYPE_VIDEO` |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 924 | "reviewStatus": { # Review statuses for the creative. # Output only. The current status of the creative review process. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 925 | "approvalStatus": "A String", # Represents the basic approval needed for a creative to begin serving. |
| 926 | # Summary of |
| 927 | # creative_and_landing_page_review_status |
| 928 | # and |
| 929 | # content_and_policy_review_status. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 930 | "creativeAndLandingPageReviewStatus": "A String", # Creative and landing page review status for the creative. |
| 931 | "exchangeReviewStatuses": [ # Exchange review statuses for the creative. |
| 932 | { # Exchange review status for the creative. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 933 | "status": "A String", # Status of the exchange review. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 934 | "exchange": "A String", # The exchange reviewing the creative. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 935 | }, |
| 936 | ], |
| 937 | "contentAndPolicyReviewStatus": "A String", # Content and policy review status for the creative. |
| 938 | "publisherReviewStatuses": [ # Publisher review statuses for the creative. |
| 939 | { # Publisher review status for the creative. |
| 940 | "status": "A String", # Status of the publisher review. |
| 941 | "publisherName": "A String", # The publisher reviewing the creative. |
| 942 | }, |
| 943 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 944 | }, |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 945 | "counterEvents": [ # Counter events for a rich media creative. |
| 946 | # Counters track the number of times that a user interacts with any part of a |
| 947 | # rich media creative in a specified way (mouse-overs, mouse-outs, clicks, |
| 948 | # taps, data loading, keyboard entries, etc.). |
| 949 | # Any event that can be captured in the creative can be recorded as a |
| 950 | # counter. |
| 951 | # Leave it empty or unset for creatives containing image assets only. |
| 952 | { # Counter event of the creative. |
| 953 | "name": "A String", # Required. The name of the counter event. |
| 954 | "reportingName": "A String", # Required. The name used to identify this counter event in reports. |
| 955 | }, |
| 956 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 957 | "progressOffset": { # The length an audio or a video has been played. # Amount of time to play the video before counting a view. |
| 958 | # |
| 959 | # This field is required when skippable is true. |
| 960 | # |
| 961 | # This field is only supported for the following |
| 962 | # creative_type: |
| 963 | # |
| 964 | # * `CREATIVE_TYPE_VIDEO` |
| 965 | "percentage": "A String", # The offset in percentage of the audio or video duration. |
| 966 | "seconds": "A String", # The offset in seconds from the start of the audio or video. |
| 967 | }, |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 968 | "updateTime": "A String", # Output only. The timestamp when the creative was last updated. Assigned by |
| 969 | # the system. |
| 970 | "advertiserId": "A String", # Output only. The unique ID of the advertiser the creative belongs to. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 971 | "universalAdId": { # A creative identifier provided by a registry that is unique across all # Optional. An optional creative identifier provided by a registry that is unique |
| 972 | # across all platforms. |
| 973 | # |
| 974 | # Universal Ad ID is part of the VAST 4.0 standard. It can be modified after |
| 975 | # the creative is created. |
| 976 | # |
| 977 | # This field is only supported for the following |
| 978 | # creative_type: |
| 979 | # |
| 980 | # * `CREATIVE_TYPE_VIDEO` |
| 981 | # platforms. This is part of the VAST 4.0 standard. |
| 982 | "id": "A String", # The unique creative identifier. |
| 983 | "registry": "A String", # The registry provides unique creative identifiers. |
| 984 | }, |
| 985 | "transcodes": [ # Output only. Audio/Video transcodes. |
| 986 | # |
| 987 | # Display & Video 360 transcodes the main asset into a number of alternative |
| 988 | # versions that use different file formats or have different properties |
| 989 | # (resolution, audio bit rate, and video bit rate), each designed for |
| 990 | # specific video players or bandwidths. |
| 991 | # |
| 992 | # These transcodes give a publisher's system more options to choose from for |
| 993 | # each impression on your video and ensures that the appropriate file serves |
| 994 | # based on the viewer’s connection and screen size. |
| 995 | # |
| 996 | # This field is only supported in following |
| 997 | # creative_type: |
| 998 | # |
| 999 | # * `CREATIVE_TYPE_VIDEO` |
| 1000 | # * `CREATIVE_TYPE_NATIVE_VIDEO` |
| 1001 | # * `CREATIVE_TYPE_AUDIO` |
| 1002 | { # Represents information about the transcoded audio or video file. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 1003 | "mimeType": "A String", # The MIME type of the transcoded file. |
| 1004 | "bitRateKbps": "A String", # The transcoding bit rate of the transcoded video, in kilobits per second. |
| 1005 | "dimensions": { # Dimensions. # The dimensions of the transcoded video. |
| 1006 | "heightPixels": 42, # The height in pixels. |
| 1007 | "widthPixels": 42, # The width in pixels. |
| 1008 | }, |
| 1009 | "frameRate": 3.14, # The frame rate of the transcoded video, in frames per second. |
| 1010 | "audioSampleRateHz": "A String", # The sample rate for the audio stream of the transcoded video, or the sample |
| 1011 | # rate for the transcoded audio, in hertz. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1012 | "transcoded": True or False, # Indicates if the transcoding was successful. |
| 1013 | "audioBitRateKbps": "A String", # The bit rate for the audio stream of the transcoded video, or the bit rate |
| 1014 | # for the transcoded audio, in kilobits per second. |
| 1015 | "fileSizeBytes": "A String", # The size of the transcoded file, in bytes. |
| 1016 | "name": "A String", # The name of the transcoded file. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1017 | }, |
| 1018 | ], |
| 1019 | "cmTrackingAd": { # A Campaign Manager tracking ad. # The Campaign Manager tracking ad associated with the creative. |
| 1020 | # |
| 1021 | # Optional for the following creative_type when |
| 1022 | # created by an advertiser that uses both Campaign Manager and third-party ad |
| 1023 | # serving: |
| 1024 | # |
| 1025 | # * `CREATIVE_TYPE_NATIVE` |
| 1026 | # * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` |
| 1027 | # * `CREATIVE_TYPE_NATIVE_APP_INSTALL` |
| 1028 | # * `CREATIVE_TYPE_NATIVE_APP_INSTALL_SQUARE` |
| 1029 | # |
| 1030 | # Output only for other cases. |
| 1031 | "cmCreativeId": "A String", # The creative ID of the campaign manager tracking Ad. |
| 1032 | "cmAdId": "A String", # The ad ID of the campaign manager tracking Ad. |
| 1033 | "cmPlacementId": "A String", # The placement ID of the campaign manager tracking Ad. |
| 1034 | }, |
| 1035 | "html5Video": True or False, # Output only. Indicates the third-party VAST tag creative requires HTML5 Video support. |
| 1036 | # |
| 1037 | # Output only and only valid for third-party VAST tag creatives. |
| 1038 | # |
| 1039 | # Third-party VAST tag creatives are creatives with following |
| 1040 | # hosting_source: |
| 1041 | # |
| 1042 | # * `HOSTING_SOURCE_THIRD_PARTY` |
| 1043 | # |
| 1044 | # combined with following creative_type: |
| 1045 | # |
| 1046 | # * `CREATIVE_TYPE_VIDEO` |
| 1047 | "requirePingForAttribution": True or False, # Optional. Indicates that the creative will wait for a return ping for attribution. |
| 1048 | # |
| 1049 | # Only valid when using a Campaign Manager tracking ad with a third-party ad |
| 1050 | # server parameter and the ${DC_DBM_TOKEN} macro. |
| 1051 | # |
| 1052 | # Optional and only valid for third-party tag creatives or third-party VAST |
| 1053 | # tag creatives. |
| 1054 | # |
| 1055 | # Third-party tag creatives are creatives with following |
| 1056 | # hosting_source: |
| 1057 | # |
| 1058 | # * `HOSTING_SOURCE_THIRD_PARTY` |
| 1059 | # |
| 1060 | # combined with following creative_type: |
| 1061 | # |
| 1062 | # * `CREATIVE_TYPE_STANDARD` |
| 1063 | # * `CREATIVE_TYPE_EXPANDABLE` |
| 1064 | # |
| 1065 | # Third-party VAST tag creatives are creatives with following |
| 1066 | # hosting_source: |
| 1067 | # |
| 1068 | # * `HOSTING_SOURCE_THIRD_PARTY` |
| 1069 | # |
| 1070 | # combined with following creative_type: |
| 1071 | # |
| 1072 | # * `CREATIVE_TYPE_VIDEO` |
| 1073 | "dimensions": { # Dimensions. # Required. Primary dimensions of the creative. |
| 1074 | # Applicable to all creative types. The value of |
| 1075 | # width_pixels and |
| 1076 | # height_pixels defaults to `0` |
| 1077 | # when creative_type is one of: |
| 1078 | # |
| 1079 | # * `CREATIVE_TYPE_VIDEO` |
| 1080 | # * `CREATIVE_TYPE_TEMPLATED_APP_INSTALL_INTERSTITIAL` |
| 1081 | # * `CREATIVE_TYPE_AUDIO` |
| 1082 | # * `CREATIVE_TYPE_NATIVE_VIDEO` |
| 1083 | # * `CREATIVE_TYPE_TEMPLATED_APP_INSTALL_VIDEO` |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1084 | "heightPixels": 42, # The height in pixels. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 1085 | "widthPixels": 42, # The width in pixels. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1086 | }, |
| 1087 | "appendedTag": "A String", # Third-party HTML tracking tag to be appended to the creative tag. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1088 | }</pre> |
| 1089 | </div> |
| 1090 | |
| 1091 | <div class="method"> |
| 1092 | <code class="details" id="delete">delete(advertiserId, creativeId, x__xgafv=None)</code> |
| 1093 | <pre>Deletes a creative. |
| 1094 | Returns error code `NOT_FOUND` if the creative does not exist. |
| 1095 | The creative should be archived first, i.e. set |
| 1096 | entity_status to `ENTITY_STATUS_ARCHIVED`, before |
| 1097 | it can be deleted. |
| 1098 | |
| 1099 | Args: |
| 1100 | advertiserId: string, The ID of the advertiser this creative belongs to. (required) |
| 1101 | creativeId: string, The ID of the creative to be deleted. (required) |
| 1102 | x__xgafv: string, V1 error format. |
| 1103 | Allowed values |
| 1104 | 1 - v1 error format |
| 1105 | 2 - v2 error format |
| 1106 | |
| 1107 | Returns: |
| 1108 | An object of the form: |
| 1109 | |
| 1110 | { # A generic empty message that you can re-use to avoid defining duplicated |
| 1111 | # empty messages in your APIs. A typical example is to use it as the request |
| 1112 | # or the response type of an API method. For instance: |
| 1113 | # |
| 1114 | # service Foo { |
| 1115 | # rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); |
| 1116 | # } |
| 1117 | # |
| 1118 | # The JSON representation for `Empty` is empty JSON object `{}`. |
| 1119 | }</pre> |
| 1120 | </div> |
| 1121 | |
| 1122 | <div class="method"> |
| 1123 | <code class="details" id="get">get(advertiserId, creativeId, x__xgafv=None)</code> |
| 1124 | <pre>Gets a creative. |
| 1125 | |
| 1126 | Args: |
| 1127 | advertiserId: string, Required. The ID of the advertiser this creative belongs to. (required) |
| 1128 | creativeId: string, Required. The ID of the creative to fetch. (required) |
| 1129 | x__xgafv: string, V1 error format. |
| 1130 | Allowed values |
| 1131 | 1 - v1 error format |
| 1132 | 2 - v2 error format |
| 1133 | |
| 1134 | Returns: |
| 1135 | An object of the form: |
| 1136 | |
| 1137 | { # A single Creative. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 1138 | "creativeAttributes": [ # Output only. A list of attributes of the creative that is generated by the system. |
| 1139 | "A String", |
| 1140 | ], |
| 1141 | "creativeId": "A String", # Output only. The unique ID of the creative. Assigned by the system. |
| 1142 | "entityStatus": "A String", # Required. Controls whether or not the creative can serve. |
| 1143 | # |
| 1144 | # Accepted values are: |
| 1145 | # |
| 1146 | # * `ENTITY_STATUS_ACTIVE` |
| 1147 | # * `ENTITY_STATUS_ARCHIVED` |
| 1148 | # * `ENTITY_STATUS_PAUSED` |
| 1149 | "skipOffset": { # The length an audio or a video has been played. # Amount of time to play the video before the skip button appears. |
| 1150 | # |
| 1151 | # This field is required when skippable is true. |
| 1152 | # |
| 1153 | # This field is only supported for the following |
| 1154 | # creative_type: |
| 1155 | # |
| 1156 | # * `CREATIVE_TYPE_VIDEO` |
| 1157 | "percentage": "A String", # The offset in percentage of the audio or video duration. |
| 1158 | "seconds": "A String", # The offset in seconds from the start of the audio or video. |
| 1159 | }, |
| 1160 | "requireHtml5": True or False, # Optional. Indicates that the creative relies on HTML5 to render properly. |
| 1161 | # |
| 1162 | # Optional and only valid for third-party tag creatives. |
| 1163 | # Third-party tag creatives are creatives with following |
| 1164 | # hosting_source: |
| 1165 | # |
| 1166 | # * `HOSTING_SOURCE_THIRD_PARTY` |
| 1167 | # |
| 1168 | # combined with following creative_type: |
| 1169 | # |
| 1170 | # * `CREATIVE_TYPE_STANDARD` |
| 1171 | # * `CREATIVE_TYPE_EXPANDABLE` |
| 1172 | "name": "A String", # Output only. The resource name of the creative. |
| 1173 | "skippable": True or False, # Whether the user can choose to skip a video creative. |
| 1174 | # |
| 1175 | # This field is only supported for the following |
| 1176 | # creative_type: |
| 1177 | # |
| 1178 | # * `CREATIVE_TYPE_VIDEO` |
| 1179 | "jsTrackerUrl": "A String", # JavaScript measurement URL from supported third-party verification |
| 1180 | # providers (ComScore, DoubleVerify, IAS, Moat). HTML script tags are not |
| 1181 | # supported. |
| 1182 | # |
| 1183 | # This field is only supported in following |
| 1184 | # creative_type: |
| 1185 | # |
| 1186 | # * `CREATIVE_TYPE_NATIVE` |
| 1187 | # * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` |
| 1188 | # * `CREATIVE_TYPE_NATIVE_APP_INSTALL` |
| 1189 | # * `CREATIVE_TYPE_NATIVE_APP_INSTALL_SQUARE` |
| 1190 | # * `CREATIVE_TYPE_NATIVE_VIDEO` |
| 1191 | "thirdPartyUrls": [ # Tracking URLs from third parties to track interactions with a video |
| 1192 | # creative. |
| 1193 | # |
| 1194 | # This field is only supported for the following |
| 1195 | # creative_type: |
| 1196 | # |
| 1197 | # * `CREATIVE_TYPE_AUDIO` |
| 1198 | # * `CREATIVE_TYPE_VIDEO` |
| 1199 | # * `CREATIVE_TYPE_NATIVE_VIDEO` |
| 1200 | { # Tracking URLs from third parties to track interactions with an audio or a |
| 1201 | # video creative. |
| 1202 | "type": "A String", # The type of interaction needs to be tracked by the tracking URL |
| 1203 | "url": "A String", # Tracking URL used to track the interaction. |
| 1204 | # |
| 1205 | # Provide a URL with optional path or query string, beginning with `https:`. |
| 1206 | # For example, https://www.example.com/path |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1207 | }, |
| 1208 | ], |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 1209 | "expandOnHover": True or False, # Optional. Indicates the creative will automatically expand on hover. |
| 1210 | # |
| 1211 | # Optional and only valid for third-party expandable creatives. |
| 1212 | # Third-party expandable creatives are creatives with following hosting |
| 1213 | # source: |
| 1214 | # |
| 1215 | # * `HOSTING_SOURCE_THIRD_PARTY` |
| 1216 | # |
| 1217 | # combined with following creative_type: |
| 1218 | # |
| 1219 | # * `CREATIVE_TYPE_EXPANDABLE` |
| 1220 | "exitEvents": [ # Required. Exit events for this creative. |
| 1221 | # An exit (also known as a click tag) is any area in your creative that |
| 1222 | # someone can click or tap to open an advertiser's landing page. |
| 1223 | # Every creative must include at least one exit. |
| 1224 | # You can add an exit to your creative in any of the following ways: |
| 1225 | # |
| 1226 | # * Use Google Web Designer's tap area. |
| 1227 | # * Define a JavaScript variable called "clickTag". |
| 1228 | # * Use the Enabler (Enabler.exit()) to track exits in rich media formats. |
| 1229 | { # Exit event of the creative. |
| 1230 | "url": "A String", # Required. The click through URL of the exit event. |
| 1231 | # This is required when type is: |
| 1232 | # |
| 1233 | # * `EXIT_EVENT_TYPE_DEFAULT` |
| 1234 | # * `EXIT_EVENT_TYPE_BACKUP` |
| 1235 | "name": "A String", # The name of the click tag of the exit event. |
| 1236 | # |
| 1237 | # The name must be unique within one creative. |
| 1238 | # |
| 1239 | # Leave it empty or unset for creatives containing image assets only. |
| 1240 | "type": "A String", # Required. The type of the exit event. |
| 1241 | "reportingName": "A String", # The name used to identify this event in reports. |
| 1242 | # Leave it empty or unset for creatives containing image assets only. |
| 1243 | }, |
| 1244 | ], |
| 1245 | "additionalDimensions": [ # Additional dimensions. |
| 1246 | # Applicable when creative_type is one of: |
| 1247 | # |
| 1248 | # * `CREATIVE_TYPE_STANDARD` |
| 1249 | # * `CREATIVE_TYPE_EXPANDABLE` |
| 1250 | # * `CREATIVE_TYPE_NATIVE` |
| 1251 | # * `CREATIVE_TYPE_TEMPLATED_APP_INSTALL` |
| 1252 | # * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` |
| 1253 | # * `CREATIVE_TYPE_LIGHTBOX` |
| 1254 | # * `CREATIVE_TYPE_NATIVE_APP_INSTALL` |
| 1255 | # * `CREATIVE_TYPE_NATIVE_APP_INSTALL_SQUARE` |
| 1256 | # * `CREATIVE_TYPE_PUBLISHER_HOSTED` |
| 1257 | # |
| 1258 | # If this field is specified, width_pixels and |
| 1259 | # height_pixels are both required and must be |
| 1260 | # greater than or equal to 0. |
| 1261 | { # Dimensions. |
| 1262 | "heightPixels": 42, # The height in pixels. |
| 1263 | "widthPixels": 42, # The width in pixels. |
| 1264 | }, |
| 1265 | ], |
| 1266 | "createTime": "A String", # Output only. The timestamp when the creative was created. Assigned by |
| 1267 | # the system. |
| 1268 | "trackerUrls": [ # Tracking URLs for analytics providers or third-party ad technology vendors. |
| 1269 | # |
| 1270 | # The URLs must start with https (except on inventory that doesn't require |
| 1271 | # SSL compliance). |
| 1272 | # If using macros in your URL, use only macros supported by Display & Video |
| 1273 | # 360. |
| 1274 | # |
| 1275 | # Standard URLs only, no IMG or SCRIPT tags. |
| 1276 | # |
| 1277 | # This field is only supported in following |
| 1278 | # creative_type: |
| 1279 | # |
| 1280 | # * `CREATIVE_TYPE_NATIVE` |
| 1281 | # * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` |
| 1282 | # * `CREATIVE_TYPE_NATIVE_APP_INSTALL` |
| 1283 | # * `CREATIVE_TYPE_NATIVE_APP_INSTALL_SQUARE` |
| 1284 | # * `CREATIVE_TYPE_NATIVE_VIDEO` |
| 1285 | "A String", |
| 1286 | ], |
| 1287 | "iasCampaignMonitoring": True or False, # Indicates whether Integral Ad Science (IAS) campaign monitoring is enabled. |
| 1288 | # To enable this for the creative, make sure the |
| 1289 | # Advertiser.creative_config.ias_client_id |
| 1290 | # has been set to your IAS client ID. |
| 1291 | "integrationCode": "A String", # ID information used to link this creative to an external system. |
| 1292 | # Must be UTF-8 encoded with a length of no more than 10,000 characters. |
| 1293 | "cmPlacementId": "A String", # Output only. The unique ID of the Campaign Manager placement associated with the |
| 1294 | # creative. |
| 1295 | # This field is only applicable for creatives that are synced from Campaign |
| 1296 | # Manager. |
| 1297 | "requireMraid": True or False, # Optional. Indicates that the creative requires MRAID (Mobile Rich Media Ad Interface |
| 1298 | # Definitions system). |
| 1299 | # |
| 1300 | # Set this if the creative relies on mobile gestures for interactivity, such |
| 1301 | # as swiping or tapping. |
| 1302 | # |
| 1303 | # Optional and only valid for third-party tag creatives. |
| 1304 | # |
| 1305 | # Third-party tag creatives are creatives with following |
| 1306 | # hosting_source: |
| 1307 | # |
| 1308 | # * `HOSTING_SOURCE_THIRD_PARTY` |
| 1309 | # |
| 1310 | # combined with following creative_type: |
| 1311 | # |
| 1312 | # * `CREATIVE_TYPE_STANDARD` |
| 1313 | # * `CREATIVE_TYPE_EXPANDABLE` |
| 1314 | "companionCreativeIds": [ # The IDs of companion creatives for a video creative. |
| 1315 | # |
| 1316 | # You can assign existing display creatives (with image or HTML5 assets) |
| 1317 | # to serve surrounding the publisher's video player. Companions display |
| 1318 | # around the video player while the video is playing and remain after the |
| 1319 | # video has completed. |
| 1320 | # |
| 1321 | # Creatives contain additional dimensions |
| 1322 | # can not be companion creatives. |
| 1323 | # |
| 1324 | # This field is only supported for following |
| 1325 | # creative_type: |
| 1326 | # |
| 1327 | # * `CREATIVE_TYPE_AUDIO` |
| 1328 | # * `CREATIVE_TYPE_VIDEO` |
| 1329 | "A String", |
| 1330 | ], |
| 1331 | "creativeType": "A String", # Required. Immutable. The type of the creative. |
| 1332 | "obaIcon": { # OBA Icon for a Creative # Specifies the OBA icon for a video creative. |
| 1333 | # |
| 1334 | # This field is only supported in following |
| 1335 | # creative_type: |
| 1336 | # |
| 1337 | # * `CREATIVE_TYPE_VIDEO` |
| 1338 | "dimensions": { # Dimensions. # The dimensions of the OBA icon. |
| 1339 | "heightPixels": 42, # The height in pixels. |
| 1340 | "widthPixels": 42, # The width in pixels. |
| 1341 | }, |
| 1342 | "resourceMimeType": "A String", # The MIME type of the OBA icon resource. |
| 1343 | "viewTrackingUrl": "A String", # Required. The view tracking URL of the OBA icon. |
| 1344 | # |
| 1345 | # Only URLs of the following domains are allowed: |
| 1346 | # |
| 1347 | # * https://info.evidon.com |
| 1348 | # * https://l.betrad.com |
| 1349 | "clickTrackingUrl": "A String", # Required. The click tracking URL of the OBA icon. |
| 1350 | # |
| 1351 | # Only URLs of the following domains are allowed: |
| 1352 | # |
| 1353 | # * https://info.evidon.com |
| 1354 | # * https://l.betrad.com |
| 1355 | "position": "A String", # The position of the OBA icon on the creative. |
| 1356 | "resourceUrl": "A String", # The URL of the OBA icon resource. |
| 1357 | "landingPageUrl": "A String", # Required. The landing page URL of the OBA icon. |
| 1358 | # |
| 1359 | # Only URLs of the following domains are allowed: |
| 1360 | # |
| 1361 | # * https://info.evidon.com |
| 1362 | # * https://l.betrad.com |
| 1363 | "program": "A String", # The program of the OBA icon. For example: “AdChoices”. |
| 1364 | }, |
| 1365 | "timerEvents": [ # Timer custom events for a rich media creative. |
| 1366 | # Timers track the time during which a user views and interacts with a |
| 1367 | # specified part of a rich media creative. |
| 1368 | # A creative can have multiple timer events, each timed independently. |
| 1369 | # Leave it empty or unset for creatives containing image assets only. |
| 1370 | { # Timer event of the creative. |
| 1371 | "name": "A String", # Required. The name of the timer event. |
| 1372 | "reportingName": "A String", # Required. The name used to identify this timer event in reports. |
| 1373 | }, |
| 1374 | ], |
| 1375 | "notes": "A String", # User notes for this creative. |
| 1376 | # Must be UTF-8 encoded with a length of no more than 20,000 characters. |
| 1377 | "dynamic": True or False, # Output only. Indicates whether the creative is dynamic. |
| 1378 | "assets": [ # Required. Assets associated to this creative. |
| 1379 | # Assets can be associated to the creative in one of following roles: |
| 1380 | # |
| 1381 | # * `ASSET_ROLE_UNSPECIFIED` |
| 1382 | # * `ASSET_ROLE_MAIN` |
| 1383 | # * `ASSET_ROLE_BACKUP` |
| 1384 | # * `ASSET_ROLE_POLITE_LOAD` |
| 1385 | { # Asset association for the creative. |
| 1386 | "asset": { # A single asset. # The associated asset. |
| 1387 | "mediaId": "A String", # Media ID of the uploaded asset. This is a unique identifier for the asset. |
| 1388 | # This ID can be passed to other API calls, e.g. |
| 1389 | # CreateCreative to associate |
| 1390 | # the asset with a creative. |
| 1391 | "content": "A String", # The asset content. |
| 1392 | # For uploaded assets, the content is the serving path. |
| 1393 | }, |
| 1394 | "role": "A String", # The role of this asset for the creative. |
| 1395 | }, |
| 1396 | ], |
| 1397 | "vpaid": True or False, # Output only. Indicates the third-party VAST tag creative requires VPAID (Digital Video |
| 1398 | # Player-Ad Interface). |
| 1399 | # |
| 1400 | # Output only and only valid for third-party VAST tag creatives. |
| 1401 | # |
| 1402 | # Third-party VAST tag creatives are creatives with following |
| 1403 | # hosting_source: |
| 1404 | # |
| 1405 | # * `HOSTING_SOURCE_THIRD_PARTY` |
| 1406 | # |
| 1407 | # combined with following creative_type: |
| 1408 | # |
| 1409 | # * `CREATIVE_TYPE_VIDEO` |
| 1410 | "expandingDirection": "A String", # Optional. Specifies the expanding direction of the creative. |
| 1411 | # |
| 1412 | # Required and only valid for third-party expandable creatives. |
| 1413 | # |
| 1414 | # Third-party expandable creatives are creatives with following hosting |
| 1415 | # source: |
| 1416 | # |
| 1417 | # * `HOSTING_SOURCE_THIRD_PARTY` |
| 1418 | # |
| 1419 | # combined with following creative_type: |
| 1420 | # |
| 1421 | # * `CREATIVE_TYPE_EXPANDABLE` |
| 1422 | "thirdPartyTag": "A String", # Optional. The original third-party tag used for the creative. |
| 1423 | # |
| 1424 | # Required and only valid for third-party tag creatives. |
| 1425 | # |
| 1426 | # Third-party tag creatives are creatives with following |
| 1427 | # hosting_source: |
| 1428 | # |
| 1429 | # * `HOSTING_SOURCE_THIRD_PARTY` |
| 1430 | # |
| 1431 | # combined with following creative_type: |
| 1432 | # |
| 1433 | # * `CREATIVE_TYPE_STANDARD` |
| 1434 | # * `CREATIVE_TYPE_EXPANDABLE` |
| 1435 | "displayName": "A String", # Required. The display name of the creative. |
| 1436 | # |
| 1437 | # Must be UTF-8 encoded with a maximum size of 240 bytes. |
| 1438 | "hostingSource": "A String", # Required. Indicates where the creative is hosted. |
| 1439 | "mediaDuration": "A String", # Output only. Media duration of the creative. |
| 1440 | # Applicable when creative_type |
| 1441 | # is one of: |
| 1442 | # |
| 1443 | # * `CREATIVE_TYPE_VIDEO` |
| 1444 | # * `CREATIVE_TYPE_AUDIO` |
| 1445 | # * `CREATIVE_TYPE_NATIVE_VIDEO` |
| 1446 | # * `CREATIVE_TYPE_PUBLISHER_HOSTED` |
| 1447 | "vastTagUrl": "A String", # Optional. The URL of the VAST tag for a third-party VAST tag creative. |
| 1448 | # |
| 1449 | # Required and only valid for third-party VAST tag creatives. |
| 1450 | # |
| 1451 | # Third-party VAST tag creatives are creatives with following |
| 1452 | # hosting_source: |
| 1453 | # |
| 1454 | # * `HOSTING_SOURCE_THIRD_PARTY` |
| 1455 | # |
| 1456 | # combined with following creative_type: |
| 1457 | # |
| 1458 | # * `CREATIVE_TYPE_VIDEO` |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1459 | "reviewStatus": { # Review statuses for the creative. # Output only. The current status of the creative review process. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 1460 | "approvalStatus": "A String", # Represents the basic approval needed for a creative to begin serving. |
| 1461 | # Summary of |
| 1462 | # creative_and_landing_page_review_status |
| 1463 | # and |
| 1464 | # content_and_policy_review_status. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1465 | "creativeAndLandingPageReviewStatus": "A String", # Creative and landing page review status for the creative. |
| 1466 | "exchangeReviewStatuses": [ # Exchange review statuses for the creative. |
| 1467 | { # Exchange review status for the creative. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1468 | "status": "A String", # Status of the exchange review. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 1469 | "exchange": "A String", # The exchange reviewing the creative. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1470 | }, |
| 1471 | ], |
| 1472 | "contentAndPolicyReviewStatus": "A String", # Content and policy review status for the creative. |
| 1473 | "publisherReviewStatuses": [ # Publisher review statuses for the creative. |
| 1474 | { # Publisher review status for the creative. |
| 1475 | "status": "A String", # Status of the publisher review. |
| 1476 | "publisherName": "A String", # The publisher reviewing the creative. |
| 1477 | }, |
| 1478 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1479 | }, |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 1480 | "counterEvents": [ # Counter events for a rich media creative. |
| 1481 | # Counters track the number of times that a user interacts with any part of a |
| 1482 | # rich media creative in a specified way (mouse-overs, mouse-outs, clicks, |
| 1483 | # taps, data loading, keyboard entries, etc.). |
| 1484 | # Any event that can be captured in the creative can be recorded as a |
| 1485 | # counter. |
| 1486 | # Leave it empty or unset for creatives containing image assets only. |
| 1487 | { # Counter event of the creative. |
| 1488 | "name": "A String", # Required. The name of the counter event. |
| 1489 | "reportingName": "A String", # Required. The name used to identify this counter event in reports. |
| 1490 | }, |
| 1491 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1492 | "progressOffset": { # The length an audio or a video has been played. # Amount of time to play the video before counting a view. |
| 1493 | # |
| 1494 | # This field is required when skippable is true. |
| 1495 | # |
| 1496 | # This field is only supported for the following |
| 1497 | # creative_type: |
| 1498 | # |
| 1499 | # * `CREATIVE_TYPE_VIDEO` |
| 1500 | "percentage": "A String", # The offset in percentage of the audio or video duration. |
| 1501 | "seconds": "A String", # The offset in seconds from the start of the audio or video. |
| 1502 | }, |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 1503 | "updateTime": "A String", # Output only. The timestamp when the creative was last updated. Assigned by |
| 1504 | # the system. |
| 1505 | "advertiserId": "A String", # Output only. The unique ID of the advertiser the creative belongs to. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1506 | "universalAdId": { # A creative identifier provided by a registry that is unique across all # Optional. An optional creative identifier provided by a registry that is unique |
| 1507 | # across all platforms. |
| 1508 | # |
| 1509 | # Universal Ad ID is part of the VAST 4.0 standard. It can be modified after |
| 1510 | # the creative is created. |
| 1511 | # |
| 1512 | # This field is only supported for the following |
| 1513 | # creative_type: |
| 1514 | # |
| 1515 | # * `CREATIVE_TYPE_VIDEO` |
| 1516 | # platforms. This is part of the VAST 4.0 standard. |
| 1517 | "id": "A String", # The unique creative identifier. |
| 1518 | "registry": "A String", # The registry provides unique creative identifiers. |
| 1519 | }, |
| 1520 | "transcodes": [ # Output only. Audio/Video transcodes. |
| 1521 | # |
| 1522 | # Display & Video 360 transcodes the main asset into a number of alternative |
| 1523 | # versions that use different file formats or have different properties |
| 1524 | # (resolution, audio bit rate, and video bit rate), each designed for |
| 1525 | # specific video players or bandwidths. |
| 1526 | # |
| 1527 | # These transcodes give a publisher's system more options to choose from for |
| 1528 | # each impression on your video and ensures that the appropriate file serves |
| 1529 | # based on the viewer’s connection and screen size. |
| 1530 | # |
| 1531 | # This field is only supported in following |
| 1532 | # creative_type: |
| 1533 | # |
| 1534 | # * `CREATIVE_TYPE_VIDEO` |
| 1535 | # * `CREATIVE_TYPE_NATIVE_VIDEO` |
| 1536 | # * `CREATIVE_TYPE_AUDIO` |
| 1537 | { # Represents information about the transcoded audio or video file. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 1538 | "mimeType": "A String", # The MIME type of the transcoded file. |
| 1539 | "bitRateKbps": "A String", # The transcoding bit rate of the transcoded video, in kilobits per second. |
| 1540 | "dimensions": { # Dimensions. # The dimensions of the transcoded video. |
| 1541 | "heightPixels": 42, # The height in pixels. |
| 1542 | "widthPixels": 42, # The width in pixels. |
| 1543 | }, |
| 1544 | "frameRate": 3.14, # The frame rate of the transcoded video, in frames per second. |
| 1545 | "audioSampleRateHz": "A String", # The sample rate for the audio stream of the transcoded video, or the sample |
| 1546 | # rate for the transcoded audio, in hertz. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1547 | "transcoded": True or False, # Indicates if the transcoding was successful. |
| 1548 | "audioBitRateKbps": "A String", # The bit rate for the audio stream of the transcoded video, or the bit rate |
| 1549 | # for the transcoded audio, in kilobits per second. |
| 1550 | "fileSizeBytes": "A String", # The size of the transcoded file, in bytes. |
| 1551 | "name": "A String", # The name of the transcoded file. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1552 | }, |
| 1553 | ], |
| 1554 | "cmTrackingAd": { # A Campaign Manager tracking ad. # The Campaign Manager tracking ad associated with the creative. |
| 1555 | # |
| 1556 | # Optional for the following creative_type when |
| 1557 | # created by an advertiser that uses both Campaign Manager and third-party ad |
| 1558 | # serving: |
| 1559 | # |
| 1560 | # * `CREATIVE_TYPE_NATIVE` |
| 1561 | # * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` |
| 1562 | # * `CREATIVE_TYPE_NATIVE_APP_INSTALL` |
| 1563 | # * `CREATIVE_TYPE_NATIVE_APP_INSTALL_SQUARE` |
| 1564 | # |
| 1565 | # Output only for other cases. |
| 1566 | "cmCreativeId": "A String", # The creative ID of the campaign manager tracking Ad. |
| 1567 | "cmAdId": "A String", # The ad ID of the campaign manager tracking Ad. |
| 1568 | "cmPlacementId": "A String", # The placement ID of the campaign manager tracking Ad. |
| 1569 | }, |
| 1570 | "html5Video": True or False, # Output only. Indicates the third-party VAST tag creative requires HTML5 Video support. |
| 1571 | # |
| 1572 | # Output only and only valid for third-party VAST tag creatives. |
| 1573 | # |
| 1574 | # Third-party VAST tag creatives are creatives with following |
| 1575 | # hosting_source: |
| 1576 | # |
| 1577 | # * `HOSTING_SOURCE_THIRD_PARTY` |
| 1578 | # |
| 1579 | # combined with following creative_type: |
| 1580 | # |
| 1581 | # * `CREATIVE_TYPE_VIDEO` |
| 1582 | "requirePingForAttribution": True or False, # Optional. Indicates that the creative will wait for a return ping for attribution. |
| 1583 | # |
| 1584 | # Only valid when using a Campaign Manager tracking ad with a third-party ad |
| 1585 | # server parameter and the ${DC_DBM_TOKEN} macro. |
| 1586 | # |
| 1587 | # Optional and only valid for third-party tag creatives or third-party VAST |
| 1588 | # tag creatives. |
| 1589 | # |
| 1590 | # Third-party tag creatives are creatives with following |
| 1591 | # hosting_source: |
| 1592 | # |
| 1593 | # * `HOSTING_SOURCE_THIRD_PARTY` |
| 1594 | # |
| 1595 | # combined with following creative_type: |
| 1596 | # |
| 1597 | # * `CREATIVE_TYPE_STANDARD` |
| 1598 | # * `CREATIVE_TYPE_EXPANDABLE` |
| 1599 | # |
| 1600 | # Third-party VAST tag creatives are creatives with following |
| 1601 | # hosting_source: |
| 1602 | # |
| 1603 | # * `HOSTING_SOURCE_THIRD_PARTY` |
| 1604 | # |
| 1605 | # combined with following creative_type: |
| 1606 | # |
| 1607 | # * `CREATIVE_TYPE_VIDEO` |
| 1608 | "dimensions": { # Dimensions. # Required. Primary dimensions of the creative. |
| 1609 | # Applicable to all creative types. The value of |
| 1610 | # width_pixels and |
| 1611 | # height_pixels defaults to `0` |
| 1612 | # when creative_type is one of: |
| 1613 | # |
| 1614 | # * `CREATIVE_TYPE_VIDEO` |
| 1615 | # * `CREATIVE_TYPE_TEMPLATED_APP_INSTALL_INTERSTITIAL` |
| 1616 | # * `CREATIVE_TYPE_AUDIO` |
| 1617 | # * `CREATIVE_TYPE_NATIVE_VIDEO` |
| 1618 | # * `CREATIVE_TYPE_TEMPLATED_APP_INSTALL_VIDEO` |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1619 | "heightPixels": 42, # The height in pixels. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 1620 | "widthPixels": 42, # The width in pixels. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1621 | }, |
| 1622 | "appendedTag": "A String", # Third-party HTML tracking tag to be appended to the creative tag. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1623 | }</pre> |
| 1624 | </div> |
| 1625 | |
| 1626 | <div class="method"> |
| 1627 | <code class="details" id="list">list(advertiserId, filter=None, pageToken=None, orderBy=None, pageSize=None, x__xgafv=None)</code> |
| 1628 | <pre>Lists creatives in an advertiser. |
| 1629 | |
| 1630 | The order is defined by the order_by |
| 1631 | parameter. |
| 1632 | If a filter by |
| 1633 | entity_status is not specified, creatives with |
| 1634 | `ENTITY_STATUS_ARCHIVED` will not be included in the results. |
| 1635 | |
| 1636 | Args: |
| 1637 | advertiserId: string, Required. The ID of the advertiser to list creatives for. (required) |
| 1638 | filter: string, Allows filtering by creative properties. |
| 1639 | |
| 1640 | Supported syntax: |
| 1641 | |
| 1642 | * Filter expressions are made up of one or more restrictions. |
| 1643 | * Restriction for the same field must be combined by `OR`. |
| 1644 | * Restriction for different fields must be combined by `AND`. |
| 1645 | * Between `(` and `)` there can only be restrictions combined by `OR` |
| 1646 | for the same field. |
| 1647 | * A restriction has the form of `{field} {operator} {value}`. |
| 1648 | * The operator must be `EQUALS (=)` for the following fields: |
| 1649 | - `entityStatus` |
| 1650 | - `creativeType`. |
| 1651 | - `dimensions` |
| 1652 | - `minDuration` |
| 1653 | - `maxDuration` |
| 1654 | - `approvalStatus` |
| 1655 | - `exchangeReviewStatus` |
| 1656 | - `dynamic` |
| 1657 | * The operator must be `HAS (:)` for the following fields: |
| 1658 | - `lineItemIds` |
| 1659 | * For `entityStatus`, `minDuration`, `maxDuration`, and `dynamic` there may |
| 1660 | be at most one restriction. |
| 1661 | * For `dimensions`, the value is in the form of `"{width}x{height}"`. |
| 1662 | * For `exchangeReviewStatus`, the value is in the form of |
| 1663 | `{exchange}-{reviewStatus}`. |
| 1664 | * For `minDuration` and `maxDuration`, the value is in the form of |
| 1665 | `"{duration}s"`. Only seconds are supported with millisecond granularity. |
| 1666 | * There may be multiple `lineItemIds` restrictions in order to search |
| 1667 | against multiple possible line item IDs. |
| 1668 | |
| 1669 | Examples: |
| 1670 | |
| 1671 | * All native creatives: `creativeType="CREATIVE_TYPE_NATIVE"` |
| 1672 | * All active creatives with 300x400 or 50x100 dimensions: |
| 1673 | `entityStatus="ENTITY_STATUS_ACTIVE" AND (dimensions="300x400" |
| 1674 | OR dimensions="50x100")` |
| 1675 | * All dynamic creatives that are approved by AdX or |
| 1676 | AppNexus, with a minimum duration of 5 seconds and 200ms. |
| 1677 | `dynamic="true" AND minDuration="5.2s" AND |
| 1678 | (exchangeReviewStatus="EXCHANGE_GOOGLE_AD_MANAGER-REVIEW_STATUS_APPROVED" |
| 1679 | OR exchangeReviewStatus="EXCHANGE_APPNEXUS-REVIEW_STATUS_APPROVED")` |
| 1680 | * All video creatives that are associated with line item ID 1 or 2: |
| 1681 | creativeType="CREATIVE_TYPE_VIDEO" AND (lineItemIds:1 OR lineItemIds:2) |
| 1682 | |
| 1683 | The length of this field should be no more than 500 characters. |
| 1684 | pageToken: string, A token identifying a page of results the server should return. |
| 1685 | Typically, this is the value of |
| 1686 | next_page_token |
| 1687 | returned from the previous call to `ListCreatives` method. |
| 1688 | If not specified, the first page of results will be returned. |
| 1689 | orderBy: string, Field by which to sort the list. |
| 1690 | Acceptable values are: |
| 1691 | |
| 1692 | * `creativeId` (default) |
| 1693 | * `createTime` |
| 1694 | * `mediaDuration` |
| 1695 | * `dimensions` (sorts by width first, then by height) |
| 1696 | |
| 1697 | The default sorting order is ascending. To specify descending order for |
| 1698 | a field, a suffix "desc" should be added to the field name. |
| 1699 | Example: `createTime desc`. |
| 1700 | pageSize: integer, Requested page size. Must be between `1` and `100`. If unspecified will |
| 1701 | default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value |
| 1702 | is specified. |
| 1703 | x__xgafv: string, V1 error format. |
| 1704 | Allowed values |
| 1705 | 1 - v1 error format |
| 1706 | 2 - v2 error format |
| 1707 | |
| 1708 | Returns: |
| 1709 | An object of the form: |
| 1710 | |
| 1711 | { |
| 1712 | "creatives": [ # The list of creatives. |
| 1713 | # |
| 1714 | # This list will be absent if empty. |
| 1715 | { # A single Creative. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 1716 | "creativeAttributes": [ # Output only. A list of attributes of the creative that is generated by the system. |
| 1717 | "A String", |
| 1718 | ], |
| 1719 | "creativeId": "A String", # Output only. The unique ID of the creative. Assigned by the system. |
| 1720 | "entityStatus": "A String", # Required. Controls whether or not the creative can serve. |
| 1721 | # |
| 1722 | # Accepted values are: |
| 1723 | # |
| 1724 | # * `ENTITY_STATUS_ACTIVE` |
| 1725 | # * `ENTITY_STATUS_ARCHIVED` |
| 1726 | # * `ENTITY_STATUS_PAUSED` |
| 1727 | "skipOffset": { # The length an audio or a video has been played. # Amount of time to play the video before the skip button appears. |
| 1728 | # |
| 1729 | # This field is required when skippable is true. |
| 1730 | # |
| 1731 | # This field is only supported for the following |
| 1732 | # creative_type: |
| 1733 | # |
| 1734 | # * `CREATIVE_TYPE_VIDEO` |
| 1735 | "percentage": "A String", # The offset in percentage of the audio or video duration. |
| 1736 | "seconds": "A String", # The offset in seconds from the start of the audio or video. |
| 1737 | }, |
| 1738 | "requireHtml5": True or False, # Optional. Indicates that the creative relies on HTML5 to render properly. |
| 1739 | # |
| 1740 | # Optional and only valid for third-party tag creatives. |
| 1741 | # Third-party tag creatives are creatives with following |
| 1742 | # hosting_source: |
| 1743 | # |
| 1744 | # * `HOSTING_SOURCE_THIRD_PARTY` |
| 1745 | # |
| 1746 | # combined with following creative_type: |
| 1747 | # |
| 1748 | # * `CREATIVE_TYPE_STANDARD` |
| 1749 | # * `CREATIVE_TYPE_EXPANDABLE` |
| 1750 | "name": "A String", # Output only. The resource name of the creative. |
| 1751 | "skippable": True or False, # Whether the user can choose to skip a video creative. |
| 1752 | # |
| 1753 | # This field is only supported for the following |
| 1754 | # creative_type: |
| 1755 | # |
| 1756 | # * `CREATIVE_TYPE_VIDEO` |
| 1757 | "jsTrackerUrl": "A String", # JavaScript measurement URL from supported third-party verification |
| 1758 | # providers (ComScore, DoubleVerify, IAS, Moat). HTML script tags are not |
| 1759 | # supported. |
| 1760 | # |
| 1761 | # This field is only supported in following |
| 1762 | # creative_type: |
| 1763 | # |
| 1764 | # * `CREATIVE_TYPE_NATIVE` |
| 1765 | # * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` |
| 1766 | # * `CREATIVE_TYPE_NATIVE_APP_INSTALL` |
| 1767 | # * `CREATIVE_TYPE_NATIVE_APP_INSTALL_SQUARE` |
| 1768 | # * `CREATIVE_TYPE_NATIVE_VIDEO` |
| 1769 | "thirdPartyUrls": [ # Tracking URLs from third parties to track interactions with a video |
| 1770 | # creative. |
| 1771 | # |
| 1772 | # This field is only supported for the following |
| 1773 | # creative_type: |
| 1774 | # |
| 1775 | # * `CREATIVE_TYPE_AUDIO` |
| 1776 | # * `CREATIVE_TYPE_VIDEO` |
| 1777 | # * `CREATIVE_TYPE_NATIVE_VIDEO` |
| 1778 | { # Tracking URLs from third parties to track interactions with an audio or a |
| 1779 | # video creative. |
| 1780 | "type": "A String", # The type of interaction needs to be tracked by the tracking URL |
| 1781 | "url": "A String", # Tracking URL used to track the interaction. |
| 1782 | # |
| 1783 | # Provide a URL with optional path or query string, beginning with `https:`. |
| 1784 | # For example, https://www.example.com/path |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1785 | }, |
| 1786 | ], |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 1787 | "expandOnHover": True or False, # Optional. Indicates the creative will automatically expand on hover. |
| 1788 | # |
| 1789 | # Optional and only valid for third-party expandable creatives. |
| 1790 | # Third-party expandable creatives are creatives with following hosting |
| 1791 | # source: |
| 1792 | # |
| 1793 | # * `HOSTING_SOURCE_THIRD_PARTY` |
| 1794 | # |
| 1795 | # combined with following creative_type: |
| 1796 | # |
| 1797 | # * `CREATIVE_TYPE_EXPANDABLE` |
| 1798 | "exitEvents": [ # Required. Exit events for this creative. |
| 1799 | # An exit (also known as a click tag) is any area in your creative that |
| 1800 | # someone can click or tap to open an advertiser's landing page. |
| 1801 | # Every creative must include at least one exit. |
| 1802 | # You can add an exit to your creative in any of the following ways: |
| 1803 | # |
| 1804 | # * Use Google Web Designer's tap area. |
| 1805 | # * Define a JavaScript variable called "clickTag". |
| 1806 | # * Use the Enabler (Enabler.exit()) to track exits in rich media formats. |
| 1807 | { # Exit event of the creative. |
| 1808 | "url": "A String", # Required. The click through URL of the exit event. |
| 1809 | # This is required when type is: |
| 1810 | # |
| 1811 | # * `EXIT_EVENT_TYPE_DEFAULT` |
| 1812 | # * `EXIT_EVENT_TYPE_BACKUP` |
| 1813 | "name": "A String", # The name of the click tag of the exit event. |
| 1814 | # |
| 1815 | # The name must be unique within one creative. |
| 1816 | # |
| 1817 | # Leave it empty or unset for creatives containing image assets only. |
| 1818 | "type": "A String", # Required. The type of the exit event. |
| 1819 | "reportingName": "A String", # The name used to identify this event in reports. |
| 1820 | # Leave it empty or unset for creatives containing image assets only. |
| 1821 | }, |
| 1822 | ], |
| 1823 | "additionalDimensions": [ # Additional dimensions. |
| 1824 | # Applicable when creative_type is one of: |
| 1825 | # |
| 1826 | # * `CREATIVE_TYPE_STANDARD` |
| 1827 | # * `CREATIVE_TYPE_EXPANDABLE` |
| 1828 | # * `CREATIVE_TYPE_NATIVE` |
| 1829 | # * `CREATIVE_TYPE_TEMPLATED_APP_INSTALL` |
| 1830 | # * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` |
| 1831 | # * `CREATIVE_TYPE_LIGHTBOX` |
| 1832 | # * `CREATIVE_TYPE_NATIVE_APP_INSTALL` |
| 1833 | # * `CREATIVE_TYPE_NATIVE_APP_INSTALL_SQUARE` |
| 1834 | # * `CREATIVE_TYPE_PUBLISHER_HOSTED` |
| 1835 | # |
| 1836 | # If this field is specified, width_pixels and |
| 1837 | # height_pixels are both required and must be |
| 1838 | # greater than or equal to 0. |
| 1839 | { # Dimensions. |
| 1840 | "heightPixels": 42, # The height in pixels. |
| 1841 | "widthPixels": 42, # The width in pixels. |
| 1842 | }, |
| 1843 | ], |
| 1844 | "createTime": "A String", # Output only. The timestamp when the creative was created. Assigned by |
| 1845 | # the system. |
| 1846 | "trackerUrls": [ # Tracking URLs for analytics providers or third-party ad technology vendors. |
| 1847 | # |
| 1848 | # The URLs must start with https (except on inventory that doesn't require |
| 1849 | # SSL compliance). |
| 1850 | # If using macros in your URL, use only macros supported by Display & Video |
| 1851 | # 360. |
| 1852 | # |
| 1853 | # Standard URLs only, no IMG or SCRIPT tags. |
| 1854 | # |
| 1855 | # This field is only supported in following |
| 1856 | # creative_type: |
| 1857 | # |
| 1858 | # * `CREATIVE_TYPE_NATIVE` |
| 1859 | # * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` |
| 1860 | # * `CREATIVE_TYPE_NATIVE_APP_INSTALL` |
| 1861 | # * `CREATIVE_TYPE_NATIVE_APP_INSTALL_SQUARE` |
| 1862 | # * `CREATIVE_TYPE_NATIVE_VIDEO` |
| 1863 | "A String", |
| 1864 | ], |
| 1865 | "iasCampaignMonitoring": True or False, # Indicates whether Integral Ad Science (IAS) campaign monitoring is enabled. |
| 1866 | # To enable this for the creative, make sure the |
| 1867 | # Advertiser.creative_config.ias_client_id |
| 1868 | # has been set to your IAS client ID. |
| 1869 | "integrationCode": "A String", # ID information used to link this creative to an external system. |
| 1870 | # Must be UTF-8 encoded with a length of no more than 10,000 characters. |
| 1871 | "cmPlacementId": "A String", # Output only. The unique ID of the Campaign Manager placement associated with the |
| 1872 | # creative. |
| 1873 | # This field is only applicable for creatives that are synced from Campaign |
| 1874 | # Manager. |
| 1875 | "requireMraid": True or False, # Optional. Indicates that the creative requires MRAID (Mobile Rich Media Ad Interface |
| 1876 | # Definitions system). |
| 1877 | # |
| 1878 | # Set this if the creative relies on mobile gestures for interactivity, such |
| 1879 | # as swiping or tapping. |
| 1880 | # |
| 1881 | # Optional and only valid for third-party tag creatives. |
| 1882 | # |
| 1883 | # Third-party tag creatives are creatives with following |
| 1884 | # hosting_source: |
| 1885 | # |
| 1886 | # * `HOSTING_SOURCE_THIRD_PARTY` |
| 1887 | # |
| 1888 | # combined with following creative_type: |
| 1889 | # |
| 1890 | # * `CREATIVE_TYPE_STANDARD` |
| 1891 | # * `CREATIVE_TYPE_EXPANDABLE` |
| 1892 | "companionCreativeIds": [ # The IDs of companion creatives for a video creative. |
| 1893 | # |
| 1894 | # You can assign existing display creatives (with image or HTML5 assets) |
| 1895 | # to serve surrounding the publisher's video player. Companions display |
| 1896 | # around the video player while the video is playing and remain after the |
| 1897 | # video has completed. |
| 1898 | # |
| 1899 | # Creatives contain additional dimensions |
| 1900 | # can not be companion creatives. |
| 1901 | # |
| 1902 | # This field is only supported for following |
| 1903 | # creative_type: |
| 1904 | # |
| 1905 | # * `CREATIVE_TYPE_AUDIO` |
| 1906 | # * `CREATIVE_TYPE_VIDEO` |
| 1907 | "A String", |
| 1908 | ], |
| 1909 | "creativeType": "A String", # Required. Immutable. The type of the creative. |
| 1910 | "obaIcon": { # OBA Icon for a Creative # Specifies the OBA icon for a video creative. |
| 1911 | # |
| 1912 | # This field is only supported in following |
| 1913 | # creative_type: |
| 1914 | # |
| 1915 | # * `CREATIVE_TYPE_VIDEO` |
| 1916 | "dimensions": { # Dimensions. # The dimensions of the OBA icon. |
| 1917 | "heightPixels": 42, # The height in pixels. |
| 1918 | "widthPixels": 42, # The width in pixels. |
| 1919 | }, |
| 1920 | "resourceMimeType": "A String", # The MIME type of the OBA icon resource. |
| 1921 | "viewTrackingUrl": "A String", # Required. The view tracking URL of the OBA icon. |
| 1922 | # |
| 1923 | # Only URLs of the following domains are allowed: |
| 1924 | # |
| 1925 | # * https://info.evidon.com |
| 1926 | # * https://l.betrad.com |
| 1927 | "clickTrackingUrl": "A String", # Required. The click tracking URL of the OBA icon. |
| 1928 | # |
| 1929 | # Only URLs of the following domains are allowed: |
| 1930 | # |
| 1931 | # * https://info.evidon.com |
| 1932 | # * https://l.betrad.com |
| 1933 | "position": "A String", # The position of the OBA icon on the creative. |
| 1934 | "resourceUrl": "A String", # The URL of the OBA icon resource. |
| 1935 | "landingPageUrl": "A String", # Required. The landing page URL of the OBA icon. |
| 1936 | # |
| 1937 | # Only URLs of the following domains are allowed: |
| 1938 | # |
| 1939 | # * https://info.evidon.com |
| 1940 | # * https://l.betrad.com |
| 1941 | "program": "A String", # The program of the OBA icon. For example: “AdChoices”. |
| 1942 | }, |
| 1943 | "timerEvents": [ # Timer custom events for a rich media creative. |
| 1944 | # Timers track the time during which a user views and interacts with a |
| 1945 | # specified part of a rich media creative. |
| 1946 | # A creative can have multiple timer events, each timed independently. |
| 1947 | # Leave it empty or unset for creatives containing image assets only. |
| 1948 | { # Timer event of the creative. |
| 1949 | "name": "A String", # Required. The name of the timer event. |
| 1950 | "reportingName": "A String", # Required. The name used to identify this timer event in reports. |
| 1951 | }, |
| 1952 | ], |
| 1953 | "notes": "A String", # User notes for this creative. |
| 1954 | # Must be UTF-8 encoded with a length of no more than 20,000 characters. |
| 1955 | "dynamic": True or False, # Output only. Indicates whether the creative is dynamic. |
| 1956 | "assets": [ # Required. Assets associated to this creative. |
| 1957 | # Assets can be associated to the creative in one of following roles: |
| 1958 | # |
| 1959 | # * `ASSET_ROLE_UNSPECIFIED` |
| 1960 | # * `ASSET_ROLE_MAIN` |
| 1961 | # * `ASSET_ROLE_BACKUP` |
| 1962 | # * `ASSET_ROLE_POLITE_LOAD` |
| 1963 | { # Asset association for the creative. |
| 1964 | "asset": { # A single asset. # The associated asset. |
| 1965 | "mediaId": "A String", # Media ID of the uploaded asset. This is a unique identifier for the asset. |
| 1966 | # This ID can be passed to other API calls, e.g. |
| 1967 | # CreateCreative to associate |
| 1968 | # the asset with a creative. |
| 1969 | "content": "A String", # The asset content. |
| 1970 | # For uploaded assets, the content is the serving path. |
| 1971 | }, |
| 1972 | "role": "A String", # The role of this asset for the creative. |
| 1973 | }, |
| 1974 | ], |
| 1975 | "vpaid": True or False, # Output only. Indicates the third-party VAST tag creative requires VPAID (Digital Video |
| 1976 | # Player-Ad Interface). |
| 1977 | # |
| 1978 | # Output only and only valid for third-party VAST tag creatives. |
| 1979 | # |
| 1980 | # Third-party VAST tag creatives are creatives with following |
| 1981 | # hosting_source: |
| 1982 | # |
| 1983 | # * `HOSTING_SOURCE_THIRD_PARTY` |
| 1984 | # |
| 1985 | # combined with following creative_type: |
| 1986 | # |
| 1987 | # * `CREATIVE_TYPE_VIDEO` |
| 1988 | "expandingDirection": "A String", # Optional. Specifies the expanding direction of the creative. |
| 1989 | # |
| 1990 | # Required and only valid for third-party expandable creatives. |
| 1991 | # |
| 1992 | # Third-party expandable creatives are creatives with following hosting |
| 1993 | # source: |
| 1994 | # |
| 1995 | # * `HOSTING_SOURCE_THIRD_PARTY` |
| 1996 | # |
| 1997 | # combined with following creative_type: |
| 1998 | # |
| 1999 | # * `CREATIVE_TYPE_EXPANDABLE` |
| 2000 | "thirdPartyTag": "A String", # Optional. The original third-party tag used for the creative. |
| 2001 | # |
| 2002 | # Required and only valid for third-party tag creatives. |
| 2003 | # |
| 2004 | # Third-party tag creatives are creatives with following |
| 2005 | # hosting_source: |
| 2006 | # |
| 2007 | # * `HOSTING_SOURCE_THIRD_PARTY` |
| 2008 | # |
| 2009 | # combined with following creative_type: |
| 2010 | # |
| 2011 | # * `CREATIVE_TYPE_STANDARD` |
| 2012 | # * `CREATIVE_TYPE_EXPANDABLE` |
| 2013 | "displayName": "A String", # Required. The display name of the creative. |
| 2014 | # |
| 2015 | # Must be UTF-8 encoded with a maximum size of 240 bytes. |
| 2016 | "hostingSource": "A String", # Required. Indicates where the creative is hosted. |
| 2017 | "mediaDuration": "A String", # Output only. Media duration of the creative. |
| 2018 | # Applicable when creative_type |
| 2019 | # is one of: |
| 2020 | # |
| 2021 | # * `CREATIVE_TYPE_VIDEO` |
| 2022 | # * `CREATIVE_TYPE_AUDIO` |
| 2023 | # * `CREATIVE_TYPE_NATIVE_VIDEO` |
| 2024 | # * `CREATIVE_TYPE_PUBLISHER_HOSTED` |
| 2025 | "vastTagUrl": "A String", # Optional. The URL of the VAST tag for a third-party VAST tag creative. |
| 2026 | # |
| 2027 | # Required and only valid for third-party VAST tag creatives. |
| 2028 | # |
| 2029 | # Third-party VAST tag creatives are creatives with following |
| 2030 | # hosting_source: |
| 2031 | # |
| 2032 | # * `HOSTING_SOURCE_THIRD_PARTY` |
| 2033 | # |
| 2034 | # combined with following creative_type: |
| 2035 | # |
| 2036 | # * `CREATIVE_TYPE_VIDEO` |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2037 | "reviewStatus": { # Review statuses for the creative. # Output only. The current status of the creative review process. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 2038 | "approvalStatus": "A String", # Represents the basic approval needed for a creative to begin serving. |
| 2039 | # Summary of |
| 2040 | # creative_and_landing_page_review_status |
| 2041 | # and |
| 2042 | # content_and_policy_review_status. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2043 | "creativeAndLandingPageReviewStatus": "A String", # Creative and landing page review status for the creative. |
| 2044 | "exchangeReviewStatuses": [ # Exchange review statuses for the creative. |
| 2045 | { # Exchange review status for the creative. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2046 | "status": "A String", # Status of the exchange review. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 2047 | "exchange": "A String", # The exchange reviewing the creative. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2048 | }, |
| 2049 | ], |
| 2050 | "contentAndPolicyReviewStatus": "A String", # Content and policy review status for the creative. |
| 2051 | "publisherReviewStatuses": [ # Publisher review statuses for the creative. |
| 2052 | { # Publisher review status for the creative. |
| 2053 | "status": "A String", # Status of the publisher review. |
| 2054 | "publisherName": "A String", # The publisher reviewing the creative. |
| 2055 | }, |
| 2056 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2057 | }, |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 2058 | "counterEvents": [ # Counter events for a rich media creative. |
| 2059 | # Counters track the number of times that a user interacts with any part of a |
| 2060 | # rich media creative in a specified way (mouse-overs, mouse-outs, clicks, |
| 2061 | # taps, data loading, keyboard entries, etc.). |
| 2062 | # Any event that can be captured in the creative can be recorded as a |
| 2063 | # counter. |
| 2064 | # Leave it empty or unset for creatives containing image assets only. |
| 2065 | { # Counter event of the creative. |
| 2066 | "name": "A String", # Required. The name of the counter event. |
| 2067 | "reportingName": "A String", # Required. The name used to identify this counter event in reports. |
| 2068 | }, |
| 2069 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2070 | "progressOffset": { # The length an audio or a video has been played. # Amount of time to play the video before counting a view. |
| 2071 | # |
| 2072 | # This field is required when skippable is true. |
| 2073 | # |
| 2074 | # This field is only supported for the following |
| 2075 | # creative_type: |
| 2076 | # |
| 2077 | # * `CREATIVE_TYPE_VIDEO` |
| 2078 | "percentage": "A String", # The offset in percentage of the audio or video duration. |
| 2079 | "seconds": "A String", # The offset in seconds from the start of the audio or video. |
| 2080 | }, |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 2081 | "updateTime": "A String", # Output only. The timestamp when the creative was last updated. Assigned by |
| 2082 | # the system. |
| 2083 | "advertiserId": "A String", # Output only. The unique ID of the advertiser the creative belongs to. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2084 | "universalAdId": { # A creative identifier provided by a registry that is unique across all # Optional. An optional creative identifier provided by a registry that is unique |
| 2085 | # across all platforms. |
| 2086 | # |
| 2087 | # Universal Ad ID is part of the VAST 4.0 standard. It can be modified after |
| 2088 | # the creative is created. |
| 2089 | # |
| 2090 | # This field is only supported for the following |
| 2091 | # creative_type: |
| 2092 | # |
| 2093 | # * `CREATIVE_TYPE_VIDEO` |
| 2094 | # platforms. This is part of the VAST 4.0 standard. |
| 2095 | "id": "A String", # The unique creative identifier. |
| 2096 | "registry": "A String", # The registry provides unique creative identifiers. |
| 2097 | }, |
| 2098 | "transcodes": [ # Output only. Audio/Video transcodes. |
| 2099 | # |
| 2100 | # Display & Video 360 transcodes the main asset into a number of alternative |
| 2101 | # versions that use different file formats or have different properties |
| 2102 | # (resolution, audio bit rate, and video bit rate), each designed for |
| 2103 | # specific video players or bandwidths. |
| 2104 | # |
| 2105 | # These transcodes give a publisher's system more options to choose from for |
| 2106 | # each impression on your video and ensures that the appropriate file serves |
| 2107 | # based on the viewer’s connection and screen size. |
| 2108 | # |
| 2109 | # This field is only supported in following |
| 2110 | # creative_type: |
| 2111 | # |
| 2112 | # * `CREATIVE_TYPE_VIDEO` |
| 2113 | # * `CREATIVE_TYPE_NATIVE_VIDEO` |
| 2114 | # * `CREATIVE_TYPE_AUDIO` |
| 2115 | { # Represents information about the transcoded audio or video file. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 2116 | "mimeType": "A String", # The MIME type of the transcoded file. |
| 2117 | "bitRateKbps": "A String", # The transcoding bit rate of the transcoded video, in kilobits per second. |
| 2118 | "dimensions": { # Dimensions. # The dimensions of the transcoded video. |
| 2119 | "heightPixels": 42, # The height in pixels. |
| 2120 | "widthPixels": 42, # The width in pixels. |
| 2121 | }, |
| 2122 | "frameRate": 3.14, # The frame rate of the transcoded video, in frames per second. |
| 2123 | "audioSampleRateHz": "A String", # The sample rate for the audio stream of the transcoded video, or the sample |
| 2124 | # rate for the transcoded audio, in hertz. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2125 | "transcoded": True or False, # Indicates if the transcoding was successful. |
| 2126 | "audioBitRateKbps": "A String", # The bit rate for the audio stream of the transcoded video, or the bit rate |
| 2127 | # for the transcoded audio, in kilobits per second. |
| 2128 | "fileSizeBytes": "A String", # The size of the transcoded file, in bytes. |
| 2129 | "name": "A String", # The name of the transcoded file. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2130 | }, |
| 2131 | ], |
| 2132 | "cmTrackingAd": { # A Campaign Manager tracking ad. # The Campaign Manager tracking ad associated with the creative. |
| 2133 | # |
| 2134 | # Optional for the following creative_type when |
| 2135 | # created by an advertiser that uses both Campaign Manager and third-party ad |
| 2136 | # serving: |
| 2137 | # |
| 2138 | # * `CREATIVE_TYPE_NATIVE` |
| 2139 | # * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` |
| 2140 | # * `CREATIVE_TYPE_NATIVE_APP_INSTALL` |
| 2141 | # * `CREATIVE_TYPE_NATIVE_APP_INSTALL_SQUARE` |
| 2142 | # |
| 2143 | # Output only for other cases. |
| 2144 | "cmCreativeId": "A String", # The creative ID of the campaign manager tracking Ad. |
| 2145 | "cmAdId": "A String", # The ad ID of the campaign manager tracking Ad. |
| 2146 | "cmPlacementId": "A String", # The placement ID of the campaign manager tracking Ad. |
| 2147 | }, |
| 2148 | "html5Video": True or False, # Output only. Indicates the third-party VAST tag creative requires HTML5 Video support. |
| 2149 | # |
| 2150 | # Output only and only valid for third-party VAST tag creatives. |
| 2151 | # |
| 2152 | # Third-party VAST tag creatives are creatives with following |
| 2153 | # hosting_source: |
| 2154 | # |
| 2155 | # * `HOSTING_SOURCE_THIRD_PARTY` |
| 2156 | # |
| 2157 | # combined with following creative_type: |
| 2158 | # |
| 2159 | # * `CREATIVE_TYPE_VIDEO` |
| 2160 | "requirePingForAttribution": True or False, # Optional. Indicates that the creative will wait for a return ping for attribution. |
| 2161 | # |
| 2162 | # Only valid when using a Campaign Manager tracking ad with a third-party ad |
| 2163 | # server parameter and the ${DC_DBM_TOKEN} macro. |
| 2164 | # |
| 2165 | # Optional and only valid for third-party tag creatives or third-party VAST |
| 2166 | # tag creatives. |
| 2167 | # |
| 2168 | # Third-party tag creatives are creatives with following |
| 2169 | # hosting_source: |
| 2170 | # |
| 2171 | # * `HOSTING_SOURCE_THIRD_PARTY` |
| 2172 | # |
| 2173 | # combined with following creative_type: |
| 2174 | # |
| 2175 | # * `CREATIVE_TYPE_STANDARD` |
| 2176 | # * `CREATIVE_TYPE_EXPANDABLE` |
| 2177 | # |
| 2178 | # Third-party VAST tag creatives are creatives with following |
| 2179 | # hosting_source: |
| 2180 | # |
| 2181 | # * `HOSTING_SOURCE_THIRD_PARTY` |
| 2182 | # |
| 2183 | # combined with following creative_type: |
| 2184 | # |
| 2185 | # * `CREATIVE_TYPE_VIDEO` |
| 2186 | "dimensions": { # Dimensions. # Required. Primary dimensions of the creative. |
| 2187 | # Applicable to all creative types. The value of |
| 2188 | # width_pixels and |
| 2189 | # height_pixels defaults to `0` |
| 2190 | # when creative_type is one of: |
| 2191 | # |
| 2192 | # * `CREATIVE_TYPE_VIDEO` |
| 2193 | # * `CREATIVE_TYPE_TEMPLATED_APP_INSTALL_INTERSTITIAL` |
| 2194 | # * `CREATIVE_TYPE_AUDIO` |
| 2195 | # * `CREATIVE_TYPE_NATIVE_VIDEO` |
| 2196 | # * `CREATIVE_TYPE_TEMPLATED_APP_INSTALL_VIDEO` |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2197 | "heightPixels": 42, # The height in pixels. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 2198 | "widthPixels": 42, # The width in pixels. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2199 | }, |
| 2200 | "appendedTag": "A String", # Third-party HTML tracking tag to be appended to the creative tag. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2201 | }, |
| 2202 | ], |
| 2203 | "nextPageToken": "A String", # A token to retrieve the next page of results. |
| 2204 | # Pass this value in the page_token field |
| 2205 | # in the subsequent call to `ListCreativesRequest` method to retrieve the |
| 2206 | # next page of results. |
| 2207 | # If this field is null, it means this is the last page. |
| 2208 | }</pre> |
| 2209 | </div> |
| 2210 | |
| 2211 | <div class="method"> |
| 2212 | <code class="details" id="list_next">list_next(previous_request, previous_response)</code> |
| 2213 | <pre>Retrieves the next page of results. |
| 2214 | |
| 2215 | Args: |
| 2216 | previous_request: The request for the previous page. (required) |
| 2217 | previous_response: The response from the request for the previous page. (required) |
| 2218 | |
| 2219 | Returns: |
| 2220 | A request object that you can call 'execute()' on to request the next |
| 2221 | page. Returns None if there are no more items in the collection. |
| 2222 | </pre> |
| 2223 | </div> |
| 2224 | |
| 2225 | <div class="method"> |
| 2226 | <code class="details" id="patch">patch(advertiserId, creativeId, body=None, updateMask=None, x__xgafv=None)</code> |
| 2227 | <pre>Updates an existing creative. |
| 2228 | Returns the updated creative if successful. |
| 2229 | |
| 2230 | Args: |
| 2231 | advertiserId: string, Output only. The unique ID of the advertiser the creative belongs to. (required) |
| 2232 | creativeId: string, Output only. The unique ID of the creative. Assigned by the system. (required) |
| 2233 | body: object, The request body. |
| 2234 | The object takes the form of: |
| 2235 | |
| 2236 | { # A single Creative. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 2237 | "creativeAttributes": [ # Output only. A list of attributes of the creative that is generated by the system. |
| 2238 | "A String", |
| 2239 | ], |
| 2240 | "creativeId": "A String", # Output only. The unique ID of the creative. Assigned by the system. |
| 2241 | "entityStatus": "A String", # Required. Controls whether or not the creative can serve. |
| 2242 | # |
| 2243 | # Accepted values are: |
| 2244 | # |
| 2245 | # * `ENTITY_STATUS_ACTIVE` |
| 2246 | # * `ENTITY_STATUS_ARCHIVED` |
| 2247 | # * `ENTITY_STATUS_PAUSED` |
| 2248 | "skipOffset": { # The length an audio or a video has been played. # Amount of time to play the video before the skip button appears. |
| 2249 | # |
| 2250 | # This field is required when skippable is true. |
| 2251 | # |
| 2252 | # This field is only supported for the following |
| 2253 | # creative_type: |
| 2254 | # |
| 2255 | # * `CREATIVE_TYPE_VIDEO` |
| 2256 | "percentage": "A String", # The offset in percentage of the audio or video duration. |
| 2257 | "seconds": "A String", # The offset in seconds from the start of the audio or video. |
| 2258 | }, |
| 2259 | "requireHtml5": True or False, # Optional. Indicates that the creative relies on HTML5 to render properly. |
| 2260 | # |
| 2261 | # Optional and only valid for third-party tag creatives. |
| 2262 | # Third-party tag creatives are creatives with following |
| 2263 | # hosting_source: |
| 2264 | # |
| 2265 | # * `HOSTING_SOURCE_THIRD_PARTY` |
| 2266 | # |
| 2267 | # combined with following creative_type: |
| 2268 | # |
| 2269 | # * `CREATIVE_TYPE_STANDARD` |
| 2270 | # * `CREATIVE_TYPE_EXPANDABLE` |
| 2271 | "name": "A String", # Output only. The resource name of the creative. |
| 2272 | "skippable": True or False, # Whether the user can choose to skip a video creative. |
| 2273 | # |
| 2274 | # This field is only supported for the following |
| 2275 | # creative_type: |
| 2276 | # |
| 2277 | # * `CREATIVE_TYPE_VIDEO` |
| 2278 | "jsTrackerUrl": "A String", # JavaScript measurement URL from supported third-party verification |
| 2279 | # providers (ComScore, DoubleVerify, IAS, Moat). HTML script tags are not |
| 2280 | # supported. |
| 2281 | # |
| 2282 | # This field is only supported in following |
| 2283 | # creative_type: |
| 2284 | # |
| 2285 | # * `CREATIVE_TYPE_NATIVE` |
| 2286 | # * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` |
| 2287 | # * `CREATIVE_TYPE_NATIVE_APP_INSTALL` |
| 2288 | # * `CREATIVE_TYPE_NATIVE_APP_INSTALL_SQUARE` |
| 2289 | # * `CREATIVE_TYPE_NATIVE_VIDEO` |
| 2290 | "thirdPartyUrls": [ # Tracking URLs from third parties to track interactions with a video |
| 2291 | # creative. |
| 2292 | # |
| 2293 | # This field is only supported for the following |
| 2294 | # creative_type: |
| 2295 | # |
| 2296 | # * `CREATIVE_TYPE_AUDIO` |
| 2297 | # * `CREATIVE_TYPE_VIDEO` |
| 2298 | # * `CREATIVE_TYPE_NATIVE_VIDEO` |
| 2299 | { # Tracking URLs from third parties to track interactions with an audio or a |
| 2300 | # video creative. |
| 2301 | "type": "A String", # The type of interaction needs to be tracked by the tracking URL |
| 2302 | "url": "A String", # Tracking URL used to track the interaction. |
| 2303 | # |
| 2304 | # Provide a URL with optional path or query string, beginning with `https:`. |
| 2305 | # For example, https://www.example.com/path |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2306 | }, |
| 2307 | ], |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 2308 | "expandOnHover": True or False, # Optional. Indicates the creative will automatically expand on hover. |
| 2309 | # |
| 2310 | # Optional and only valid for third-party expandable creatives. |
| 2311 | # Third-party expandable creatives are creatives with following hosting |
| 2312 | # source: |
| 2313 | # |
| 2314 | # * `HOSTING_SOURCE_THIRD_PARTY` |
| 2315 | # |
| 2316 | # combined with following creative_type: |
| 2317 | # |
| 2318 | # * `CREATIVE_TYPE_EXPANDABLE` |
| 2319 | "exitEvents": [ # Required. Exit events for this creative. |
| 2320 | # An exit (also known as a click tag) is any area in your creative that |
| 2321 | # someone can click or tap to open an advertiser's landing page. |
| 2322 | # Every creative must include at least one exit. |
| 2323 | # You can add an exit to your creative in any of the following ways: |
| 2324 | # |
| 2325 | # * Use Google Web Designer's tap area. |
| 2326 | # * Define a JavaScript variable called "clickTag". |
| 2327 | # * Use the Enabler (Enabler.exit()) to track exits in rich media formats. |
| 2328 | { # Exit event of the creative. |
| 2329 | "url": "A String", # Required. The click through URL of the exit event. |
| 2330 | # This is required when type is: |
| 2331 | # |
| 2332 | # * `EXIT_EVENT_TYPE_DEFAULT` |
| 2333 | # * `EXIT_EVENT_TYPE_BACKUP` |
| 2334 | "name": "A String", # The name of the click tag of the exit event. |
| 2335 | # |
| 2336 | # The name must be unique within one creative. |
| 2337 | # |
| 2338 | # Leave it empty or unset for creatives containing image assets only. |
| 2339 | "type": "A String", # Required. The type of the exit event. |
| 2340 | "reportingName": "A String", # The name used to identify this event in reports. |
| 2341 | # Leave it empty or unset for creatives containing image assets only. |
| 2342 | }, |
| 2343 | ], |
| 2344 | "additionalDimensions": [ # Additional dimensions. |
| 2345 | # Applicable when creative_type is one of: |
| 2346 | # |
| 2347 | # * `CREATIVE_TYPE_STANDARD` |
| 2348 | # * `CREATIVE_TYPE_EXPANDABLE` |
| 2349 | # * `CREATIVE_TYPE_NATIVE` |
| 2350 | # * `CREATIVE_TYPE_TEMPLATED_APP_INSTALL` |
| 2351 | # * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` |
| 2352 | # * `CREATIVE_TYPE_LIGHTBOX` |
| 2353 | # * `CREATIVE_TYPE_NATIVE_APP_INSTALL` |
| 2354 | # * `CREATIVE_TYPE_NATIVE_APP_INSTALL_SQUARE` |
| 2355 | # * `CREATIVE_TYPE_PUBLISHER_HOSTED` |
| 2356 | # |
| 2357 | # If this field is specified, width_pixels and |
| 2358 | # height_pixels are both required and must be |
| 2359 | # greater than or equal to 0. |
| 2360 | { # Dimensions. |
| 2361 | "heightPixels": 42, # The height in pixels. |
| 2362 | "widthPixels": 42, # The width in pixels. |
| 2363 | }, |
| 2364 | ], |
| 2365 | "createTime": "A String", # Output only. The timestamp when the creative was created. Assigned by |
| 2366 | # the system. |
| 2367 | "trackerUrls": [ # Tracking URLs for analytics providers or third-party ad technology vendors. |
| 2368 | # |
| 2369 | # The URLs must start with https (except on inventory that doesn't require |
| 2370 | # SSL compliance). |
| 2371 | # If using macros in your URL, use only macros supported by Display & Video |
| 2372 | # 360. |
| 2373 | # |
| 2374 | # Standard URLs only, no IMG or SCRIPT tags. |
| 2375 | # |
| 2376 | # This field is only supported in following |
| 2377 | # creative_type: |
| 2378 | # |
| 2379 | # * `CREATIVE_TYPE_NATIVE` |
| 2380 | # * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` |
| 2381 | # * `CREATIVE_TYPE_NATIVE_APP_INSTALL` |
| 2382 | # * `CREATIVE_TYPE_NATIVE_APP_INSTALL_SQUARE` |
| 2383 | # * `CREATIVE_TYPE_NATIVE_VIDEO` |
| 2384 | "A String", |
| 2385 | ], |
| 2386 | "iasCampaignMonitoring": True or False, # Indicates whether Integral Ad Science (IAS) campaign monitoring is enabled. |
| 2387 | # To enable this for the creative, make sure the |
| 2388 | # Advertiser.creative_config.ias_client_id |
| 2389 | # has been set to your IAS client ID. |
| 2390 | "integrationCode": "A String", # ID information used to link this creative to an external system. |
| 2391 | # Must be UTF-8 encoded with a length of no more than 10,000 characters. |
| 2392 | "cmPlacementId": "A String", # Output only. The unique ID of the Campaign Manager placement associated with the |
| 2393 | # creative. |
| 2394 | # This field is only applicable for creatives that are synced from Campaign |
| 2395 | # Manager. |
| 2396 | "requireMraid": True or False, # Optional. Indicates that the creative requires MRAID (Mobile Rich Media Ad Interface |
| 2397 | # Definitions system). |
| 2398 | # |
| 2399 | # Set this if the creative relies on mobile gestures for interactivity, such |
| 2400 | # as swiping or tapping. |
| 2401 | # |
| 2402 | # Optional and only valid for third-party tag creatives. |
| 2403 | # |
| 2404 | # Third-party tag creatives are creatives with following |
| 2405 | # hosting_source: |
| 2406 | # |
| 2407 | # * `HOSTING_SOURCE_THIRD_PARTY` |
| 2408 | # |
| 2409 | # combined with following creative_type: |
| 2410 | # |
| 2411 | # * `CREATIVE_TYPE_STANDARD` |
| 2412 | # * `CREATIVE_TYPE_EXPANDABLE` |
| 2413 | "companionCreativeIds": [ # The IDs of companion creatives for a video creative. |
| 2414 | # |
| 2415 | # You can assign existing display creatives (with image or HTML5 assets) |
| 2416 | # to serve surrounding the publisher's video player. Companions display |
| 2417 | # around the video player while the video is playing and remain after the |
| 2418 | # video has completed. |
| 2419 | # |
| 2420 | # Creatives contain additional dimensions |
| 2421 | # can not be companion creatives. |
| 2422 | # |
| 2423 | # This field is only supported for following |
| 2424 | # creative_type: |
| 2425 | # |
| 2426 | # * `CREATIVE_TYPE_AUDIO` |
| 2427 | # * `CREATIVE_TYPE_VIDEO` |
| 2428 | "A String", |
| 2429 | ], |
| 2430 | "creativeType": "A String", # Required. Immutable. The type of the creative. |
| 2431 | "obaIcon": { # OBA Icon for a Creative # Specifies the OBA icon for a video creative. |
| 2432 | # |
| 2433 | # This field is only supported in following |
| 2434 | # creative_type: |
| 2435 | # |
| 2436 | # * `CREATIVE_TYPE_VIDEO` |
| 2437 | "dimensions": { # Dimensions. # The dimensions of the OBA icon. |
| 2438 | "heightPixels": 42, # The height in pixels. |
| 2439 | "widthPixels": 42, # The width in pixels. |
| 2440 | }, |
| 2441 | "resourceMimeType": "A String", # The MIME type of the OBA icon resource. |
| 2442 | "viewTrackingUrl": "A String", # Required. The view tracking URL of the OBA icon. |
| 2443 | # |
| 2444 | # Only URLs of the following domains are allowed: |
| 2445 | # |
| 2446 | # * https://info.evidon.com |
| 2447 | # * https://l.betrad.com |
| 2448 | "clickTrackingUrl": "A String", # Required. The click tracking URL of the OBA icon. |
| 2449 | # |
| 2450 | # Only URLs of the following domains are allowed: |
| 2451 | # |
| 2452 | # * https://info.evidon.com |
| 2453 | # * https://l.betrad.com |
| 2454 | "position": "A String", # The position of the OBA icon on the creative. |
| 2455 | "resourceUrl": "A String", # The URL of the OBA icon resource. |
| 2456 | "landingPageUrl": "A String", # Required. The landing page URL of the OBA icon. |
| 2457 | # |
| 2458 | # Only URLs of the following domains are allowed: |
| 2459 | # |
| 2460 | # * https://info.evidon.com |
| 2461 | # * https://l.betrad.com |
| 2462 | "program": "A String", # The program of the OBA icon. For example: “AdChoices”. |
| 2463 | }, |
| 2464 | "timerEvents": [ # Timer custom events for a rich media creative. |
| 2465 | # Timers track the time during which a user views and interacts with a |
| 2466 | # specified part of a rich media creative. |
| 2467 | # A creative can have multiple timer events, each timed independently. |
| 2468 | # Leave it empty or unset for creatives containing image assets only. |
| 2469 | { # Timer event of the creative. |
| 2470 | "name": "A String", # Required. The name of the timer event. |
| 2471 | "reportingName": "A String", # Required. The name used to identify this timer event in reports. |
| 2472 | }, |
| 2473 | ], |
| 2474 | "notes": "A String", # User notes for this creative. |
| 2475 | # Must be UTF-8 encoded with a length of no more than 20,000 characters. |
| 2476 | "dynamic": True or False, # Output only. Indicates whether the creative is dynamic. |
| 2477 | "assets": [ # Required. Assets associated to this creative. |
| 2478 | # Assets can be associated to the creative in one of following roles: |
| 2479 | # |
| 2480 | # * `ASSET_ROLE_UNSPECIFIED` |
| 2481 | # * `ASSET_ROLE_MAIN` |
| 2482 | # * `ASSET_ROLE_BACKUP` |
| 2483 | # * `ASSET_ROLE_POLITE_LOAD` |
| 2484 | { # Asset association for the creative. |
| 2485 | "asset": { # A single asset. # The associated asset. |
| 2486 | "mediaId": "A String", # Media ID of the uploaded asset. This is a unique identifier for the asset. |
| 2487 | # This ID can be passed to other API calls, e.g. |
| 2488 | # CreateCreative to associate |
| 2489 | # the asset with a creative. |
| 2490 | "content": "A String", # The asset content. |
| 2491 | # For uploaded assets, the content is the serving path. |
| 2492 | }, |
| 2493 | "role": "A String", # The role of this asset for the creative. |
| 2494 | }, |
| 2495 | ], |
| 2496 | "vpaid": True or False, # Output only. Indicates the third-party VAST tag creative requires VPAID (Digital Video |
| 2497 | # Player-Ad Interface). |
| 2498 | # |
| 2499 | # Output only and only valid for third-party VAST tag creatives. |
| 2500 | # |
| 2501 | # Third-party VAST tag creatives are creatives with following |
| 2502 | # hosting_source: |
| 2503 | # |
| 2504 | # * `HOSTING_SOURCE_THIRD_PARTY` |
| 2505 | # |
| 2506 | # combined with following creative_type: |
| 2507 | # |
| 2508 | # * `CREATIVE_TYPE_VIDEO` |
| 2509 | "expandingDirection": "A String", # Optional. Specifies the expanding direction of the creative. |
| 2510 | # |
| 2511 | # Required and only valid for third-party expandable creatives. |
| 2512 | # |
| 2513 | # Third-party expandable creatives are creatives with following hosting |
| 2514 | # source: |
| 2515 | # |
| 2516 | # * `HOSTING_SOURCE_THIRD_PARTY` |
| 2517 | # |
| 2518 | # combined with following creative_type: |
| 2519 | # |
| 2520 | # * `CREATIVE_TYPE_EXPANDABLE` |
| 2521 | "thirdPartyTag": "A String", # Optional. The original third-party tag used for the creative. |
| 2522 | # |
| 2523 | # Required and only valid for third-party tag creatives. |
| 2524 | # |
| 2525 | # Third-party tag creatives are creatives with following |
| 2526 | # hosting_source: |
| 2527 | # |
| 2528 | # * `HOSTING_SOURCE_THIRD_PARTY` |
| 2529 | # |
| 2530 | # combined with following creative_type: |
| 2531 | # |
| 2532 | # * `CREATIVE_TYPE_STANDARD` |
| 2533 | # * `CREATIVE_TYPE_EXPANDABLE` |
| 2534 | "displayName": "A String", # Required. The display name of the creative. |
| 2535 | # |
| 2536 | # Must be UTF-8 encoded with a maximum size of 240 bytes. |
| 2537 | "hostingSource": "A String", # Required. Indicates where the creative is hosted. |
| 2538 | "mediaDuration": "A String", # Output only. Media duration of the creative. |
| 2539 | # Applicable when creative_type |
| 2540 | # is one of: |
| 2541 | # |
| 2542 | # * `CREATIVE_TYPE_VIDEO` |
| 2543 | # * `CREATIVE_TYPE_AUDIO` |
| 2544 | # * `CREATIVE_TYPE_NATIVE_VIDEO` |
| 2545 | # * `CREATIVE_TYPE_PUBLISHER_HOSTED` |
| 2546 | "vastTagUrl": "A String", # Optional. The URL of the VAST tag for a third-party VAST tag creative. |
| 2547 | # |
| 2548 | # Required and only valid for third-party VAST tag creatives. |
| 2549 | # |
| 2550 | # Third-party VAST tag creatives are creatives with following |
| 2551 | # hosting_source: |
| 2552 | # |
| 2553 | # * `HOSTING_SOURCE_THIRD_PARTY` |
| 2554 | # |
| 2555 | # combined with following creative_type: |
| 2556 | # |
| 2557 | # * `CREATIVE_TYPE_VIDEO` |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2558 | "reviewStatus": { # Review statuses for the creative. # Output only. The current status of the creative review process. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 2559 | "approvalStatus": "A String", # Represents the basic approval needed for a creative to begin serving. |
| 2560 | # Summary of |
| 2561 | # creative_and_landing_page_review_status |
| 2562 | # and |
| 2563 | # content_and_policy_review_status. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2564 | "creativeAndLandingPageReviewStatus": "A String", # Creative and landing page review status for the creative. |
| 2565 | "exchangeReviewStatuses": [ # Exchange review statuses for the creative. |
| 2566 | { # Exchange review status for the creative. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2567 | "status": "A String", # Status of the exchange review. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 2568 | "exchange": "A String", # The exchange reviewing the creative. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2569 | }, |
| 2570 | ], |
| 2571 | "contentAndPolicyReviewStatus": "A String", # Content and policy review status for the creative. |
| 2572 | "publisherReviewStatuses": [ # Publisher review statuses for the creative. |
| 2573 | { # Publisher review status for the creative. |
| 2574 | "status": "A String", # Status of the publisher review. |
| 2575 | "publisherName": "A String", # The publisher reviewing the creative. |
| 2576 | }, |
| 2577 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2578 | }, |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 2579 | "counterEvents": [ # Counter events for a rich media creative. |
| 2580 | # Counters track the number of times that a user interacts with any part of a |
| 2581 | # rich media creative in a specified way (mouse-overs, mouse-outs, clicks, |
| 2582 | # taps, data loading, keyboard entries, etc.). |
| 2583 | # Any event that can be captured in the creative can be recorded as a |
| 2584 | # counter. |
| 2585 | # Leave it empty or unset for creatives containing image assets only. |
| 2586 | { # Counter event of the creative. |
| 2587 | "name": "A String", # Required. The name of the counter event. |
| 2588 | "reportingName": "A String", # Required. The name used to identify this counter event in reports. |
| 2589 | }, |
| 2590 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2591 | "progressOffset": { # The length an audio or a video has been played. # Amount of time to play the video before counting a view. |
| 2592 | # |
| 2593 | # This field is required when skippable is true. |
| 2594 | # |
| 2595 | # This field is only supported for the following |
| 2596 | # creative_type: |
| 2597 | # |
| 2598 | # * `CREATIVE_TYPE_VIDEO` |
| 2599 | "percentage": "A String", # The offset in percentage of the audio or video duration. |
| 2600 | "seconds": "A String", # The offset in seconds from the start of the audio or video. |
| 2601 | }, |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 2602 | "updateTime": "A String", # Output only. The timestamp when the creative was last updated. Assigned by |
| 2603 | # the system. |
| 2604 | "advertiserId": "A String", # Output only. The unique ID of the advertiser the creative belongs to. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2605 | "universalAdId": { # A creative identifier provided by a registry that is unique across all # Optional. An optional creative identifier provided by a registry that is unique |
| 2606 | # across all platforms. |
| 2607 | # |
| 2608 | # Universal Ad ID is part of the VAST 4.0 standard. It can be modified after |
| 2609 | # the creative is created. |
| 2610 | # |
| 2611 | # This field is only supported for the following |
| 2612 | # creative_type: |
| 2613 | # |
| 2614 | # * `CREATIVE_TYPE_VIDEO` |
| 2615 | # platforms. This is part of the VAST 4.0 standard. |
| 2616 | "id": "A String", # The unique creative identifier. |
| 2617 | "registry": "A String", # The registry provides unique creative identifiers. |
| 2618 | }, |
| 2619 | "transcodes": [ # Output only. Audio/Video transcodes. |
| 2620 | # |
| 2621 | # Display & Video 360 transcodes the main asset into a number of alternative |
| 2622 | # versions that use different file formats or have different properties |
| 2623 | # (resolution, audio bit rate, and video bit rate), each designed for |
| 2624 | # specific video players or bandwidths. |
| 2625 | # |
| 2626 | # These transcodes give a publisher's system more options to choose from for |
| 2627 | # each impression on your video and ensures that the appropriate file serves |
| 2628 | # based on the viewer’s connection and screen size. |
| 2629 | # |
| 2630 | # This field is only supported in following |
| 2631 | # creative_type: |
| 2632 | # |
| 2633 | # * `CREATIVE_TYPE_VIDEO` |
| 2634 | # * `CREATIVE_TYPE_NATIVE_VIDEO` |
| 2635 | # * `CREATIVE_TYPE_AUDIO` |
| 2636 | { # Represents information about the transcoded audio or video file. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 2637 | "mimeType": "A String", # The MIME type of the transcoded file. |
| 2638 | "bitRateKbps": "A String", # The transcoding bit rate of the transcoded video, in kilobits per second. |
| 2639 | "dimensions": { # Dimensions. # The dimensions of the transcoded video. |
| 2640 | "heightPixels": 42, # The height in pixels. |
| 2641 | "widthPixels": 42, # The width in pixels. |
| 2642 | }, |
| 2643 | "frameRate": 3.14, # The frame rate of the transcoded video, in frames per second. |
| 2644 | "audioSampleRateHz": "A String", # The sample rate for the audio stream of the transcoded video, or the sample |
| 2645 | # rate for the transcoded audio, in hertz. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2646 | "transcoded": True or False, # Indicates if the transcoding was successful. |
| 2647 | "audioBitRateKbps": "A String", # The bit rate for the audio stream of the transcoded video, or the bit rate |
| 2648 | # for the transcoded audio, in kilobits per second. |
| 2649 | "fileSizeBytes": "A String", # The size of the transcoded file, in bytes. |
| 2650 | "name": "A String", # The name of the transcoded file. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2651 | }, |
| 2652 | ], |
| 2653 | "cmTrackingAd": { # A Campaign Manager tracking ad. # The Campaign Manager tracking ad associated with the creative. |
| 2654 | # |
| 2655 | # Optional for the following creative_type when |
| 2656 | # created by an advertiser that uses both Campaign Manager and third-party ad |
| 2657 | # serving: |
| 2658 | # |
| 2659 | # * `CREATIVE_TYPE_NATIVE` |
| 2660 | # * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` |
| 2661 | # * `CREATIVE_TYPE_NATIVE_APP_INSTALL` |
| 2662 | # * `CREATIVE_TYPE_NATIVE_APP_INSTALL_SQUARE` |
| 2663 | # |
| 2664 | # Output only for other cases. |
| 2665 | "cmCreativeId": "A String", # The creative ID of the campaign manager tracking Ad. |
| 2666 | "cmAdId": "A String", # The ad ID of the campaign manager tracking Ad. |
| 2667 | "cmPlacementId": "A String", # The placement ID of the campaign manager tracking Ad. |
| 2668 | }, |
| 2669 | "html5Video": True or False, # Output only. Indicates the third-party VAST tag creative requires HTML5 Video support. |
| 2670 | # |
| 2671 | # Output only and only valid for third-party VAST tag creatives. |
| 2672 | # |
| 2673 | # Third-party VAST tag creatives are creatives with following |
| 2674 | # hosting_source: |
| 2675 | # |
| 2676 | # * `HOSTING_SOURCE_THIRD_PARTY` |
| 2677 | # |
| 2678 | # combined with following creative_type: |
| 2679 | # |
| 2680 | # * `CREATIVE_TYPE_VIDEO` |
| 2681 | "requirePingForAttribution": True or False, # Optional. Indicates that the creative will wait for a return ping for attribution. |
| 2682 | # |
| 2683 | # Only valid when using a Campaign Manager tracking ad with a third-party ad |
| 2684 | # server parameter and the ${DC_DBM_TOKEN} macro. |
| 2685 | # |
| 2686 | # Optional and only valid for third-party tag creatives or third-party VAST |
| 2687 | # tag creatives. |
| 2688 | # |
| 2689 | # Third-party tag creatives are creatives with following |
| 2690 | # hosting_source: |
| 2691 | # |
| 2692 | # * `HOSTING_SOURCE_THIRD_PARTY` |
| 2693 | # |
| 2694 | # combined with following creative_type: |
| 2695 | # |
| 2696 | # * `CREATIVE_TYPE_STANDARD` |
| 2697 | # * `CREATIVE_TYPE_EXPANDABLE` |
| 2698 | # |
| 2699 | # Third-party VAST tag creatives are creatives with following |
| 2700 | # hosting_source: |
| 2701 | # |
| 2702 | # * `HOSTING_SOURCE_THIRD_PARTY` |
| 2703 | # |
| 2704 | # combined with following creative_type: |
| 2705 | # |
| 2706 | # * `CREATIVE_TYPE_VIDEO` |
| 2707 | "dimensions": { # Dimensions. # Required. Primary dimensions of the creative. |
| 2708 | # Applicable to all creative types. The value of |
| 2709 | # width_pixels and |
| 2710 | # height_pixels defaults to `0` |
| 2711 | # when creative_type is one of: |
| 2712 | # |
| 2713 | # * `CREATIVE_TYPE_VIDEO` |
| 2714 | # * `CREATIVE_TYPE_TEMPLATED_APP_INSTALL_INTERSTITIAL` |
| 2715 | # * `CREATIVE_TYPE_AUDIO` |
| 2716 | # * `CREATIVE_TYPE_NATIVE_VIDEO` |
| 2717 | # * `CREATIVE_TYPE_TEMPLATED_APP_INSTALL_VIDEO` |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2718 | "heightPixels": 42, # The height in pixels. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 2719 | "widthPixels": 42, # The width in pixels. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2720 | }, |
| 2721 | "appendedTag": "A String", # Third-party HTML tracking tag to be appended to the creative tag. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2722 | } |
| 2723 | |
| 2724 | updateMask: string, Required. The mask to control which fields to update. |
| 2725 | x__xgafv: string, V1 error format. |
| 2726 | Allowed values |
| 2727 | 1 - v1 error format |
| 2728 | 2 - v2 error format |
| 2729 | |
| 2730 | Returns: |
| 2731 | An object of the form: |
| 2732 | |
| 2733 | { # A single Creative. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 2734 | "creativeAttributes": [ # Output only. A list of attributes of the creative that is generated by the system. |
| 2735 | "A String", |
| 2736 | ], |
| 2737 | "creativeId": "A String", # Output only. The unique ID of the creative. Assigned by the system. |
| 2738 | "entityStatus": "A String", # Required. Controls whether or not the creative can serve. |
| 2739 | # |
| 2740 | # Accepted values are: |
| 2741 | # |
| 2742 | # * `ENTITY_STATUS_ACTIVE` |
| 2743 | # * `ENTITY_STATUS_ARCHIVED` |
| 2744 | # * `ENTITY_STATUS_PAUSED` |
| 2745 | "skipOffset": { # The length an audio or a video has been played. # Amount of time to play the video before the skip button appears. |
| 2746 | # |
| 2747 | # This field is required when skippable is true. |
| 2748 | # |
| 2749 | # This field is only supported for the following |
| 2750 | # creative_type: |
| 2751 | # |
| 2752 | # * `CREATIVE_TYPE_VIDEO` |
| 2753 | "percentage": "A String", # The offset in percentage of the audio or video duration. |
| 2754 | "seconds": "A String", # The offset in seconds from the start of the audio or video. |
| 2755 | }, |
| 2756 | "requireHtml5": True or False, # Optional. Indicates that the creative relies on HTML5 to render properly. |
| 2757 | # |
| 2758 | # Optional and only valid for third-party tag creatives. |
| 2759 | # Third-party tag creatives are creatives with following |
| 2760 | # hosting_source: |
| 2761 | # |
| 2762 | # * `HOSTING_SOURCE_THIRD_PARTY` |
| 2763 | # |
| 2764 | # combined with following creative_type: |
| 2765 | # |
| 2766 | # * `CREATIVE_TYPE_STANDARD` |
| 2767 | # * `CREATIVE_TYPE_EXPANDABLE` |
| 2768 | "name": "A String", # Output only. The resource name of the creative. |
| 2769 | "skippable": True or False, # Whether the user can choose to skip a video creative. |
| 2770 | # |
| 2771 | # This field is only supported for the following |
| 2772 | # creative_type: |
| 2773 | # |
| 2774 | # * `CREATIVE_TYPE_VIDEO` |
| 2775 | "jsTrackerUrl": "A String", # JavaScript measurement URL from supported third-party verification |
| 2776 | # providers (ComScore, DoubleVerify, IAS, Moat). HTML script tags are not |
| 2777 | # supported. |
| 2778 | # |
| 2779 | # This field is only supported in following |
| 2780 | # creative_type: |
| 2781 | # |
| 2782 | # * `CREATIVE_TYPE_NATIVE` |
| 2783 | # * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` |
| 2784 | # * `CREATIVE_TYPE_NATIVE_APP_INSTALL` |
| 2785 | # * `CREATIVE_TYPE_NATIVE_APP_INSTALL_SQUARE` |
| 2786 | # * `CREATIVE_TYPE_NATIVE_VIDEO` |
| 2787 | "thirdPartyUrls": [ # Tracking URLs from third parties to track interactions with a video |
| 2788 | # creative. |
| 2789 | # |
| 2790 | # This field is only supported for the following |
| 2791 | # creative_type: |
| 2792 | # |
| 2793 | # * `CREATIVE_TYPE_AUDIO` |
| 2794 | # * `CREATIVE_TYPE_VIDEO` |
| 2795 | # * `CREATIVE_TYPE_NATIVE_VIDEO` |
| 2796 | { # Tracking URLs from third parties to track interactions with an audio or a |
| 2797 | # video creative. |
| 2798 | "type": "A String", # The type of interaction needs to be tracked by the tracking URL |
| 2799 | "url": "A String", # Tracking URL used to track the interaction. |
| 2800 | # |
| 2801 | # Provide a URL with optional path or query string, beginning with `https:`. |
| 2802 | # For example, https://www.example.com/path |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2803 | }, |
| 2804 | ], |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 2805 | "expandOnHover": True or False, # Optional. Indicates the creative will automatically expand on hover. |
| 2806 | # |
| 2807 | # Optional and only valid for third-party expandable creatives. |
| 2808 | # Third-party expandable creatives are creatives with following hosting |
| 2809 | # source: |
| 2810 | # |
| 2811 | # * `HOSTING_SOURCE_THIRD_PARTY` |
| 2812 | # |
| 2813 | # combined with following creative_type: |
| 2814 | # |
| 2815 | # * `CREATIVE_TYPE_EXPANDABLE` |
| 2816 | "exitEvents": [ # Required. Exit events for this creative. |
| 2817 | # An exit (also known as a click tag) is any area in your creative that |
| 2818 | # someone can click or tap to open an advertiser's landing page. |
| 2819 | # Every creative must include at least one exit. |
| 2820 | # You can add an exit to your creative in any of the following ways: |
| 2821 | # |
| 2822 | # * Use Google Web Designer's tap area. |
| 2823 | # * Define a JavaScript variable called "clickTag". |
| 2824 | # * Use the Enabler (Enabler.exit()) to track exits in rich media formats. |
| 2825 | { # Exit event of the creative. |
| 2826 | "url": "A String", # Required. The click through URL of the exit event. |
| 2827 | # This is required when type is: |
| 2828 | # |
| 2829 | # * `EXIT_EVENT_TYPE_DEFAULT` |
| 2830 | # * `EXIT_EVENT_TYPE_BACKUP` |
| 2831 | "name": "A String", # The name of the click tag of the exit event. |
| 2832 | # |
| 2833 | # The name must be unique within one creative. |
| 2834 | # |
| 2835 | # Leave it empty or unset for creatives containing image assets only. |
| 2836 | "type": "A String", # Required. The type of the exit event. |
| 2837 | "reportingName": "A String", # The name used to identify this event in reports. |
| 2838 | # Leave it empty or unset for creatives containing image assets only. |
| 2839 | }, |
| 2840 | ], |
| 2841 | "additionalDimensions": [ # Additional dimensions. |
| 2842 | # Applicable when creative_type is one of: |
| 2843 | # |
| 2844 | # * `CREATIVE_TYPE_STANDARD` |
| 2845 | # * `CREATIVE_TYPE_EXPANDABLE` |
| 2846 | # * `CREATIVE_TYPE_NATIVE` |
| 2847 | # * `CREATIVE_TYPE_TEMPLATED_APP_INSTALL` |
| 2848 | # * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` |
| 2849 | # * `CREATIVE_TYPE_LIGHTBOX` |
| 2850 | # * `CREATIVE_TYPE_NATIVE_APP_INSTALL` |
| 2851 | # * `CREATIVE_TYPE_NATIVE_APP_INSTALL_SQUARE` |
| 2852 | # * `CREATIVE_TYPE_PUBLISHER_HOSTED` |
| 2853 | # |
| 2854 | # If this field is specified, width_pixels and |
| 2855 | # height_pixels are both required and must be |
| 2856 | # greater than or equal to 0. |
| 2857 | { # Dimensions. |
| 2858 | "heightPixels": 42, # The height in pixels. |
| 2859 | "widthPixels": 42, # The width in pixels. |
| 2860 | }, |
| 2861 | ], |
| 2862 | "createTime": "A String", # Output only. The timestamp when the creative was created. Assigned by |
| 2863 | # the system. |
| 2864 | "trackerUrls": [ # Tracking URLs for analytics providers or third-party ad technology vendors. |
| 2865 | # |
| 2866 | # The URLs must start with https (except on inventory that doesn't require |
| 2867 | # SSL compliance). |
| 2868 | # If using macros in your URL, use only macros supported by Display & Video |
| 2869 | # 360. |
| 2870 | # |
| 2871 | # Standard URLs only, no IMG or SCRIPT tags. |
| 2872 | # |
| 2873 | # This field is only supported in following |
| 2874 | # creative_type: |
| 2875 | # |
| 2876 | # * `CREATIVE_TYPE_NATIVE` |
| 2877 | # * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` |
| 2878 | # * `CREATIVE_TYPE_NATIVE_APP_INSTALL` |
| 2879 | # * `CREATIVE_TYPE_NATIVE_APP_INSTALL_SQUARE` |
| 2880 | # * `CREATIVE_TYPE_NATIVE_VIDEO` |
| 2881 | "A String", |
| 2882 | ], |
| 2883 | "iasCampaignMonitoring": True or False, # Indicates whether Integral Ad Science (IAS) campaign monitoring is enabled. |
| 2884 | # To enable this for the creative, make sure the |
| 2885 | # Advertiser.creative_config.ias_client_id |
| 2886 | # has been set to your IAS client ID. |
| 2887 | "integrationCode": "A String", # ID information used to link this creative to an external system. |
| 2888 | # Must be UTF-8 encoded with a length of no more than 10,000 characters. |
| 2889 | "cmPlacementId": "A String", # Output only. The unique ID of the Campaign Manager placement associated with the |
| 2890 | # creative. |
| 2891 | # This field is only applicable for creatives that are synced from Campaign |
| 2892 | # Manager. |
| 2893 | "requireMraid": True or False, # Optional. Indicates that the creative requires MRAID (Mobile Rich Media Ad Interface |
| 2894 | # Definitions system). |
| 2895 | # |
| 2896 | # Set this if the creative relies on mobile gestures for interactivity, such |
| 2897 | # as swiping or tapping. |
| 2898 | # |
| 2899 | # Optional and only valid for third-party tag creatives. |
| 2900 | # |
| 2901 | # Third-party tag creatives are creatives with following |
| 2902 | # hosting_source: |
| 2903 | # |
| 2904 | # * `HOSTING_SOURCE_THIRD_PARTY` |
| 2905 | # |
| 2906 | # combined with following creative_type: |
| 2907 | # |
| 2908 | # * `CREATIVE_TYPE_STANDARD` |
| 2909 | # * `CREATIVE_TYPE_EXPANDABLE` |
| 2910 | "companionCreativeIds": [ # The IDs of companion creatives for a video creative. |
| 2911 | # |
| 2912 | # You can assign existing display creatives (with image or HTML5 assets) |
| 2913 | # to serve surrounding the publisher's video player. Companions display |
| 2914 | # around the video player while the video is playing and remain after the |
| 2915 | # video has completed. |
| 2916 | # |
| 2917 | # Creatives contain additional dimensions |
| 2918 | # can not be companion creatives. |
| 2919 | # |
| 2920 | # This field is only supported for following |
| 2921 | # creative_type: |
| 2922 | # |
| 2923 | # * `CREATIVE_TYPE_AUDIO` |
| 2924 | # * `CREATIVE_TYPE_VIDEO` |
| 2925 | "A String", |
| 2926 | ], |
| 2927 | "creativeType": "A String", # Required. Immutable. The type of the creative. |
| 2928 | "obaIcon": { # OBA Icon for a Creative # Specifies the OBA icon for a video creative. |
| 2929 | # |
| 2930 | # This field is only supported in following |
| 2931 | # creative_type: |
| 2932 | # |
| 2933 | # * `CREATIVE_TYPE_VIDEO` |
| 2934 | "dimensions": { # Dimensions. # The dimensions of the OBA icon. |
| 2935 | "heightPixels": 42, # The height in pixels. |
| 2936 | "widthPixels": 42, # The width in pixels. |
| 2937 | }, |
| 2938 | "resourceMimeType": "A String", # The MIME type of the OBA icon resource. |
| 2939 | "viewTrackingUrl": "A String", # Required. The view tracking URL of the OBA icon. |
| 2940 | # |
| 2941 | # Only URLs of the following domains are allowed: |
| 2942 | # |
| 2943 | # * https://info.evidon.com |
| 2944 | # * https://l.betrad.com |
| 2945 | "clickTrackingUrl": "A String", # Required. The click tracking URL of the OBA icon. |
| 2946 | # |
| 2947 | # Only URLs of the following domains are allowed: |
| 2948 | # |
| 2949 | # * https://info.evidon.com |
| 2950 | # * https://l.betrad.com |
| 2951 | "position": "A String", # The position of the OBA icon on the creative. |
| 2952 | "resourceUrl": "A String", # The URL of the OBA icon resource. |
| 2953 | "landingPageUrl": "A String", # Required. The landing page URL of the OBA icon. |
| 2954 | # |
| 2955 | # Only URLs of the following domains are allowed: |
| 2956 | # |
| 2957 | # * https://info.evidon.com |
| 2958 | # * https://l.betrad.com |
| 2959 | "program": "A String", # The program of the OBA icon. For example: “AdChoices”. |
| 2960 | }, |
| 2961 | "timerEvents": [ # Timer custom events for a rich media creative. |
| 2962 | # Timers track the time during which a user views and interacts with a |
| 2963 | # specified part of a rich media creative. |
| 2964 | # A creative can have multiple timer events, each timed independently. |
| 2965 | # Leave it empty or unset for creatives containing image assets only. |
| 2966 | { # Timer event of the creative. |
| 2967 | "name": "A String", # Required. The name of the timer event. |
| 2968 | "reportingName": "A String", # Required. The name used to identify this timer event in reports. |
| 2969 | }, |
| 2970 | ], |
| 2971 | "notes": "A String", # User notes for this creative. |
| 2972 | # Must be UTF-8 encoded with a length of no more than 20,000 characters. |
| 2973 | "dynamic": True or False, # Output only. Indicates whether the creative is dynamic. |
| 2974 | "assets": [ # Required. Assets associated to this creative. |
| 2975 | # Assets can be associated to the creative in one of following roles: |
| 2976 | # |
| 2977 | # * `ASSET_ROLE_UNSPECIFIED` |
| 2978 | # * `ASSET_ROLE_MAIN` |
| 2979 | # * `ASSET_ROLE_BACKUP` |
| 2980 | # * `ASSET_ROLE_POLITE_LOAD` |
| 2981 | { # Asset association for the creative. |
| 2982 | "asset": { # A single asset. # The associated asset. |
| 2983 | "mediaId": "A String", # Media ID of the uploaded asset. This is a unique identifier for the asset. |
| 2984 | # This ID can be passed to other API calls, e.g. |
| 2985 | # CreateCreative to associate |
| 2986 | # the asset with a creative. |
| 2987 | "content": "A String", # The asset content. |
| 2988 | # For uploaded assets, the content is the serving path. |
| 2989 | }, |
| 2990 | "role": "A String", # The role of this asset for the creative. |
| 2991 | }, |
| 2992 | ], |
| 2993 | "vpaid": True or False, # Output only. Indicates the third-party VAST tag creative requires VPAID (Digital Video |
| 2994 | # Player-Ad Interface). |
| 2995 | # |
| 2996 | # Output only and only valid for third-party VAST tag creatives. |
| 2997 | # |
| 2998 | # Third-party VAST tag creatives are creatives with following |
| 2999 | # hosting_source: |
| 3000 | # |
| 3001 | # * `HOSTING_SOURCE_THIRD_PARTY` |
| 3002 | # |
| 3003 | # combined with following creative_type: |
| 3004 | # |
| 3005 | # * `CREATIVE_TYPE_VIDEO` |
| 3006 | "expandingDirection": "A String", # Optional. Specifies the expanding direction of the creative. |
| 3007 | # |
| 3008 | # Required and only valid for third-party expandable creatives. |
| 3009 | # |
| 3010 | # Third-party expandable creatives are creatives with following hosting |
| 3011 | # source: |
| 3012 | # |
| 3013 | # * `HOSTING_SOURCE_THIRD_PARTY` |
| 3014 | # |
| 3015 | # combined with following creative_type: |
| 3016 | # |
| 3017 | # * `CREATIVE_TYPE_EXPANDABLE` |
| 3018 | "thirdPartyTag": "A String", # Optional. The original third-party tag used for the creative. |
| 3019 | # |
| 3020 | # Required and only valid for third-party tag creatives. |
| 3021 | # |
| 3022 | # Third-party tag creatives are creatives with following |
| 3023 | # hosting_source: |
| 3024 | # |
| 3025 | # * `HOSTING_SOURCE_THIRD_PARTY` |
| 3026 | # |
| 3027 | # combined with following creative_type: |
| 3028 | # |
| 3029 | # * `CREATIVE_TYPE_STANDARD` |
| 3030 | # * `CREATIVE_TYPE_EXPANDABLE` |
| 3031 | "displayName": "A String", # Required. The display name of the creative. |
| 3032 | # |
| 3033 | # Must be UTF-8 encoded with a maximum size of 240 bytes. |
| 3034 | "hostingSource": "A String", # Required. Indicates where the creative is hosted. |
| 3035 | "mediaDuration": "A String", # Output only. Media duration of the creative. |
| 3036 | # Applicable when creative_type |
| 3037 | # is one of: |
| 3038 | # |
| 3039 | # * `CREATIVE_TYPE_VIDEO` |
| 3040 | # * `CREATIVE_TYPE_AUDIO` |
| 3041 | # * `CREATIVE_TYPE_NATIVE_VIDEO` |
| 3042 | # * `CREATIVE_TYPE_PUBLISHER_HOSTED` |
| 3043 | "vastTagUrl": "A String", # Optional. The URL of the VAST tag for a third-party VAST tag creative. |
| 3044 | # |
| 3045 | # Required and only valid for third-party VAST tag creatives. |
| 3046 | # |
| 3047 | # Third-party VAST tag creatives are creatives with following |
| 3048 | # hosting_source: |
| 3049 | # |
| 3050 | # * `HOSTING_SOURCE_THIRD_PARTY` |
| 3051 | # |
| 3052 | # combined with following creative_type: |
| 3053 | # |
| 3054 | # * `CREATIVE_TYPE_VIDEO` |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3055 | "reviewStatus": { # Review statuses for the creative. # Output only. The current status of the creative review process. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 3056 | "approvalStatus": "A String", # Represents the basic approval needed for a creative to begin serving. |
| 3057 | # Summary of |
| 3058 | # creative_and_landing_page_review_status |
| 3059 | # and |
| 3060 | # content_and_policy_review_status. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3061 | "creativeAndLandingPageReviewStatus": "A String", # Creative and landing page review status for the creative. |
| 3062 | "exchangeReviewStatuses": [ # Exchange review statuses for the creative. |
| 3063 | { # Exchange review status for the creative. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3064 | "status": "A String", # Status of the exchange review. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 3065 | "exchange": "A String", # The exchange reviewing the creative. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3066 | }, |
| 3067 | ], |
| 3068 | "contentAndPolicyReviewStatus": "A String", # Content and policy review status for the creative. |
| 3069 | "publisherReviewStatuses": [ # Publisher review statuses for the creative. |
| 3070 | { # Publisher review status for the creative. |
| 3071 | "status": "A String", # Status of the publisher review. |
| 3072 | "publisherName": "A String", # The publisher reviewing the creative. |
| 3073 | }, |
| 3074 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3075 | }, |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 3076 | "counterEvents": [ # Counter events for a rich media creative. |
| 3077 | # Counters track the number of times that a user interacts with any part of a |
| 3078 | # rich media creative in a specified way (mouse-overs, mouse-outs, clicks, |
| 3079 | # taps, data loading, keyboard entries, etc.). |
| 3080 | # Any event that can be captured in the creative can be recorded as a |
| 3081 | # counter. |
| 3082 | # Leave it empty or unset for creatives containing image assets only. |
| 3083 | { # Counter event of the creative. |
| 3084 | "name": "A String", # Required. The name of the counter event. |
| 3085 | "reportingName": "A String", # Required. The name used to identify this counter event in reports. |
| 3086 | }, |
| 3087 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3088 | "progressOffset": { # The length an audio or a video has been played. # Amount of time to play the video before counting a view. |
| 3089 | # |
| 3090 | # This field is required when skippable is true. |
| 3091 | # |
| 3092 | # This field is only supported for the following |
| 3093 | # creative_type: |
| 3094 | # |
| 3095 | # * `CREATIVE_TYPE_VIDEO` |
| 3096 | "percentage": "A String", # The offset in percentage of the audio or video duration. |
| 3097 | "seconds": "A String", # The offset in seconds from the start of the audio or video. |
| 3098 | }, |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 3099 | "updateTime": "A String", # Output only. The timestamp when the creative was last updated. Assigned by |
| 3100 | # the system. |
| 3101 | "advertiserId": "A String", # Output only. The unique ID of the advertiser the creative belongs to. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3102 | "universalAdId": { # A creative identifier provided by a registry that is unique across all # Optional. An optional creative identifier provided by a registry that is unique |
| 3103 | # across all platforms. |
| 3104 | # |
| 3105 | # Universal Ad ID is part of the VAST 4.0 standard. It can be modified after |
| 3106 | # the creative is created. |
| 3107 | # |
| 3108 | # This field is only supported for the following |
| 3109 | # creative_type: |
| 3110 | # |
| 3111 | # * `CREATIVE_TYPE_VIDEO` |
| 3112 | # platforms. This is part of the VAST 4.0 standard. |
| 3113 | "id": "A String", # The unique creative identifier. |
| 3114 | "registry": "A String", # The registry provides unique creative identifiers. |
| 3115 | }, |
| 3116 | "transcodes": [ # Output only. Audio/Video transcodes. |
| 3117 | # |
| 3118 | # Display & Video 360 transcodes the main asset into a number of alternative |
| 3119 | # versions that use different file formats or have different properties |
| 3120 | # (resolution, audio bit rate, and video bit rate), each designed for |
| 3121 | # specific video players or bandwidths. |
| 3122 | # |
| 3123 | # These transcodes give a publisher's system more options to choose from for |
| 3124 | # each impression on your video and ensures that the appropriate file serves |
| 3125 | # based on the viewer’s connection and screen size. |
| 3126 | # |
| 3127 | # This field is only supported in following |
| 3128 | # creative_type: |
| 3129 | # |
| 3130 | # * `CREATIVE_TYPE_VIDEO` |
| 3131 | # * `CREATIVE_TYPE_NATIVE_VIDEO` |
| 3132 | # * `CREATIVE_TYPE_AUDIO` |
| 3133 | { # Represents information about the transcoded audio or video file. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 3134 | "mimeType": "A String", # The MIME type of the transcoded file. |
| 3135 | "bitRateKbps": "A String", # The transcoding bit rate of the transcoded video, in kilobits per second. |
| 3136 | "dimensions": { # Dimensions. # The dimensions of the transcoded video. |
| 3137 | "heightPixels": 42, # The height in pixels. |
| 3138 | "widthPixels": 42, # The width in pixels. |
| 3139 | }, |
| 3140 | "frameRate": 3.14, # The frame rate of the transcoded video, in frames per second. |
| 3141 | "audioSampleRateHz": "A String", # The sample rate for the audio stream of the transcoded video, or the sample |
| 3142 | # rate for the transcoded audio, in hertz. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3143 | "transcoded": True or False, # Indicates if the transcoding was successful. |
| 3144 | "audioBitRateKbps": "A String", # The bit rate for the audio stream of the transcoded video, or the bit rate |
| 3145 | # for the transcoded audio, in kilobits per second. |
| 3146 | "fileSizeBytes": "A String", # The size of the transcoded file, in bytes. |
| 3147 | "name": "A String", # The name of the transcoded file. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3148 | }, |
| 3149 | ], |
| 3150 | "cmTrackingAd": { # A Campaign Manager tracking ad. # The Campaign Manager tracking ad associated with the creative. |
| 3151 | # |
| 3152 | # Optional for the following creative_type when |
| 3153 | # created by an advertiser that uses both Campaign Manager and third-party ad |
| 3154 | # serving: |
| 3155 | # |
| 3156 | # * `CREATIVE_TYPE_NATIVE` |
| 3157 | # * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` |
| 3158 | # * `CREATIVE_TYPE_NATIVE_APP_INSTALL` |
| 3159 | # * `CREATIVE_TYPE_NATIVE_APP_INSTALL_SQUARE` |
| 3160 | # |
| 3161 | # Output only for other cases. |
| 3162 | "cmCreativeId": "A String", # The creative ID of the campaign manager tracking Ad. |
| 3163 | "cmAdId": "A String", # The ad ID of the campaign manager tracking Ad. |
| 3164 | "cmPlacementId": "A String", # The placement ID of the campaign manager tracking Ad. |
| 3165 | }, |
| 3166 | "html5Video": True or False, # Output only. Indicates the third-party VAST tag creative requires HTML5 Video support. |
| 3167 | # |
| 3168 | # Output only and only valid for third-party VAST tag creatives. |
| 3169 | # |
| 3170 | # Third-party VAST tag creatives are creatives with following |
| 3171 | # hosting_source: |
| 3172 | # |
| 3173 | # * `HOSTING_SOURCE_THIRD_PARTY` |
| 3174 | # |
| 3175 | # combined with following creative_type: |
| 3176 | # |
| 3177 | # * `CREATIVE_TYPE_VIDEO` |
| 3178 | "requirePingForAttribution": True or False, # Optional. Indicates that the creative will wait for a return ping for attribution. |
| 3179 | # |
| 3180 | # Only valid when using a Campaign Manager tracking ad with a third-party ad |
| 3181 | # server parameter and the ${DC_DBM_TOKEN} macro. |
| 3182 | # |
| 3183 | # Optional and only valid for third-party tag creatives or third-party VAST |
| 3184 | # tag creatives. |
| 3185 | # |
| 3186 | # Third-party tag creatives are creatives with following |
| 3187 | # hosting_source: |
| 3188 | # |
| 3189 | # * `HOSTING_SOURCE_THIRD_PARTY` |
| 3190 | # |
| 3191 | # combined with following creative_type: |
| 3192 | # |
| 3193 | # * `CREATIVE_TYPE_STANDARD` |
| 3194 | # * `CREATIVE_TYPE_EXPANDABLE` |
| 3195 | # |
| 3196 | # Third-party VAST tag creatives are creatives with following |
| 3197 | # hosting_source: |
| 3198 | # |
| 3199 | # * `HOSTING_SOURCE_THIRD_PARTY` |
| 3200 | # |
| 3201 | # combined with following creative_type: |
| 3202 | # |
| 3203 | # * `CREATIVE_TYPE_VIDEO` |
| 3204 | "dimensions": { # Dimensions. # Required. Primary dimensions of the creative. |
| 3205 | # Applicable to all creative types. The value of |
| 3206 | # width_pixels and |
| 3207 | # height_pixels defaults to `0` |
| 3208 | # when creative_type is one of: |
| 3209 | # |
| 3210 | # * `CREATIVE_TYPE_VIDEO` |
| 3211 | # * `CREATIVE_TYPE_TEMPLATED_APP_INSTALL_INTERSTITIAL` |
| 3212 | # * `CREATIVE_TYPE_AUDIO` |
| 3213 | # * `CREATIVE_TYPE_NATIVE_VIDEO` |
| 3214 | # * `CREATIVE_TYPE_TEMPLATED_APP_INSTALL_VIDEO` |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3215 | "heightPixels": 42, # The height in pixels. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 3216 | "widthPixels": 42, # The width in pixels. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3217 | }, |
| 3218 | "appendedTag": "A String", # Third-party HTML tracking tag to be appended to the creative tag. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3219 | }</pre> |
| 3220 | </div> |
| 3221 | |
| 3222 | </body></html> |