Method: users.history.list

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

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 de l'historique à renvoyer. La valeur par défaut de ce champ est 100. La valeur maximale autorisée pour ce champ est de 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 de l'historique après le startHistoryId spécifié. Le startHistoryId fourni doit être obtenu à partir du historyId d'un message, d'un fil de discussion ou d'une réponse list précédente. Les ID d'historique augmentent de manière chronologique, mais ne sont pas contigus. Des écarts aléatoires existent entre les ID valides. Si vous fournissez un startHistoryId non valide ou obsolète, le code d'erreur HTTP 404 est généralement renvoyé. Un historyId est généralement valable au moins une semaine, mais dans de rares cas, il peut ne l'être que quelques heures. Si vous recevez une réponse d'erreur HTTP 404, votre application doit effectuer une synchronisation complète. Si vous ne recevez aucun nextPageToken dans la réponse, cela signifie qu'il n'y a pas de mises à jour à récupérer. Vous pouvez stocker le historyId renvoyé pour une future requête.
labelId

string

Ne renvoie que 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. Les messages contenus dans la réponse ne comportent généralement que les champs id et threadId.
nextPageToken

string

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

string

ID de l'enregistrement de l'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 plus d'informations, consultez la OAuth 2.0 Overview.

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 de l'historique. Les champs correspondant à des types de modifications spécifiques, tels que messagesAdded, peuvent dupliquer les messages dans ce champ. Nous vous recommandons d'utiliser les champs de type de modification spécifiques à la place.
messagesAdded[]

object (MessageAdded)

Messages ajoutés à la boîte aux lettres dans cet historique.
messagesDeleted[]

object (MessageDeleted)

Messages supprimés (et non placés dans la corbeille) de la boîte aux lettres dans cet historique.
labelsAdded[]

object (LabelAdded)

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

object (LabelRemoved)

Libellés supprimés des messages dans cet enregistrement de l'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 des libellés supprimés du message.