Method: attributes.list

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

HTTP-запрос

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

URL-адрес использует синтаксис транскодирования gRPC .

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

Параметры
parent

string

Имя ресурса местоположения для поиска доступных атрибутов. Если это поле установлено, категорииName, RegionCode, LanguageCode и ShowAll не являются обязательными и не должны быть установлены.

categoryName

string

Стабильный идентификатор основной категории для поиска доступных атрибутов. Должно быть в формате категории/{category_id}.

regionCode

string

Код страны ISO 3166-1 альфа-2 для поиска доступных атрибутов.

languageCode

string

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

showAll

boolean

Метаданные для всех доступных атрибутов возвращаются, если для этого поля установлено значение true, игнорируя поля «родитель» и «имя категории». LanguageCode и RegionCode необходимы, если для параметра showAll установлено значение true.

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 .

АтрибутМетаданные

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

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

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

valueMetadata[]

object ( AttributeValueMetadata )

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

deprecated

boolean

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

АтрибутЗначениеМетаданные

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

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

value ( Value format)

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

displayName

string

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

Например, для атрибута перечисления «WiFi» оно может содержать «Paid», обозначающее платный Wi-Fi.