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

View Source

API calls for all endpoints tagged Categories.

Summary

Functions

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

Returns a list of business categories for the provided language and GConcept ids.

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

Returns a list of business categories. Search will match the category name but not the category ID. Search only matches the front of a category name (that is, 'food' may return 'Food Court' but not 'Fast Food Restaurant').

Functions

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

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

Returns a list of business categories for the provided language and GConcept ids.

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").
    • :languageCode (type: String.t) - Required. The BCP 47 code of language that the category names should be returned in.
    • :names (type: list(String.t)) - Required. At least one name must be set. The GConcept ids the localized category names should be returned for. To return details for more than one category, repeat this parameter in the request.
    • :regionCode (type: String.t) - Optional. The ISO 3166-1 alpha-2 country code used to infer non-standard language.
    • :view (type: String.t) - Required. Specifies which parts to the Category resource should be returned in the response.
  • opts (type: keyword()) - Call options

Returns

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

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

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

Returns a list of business categories. Search will match the category name but not the category ID. Search only matches the front of a category name (that is, 'food' may return 'Food Court' but not 'Fast Food Restaurant').

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").
    • :filter (type: String.t) - Optional. Filter string from user. The only field that supported is displayName. Eg: filter=displayName=foo.
    • :languageCode (type: String.t) - Required. The BCP 47 code of language.
    • :pageSize (type: integer()) - Optional. How many categories to fetch per page. Default is 100, minimum is 1, and maximum page size is 100.
    • :pageToken (type: String.t) - Optional. If specified, the next page of categories will be fetched.
    • :regionCode (type: String.t) - Required. The ISO 3166-1 alpha-2 country code.
    • :view (type: String.t) - Required. Specifies which parts to the Category resource should be returned in the response.
  • opts (type: keyword()) - Call options

Returns

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