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