Method: labels.list

Lister les libellés Pour en savoir plus, consultez Rechercher des libellés.

Requête HTTP

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

L'URL utilise la syntaxe de transcodage gRPC.

Paramètres de requête

Paramètres
publishedOnly

boolean

Indique s'il faut inclure uniquement les libellés publiés dans les résultats.

  • Lorsque true, seules les révisions actuelles des libellés publiés sont renvoyées. Les libellés désactivés sont inclus. Les noms de ressources des libellés renvoyés font référence à la révision publiée (labels/{id}/{revisionId}).
  • Lorsque la valeur est false, les révisions actuelles des libellés sont renvoyées, mais elles ne sont pas forcément publiées. Les noms de ressources de libellés renvoyés ne font pas référence à une révision spécifique (labels/{id}).
customer

string

Client auquel limiter cette demande de liste. Exemple : customers/abcd1234. Si ce paramètre n'est pas défini, tous les libellés du client actuel seront renvoyés.
languageCode

string

Code de langue BCP-47 à utiliser pour évaluer les libellés de champ localisés. Si aucune langue n'est spécifiée, les valeurs de la langue par défaut configurée sont utilisées.
pageSize

integer

Nombre maximal de libellés à renvoyer par page. Valeur par défaut : 50. Max : 200.
pageToken

string

Jeton de la page à renvoyer.
view

enum (LabelView)

Si ce paramètre est spécifié, seuls certains champs appartenant à la vue indiquée sont renvoyés.

Paramètre d'union access.

access ne peut être qu'un des éléments suivants :
useAdminAccess

boolean

Définissez cette valeur sur true pour utiliser les identifiants d'administrateur de l'utilisateur. Cela renverra toutes les étiquettes du client.
minimumRole

enum (LabelRole)

Spécifie le niveau d'accès dont l'utilisateur doit disposer pour les libellés renvoyés. Rôle minimal qu'un utilisateur doit avoir sur un libellé. La valeur par défaut est READER.

Corps de la requête

Le corps de la requête doit être vide.

Corps de la réponse

Réponse pour la liste des libellés.

Si la requête aboutit, le corps de la réponse contient des données qui ont la structure suivante :

Représentation JSON 
{
  "labels": [
    {
      object (Label)
    }
  ],
  "nextPageToken": string
}
Champs
labels[]

object (Label)

Libellés.
nextPageToken

string

Jeton de la page suivante dans la réponse.

Champs d'application des autorisations

Nécessite l'un des champs d'application OAuth suivants :

  • 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

Pour en savoir plus, consultez le guide d'autorisation.