Method: attributes.list

Zwraca listę atrybutów, które byłyby dostępne dla lokalizacji w podanej kategorii podstawowej i kraju.

Żądanie HTTP

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

Adres URL używa składni transkodowania gRPC.

Parametry zapytania

Parametry
parent

string

Nazwa zasobu lokalizacji, w której można wyszukać dostępne atrybuty. Jeśli to pole jest skonfigurowane, wartości parametrówcategoryName, regionCode, languageCode oraz showAll nie są wymagane i nie można ich ustawiać.
categoryName

string

Stabilny identyfikator kategorii podstawowej służący do znajdowania dostępnych atrybutów. Musi mieć format kategorie/{identyfikator_kategorii}.
regionCode

string

Kod kraju zgodny ze standardem ISO 3166-1 alfa-2 pozwala znaleźć dostępne atrybuty.
languageCode

string

Kod języka BCP 47, w którym są pobierane nazwy wyświetlane atrybutów. Jeśli ten język nie jest dostępny, zostaną podane w języku angielskim.
showAll

boolean

Gdy to pole ma wartość true, zwracane są metadane wszystkich dostępnych atrybutów, z pominięciem pól „parent” i „categoryName”. Jeśli zasada showAll ma wartość „true” (prawda) i pole showAll jest wymagane, wymagane są metadane dotyczące wszystkich dostępnych atrybutów.
pageSize

integer

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

string

Jeśli określono wartość, pobierana jest następna strona metadanych atrybutów.

Treść żądania

Treść żądania musi być pusta.

Treść odpowiedzi

Odpowiedź na atrybut 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 atrybutów dla dostępnych atrybutów.
nextPageToken

string

Jeśli liczba atrybutów przekracza żądany rozmiar strony, w tym polu pojawi się token służący do pobierania następnej strony atrybutów przy kolejnym wywołaniu funkcji attributes.list. Jeśli nie ma więcej atrybutów, to pole nie będzie obecne w odpowiedzi.

Zakresy autoryzacji

Wymaga następującego zakresu OAuth:

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

Więcej informacji znajdziesz w artykule Omówienie protokołu OAuth 2.0.

AttributeMetadata

Metadane atrybutu. Zawiera informacje wyświetlane dla atrybutu, w tym zlokalizowaną nazwę i nagłówek służący 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 nazwa wyświetlana atrybutu, jeśli jest dostępna. W przeciwnym razie – angielska nazwa wyświetlana.
groupDisplayName

string

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

boolean

Jeśli ma wartość true (prawda), atrybut obsługuje wiele wartości. Jeśli ma wartość false (fałsz), należy podać tylko jedną wartość.
valueMetadata[]

object (AttributeValueMetadata)

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

boolean

Jeśli ma wartość true (prawda), atrybut został wycofany i nie powinien być już używany. Jeśli ten atrybut został wycofany, zaktualizowanie tego atrybutu nie spowoduje błędu, ale zmiany nie zostaną zapisane. W pewnym momencie po wycofaniu atrybut zostanie całkowicie usunięty i stanie się błędem.

AttributeValueMetadata

Metadane dotyczące 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 zlokalizowana tam, gdzie jest dostępna. W przeciwnym razie jest w języku angielskim. Wyświetlanej nazwy wartości należy używać w kontekście wyświetlanej nazwy atrybutu.

Na przykład atrybut wyliczeniowy „Wi-Fi” może zawierać wartość „Płatna”, która oznacza płatne Wi-Fi.