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