| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 1 | <html><body> |
| 2 | <style> |
| 3 | |
| 4 | body, h1, h2, h3, div, span, p, pre, a { |
| 5 | margin: 0; |
| 6 | padding: 0; |
| 7 | border: 0; |
| 8 | font-weight: inherit; |
| 9 | font-style: inherit; |
| 10 | font-size: 100%; |
| 11 | font-family: inherit; |
| 12 | vertical-align: baseline; |
| 13 | } |
| 14 | |
| 15 | body { |
| 16 | font-size: 13px; |
| 17 | padding: 1em; |
| 18 | } |
| 19 | |
| 20 | h1 { |
| 21 | font-size: 26px; |
| 22 | margin-bottom: 1em; |
| 23 | } |
| 24 | |
| 25 | h2 { |
| 26 | font-size: 24px; |
| 27 | margin-bottom: 1em; |
| 28 | } |
| 29 | |
| 30 | h3 { |
| 31 | font-size: 20px; |
| 32 | margin-bottom: 1em; |
| 33 | margin-top: 1em; |
| 34 | } |
| 35 | |
| 36 | pre, code { |
| 37 | line-height: 1.5; |
| 38 | font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; |
| 39 | } |
| 40 | |
| 41 | pre { |
| 42 | margin-top: 0.5em; |
| 43 | } |
| 44 | |
| 45 | h1, h2, h3, p { |
| 46 | font-family: Arial, sans serif; |
| 47 | } |
| 48 | |
| 49 | h1, h2, h3 { |
| 50 | border-bottom: solid #CCC 1px; |
| 51 | } |
| 52 | |
| 53 | .toc_element { |
| 54 | margin-top: 0.5em; |
| 55 | } |
| 56 | |
| 57 | .firstline { |
| 58 | margin-left: 2 em; |
| 59 | } |
| 60 | |
| 61 | .method { |
| 62 | margin-top: 1em; |
| 63 | border: solid 1px #CCC; |
| 64 | padding: 1em; |
| 65 | background: #EEE; |
| 66 | } |
| 67 | |
| 68 | .details { |
| 69 | font-weight: bold; |
| 70 | font-size: 14px; |
| 71 | } |
| 72 | |
| 73 | </style> |
| 74 | |
| 75 | <h1><a href="adsense_v1_4.html">AdSense Management API</a> . <a href="adsense_v1_4.customchannels.html">customchannels</a></h1> |
| 76 | <h2>Instance Methods</h2> |
| 77 | <p class="toc_element"> |
| 78 | <code><a href="adsense_v1_4.customchannels.adunits.html">adunits()</a></code> |
| 79 | </p> |
| 80 | <p class="firstline">Returns the adunits Resource.</p> |
| 81 | |
| 82 | <p class="toc_element"> |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 83 | <code><a href="#close">close()</a></code></p> |
| 84 | <p class="firstline">Close httplib2 connections.</p> |
| 85 | <p class="toc_element"> |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 86 | <code><a href="#get">get(adClientId, customChannelId)</a></code></p> |
| 87 | <p class="firstline">Get the specified custom channel from the specified ad client.</p> |
| 88 | <p class="toc_element"> |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 89 | <code><a href="#list">list(adClientId, maxResults=None, pageToken=None)</a></code></p> |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 90 | <p class="firstline">List all custom channels in the specified ad client for this AdSense account.</p> |
| 91 | <p class="toc_element"> |
| 92 | <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> |
| 93 | <p class="firstline">Retrieves the next page of results.</p> |
| 94 | <h3>Method Details</h3> |
| 95 | <div class="method"> |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 96 | <code class="details" id="close">close()</code> |
| 97 | <pre>Close httplib2 connections.</pre> |
| 98 | </div> |
| 99 | |
| 100 | <div class="method"> |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 101 | <code class="details" id="get">get(adClientId, customChannelId)</code> |
| 102 | <pre>Get the specified custom channel from the specified ad client. |
| 103 | |
| 104 | Args: |
| 105 | adClientId: string, Ad client which contains the custom channel. (required) |
| 106 | customChannelId: string, Custom channel to retrieve. (required) |
| 107 | |
| 108 | Returns: |
| 109 | An object of the form: |
| 110 | |
| 111 | { |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 112 | "code": "A String", # Code of this custom channel, not necessarily unique across ad clients. |
| 113 | "id": "A String", # Unique identifier of this custom channel. This should be considered an opaque identifier; it is not safe to rely on it being in any particular format. |
| 114 | "kind": "adsense#customChannel", # Kind of resource this is, in this case adsense#customChannel. |
| 115 | "name": "A String", # Name of this custom channel. |
| 116 | "targetingInfo": { # The targeting information of this custom channel, if activated. |
| 117 | "adsAppearOn": "A String", # The name used to describe this channel externally. |
| 118 | "description": "A String", # The external description of the channel. |
| 119 | "location": "A String", # The locations in which ads appear. (Only valid for content and mobile content ads (deprecated)). Acceptable values for content ads are: TOP_LEFT, TOP_CENTER, TOP_RIGHT, MIDDLE_LEFT, MIDDLE_CENTER, MIDDLE_RIGHT, BOTTOM_LEFT, BOTTOM_CENTER, BOTTOM_RIGHT, MULTIPLE_LOCATIONS. Acceptable values for mobile content ads (deprecated) are: TOP, MIDDLE, BOTTOM, MULTIPLE_LOCATIONS. |
| 120 | "siteLanguage": "A String", # The language of the sites ads will be displayed on. |
| 121 | }, |
| 122 | }</pre> |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 123 | </div> |
| 124 | |
| 125 | <div class="method"> |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 126 | <code class="details" id="list">list(adClientId, maxResults=None, pageToken=None)</code> |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 127 | <pre>List all custom channels in the specified ad client for this AdSense account. |
| 128 | |
| 129 | Args: |
| 130 | adClientId: string, Ad client for which to list custom channels. (required) |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 131 | maxResults: integer, The maximum number of custom channels to include in the response, used for paging. |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 132 | pageToken: string, A continuation token, used to page through custom channels. To retrieve the next page, set this parameter to the value of "nextPageToken" from the previous response. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 133 | |
| 134 | Returns: |
| 135 | An object of the form: |
| 136 | |
| 137 | { |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 138 | "etag": "A String", # ETag of this response for caching purposes. |
| 139 | "items": [ # The custom channels returned in this list response. |
| 140 | { |
| 141 | "code": "A String", # Code of this custom channel, not necessarily unique across ad clients. |
| 142 | "id": "A String", # Unique identifier of this custom channel. This should be considered an opaque identifier; it is not safe to rely on it being in any particular format. |
| 143 | "kind": "adsense#customChannel", # Kind of resource this is, in this case adsense#customChannel. |
| 144 | "name": "A String", # Name of this custom channel. |
| 145 | "targetingInfo": { # The targeting information of this custom channel, if activated. |
| 146 | "adsAppearOn": "A String", # The name used to describe this channel externally. |
| 147 | "description": "A String", # The external description of the channel. |
| 148 | "location": "A String", # The locations in which ads appear. (Only valid for content and mobile content ads (deprecated)). Acceptable values for content ads are: TOP_LEFT, TOP_CENTER, TOP_RIGHT, MIDDLE_LEFT, MIDDLE_CENTER, MIDDLE_RIGHT, BOTTOM_LEFT, BOTTOM_CENTER, BOTTOM_RIGHT, MULTIPLE_LOCATIONS. Acceptable values for mobile content ads (deprecated) are: TOP, MIDDLE, BOTTOM, MULTIPLE_LOCATIONS. |
| 149 | "siteLanguage": "A String", # The language of the sites ads will be displayed on. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 150 | }, |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 151 | }, |
| 152 | ], |
| 153 | "kind": "adsense#customChannels", # Kind of list this is, in this case adsense#customChannels. |
| 154 | "nextPageToken": "A String", # Continuation token used to page through custom channels. To retrieve the next page of results, set the next request's "pageToken" value to this. |
| 155 | }</pre> |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 156 | </div> |
| 157 | |
| 158 | <div class="method"> |
| 159 | <code class="details" id="list_next">list_next(previous_request, previous_response)</code> |
| 160 | <pre>Retrieves the next page of results. |
| 161 | |
| 162 | Args: |
| 163 | previous_request: The request for the previous page. (required) |
| 164 | previous_response: The response from the request for the previous page. (required) |
| 165 | |
| 166 | Returns: |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 167 | A request object that you can call 'execute()' on to request the next |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 168 | page. Returns None if there are no more items in the collection. |
| 169 | </pre> |
| 170 | </div> |
| 171 | |
| 172 | </body></html> |