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.customchannels.html">customchannels</a> . <a href="adsense_v1_4.customchannels.adunits.html">adunits</a></h1> 76 <h2>Instance Methods</h2> 77 <p class="toc_element"> 78 <code><a href="#list">list(adClientId, customChannelId, pageToken=None, includeInactive=None, maxResults=None)</a></code></p> 79 <p class="firstline">List all ad units in the specified custom channel.</p> 80 <p class="toc_element"> 81 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> 82 <p class="firstline">Retrieves the next page of results.</p> 83 <h3>Method Details</h3> 84 <div class="method"> 85 <code class="details" id="list">list(adClientId, customChannelId, pageToken=None, includeInactive=None, maxResults=None)</code> 86 <pre>List all ad units in the specified custom channel. 87 88 Args: 89 adClientId: string, Ad client which contains the custom channel. (required) 90 customChannelId: string, Custom channel for which to list ad units. (required) 91 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. 92 includeInactive: boolean, Whether to include inactive ad units. Default: true. 93 maxResults: integer, The maximum number of ad units to include in the response, used for paging. 94 95 Returns: 96 An object of the form: 97 98 { 99 "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. 100 "items": [ # The ad units returned in this list response. 101 { 102 "status": "A String", # Status of this ad unit. Possible values are: 103 # NEW: Indicates that the ad unit was created within the last seven days and does not yet have any activity associated with it. 104 # 105 # ACTIVE: Indicates that there has been activity on this ad unit in the last seven days. 106 # 107 # INACTIVE: Indicates that there has been no activity on this ad unit in the last seven days. 108 "kind": "adsense#adUnit", # Kind of resource this is, in this case adsense#adUnit. 109 "code": "A String", # Identity code of this ad unit, not necessarily unique across ad clients. 110 "name": "A String", # Name of this ad unit. 111 "feedAdsSettings": { # Settings specific to feed ads (AFF) - deprecated. 112 "minimumWordCount": 42, # The minimum length an entry should be in order to have attached ads. 113 "frequency": 42, # The frequency at which ads should appear in the feed (i.e. every N entries). 114 "adPosition": "A String", # The position of the ads relative to the feed entries. 115 "type": "A String", # The type of ads which should appear. 116 }, 117 "savedStyleId": "A String", # ID of the saved ad style which holds this ad unit's style information. 118 "contentAdsSettings": { # Settings specific to content ads (AFC) and highend mobile content ads (AFMC - deprecated). 119 "type": "A String", # Type of this ad unit. 120 "backupOption": { # The backup option to be used in instances where no ad is available. 121 "color": "A String", # Color to use when type is set to COLOR. 122 "url": "A String", # URL to use when type is set to URL. 123 "type": "A String", # Type of the backup option. Possible values are BLANK, COLOR and URL. 124 }, 125 "size": "A String", # Size of this ad unit. 126 }, 127 "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. 128 "mobileContentAdsSettings": { # Settings specific to WAP mobile content ads (AFMC) - deprecated. 129 "scriptingLanguage": "A String", # The scripting language to use for this ad unit. 130 "type": "A String", # Type of this ad unit. 131 "markupLanguage": "A String", # The markup language to use for this ad unit. 132 "size": "A String", # Size of this ad unit. 133 }, 134 "customStyle": { # Custom style information specific to this ad unit. 135 "corners": "A String", # The style of the corners in the ad (deprecated: never populated, ignored). 136 "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. 137 "url": "A String", # The color of the ad url. 138 "text": "A String", # The color of the ad text. 139 "border": "A String", # The color of the ad border. 140 "background": "A String", # The color of the ad background. 141 "title": "A String", # The color of the ad title. 142 }, 143 "font": { # The font which is included in the style. 144 "family": "A String", # The family of the font. 145 "size": "A String", # The size of the font. 146 }, 147 "kind": "adsense#adStyle", # Kind this is, in this case adsense#adStyle. 148 }, 149 }, 150 ], 151 "kind": "adsense#adUnits", # Kind of list this is, in this case adsense#adUnits. 152 "etag": "A String", # ETag of this response for caching purposes. 153 }</pre> 154 </div> 155 156 <div class="method"> 157 <code class="details" id="list_next">list_next(previous_request, previous_response)</code> 158 <pre>Retrieves the next page of results. 159 160 Args: 161 previous_request: The request for the previous page. (required) 162 previous_response: The response from the request for the previous page. (required) 163 164 Returns: 165 A request object that you can call 'execute()' on to request the next 166 page. Returns None if there are no more items in the collection. 167 </pre> 168 </div> 169 170 </body></html>
