File: displayvideo_v3.advertisers.adGroupAds.html

package info (click to toggle)
python-googleapi 2.180.0-1
  • links: PTS
  • area: main
  • in suites: forky
  • size: 527,124 kB
  • sloc: python: 11,076; javascript: 249; sh: 114; makefile: 59
file content (479 lines) | stat: -rw-r--r-- 31,383 bytes parent folder | download | duplicates (3)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
<html><body>
<style>

body, h1, h2, h3, div, span, p, pre, a {
  margin: 0;
  padding: 0;
  border: 0;
  font-weight: inherit;
  font-style: inherit;
  font-size: 100%;
  font-family: inherit;
  vertical-align: baseline;
}

body {
  font-size: 13px;
  padding: 1em;
}

h1 {
  font-size: 26px;
  margin-bottom: 1em;
}

h2 {
  font-size: 24px;
  margin-bottom: 1em;
}

h3 {
  font-size: 20px;
  margin-bottom: 1em;
  margin-top: 1em;
}

pre, code {
  line-height: 1.5;
  font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}

pre {
  margin-top: 0.5em;
}

h1, h2, h3, p {
  font-family: Arial, sans serif;
}

h1, h2, h3 {
  border-bottom: solid #CCC 1px;
}

.toc_element {
  margin-top: 0.5em;
}

.firstline {
  margin-left: 2 em;
}

.method  {
  margin-top: 1em;
  border: solid 1px #CCC;
  padding: 1em;
  background: #EEE;
}

.details {
  font-weight: bold;
  font-size: 14px;
}

</style>

<h1><a href="displayvideo_v3.html">Display & Video 360 API</a> . <a href="displayvideo_v3.advertisers.html">advertisers</a> . <a href="displayvideo_v3.advertisers.adGroupAds.html">adGroupAds</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
  <code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
  <code><a href="#get">get(advertiserId, adGroupAdId, x__xgafv=None)</a></code></p>
