Method: attributes.list

Gibt die Liste der Attribute zurück, die für einen Standort mit der angegebenen primären Kategorie und dem angegebenen Land verfügbar wären.

HTTP-Anfrage

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

Die URL verwendet die Syntax der gRPC-Transcodierung.

Abfrageparameter

Parameter
parent

string

Ressourcenname des Standorts für die Suche nach verfügbaren Attributen. Wenn für dieses Feld ein Wert festgelegt ist, sind „categoryName“, „regionCode“, „languageCode“ und „showAll“ keine Pflichtfelder und dürfen nicht festgelegt werden.
categoryName

string

Die stabile ID der primären Kategorie zum Ermitteln verfügbarer Attribute. Muss das Format „categories/{category_id}“ haben.
regionCode

string

Der ISO 3166-1 Alpha-2-Ländercode für die Suche nach verfügbaren Attributen.
languageCode

string

Der BCP 47-Code der Sprache, in der die Anzeigenamen der Attribute abgerufen werden sollen. Wenn diese Sprache nicht verfügbar ist, wird sie auf Englisch angegeben.
showAll

boolean

Metadaten für alle verfügbaren Attribute werden zurückgegeben, wenn dieses Feld auf „true“ gesetzt ist, wobei die Felder „parent“ und „categoryName“ ignoriert werden. "languageCode" und "regionCode" sind erforderlich, wenn "showAll" auf "true" gesetzt ist.
pageSize

integer

Die Anzahl der Attribute, die pro Seite hinzugefügt werden sollen. Der Standardwert ist 200, der Mindestwert ist 1.
pageToken

string

Wenn angegeben, wird die nächste Seite mit Attributmetadaten abgerufen.

Anfragetext

Der Anfragetext muss leer sein.

Antworttext

Antwort für AttributesService.ListAttributeMetadata.

Bei Erfolg enthält der Antworttext Daten mit der folgenden Struktur:

JSON-Darstellung 
{
  "attributeMetadata": [
    {
      object (AttributeMetadata)
    }
  ],
  "nextPageToken": string
}
Felder
attributeMetadata[]

object (AttributeMetadata)

Eine Sammlung von Attributmetadaten für die verfügbaren Attribute.
nextPageToken

string

Wenn die Anzahl der Attribute die angeforderte Seitengröße überschreitet, wird dieses Feld mit einem Token gefüllt, um bei einem nachfolgenden Aufruf von attributes.list die nächste Seite mit Attributen abzurufen. Wenn keine weiteren Attribute vorhanden sind, ist dieses Feld nicht in der Antwort vorhanden.

Autorisierungsbereiche

Erfordert den folgenden OAuth-Bereich:

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

Weitere Informationen finden Sie in der Übersicht über OAuth 2.0.

AttributeMetadata

Metadaten für ein Attribut. Enthält Anzeigeinformationen für das Attribut, einschließlich eines lokalisierten Namens und einer Überschrift zum Gruppieren verwandter Attribute.

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

string

Die eindeutige Kennung für das Attribut.
valueType

enum (AttributeValueType)

Der Werttyp für das Attribut. Es wird davon ausgegangen, dass die festgelegten und abgerufenen Werte diesen Typ haben.
displayName

string

Der lokalisierte Anzeigename für das Attribut, falls verfügbar andernfalls den englischen Anzeigenamen.
groupDisplayName

string

Der lokalisierte Anzeigename der Gruppe, die dieses Attribut enthält (falls verfügbar) andernfalls den englischen Gruppennamen. Zugehörige Attribute werden in einer Gruppe zusammengefasst und sollten zusammen unter der hier angegebenen Überschrift angezeigt werden.
repeatable

boolean

Falls wahr, unterstützt das Attribut mehrere Werte. Bei „false“ sollte nur ein Wert angegeben werden.
valueMetadata[]

object (AttributeValueMetadata)

Für einige Attributtypen (z. B. enums) wird eine Liste der unterstützten Werte und der entsprechenden Anzeigenamen für diese Werte bereitgestellt.
deprecated

boolean

Bei Einstellung auf „true“ wird das Attribut eingestellt und sollte nicht mehr verwendet werden. Wenn dieses Attribut eingestellt wird, führt das Aktualisieren dieses Attributs nicht zu einem Fehler, aber Aktualisierungen werden nicht gespeichert. Irgendwann wird das Attribut vollständig entfernt und es wird ein Fehler ausgegeben.

AttributeValueMetadata

Metadaten für unterstützte Attributwerte.

JSON-Darstellung 
{
  "value": value,
  "displayName": string
}
Felder
value

value (Value format)

Der Attributwert.
displayName

string

Der Anzeigename für diesen Wert, lokalisiert, sofern verfügbar. andernfalls auf Englisch. Der Anzeigename des Werts ist für die Verwendung im Zusammenhang mit dem Anzeigenamen des Attributs vorgesehen.

Für die Option „WLAN“ enum-Attribut enthält, könnte dieses Attribut „Bezahlt“ enthalten für kostenpflichtiges WLAN.