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 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287
|
<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="androidpublisher_v3.html">Google Play Android Developer API</a> . <a href="androidpublisher_v3.users.html">users</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
<code><a href="#create">create(parent, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Grant access for a user to the given developer account.</p>
<p class="toc_element">
<code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
<p class="firstline">Removes all access for the user to the given developer 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 all users with access to a developer 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="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
<p class="firstline">Updates access for the user to the developer account.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="close">close()</code>
<pre>Close httplib2 connections.</pre>
</div>
<div class="method">
<code class="details" id="create">create(parent, body=None, x__xgafv=None)</code>
<pre>Grant access for a user to the given developer account.
Args:
parent: string, Required. The developer account to add the user to. Format: developers/{developer} (required)
body: object, The request body.
The object takes the form of:
{ # A user resource.
"accessState": "A String", # Output only. The state of the user's access to the Play Console.
"developerAccountPermissions": [ # Permissions for the user which apply across the developer account.
"A String",
],
"email": "A String", # Immutable. The user's email address.
"expirationTime": "A String", # The time at which the user's access expires, if set. When setting this value, it must always be in the future.
"grants": [ # Output only. Per-app permissions for the user.
{ # An access grant resource.
"appLevelPermissions": [ # The permissions granted to the user for this app.
"A String",
],
"name": "A String", # Required. Resource name for this grant, following the pattern "developers/{developer}/users/{email}/grants/{package_name}". If this grant is for a draft app, the app ID will be used in this resource name instead of the package name.
"packageName": "A String", # Immutable. The package name of the app. This will be empty for draft apps.
},
],
"name": "A String", # Required. Resource name for this user, following the pattern "developers/{developer}/users/{email}".
"partial": True or False, # Output only. Whether there are more permissions for the user that are not represented here. This can happen if the caller does not have permission to manage all apps in the account. This is also `true` if this user is the account owner. If this field is `true`, it should be taken as a signal that this user cannot be fully managed via the API. That is, the API caller is not be able to manage all of the permissions this user holds, either because it doesn't know about them or because the user is the account owner.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A user resource.
"accessState": "A String", # Output only. The state of the user's access to the Play Console.
"developerAccountPermissions": [ # Permissions for the user which apply across the developer account.
"A String",
],
"email": "A String", # Immutable. The user's email address.
"expirationTime": "A String", # The time at which the user's access expires, if set. When setting this value, it must always be in the future.
"grants": [ # Output only. Per-app permissions for the user.
{ # An access grant resource.
"appLevelPermissions": [ # The permissions granted to the user for this app.
"A String",
],
"name": "A String", # Required. Resource name for this grant, following the pattern "developers/{developer}/users/{email}/grants/{package_name}". If this grant is for a draft app, the app ID will be used in this resource name instead of the package name.
"packageName": "A String", # Immutable. The package name of the app. This will be empty for draft apps.
},
],
"name": "A String", # Required. Resource name for this user, following the pattern "developers/{developer}/users/{email}".
"partial": True or False, # Output only. Whether there are more permissions for the user that are not represented here. This can happen if the caller does not have permission to manage all apps in the account. This is also `true` if this user is the account owner. If this field is `true`, it should be taken as a signal that this user cannot be fully managed via the API. That is, the API caller is not be able to manage all of the permissions this user holds, either because it doesn't know about them or because the user is the account owner.
}</pre>
</div>
<div class="method">
<code class="details" id="delete">delete(name, x__xgafv=None)</code>
<pre>Removes all access for the user to the given developer account.
Args:
name: string, Required. The name of the user to delete. Format: developers/{developer}/users/{email} (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
</pre>
</div>
<div class="method">
<code class="details" id="list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</code>
<pre>Lists all users with access to a developer account.
Args:
parent: string, Required. The developer account to fetch users from. Format: developers/{developer} (required)
pageSize: integer, The maximum number of results to return. This must be set to -1 to disable pagination.
pageToken: string, A token received from a previous call to this method, in order to retrieve further results.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A response containing one or more users with access to an account.
"nextPageToken": "A String", # 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.
"users": [ # The resulting users.
{ # A user resource.
"accessState": "A String", # Output only. The state of the user's access to the Play Console.
"developerAccountPermissions": [ # Permissions for the user which apply across the developer account.
"A String",
],
"email": "A String", # Immutable. The user's email address.
"expirationTime": "A String", # The time at which the user's access expires, if set. When setting this value, it must always be in the future.
"grants": [ # Output only. Per-app permissions for the user.
{ # An access grant resource.
"appLevelPermissions": [ # The permissions granted to the user for this app.
"A String",
],
"name": "A String", # Required. Resource name for this grant, following the pattern "developers/{developer}/users/{email}/grants/{package_name}". If this grant is for a draft app, the app ID will be used in this resource name instead of the package name.
"packageName": "A String", # Immutable. The package name of the app. This will be empty for draft apps.
},
],
"name": "A String", # Required. Resource name for this user, following the pattern "developers/{developer}/users/{email}".
"partial": True or False, # Output only. Whether there are more permissions for the user that are not represented here. This can happen if the caller does not have permission to manage all apps in the account. This is also `true` if this user is the account owner. If this field is `true`, it should be taken as a signal that this user cannot be fully managed via the API. That is, the API caller is not be able to manage all of the permissions this user holds, either because it doesn't know about them or because the user is the account owner.
},
],
}</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="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code>
<pre>Updates access for the user to the developer account.
Args:
name: string, Required. Resource name for this user, following the pattern "developers/{developer}/users/{email}". (required)
body: object, The request body.
The object takes the form of:
{ # A user resource.
"accessState": "A String", # Output only. The state of the user's access to the Play Console.
"developerAccountPermissions": [ # Permissions for the user which apply across the developer account.
"A String",
],
"email": "A String", # Immutable. The user's email address.
"expirationTime": "A String", # The time at which the user's access expires, if set. When setting this value, it must always be in the future.
"grants": [ # Output only. Per-app permissions for the user.
{ # An access grant resource.
"appLevelPermissions": [ # The permissions granted to the user for this app.
"A String",
],
"name": "A String", # Required. Resource name for this grant, following the pattern "developers/{developer}/users/{email}/grants/{package_name}". If this grant is for a draft app, the app ID will be used in this resource name instead of the package name.
"packageName": "A String", # Immutable. The package name of the app. This will be empty for draft apps.
},
],
"name": "A String", # Required. Resource name for this user, following the pattern "developers/{developer}/users/{email}".
"partial": True or False, # Output only. Whether there are more permissions for the user that are not represented here. This can happen if the caller does not have permission to manage all apps in the account. This is also `true` if this user is the account owner. If this field is `true`, it should be taken as a signal that this user cannot be fully managed via the API. That is, the API caller is not be able to manage all of the permissions this user holds, either because it doesn't know about them or because the user is the account owner.
}
updateMask: string, Optional. The list of fields to be updated.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A user resource.
"accessState": "A String", # Output only. The state of the user's access to the Play Console.
"developerAccountPermissions": [ # Permissions for the user which apply across the developer account.
"A String",
],
"email": "A String", # Immutable. The user's email address.
"expirationTime": "A String", # The time at which the user's access expires, if set. When setting this value, it must always be in the future.
"grants": [ # Output only. Per-app permissions for the user.
{ # An access grant resource.
"appLevelPermissions": [ # The permissions granted to the user for this app.
"A String",
],
"name": "A String", # Required. Resource name for this grant, following the pattern "developers/{developer}/users/{email}/grants/{package_name}". If this grant is for a draft app, the app ID will be used in this resource name instead of the package name.
"packageName": "A String", # Immutable. The package name of the app. This will be empty for draft apps.
},
],
"name": "A String", # Required. Resource name for this user, following the pattern "developers/{developer}/users/{email}".
"partial": True or False, # Output only. Whether there are more permissions for the user that are not represented here. This can happen if the caller does not have permission to manage all apps in the account. This is also `true` if this user is the account owner. If this field is `true`, it should be taken as a signal that this user cannot be fully managed via the API. That is, the API caller is not be able to manage all of the permissions this user holds, either because it doesn't know about them or because the user is the account owner.
}</pre>
</div>
</body></html>
|