Method: labels.list

Liste des libellés.

Requête HTTP

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

L'URL utilise la syntaxe de transcodage gRPC.

Paramètres de requête

Paramètres
publishedOnly

boolean

Indique si seuls les libellés publiés doivent être inclus dans les résultats.

  • Lorsque la valeur est true, seules les révisions d'étiquettes publiées actuellement sont renvoyées. Les libellés désactivés sont inclus. Les noms de ressources d'étiquettes renvoyés font référence à la révision publiée (labels/{id}/{revisionId}).
  • Lorsque la valeur est false, les révisions actuelles du libellé sont renvoyées, mais elles ne sont pas nécessairement publiées. Les noms de ressources de libellé 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: "customers/abcd1234". Si ce paramètre n'est pas défini, tous les libellés du client actuel sont renvoyés.
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 à 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. Toutes les étiquettes du client sont renvoyées.
minimumRole

enum (LabelRole)

Indique le niveau d'accès dont l'utilisateur doit disposer sur 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.