Method: users.messages.batchModify

Modifie les libellés et les valeurs de libellé de classification des messages spécifiés. Pour les administrateurs qui modifient des messages pour les utilisateurs de leur organisation, les demandes nécessitent une autorisation avec un compte de service disposant d'une autorité de délégation à l'échelle du domaine pour emprunter l'identité des utilisateurs avec le champ d'application https://www.googleapis.com/auth/gmail.modify.restricted.

Requête HTTP

POST https://gmail.googleapis.com/gmail/v1/users/{userId}/messages/batchModify

L'URL utilise la syntaxe de transcodage gRPC.

Paramètres de chemin d'accès

Paramètres
userId

string

Adresse e-mail de l'utilisateur. La valeur spéciale me peut être utilisée pour indiquer l'utilisateur authentifié.

Corps de la requête

Le corps de la requête contient des données présentant la structure suivante :

Représentation JSON 
{
  "ids": [
    string
  ],
  "addLabelIds": [
    string
  ],
  "removeLabelIds": [
    string
  ],
  "addClassificationLabels": [
    {
      object (ClassificationLabelValue)
    }
  ],
  "removeClassificationLabelIds": [
    string
  ]
}
Champs
ids[]

string

ID des messages à modifier. Le nombre d'ID est limité à 1 000 par requête.
addLabelIds[]

string

Liste des ID de libellés à ajouter aux messages.
removeLabelIds[]

string

Liste des ID de libellés à supprimer des messages.
addClassificationLabels[]

object (ClassificationLabelValue)

Liste des valeurs de libellé de classification à ajouter. Si un libellé de classification portant le même ID est déjà appliqué au message, les champs avec des ID de champ existants seront mis à jour et les champs avec de nouveaux ID de champ seront ajoutés. Le nombre de valeurs de libellé de classification est limité à 20 par demande. Si le message est déjà classé et que le nombre total final de valeurs de libellé de classification dépasse le nombre maximal autorisé par message, la modification échoue.
removeClassificationLabelIds[]

string

Liste des valeurs de libellé de classification à supprimer des messages.

Corps de la réponse

Si la requête aboutit, le corps de la réponse est vide.

Champs d'application des autorisations

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

  • https://mail.google.com/
  • https://www.googleapis.com/auth/gmail.modify
  • https://www.googleapis.com/auth/gmail.modify.restricted

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