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