• 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.adunits.html">adunits</a> . <a href="adexchangeseller_v1_1.adunits.customchannels.html">customchannels</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78  <code><a href="#list">list(adClientId, adUnitId, pageToken=None, maxResults=None)</a></code></p>
79<p class="firstline">List all custom channels which the specified ad unit belongs to.</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, adUnitId, pageToken=None, maxResults=None)</code>
86  <pre>List all custom channels which the specified ad unit belongs to.
87
88Args:
89  adClientId: string, Ad client which contains the ad unit. (required)
90  adUnitId: string, Ad unit for which to list custom channels. (required)
91  pageToken: string, A continuation token, used to page through custom channels. To retrieve the next page, set this parameter to the value of "nextPageToken" from the previous response.
92  maxResults: integer, The maximum number of custom channels to include in the response, used for paging.
93
94Returns:
95  An object of the form:
96
97    {
98    "nextPageToken": "A String", # Continuation token used to page through custom channels. To retrieve the next page of results, set the next request's "pageToken" value to this.
99    "items": [ # The custom channels returned in this list response.
100      {
101        "kind": "adexchangeseller#customChannel", # Kind of resource this is, in this case adexchangeseller#customChannel.
102        "code": "A String", # Code of this custom channel, not necessarily unique across ad clients.
103        "targetingInfo": { # The targeting information of this custom channel, if activated.
104          "location": "A String", # The locations in which ads appear. (Only valid for content and mobile content ads). Acceptable values for content ads are: TOP_LEFT, TOP_CENTER, TOP_RIGHT, MIDDLE_LEFT, MIDDLE_CENTER, MIDDLE_RIGHT, BOTTOM_LEFT, BOTTOM_CENTER, BOTTOM_RIGHT, MULTIPLE_LOCATIONS. Acceptable values for mobile content ads are: TOP, MIDDLE, BOTTOM, MULTIPLE_LOCATIONS.
105          "adsAppearOn": "A String", # The name used to describe this channel externally.
106          "siteLanguage": "A String", # The language of the sites ads will be displayed on.
107          "description": "A String", # The external description of the channel.
108        },
109        "id": "A String", # Unique identifier of this custom channel. This should be considered an opaque identifier; it is not safe to rely on it being in any particular format.
110        "name": "A String", # Name of this custom channel.
111      },
112    ],
113    "kind": "adexchangeseller#customChannels", # Kind of list this is, in this case adexchangeseller#customChannels.
114    "etag": "A String", # ETag of this response for caching purposes.
115  }</pre>
116</div>
117
118<div class="method">
119    <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
120  <pre>Retrieves the next page of results.
121
122Args:
123  previous_request: The request for the previous page. (required)
124  previous_response: The response from the request for the previous page. (required)
125
126Returns:
127  A request object that you can call 'execute()' on to request the next
128  page. Returns None if there are no more items in the collection.
129    </pre>
130</div>
131
132</body></html>