GoogleApi.MyBusinessAccountManagement.V1.Api.Accounts (google_api_my_business_account_management v0.4.1)
View SourceAPI calls for all endpoints tagged Accounts
.
Summary
Functions
Invites the specified user to become an administrator for the specified account. The invitee must accept the invitation in order to be granted access to the account. See AcceptInvitation to programmatically accept an invitation.
Removes the specified admin from the specified account.
Lists the admins for the specified account.
Updates the Admin for the specified Account Admin.
Creates an account with the specified name and type under the given parent. - Personal accounts and Organizations cannot be created. - User Groups cannot be created with a Personal account as primary owner. - Location Groups cannot be created with a primary owner of a Personal account if the Personal account is in an Organization. - Location Groups cannot own Location Groups.
Gets the specified account. Returns NOT_FOUND
if the account does not exist or if the caller does not have access rights to it.
Accepts the specified invitation.
Declines the specified invitation.
Lists pending invitations for the specified account.
Lists all of the accounts for the authenticated user. This includes all accounts that the user owns, as well as any accounts for which the user has management rights.
Updates the specified business account. Personal accounts cannot be updated using this method.
Functions
@spec mybusinessaccountmanagement_accounts_admins_create( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.MyBusinessAccountManagement.V1.Model.Admin.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Invites the specified user to become an administrator for the specified account. The invitee must accept the invitation in order to be granted access to the account. See AcceptInvitation to programmatically accept an invitation.
Parameters
-
connection
(type:GoogleApi.MyBusinessAccountManagement.V1.Connection.t
) - Connection to server -
parent
(type:String.t
) - Required. The resource name of the account this admin is created for.accounts/{account_id}
. -
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.MyBusinessAccountManagement.V1.Model.Admin.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.MyBusinessAccountManagement.V1.Model.Admin{}}
on success -
{:error, info}
on failure
@spec mybusinessaccountmanagement_accounts_admins_delete( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.MyBusinessAccountManagement.V1.Model.Empty.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Removes the specified admin from the specified account.
Parameters
-
connection
(type:GoogleApi.MyBusinessAccountManagement.V1.Connection.t
) - Connection to server -
name
(type:String.t
) - Required. The resource name of the admin to remove from the account.accounts/{account_id}/admins/{admin_id}
. -
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, %GoogleApi.MyBusinessAccountManagement.V1.Model.Empty{}}
on success -
{:error, info}
on failure
@spec mybusinessaccountmanagement_accounts_admins_list( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.MyBusinessAccountManagement.V1.Model.ListAccountAdminsResponse.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Lists the admins for the specified account.
Parameters
-
connection
(type:GoogleApi.MyBusinessAccountManagement.V1.Connection.t
) - Connection to server -
parent
(type:String.t
) - Required. The name of the account from which to retrieve a list of admins.accounts/{account_id}/admins
. -
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, %GoogleApi.MyBusinessAccountManagement.V1.Model.ListAccountAdminsResponse{}}
on success -
{:error, info}
on failure
@spec mybusinessaccountmanagement_accounts_admins_patch( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.MyBusinessAccountManagement.V1.Model.Admin.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Updates the Admin for the specified Account Admin.
Parameters
-
connection
(type:GoogleApi.MyBusinessAccountManagement.V1.Connection.t
) - Connection to server -
name
(type:String.t
) - Immutable. The resource name. For account admins, this is in the form:accounts/{account_id}/admins/{admin_id}
For location admins, this is in the form:locations/{location_id}/admins/{admin_id}
This field will be ignored if set during admin creation. -
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
) - Required. The specific fields that should be updated. The only editable field is role. -
:body
(type:GoogleApi.MyBusinessAccountManagement.V1.Model.Admin.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.MyBusinessAccountManagement.V1.Model.Admin{}}
on success -
{:error, info}
on failure
@spec mybusinessaccountmanagement_accounts_create( Tesla.Env.client(), keyword(), keyword() ) :: {:ok, GoogleApi.MyBusinessAccountManagement.V1.Model.Account.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Creates an account with the specified name and type under the given parent. - Personal accounts and Organizations cannot be created. - User Groups cannot be created with a Personal account as primary owner. - Location Groups cannot be created with a primary owner of a Personal account if the Personal account is in an Organization. - Location Groups cannot own Location Groups.
Parameters
-
connection
(type:GoogleApi.MyBusinessAccountManagement.V1.Connection.t
) - Connection to server -
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.MyBusinessAccountManagement.V1.Model.Account.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.MyBusinessAccountManagement.V1.Model.Account{}}
on success -
{:error, info}
on failure
@spec mybusinessaccountmanagement_accounts_get( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.MyBusinessAccountManagement.V1.Model.Account.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Gets the specified account. Returns NOT_FOUND
if the account does not exist or if the caller does not have access rights to it.
Parameters
-
connection
(type:GoogleApi.MyBusinessAccountManagement.V1.Connection.t
) - Connection to server -
name
(type:String.t
) - Required. The name of the account to fetch. -
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, %GoogleApi.MyBusinessAccountManagement.V1.Model.Account{}}
on success -
{:error, info}
on failure
@spec mybusinessaccountmanagement_accounts_invitations_accept( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.MyBusinessAccountManagement.V1.Model.Empty.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Accepts the specified invitation.
Parameters
-
connection
(type:GoogleApi.MyBusinessAccountManagement.V1.Connection.t
) - Connection to server -
name
(type:String.t
) - Required. The name of the invitation that is being accepted.accounts/{account_id}/invitations/{invitation_id}
-
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.MyBusinessAccountManagement.V1.Model.AcceptInvitationRequest.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.MyBusinessAccountManagement.V1.Model.Empty{}}
on success -
{:error, info}
on failure
@spec mybusinessaccountmanagement_accounts_invitations_decline( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.MyBusinessAccountManagement.V1.Model.Empty.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Declines the specified invitation.
Parameters
-
connection
(type:GoogleApi.MyBusinessAccountManagement.V1.Connection.t
) - Connection to server -
name
(type:String.t
) - Required. The name of the account invitation that is being declined.accounts/{account_id}/invitations/{invitation_id}
-
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.MyBusinessAccountManagement.V1.Model.DeclineInvitationRequest.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.MyBusinessAccountManagement.V1.Model.Empty{}}
on success -
{:error, info}
on failure
@spec mybusinessaccountmanagement_accounts_invitations_list( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.MyBusinessAccountManagement.V1.Model.ListInvitationsResponse.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Lists pending invitations for the specified account.
Parameters
-
connection
(type:GoogleApi.MyBusinessAccountManagement.V1.Connection.t
) - Connection to server -
parent
(type:String.t
) - Required. The name of the account from which the list of invitations is being retrieved.accounts/{account_id}/invitations
-
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"). -
:filter
(type:String.t
) - Optional. Filtering the response is supported via the Invitation.target_type field.
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.MyBusinessAccountManagement.V1.Model.ListInvitationsResponse{}}
on success -
{:error, info}
on failure
@spec mybusinessaccountmanagement_accounts_list( Tesla.Env.client(), keyword(), keyword() ) :: {:ok, GoogleApi.MyBusinessAccountManagement.V1.Model.ListAccountsResponse.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Lists all of the accounts for the authenticated user. This includes all accounts that the user owns, as well as any accounts for which the user has management rights.
Parameters
-
connection
(type:GoogleApi.MyBusinessAccountManagement.V1.Connection.t
) - Connection to server -
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"). -
:filter
(type:String.t
) - Optional. A filter constraining the accounts to return. The response includes only entries that match the filter. Iffilter
is empty, then no constraints are applied and all accounts (paginated) are retrieved for the requested account. For example, a request with the filtertype=USER_GROUP
will only return user groups. Thetype
field is the only supported filter. -
:pageSize
(type:integer()
) - Optional. How many accounts to fetch per page. The default and maximum is 20. -
:pageToken
(type:String.t
) - Optional. If specified, the next page of accounts is retrieved. ThepageToken
is returned when a call toaccounts.list
returns more results than can fit into the requested page size. -
:parentAccount
(type:String.t
) - Optional. The resource name of the account for which the list of directly accessible accounts is to be retrieved. This only makes sense for Organizations and User Groups. If empty, will returnListAccounts
for the authenticated user.accounts/{account_id}
.
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.MyBusinessAccountManagement.V1.Model.ListAccountsResponse{}}
on success -
{:error, info}
on failure
@spec mybusinessaccountmanagement_accounts_patch( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.MyBusinessAccountManagement.V1.Model.Account.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Updates the specified business account. Personal accounts cannot be updated using this method.
Parameters
-
connection
(type:GoogleApi.MyBusinessAccountManagement.V1.Connection.t
) - Connection to server -
name
(type:String.t
) - Immutable. The resource name, in the formataccounts/{account_id}
. -
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
) - Required. The specific fields that should be updated. The only editable field isaccountName
. -
:validateOnly
(type:boolean()
) - Optional. If true, the request is validated without actually updating the account. -
:body
(type:GoogleApi.MyBusinessAccountManagement.V1.Model.Account.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.MyBusinessAccountManagement.V1.Model.Account{}}
on success -
{:error, info}
on failure