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

API calls for all endpoints tagged Accounts.

Summary

Functions

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

Creates a new Location that will be owned by the logged in user.

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

Lists the locations for the specified account.

Functions

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

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

Creates a new Location that will be owned by the logged in user.

Parameters

connection (type: GoogleApi.MyBusinessBusinessInformation.V1.Connection.t) - Connection to server
parent (type: String.t) - Required. The name of the account in which to create this 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").
- :requestId (type: String.t) - Optional. A unique request ID for the server to detect duplicated requests. We recommend using UUIDs. Max length is 50 characters.
- :validateOnly (type: boolean()) - Optional. If true, the request is validated without actually creating the location.
- :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_accounts_locations_list(connection, parent, optional_params \\ [], opts \\ [])

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

Lists the locations for the specified account.

Parameters

connection (type: GoogleApi.MyBusinessBusinessInformation.V1.Connection.t) - Connection to server
parent (type: String.t) - Required. The name of the account to fetch locations from. If the parent Account is of AccountType PERSONAL, only Locations that are directly owned by the Account are returned, otherwise it will return all accessible locations from the Account, either directly or indirectly.
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 locations to return. The response includes only entries that match the filter. If filter is empty, then constraints are applied and all locations (paginated) are retrieved for the requested account. For more information about valid fields and example usage, see Work with Location Data Guide.
- :orderBy (type: String.t) - Optional. Sorting order for the request. Multiple fields should be comma-separated, following SQL syntax. The default sorting order is ascending. To specify descending order, a suffix " desc" should be added. Valid fields to order_by are title and store_code. For example: "title, store_code desc" or "title" or "store_code desc"
- :pageSize (type: integer()) - Optional. How many locations to fetch per page. Default value is 10 if not set. Minimum is 1, and maximum page size is 100.
- :pageToken (type: String.t) - Optional. If specified, it fetches the next page of locations. The page token is returned by previous calls to ListLocations when there were more locations than could fit in the requested page size.
- :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.ListLocationsResponse{}} on success
{:error, info} on failure