The Verifications API and Business Information API is now launched! Migration work is required. Please see our deprecation schedule for more information related to deprecated endpoints. You may also sign up for our mailing list to receive updates.

Method: attributes.list

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

HTTP request

GET https://mybusinessbusinessinformation.googleapis.com/v1/attributes

The URL uses gRPC Transcoding syntax.

Query parameters

Parameters
parent

string

Resource name of the location to look up available attributes. If this field is set, categoryName, regionCode, languageCode and showAll are not required and must not be set.

categoryName

string

The primary category stable ID to find available attributes. Must be of the format categories/{category_id}.

regionCode

string

The ISO 3166-1 alpha-2 country code to find available attributes.

languageCode

string

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

showAll

boolean

Metadata for all available attributes are returned when this field is set to true, disregarding parent and categoryName fields. languageCode and regionCode are required when showAll is set to true.

pageSize

integer

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

pageToken

string

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

Request body

The request body must be empty.

Response body

If successful, the response body contains data with the following structure:

Response for AttributesService.ListAttributeMetadata.

JSON representation
{
  "attributeMetadata": [
    {
      object (AttributeMetadata)
    }
  ],
  "nextPageToken": string
}
Fields
attributeMetadata[]

object (AttributeMetadata)

A collection of attribute metadata for the available attributes.

nextPageToken

string

If the number of attributes exceeded the requested page size, this field will be populated with a token to fetch the next page of attributes on a subsequent call to attributes.list. If there are no more attributes, this field will not be present in the response.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/business.manage

For more information, see the OAuth 2.0 Overview.

AttributeMetadata

Metadata for an attribute. Contains display information for the attribute, including a localized name and a heading for grouping related attributes together.

JSON representation
{
  "parent": string,
  "valueType": enum (AttributeValueType),
  "displayName": string,
  "groupDisplayName": string,
  "repeatable": boolean,
  "valueMetadata": [
    {
      object (AttributeValueMetadata)
    }
  ],
  "deprecated": boolean
}
Fields
parent

string

The unique identifier for the attribute.

valueType

enum (AttributeValueType)

The value type for the attribute. Values set and retrieved should be expected to be of this type.

displayName

string

The localized display name for the attribute, if available; otherwise, the English display name.

groupDisplayName

string

The localized display name of the group that contains this attribute, if available; otherwise, the English group name. Related attributes are collected into a group and should be displayed together under the heading given here.

repeatable

boolean

If true, the attribute supports multiple values. If false, only a single value should be provided.

valueMetadata[]

object (AttributeValueMetadata)

For some types of attributes (for example, enums), a list of supported values and corresponding display names for those values is provided.

deprecated

boolean

If true, the attribute is deprecated and should no longer be used. If deprecated, updating this attribute will not result in an error, but updates will not be saved. At some point after being deprecated, the attribute will be removed entirely and it will become an error.

AttributeValueMetadata

Metadata for supported attribute values.

JSON representation
{
  "value": value,
  "displayName": string
}
Fields
value

value (Value format)

The attribute value.

displayName

string

The display name for this value, localized where available; otherwise, in English. The value display name is intended to be used in context with the attribute display name.

For example, for a "WiFi" enum attribute, this could contain "Paid" to represent paid Wi-Fi.