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