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

API calls for all endpoints tagged Chains.

Summary

Functions

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

Gets the specified chain. Returns NOT_FOUND if the chain does not exist.

mybusinessbusinessinformation_chains_search(connection, optional_params \\ [], opts \\ [])

Searches the chain based on chain name.

Functions

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

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

Gets the specified chain. Returns NOT_FOUND if the chain does not exist.

Parameters

connection (type: GoogleApi.MyBusinessBusinessInformation.V1.Connection.t) - Connection to server
name (type: String.t) - Required. The chain's resource name, in the format chains/{chain_place_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.MyBusinessBusinessInformation.V1.Model.Chain{}} on success
{:error, info} on failure

mybusinessbusinessinformation_chains_search(connection, optional_params \\ [], opts \\ [])

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

Searches the chain based on chain name.

Parameters

connection (type: GoogleApi.MyBusinessBusinessInformation.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").
- :chainName (type: String.t) - Required. Search for a chain by its name. Exact/partial/fuzzy/related queries are supported. Examples: "walmart", "wal-mart", "walmmmart", "沃尔玛"
- :pageSize (type: integer()) - The maximum number of matched chains to return from this query. The default is 10. The maximum possible value is 500.
opts (type: keyword()) - Call options

Returns

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