- Solicitud HTTP
- Parámetros de ruta de acceso
- Parámetros de consulta
- Cuerpo de la solicitud
- Cuerpo de la respuesta
- Permisos de autorización
- HistoryType
- Historial
- MessageAdded
- MessageDeleted
- LabelAdded
- LabelRemoved
- Pruébala
Enumera el historial de todos los cambios de un buzón determinado. Los resultados del historial se muestran en orden cronológico (aumenta historyId
).
Solicitud HTTP
GET https://gmail.googleapis.com/gmail/v1/users/{userId}/history
La URL usa la sintaxis de la transcodificación gRPC.
Parámetros de ruta de acceso
Parámetros | |
---|---|
userId |
La dirección de correo electrónico del usuario. Se puede usar el valor especial |
Parámetros de consulta
Parámetros | |
---|---|
maxResults |
Cantidad máxima de registros del historial que se mostrarán. El valor predeterminado de este campo es 100. El valor máximo permitido para este campo es 500. |
pageToken |
Token de página para recuperar una página específica de resultados en la lista. |
startHistoryId |
Obligatorio. Muestra los registros históricos después del |
labelId |
Solo muestra mensajes con una etiqueta que coincida con el ID. |
historyTypes[] |
Tipos de historial que mostrará la función |
Cuerpo de la solicitud
El cuerpo de la solicitud debe estar vacío.
Cuerpo de la respuesta
Si el proceso es satisfactorio, el cuerpo de la respuesta contiene datos con la siguiente estructura:
Representación JSON |
---|
{
"history": [
{
object ( |
Campos | |
---|---|
history[] |
Lista de registros del historial. Por lo general, cualquier |
nextPageToken |
Token de página para recuperar la página siguiente de resultados de la lista. |
historyId |
El ID del registro del historial actual del buzón. |
Permisos de autorización
Se necesita uno de los siguientes alcances de OAuth:
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
Para obtener más información, consulta la guía de autorización.
HistoryType
Enumeradores | |
---|---|
messageAdded |
|
messageDeleted |
|
labelAdded |
|
labelRemoved |
Historial
Un registro de un cambio en el buzón del usuario. Cada cambio en el historial puede afectar a varios mensajes de diferentes maneras.
Representación JSON |
---|
{ "id": string, "messages": [ { object ( |
Campos | |
---|---|
id |
El ID de secuencia del buzón de correo. |
messages[] |
Se modificó la lista de mensajes en este registro del historial. Los campos de tipos de cambio específicos, como |
messagesAdded[] |
Mensajes que se agregaron al buzón de correo de este registro del historial. |
messagesDeleted[] |
Mensajes borrados (no enviados a la papelera) del buzón en este registro del historial. |
labelsAdded[] |
Etiquetas que se agregaron a los mensajes en este registro del historial. |
labelsRemoved[] |
Se quitaron las etiquetas de los mensajes en este registro del historial. |
MessageAdded
Representación JSON |
---|
{
"message": {
object ( |
Campos | |
---|---|
message |
|
MessageDeleted
Representación JSON |
---|
{
"message": {
object ( |
Campos | |
---|---|
message |
|
LabelAdded
Representación JSON |
---|
{
"message": {
object ( |
Campos | |
---|---|
message |
|
labelIds[] |
Se agregaron los IDs de etiqueta al mensaje. |
LabelRemoved
Representación JSON |
---|
{
"message": {
object ( |
Campos | |
---|---|
message |
|
labelIds[] |
Se quitaron los ID de etiqueta del mensaje. |