• 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="adexchangeseller_v1_1.html">Ad Exchange Seller API</a> . <a href="adexchangeseller_v1_1.customchannels.html">customchannels</a> . <a href="adexchangeseller_v1_1.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
88Args:
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
95Returns:
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": "adexchangeseller#adUnit", # Kind of resource this is, in this case adexchangeseller#adUnit.
109        "code": "A String", # Identity code of this ad unit, not necessarily unique across ad clients.
110        "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.
111        "name": "A String", # Name of this ad unit.
112      },
113    ],
114    "kind": "adexchangeseller#adUnits", # Kind of list this is, in this case adexchangeseller#adUnits.
115    "etag": "A String", # ETag of this response for caching purposes.
116  }</pre>
117</div>
118
119<div class="method">
120    <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
121  <pre>Retrieves the next page of results.
122
123Args:
124  previous_request: The request for the previous page. (required)
125  previous_response: The response from the request for the previous page. (required)
126
127Returns:
128  A request object that you can call 'execute()' on to request the next
129  page. Returns None if there are no more items in the collection.
130    </pre>
131</div>
132
133</body></html>