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, nach dem die verfügbaren Attribute gesucht werden sollen. Wenn dieses Feld festgelegt ist, sind „categoryName“, „regionCode“, „languageCode“ und „showAll“ nicht erforderlich und dürfen nicht festgelegt werden.
categoryName

string

Die stabile ID der primären Kategorie, um verfügbare Attribute zu finden. Muss das Format „categories/{category_id}“ haben.
regionCode

string

Der ISO 3166-1 Alpha-2-Ländercode, um verfügbare Attribute zu finden.
languageCode

string

Der BCP-47-Code für die Sprache, in der Anzeigenamen von Attributen abgerufen werden sollen. Wenn diese Sprache nicht verfügbar ist, werden sie auf Englisch bereitgestellt.
showAll

boolean

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

integer

Die Anzahl der Attribute, die 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 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 enthalten.

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. Werte, die festgelegt und abgerufen werden, sollten diesen Typ haben.
displayName

string

Der lokalisierte Anzeigename für das Attribut, falls verfügbar, andernfalls der englische Anzeigename.
groupDisplayName

string

Sofern verfügbar der lokalisierte Anzeigename der Gruppe, die dieses Attribut enthält; andernfalls der englische Gruppenname. Verwandte Attribute werden in einer Gruppe zusammengefasst und sollten gemeinsam unter der hier angegebenen Überschrift angezeigt werden.
repeatable

boolean

Wenn 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 entsprechenden Anzeigenamen für diese Werte bereitgestellt.
deprecated

boolean

Wenn „true“ festgelegt ist, wurde das Attribut eingestellt und sollte nicht mehr verwendet werden. Wenn das Attribut veraltet ist, führt das Aktualisieren dieses Attributs nicht zu einem Fehler, die Aktualisierungen werden jedoch nicht gespeichert. Nach der Einstellung wird das Attribut vollständig entfernt und wird zu einem Fehler.

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, sofern verfügbar in der gewünschten Sprache, ansonsten auf Englisch. Der Anzeigename des Werts ist für die Verwendung im Zusammenhang mit dem Attributanzeigenamen vorgesehen.

Für ein enum-Attribut des Typs „WLAN“ könnte das beispielsweise „Kostenpflichtig“ für kostenpflichtiges WLAN enthalten.