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="adsense_v1_4.html">AdSense Management API</a> . <a href="adsense_v1_4.accounts.html">accounts</a> . <a href="adsense_v1_4.accounts.adunits.html">adunits</a></h1> 76<h2>Instance Methods</h2> 77<p class="toc_element"> 78 <code><a href="adsense_v1_4.accounts.adunits.customchannels.html">customchannels()</a></code> 79</p> 80<p class="firstline">Returns the customchannels Resource.</p> 81 82<p class="toc_element"> 83 <code><a href="#close">close()</a></code></p> 84<p class="firstline">Close httplib2 connections.</p> 85<p class="toc_element"> 86 <code><a href="#get">get(accountId, adClientId, adUnitId)</a></code></p> 87<p class="firstline">Gets the specified ad unit in the specified ad client for the specified account.</p> 88<p class="toc_element"> 89 <code><a href="#getAdCode">getAdCode(accountId, adClientId, adUnitId)</a></code></p> 90<p class="firstline">Get ad code for the specified ad unit.</p> 91<p class="toc_element"> 92 <code><a href="#list">list(accountId, adClientId, includeInactive=None, maxResults=None, pageToken=None)</a></code></p> 93<p class="firstline">List all ad units in the specified ad client for the specified account.</p> 94<p class="toc_element"> 95 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> 96<p class="firstline">Retrieves the next page of results.</p> 97<h3>Method Details</h3> 98<div class="method"> 99 <code class="details" id="close">close()</code> 100 <pre>Close httplib2 connections.</pre> 101</div> 102 103<div class="method"> 104 <code class="details" id="get">get(accountId, adClientId, adUnitId)</code> 105 <pre>Gets the specified ad unit in the specified ad client for the specified account. 106 107Args: 108 accountId: string, Account to which the ad client belongs. (required) 109 adClientId: string, Ad client for which to get the ad unit. (required) 110 adUnitId: string, Ad unit to retrieve. (required) 111 112Returns: 113 An object of the form: 114 115 { 116 "code": "A String", # Identity code of this ad unit, not necessarily unique across ad clients. 117 "contentAdsSettings": { # Settings specific to content ads (AFC) and highend mobile content ads (AFMC - deprecated). 118 "backupOption": { # The backup option to be used in instances where no ad is available. 119 "color": "A String", # Color to use when type is set to COLOR. 120 "type": "A String", # Type of the backup option. Possible values are BLANK, COLOR and URL. 121 "url": "A String", # URL to use when type is set to URL. 122 }, 123 "size": "A String", # Size of this ad unit. 124 "type": "A String", # Type of this ad unit. 125 }, 126 "customStyle": { # Custom style information specific to this ad unit. 127 "colors": { # The colors which are included in the style. These are represented as six hexadecimal characters, similar to HTML color codes, but without the leading hash. 128 "background": "A String", # The color of the ad background. 129 "border": "A String", # The color of the ad border. 130 "text": "A String", # The color of the ad text. 131 "title": "A String", # The color of the ad title. 132 "url": "A String", # The color of the ad url. 133 }, 134 "corners": "A String", # The style of the corners in the ad (deprecated: never populated, ignored). 135 "font": { # The font which is included in the style. 136 "family": "A String", # The family of the font. 137 "size": "A String", # The size of the font. 138 }, 139 "kind": "adsense#adStyle", # Kind this is, in this case adsense#adStyle. 140 }, 141 "feedAdsSettings": { # Settings specific to feed ads (AFF) - deprecated. 142 "adPosition": "A String", # The position of the ads relative to the feed entries. 143 "frequency": 42, # The frequency at which ads should appear in the feed (i.e. every N entries). 144 "minimumWordCount": 42, # The minimum length an entry should be in order to have attached ads. 145 "type": "A String", # The type of ads which should appear. 146 }, 147 "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. 148 "kind": "adsense#adUnit", # Kind of resource this is, in this case adsense#adUnit. 149 "mobileContentAdsSettings": { # Settings specific to WAP mobile content ads (AFMC) - deprecated. 150 "markupLanguage": "A String", # The markup language to use for this ad unit. 151 "scriptingLanguage": "A String", # The scripting language to use for this ad unit. 152 "size": "A String", # Size of this ad unit. 153 "type": "A String", # Type of this ad unit. 154 }, 155 "name": "A String", # Name of this ad unit. 156 "savedStyleId": "A String", # ID of the saved ad style which holds this ad unit's style information. 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="getAdCode">getAdCode(accountId, adClientId, adUnitId)</code> 168 <pre>Get ad code for the specified ad unit. 169 170Args: 171 accountId: string, Account which contains the ad client. (required) 172 adClientId: string, Ad client with contains the ad unit. (required) 173 adUnitId: string, Ad unit to get the code for. (required) 174 175Returns: 176 An object of the form: 177 178 { 179 "adCode": "A String", # The Auto ad code snippet. The ad code snippet. 180 "ampBody": "A String", # The AMP Auto ad code snippet that goes in the body of an AMP page. 181 "ampHead": "A String", # The AMP Auto ad code snippet that goes in the head of an AMP page. 182 "kind": "adsense#adCode", # Kind this is, in this case adsense#adCode. 183}</pre> 184</div> 185 186<div class="method"> 187 <code class="details" id="list">list(accountId, adClientId, includeInactive=None, maxResults=None, pageToken=None)</code> 188 <pre>List all ad units in the specified ad client for the specified account. 189 190Args: 191 accountId: string, Account to which the ad client belongs. (required) 192 adClientId: string, Ad client for which to list ad units. (required) 193 includeInactive: boolean, Whether to include inactive ad units. Default: true. 194 maxResults: integer, The maximum number of ad units to include in the response, used for paging. 195 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. 196 197Returns: 198 An object of the form: 199 200 { 201 "etag": "A String", # ETag of this response for caching purposes. 202 "items": [ # The ad units returned in this list response. 203 { 204 "code": "A String", # Identity code of this ad unit, not necessarily unique across ad clients. 205 "contentAdsSettings": { # Settings specific to content ads (AFC) and highend mobile content ads (AFMC - deprecated). 206 "backupOption": { # The backup option to be used in instances where no ad is available. 207 "color": "A String", # Color to use when type is set to COLOR. 208 "type": "A String", # Type of the backup option. Possible values are BLANK, COLOR and URL. 209 "url": "A String", # URL to use when type is set to URL. 210 }, 211 "size": "A String", # Size of this ad unit. 212 "type": "A String", # Type of this ad unit. 213 }, 214 "customStyle": { # Custom style information specific to this ad unit. 215 "colors": { # The colors which are included in the style. These are represented as six hexadecimal characters, similar to HTML color codes, but without the leading hash. 216 "background": "A String", # The color of the ad background. 217 "border": "A String", # The color of the ad border. 218 "text": "A String", # The color of the ad text. 219 "title": "A String", # The color of the ad title. 220 "url": "A String", # The color of the ad url. 221 }, 222 "corners": "A String", # The style of the corners in the ad (deprecated: never populated, ignored). 223 "font": { # The font which is included in the style. 224 "family": "A String", # The family of the font. 225 "size": "A String", # The size of the font. 226 }, 227 "kind": "adsense#adStyle", # Kind this is, in this case adsense#adStyle. 228 }, 229 "feedAdsSettings": { # Settings specific to feed ads (AFF) - deprecated. 230 "adPosition": "A String", # The position of the ads relative to the feed entries. 231 "frequency": 42, # The frequency at which ads should appear in the feed (i.e. every N entries). 232 "minimumWordCount": 42, # The minimum length an entry should be in order to have attached ads. 233 "type": "A String", # The type of ads which should appear. 234 }, 235 "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. 236 "kind": "adsense#adUnit", # Kind of resource this is, in this case adsense#adUnit. 237 "mobileContentAdsSettings": { # Settings specific to WAP mobile content ads (AFMC) - deprecated. 238 "markupLanguage": "A String", # The markup language to use for this ad unit. 239 "scriptingLanguage": "A String", # The scripting language to use for this ad unit. 240 "size": "A String", # Size of this ad unit. 241 "type": "A String", # Type of this ad unit. 242 }, 243 "name": "A String", # Name of this ad unit. 244 "savedStyleId": "A String", # ID of the saved ad style which holds this ad unit's style information. 245 "status": "A String", # Status of this ad unit. Possible values are: 246 # NEW: Indicates that the ad unit was created within the last seven days and does not yet have any activity associated with it. 247 # 248 # ACTIVE: Indicates that there has been activity on this ad unit in the last seven days. 249 # 250 # INACTIVE: Indicates that there has been no activity on this ad unit in the last seven days. 251 }, 252 ], 253 "kind": "adsense#adUnits", # Kind of list this is, in this case adsense#adUnits. 254 "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. 255}</pre> 256</div> 257 258<div class="method"> 259 <code class="details" id="list_next">list_next(previous_request, previous_response)</code> 260 <pre>Retrieves the next page of results. 261 262Args: 263 previous_request: The request for the previous page. (required) 264 previous_response: The response from the request for the previous page. (required) 265 266Returns: 267 A request object that you can call 'execute()' on to request the next 268 page. Returns None if there are no more items in the collection. 269 </pre> 270</div> 271 272</body></html>