attributes

Changed on

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

get/v1/attributes

Request

  • Base URL: https://mybusinessbusinessinformation.googleapis.com
  • URL: https://mybusinessbusinessinformation.googleapis.com/v1/attributes
  • Auth: none declared

Query parameters

categoryNamestring

Optional. The primary category stable ID to find available attributes. Must be of the format categories/{category_id} (e.g., categories/gcid:restaurant). Required if parent is not set and show_all is false.

languageCodestring

Optional. The BCP 47 code of language to get attribute display names in. If this language is not available, they will be provided in English.

pageSizeinteger

How many attributes to include per page. Default is 200, minimum is 1.

pageTokenstring

If specified, the next page of attribute metadata is retrieved.

parentstring

Optional. 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. Format: locations/{location_id} (e.g., locations/1234567890).

regionCodestring

Optional. The ISO 3166-1 alpha-2 country code to find available attributes. Required if parent is not set.

showAllboolean

Optional. If set to true, metadata for all available attributes are returned, disregarding parent and category_name fields. language_code and region_code are required when show_all is set to true.

Response

Successful response

Changes