Method: labels.list

Labels auflisten Weitere Informationen finden Sie unter Nach Labels suchen.

HTTP-Anfrage

GET https://drivelabels.googleapis.com/v2/labels

Die URL verwendet die Syntax der gRPC-Transcodierung.

Abfrageparameter

Parameter
publishedOnly

boolean

Gibt an, ob nur veröffentlichte Labels in die Ergebnisse einbezogen werden sollen.

  • Wenn true, werden nur die aktuell veröffentlichten Label-Revisionen zurückgegeben. Deaktivierte Labels sind enthalten. Die zurückgegebenen Ressourcenname des Labels verweist auf die veröffentlichte Überarbeitung (labels/{id}/{revisionId}).
  • Wenn false, werden die aktuellen Label-Überarbeitungen zurückgegeben, die möglicherweise nicht veröffentlicht sind. Die zurückgegebenen Label-Ressourcennamen verweisen nicht auf eine bestimmte Überarbeitung (labels/{id}).
customer

string

Der Kunde, auf den sich diese Listenanfrage bezieht. Beispiel: customers/abcd1234. Wenn nicht festgelegt, werden alle Labels des aktuellen Kunden zurückgegeben.

languageCode

string

Der BCP-47-Sprachcode, der zum Auswerten lokalisierter Feldlabels verwendet werden soll. Wenn nichts angegeben ist, werden Werte in der standardmäßig konfigurierten Sprache verwendet.

pageSize

integer

Maximale Anzahl der Labels, die pro Seite zurückgegeben werden sollen. Standard: 50. Max.: 200.

pageToken

string

Das Token der Seite, die zurückgegeben werden soll.

view

enum (LabelView)

Wenn angegeben, werden nur bestimmte Felder der angegebenen Ansicht zurückgegeben.

Union-Parameter access.

Für access ist nur einer der folgenden Werte zulässig:

useAdminAccess

boolean

Legen Sie true fest, um die Administratoranmeldedaten des Nutzers zu verwenden. Damit werden alle Labels des Kunden zurückgegeben.

minimumRole

enum (LabelRole)

Gibt die Zugriffsebene an, die der Nutzer für die zurückgegebenen Labels haben muss. Die Mindestrolle, die ein Nutzer für ein Label haben muss. Die Standardeinstellung ist READER.

Anfragetext

Der Anfragetext muss leer sein.

Antworttext

Antwort für die Auflistung von Labels.

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

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

object (Label)

Labels.

nextPageToken

string

Das Token der nächsten Seite in der Antwort.

Autorisierungsbereiche

Erfordert einen der folgenden OAuth-Bereiche:

  • https://www.googleapis.com/auth/drive.labels
  • https://www.googleapis.com/auth/drive.labels.readonly
  • https://www.googleapis.com/auth/drive.admin.labels
  • https://www.googleapis.com/auth/drive.admin.labels.readonly

Weitere Informationen finden Sie im Autorisierungsleitfaden.