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

View Source

API calls for all endpoints tagged Attributes.

Summary

Functions

Returns the list of attributes that would be available for a location with the given primary category and country.

Functions

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

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

Returns the list of attributes that would be available for a location with the given primary category and country.

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").
    • :categoryName (type: String.t) - The primary category stable ID to find available attributes. Must be of the format categories/{category_id}.
    • :languageCode (type: String.t) - The BCP 47 code of language to get attribute display names in. If this language is not available, they will be provided in English.
    • :pageSize (type: integer()) - How many attributes to include per page. Default is 200, minimum is 1.
    • :pageToken (type: String.t) - If specified, the next page of attribute metadata is retrieved.
    • :parent (type: String.t) - Resource name of the location to look up available attributes. If this field is set, category_name, region_code, language_code and show_all are not required and must not be set.
    • :regionCode (type: String.t) - The ISO 3166-1 alpha-2 country code to find available attributes.
    • :showAll (type: boolean()) - Metadata for all available attributes are returned when this field is set to true, disregarding parent and category_name fields. language_code and region_code are required when show_all is set to true.
  • opts (type: keyword()) - Call options

Returns

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