• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1<html><body>
2<style>
3
4body, h1, h2, h3, div, span, p, pre, a {
5  margin: 0;
6  padding: 0;
7  border: 0;
8  font-weight: inherit;
9  font-style: inherit;
10  font-size: 100%;
11  font-family: inherit;
12  vertical-align: baseline;
13}
14
15body {
16  font-size: 13px;
17  padding: 1em;
18}
19
20h1 {
21  font-size: 26px;
22  margin-bottom: 1em;
23}
24
25h2 {
26  font-size: 24px;
27  margin-bottom: 1em;
28}
29
30h3 {
31  font-size: 20px;
32  margin-bottom: 1em;
33  margin-top: 1em;
34}
35
36pre, code {
37  line-height: 1.5;
38  font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42  margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46  font-family: Arial, sans serif;
47}
48
49h1, h2, h3 {
50  border-bottom: solid #CCC 1px;
51}
52
53.toc_element {
54  margin-top: 0.5em;
55}
56
57.firstline {
58  margin-left: 2 em;
59}
60
61.method  {
62  margin-top: 1em;
63  border: solid 1px #CCC;
64  padding: 1em;
65  background: #EEE;
66}
67
68.details {
69  font-weight: bold;
70  font-size: 14px;
71}
72
73</style>
74
75<h1><a href="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>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78  <code><a href="#delete">delete(accountId, adClientId, adUnitId)</a></code></p>
79<p class="firstline">Delete the specified ad unit from the specified publisher AdSense account.</p>
80<p class="toc_element">
81  <code><a href="#get">get(accountId, adClientId, adUnitId)</a></code></p>
82<p class="firstline">Get the specified host ad unit in this AdSense account.</p>
83<p class="toc_element">
84  <code><a href="#getAdCode">getAdCode(accountId, adClientId, adUnitId, hostCustomChannelId=None)</a></code></p>
85<p class="firstline">Get ad code for the specified ad unit, attaching the specified host custom channels.</p>
86<p class="toc_element">
87  <code><a href="#insert">insert(accountId, adClientId, body)</a></code></p>
88<p class="firstline">Insert the supplied ad unit into the specified publisher AdSense account.</p>
89<p class="toc_element">
90  <code><a href="#list">list(accountId, adClientId, pageToken=None, includeInactive=None, maxResults=None)</a></code></p>
91<p class="firstline">List all ad units in the specified publisher's AdSense account.</p>
92<p class="toc_element">
93  <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
94<p class="firstline">Retrieves the next page of results.</p>
95<p class="toc_element">
96  <code><a href="#patch">patch(accountId, adClientId, adUnitId, body)</a></code></p>
97<p class="firstline">Update the supplied ad unit in the specified publisher AdSense account. This method supports patch semantics.</p>
98<p class="toc_element">
99  <code><a href="#update">update(accountId, adClientId, body)</a></code></p>
100<p class="firstline">Update the supplied ad unit in the specified publisher AdSense account.</p>
101<h3>Method Details</h3>
102<div class="method">
103    <code class="details" id="delete">delete(accountId, adClientId, adUnitId)</code>
104  <pre>Delete the specified ad unit from the specified publisher AdSense account.
105
106Args:
107  accountId: string, Account which contains the ad unit. (required)
108  adClientId: string, Ad client for which to get ad unit. (required)
109  adUnitId: string, Ad unit to delete. (required)
110
111Returns:
112  An object of the form:
113
114    {
115      "status": "A String", # Status of this ad unit. Possible values are:
116          # NEW: Indicates that the ad unit was created within the last seven days and does not yet have any activity associated with it.
117          #
118          # ACTIVE: Indicates that there has been activity on this ad unit in the last seven days.
119          #
120          # INACTIVE: Indicates that there has been no activity on this ad unit in the last seven days.
121      "kind": "adsensehost#adUnit", # Kind of resource this is, in this case adsensehost#adUnit.
122      "code": "A String", # Identity code of this ad unit, not necessarily unique across ad clients.
123      "name": "A String", # Name of this ad unit.
124      "contentAdsSettings": { # Settings specific to content ads (AFC) and highend mobile content ads (AFMC - deprecated).
125        "type": "A String", # Type of this ad unit. Possible values are TEXT, TEXT_IMAGE, IMAGE and LINK.
126        "backupOption": { # The backup option to be used in instances where no ad is available.
127          "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.
128          "url": "A String", # URL to use when type is set to URL.
129          "type": "A String", # Type of the backup option. Possible values are BLANK, COLOR and URL.
130        },
131        "size": "A String", # Size of this ad unit. Size values are in the form SIZE_{width}_{height}.
132      },
133      "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.
134      "mobileContentAdsSettings": { # Settings specific to WAP mobile content ads (AFMC - deprecated).
135        "scriptingLanguage": "A String", # The scripting language to use for this ad unit.
136        "type": "A String", # Type of this ad unit.
137        "markupLanguage": "A String", # The markup language to use for this ad unit.
138        "size": "A String", # Size of this ad unit.
139      },
140      "customStyle": { # Custom style information specific to this ad unit.
141        "corners": "A String", # The style of the corners in the ad (deprecated: never populated, ignored).
142        "colors": { # The colors included in the style. These are represented as six hexadecimal characters, similar to HTML color codes, but without the leading hash.
143          "url": "A String", # The color of the ad url.
144          "text": "A String", # The color of the ad text.
145          "border": "A String", # The color of the ad border.
146          "background": "A String", # The color of the ad background.
147          "title": "A String", # The color of the ad title.
148        },
149        "font": { # The font which is included in the style.
150          "family": "A String", # The family of the font. Possible values are: ACCOUNT_DEFAULT_FAMILY, ADSENSE_DEFAULT_FAMILY, ARIAL, TIMES and VERDANA.
151          "size": "A String", # The size of the font. Possible values are: ACCOUNT_DEFAULT_SIZE, ADSENSE_DEFAULT_SIZE, SMALL, MEDIUM and LARGE.
152        },
153        "kind": "adsensehost#adStyle", # Kind this is, in this case adsensehost#adStyle.
154      },
155    }</pre>
156</div>
157
158<div class="method">
159    <code class="details" id="get">get(accountId, adClientId, adUnitId)</code>
160  <pre>Get the specified host ad unit in this AdSense account.
161
162Args:
163  accountId: string, Account which contains the ad unit. (required)
164  adClientId: string, Ad client for which to get ad unit. (required)
165  adUnitId: string, Ad unit to get. (required)
166
167Returns:
168  An object of the form:
169
170    {
171      "status": "A String", # Status of this ad unit. Possible values are:
172          # NEW: Indicates that the ad unit was created within the last seven days and does not yet have any activity associated with it.
173          #
174          # ACTIVE: Indicates that there has been activity on this ad unit in the last seven days.
175          #
176          # INACTIVE: Indicates that there has been no activity on this ad unit in the last seven days.
177      "kind": "adsensehost#adUnit", # Kind of resource this is, in this case adsensehost#adUnit.
178      "code": "A String", # Identity code of this ad unit, not necessarily unique across ad clients.
179      "name": "A String", # Name of this ad unit.
180      "contentAdsSettings": { # Settings specific to content ads (AFC) and highend mobile content ads (AFMC - deprecated).
181        "type": "A String", # Type of this ad unit. Possible values are TEXT, TEXT_IMAGE, IMAGE and LINK.
182        "backupOption": { # The backup option to be used in instances where no ad is available.
183          "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.
184          "url": "A String", # URL to use when type is set to URL.
185          "type": "A String", # Type of the backup option. Possible values are BLANK, COLOR and URL.
186        },
187        "size": "A String", # Size of this ad unit. Size values are in the form SIZE_{width}_{height}.
188      },
189      "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.
190      "mobileContentAdsSettings": { # Settings specific to WAP mobile content ads (AFMC - deprecated).
191        "scriptingLanguage": "A String", # The scripting language to use for this ad unit.
192        "type": "A String", # Type of this ad unit.
193        "markupLanguage": "A String", # The markup language to use for this ad unit.
194        "size": "A String", # Size of this ad unit.
195      },
196      "customStyle": { # Custom style information specific to this ad unit.
197        "corners": "A String", # The style of the corners in the ad (deprecated: never populated, ignored).
198        "colors": { # The colors included in the style. These are represented as six hexadecimal characters, similar to HTML color codes, but without the leading hash.
199          "url": "A String", # The color of the ad url.
200          "text": "A String", # The color of the ad text.
201          "border": "A String", # The color of the ad border.
202          "background": "A String", # The color of the ad background.
203          "title": "A String", # The color of the ad title.
204        },
205        "font": { # The font which is included in the style.
206          "family": "A String", # The family of the font. Possible values are: ACCOUNT_DEFAULT_FAMILY, ADSENSE_DEFAULT_FAMILY, ARIAL, TIMES and VERDANA.
207          "size": "A String", # The size of the font. Possible values are: ACCOUNT_DEFAULT_SIZE, ADSENSE_DEFAULT_SIZE, SMALL, MEDIUM and LARGE.
208        },
209        "kind": "adsensehost#adStyle", # Kind this is, in this case adsensehost#adStyle.
210      },
211    }</pre>
212</div>
213
214<div class="method">
215    <code class="details" id="getAdCode">getAdCode(accountId, adClientId, adUnitId, hostCustomChannelId=None)</code>
216  <pre>Get ad code for the specified ad unit, attaching the specified host custom channels.
217
218Args:
219  accountId: string, Account which contains the ad client. (required)
220  adClientId: string, Ad client with contains the ad unit. (required)
221  adUnitId: string, Ad unit to get the code for. (required)
222  hostCustomChannelId: string, Host custom channel to attach to the ad code. (repeated)
223
224Returns:
225  An object of the form:
226
227    {
228    "adCode": "A String", # The ad code snippet.
229    "kind": "adsensehost#adCode", # Kind this is, in this case adsensehost#adCode.
230  }</pre>
231</div>
232
233<div class="method">
234    <code class="details" id="insert">insert(accountId, adClientId, body)</code>
235  <pre>Insert the supplied ad unit into the specified publisher AdSense account.
236
237Args:
238  accountId: string, Account which will contain the ad unit. (required)
239  adClientId: string, Ad client into which to insert the ad unit. (required)
240  body: object, The request body. (required)
241    The object takes the form of:
242
243{
244    "status": "A String", # Status of this ad unit. Possible values are:
245        # NEW: Indicates that the ad unit was created within the last seven days and does not yet have any activity associated with it.
246        #
247        # ACTIVE: Indicates that there has been activity on this ad unit in the last seven days.
248        #
249        # INACTIVE: Indicates that there has been no activity on this ad unit in the last seven days.
250    "kind": "adsensehost#adUnit", # Kind of resource this is, in this case adsensehost#adUnit.
251    "code": "A String", # Identity code of this ad unit, not necessarily unique across ad clients.
252    "name": "A String", # Name of this ad unit.
253    "contentAdsSettings": { # Settings specific to content ads (AFC) and highend mobile content ads (AFMC - deprecated).
254      "type": "A String", # Type of this ad unit. Possible values are TEXT, TEXT_IMAGE, IMAGE and LINK.
255      "backupOption": { # The backup option to be used in instances where no ad is available.
256        "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.
257        "url": "A String", # URL to use when type is set to URL.
258        "type": "A String", # Type of the backup option. Possible values are BLANK, COLOR and URL.
259      },
260      "size": "A String", # Size of this ad unit. Size values are in the form SIZE_{width}_{height}.
261    },
262    "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.
263    "mobileContentAdsSettings": { # Settings specific to WAP mobile content ads (AFMC - deprecated).
264      "scriptingLanguage": "A String", # The scripting language to use for this ad unit.
265      "type": "A String", # Type of this ad unit.
266      "markupLanguage": "A String", # The markup language to use for this ad unit.
267      "size": "A String", # Size of this ad unit.
268    },
269    "customStyle": { # Custom style information specific to this ad unit.
270      "corners": "A String", # The style of the corners in the ad (deprecated: never populated, ignored).
271      "colors": { # The colors included in the style. These are represented as six hexadecimal characters, similar to HTML color codes, but without the leading hash.
272        "url": "A String", # The color of the ad url.
273        "text": "A String", # The color of the ad text.
274        "border": "A String", # The color of the ad border.
275        "background": "A String", # The color of the ad background.
276        "title": "A String", # The color of the ad title.
277      },
278      "font": { # The font which is included in the style.
279        "family": "A String", # The family of the font. Possible values are: ACCOUNT_DEFAULT_FAMILY, ADSENSE_DEFAULT_FAMILY, ARIAL, TIMES and VERDANA.
280        "size": "A String", # The size of the font. Possible values are: ACCOUNT_DEFAULT_SIZE, ADSENSE_DEFAULT_SIZE, SMALL, MEDIUM and LARGE.
281      },
282      "kind": "adsensehost#adStyle", # Kind this is, in this case adsensehost#adStyle.
283    },
284  }
285
286
287Returns:
288  An object of the form:
289
290    {
291      "status": "A String", # Status of this ad unit. Possible values are:
292          # NEW: Indicates that the ad unit was created within the last seven days and does not yet have any activity associated with it.
293          #
294          # ACTIVE: Indicates that there has been activity on this ad unit in the last seven days.
295          #
296          # INACTIVE: Indicates that there has been no activity on this ad unit in the last seven days.
297      "kind": "adsensehost#adUnit", # Kind of resource this is, in this case adsensehost#adUnit.
298      "code": "A String", # Identity code of this ad unit, not necessarily unique across ad clients.
299      "name": "A String", # Name of this ad unit.
300      "contentAdsSettings": { # Settings specific to content ads (AFC) and highend mobile content ads (AFMC - deprecated).
301        "type": "A String", # Type of this ad unit. Possible values are TEXT, TEXT_IMAGE, IMAGE and LINK.
302        "backupOption": { # The backup option to be used in instances where no ad is available.
303          "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.
304          "url": "A String", # URL to use when type is set to URL.
305          "type": "A String", # Type of the backup option. Possible values are BLANK, COLOR and URL.
306        },
307        "size": "A String", # Size of this ad unit. Size values are in the form SIZE_{width}_{height}.
308      },
309      "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.
310      "mobileContentAdsSettings": { # Settings specific to WAP mobile content ads (AFMC - deprecated).
311        "scriptingLanguage": "A String", # The scripting language to use for this ad unit.
312        "type": "A String", # Type of this ad unit.
313        "markupLanguage": "A String", # The markup language to use for this ad unit.
314        "size": "A String", # Size of this ad unit.
315      },
316      "customStyle": { # Custom style information specific to this ad unit.
317        "corners": "A String", # The style of the corners in the ad (deprecated: never populated, ignored).
318        "colors": { # The colors included in the style. These are represented as six hexadecimal characters, similar to HTML color codes, but without the leading hash.
319          "url": "A String", # The color of the ad url.
320          "text": "A String", # The color of the ad text.
321          "border": "A String", # The color of the ad border.
322          "background": "A String", # The color of the ad background.
323          "title": "A String", # The color of the ad title.
324        },
325        "font": { # The font which is included in the style.
326          "family": "A String", # The family of the font. Possible values are: ACCOUNT_DEFAULT_FAMILY, ADSENSE_DEFAULT_FAMILY, ARIAL, TIMES and VERDANA.
327          "size": "A String", # The size of the font. Possible values are: ACCOUNT_DEFAULT_SIZE, ADSENSE_DEFAULT_SIZE, SMALL, MEDIUM and LARGE.
328        },
329        "kind": "adsensehost#adStyle", # Kind this is, in this case adsensehost#adStyle.
330      },
331    }</pre>
332</div>
333
334<div class="method">
335    <code class="details" id="list">list(accountId, adClientId, pageToken=None, includeInactive=None, maxResults=None)</code>
336  <pre>List all ad units in the specified publisher's AdSense account.
337
338Args:
339  accountId: string, Account which contains the ad client. (required)
340  adClientId: string, Ad client for which to list ad units. (required)
341  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.
342  includeInactive: boolean, Whether to include inactive ad units. Default: true.
343  maxResults: integer, The maximum number of ad units to include in the response, used for paging.
344
345Returns:
346  An object of the form:
347
348    {
349    "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.
350    "items": [ # The ad units returned in this list response.
351      {
352          "status": "A String", # Status of this ad unit. Possible values are:
353              # NEW: Indicates that the ad unit was created within the last seven days and does not yet have any activity associated with it.
354              #
355              # ACTIVE: Indicates that there has been activity on this ad unit in the last seven days.
356              #
357              # INACTIVE: Indicates that there has been no activity on this ad unit in the last seven days.
358          "kind": "adsensehost#adUnit", # Kind of resource this is, in this case adsensehost#adUnit.
359          "code": "A String", # Identity code of this ad unit, not necessarily unique across ad clients.
360          "name": "A String", # Name of this ad unit.
361          "contentAdsSettings": { # Settings specific to content ads (AFC) and highend mobile content ads (AFMC - deprecated).
362            "type": "A String", # Type of this ad unit. Possible values are TEXT, TEXT_IMAGE, IMAGE and LINK.
363            "backupOption": { # The backup option to be used in instances where no ad is available.
364              "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.
365              "url": "A String", # URL to use when type is set to URL.
366              "type": "A String", # Type of the backup option. Possible values are BLANK, COLOR and URL.
367            },
368            "size": "A String", # Size of this ad unit. Size values are in the form SIZE_{width}_{height}.
369          },
370          "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.
371          "mobileContentAdsSettings": { # Settings specific to WAP mobile content ads (AFMC - deprecated).
372            "scriptingLanguage": "A String", # The scripting language to use for this ad unit.
373            "type": "A String", # Type of this ad unit.
374            "markupLanguage": "A String", # The markup language to use for this ad unit.
375            "size": "A String", # Size of this ad unit.
376          },
377          "customStyle": { # Custom style information specific to this ad unit.
378            "corners": "A String", # The style of the corners in the ad (deprecated: never populated, ignored).
379            "colors": { # The colors included in the style. These are represented as six hexadecimal characters, similar to HTML color codes, but without the leading hash.
380              "url": "A String", # The color of the ad url.
381              "text": "A String", # The color of the ad text.
382              "border": "A String", # The color of the ad border.
383              "background": "A String", # The color of the ad background.
384              "title": "A String", # The color of the ad title.
385            },
386            "font": { # The font which is included in the style.
387              "family": "A String", # The family of the font. Possible values are: ACCOUNT_DEFAULT_FAMILY, ADSENSE_DEFAULT_FAMILY, ARIAL, TIMES and VERDANA.
388              "size": "A String", # The size of the font. Possible values are: ACCOUNT_DEFAULT_SIZE, ADSENSE_DEFAULT_SIZE, SMALL, MEDIUM and LARGE.
389            },
390            "kind": "adsensehost#adStyle", # Kind this is, in this case adsensehost#adStyle.
391          },
392        },
393    ],
394    "kind": "adsensehost#adUnits", # Kind of list this is, in this case adsensehost#adUnits.
395    "etag": "A String", # ETag of this response for caching purposes.
396  }</pre>
397</div>
398
399<div class="method">
400    <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
401  <pre>Retrieves the next page of results.
402
403Args:
404  previous_request: The request for the previous page. (required)
405  previous_response: The response from the request for the previous page. (required)
406
407Returns:
408  A request object that you can call 'execute()' on to request the next
409  page. Returns None if there are no more items in the collection.
410    </pre>
411</div>
412
413<div class="method">
414    <code class="details" id="patch">patch(accountId, adClientId, adUnitId, body)</code>
415  <pre>Update the supplied ad unit in the specified publisher AdSense account. This method supports patch semantics.
416
417Args:
418  accountId: string, Account which contains the ad client. (required)
419  adClientId: string, Ad client which contains the ad unit. (required)
420  adUnitId: string, Ad unit to get. (required)
421  body: object, The request body. (required)
422    The object takes the form of:
423
424{
425    "status": "A String", # Status of this ad unit. Possible values are:
426        # NEW: Indicates that the ad unit was created within the last seven days and does not yet have any activity associated with it.
427        #
428        # ACTIVE: Indicates that there has been activity on this ad unit in the last seven days.
429        #
430        # INACTIVE: Indicates that there has been no activity on this ad unit in the last seven days.
431    "kind": "adsensehost#adUnit", # Kind of resource this is, in this case adsensehost#adUnit.
432    "code": "A String", # Identity code of this ad unit, not necessarily unique across ad clients.
433    "name": "A String", # Name of this ad unit.
434    "contentAdsSettings": { # Settings specific to content ads (AFC) and highend mobile content ads (AFMC - deprecated).
435      "type": "A String", # Type of this ad unit. Possible values are TEXT, TEXT_IMAGE, IMAGE and LINK.
436      "backupOption": { # The backup option to be used in instances where no ad is available.
437        "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.
438        "url": "A String", # URL to use when type is set to URL.
439        "type": "A String", # Type of the backup option. Possible values are BLANK, COLOR and URL.
440      },
441      "size": "A String", # Size of this ad unit. Size values are in the form SIZE_{width}_{height}.
442    },
443    "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.
444    "mobileContentAdsSettings": { # Settings specific to WAP mobile content ads (AFMC - deprecated).
445      "scriptingLanguage": "A String", # The scripting language to use for this ad unit.
446      "type": "A String", # Type of this ad unit.
447      "markupLanguage": "A String", # The markup language to use for this ad unit.
448      "size": "A String", # Size of this ad unit.
449    },
450    "customStyle": { # Custom style information specific to this ad unit.
451      "corners": "A String", # The style of the corners in the ad (deprecated: never populated, ignored).
452      "colors": { # The colors included in the style. These are represented as six hexadecimal characters, similar to HTML color codes, but without the leading hash.
453        "url": "A String", # The color of the ad url.
454        "text": "A String", # The color of the ad text.
455        "border": "A String", # The color of the ad border.
456        "background": "A String", # The color of the ad background.
457        "title": "A String", # The color of the ad title.
458      },
459      "font": { # The font which is included in the style.
460        "family": "A String", # The family of the font. Possible values are: ACCOUNT_DEFAULT_FAMILY, ADSENSE_DEFAULT_FAMILY, ARIAL, TIMES and VERDANA.
461        "size": "A String", # The size of the font. Possible values are: ACCOUNT_DEFAULT_SIZE, ADSENSE_DEFAULT_SIZE, SMALL, MEDIUM and LARGE.
462      },
463      "kind": "adsensehost#adStyle", # Kind this is, in this case adsensehost#adStyle.
464    },
465  }
466
467
468Returns:
469  An object of the form:
470
471    {
472      "status": "A String", # Status of this ad unit. Possible values are:
473          # NEW: Indicates that the ad unit was created within the last seven days and does not yet have any activity associated with it.
474          #
475          # ACTIVE: Indicates that there has been activity on this ad unit in the last seven days.
476          #
477          # INACTIVE: Indicates that there has been no activity on this ad unit in the last seven days.
478      "kind": "adsensehost#adUnit", # Kind of resource this is, in this case adsensehost#adUnit.
479      "code": "A String", # Identity code of this ad unit, not necessarily unique across ad clients.
480      "name": "A String", # Name of this ad unit.
481      "contentAdsSettings": { # Settings specific to content ads (AFC) and highend mobile content ads (AFMC - deprecated).
482        "type": "A String", # Type of this ad unit. Possible values are TEXT, TEXT_IMAGE, IMAGE and LINK.
483        "backupOption": { # The backup option to be used in instances where no ad is available.
484          "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.
485          "url": "A String", # URL to use when type is set to URL.
486          "type": "A String", # Type of the backup option. Possible values are BLANK, COLOR and URL.
487        },
488        "size": "A String", # Size of this ad unit. Size values are in the form SIZE_{width}_{height}.
489      },
490      "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.
491      "mobileContentAdsSettings": { # Settings specific to WAP mobile content ads (AFMC - deprecated).
492        "scriptingLanguage": "A String", # The scripting language to use for this ad unit.
493        "type": "A String", # Type of this ad unit.
494        "markupLanguage": "A String", # The markup language to use for this ad unit.
495        "size": "A String", # Size of this ad unit.
496      },
497      "customStyle": { # Custom style information specific to this ad unit.
498        "corners": "A String", # The style of the corners in the ad (deprecated: never populated, ignored).
499        "colors": { # The colors included in the style. These are represented as six hexadecimal characters, similar to HTML color codes, but without the leading hash.
500          "url": "A String", # The color of the ad url.
501          "text": "A String", # The color of the ad text.
502          "border": "A String", # The color of the ad border.
503          "background": "A String", # The color of the ad background.
504          "title": "A String", # The color of the ad title.
505        },
506        "font": { # The font which is included in the style.
507          "family": "A String", # The family of the font. Possible values are: ACCOUNT_DEFAULT_FAMILY, ADSENSE_DEFAULT_FAMILY, ARIAL, TIMES and VERDANA.
508          "size": "A String", # The size of the font. Possible values are: ACCOUNT_DEFAULT_SIZE, ADSENSE_DEFAULT_SIZE, SMALL, MEDIUM and LARGE.
509        },
510        "kind": "adsensehost#adStyle", # Kind this is, in this case adsensehost#adStyle.
511      },
512    }</pre>
513</div>
514
515<div class="method">
516    <code class="details" id="update">update(accountId, adClientId, body)</code>
517  <pre>Update the supplied ad unit in the specified publisher AdSense account.
518
519Args:
520  accountId: string, Account which contains the ad client. (required)
521  adClientId: string, Ad client which contains the ad unit. (required)
522  body: object, The request body. (required)
523    The object takes the form of:
524
525{
526    "status": "A String", # Status of this ad unit. Possible values are:
527        # NEW: Indicates that the ad unit was created within the last seven days and does not yet have any activity associated with it.
528        #
529        # ACTIVE: Indicates that there has been activity on this ad unit in the last seven days.
530        #
531        # INACTIVE: Indicates that there has been no activity on this ad unit in the last seven days.
532    "kind": "adsensehost#adUnit", # Kind of resource this is, in this case adsensehost#adUnit.
533    "code": "A String", # Identity code of this ad unit, not necessarily unique across ad clients.
534    "name": "A String", # Name of this ad unit.
535    "contentAdsSettings": { # Settings specific to content ads (AFC) and highend mobile content ads (AFMC - deprecated).
536      "type": "A String", # Type of this ad unit. Possible values are TEXT, TEXT_IMAGE, IMAGE and LINK.
537      "backupOption": { # The backup option to be used in instances where no ad is available.
538        "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.
539        "url": "A String", # URL to use when type is set to URL.
540        "type": "A String", # Type of the backup option. Possible values are BLANK, COLOR and URL.
541      },
542      "size": "A String", # Size of this ad unit. Size values are in the form SIZE_{width}_{height}.
543    },
544    "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.
545    "mobileContentAdsSettings": { # Settings specific to WAP mobile content ads (AFMC - deprecated).
546      "scriptingLanguage": "A String", # The scripting language to use for this ad unit.
547      "type": "A String", # Type of this ad unit.
548      "markupLanguage": "A String", # The markup language to use for this ad unit.
549      "size": "A String", # Size of this ad unit.
550    },
551    "customStyle": { # Custom style information specific to this ad unit.
552      "corners": "A String", # The style of the corners in the ad (deprecated: never populated, ignored).
553      "colors": { # The colors included in the style. These are represented as six hexadecimal characters, similar to HTML color codes, but without the leading hash.
554        "url": "A String", # The color of the ad url.
555        "text": "A String", # The color of the ad text.
556        "border": "A String", # The color of the ad border.
557        "background": "A String", # The color of the ad background.
558        "title": "A String", # The color of the ad title.
559      },
560      "font": { # The font which is included in the style.
561        "family": "A String", # The family of the font. Possible values are: ACCOUNT_DEFAULT_FAMILY, ADSENSE_DEFAULT_FAMILY, ARIAL, TIMES and VERDANA.
562        "size": "A String", # The size of the font. Possible values are: ACCOUNT_DEFAULT_SIZE, ADSENSE_DEFAULT_SIZE, SMALL, MEDIUM and LARGE.
563      },
564      "kind": "adsensehost#adStyle", # Kind this is, in this case adsensehost#adStyle.
565    },
566  }
567
568
569Returns:
570  An object of the form:
571
572    {
573      "status": "A String", # Status of this ad unit. Possible values are:
574          # NEW: Indicates that the ad unit was created within the last seven days and does not yet have any activity associated with it.
575          #
576          # ACTIVE: Indicates that there has been activity on this ad unit in the last seven days.
577          #
578          # INACTIVE: Indicates that there has been no activity on this ad unit in the last seven days.
579      "kind": "adsensehost#adUnit", # Kind of resource this is, in this case adsensehost#adUnit.
580      "code": "A String", # Identity code of this ad unit, not necessarily unique across ad clients.
581      "name": "A String", # Name of this ad unit.
582      "contentAdsSettings": { # Settings specific to content ads (AFC) and highend mobile content ads (AFMC - deprecated).
583        "type": "A String", # Type of this ad unit. Possible values are TEXT, TEXT_IMAGE, IMAGE and LINK.
584        "backupOption": { # The backup option to be used in instances where no ad is available.
585          "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.
586          "url": "A String", # URL to use when type is set to URL.
587          "type": "A String", # Type of the backup option. Possible values are BLANK, COLOR and URL.
588        },
589        "size": "A String", # Size of this ad unit. Size values are in the form SIZE_{width}_{height}.
590      },
591      "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.
592      "mobileContentAdsSettings": { # Settings specific to WAP mobile content ads (AFMC - deprecated).
593        "scriptingLanguage": "A String", # The scripting language to use for this ad unit.
594        "type": "A String", # Type of this ad unit.
595        "markupLanguage": "A String", # The markup language to use for this ad unit.
596        "size": "A String", # Size of this ad unit.
597      },
598      "customStyle": { # Custom style information specific to this ad unit.
599        "corners": "A String", # The style of the corners in the ad (deprecated: never populated, ignored).
600        "colors": { # The colors included in the style. These are represented as six hexadecimal characters, similar to HTML color codes, but without the leading hash.
601          "url": "A String", # The color of the ad url.
602          "text": "A String", # The color of the ad text.
603          "border": "A String", # The color of the ad border.
604          "background": "A String", # The color of the ad background.
605          "title": "A String", # The color of the ad title.
606        },
607        "font": { # The font which is included in the style.
608          "family": "A String", # The family of the font. Possible values are: ACCOUNT_DEFAULT_FAMILY, ADSENSE_DEFAULT_FAMILY, ARIAL, TIMES and VERDANA.
609          "size": "A String", # The size of the font. Possible values are: ACCOUNT_DEFAULT_SIZE, ADSENSE_DEFAULT_SIZE, SMALL, MEDIUM and LARGE.
610        },
611        "kind": "adsensehost#adStyle", # Kind this is, in this case adsensehost#adStyle.
612      },
613    }</pre>
614</div>
615
616</body></html>