GoogleApi.MyBusinessAccountManagement.V1.Api.Locations (google_api_my_business_account_management v0.4.1)

View Source

API calls for all endpoints tagged Locations.

Summary

Functions

mybusinessaccountmanagement_locations_admins_create(connection, parent, optional_params \\ [], opts \\ [])

Invites the specified user to become an administrator for the specified location. The invitee must accept the invitation in order to be granted access to the location. See AcceptInvitation to programmatically accept an invitation.

mybusinessaccountmanagement_locations_admins_delete(connection, name, optional_params \\ [], opts \\ [])

Removes the specified admin as a manager of the specified location.

mybusinessaccountmanagement_locations_admins_list(connection, parent, optional_params \\ [], opts \\ [])

Lists all of the admins for the specified location.

mybusinessaccountmanagement_locations_admins_patch(connection, name, optional_params \\ [], opts \\ [])

Updates the Admin for the specified location. Only the AdminRole of the Admin can be updated.

mybusinessaccountmanagement_locations_transfer(connection, name, optional_params \\ [], opts \\ [])

Moves a location from an account that the user owns to another account that the same user administers. The user must be an owner of the account the location is currently associated with and must also be at least a manager of the destination account.

Functions

mybusinessaccountmanagement_locations_admins_create(connection, parent, optional_params \\ [], opts \\ [])

@spec mybusinessaccountmanagement_locations_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 location. The invitee must accept the invitation in order to be granted access to the location. 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 location this admin is created for. locations/{location_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").
    • :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

mybusinessaccountmanagement_locations_admins_delete(connection, name, optional_params \\ [], opts \\ [])

@spec mybusinessaccountmanagement_locations_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 as a manager of the specified location.

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 location.
  • 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

mybusinessaccountmanagement_locations_admins_list(connection, parent, optional_params \\ [], opts \\ [])

@spec mybusinessaccountmanagement_locations_admins_list(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok,
   GoogleApi.MyBusinessAccountManagement.V1.Model.ListLocationAdminsResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Lists all of the admins for the specified location.

Parameters

  • connection (type: GoogleApi.MyBusinessAccountManagement.V1.Connection.t) - Connection to server
  • parent (type: String.t) - Required. The name of the location to list admins of. locations/{location_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.ListLocationAdminsResponse{}} on success
  • {:error, info} on failure

mybusinessaccountmanagement_locations_admins_patch(connection, name, optional_params \\ [], opts \\ [])

@spec mybusinessaccountmanagement_locations_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 location. Only the AdminRole of the Admin can be updated.

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

mybusinessaccountmanagement_locations_transfer(connection, name, optional_params \\ [], opts \\ [])

@spec mybusinessaccountmanagement_locations_transfer(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.MyBusinessAccountManagement.V1.Model.Empty.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Moves a location from an account that the user owns to another account that the same user administers. The user must be an owner of the account the location is currently associated with and must also be at least a manager of the destination account.

Parameters

  • connection (type: GoogleApi.MyBusinessAccountManagement.V1.Connection.t) - Connection to server
  • name (type: String.t) - Required. The name of the location to transfer. locations/{location_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.TransferLocationRequest.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.MyBusinessAccountManagement.V1.Model.Empty{}} on success
  • {:error, info} on failure