Method: users.history.list

Répertorie l'historique de toutes les modifications apportées à la boîte aux lettres indiquée. Les résultats de l'historique sont renvoyés par ordre chronologique (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 à afficher. 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 pour récupérer une page spécifique de résultats dans la liste.
startHistoryId

string

Obligatoire. Renvoie les enregistrements d'historique après le startHistoryId spécifié. 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 par ordre chronologique, mais ne sont pas contigus avec des écarts aléatoires entre les ID valides. Si vous fournissez un startHistoryId non valide ou obsolète, vous obtiendrez généralement un code d'erreur HTTP 404. Un historyId est généralement valide pendant au moins une semaine, mais dans de rares cas, il n'est valable 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 aucun 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 d'historique. Généralement, les champs messages contenus dans la réponse ne sont renseignés que id et threadId.
nextPageToken

string

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

string

ID 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 sur les autorisations.

Type d'historique

Enums
messageAdded
messageDeleted
labelAdded
labelRemoved

Historique

Enregistrement d'une modification dans 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 la séquence de boîtes aux lettres.
messages[]

object (Message)

Liste des messages modifiés dans cet enregistrement d'historique. Les champs de types de modifications spécifiques, tels que messagesAdded, peuvent contenir des messages en double. Nous vous recommandons d'utiliser plutôt les champs spécifiques des types de modifications.
messagesAdded[]

object (MessageAdded)

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

object (MessageDeleted)

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

object (LabelAdded)

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

object (LabelRemoved)

Libellés supprimés des messages dans cet enregistrement.

MessageAjouté

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

object (Message)

Message supprimé

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

object (Message)

Libellé ajouté

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

object (Message)
labelIds[]

string

ID des libellés ajoutés au message.

Libellé supprimé

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

object (Message)
labelIds[]

string

ID de libellés supprimés du message.