GoogleApi.AndroidPublisher.V3.Api.Users (google_api_android_publisher v0.43.0)
View SourceAPI calls for all endpoints tagged Users.
Summary
Functions
Grant access for a user to the given developer account.
Removes all access for the user to the given developer account.
Lists all users with access to a developer account.
Updates access for the user to the developer account.
Functions
@spec androidpublisher_users_create( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.AndroidPublisher.V3.Model.User.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Grant access for a user to the given developer account.
Parameters
-
connection(type:GoogleApi.AndroidPublisher.V3.Connection.t) - Connection to server -
parent(type:String.t) - Required. The developer account to add the user to. Format: developers/{developer} -
optional_params(type:keyword()) - Optional parameters-
:"$.xgafv"(type:String.t) - V1 error format. -
:access_token(type:String.t) - OAuth access token. -
:alt(type:String.t) - Data format for response. -
:callback(type:String.t) - JSONP -
:fields(type:String.t) - Selector specifying which fields to include in a partial response. -
:key(type:String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token(type:String.t) - OAuth 2.0 token for the current user. -
:prettyPrint(type:boolean()) - Returns response with indentations and line breaks. -
:quotaUser(type:String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType(type:String.t) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol(type:String.t) - Upload protocol for media (e.g. "raw", "multipart"). -
:body(type:GoogleApi.AndroidPublisher.V3.Model.User.t) -
-
-
opts(type:keyword()) - Call options
Returns
-
{:ok, %GoogleApi.AndroidPublisher.V3.Model.User{}}on success -
{:error, info}on failure
@spec androidpublisher_users_delete( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, nil} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Removes all access for the user to the given developer account.
Parameters
-
connection(type:GoogleApi.AndroidPublisher.V3.Connection.t) - Connection to server -
name(type:String.t) - Required. The name of the user to delete. Format: developers/{developer}/users/{email} -
optional_params(type:keyword()) - Optional parameters-
:"$.xgafv"(type:String.t) - V1 error format. -
:access_token(type:String.t) - OAuth access token. -
:alt(type:String.t) - Data format for response. -
:callback(type:String.t) - JSONP -
:fields(type:String.t) - Selector specifying which fields to include in a partial response. -
:key(type:String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token(type:String.t) - OAuth 2.0 token for the current user. -
:prettyPrint(type:boolean()) - Returns response with indentations and line breaks. -
:quotaUser(type:String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType(type:String.t) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol(type:String.t) - Upload protocol for media (e.g. "raw", "multipart").
-
-
opts(type:keyword()) - Call options
Returns
-
{:ok, %{}}on success -
{:error, info}on failure
@spec androidpublisher_users_list( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.AndroidPublisher.V3.Model.ListUsersResponse.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Lists all users with access to a developer account.
Parameters
-
connection(type:GoogleApi.AndroidPublisher.V3.Connection.t) - Connection to server -
parent(type:String.t) - Required. The developer account to fetch users from. Format: developers/{developer} -
optional_params(type:keyword()) - Optional parameters-
:"$.xgafv"(type:String.t) - V1 error format. -
:access_token(type:String.t) - OAuth access token. -
:alt(type:String.t) - Data format for response. -
:callback(type:String.t) - JSONP -
:fields(type:String.t) - Selector specifying which fields to include in a partial response. -
:key(type:String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token(type:String.t) - OAuth 2.0 token for the current user. -
:prettyPrint(type:boolean()) - Returns response with indentations and line breaks. -
:quotaUser(type:String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType(type:String.t) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol(type:String.t) - Upload protocol for media (e.g. "raw", "multipart"). -
:pageSize(type:integer()) - The maximum number of results to return. This must be set to -1 to disable pagination. -
:pageToken(type:String.t) - A token received from a previous call to this method, in order to retrieve further results.
-
-
opts(type:keyword()) - Call options
Returns
-
{:ok, %GoogleApi.AndroidPublisher.V3.Model.ListUsersResponse{}}on success -
{:error, info}on failure
@spec androidpublisher_users_patch( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.AndroidPublisher.V3.Model.User.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Updates access for the user to the developer account.
Parameters
-
connection(type:GoogleApi.AndroidPublisher.V3.Connection.t) - Connection to server -
name(type:String.t) - Required. Resource name for this user, following the pattern "developers/{developer}/users/{email}". -
optional_params(type:keyword()) - Optional parameters-
:"$.xgafv"(type:String.t) - V1 error format. -
:access_token(type:String.t) - OAuth access token. -
:alt(type:String.t) - Data format for response. -
:callback(type:String.t) - JSONP -
:fields(type:String.t) - Selector specifying which fields to include in a partial response. -
:key(type:String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token(type:String.t) - OAuth 2.0 token for the current user. -
:prettyPrint(type:boolean()) - Returns response with indentations and line breaks. -
:quotaUser(type:String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType(type:String.t) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol(type:String.t) - Upload protocol for media (e.g. "raw", "multipart"). -
:updateMask(type:String.t) - Optional. The list of fields to be updated. -
:body(type:GoogleApi.AndroidPublisher.V3.Model.User.t) -
-
-
opts(type:keyword()) - Call options
Returns
-
{:ok, %GoogleApi.AndroidPublisher.V3.Model.User{}}on success -
{:error, info}on failure