Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 98b51f044ede8b9b24e584ab9680e3f35f4bd469 / . / docs / dyn / adexchangeseller_v1.customchannels.html
blob: 0d324f88ecd6c28862564f0b6fa571aa9a0236b5 [file] [log] [blame]
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]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.html">Ad Exchange Seller API</a> . <a href="adexchangeseller_v1.customchannels.html">customchannels</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="adexchangeseller_v1.customchannels.adunits.html">adunits()</a></code>
79</p>
80<p class="firstline">Returns the adunits Resource.</p>
81
82<p class="toc_element">
83 <code><a href="#get">get(adClientId, customChannelId)</a></code></p>
84<p class="firstline">Get the specified custom channel from the specified ad client.</p>
85<p class="toc_element">
86 <code><a href="#list">list(adClientId, pageToken=None, maxResults=None)</a></code></p>
87<p class="firstline">List all custom channels in the specified ad client for this Ad Exchange account.</p>
88<p class="toc_element">
89 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
90<p class="firstline">Retrieves the next page of results.</p>
91<h3>Method Details</h3>
92<div class="method">
93 <code class="details" id="get">get(adClientId, customChannelId)</code>
94 <pre>Get the specified custom channel from the specified ad client.
95
96Args:
97 adClientId: string, Ad client which contains the custom channel. (required)
98 customChannelId: string, Custom channel to retrieve. (required)
99
100Returns:
101 An object of the form:
102
103 {
104 "kind": "adexchangeseller#customChannel", # Kind of resource this is, in this case adexchangeseller#customChannel.
105 "code": "A String", # Code of this custom channel, not necessarily unique across ad clients.
106 "targetingInfo": { # The targeting information of this custom channel, if activated.
107 "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.
108 "adsAppearOn": "A String", # The name used to describe this channel externally.
109 "siteLanguage": "A String", # The language of the sites ads will be displayed on.
110 "description": "A String", # The external description of the channel.
111 },
112 "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.
113 "name": "A String", # Name of this custom channel.
114 }</pre>
115</div>
116
117<div class="method">
118 <code class="details" id="list">list(adClientId, pageToken=None, maxResults=None)</code>
119 <pre>List all custom channels in the specified ad client for this Ad Exchange account.
120
121Args:
122 adClientId: string, Ad client for which to list custom channels. (required)
123 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.
124 maxResults: integer, The maximum number of custom channels to include in the response, used for paging.
125
126Returns:
127 An object of the form:
128
129 {
130 "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.
131 "items": [ # The custom channels returned in this list response.
132 {
133 "kind": "adexchangeseller#customChannel", # Kind of resource this is, in this case adexchangeseller#customChannel.
134 "code": "A String", # Code of this custom channel, not necessarily unique across ad clients.
135 "targetingInfo": { # The targeting information of this custom channel, if activated.
136 "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.
137 "adsAppearOn": "A String", # The name used to describe this channel externally.
138 "siteLanguage": "A String", # The language of the sites ads will be displayed on.
139 "description": "A String", # The external description of the channel.
140 },
141 "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.
142 "name": "A String", # Name of this custom channel.
143 },
144 ],
145 "kind": "adexchangeseller#customChannels", # Kind of list this is, in this case adexchangeseller#customChannels.
146 "etag": "A String", # ETag of this response for caching purposes.
147 }</pre>
148</div>
149
150<div class="method">
151 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
152 <pre>Retrieves the next page of results.
153
154Args:
155 previous_request: The request for the previous page. (required)
156 previous_response: The response from the request for the previous page. (required)
157
158Returns:
159 A request object that you can call 'execute()' on to request the next
160 page. Returns None if there are no more items in the collection.
161 </pre>
162</div>
163
164</body></html>