Method: labels.list

Listez les 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

Permet d'inclure uniquement les libellés publiés dans les résultats.

  • Lorsque la valeur est true, seules les révisions de libellé actuellement publiées sont renvoyées. Les libellés désactivés sont inclus. Les noms de ressources de libellés renvoyés font référence à la révision publiée (labels/{id}/{revisionId}).
  • Lorsque la valeur est false, les révisions de libellé actuelles sont renvoyées, et peuvent donc ne pas être 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 appliquer cette requête de liste. Exemple: "clients/abcd1234". Si cette règle n'est pas configurée, toutes les étiquettes du client actuel sont renvoyées.
languageCode

string

Code de langue BCP-47 à utiliser pour évaluer les libellés de champ localisés. Si aucune valeur n'est spécifiée, les valeurs dans la langue configurée par défaut 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 à afficher.
view

enum (LabelView)

Si 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 la valeur sur true pour utiliser les identifiants d'administrateur de l'utilisateur. Cela renverra tous les libellés pour le client.
minimumRole

enum (LabelRole)

Spécifie le niveau d'accès de l'utilisateur aux 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 les libellés des fiches.

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 relatif aux autorisations.