Method: labels.list

Elenca le etichette.

Richiesta HTTP

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

L'URL utilizza la sintassi di transcodifica gRPC.

Parametri di ricerca

Parametri
publishedOnly

boolean

Indica se includere nei risultati solo le etichette pubblicate.

  • Quando true, vengono restituite solo le revisioni delle etichette pubblicate correnti. Sono incluse le etichette disattivate. I nomi delle risorse delle etichette restituiti fanno riferimento alla revisione pubblicata (labels/{id}/{revisionId}).
  • Quando false vengono restituite le revisioni delle etichette correnti, che potrebbero non essere pubblicate. I nomi delle risorse delle etichette restituite non fanno riferimento a una revisione specifica (labels/{id}).
customer

string

Il cliente a cui definire l'ambito di questa richiesta di elenco. Ad esempio: "customers/abcd1234". Se il criterio non viene configurato, verranno restituite tutte le etichette dell'attuale cliente.

languageCode

string

Il codice lingua BCP-47 da utilizzare per valutare le etichette dei campi localizzati. Se non specificato, vengono utilizzati i valori nella lingua predefinita configurata.

pageSize

integer

Numero massimo di etichette da restituire per pagina. Valore predefinito: 50. Massimo: 200.

pageToken

string

Il token della pagina da restituire.

view

enum (LabelView)

Se specificato, vengono restituiti solo alcuni campi appartenenti alla visualizzazione indicata.

Parametro di unione access.

access può essere solo uno dei seguenti:

useAdminAccess

boolean

Imposta su true per utilizzare le credenziali di amministratore dell'utente. Verranno restituite tutte le etichette all'interno del cliente.

minimumRole

enum (LabelRole)

Specifica il livello di accesso che l'utente deve avere sulle etichette restituite. Il ruolo minimo che un utente deve avere per un'etichetta. Il valore predefinito è READER.

Corpo della richiesta

Il corpo della richiesta deve essere vuoto.

Corpo della risposta

Risposta per l'elenco delle etichette.

In caso di esito positivo, il corpo della risposta contiene dati con la seguente struttura:

Rappresentazione JSON
{
  "labels": [
    {
      object (Label)
    }
  ],
  "nextPageToken": string
}
Campi
labels[]

object (Label)

Etichette.

nextPageToken

string

Il token della pagina successiva nella risposta.

Ambiti di autorizzazione

Richiede uno dei seguenti ambiti OAuth:

  • 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

Per ulteriori informazioni, consulta la guida all'autorizzazione.