blob: 7755428ed8b0594c222bf6570e4865587554b3c2 [file] [log] [blame]
John Asmuth614db982014-04-24 15:46:26 -04001<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.urlchannels.html">urlchannels</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -070078 <code><a href="#close">close()</a></code></p>
79<p class="firstline">Close httplib2 connections.</p>
80<p class="toc_element">
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -080081 <code><a href="#list">list(accountId, adClientId, maxResults=None, pageToken=None)</a></code></p>
John Asmuth614db982014-04-24 15:46:26 -040082<p class="firstline">List all URL channels in the specified ad client for the specified account.</p>
83<p class="toc_element">
84 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
85<p class="firstline">Retrieves the next page of results.</p>
86<h3>Method Details</h3>
87<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -070088 <code class="details" id="close">close()</code>
89 <pre>Close httplib2 connections.</pre>
90</div>
91
92<div class="method">
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -080093 <code class="details" id="list">list(accountId, adClientId, maxResults=None, pageToken=None)</code>
John Asmuth614db982014-04-24 15:46:26 -040094 <pre>List all URL channels in 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 for which to list URL channels. (required)
Yoshi Automation Botb6971b02020-11-26 17:16:03 -080099 maxResults: integer, The maximum number of URL channels to include in the response, used for paging.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800100 pageToken: string, A continuation token, used to page through URL channels. To retrieve the next page, set this parameter to the value of &quot;nextPageToken&quot; from the previous response.
John Asmuth614db982014-04-24 15:46:26 -0400101
102Returns:
103 An object of the form:
104
105 {
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800106 &quot;etag&quot;: &quot;A String&quot;, # ETag of this response for caching purposes.
107 &quot;items&quot;: [ # The URL channels returned in this list response.
108 {
109 &quot;id&quot;: &quot;A String&quot;, # Unique identifier of this URL channel. This should be considered an opaque identifier; it is not safe to rely on it being in any particular format.
110 &quot;kind&quot;: &quot;adsense#urlChannel&quot;, # Kind of resource this is, in this case adsense#urlChannel.
111 &quot;urlPattern&quot;: &quot;A String&quot;, # URL Pattern of this URL channel. Does not include &quot;http://&quot; or &quot;https://&quot;. Example: www.example.com/home
112 },
113 ],
114 &quot;kind&quot;: &quot;adsense#urlChannels&quot;, # Kind of list this is, in this case adsense#urlChannels.
115 &quot;nextPageToken&quot;: &quot;A String&quot;, # Continuation token used to page through URL channels. To retrieve the next page of results, set the next request&#x27;s &quot;pageToken&quot; value to this.
116}</pre>
John Asmuth614db982014-04-24 15:46:26 -0400117</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:
Bu Sun Kim65020912020-05-20 12:08:20 -0700128 A request object that you can call &#x27;execute()&#x27; on to request the next
John Asmuth614db982014-04-24 15:46:26 -0400129 page. Returns None if there are no more items in the collection.
130 </pre>
131</div>
132
133</body></html>