1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
|
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="adsenseplatform_v1alpha.html">AdSense Platform API</a> . <a href="adsenseplatform_v1alpha.platforms.html">platforms</a> . <a href="adsenseplatform_v1alpha.platforms.accounts.html">accounts</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="adsenseplatform_v1alpha.platforms.accounts.events.html">events()</a></code>
</p>
<p class="firstline">Returns the events Resource.</p>
<p class="toc_element">
<code><a href="adsenseplatform_v1alpha.platforms.accounts.sites.html">sites()</a></code>
</p>
<p class="firstline">Returns the sites Resource.</p>
<p class="toc_element">
<code><a href="#close">close(name, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Closes a sub-account.</p>
<p class="toc_element">
<code><a href="#create">create(parent, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Creates a sub-account.</p>
<p class="toc_element">
<code><a href="#get">get(name, x__xgafv=None)</a></code></p>
<p class="firstline">Gets information about the selected sub-account.</p>
<p class="toc_element">
<code><a href="#list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists a partial view of sub-accounts for a specific parent account.</p>
<p class="toc_element">
<code><a href="#list_next">list_next()</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
<code><a href="#lookup">lookup(parent, creationRequestId=None, x__xgafv=None)</a></code></p>
<p class="firstline">Looks up information about a sub-account for a specified creation_request_id. If no account exists for the given creation_request_id, returns 404.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="close">close(name, body=None, x__xgafv=None)</code>
<pre>Closes a sub-account.
Args:
name: string, Required. Account to close. Format: platforms/{platform}/accounts/{account_id} (required)
body: object, The request body.
The object takes the form of:
{ # Request definition for the account close rpc.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Response definition for the account close rpc.
}</pre>
</div>
<div class="method">
<code class="details" id="create">create(parent, body=None, x__xgafv=None)</code>
<pre>Creates a sub-account.
Args:
parent: string, Required. Platform to create an account for. Format: platforms/{platform} (required)
body: object, The request body.
The object takes the form of:
{ # Representation of an Account.
"createTime": "A String", # Output only. Creation time of the account.
"creationRequestId": "A String", # Required. An opaque token that uniquely identifies the account among all the platform's accounts. This string may contain at most 64 non-whitespace ASCII characters, but otherwise has no predefined structure. However, it is expected to be a platform-specific identifier for the user creating the account, so that only a single account can be created for any given user. This field must not contain any information that is recognizable as personally identifiable information. e.g. it should not be an email address or login name. Once an account has been created, a second attempt to create an account using the same creation_request_id will result in an ALREADY_EXISTS error.
"displayName": "A String", # Display name of this account.
"name": "A String", # Output only. Resource name of the account. Format: platforms/pub-[0-9]+/accounts/pub-[0-9]+
"regionCode": "A String", # Required. Input only. CLDR region code of the country/region of the address. Set this to country code of the child account if known, otherwise to your own country code.
"state": "A String", # Output only. Approval state of the account.
"timeZone": { # Represents a time zone from the [IANA Time Zone Database](https://www.iana.org/time-zones). # Required. The IANA TZ timezone code of this account. For more information, see https://en.wikipedia.org/wiki/List_of_tz_database_time_zones. This field is used for reporting. It is recommended to set it to the same value for all child accounts.
"id": "A String", # IANA Time Zone Database time zone. For example "America/New_York".
"version": "A String", # Optional. IANA Time Zone Database version number. For example "2019a".
},
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Representation of an Account.
"createTime": "A String", # Output only. Creation time of the account.
"creationRequestId": "A String", # Required. An opaque token that uniquely identifies the account among all the platform's accounts. This string may contain at most 64 non-whitespace ASCII characters, but otherwise has no predefined structure. However, it is expected to be a platform-specific identifier for the user creating the account, so that only a single account can be created for any given user. This field must not contain any information that is recognizable as personally identifiable information. e.g. it should not be an email address or login name. Once an account has been created, a second attempt to create an account using the same creation_request_id will result in an ALREADY_EXISTS error.
"displayName": "A String", # Display name of this account.
"name": "A String", # Output only. Resource name of the account. Format: platforms/pub-[0-9]+/accounts/pub-[0-9]+
"regionCode": "A String", # Required. Input only. CLDR region code of the country/region of the address. Set this to country code of the child account if known, otherwise to your own country code.
"state": "A String", # Output only. Approval state of the account.
"timeZone": { # Represents a time zone from the [IANA Time Zone Database](https://www.iana.org/time-zones). # Required. The IANA TZ timezone code of this account. For more information, see https://en.wikipedia.org/wiki/List_of_tz_database_time_zones. This field is used for reporting. It is recommended to set it to the same value for all child accounts.
"id": "A String", # IANA Time Zone Database time zone. For example "America/New_York".
"version": "A String", # Optional. IANA Time Zone Database version number. For example "2019a".
},
}</pre>
</div>
<div class="method">
<code class="details" id="get">get(name, x__xgafv=None)</code>
<pre>Gets information about the selected sub-account.
Args:
name: string, Required. Account to get information about. Format: platforms/{platform}/accounts/{account_id} (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Representation of an Account.
"createTime": "A String", # Output only. Creation time of the account.
"creationRequestId": "A String", # Required. An opaque token that uniquely identifies the account among all the platform's accounts. This string may contain at most 64 non-whitespace ASCII characters, but otherwise has no predefined structure. However, it is expected to be a platform-specific identifier for the user creating the account, so that only a single account can be created for any given user. This field must not contain any information that is recognizable as personally identifiable information. e.g. it should not be an email address or login name. Once an account has been created, a second attempt to create an account using the same creation_request_id will result in an ALREADY_EXISTS error.
"displayName": "A String", # Display name of this account.
"name": "A String", # Output only. Resource name of the account. Format: platforms/pub-[0-9]+/accounts/pub-[0-9]+
"regionCode": "A String", # Required. Input only. CLDR region code of the country/region of the address. Set this to country code of the child account if known, otherwise to your own country code.
"state": "A String", # Output only. Approval state of the account.
"timeZone": { # Represents a time zone from the [IANA Time Zone Database](https://www.iana.org/time-zones). # Required. The IANA TZ timezone code of this account. For more information, see https://en.wikipedia.org/wiki/List_of_tz_database_time_zones. This field is used for reporting. It is recommended to set it to the same value for all child accounts.
"id": "A String", # IANA Time Zone Database time zone. For example "America/New_York".
"version": "A String", # Optional. IANA Time Zone Database version number. For example "2019a".
},
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</code>
<pre>Lists a partial view of sub-accounts for a specific parent account.
Args:
parent: string, Required. Platform who parents the accounts. Format: platforms/{platform} (required)
pageSize: integer, Optional. 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.
pageToken: string, Optional. A page token, received from a previous `ListAccounts` call. Provide this to retrieve the subsequent page.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Response definition for the list accounts rpc.
"accounts": [ # The Accounts returned in the list response. Represented by a partial view of the Account resource, populating `name` and `creation_request_id`.
{ # Representation of an Account.
"createTime": "A String", # Output only. Creation time of the account.
"creationRequestId": "A String", # Required. An opaque token that uniquely identifies the account among all the platform's accounts. This string may contain at most 64 non-whitespace ASCII characters, but otherwise has no predefined structure. However, it is expected to be a platform-specific identifier for the user creating the account, so that only a single account can be created for any given user. This field must not contain any information that is recognizable as personally identifiable information. e.g. it should not be an email address or login name. Once an account has been created, a second attempt to create an account using the same creation_request_id will result in an ALREADY_EXISTS error.
"displayName": "A String", # Display name of this account.
"name": "A String", # Output only. Resource name of the account. Format: platforms/pub-[0-9]+/accounts/pub-[0-9]+
"regionCode": "A String", # Required. Input only. CLDR region code of the country/region of the address. Set this to country code of the child account if known, otherwise to your own country code.
"state": "A String", # Output only. Approval state of the account.
"timeZone": { # Represents a time zone from the [IANA Time Zone Database](https://www.iana.org/time-zones). # Required. The IANA TZ timezone code of this account. For more information, see https://en.wikipedia.org/wiki/List_of_tz_database_time_zones. This field is used for reporting. It is recommended to set it to the same value for all child accounts.
"id": "A String", # IANA Time Zone Database time zone. For example "America/New_York".
"version": "A String", # Optional. IANA Time Zone Database version number. For example "2019a".
},
},
],
"nextPageToken": "A String", # Continuation token used to page through accounts. To retrieve the next page of the results, set the next request's "page_token" value to this.
}</pre>
</div>
<div class="method">
<code class="details" id="list_next">list_next()</code>
<pre>Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
<div class="method">
<code class="details" id="lookup">lookup(parent, creationRequestId=None, x__xgafv=None)</code>
<pre>Looks up information about a sub-account for a specified creation_request_id. If no account exists for the given creation_request_id, returns 404.
Args:
parent: string, Required. Platform who parents the account. Format: platforms/{platform} (required)
creationRequestId: string, Optional. The creation_request_id provided when calling createAccount.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Response definition for the lookup account rpc.
"name": "A String", # The name of the Account Format: platforms/{platform}/accounts/{account_id}
}</pre>
</div>
</body></html>
|
