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