<p class="firstline">Gets an ad group ad.</p>
<p class="toc_element">
  <code><a href="#list">list(advertiserId, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists ad group ads.</p>
<p class="toc_element">
  <code><a href="#list_next">list_next()</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<h3>Method Details</h3>
<div class="method">
    <code class="details" id="close">close()</code>
  <pre>Close httplib2 connections.</pre>
</div>

<div class="method">
    <code class="details" id="get">get(advertiserId, adGroupAdId, x__xgafv=None)</code>
  <pre>Gets an ad group ad.

Args:
  advertiserId: string, Required. The ID of the advertiser this ad group ad belongs to. (required)
  adGroupAdId: string, Required. The ID of the ad group ad to fetch. (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A single ad associated with an ad group.
  &quot;adGroupAdId&quot;: &quot;A String&quot;, # The unique ID of the ad. Assigned by the system.
  &quot;adGroupId&quot;: &quot;A String&quot;, # The unique ID of the ad group that the ad belongs to.
  &quot;adUrls&quot;: [ # List of URLs used by the ad.
    { # Additional URLs related to the ad, including beacons.
      &quot;type&quot;: &quot;A String&quot;, # The type of the Ad URL.
      &quot;url&quot;: &quot;A String&quot;, # The URL string value.
    },
  ],
  &quot;advertiserId&quot;: &quot;A String&quot;, # The unique ID of the advertiser the ad belongs to.
  &quot;audioAd&quot;: { # Details for an audio ad. # Details of an [audio ad](//support.google.com/displayvideo/answer/6274216) used for reach marketing objectives.
    &quot;displayUrl&quot;: &quot;A String&quot;, # The webpage address that appears with the ad.
    &quot;finalUrl&quot;: &quot;A String&quot;, # The URL address of the webpage that people reach after they click the ad.
    &quot;trackingUrl&quot;: &quot;A String&quot;, # The URL address loaded in the background for tracking purposes.
    &quot;video&quot;: { # Details of a YouTube video. # The YouTube video of the ad.
      &quot;id&quot;: &quot;A String&quot;, # The YouTube video ID which can be searched on YouTube webpage.
      &quot;unavailableReason&quot;: &quot;A String&quot;, # The reason why the video data is not available.
    },
  },
  &quot;bumperAd&quot;: { # Details for a bumper ad. # Details of a [non-skippable short video ad](//support.google.com/displayvideo/answer/6274216), equal to or less than 6 seconds, used for reach.
    &quot;commonInStreamAttribute&quot;: { # Common attributes for in-stream, non-skippable and bumper ads. # Common ad attributes.
      &quot;actionButtonLabel&quot;: &quot;A String&quot;, # The text on the call-to-action button.
      &quot;actionHeadline&quot;: &quot;A String&quot;, # The headline of the call-to-action banner.
      &quot;companionBanner&quot;: { # Meta data of an image asset. # The image which shows next to the video ad.
        &quot;fileSize&quot;: &quot;A String&quot;, # File size of the image asset in bytes.
        &quot;fullSize&quot;: { # Dimensions. # Metadata for this image at its original size.
          &quot;heightPixels&quot;: 42, # The height in pixels.
          &quot;widthPixels&quot;: 42, # The width in pixels.
        },
        &quot;mimeType&quot;: &quot;A String&quot;, # MIME type of the image asset.
      },
      &quot;displayUrl&quot;: &quot;A String&quot;, # The webpage address that appears with the ad.
      &quot;finalUrl&quot;: &quot;A String&quot;, # The URL address of the webpage that people reach after they click the ad.
      &quot;trackingUrl&quot;: &quot;A String&quot;, # The URL address loaded in the background for tracking purposes.
      &quot;video&quot;: { # Details of a YouTube video. # The YouTube video of the ad.
        &quot;id&quot;: &quot;A String&quot;, # The YouTube video ID which can be searched on YouTube webpage.
        &quot;unavailableReason&quot;: &quot;A String&quot;, # The reason why the video data is not available.
      },
    },
  },
  &quot;displayName&quot;: &quot;A String&quot;, # The display name of the ad. Must be UTF-8 encoded with a maximum size of 255 bytes.
  &quot;displayVideoSourceAd&quot;: { # The ad sourced from a DV360 creative. # Details of an ad sourced from a Display &amp; Video 360 creative.
    &quot;creativeId&quot;: &quot;A String&quot;, # The ID of the source creative.
  },
  &quot;entityStatus&quot;: &quot;A String&quot;, # The entity status of the ad.
  &quot;inStreamAd&quot;: { # Details for an in-stream ad. # Details of an [in-stream ad skippable after 5 seconds](//support.google.com/displayvideo/answer/6274216), used for brand awareness or reach marketing objectives.
    &quot;commonInStreamAttribute&quot;: { # Common attributes for in-stream, non-skippable and bumper ads. # Common ad attributes.
      &quot;actionButtonLabel&quot;: &quot;A String&quot;, # The text on the call-to-action button.
      &quot;actionHeadline&quot;: &quot;A String&quot;, # The headline of the call-to-action banner.
      &quot;companionBanner&quot;: { # Meta data of an image asset. # The image which shows next to the video ad.
        &quot;fileSize&quot;: &quot;A String&quot;, # File size of the image asset in bytes.
        &quot;fullSize&quot;: { # Dimensions. # Metadata for this image at its original size.
          &quot;heightPixels&quot;: 42, # The height in pixels.
          &quot;widthPixels&quot;: 42, # The width in pixels.
        },
        &quot;mimeType&quot;: &quot;A String&quot;, # MIME type of the image asset.
      },
      &quot;displayUrl&quot;: &quot;A String&quot;, # The webpage address that appears with the ad.
      &quot;finalUrl&quot;: &quot;A String&quot;, # The URL address of the webpage that people reach after they click the ad.
      &quot;trackingUrl&quot;: &quot;A String&quot;, # The URL address loaded in the background for tracking purposes.
      &quot;video&quot;: { # Details of a YouTube video. # The YouTube video of the ad.
        &quot;id&quot;: &quot;A String&quot;, # The YouTube video ID which can be searched on YouTube webpage.
        &quot;unavailableReason&quot;: &quot;A String&quot;, # The reason why the video data is not available.
      },
    },
    &quot;customParameters&quot;: { # The custom parameters to pass custom values to tracking URL template.
      &quot;a_key&quot;: &quot;A String&quot;,
    },
  },
  &quot;mastheadAd&quot;: { # Details for a Masthead Ad. # Details of an [ad served on the YouTube Home feed](//support.google.com/google-ads/answer/9709826).
    &quot;autoplayVideoDuration&quot;: &quot;A String&quot;, # The duration of time the video will autoplay.
    &quot;autoplayVideoStartMillisecond&quot;: &quot;A String&quot;, # The amount of time in milliseconds after which the video will start to play.
    &quot;callToActionButtonLabel&quot;: &quot;A String&quot;, # The text on the call-to-action button.
    &quot;callToActionFinalUrl&quot;: &quot;A String&quot;, # The destination URL for the call-to-action button.
    &quot;callToActionTrackingUrl&quot;: &quot;A String&quot;, # The tracking URL for the call-to-action button.
    &quot;companionYoutubeVideos&quot;: [ # The videos that appear next to the Masthead Ad on desktop. Can be no more than two.
      { # Details of a YouTube video.
        &quot;id&quot;: &quot;A String&quot;, # The YouTube video ID which can be searched on YouTube webpage.
        &quot;unavailableReason&quot;: &quot;A String&quot;, # The reason why the video data is not available.
      },
    ],
    &quot;description&quot;: &quot;A String&quot;, # The description of the ad.
    &quot;headline&quot;: &quot;A String&quot;, # The headline of the ad.
    &quot;showChannelArt&quot;: True or False, # Whether to show a background or banner that appears at the top of a YouTube page.
    &quot;video&quot;: { # Details of a YouTube video. # The YouTube video used by the ad.
      &quot;id&quot;: &quot;A String&quot;, # The YouTube video ID which can be searched on YouTube webpage.
      &quot;unavailableReason&quot;: &quot;A String&quot;, # The reason why the video data is not available.
    },
    &quot;videoAspectRatio&quot;: &quot;A String&quot;, # The aspect ratio of the autoplaying YouTube video on the Masthead.
  },
  &quot;name&quot;: &quot;A String&quot;, # The resource name of the ad.
  &quot;nonSkippableAd&quot;: { # Details for a non-skippable ad. # Details of a [non-skippable short in-stream video ad](//support.google.com/displayvideo/answer/6274216), between 6 and 15 seconds, used for reach marketing objectives.
    &quot;commonInStreamAttribute&quot;: { # Common attributes for in-stream, non-skippable and bumper ads. # Common ad attributes.
      &quot;actionButtonLabel&quot;: &quot;A String&quot;, # The text on the call-to-action button.
      &quot;actionHeadline&quot;: &quot;A String&quot;, # The headline of the call-to-action banner.
      &quot;companionBanner&quot;: { # Meta data of an image asset. # The image which shows next to the video ad.
        &quot;fileSize&quot;: &quot;A String&quot;, # File size of the image asset in bytes.
        &quot;fullSize&quot;: { # Dimensions. # Metadata for this image at its original size.
          &quot;heightPixels&quot;: 42, # The height in pixels.
          &quot;widthPixels&quot;: 42, # The width in pixels.
        },
        &quot;mimeType&quot;: &quot;A String&quot;, # MIME type of the image asset.
      },
      &quot;displayUrl&quot;: &quot;A String&quot;, # The webpage address that appears with the ad.
      &quot;finalUrl&quot;: &quot;A String&quot;, # The URL address of the webpage that people reach after they click the ad.
      &quot;trackingUrl&quot;: &quot;A String&quot;, # The URL address loaded in the background for tracking purposes.
      &quot;video&quot;: { # Details of a YouTube video. # The YouTube video of the ad.
        &quot;id&quot;: &quot;A String&quot;, # The YouTube video ID which can be searched on YouTube webpage.
        &quot;unavailableReason&quot;: &quot;A String&quot;, # The reason why the video data is not available.
      },
    },
    &quot;customParameters&quot;: { # The custom parameters to pass custom values to tracking URL template.
      &quot;a_key&quot;: &quot;A String&quot;,
    },
  },
  &quot;videoDiscoverAd&quot;: { # Details for a video discovery ad. # Details of an [ad promoting a video](//support.google.com/displayvideo/answer/6274216) that shows in places of discovery.
    &quot;description1&quot;: &quot;A String&quot;, # First text line for the ad.
    &quot;description2&quot;: &quot;A String&quot;, # Second text line for the ad.
    &quot;headline&quot;: &quot;A String&quot;, # The headline of ad.
    &quot;thumbnail&quot;: &quot;A String&quot;, # Thumbnail image used in the ad.
    &quot;video&quot;: { # Details of a YouTube video. # The YouTube video the ad promotes.
      &quot;id&quot;: &quot;A String&quot;, # The YouTube video ID which can be searched on YouTube webpage.
      &quot;unavailableReason&quot;: &quot;A String&quot;, # The reason why the video data is not available.
    },
  },
  &quot;videoPerformanceAd&quot;: { # Details for a video performance ad. # Details of an [ad used in a video action campaign](//support.google.com/google-ads/answer/10147229) to drive actions to the business, service or product.
    &quot;actionButtonLabels&quot;: [ # The list of text assets shown on the call-to-action button.
      &quot;A String&quot;,
    ],
    &quot;companionBanners&quot;: [ # The list of companion banners used by this ad.
      { # Meta data of an image asset.
        &quot;fileSize&quot;: &quot;A String&quot;, # File size of the image asset in bytes.
        &quot;fullSize&quot;: { # Dimensions. # Metadata for this image at its original size.
          &quot;heightPixels&quot;: 42, # The height in pixels.
          &quot;widthPixels&quot;: 42, # The width in pixels.
        },
        &quot;mimeType&quot;: &quot;A String&quot;, # MIME type of the image asset.
      },
    ],
    &quot;customParameters&quot;: { # The custom parameters to pass custom values to tracking URL template.
      &quot;a_key&quot;: &quot;A String&quot;,
    },
    &quot;descriptions&quot;: [ # The list of descriptions shown on the call-to-action banner.
      &quot;A String&quot;,
    ],
    &quot;displayUrlBreadcrumb1&quot;: &quot;A String&quot;, # The first piece after the domain in the display URL.
    &quot;displayUrlBreadcrumb2&quot;: &quot;A String&quot;, # The second piece after the domain in the display URL.
    &quot;domain&quot;: &quot;A String&quot;, # The domain of the display URL.
    &quot;finalUrl&quot;: &quot;A String&quot;, # The URL address of the webpage that people reach after they click the ad.
    &quot;headlines&quot;: [ # The list of headlines shown on the call-to-action banner.
      &quot;A String&quot;,
    ],
    &quot;longHeadlines&quot;: [ # The list of lone headlines shown on the call-to-action banner.
      &quot;A String&quot;,
    ],
    &quot;trackingUrl&quot;: &quot;A String&quot;, # The URL address loaded in the background for tracking purposes.
    &quot;videos&quot;: [ # The list of YouTube video assets used by this ad.
      { # Details of a YouTube video.
        &quot;id&quot;: &quot;A String&quot;, # The YouTube video ID which can be searched on YouTube webpage.
        &quot;unavailableReason&quot;: &quot;A String&quot;, # The reason why the video data is not available.
      },
    ],
  },
}</pre>
</div>

<div class="method">
    <code class="details" id="list">list(advertiserId, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)</code>
  <pre>Lists ad group ads.

Args:
  advertiserId: string, Required. The ID of the advertiser the ad groups belongs to. (required)
  filter: string, Optional. Allows filtering by custom ad group ad fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` and `OR`. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `EQUALS (=)` operator. Supported fields: * `adGroupId` * `displayName` * `entityStatus` * `adGroupAdId` Examples: * All ad group ads under an ad group: `adGroupId=&quot;1234&quot;` * All ad group ads under an ad group with an entityStatus of `ENTITY_STATUS_ACTIVE` or `ENTITY_STATUS_PAUSED`: `(entityStatus=&quot;ENTITY_STATUS_ACTIVE&quot; OR entityStatus=&quot;ENTITY_STATUS_PAUSED&quot;) AND adGroupId=&quot;12345&quot;` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.
  orderBy: string, Optional. Field by which to sort the list. Acceptable values are: * `displayName` (default) * `entityStatus` The default sorting order is ascending. To specify descending order for a field, a suffix &quot;desc&quot; should be added to the field name. Example: `displayName desc`.
  pageSize: integer, Optional. Requested page size. Must be between `1` and `100`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified.
  pageToken: string, Optional. A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListAdGroupAds` method. If not specified, the first page of results will be returned.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    {
  &quot;adGroupAds&quot;: [ # The list of ad group ads. This list will be absent if empty.
    { # A single ad associated with an ad group.
      &quot;adGroupAdId&quot;: &quot;A String&quot;, # The unique ID of the ad. Assigned by the system.
      &quot;adGroupId&quot;: &quot;A String&quot;, # The unique ID of the ad group that the ad belongs to.
      &quot;adUrls&quot;: [ # List of URLs used by the ad.
        { # Additional URLs related to the ad, including beacons.
          &quot;type&quot;: &quot;A String&quot;, # The type of the Ad URL.
          &quot;url&quot;: &quot;A String&quot;, # The URL string value.
        },
      ],
      &quot;advertiserId&quot;: &quot;A String&quot;, # The unique ID of the advertiser the ad belongs to.
      &quot;audioAd&quot;: { # Details for an audio ad. # Details of an [audio ad](//support.google.com/displayvideo/answer/6274216) used for reach marketing objectives.
        &quot;displayUrl&quot;: &quot;A String&quot;, # The webpage address that appears with the ad.
        &quot;finalUrl&quot;: &quot;A String&quot;, # The URL address of the webpage that people reach after they click the ad.
        &quot;trackingUrl&quot;: &quot;A String&quot;, # The URL address loaded in the background for tracking purposes.
        &quot;video&quot;: { # Details of a YouTube video. # The YouTube video of the ad.
          &quot;id&quot;: &quot;A String&quot;, # The YouTube video ID which can be searched on YouTube webpage.
          &quot;unavailableReason&quot;: &quot;A String&quot;, # The reason why the video data is not available.
        },
      },
      &quot;bumperAd&quot;: { # Details for a bumper ad. # Details of a [non-skippable short video ad](//support.google.com/displayvideo/answer/6274216), equal to or less than 6 seconds, used for reach.
        &quot;commonInStreamAttribute&quot;: { # Common attributes for in-stream, non-skippable and bumper ads. # Common ad attributes.
          &quot;actionButtonLabel&quot;: &quot;A String&quot;, # The text on the call-to-action button.
          &quot;actionHeadline&quot;: &quot;A String&quot;, # The headline of the call-to-action banner.
          &quot;companionBanner&quot;: { # Meta data of an image asset. # The image which shows next to the video ad.
            &quot;fileSize&quot;: &quot;A String&quot;, # File size of the image asset in bytes.
            &quot;fullSize&quot;: { # Dimensions. # Metadata for this image at its original size.
              &quot;heightPixels&quot;: 42, # The height in pixels.
              &quot;widthPixels&quot;: 42, # The width in pixels.
            },
            &quot;mimeType&quot;: &quot;A String&quot;, # MIME type of the image asset.
          },
          &quot;displayUrl&quot;: &quot;A String&quot;, # The webpage address that appears with the ad.
          &quot;finalUrl&quot;: &quot;A String&quot;, # The URL address of the webpage that people reach after they click the ad.
          &quot;trackingUrl&quot;: &quot;A String&quot;, # The URL address loaded in the background for tracking purposes.
          &quot;video&quot;: { # Details of a YouTube video. # The YouTube video of the ad.
            &quot;id&quot;: &quot;A String&quot;, # The YouTube video ID which can be searched on YouTube webpage.
            &quot;unavailableReason&quot;: &quot;A String&quot;, # The reason why the video data is not available.
          },
        },
      },
      &quot;displayName&quot;: &quot;A String&quot;, # The display name of the ad. Must be UTF-8 encoded with a maximum size of 255 bytes.
      &quot;displayVideoSourceAd&quot;: { # The ad sourced from a DV360 creative. # Details of an ad sourced from a Display &amp; Video 360 creative.
        &quot;creativeId&quot;: &quot;A String&quot;, # The ID of the source creative.
      },
      &quot;entityStatus&quot;: &quot;A String&quot;, # The entity status of the ad.
      &quot;inStreamAd&quot;: { # Details for an in-stream ad. # Details of an [in-stream ad skippable after 5 seconds](//support.google.com/displayvideo/answer/6274216), used for brand awareness or reach marketing objectives.
        &quot;commonInStreamAttribute&quot;: { # Common attributes for in-stream, non-skippable and bumper ads. # Common ad attributes.
          &quot;actionButtonLabel&quot;: &quot;A String&quot;, # The text on the call-to-action button.
          &quot;actionHeadline&quot;: &quot;A String&quot;, # The headline of the call-to-action banner.
          &quot;companionBanner&quot;: { # Meta data of an image asset. # The image which shows next to the video ad.
            &quot;fileSize&quot;: &quot;A String&quot;, # File size of the image asset in bytes.
            &quot;fullSize&quot;: { # Dimensions. # Metadata for this image at its original size.
              &quot;heightPixels&quot;: 42, # The height in pixels.
              &quot;widthPixels&quot;: 42, # The width in pixels.
            },
            &quot;mimeType&quot;: &quot;A String&quot;, # MIME type of the image asset.
          },
          &quot;displayUrl&quot;: &quot;A String&quot;, # The webpage address that appears with the ad.
          &quot;finalUrl&quot;: &quot;A String&quot;, # The URL address of the webpage that people reach after they click the ad.
          &quot;trackingUrl&quot;: &quot;A String&quot;, # The URL address loaded in the background for tracking purposes.
          &quot;video&quot;: { # Details of a YouTube video. # The YouTube video of the ad.
            &quot;id&quot;: &quot;A String&quot;, # The YouTube video ID which can be searched on YouTube webpage.
            &quot;unavailableReason&quot;: &quot;A String&quot;, # The reason why the video data is not available.
          },
        },
        &quot;customParameters&quot;: { # The custom parameters to pass custom values to tracking URL template.
          &quot;a_key&quot;: &quot;A String&quot;,
        },
      },
      &quot;mastheadAd&quot;: { # Details for a Masthead Ad. # Details of an [ad served on the YouTube Home feed](//support.google.com/google-ads/answer/9709826).
        &quot;autoplayVideoDuration&quot;: &quot;A String&quot;, # The duration of time the video will autoplay.
        &quot;autoplayVideoStartMillisecond&quot;: &quot;A String&quot;, # The amount of time in milliseconds after which the video will start to play.
        &quot;callToActionButtonLabel&quot;: &quot;A String&quot;, # The text on the call-to-action button.
        &quot;callToActionFinalUrl&quot;: &quot;A String&quot;, # The destination URL for the call-to-action button.
        &quot;callToActionTrackingUrl&quot;: &quot;A String&quot;, # The tracking URL for the call-to-action button.
        &quot;companionYoutubeVideos&quot;: [ # The videos that appear next to the Masthead Ad on desktop. Can be no more than two.
          { # Details of a YouTube video.
            &quot;id&quot;: &quot;A String&quot;, # The YouTube video ID which can be searched on YouTube webpage.
            &quot;unavailableReason&quot;: &quot;A String&quot;, # The reason why the video data is not available.
          },
        ],
        &quot;description&quot;: &quot;A String&quot;, # The description of the ad.
        &quot;headline&quot;: &quot;A String&quot;, # The headline of the ad.
        &quot;showChannelArt&quot;: True or False, # Whether to show a background or banner that appears at the top of a YouTube page.
        &quot;video&quot;: { # Details of a YouTube video. # The YouTube video used by the ad.
          &quot;id&quot;: &quot;A String&quot;, # The YouTube video ID which can be searched on YouTube webpage.
          &quot;unavailableReason&quot;: &quot;A String&quot;, # The reason why the video data is not available.
        },
        &quot;videoAspectRatio&quot;: &quot;A String&quot;, # The aspect ratio of the autoplaying YouTube video on the Masthead.
      },
      &quot;name&quot;: &quot;A String&quot;, # The resource name of the ad.
      &quot;nonSkippableAd&quot;: { # Details for a non-skippable ad. # Details of a [non-skippable short in-stream video ad](//support.google.com/displayvideo/answer/6274216), between 6 and 15 seconds, used for reach marketing objectives.
        &quot;commonInStreamAttribute&quot;: { # Common attributes for in-stream, non-skippable and bumper ads. # Common ad attributes.
          &quot;actionButtonLabel&quot;: &quot;A String&quot;, # The text on the call-to-action button.
          &quot;actionHeadline&quot;: &quot;A String&quot;, # The headline of the call-to-action banner.
          &quot;companionBanner&quot;: { # Meta data of an image asset. # The image which shows next to the video ad.
            &quot;fileSize&quot;: &quot;A String&quot;, # File size of the image asset in bytes.
            &quot;fullSize&quot;: { # Dimensions. # Metadata for this image at its original size.
              &quot;heightPixels&quot;: 42, # The height in pixels.
              &quot;widthPixels&quot;: 42, # The width in pixels.
            },
            &quot;mimeType&quot;: &quot;A String&quot;, # MIME type of the image asset.
          },
          &quot;displayUrl&quot;: &quot;A String&quot;, # The webpage address that appears with the ad.
          &quot;finalUrl&quot;: &quot;A String&quot;, # The URL address of the webpage that people reach after they click the ad.
          &quot;trackingUrl&quot;: &quot;A String&quot;, # The URL address loaded in the background for tracking purposes.
          &quot;video&quot;: { # Details of a YouTube video. # The YouTube video of the ad.
            &quot;id&quot;: &quot;A String&quot;, # The YouTube video ID which can be searched on YouTube webpage.
            &quot;unavailableReason&quot;: &quot;A String&quot;, # The reason why the video data is not available.
          },
        },
        &quot;customParameters&quot;: { # The custom parameters to pass custom values to tracking URL template.
          &quot;a_key&quot;: &quot;A String&quot;,
        },
      },
      &quot;videoDiscoverAd&quot;: { # Details for a video discovery ad. # Details of an [ad promoting a video](//support.google.com/displayvideo/answer/6274216) that shows in places of discovery.
        &quot;description1&quot;: &quot;A String&quot;, # First text line for the ad.
        &quot;description2&quot;: &quot;A String&quot;, # Second text line for the ad.
        &quot;headline&quot;: &quot;A String&quot;, # The headline of ad.
        &quot;thumbnail&quot;: &quot;A String&quot;, # Thumbnail image used in the ad.
        &quot;video&quot;: { # Details of a YouTube video. # The YouTube video the ad promotes.
          &quot;id&quot;: &quot;A String&quot;, # The YouTube video ID which can be searched on YouTube webpage.
          &quot;unavailableReason&quot;: &quot;A String&quot;, # The reason why the video data is not available.
        },
      },
      &quot;videoPerformanceAd&quot;: { # Details for a video performance ad. # Details of an [ad used in a video action campaign](//support.google.com/google-ads/answer/10147229) to drive actions to the business, service or product.
        &quot;actionButtonLabels&quot;: [ # The list of text assets shown on the call-to-action button.
          &quot;A String&quot;,
        ],
        &quot;companionBanners&quot;: [ # The list of companion banners used by this ad.
          { # Meta data of an image asset.
            &quot;fileSize&quot;: &quot;A String&quot;, # File size of the image asset in bytes.
            &quot;fullSize&quot;: { # Dimensions. # Metadata for this image at its original size.
              &quot;heightPixels&quot;: 42, # The height in pixels.
              &quot;widthPixels&quot;: 42, # The width in pixels.
            },
            &quot;mimeType&quot;: &quot;A String&quot;, # MIME type of the image asset.
          },
        ],
        &quot;customParameters&quot;: { # The custom parameters to pass custom values to tracking URL template.
          &quot;a_key&quot;: &quot;A String&quot;,
        },
        &quot;descriptions&quot;: [ # The list of descriptions shown on the call-to-action banner.
          &quot;A String&quot;,
        ],
        &quot;displayUrlBreadcrumb1&quot;: &quot;A String&quot;, # The first piece after the domain in the display URL.
        &quot;displayUrlBreadcrumb2&quot;: &quot;A String&quot;, # The second piece after the domain in the display URL.
        &quot;domain&quot;: &quot;A String&quot;, # The domain of the display URL.
        &quot;finalUrl&quot;: &quot;A String&quot;, # The URL address of the webpage that people reach after they click the ad.
        &quot;headlines&quot;: [ # The list of headlines shown on the call-to-action banner.
          &quot;A String&quot;,
        ],
        &quot;longHeadlines&quot;: [ # The list of lone headlines shown on the call-to-action banner.
          &quot;A String&quot;,
        ],
        &quot;trackingUrl&quot;: &quot;A String&quot;, # The URL address loaded in the background for tracking purposes.
        &quot;videos&quot;: [ # The list of YouTube video assets used by this ad.
          { # Details of a YouTube video.
            &quot;id&quot;: &quot;A String&quot;, # The YouTube video ID which can be searched on YouTube webpage.
            &quot;unavailableReason&quot;: &quot;A String&quot;, # The reason why the video data is not available.
          },
        ],
      },
    },
  ],
  &quot;nextPageToken&quot;: &quot;A String&quot;, # A token to retrieve the next page of results. Pass this value in the page_token field in the subsequent call to `ListAdGroupAds` method to retrieve the next page of results.
}</pre>
</div>

<div class="method">
    <code class="details" id="list_next">list_next()</code>
  <pre>Retrieves the next page of results.

        Args:
          previous_request: The request for the previous page. (required)
          previous_response: The response from the request for the previous page. (required)

        Returns:
          A request object that you can call &#x27;execute()&#x27; on to request the next
          page. Returns None if there are no more items in the collection.
        </pre>
</div>

</body></html>