Method: attributes.list

Zwraca listę atrybutów, które byłyby dostępne dla lokalizacji o podanej kategorii podstawowej i danym 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 wyszukiwać dostępne atrybuty. Jeśli to pole jest ustawione, pola CategoryName, regionCode, languageCode i showAll nie są wymagane i nie mogą być ustawione.
categoryName

string

Stabilny identyfikator kategorii podstawowej do wyszukiwania dostępnych atrybutów. Wymagany format: kategorie/{identyfikator_kategorii}.
regionCode

string

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

string

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

boolean

Gdy to pole ma wartość true (prawda), zwracane są metadane wszystkich dostępnych atrybutów. Pomijane są pola nadrzędny i categoryName. Jeśli parametr showAll ma wartość true (prawda), wymagane są kody languageCode i regionCode.
pageSize

integer

Liczba atrybutów do uwzględnienia na stronie. Wartość domyślna to 200, a minimum 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ź dotycząca atrybutu 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ła żądany rozmiar strony, pole to zostanie wypełnione tokenem umożliwiającym pobranie 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 wyświetlane informacje o atrybucie, w tym zlokalizowaną nazwę i nagłówek 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 pobierane wartości powinny być tego typu.
displayName

string

zlokalizowana wyświetlana nazwa atrybutu, jeśli jest dostępna; w przeciwnym razie wyświetla się nazwa w języku angielskim.
groupDisplayName

string

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

boolean

Jeśli ma wartość 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. wyliczenia) dostępna jest lista obsługiwanych wartości i odpowiadających im wyświetlanych nazw.
deprecated

boolean

Jeśli ma wartość true (prawda), atrybut został wycofany i nie należy go już używać. Jeśli atrybut zostanie wycofany, aktualizacja nie spowoduje błędu, ale aktualizacje nie zostaną zapisane. Po wycofaniu atrybut zostanie w pewnym momencie całkowicie usunięty i stanie się błędem.

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, zlokalizowana, jeśli jest dostępna; w przeciwnym razie – w języku angielskim. Wyświetlana nazwa wartości powinna być używana w kontekście z wyświetlaną nazwą atrybutu.

Na przykład w kolumnie „Wi-Fi” wyliczeniowy, może on zawierać wartość „Płatne” reprezentują płatną sieć Wi-Fi.