Method: attributes.list

Возвращает список атрибутов, доступных для адреса с указанной основной категорией и страной.

HTTP-запрос

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

URL имеет синтаксис gRPC Transcoding.

Параметры запроса

Параметры
parent

string

Необязательное поле. Название ресурса местоположения, для которого нужно найти доступные атрибуты. Если это поле заполнено, то поля categoryName, regionCode, languageCode и showAll не обязательны и не должны быть заполнены.

Формат: locations/{locationId} (например, locations/1234567890).
categoryName

string

Необязательное поле. Постоянный идентификатор основной категории, для которой нужно найти доступные атрибуты. Значение должно быть указано в формате categories/{category_id} (например, categories/gcid:restaurant). Обязательный параметр, если не задано значение parent и для showAll установлено значение false.
regionCode

string

Необязательное поле. Код страны в формате ISO 3166-1 alpha-2, для которой нужно найти доступные атрибуты. Обязательно, если не задано значение parent.
languageCode

string

Необязательное поле. Код языка по стандарту BCP 47, на котором нужно получить отображаемые названия атрибутов. Если он недоступен, то на английском.
showAll

boolean

Необязательное поле. Если задано значение true, возвращаются метаданные для всех доступных атрибутов, независимо от полей parent и categoryName. Если для параметра showAll задано значение true, необходимо указать languageCode и regionCode.
pageSize

integer

Количество атрибутов на странице. Значение по умолчанию – 200, минимальное значение – 1.
pageToken

string

Если указано, извлекается следующая страница метаданных атрибута.

Тело запроса

Тело запроса должно быть пустым.

Тело ответа

Ответ для AttributesService.ListAttributeMetadata.

Ниже приведена структура данных в ответе, полученном на запрос.

JSON-представление 
{
  "attributeMetadata": [
    {
      object (AttributeMetadata)
    }
  ],
  "nextPageToken": string
}
Поля
attributeMetadata[]

object (AttributeMetadata)

Набор метаданных для доступных атрибутов.
nextPageToken

string

Если количество атрибутов превышает размер запрашиваемой страницы, это поле будет заполнено токеном для получения следующей страницы атрибутов при последующем вызове attributes.list. Если атрибутов больше нет, это поле не будет представлено в ответе.

Области авторизации

Требуется следующая область действия OAuth:

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

Дополнительную информацию вы найдете в OAuth 2.0 Overview.

AttributeMetadata

Метаданные атрибута. Содержит информацию об атрибуте, включая локализованное название и заголовок для группировки связанных атрибутов.

JSON-представление 
{
  "parent": string,
  "valueType": enum (AttributeValueType),
  "displayName": string,
  "groupDisplayName": string,
  "repeatable": boolean,
  "valueMetadata": [
    {
      object (AttributeValueMetadata)
    }
  ],
  "deprecated": boolean
}
Поля
parent

string

Уникальный идентификатор атрибута.
valueType

enum (AttributeValueType)

Тип значения атрибута. Заданные и полученные значения должны быть этого типа.
displayName

string

Локализованное отображаемое название атрибута, если оно доступно. В противном случае – отображаемое название на английском языке.
groupDisplayName

string

Локализованное отображаемое название группы, содержащей этот атрибут, если оно доступно. В противном случае – название группы на английском языке. Связанные атрибуты собираются в группу и должны показываться вместе под указанным здесь заголовком.
repeatable

boolean

Если указано значение true, атрибут поддерживает несколько значений. Если false, то должно быть указано только одно значение.
valueMetadata[]

object (AttributeValueMetadata)

Для некоторых типов атрибутов (например, перечислений) предоставляется список допустимых значений и соответствующих отображаемых названий для этих значений.
deprecated

boolean

Если указано значение true, атрибут устарел и больше не должен использоваться. Если атрибут устарел, его обновление не приведет к ошибке, но изменения не будут сохранены. Через некоторое время после прекращения поддержки атрибут будет полностью удален, и его использование будет считаться ошибкой.

AttributeValueMetadata

Метаданные для поддерживаемых значений атрибутов.

JSON-представление 
{
  "value": value,
  "displayName": string
}
Поля
value

value (Value format)

Значение атрибута.
displayName

string

Отображаемое название для этого значения, локализованное, если доступно; в противном случае на английском языке. Отображаемое название значения должно использоваться в контексте с отображаемым названием атрибута.

Например, для атрибута перечисления "WiFi" это может быть значение "Paid" (платный Wi-Fi).