• 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_4.html">AdSense Management API</a> . <a href="adsense_v1_4.accounts.html">accounts</a> . <a href="adsense_v1_4.accounts.customchannels.html">customchannels</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78  <code><a href="adsense_v1_4.accounts.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(accountId, adClientId, customChannelId)</a></code></p>
84<p class="firstline">Get the specified custom channel from the specified ad client for the specified account.</p>
85<p class="toc_element">
86  <code><a href="#list">list(accountId, adClientId, pageToken=None, maxResults=None)</a></code></p>
87<p class="firstline">List all custom channels in the specified ad client for the specified 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(accountId, adClientId, customChannelId)</code>
94  <pre>Get the specified custom channel from the specified ad client for the specified account.
95
96Args:
97  accountId: string, Account to which the ad client belongs. (required)
98  adClientId: string, Ad client which contains the custom channel. (required)
99  customChannelId: string, Custom channel to retrieve. (required)
100
101Returns:
102  An object of the form:
103
104    {
105    "kind": "adsense#customChannel", # Kind of resource this is, in this case adsense#customChannel.
106    "code": "A String", # Code of this custom channel, not necessarily unique across ad clients.
107    "targetingInfo": { # The targeting information of this custom channel, if activated.
108      "location": "A String", # The locations in which ads appear. (Only valid for content and mobile content ads (deprecated)). 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 (deprecated) are: TOP, MIDDLE, BOTTOM, MULTIPLE_LOCATIONS.
109      "adsAppearOn": "A String", # The name used to describe this channel externally.
110      "siteLanguage": "A String", # The language of the sites ads will be displayed on.
111      "description": "A String", # The external description of the channel.
112    },
113    "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.
114    "name": "A String", # Name of this custom channel.
115  }</pre>
116</div>
117
118<div class="method">
119    <code class="details" id="list">list(accountId, adClientId, pageToken=None, maxResults=None)</code>
120  <pre>List all custom channels in the specified ad client for the specified account.
121
122Args:
123  accountId: string, Account to which the ad client belongs. (required)
124  adClientId: string, Ad client for which to list custom channels. (required)
125  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.
126  maxResults: integer, The maximum number of custom channels to include in the response, used for paging.
127
128Returns:
129  An object of the form:
130
131    {
132    "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.
133    "items": [ # The custom channels returned in this list response.
134      {
135        "kind": "adsense#customChannel", # Kind of resource this is, in this case adsense#customChannel.
136        "code": "A String", # Code of this custom channel, not necessarily unique across ad clients.
137        "targetingInfo": { # The targeting information of this custom channel, if activated.
138          "location": "A String", # The locations in which ads appear. (Only valid for content and mobile content ads (deprecated)). 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 (deprecated) are: TOP, MIDDLE, BOTTOM, MULTIPLE_LOCATIONS.
139          "adsAppearOn": "A String", # The name used to describe this channel externally.
140          "siteLanguage": "A String", # The language of the sites ads will be displayed on.
141          "description": "A String", # The external description of the channel.
142        },
143        "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.
144        "name": "A String", # Name of this custom channel.
145      },
146    ],
147    "kind": "adsense#customChannels", # Kind of list this is, in this case adsense#customChannels.
148    "etag": "A String", # ETag of this response for caching purposes.
149  }</pre>
150</div>
151
152<div class="method">
153    <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
154  <pre>Retrieves the next page of results.
155
156Args:
157  previous_request: The request for the previous page. (required)
158  previous_response: The response from the request for the previous page. (required)
159
160Returns:
161  A request object that you can call 'execute()' on to request the next
162  page. Returns None if there are no more items in the collection.
163    </pre>
164</div>
165
166</body></html>