blob: 4b03cceaea8c5b1100af9cf2ea83be977a263e33 [file] [log] [blame]
yoshi-code-bot3dd15272021-04-21 15:07:48 -07001<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_v2.html">AdSense Management API</a> . <a href="adsense_v2.accounts.html">accounts</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="adsense_v2.accounts.adclients.html">adclients()</a></code>
79</p>
80<p class="firstline">Returns the adclients Resource.</p>
81
82<p class="toc_element">
83 <code><a href="adsense_v2.accounts.alerts.html">alerts()</a></code>
84</p>
85<p class="firstline">Returns the alerts Resource.</p>
86
87<p class="toc_element">
88 <code><a href="adsense_v2.accounts.payments.html">payments()</a></code>
89</p>
90<p class="firstline">Returns the payments Resource.</p>
91
92<p class="toc_element">
93 <code><a href="adsense_v2.accounts.reports.html">reports()</a></code>
94</p>
95<p class="firstline">Returns the reports Resource.</p>
96
97<p class="toc_element">
98 <code><a href="adsense_v2.accounts.sites.html">sites()</a></code>
99</p>
100<p class="firstline">Returns the sites Resource.</p>
101
102<p class="toc_element">
103 <code><a href="#close">close()</a></code></p>
104<p class="firstline">Close httplib2 connections.</p>
105<p class="toc_element">
106 <code><a href="#get">get(name, x__xgafv=None)</a></code></p>
107<p class="firstline">Gets information about the selected AdSense account.</p>
108<p class="toc_element">
109 <code><a href="#list">list(pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
110<p class="firstline">Lists all accounts available to this user.</p>
111<p class="toc_element">
112 <code><a href="#listChildAccounts">listChildAccounts(parent, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
113<p class="firstline">Lists all accounts directly managed by the given AdSense account.</p>
114<p class="toc_element">
115 <code><a href="#listChildAccounts_next">listChildAccounts_next(previous_request, previous_response)</a></code></p>
116<p class="firstline">Retrieves the next page of results.</p>
117<p class="toc_element">
118 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
119<p class="firstline">Retrieves the next page of results.</p>
120<h3>Method Details</h3>
121<div class="method">
122 <code class="details" id="close">close()</code>
123 <pre>Close httplib2 connections.</pre>
124</div>
125
126<div class="method">
127 <code class="details" id="get">get(name, x__xgafv=None)</code>
128 <pre>Gets information about the selected AdSense account.
129
130Args:
yoshi-code-bot85954412021-12-06 23:26:37 -0800131 name: string, Required. Account to get information about. Format: accounts/{account} (required)
yoshi-code-bot3dd15272021-04-21 15:07:48 -0700132 x__xgafv: string, V1 error format.
133 Allowed values
134 1 - v1 error format
135 2 - v2 error format
136
137Returns:
138 An object of the form:
139
140 { # Representation of an account.
141 &quot;createTime&quot;: &quot;A String&quot;, # Output only. Creation time of the account.
142 &quot;displayName&quot;: &quot;A String&quot;, # Output only. Display name of this account.
143 &quot;name&quot;: &quot;A String&quot;, # Resource name of the account. Format: accounts/pub-[0-9]+
144 &quot;pendingTasks&quot;: [ # Output only. Outstanding tasks that need to be completed as part of the sign-up process for a new account. e.g. &quot;billing-profile-creation&quot;, &quot;phone-pin-verification&quot;.
145 &quot;A String&quot;,
146 ],
147 &quot;premium&quot;: True or False, # Output only. Whether this account is premium.
148 &quot;timeZone&quot;: { # Represents a time zone from the [IANA Time Zone Database](https://www.iana.org/time-zones). # The account time zone, as used by reporting. For more information, see [changing the time zone of your reports](https://support.google.com/adsense/answer/9830725).
149 &quot;id&quot;: &quot;A String&quot;, # IANA Time Zone Database time zone, e.g. &quot;America/New_York&quot;.
150 &quot;version&quot;: &quot;A String&quot;, # Optional. IANA Time Zone Database version number, e.g. &quot;2019a&quot;.
151 },
152}</pre>
153</div>
154
155<div class="method">
156 <code class="details" id="list">list(pageSize=None, pageToken=None, x__xgafv=None)</code>
157 <pre>Lists all accounts available to this user.
158
159Args:
160 pageSize: integer, The maximum number of accounts to include in the response, used for paging. If unspecified, at most 10000 accounts will be returned. The maximum value is 10000; values above 10000 will be coerced to 10000.
161 pageToken: string, A page token, received from a previous `ListAccounts` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListAccounts` must match the call that provided the page token.
162 x__xgafv: string, V1 error format.
163 Allowed values
164 1 - v1 error format
165 2 - v2 error format
166
167Returns:
168 An object of the form:
169
170 { # Response definition for the account list rpc.
171 &quot;accounts&quot;: [ # The accounts returned in this list response.
172 { # Representation of an account.
173 &quot;createTime&quot;: &quot;A String&quot;, # Output only. Creation time of the account.
174 &quot;displayName&quot;: &quot;A String&quot;, # Output only. Display name of this account.
175 &quot;name&quot;: &quot;A String&quot;, # Resource name of the account. Format: accounts/pub-[0-9]+
176 &quot;pendingTasks&quot;: [ # Output only. Outstanding tasks that need to be completed as part of the sign-up process for a new account. e.g. &quot;billing-profile-creation&quot;, &quot;phone-pin-verification&quot;.
177 &quot;A String&quot;,
178 ],
179 &quot;premium&quot;: True or False, # Output only. Whether this account is premium.
180 &quot;timeZone&quot;: { # Represents a time zone from the [IANA Time Zone Database](https://www.iana.org/time-zones). # The account time zone, as used by reporting. For more information, see [changing the time zone of your reports](https://support.google.com/adsense/answer/9830725).
181 &quot;id&quot;: &quot;A String&quot;, # IANA Time Zone Database time zone, e.g. &quot;America/New_York&quot;.
182 &quot;version&quot;: &quot;A String&quot;, # Optional. IANA Time Zone Database version number, e.g. &quot;2019a&quot;.
183 },
184 },
185 ],
186 &quot;nextPageToken&quot;: &quot;A String&quot;, # Continuation token used to page through accounts. To retrieve the next page of the results, set the next request&#x27;s &quot;page_token&quot; value to this.
187}</pre>
188</div>
189
190<div class="method">
191 <code class="details" id="listChildAccounts">listChildAccounts(parent, pageSize=None, pageToken=None, x__xgafv=None)</code>
192 <pre>Lists all accounts directly managed by the given AdSense account.
193
194Args:
195 parent: string, Required. The parent account, which owns the child accounts. Format: accounts/{account} (required)
196 pageSize: integer, The maximum number of accounts to include in the response, used for paging. If unspecified, at most 10000 accounts will be returned. The maximum value is 10000; values above 10000 will be coerced to 10000.
197 pageToken: string, A page token, received from a previous `ListAccounts` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListAccounts` must match the call that provided the page token.
198 x__xgafv: string, V1 error format.
199 Allowed values
200 1 - v1 error format
201 2 - v2 error format
202
203Returns:
204 An object of the form:
205
206 { # Response definition for the child account list rpc.
207 &quot;accounts&quot;: [ # The accounts returned in this list response.
208 { # Representation of an account.
209 &quot;createTime&quot;: &quot;A String&quot;, # Output only. Creation time of the account.
210 &quot;displayName&quot;: &quot;A String&quot;, # Output only. Display name of this account.
211 &quot;name&quot;: &quot;A String&quot;, # Resource name of the account. Format: accounts/pub-[0-9]+
212 &quot;pendingTasks&quot;: [ # Output only. Outstanding tasks that need to be completed as part of the sign-up process for a new account. e.g. &quot;billing-profile-creation&quot;, &quot;phone-pin-verification&quot;.
213 &quot;A String&quot;,
214 ],
215 &quot;premium&quot;: True or False, # Output only. Whether this account is premium.
216 &quot;timeZone&quot;: { # Represents a time zone from the [IANA Time Zone Database](https://www.iana.org/time-zones). # The account time zone, as used by reporting. For more information, see [changing the time zone of your reports](https://support.google.com/adsense/answer/9830725).
217 &quot;id&quot;: &quot;A String&quot;, # IANA Time Zone Database time zone, e.g. &quot;America/New_York&quot;.
218 &quot;version&quot;: &quot;A String&quot;, # Optional. IANA Time Zone Database version number, e.g. &quot;2019a&quot;.
219 },
220 },
221 ],
222 &quot;nextPageToken&quot;: &quot;A String&quot;, # Continuation token used to page through accounts. To retrieve the next page of the results, set the next request&#x27;s &quot;page_token&quot; value to this.
223}</pre>
224</div>
225
226<div class="method">
227 <code class="details" id="listChildAccounts_next">listChildAccounts_next(previous_request, previous_response)</code>
228 <pre>Retrieves the next page of results.
229
230Args:
231 previous_request: The request for the previous page. (required)
232 previous_response: The response from the request for the previous page. (required)
233
234Returns:
235 A request object that you can call &#x27;execute()&#x27; on to request the next
236 page. Returns None if there are no more items in the collection.
237 </pre>
238</div>
239
240<div class="method">
241 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
242 <pre>Retrieves the next page of results.
243
244Args:
245 previous_request: The request for the previous page. (required)
246 previous_response: The response from the request for the previous page. (required)
247
248Returns:
249 A request object that you can call &#x27;execute()&#x27; on to request the next
250 page. Returns None if there are no more items in the collection.
251 </pre>
252</div>
253
254</body></html>