- Requête HTTP
- Paramètres de chemin d'accès
- Paramètres de requête
- Corps de la requête
- Corps de la réponse
- Champs d'application des autorisations
- HistoryType
- Historique
<ph type="x-smartling-placeholder">
- </ph>
- Représentation JSON
- MessageAdded
<ph type="x-smartling-placeholder">
- </ph>
- Représentation JSON
- MessageDeleted
<ph type="x-smartling-placeholder">
- </ph>
- Représentation JSON
- LabelAdded
<ph type="x-smartling-placeholder">
- </ph>
- Représentation JSON
- LabelRemoved
<ph type="x-smartling-placeholder">
- </ph>
- Représentation JSON
- Essayer
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 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 |
Adresse e-mail de l'utilisateur. La valeur spéciale |
Paramètres de requête
Paramètres | |
---|---|
maxResults |
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 |
Jeton de page permettant de récupérer une page spécifique de résultats dans la liste. |
startHistoryId |
Obligatoire. Renvoie les enregistrements d'historique postérieurs à la valeur |
labelId |
Affiche uniquement les messages dont le libellé correspond à l'ID. |
historyTypes[] |
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 ( |
Champs | |
---|---|
history[] |
Liste des enregistrements de l'historique. Les |
nextPageToken |
Jeton de page permettant de récupérer la page suivante des résultats dans la liste. |
historyId |
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 ( |
Champs | |
---|---|
id |
ID de séquence de la boîte aux lettres. |
messages[] |
Liste des messages modifiés dans cet enregistrement d'historique. Les champs associés à des types de modifications spécifiques, tels que |
messagesAdded[] |
Les messages ont été ajoutés à la boîte aux lettres dans cet enregistrement d'historique. |
messagesDeleted[] |
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[] |
Libellés ajoutés aux messages dans cet enregistrement d'historique. |
labelsRemoved[] |
Libellés supprimés des messages de cet enregistrement d'historique. |
MessageAdded
Représentation JSON |
---|
{
"message": {
object ( |
Champs | |
---|---|
message |
|
MessageDeleted
Représentation JSON |
---|
{
"message": {
object ( |
Champs | |
---|---|
message |
|
LabelAdded
Représentation JSON |
---|
{
"message": {
object ( |
Champs | |
---|---|
message |
|
labelIds[] |
ID des libellés ajoutés au message. |
LabelRemoved
Représentation JSON |
---|
{
"message": {
object ( |
Champs | |
---|---|
message |
|
labelIds[] |
ID de libellé supprimés du message. |