Method: attributes.list

Zwraca listę atrybutów, które byłyby dostępne dla lokalizacji z daną kategorią podstawową i krajem.

Żądanie HTTP

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

Adres URL używa składni transkodowania gRPC.

Parametry zapytania

Parametry
parent

string

Opcjonalnie: Nazwa zasobu lokalizacji, w której chcesz sprawdzić dostępne atrybuty. Jeśli to pole jest ustawione, pola categoryName, regionCode, languageCode i showAll nie są wymagane i nie mogą być ustawione.

Format: locations/{locationId} (np. locations/1234567890).
categoryName

string

Opcjonalnie: Identyfikator stabilny kategorii podstawowej, który umożliwia znalezienie dostępnych atrybutów. Musi mieć format categories/{category_id} (np. categories/gcid:restaurant). Wymagane, jeśli nie ustawiono parent, a showAll ma wartość false.
regionCode

string

Opcjonalnie: Kod kraju w formacie ISO 3166-1 alfa-2, aby znaleźć dostępne atrybuty. Wymagane, jeśli nie ustawiono parametru parent.
languageCode

string

Opcjonalnie: Kod BCP 47 języka, w którym mają być wyświetlane nazwy atrybutów. Jeśli ten język nie jest dostępny, informacje będą wyświetlane w języku angielskim.
showAll

boolean

Opcjonalnie: Jeśli ma wartość „true”, zwracane są metadane wszystkich dostępnych atrybutów, niezależnie od pól parent i categoryName. Właściwości languageCode i regionCode są wymagane, gdy właściwość showAll ma wartość „true”.
pageSize

integer

Liczba atrybutów na stronie. Wartość domyślna to 200, a minimalna to 1.
pageToken

string

Jeśli jest określony, pobierana jest następna strona metadanych atrybutu.

Treść żądania

Treść żądania musi być pusta.

Treść odpowiedzi

Odpowiedź na AttributesService.ListAttributeMetadata.

W przypadku powodzenia treść żądania zawiera dane o następującej strukturze:

Zapis JSON 
{
  "attributeMetadata": [
    {
      object (AttributeMetadata)
    }
  ],
  "nextPageToken": string
}
Pola
attributeMetadata[]

object (AttributeMetadata)

Zbiór metadanych dostępnych atrybutów.
nextPageToken

string

Jeśli liczba atrybutów przekroczy żądany rozmiar strony, to pole zostanie wypełnione tokenem, który umożliwi pobranie następnej strony atrybutów przy kolejnym wywołaniu metody attributes.list. Jeśli nie ma więcej atrybutów, to pole nie będzie widoczne w odpowiedzi.

Zakresy autoryzacji

Wymaga następującego zakresu OAuth:

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

Więcej informacji znajdziesz w OAuth 2.0 Overview.

AttributeMetadata

Metadane atrybutu. Zawiera informacje o wyświetlaniu atrybutu, w tym zlokalizowaną nazwę i nagłówek do grupowania powiązanych atrybutów.

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

string

Unikalny identyfikator atrybutu.
valueType

enum (AttributeValueType)

Typ wartości atrybutu. Ustawione i pobrane wartości powinny być tego typu.
displayName

string

Zlokalizowana wyświetlana nazwa atrybutu, jeśli jest dostępna. W przeciwnym razie wyświetlana jest nazwa w języku angielskim.
groupDisplayName

string

Zlokalizowana wyświetlana nazwa grupy zawierającej ten atrybut, jeśli jest dostępna. W przeciwnym razie nazwa grupy w języku angielskim. Powiązane atrybuty są zbierane w grupę i powinny być wyświetlane razem pod podanym tutaj nagłówkiem.
repeatable

boolean

Jeśli ma wartość „true”, atrybut obsługuje wiele wartości. Jeśli ustawiona jest wartość Fałsz, należy podać tylko jedną wartość.
valueMetadata[]

object (AttributeValueMetadata)

W przypadku niektórych typów atrybutów (np. typów wyliczeniowych) podana jest lista obsługiwanych wartości i odpowiadających im wyświetlanych nazw.
deprecated

boolean

Jeśli ma wartość „true”, atrybut jest wycofany i nie należy go już używać. Jeśli atrybut został wycofany, jego aktualizacja nie spowoduje błędu, ale zmiany nie zostaną zapisane. Po pewnym czasie od wycofania atrybut zostanie całkowicie usunięty i będzie powodować błąd.

AttributeValueMetadata

Metadane obsługiwanych wartości atrybutów.

Zapis JSON 
{
  "value": value,
  "displayName": string
}
Pola
value

value (Value format)

Wartość atrybutu.
displayName

string

Wyświetlana nazwa tej wartości, przetłumaczona, jeśli jest dostępna, lub w języku angielskim. Wyświetlana nazwa wartości jest przeznaczona do użycia w kontekście wyświetlanej nazwy atrybutu.

Na przykład w przypadku atrybutu typu wyliczeniowego „Wi-Fi” może to być „Płatne”, co oznacza płatne Wi-Fi.