GoogleApi.MyBusinessBusinessInformation.V1.Api.Locations (google_api_my_business_business_information v0.5.2)

API calls for all endpoints tagged Locations.

Summary

Functions

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

Gets the Google-updated version of the specified location.

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

Deletes a location. If this location cannot be deleted using the API and it is marked so in the google.mybusiness.businessinformation.v1.LocationState, use the Google Business Profile website.

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

Returns the specified location.

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

Looks up all the attributes set for a given location.

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

Gets the Google-updated version of the specified location.

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

Updates the specified location.

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

Update attributes for a given location.

Functions

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

@spec mybusinessbusinessinformation_locations_attributes_get_google_updated(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.MyBusinessBusinessInformation.V1.Model.Attributes.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Gets the Google-updated version of the specified location.

Parameters

connection (type: GoogleApi.MyBusinessBusinessInformation.V1.Connection.t) - Connection to server
name (type: String.t) - Required. Google identifier for this location in the form of locations/{location_id}/attributes.
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.MyBusinessBusinessInformation.V1.Model.Attributes{}} on success
{:error, info} on failure

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

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

Deletes a location. If this location cannot be deleted using the API and it is marked so in the google.mybusiness.businessinformation.v1.LocationState, use the Google Business Profile website.

Parameters

connection (type: GoogleApi.MyBusinessBusinessInformation.V1.Connection.t) - Connection to server
name (type: String.t) - Required. The name of the location to delete.
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.MyBusinessBusinessInformation.V1.Model.Empty{}} on success
{:error, info} on failure

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

@spec mybusinessbusinessinformation_locations_get(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.MyBusinessBusinessInformation.V1.Model.Location.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Returns the specified location.

Parameters

connection (type: GoogleApi.MyBusinessBusinessInformation.V1.Connection.t) - Connection to server
name (type: String.t) - Required. The name of the location 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").
- :readMask (type: String.t) - Required. Read mask to specify what fields will be returned in the response.
opts (type: keyword()) - Call options

Returns

{:ok, %GoogleApi.MyBusinessBusinessInformation.V1.Model.Location{}} on success
{:error, info} on failure

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

@spec mybusinessbusinessinformation_locations_get_attributes(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.MyBusinessBusinessInformation.V1.Model.Attributes.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Looks up all the attributes set for a given location.

Parameters

connection (type: GoogleApi.MyBusinessBusinessInformation.V1.Connection.t) - Connection to server
name (type: String.t) - Required. Google identifier for this location in the form of locations/{location_id}/attributes.
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.MyBusinessBusinessInformation.V1.Model.Attributes{}} on success
{:error, info} on failure

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

@spec mybusinessbusinessinformation_locations_get_google_updated(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok,
   GoogleApi.MyBusinessBusinessInformation.V1.Model.GoogleUpdatedLocation.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Gets the Google-updated version of the specified location.

Parameters

connection (type: GoogleApi.MyBusinessBusinessInformation.V1.Connection.t) - Connection to server
name (type: String.t) - Required. The name of the location 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").
- :readMask (type: String.t) - Required. Read mask to specify what fields will be returned in the response.
opts (type: keyword()) - Call options

Returns

{:ok, %GoogleApi.MyBusinessBusinessInformation.V1.Model.GoogleUpdatedLocation{}} on success
{:error, info} on failure

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

@spec mybusinessbusinessinformation_locations_patch(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.MyBusinessBusinessInformation.V1.Model.Location.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Updates the specified location.

Parameters

connection (type: GoogleApi.MyBusinessBusinessInformation.V1.Connection.t) - Connection to server
name (type: String.t) - Google identifier for this location in the form: 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").
- :updateMask (type: String.t) - Required. The specific fields to update.
- :validateOnly (type: boolean()) - Optional. If true, the request is validated without actually updating the location. When this field is set, we will only return validation errors if there were any. The response will be empty if no errors were found.
- :body (type: GoogleApi.MyBusinessBusinessInformation.V1.Model.Location.t) -
opts (type: keyword()) - Call options

Returns

{:ok, %GoogleApi.MyBusinessBusinessInformation.V1.Model.Location{}} on success
{:error, info} on failure

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

@spec mybusinessbusinessinformation_locations_update_attributes(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.MyBusinessBusinessInformation.V1.Model.Attributes.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Update attributes for a given location.

Parameters

connection (type: GoogleApi.MyBusinessBusinessInformation.V1.Connection.t) - Connection to server
name (type: String.t) - Required. Google identifier for this location in the form of locations/{location_id}/attributes.
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").
- :attributeMask (type: String.t) - Required. Attribute name of attributes that you'd like to update. Represented by attributes/{attribute}. Updates: All attributes provided in the attributes field that you would like to update must be set in the attribute_mask. Attributes set in the above list but not in the attribute_mask will be ignored. Deletes: If you'd like to delete certain attributes, they must be specified in the attribute_mask with no matching entry in the attributes list. If you'd like to delete all attributes set on a location, you should look up all the applicable attributes for the location and then add them to the attribute_mask with an empty attributes field.
- :body (type: GoogleApi.MyBusinessBusinessInformation.V1.Model.Attributes.t) -
opts (type: keyword()) - Call options

Returns

{:ok, %GoogleApi.MyBusinessBusinessInformation.V1.Model.Attributes{}} on success
{:error, info} on failure