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