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
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
|
<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="adsensehost_v4_1.html">AdSense Host API</a> . <a href="adsensehost_v4_1.accounts.html">accounts</a> . <a href="adsensehost_v4_1.accounts.adunits.html">adunits</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="#delete">delete(accountId, adClientId, adUnitId)</a></code></p>
<p class="firstline">Delete the specified ad unit from the specified publisher AdSense account.</p>
<p class="toc_element">
<code><a href="#get">get(accountId, adClientId, adUnitId)</a></code></p>
<p class="firstline">Get the specified host ad unit in this AdSense account.</p>
<p class="toc_element">
<code><a href="#getAdCode">getAdCode(accountId, adClientId, adUnitId, hostCustomChannelId=None)</a></code></p>
<p class="firstline">Get ad code for the specified ad unit, attaching the specified host custom channels.</p>
<p class="toc_element">
<code><a href="#insert">insert(accountId, adClientId, body=None)</a></code></p>
<p class="firstline">Insert the supplied ad unit into the specified publisher AdSense account.</p>
<p class="toc_element">
<code><a href="#list">list(accountId, adClientId, includeInactive=None, maxResults=None, pageToken=None)</a></code></p>
<p class="firstline">List all ad units in the specified publisher's AdSense account.</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>
<p class="toc_element">
<code><a href="#patch">patch(accountId, adClientId, adUnitId, body=None)</a></code></p>
<p class="firstline">Update the supplied ad unit in the specified publisher AdSense account. This method supports patch semantics.</p>
<p class="toc_element">
<code><a href="#update">update(accountId, adClientId, body=None)</a></code></p>
<p class="firstline">Update the supplied ad unit in the specified publisher AdSense account.</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="delete">delete(accountId, adClientId, adUnitId)</code>
<pre>Delete the specified ad unit from the specified publisher AdSense account.
Args:
accountId: string, Account which contains the ad unit. (required)
adClientId: string, Ad client for which to get ad unit. (required)
adUnitId: string, Ad unit to delete. (required)
Returns:
An object of the form:
{
"code": "A String", # Identity code of this ad unit, not necessarily unique across ad clients.
"contentAdsSettings": { # Settings specific to content ads (AFC) and highend mobile content ads (AFMC - deprecated).
"backupOption": { # The backup option to be used in instances where no ad is available.
"color": "A String", # Color to use when type is set to COLOR. These are represented as six hexadecimal characters, similar to HTML color codes, but without the leading hash.
"type": "A String", # Type of the backup option. Possible values are BLANK, COLOR and URL.
"url": "A String", # URL to use when type is set to URL.
},
"size": "A String", # Size of this ad unit. Size values are in the form SIZE_{width}_{height}.
"type": "A String", # Type of this ad unit. Possible values are TEXT, TEXT_IMAGE, IMAGE and LINK.
},
"customStyle": { # Custom style information specific to this ad unit.
"colors": { # The colors included in the style. These are represented as six hexadecimal characters, similar to HTML color codes, but without the leading hash.
"background": "A String", # The color of the ad background.
"border": "A String", # The color of the ad border.
"text": "A String", # The color of the ad text.
"title": "A String", # The color of the ad title.
"url": "A String", # The color of the ad url.
},
"corners": "A String", # The style of the corners in the ad (deprecated: never populated, ignored).
"font": { # The font which is included in the style.
"family": "A String", # The family of the font. Possible values are: ACCOUNT_DEFAULT_FAMILY, ADSENSE_DEFAULT_FAMILY, ARIAL, TIMES and VERDANA.
"size": "A String", # The size of the font. Possible values are: ACCOUNT_DEFAULT_SIZE, ADSENSE_DEFAULT_SIZE, SMALL, MEDIUM and LARGE.
},
"kind": "adsensehost#adStyle", # Kind this is, in this case adsensehost#adStyle.
},
"id": "A String", # Unique identifier of this ad unit. This should be considered an opaque identifier; it is not safe to rely on it being in any particular format.
"kind": "adsensehost#adUnit", # Kind of resource this is, in this case adsensehost#adUnit.
"mobileContentAdsSettings": { # Settings specific to WAP mobile content ads (AFMC - deprecated).
"markupLanguage": "A String", # The markup language to use for this ad unit.
"scriptingLanguage": "A String", # The scripting language to use for this ad unit.
"size": "A String", # Size of this ad unit.
"type": "A String", # Type of this ad unit.
},
"name": "A String", # Name of this ad unit.
"status": "A String", # Status of this ad unit. Possible values are:
# NEW: Indicates that the ad unit was created within the last seven days and does not yet have any activity associated with it.
#
# ACTIVE: Indicates that there has been activity on this ad unit in the last seven days.
#
# INACTIVE: Indicates that there has been no activity on this ad unit in the last seven days.
}</pre>
</div>
<div class="method">
<code class="details" id="get">get(accountId, adClientId, adUnitId)</code>
<pre>Get the specified host ad unit in this AdSense account.
Args:
accountId: string, Account which contains the ad unit. (required)
adClientId: string, Ad client for which to get ad unit. (required)
adUnitId: string, Ad unit to get. (required)
Returns:
An object of the form:
{
"code": "A String", # Identity code of this ad unit, not necessarily unique across ad clients.
"contentAdsSettings": { # Settings specific to content ads (AFC) and highend mobile content ads (AFMC - deprecated).
"backupOption": { # The backup option to be used in instances where no ad is available.
"color": "A String", # Color to use when type is set to COLOR. These are represented as six hexadecimal characters, similar to HTML color codes, but without the leading hash.
"type": "A String", # Type of the backup option. Possible values are BLANK, COLOR and URL.
"url": "A String", # URL to use when type is set to URL.
},
"size": "A String", # Size of this ad unit. Size values are in the form SIZE_{width}_{height}.
"type": "A String", # Type of this ad unit. Possible values are TEXT, TEXT_IMAGE, IMAGE and LINK.
},
"customStyle": { # Custom style information specific to this ad unit.
"colors": { # The colors included in the style. These are represented as six hexadecimal characters, similar to HTML color codes, but without the leading hash.
"background": "A String", # The color of the ad background.
"border": "A String", # The color of the ad border.
"text": "A String", # The color of the ad text.
"title": "A String", # The color of the ad title.
"url": "A String", # The color of the ad url.
},
"corners": "A String", # The style of the corners in the ad (deprecated: never populated, ignored).
"font": { # The font which is included in the style.
"family": "A String", # The family of the font. Possible values are: ACCOUNT_DEFAULT_FAMILY, ADSENSE_DEFAULT_FAMILY, ARIAL, TIMES and VERDANA.
"size": "A String", # The size of the font. Possible values are: ACCOUNT_DEFAULT_SIZE, ADSENSE_DEFAULT_SIZE, SMALL, MEDIUM and LARGE.
},
"kind": "adsensehost#adStyle", # Kind this is, in this case adsensehost#adStyle.
},
"id": "A String", # Unique identifier of this ad unit. This should be considered an opaque identifier; it is not safe to rely on it being in any particular format.
"kind": "adsensehost#adUnit", # Kind of resource this is, in this case adsensehost#adUnit.
"mobileContentAdsSettings": { # Settings specific to WAP mobile content ads (AFMC - deprecated).
"markupLanguage": "A String", # The markup language to use for this ad unit.
"scriptingLanguage": "A String", # The scripting language to use for this ad unit.
"size": "A String", # Size of this ad unit.
"type": "A String", # Type of this ad unit.
},
"name": "A String", # Name of this ad unit.
"status": "A String", # Status of this ad unit. Possible values are:
# NEW: Indicates that the ad unit was created within the last seven days and does not yet have any activity associated with it.
#
# ACTIVE: Indicates that there has been activity on this ad unit in the last seven days.
#
# INACTIVE: Indicates that there has been no activity on this ad unit in the last seven days.
}</pre>
</div>
<div class="method">
<code class="details" id="getAdCode">getAdCode(accountId, adClientId, adUnitId, hostCustomChannelId=None)</code>
<pre>Get ad code for the specified ad unit, attaching the specified host custom channels.
Args:
accountId: string, Account which contains the ad client. (required)
adClientId: string, Ad client with contains the ad unit. (required)
adUnitId: string, Ad unit to get the code for. (required)
hostCustomChannelId: string, Host custom channel to attach to the ad code. (repeated)
Returns:
An object of the form:
{
"adCode": "A String", # The ad code snippet.
"kind": "adsensehost#adCode", # Kind this is, in this case adsensehost#adCode.
}</pre>
</div>
<div class="method">
<code class="details" id="insert">insert(accountId, adClientId, body=None)</code>
<pre>Insert the supplied ad unit into the specified publisher AdSense account.
Args:
accountId: string, Account which will contain the ad unit. (required)
adClientId: string, Ad client into which to insert the ad unit. (required)
body: object, The request body.
The object takes the form of:
{
"code": "A String", # Identity code of this ad unit, not necessarily unique across ad clients.
"contentAdsSettings": { # Settings specific to content ads (AFC) and highend mobile content ads (AFMC - deprecated).
"backupOption": { # The backup option to be used in instances where no ad is available.
"color": "A String", # Color to use when type is set to COLOR. These are represented as six hexadecimal characters, similar to HTML color codes, but without the leading hash.
"type": "A String", # Type of the backup option. Possible values are BLANK, COLOR and URL.
"url": "A String", # URL to use when type is set to URL.
},
"size": "A String", # Size of this ad unit. Size values are in the form SIZE_{width}_{height}.
"type": "A String", # Type of this ad unit. Possible values are TEXT, TEXT_IMAGE, IMAGE and LINK.
},
"customStyle": { # Custom style information specific to this ad unit.
"colors": { # The colors included in the style. These are represented as six hexadecimal characters, similar to HTML color codes, but without the leading hash.
"background": "A String", # The color of the ad background.
"border": "A String", # The color of the ad border.
"text": "A String", # The color of the ad text.
"title": "A String", # The color of the ad title.
"url": "A String", # The color of the ad url.
},
"corners": "A String", # The style of the corners in the ad (deprecated: never populated, ignored).
"font": { # The font which is included in the style.
"family": "A String", # The family of the font. Possible values are: ACCOUNT_DEFAULT_FAMILY, ADSENSE_DEFAULT_FAMILY, ARIAL, TIMES and VERDANA.
"size": "A String", # The size of the font. Possible values are: ACCOUNT_DEFAULT_SIZE, ADSENSE_DEFAULT_SIZE, SMALL, MEDIUM and LARGE.
},
"kind": "adsensehost#adStyle", # Kind this is, in this case adsensehost#adStyle.
},
"id": "A String", # Unique identifier of this ad unit. This should be considered an opaque identifier; it is not safe to rely on it being in any particular format.
"kind": "adsensehost#adUnit", # Kind of resource this is, in this case adsensehost#adUnit.
"mobileContentAdsSettings": { # Settings specific to WAP mobile content ads (AFMC - deprecated).
"markupLanguage": "A String", # The markup language to use for this ad unit.
"scriptingLanguage": "A String", # The scripting language to use for this ad unit.
"size": "A String", # Size of this ad unit.
"type": "A String", # Type of this ad unit.
},
"name": "A String", # Name of this ad unit.
"status": "A String", # Status of this ad unit. Possible values are:
# NEW: Indicates that the ad unit was created within the last seven days and does not yet have any activity associated with it.
#
# ACTIVE: Indicates that there has been activity on this ad unit in the last seven days.
#
# INACTIVE: Indicates that there has been no activity on this ad unit in the last seven days.
}
Returns:
An object of the form:
{
"code": "A String", # Identity code of this ad unit, not necessarily unique across ad clients.
"contentAdsSettings": { # Settings specific to content ads (AFC) and highend mobile content ads (AFMC - deprecated).
"backupOption": { # The backup option to be used in instances where no ad is available.
"color": "A String", # Color to use when type is set to COLOR. These are represented as six hexadecimal characters, similar to HTML color codes, but without the leading hash.
"type": "A String", # Type of the backup option. Possible values are BLANK, COLOR and URL.
"url": "A String", # URL to use when type is set to URL.
},
"size": "A String", # Size of this ad unit. Size values are in the form SIZE_{width}_{height}.
"type": "A String", # Type of this ad unit. Possible values are TEXT, TEXT_IMAGE, IMAGE and LINK.
},
"customStyle": { # Custom style information specific to this ad unit.
"colors": { # The colors included in the style. These are represented as six hexadecimal characters, similar to HTML color codes, but without the leading hash.
"background": "A String", # The color of the ad background.
"border": "A String", # The color of the ad border.
"text": "A String", # The color of the ad text.
"title": "A String", # The color of the ad title.
"url": "A String", # The color of the ad url.
},
"corners": "A String", # The style of the corners in the ad (deprecated: never populated, ignored).
"font": { # The font which is included in the style.
"family": "A String", # The family of the font. Possible values are: ACCOUNT_DEFAULT_FAMILY, ADSENSE_DEFAULT_FAMILY, ARIAL, TIMES and VERDANA.
"size": "A String", # The size of the font. Possible values are: ACCOUNT_DEFAULT_SIZE, ADSENSE_DEFAULT_SIZE, SMALL, MEDIUM and LARGE.
},
"kind": "adsensehost#adStyle", # Kind this is, in this case adsensehost#adStyle.
},
"id": "A String", # Unique identifier of this ad unit. This should be considered an opaque identifier; it is not safe to rely on it being in any particular format.
"kind": "adsensehost#adUnit", # Kind of resource this is, in this case adsensehost#adUnit.
"mobileContentAdsSettings": { # Settings specific to WAP mobile content ads (AFMC - deprecated).
"markupLanguage": "A String", # The markup language to use for this ad unit.
"scriptingLanguage": "A String", # The scripting language to use for this ad unit.
"size": "A String", # Size of this ad unit.
"type": "A String", # Type of this ad unit.
},
"name": "A String", # Name of this ad unit.
"status": "A String", # Status of this ad unit. Possible values are:
# NEW: Indicates that the ad unit was created within the last seven days and does not yet have any activity associated with it.
#
# ACTIVE: Indicates that there has been activity on this ad unit in the last seven days.
#
# INACTIVE: Indicates that there has been no activity on this ad unit in the last seven days.
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(accountId, adClientId, includeInactive=None, maxResults=None, pageToken=None)</code>
<pre>List all ad units in the specified publisher's AdSense account.
Args:
accountId: string, Account which contains the ad client. (required)
adClientId: string, Ad client for which to list ad units. (required)
includeInactive: boolean, Whether to include inactive ad units. Default: true.
maxResults: integer, The maximum number of ad units to include in the response, used for paging.
pageToken: string, A continuation token, used to page through ad units. To retrieve the next page, set this parameter to the value of "nextPageToken" from the previous response.
Returns:
An object of the form:
{
"etag": "A String", # ETag of this response for caching purposes.
"items": [ # The ad units returned in this list response.
{
"code": "A String", # Identity code of this ad unit, not necessarily unique across ad clients.
"contentAdsSettings": { # Settings specific to content ads (AFC) and highend mobile content ads (AFMC - deprecated).
"backupOption": { # The backup option to be used in instances where no ad is available.
"color": "A String", # Color to use when type is set to COLOR. These are represented as six hexadecimal characters, similar to HTML color codes, but without the leading hash.
"type": "A String", # Type of the backup option. Possible values are BLANK, COLOR and URL.
"url": "A String", # URL to use when type is set to URL.
},
"size": "A String", # Size of this ad unit. Size values are in the form SIZE_{width}_{height}.
"type": "A String", # Type of this ad unit. Possible values are TEXT, TEXT_IMAGE, IMAGE and LINK.
},
"customStyle": { # Custom style information specific to this ad unit.
"colors": { # The colors included in the style. These are represented as six hexadecimal characters, similar to HTML color codes, but without the leading hash.
"background": "A String", # The color of the ad background.
"border": "A String", # The color of the ad border.
"text": "A String", # The color of the ad text.
"title": "A String", # The color of the ad title.
"url": "A String", # The color of the ad url.
},
"corners": "A String", # The style of the corners in the ad (deprecated: never populated, ignored).
"font": { # The font which is included in the style.
"family": "A String", # The family of the font. Possible values are: ACCOUNT_DEFAULT_FAMILY, ADSENSE_DEFAULT_FAMILY, ARIAL, TIMES and VERDANA.
"size": "A String", # The size of the font. Possible values are: ACCOUNT_DEFAULT_SIZE, ADSENSE_DEFAULT_SIZE, SMALL, MEDIUM and LARGE.
},
"kind": "adsensehost#adStyle", # Kind this is, in this case adsensehost#adStyle.
},
"id": "A String", # Unique identifier of this ad unit. This should be considered an opaque identifier; it is not safe to rely on it being in any particular format.
"kind": "adsensehost#adUnit", # Kind of resource this is, in this case adsensehost#adUnit.
"mobileContentAdsSettings": { # Settings specific to WAP mobile content ads (AFMC - deprecated).
"markupLanguage": "A String", # The markup language to use for this ad unit.
"scriptingLanguage": "A String", # The scripting language to use for this ad unit.
"size": "A String", # Size of this ad unit.
"type": "A String", # Type of this ad unit.
},
"name": "A String", # Name of this ad unit.
"status": "A String", # Status of this ad unit. Possible values are:
# NEW: Indicates that the ad unit was created within the last seven days and does not yet have any activity associated with it.
#
# ACTIVE: Indicates that there has been activity on this ad unit in the last seven days.
#
# INACTIVE: Indicates that there has been no activity on this ad unit in the last seven days.
},
],
"kind": "adsensehost#adUnits", # Kind of list this is, in this case adsensehost#adUnits.
"nextPageToken": "A String", # Continuation token used to page through ad units. To retrieve the next page of results, set the next request's "pageToken" value to this.
}</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 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
<div class="method">
<code class="details" id="patch">patch(accountId, adClientId, adUnitId, body=None)</code>
<pre>Update the supplied ad unit in the specified publisher AdSense account. This method supports patch semantics.
Args:
accountId: string, Account which contains the ad client. (required)
adClientId: string, Ad client which contains the ad unit. (required)
adUnitId: string, Ad unit to get. (required)
body: object, The request body.
The object takes the form of:
{
"code": "A String", # Identity code of this ad unit, not necessarily unique across ad clients.
"contentAdsSettings": { # Settings specific to content ads (AFC) and highend mobile content ads (AFMC - deprecated).
"backupOption": { # The backup option to be used in instances where no ad is available.
"color": "A String", # Color to use when type is set to COLOR. These are represented as six hexadecimal characters, similar to HTML color codes, but without the leading hash.
"type": "A String", # Type of the backup option. Possible values are BLANK, COLOR and URL.
"url": "A String", # URL to use when type is set to URL.
},
"size": "A String", # Size of this ad unit. Size values are in the form SIZE_{width}_{height}.
"type": "A String", # Type of this ad unit. Possible values are TEXT, TEXT_IMAGE, IMAGE and LINK.
},
"customStyle": { # Custom style information specific to this ad unit.
"colors": { # The colors included in the style. These are represented as six hexadecimal characters, similar to HTML color codes, but without the leading hash.
"background": "A String", # The color of the ad background.
"border": "A String", # The color of the ad border.
"text": "A String", # The color of the ad text.
"title": "A String", # The color of the ad title.
"url": "A String", # The color of the ad url.
},
"corners": "A String", # The style of the corners in the ad (deprecated: never populated, ignored).
"font": { # The font which is included in the style.
"family": "A String", # The family of the font. Possible values are: ACCOUNT_DEFAULT_FAMILY, ADSENSE_DEFAULT_FAMILY, ARIAL, TIMES and VERDANA.
"size": "A String", # The size of the font. Possible values are: ACCOUNT_DEFAULT_SIZE, ADSENSE_DEFAULT_SIZE, SMALL, MEDIUM and LARGE.
},
"kind": "adsensehost#adStyle", # Kind this is, in this case adsensehost#adStyle.
},
"id": "A String", # Unique identifier of this ad unit. This should be considered an opaque identifier; it is not safe to rely on it being in any particular format.
"kind": "adsensehost#adUnit", # Kind of resource this is, in this case adsensehost#adUnit.
"mobileContentAdsSettings": { # Settings specific to WAP mobile content ads (AFMC - deprecated).
"markupLanguage": "A String", # The markup language to use for this ad unit.
"scriptingLanguage": "A String", # The scripting language to use for this ad unit.
"size": "A String", # Size of this ad unit.
"type": "A String", # Type of this ad unit.
},
"name": "A String", # Name of this ad unit.
"status": "A String", # Status of this ad unit. Possible values are:
# NEW: Indicates that the ad unit was created within the last seven days and does not yet have any activity associated with it.
#
# ACTIVE: Indicates that there has been activity on this ad unit in the last seven days.
#
# INACTIVE: Indicates that there has been no activity on this ad unit in the last seven days.
}
Returns:
An object of the form:
{
"code": "A String", # Identity code of this ad unit, not necessarily unique across ad clients.
"contentAdsSettings": { # Settings specific to content ads (AFC) and highend mobile content ads (AFMC - deprecated).
"backupOption": { # The backup option to be used in instances where no ad is available.
"color": "A String", # Color to use when type is set to COLOR. These are represented as six hexadecimal characters, similar to HTML color codes, but without the leading hash.
"type": "A String", # Type of the backup option. Possible values are BLANK, COLOR and URL.
"url": "A String", # URL to use when type is set to URL.
},
"size": "A String", # Size of this ad unit. Size values are in the form SIZE_{width}_{height}.
"type": "A String", # Type of this ad unit. Possible values are TEXT, TEXT_IMAGE, IMAGE and LINK.
},
"customStyle": { # Custom style information specific to this ad unit.
"colors": { # The colors included in the style. These are represented as six hexadecimal characters, similar to HTML color codes, but without the leading hash.
"background": "A String", # The color of the ad background.
"border": "A String", # The color of the ad border.
"text": "A String", # The color of the ad text.
"title": "A String", # The color of the ad title.
"url": "A String", # The color of the ad url.
},
"corners": "A String", # The style of the corners in the ad (deprecated: never populated, ignored).
"font": { # The font which is included in the style.
"family": "A String", # The family of the font. Possible values are: ACCOUNT_DEFAULT_FAMILY, ADSENSE_DEFAULT_FAMILY, ARIAL, TIMES and VERDANA.
"size": "A String", # The size of the font. Possible values are: ACCOUNT_DEFAULT_SIZE, ADSENSE_DEFAULT_SIZE, SMALL, MEDIUM and LARGE.
},
"kind": "adsensehost#adStyle", # Kind this is, in this case adsensehost#adStyle.
},
"id": "A String", # Unique identifier of this ad unit. This should be considered an opaque identifier; it is not safe to rely on it being in any particular format.
"kind": "adsensehost#adUnit", # Kind of resource this is, in this case adsensehost#adUnit.
"mobileContentAdsSettings": { # Settings specific to WAP mobile content ads (AFMC - deprecated).
"markupLanguage": "A String", # The markup language to use for this ad unit.
"scriptingLanguage": "A String", # The scripting language to use for this ad unit.
"size": "A String", # Size of this ad unit.
"type": "A String", # Type of this ad unit.
},
"name": "A String", # Name of this ad unit.
"status": "A String", # Status of this ad unit. Possible values are:
# NEW: Indicates that the ad unit was created within the last seven days and does not yet have any activity associated with it.
#
# ACTIVE: Indicates that there has been activity on this ad unit in the last seven days.
#
# INACTIVE: Indicates that there has been no activity on this ad unit in the last seven days.
}</pre>
</div>
<div class="method">
<code class="details" id="update">update(accountId, adClientId, body=None)</code>
<pre>Update the supplied ad unit in the specified publisher AdSense account.
Args:
accountId: string, Account which contains the ad client. (required)
adClientId: string, Ad client which contains the ad unit. (required)
body: object, The request body.
The object takes the form of:
{
"code": "A String", # Identity code of this ad unit, not necessarily unique across ad clients.
"contentAdsSettings": { # Settings specific to content ads (AFC) and highend mobile content ads (AFMC - deprecated).
"backupOption": { # The backup option to be used in instances where no ad is available.
"color": "A String", # Color to use when type is set to COLOR. These are represented as six hexadecimal characters, similar to HTML color codes, but without the leading hash.
"type": "A String", # Type of the backup option. Possible values are BLANK, COLOR and URL.
"url": "A String", # URL to use when type is set to URL.
},
"size": "A String", # Size of this ad unit. Size values are in the form SIZE_{width}_{height}.
"type": "A String", # Type of this ad unit. Possible values are TEXT, TEXT_IMAGE, IMAGE and LINK.
},
"customStyle": { # Custom style information specific to this ad unit.
"colors": { # The colors included in the style. These are represented as six hexadecimal characters, similar to HTML color codes, but without the leading hash.
"background": "A String", # The color of the ad background.
"border": "A String", # The color of the ad border.
"text": "A String", # The color of the ad text.
"title": "A String", # The color of the ad title.
"url": "A String", # The color of the ad url.
},
"corners": "A String", # The style of the corners in the ad (deprecated: never populated, ignored).
"font": { # The font which is included in the style.
"family": "A String", # The family of the font. Possible values are: ACCOUNT_DEFAULT_FAMILY, ADSENSE_DEFAULT_FAMILY, ARIAL, TIMES and VERDANA.
"size": "A String", # The size of the font. Possible values are: ACCOUNT_DEFAULT_SIZE, ADSENSE_DEFAULT_SIZE, SMALL, MEDIUM and LARGE.
},
"kind": "adsensehost#adStyle", # Kind this is, in this case adsensehost#adStyle.
},
"id": "A String", # Unique identifier of this ad unit. This should be considered an opaque identifier; it is not safe to rely on it being in any particular format.
"kind": "adsensehost#adUnit", # Kind of resource this is, in this case adsensehost#adUnit.
"mobileContentAdsSettings": { # Settings specific to WAP mobile content ads (AFMC - deprecated).
"markupLanguage": "A String", # The markup language to use for this ad unit.
"scriptingLanguage": "A String", # The scripting language to use for this ad unit.
"size": "A String", # Size of this ad unit.
"type": "A String", # Type of this ad unit.
},
"name": "A String", # Name of this ad unit.
"status": "A String", # Status of this ad unit. Possible values are:
# NEW: Indicates that the ad unit was created within the last seven days and does not yet have any activity associated with it.
#
# ACTIVE: Indicates that there has been activity on this ad unit in the last seven days.
#
# INACTIVE: Indicates that there has been no activity on this ad unit in the last seven days.
}
Returns:
An object of the form:
{
"code": "A String", # Identity code of this ad unit, not necessarily unique across ad clients.
"contentAdsSettings": { # Settings specific to content ads (AFC) and highend mobile content ads (AFMC - deprecated).
"backupOption": { # The backup option to be used in instances where no ad is available.
"color": "A String", # Color to use when type is set to COLOR. These are represented as six hexadecimal characters, similar to HTML color codes, but without the leading hash.
"type": "A String", # Type of the backup option. Possible values are BLANK, COLOR and URL.
"url": "A String", # URL to use when type is set to URL.
},
"size": "A String", # Size of this ad unit. Size values are in the form SIZE_{width}_{height}.
"type": "A String", # Type of this ad unit. Possible values are TEXT, TEXT_IMAGE, IMAGE and LINK.
},
"customStyle": { # Custom style information specific to this ad unit.
"colors": { # The colors included in the style. These are represented as six hexadecimal characters, similar to HTML color codes, but without the leading hash.
"background": "A String", # The color of the ad background.
"border": "A String", # The color of the ad border.
"text": "A String", # The color of the ad text.
"title": "A String", # The color of the ad title.
"url": "A String", # The color of the ad url.
},
"corners": "A String", # The style of the corners in the ad (deprecated: never populated, ignored).
"font": { # The font which is included in the style.
"family": "A String", # The family of the font. Possible values are: ACCOUNT_DEFAULT_FAMILY, ADSENSE_DEFAULT_FAMILY, ARIAL, TIMES and VERDANA.
"size": "A String", # The size of the font. Possible values are: ACCOUNT_DEFAULT_SIZE, ADSENSE_DEFAULT_SIZE, SMALL, MEDIUM and LARGE.
},
"kind": "adsensehost#adStyle", # Kind this is, in this case adsensehost#adStyle.
},
"id": "A String", # Unique identifier of this ad unit. This should be considered an opaque identifier; it is not safe to rely on it being in any particular format.
"kind": "adsensehost#adUnit", # Kind of resource this is, in this case adsensehost#adUnit.
"mobileContentAdsSettings": { # Settings specific to WAP mobile content ads (AFMC - deprecated).
"markupLanguage": "A String", # The markup language to use for this ad unit.
"scriptingLanguage": "A String", # The scripting language to use for this ad unit.
"size": "A String", # Size of this ad unit.
"type": "A String", # Type of this ad unit.
},
"name": "A String", # Name of this ad unit.
"status": "A String", # Status of this ad unit. Possible values are:
# NEW: Indicates that the ad unit was created within the last seven days and does not yet have any activity associated with it.
#
# ACTIVE: Indicates that there has been activity on this ad unit in the last seven days.
#
# INACTIVE: Indicates that there has been no activity on this ad unit in the last seven days.
}</pre>
</div>
</body></html>
|
