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="adsensehost_v4_1.html">AdSense Host API</a> . <a href="adsensehost_v4_1.customchannels.html">customchannels</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78  <code><a href="#close">close()</a></code></p>
79<p class="firstline">Close httplib2 connections.</p>
80<p class="toc_element">
81  <code><a href="#delete">delete(adClientId, customChannelId)</a></code></p>
82<p class="firstline">Delete a specific custom channel from the host AdSense account.</p>
83<p class="toc_element">
84  <code><a href="#get">get(adClientId, customChannelId)</a></code></p>
85<p class="firstline">Get a specific custom channel from the host AdSense account.</p>
86<p class="toc_element">
87  <code><a href="#insert">insert(adClientId, body=None)</a></code></p>
88<p class="firstline">Add a new custom channel to the host AdSense account.</p>
89<p class="toc_element">
90  <code><a href="#list">list(adClientId, maxResults=None, pageToken=None)</a></code></p>
91<p class="firstline">List all host custom channels in this AdSense account.</p>
92<p class="toc_element">
93  <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
94<p class="firstline">Retrieves the next page of results.</p>
95<p class="toc_element">
96  <code><a href="#patch">patch(adClientId, customChannelId, body=None)</a></code></p>
97<p class="firstline">Update a custom channel in the host AdSense account. This method supports patch semantics.</p>
98<p class="toc_element">
99  <code><a href="#update">update(adClientId, body=None)</a></code></p>
100<p class="firstline">Update a custom channel in the host AdSense account.</p>
101<h3>Method Details</h3>
102<div class="method">
103    <code class="details" id="close">close()</code>
104  <pre>Close httplib2 connections.</pre>
105</div>
106
107<div class="method">
108    <code class="details" id="delete">delete(adClientId, customChannelId)</code>
109  <pre>Delete a specific custom channel from the host AdSense account.
110
111Args:
112  adClientId: string, Ad client from which to delete the custom channel. (required)
113  customChannelId: string, Custom channel to delete. (required)
114
115Returns:
116  An object of the form:
117
118    {
119  &quot;code&quot;: &quot;A String&quot;, # Code of this custom channel, not necessarily unique across ad clients.
120  &quot;id&quot;: &quot;A String&quot;, # 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.
121  &quot;kind&quot;: &quot;adsensehost#customChannel&quot;, # Kind of resource this is, in this case adsensehost#customChannel.
122  &quot;name&quot;: &quot;A String&quot;, # Name of this custom channel.
123}</pre>
124</div>
125
126<div class="method">
127    <code class="details" id="get">get(adClientId, customChannelId)</code>
128  <pre>Get a specific custom channel from the host AdSense account.
129
130Args:
131  adClientId: string, Ad client from which to get the custom channel. (required)
132  customChannelId: string, Custom channel to get. (required)
133
134Returns:
135  An object of the form:
136
137    {
138  &quot;code&quot;: &quot;A String&quot;, # Code of this custom channel, not necessarily unique across ad clients.
139  &quot;id&quot;: &quot;A String&quot;, # 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.
140  &quot;kind&quot;: &quot;adsensehost#customChannel&quot;, # Kind of resource this is, in this case adsensehost#customChannel.
141  &quot;name&quot;: &quot;A String&quot;, # Name of this custom channel.
142}</pre>
143</div>
144
145<div class="method">
146    <code class="details" id="insert">insert(adClientId, body=None)</code>
147  <pre>Add a new custom channel to the host AdSense account.
148
149Args:
150  adClientId: string, Ad client to which the new custom channel will be added. (required)
151  body: object, The request body.
152    The object takes the form of:
153
154{
155  &quot;code&quot;: &quot;A String&quot;, # Code of this custom channel, not necessarily unique across ad clients.
156  &quot;id&quot;: &quot;A String&quot;, # 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.
157  &quot;kind&quot;: &quot;adsensehost#customChannel&quot;, # Kind of resource this is, in this case adsensehost#customChannel.
158  &quot;name&quot;: &quot;A String&quot;, # Name of this custom channel.
159}
160
161
162Returns:
163  An object of the form:
164
165    {
166  &quot;code&quot;: &quot;A String&quot;, # Code of this custom channel, not necessarily unique across ad clients.
167  &quot;id&quot;: &quot;A String&quot;, # 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.
168  &quot;kind&quot;: &quot;adsensehost#customChannel&quot;, # Kind of resource this is, in this case adsensehost#customChannel.
169  &quot;name&quot;: &quot;A String&quot;, # Name of this custom channel.
170}</pre>
171</div>
172
173<div class="method">
174    <code class="details" id="list">list(adClientId, maxResults=None, pageToken=None)</code>
175  <pre>List all host custom channels in this AdSense account.
176
177Args:
178  adClientId: string, Ad client for which to list custom channels. (required)
179  maxResults: integer, The maximum number of custom channels to include in the response, used for paging.
180  pageToken: string, A continuation token, used to page through custom channels. To retrieve the next page, set this parameter to the value of &quot;nextPageToken&quot; from the previous response.
181
182Returns:
183  An object of the form:
184
185    {
186  &quot;etag&quot;: &quot;A String&quot;, # ETag of this response for caching purposes.
187  &quot;items&quot;: [ # The custom channels returned in this list response.
188    {
189      &quot;code&quot;: &quot;A String&quot;, # Code of this custom channel, not necessarily unique across ad clients.
190      &quot;id&quot;: &quot;A String&quot;, # 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.
191      &quot;kind&quot;: &quot;adsensehost#customChannel&quot;, # Kind of resource this is, in this case adsensehost#customChannel.
192      &quot;name&quot;: &quot;A String&quot;, # Name of this custom channel.
193    },
194  ],
195  &quot;kind&quot;: &quot;adsensehost#customChannels&quot;, # Kind of list this is, in this case adsensehost#customChannels.
196  &quot;nextPageToken&quot;: &quot;A String&quot;, # Continuation token used to page through custom channels. To retrieve the next page of results, set the next request&#x27;s &quot;pageToken&quot; value to this.
197}</pre>
198</div>
199
200<div class="method">
201    <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
202  <pre>Retrieves the next page of results.
203
204Args:
205  previous_request: The request for the previous page. (required)
206  previous_response: The response from the request for the previous page. (required)
207
208Returns:
209  A request object that you can call &#x27;execute()&#x27; on to request the next
210  page. Returns None if there are no more items in the collection.
211    </pre>
212</div>
213
214<div class="method">
215    <code class="details" id="patch">patch(adClientId, customChannelId, body=None)</code>
216  <pre>Update a custom channel in the host AdSense account. This method supports patch semantics.
217
218Args:
219  adClientId: string, Ad client in which the custom channel will be updated. (required)
220  customChannelId: string, Custom channel to get. (required)
221  body: object, The request body.
222    The object takes the form of:
223
224{
225  &quot;code&quot;: &quot;A String&quot;, # Code of this custom channel, not necessarily unique across ad clients.
226  &quot;id&quot;: &quot;A String&quot;, # 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.
227  &quot;kind&quot;: &quot;adsensehost#customChannel&quot;, # Kind of resource this is, in this case adsensehost#customChannel.
228  &quot;name&quot;: &quot;A String&quot;, # Name of this custom channel.
229}
230
231
232Returns:
233  An object of the form:
234
235    {
236  &quot;code&quot;: &quot;A String&quot;, # Code of this custom channel, not necessarily unique across ad clients.
237  &quot;id&quot;: &quot;A String&quot;, # 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.
238  &quot;kind&quot;: &quot;adsensehost#customChannel&quot;, # Kind of resource this is, in this case adsensehost#customChannel.
239  &quot;name&quot;: &quot;A String&quot;, # Name of this custom channel.
240}</pre>
241</div>
242
243<div class="method">
244    <code class="details" id="update">update(adClientId, body=None)</code>
245  <pre>Update a custom channel in the host AdSense account.
246
247Args:
248  adClientId: string, Ad client in which the custom channel will be updated. (required)
249  body: object, The request body.
250    The object takes the form of:
251
252{
253  &quot;code&quot;: &quot;A String&quot;, # Code of this custom channel, not necessarily unique across ad clients.
254  &quot;id&quot;: &quot;A String&quot;, # 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.
255  &quot;kind&quot;: &quot;adsensehost#customChannel&quot;, # Kind of resource this is, in this case adsensehost#customChannel.
256  &quot;name&quot;: &quot;A String&quot;, # Name of this custom channel.
257}
258
259
260Returns:
261  An object of the form:
262
263    {
264  &quot;code&quot;: &quot;A String&quot;, # Code of this custom channel, not necessarily unique across ad clients.
265  &quot;id&quot;: &quot;A String&quot;, # 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.
266  &quot;kind&quot;: &quot;adsensehost#customChannel&quot;, # Kind of resource this is, in this case adsensehost#customChannel.
267  &quot;name&quot;: &quot;A String&quot;, # Name of this custom channel.
268}</pre>
269</div>
270
271</body></html>