Method: labels.list

Labels auflisten

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.

  • Bei true werden nur die aktuell veröffentlichten Labelversionen zurückgegeben. Deaktivierte Labels sind enthalten. Die zurückgegebenen Ressourcennamen der Labels beziehen sich auf die veröffentlichte Version (labels/{id}/{revisionId}).
  • Bei false werden die aktuellen Labelüberarbeitungen zurückgegeben, die möglicherweise nicht veröffentlicht wurden. Die zurückgegebenen Labelressourcennamen verweisen nicht auf eine bestimmte Version (labels/{id}).
customer

string

Der Kunde, für den diese Listenanfrage gilt. Beispiel: „Kunden/abcd1234“. Wenn nicht festgelegt, werden alle Labels für den aktuellen Kunden zurückgegeben.

languageCode

string

Der BCP-47-Sprachcode, der für die Auswertung lokalisierter Feldlabels verwendet werden soll. Wenn keine Angabe erfolgt, werden Werte in der standardmäßig konfigurierten Sprache verwendet.

pageSize

integer

Die maximale Anzahl von 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 zurückgegeben, die zur angegebenen Ansicht gehören.

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. Dadurch 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 das Auflisten 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 Leitfaden zur Autorisierung.