Google verwendet KI-Technologie, um Inhalte in Ihre bevorzugte Sprache zu übersetzen. KI-Übersetzungen können Fehler enthalten.

Method: attributes.list

HTTP-Anfrage
Suchparameter
Anfragetext
Antworttext
- JSON-Darstellung
Autorisierungsbereiche
AttributeMetadata
- JSON-Darstellung
AttributeValueMetadata
- JSON-Darstellung

Gibt die Liste der Attribute zurück, die für einen Standort mit der angegebenen Primärkategorie 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` Optional. Ressourcenname des Standorts, für den verfügbare Attribute gesucht werden sollen. Wenn dieses Feld festgelegt ist, sind `categoryName`, `regionCode`, `languageCode` und `showAll` nicht erforderlich und dürfen nicht festgelegt werden. Format: `locations/{locationId}` (z.B. `locations/1234567890`).
`categoryName`	`string` Optional. Die stabile ID der primären Kategorie, um verfügbare Attribute zu finden. Muss das Format `categories/{category_id}` haben (z.B. `categories/gcid:restaurant`). Erforderlich, wenn `parent` nicht festgelegt ist und `showAll` „false“ ist.
`regionCode`	`string` Optional. Der ISO 3166-1 Alpha-2-Ländercode, um verfügbare Attribute zu finden. Erforderlich, wenn `parent` nicht festgelegt ist.
`languageCode`	`string` Optional. Der BCP-47-Code der Sprache, in der die Anzeigenamen der Attribute abgerufen werden sollen. Wenn diese Sprache nicht verfügbar ist, werden sie auf Englisch bereitgestellt.
`showAll`	`boolean` Optional. Wenn „true“ festgelegt ist, werden Metadaten für alle verfügbaren Attribute zurückgegeben, wobei die Felder `parent` und `categoryName` ignoriert werden. `languageCode` und `regionCode` sind erforderlich, wenn `showAll` auf „true“ gesetzt ist.
`pageSize`	`integer` Wie viele Attribute pro Seite enthalten sein 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 die nächste Seite mit Attributen bei einem nachfolgenden Aufruf von attributes.list abzurufen. Wenn keine weiteren Attribute vorhanden sind, ist dieses Feld in der Antwort nicht enthalten.

Autorisierungsbereiche

Erfordert den folgenden OAuth-Bereich:

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

Weitere Informationen finden Sie unter OAuth 2.0 Overview.

AttributeMetadata

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

JSON-Darstellung

JSON-Darstellung
{ "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,
  "valueMetadata": [
    {
      object (AttributeValueMetadata)
    }
  ],
  "deprecated": boolean
}

Felder
`parent`	`string` Die eindeutige Kennung für das Attribut.
`valueType`	`enum (AttributeValueType)` Der Werttyp für das Attribut. Die festgelegten und abgerufenen Werte sollten von diesem Typ sein.
`displayName`	`string` Der lokalisierte Anzeigename für das Attribut, falls verfügbar, andernfalls der englische Anzeigename.
`groupDisplayName`	`string` Der lokalisierte Anzeigename der Gruppe, die dieses Attribut enthält, falls verfügbar. Andernfalls der englische Gruppenname. Zusammengehörige Attribute werden in einer Gruppe zusammengefasst und sollten zusammen unter der hier angegebenen Überschrift angezeigt werden.
`repeatable`	`boolean` Wenn „true“, unterstützt das Attribut mehrere Werte. Wenn „false“, sollte nur ein einzelner Wert angegeben werden.
`valueMetadata[]`	`object (AttributeValueMetadata)` Für einige Attributtypen (z. B. Optionen) wird eine Liste der unterstützten Werte und entsprechenden Anzeigenamen für diese Werte bereitgestellt.
`deprecated`	`boolean` Wenn „true“, ist das Attribut veraltet und sollte nicht mehr verwendet werden. Wenn es verworfen wurde, führt das Aktualisieren dieses Attributs nicht zu einem Fehler, aber die Aktualisierungen werden nicht gespeichert. Nach der Einstellung wird das Attribut irgendwann vollständig entfernt und führt zu einem Fehler.

AttributeValueMetadata

Metadaten für unterstützte Attributwerte.

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

Felder

value

value (Value format)

Der Attributwert.

displayName