blob: b697bea2dca31411c3bc22f5b6a169b1437993ec [file] [log] [blame]
yoshi-code-botf4773f62021-10-19 00:22:31 -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="androidpublisher_v3.html">Google Play Android Developer API</a> . <a href="androidpublisher_v3.users.html">users</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="#create">create(parent, body=None, x__xgafv=None)</a></code></p>
82<p class="firstline">Grant access for a user to the given developer account.</p>
83<p class="toc_element">
84 <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
85<p class="firstline">Removes all access for the user to the given developer account.</p>
86<p class="toc_element">
87 <code><a href="#list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
88<p class="firstline">Lists all users with access to a developer account.</p>
89<p class="toc_element">
90 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
91<p class="firstline">Retrieves the next page of results.</p>
92<p class="toc_element">
93 <code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
94<p class="firstline">Updates access for the user to the developer account.</p>
95<h3>Method Details</h3>
96<div class="method">
97 <code class="details" id="close">close()</code>
98 <pre>Close httplib2 connections.</pre>
99</div>
100
101<div class="method">
102 <code class="details" id="create">create(parent, body=None, x__xgafv=None)</code>
103 <pre>Grant access for a user to the given developer account.
104
105Args:
106 parent: string, Required. The developer account to add the user to. Format: developers/{developer} (required)
107 body: object, The request body.
108 The object takes the form of:
109
110{ # A user resource.
111 &quot;accessState&quot;: &quot;A String&quot;, # Output only. The state of the user&#x27;s access to the Play Console.
112 &quot;developerAccountPermissions&quot;: [ # Permissions for the user which apply across the developer account.
113 &quot;A String&quot;,
114 ],
115 &quot;email&quot;: &quot;A String&quot;, # Immutable. The user&#x27;s email address.
116 &quot;expirationTime&quot;: &quot;A String&quot;, # The time at which the user&#x27;s access expires, if set.
117 &quot;grants&quot;: [ # Output only. Per-app permissions for the user.
118 { # An access grant resource.
119 &quot;appLevelPermissions&quot;: [ # The permissions granted to the user for this app.
120 &quot;A String&quot;,
121 ],
122 &quot;name&quot;: &quot;A String&quot;, # Required. Resource name for this grant, following the pattern &quot;developers/{developer}/users/{email}/grants/{package_name}&quot;.
123 &quot;packageName&quot;: &quot;A String&quot;, # Immutable. The package name of the app.
124 },
125 ],
126 &quot;name&quot;: &quot;A String&quot;, # Required. Resource name for this user, following the pattern &quot;developers/{developer}/users/{email}&quot;.
127 &quot;partial&quot;: True or False, # Output only. Whether there are more permissions for the user that are not represented here.
128}
129
130 x__xgafv: string, V1 error format.
131 Allowed values
132 1 - v1 error format
133 2 - v2 error format
134
135Returns:
136 An object of the form:
137
138 { # A user resource.
139 &quot;accessState&quot;: &quot;A String&quot;, # Output only. The state of the user&#x27;s access to the Play Console.
140 &quot;developerAccountPermissions&quot;: [ # Permissions for the user which apply across the developer account.
141 &quot;A String&quot;,
142 ],
143 &quot;email&quot;: &quot;A String&quot;, # Immutable. The user&#x27;s email address.
144 &quot;expirationTime&quot;: &quot;A String&quot;, # The time at which the user&#x27;s access expires, if set.
145 &quot;grants&quot;: [ # Output only. Per-app permissions for the user.
146 { # An access grant resource.
147 &quot;appLevelPermissions&quot;: [ # The permissions granted to the user for this app.
148 &quot;A String&quot;,
149 ],
150 &quot;name&quot;: &quot;A String&quot;, # Required. Resource name for this grant, following the pattern &quot;developers/{developer}/users/{email}/grants/{package_name}&quot;.
151 &quot;packageName&quot;: &quot;A String&quot;, # Immutable. The package name of the app.
152 },
153 ],
154 &quot;name&quot;: &quot;A String&quot;, # Required. Resource name for this user, following the pattern &quot;developers/{developer}/users/{email}&quot;.
155 &quot;partial&quot;: True or False, # Output only. Whether there are more permissions for the user that are not represented here.
156}</pre>
157</div>
158
159<div class="method">
160 <code class="details" id="delete">delete(name, x__xgafv=None)</code>
161 <pre>Removes all access for the user to the given developer account.
162
163Args:
164 name: string, Required. The name of the user to delete. Format: developers/{developer}/users/{email} (required)
165 x__xgafv: string, V1 error format.
166 Allowed values
167 1 - v1 error format
168 2 - v2 error format
169</pre>
170</div>
171
172<div class="method">
173 <code class="details" id="list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</code>
174 <pre>Lists all users with access to a developer account.
175
176Args:
177 parent: string, Required. The developer account to fetch users from. Format: developers/{developer} (required)
178 pageSize: integer, The maximum number of results to return. This must be set to -1 to disable pagination.
179 pageToken: string, A token received from a previous call to this method, in order to retrieve further results.
180 x__xgafv: string, V1 error format.
181 Allowed values
182 1 - v1 error format
183 2 - v2 error format
184
185Returns:
186 An object of the form:
187
188 { # A response containing one or more users with access to an account.
189 &quot;nextPageToken&quot;: &quot;A String&quot;, # A token to pass to subsequent calls in order to retrieve subsequent results. This will not be set if there are no more results to return.
190 &quot;users&quot;: [ # The resulting users.
191 { # A user resource.
192 &quot;accessState&quot;: &quot;A String&quot;, # Output only. The state of the user&#x27;s access to the Play Console.
193 &quot;developerAccountPermissions&quot;: [ # Permissions for the user which apply across the developer account.
194 &quot;A String&quot;,
195 ],
196 &quot;email&quot;: &quot;A String&quot;, # Immutable. The user&#x27;s email address.
197 &quot;expirationTime&quot;: &quot;A String&quot;, # The time at which the user&#x27;s access expires, if set.
198 &quot;grants&quot;: [ # Output only. Per-app permissions for the user.
199 { # An access grant resource.
200 &quot;appLevelPermissions&quot;: [ # The permissions granted to the user for this app.
201 &quot;A String&quot;,
202 ],
203 &quot;name&quot;: &quot;A String&quot;, # Required. Resource name for this grant, following the pattern &quot;developers/{developer}/users/{email}/grants/{package_name}&quot;.
204 &quot;packageName&quot;: &quot;A String&quot;, # Immutable. The package name of the app.
205 },
206 ],
207 &quot;name&quot;: &quot;A String&quot;, # Required. Resource name for this user, following the pattern &quot;developers/{developer}/users/{email}&quot;.
208 &quot;partial&quot;: True or False, # Output only. Whether there are more permissions for the user that are not represented here.
209 },
210 ],
211}</pre>
212</div>
213
214<div class="method">
215 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
216 <pre>Retrieves the next page of results.
217
218Args:
219 previous_request: The request for the previous page. (required)
220 previous_response: The response from the request for the previous page. (required)
221
222Returns:
223 A request object that you can call &#x27;execute()&#x27; on to request the next
224 page. Returns None if there are no more items in the collection.
225 </pre>
226</div>
227
228<div class="method">
229 <code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code>
230 <pre>Updates access for the user to the developer account.
231
232Args:
233 name: string, Required. Resource name for this user, following the pattern &quot;developers/{developer}/users/{email}&quot;. (required)
234 body: object, The request body.
235 The object takes the form of:
236
237{ # A user resource.
238 &quot;accessState&quot;: &quot;A String&quot;, # Output only. The state of the user&#x27;s access to the Play Console.
239 &quot;developerAccountPermissions&quot;: [ # Permissions for the user which apply across the developer account.
240 &quot;A String&quot;,
241 ],
242 &quot;email&quot;: &quot;A String&quot;, # Immutable. The user&#x27;s email address.
243 &quot;expirationTime&quot;: &quot;A String&quot;, # The time at which the user&#x27;s access expires, if set.
244 &quot;grants&quot;: [ # Output only. Per-app permissions for the user.
245 { # An access grant resource.
246 &quot;appLevelPermissions&quot;: [ # The permissions granted to the user for this app.
247 &quot;A String&quot;,
248 ],
249 &quot;name&quot;: &quot;A String&quot;, # Required. Resource name for this grant, following the pattern &quot;developers/{developer}/users/{email}/grants/{package_name}&quot;.
250 &quot;packageName&quot;: &quot;A String&quot;, # Immutable. The package name of the app.
251 },
252 ],
253 &quot;name&quot;: &quot;A String&quot;, # Required. Resource name for this user, following the pattern &quot;developers/{developer}/users/{email}&quot;.
254 &quot;partial&quot;: True or False, # Output only. Whether there are more permissions for the user that are not represented here.
255}
256
257 updateMask: string, Optional. The list of fields to be updated.
258 x__xgafv: string, V1 error format.
259 Allowed values
260 1 - v1 error format
261 2 - v2 error format
262
263Returns:
264 An object of the form:
265
266 { # A user resource.
267 &quot;accessState&quot;: &quot;A String&quot;, # Output only. The state of the user&#x27;s access to the Play Console.
268 &quot;developerAccountPermissions&quot;: [ # Permissions for the user which apply across the developer account.
269 &quot;A String&quot;,
270 ],
271 &quot;email&quot;: &quot;A String&quot;, # Immutable. The user&#x27;s email address.
272 &quot;expirationTime&quot;: &quot;A String&quot;, # The time at which the user&#x27;s access expires, if set.
273 &quot;grants&quot;: [ # Output only. Per-app permissions for the user.
274 { # An access grant resource.
275 &quot;appLevelPermissions&quot;: [ # The permissions granted to the user for this app.
276 &quot;A String&quot;,
277 ],
278 &quot;name&quot;: &quot;A String&quot;, # Required. Resource name for this grant, following the pattern &quot;developers/{developer}/users/{email}/grants/{package_name}&quot;.
279 &quot;packageName&quot;: &quot;A String&quot;, # Immutable. The package name of the app.
280 },
281 ],
282 &quot;name&quot;: &quot;A String&quot;, # Required. Resource name for this user, following the pattern &quot;developers/{developer}/users/{email}&quot;.
283 &quot;partial&quot;: True or False, # Output only. Whether there are more permissions for the user that are not represented here.
284}</pre>
285</div>
286
287</body></html>