Method: users.history.list

Liste l'historique de toutes les modifications apportées à la boîte aux lettres concernée. Les résultats de l'historique sont renvoyés dans l'ordre chronologique (avec une augmentation de historyId).

Requête HTTP

GET https://gmail.googleapis.com/gmail/v1/users/{userId}/history

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é.

Paramètres de requête

Paramètres
maxResults

integer (uint32 format)

Nombre maximal d'enregistrements d'historique à renvoyer. La valeur par défaut de ce champ est 100. La valeur maximale autorisée pour ce champ est 500.
pageToken

string

Jeton de page permettant de récupérer une page spécifique de résultats dans la liste.
startHistoryId

string

Obligatoire. Renvoie les enregistrements d'historique postérieurs à la valeur startHistoryId spécifiée. Le startHistoryId fourni doit être obtenu à partir du historyId d'un message, d'un thread ou d'une réponse list précédente. Les ID d'historique augmentent dans l'ordre chronologique, mais ne suivent pas d'espaces aléatoires entre les ID valides. Fournir un startHistoryId non valide ou obsolète renvoie généralement un code d'erreur HTTP 404. Une historyId est généralement valide pendant au moins une semaine, mais dans de rares cas, elle peut n'être valide que pendant quelques heures. Si vous recevez une réponse d'erreur HTTP 404, votre application doit effectuer une synchronisation complète. Si vous ne recevez pas de nextPageToken dans la réponse, il n'y a aucune mise à jour à récupérer et vous pouvez stocker le historyId renvoyé pour une requête ultérieure.
labelId

string

Affiche uniquement les messages dont le libellé correspond à l'ID.
historyTypes[]

enum (HistoryType)

Types d'historique à renvoyer par la fonction

Corps de la requête

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

Corps de la réponse

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

Représentation JSON 
{
  "history": [
    {
      object (History)
    }
  ],
  "nextPageToken": string,
  "historyId": string
}
Champs
history[]

object (History)

Liste des enregistrements de l'historique. Pour chaque messages contenu dans la réponse, seuls les champs id et threadId sont généralement renseignés.
nextPageToken

string

Jeton de page permettant de récupérer la page suivante des résultats dans la liste.
historyId

string

Identifiant de l'enregistrement d'historique actuel de la boîte aux lettres.

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.readonly
  • https://www.googleapis.com/auth/gmail.metadata

Pour en savoir plus, consultez le Guide relatif aux autorisations.

HistoryType

Enums
messageAdded
messageDeleted
labelAdded
labelRemoved

Historique

Enregistrement d'une modification apportée à la boîte aux lettres de l'utilisateur. Chaque modification de l'historique peut affecter plusieurs messages de différentes manières.

Représentation JSON 
{
  "id": string,
  "messages": [
    {
      object (Message)
    }
  ],
  "messagesAdded": [
    {
      object (MessageAdded)
    }
  ],
  "messagesDeleted": [
    {
      object (MessageDeleted)
    }
  ],
  "labelsAdded": [
    {
      object (LabelAdded)
    }
  ],
  "labelsRemoved": [
    {
      object (LabelRemoved)
    }
  ]
}
Champs
id

string

ID de séquence de la boîte aux lettres.
messages[]

object (Message)

Liste des messages modifiés dans cet enregistrement d'historique. Les champs associés à des types de modifications spécifiques, tels que messagesAdded, peuvent dupliquer des messages dans ce champ. Nous vous recommandons plutôt d'utiliser les champs spécifiques au type de modification.
messagesAdded[]

object (MessageAdded)

Les messages ont été ajoutés à la boîte aux lettres dans cet enregistrement d'historique.
messagesDeleted[]

object (MessageDeleted)

Les messages ont été supprimés de la boîte aux lettres (et non placés dans la corbeille) dans cet enregistrement d'historique.
labelsAdded[]

object (LabelAdded)

Libellés ajoutés aux messages dans cet enregistrement d'historique.
labelsRemoved[]

object (LabelRemoved)

Libellés supprimés des messages de cet enregistrement d'historique.

MessageAdded

Représentation JSON 
{
  "message": {
    object (Message)
  }
}
Champs
message

object (Message)

MessageDeleted

Représentation JSON 
{
  "message": {
    object (Message)
  }
}
Champs
message

object (Message)

LabelAdded

Représentation JSON 
{
  "message": {
    object (Message)
  },
  "labelIds": [
    string
  ]
}
Champs
message

object (Message)
labelIds[]

string

ID des libellés ajoutés au message.

LabelRemoved

Représentation JSON 
{
  "message": {
    object (Message)
  },
  "labelIds": [
    string
  ]
}
Champs
message

object (Message)
labelIds[]

string

ID de libellé supprimés du message.