Method: users.history.list

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

string

La dirección de correo electrónico del usuario. Se puede usar el valor especial me para indicar el usuario autenticado.

Parámetros de consulta

Parámetros
maxResults

integer (uint32 format)

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

string

Token de página para recuperar una página específica de resultados en la lista.

startHistoryId

string

Obligatorio. Muestra los registros históricos después del startHistoryId especificado. El startHistoryId proporcionado debe obtenerse del historyId de un mensaje, un subproceso o una respuesta list anterior. Los ID del historial aumentan cronológicamente, pero no son contiguos a espacios aleatorios entre los ID válidos. Si proporcionas un startHistoryId no válido o desactualizado, por lo general, se muestra un código de error HTTP 404. Normalmente, un historyId es válido durante al menos una semana, pero en algunas circunstancias excepcionales puede ser válido solo por unas horas. Si recibes una respuesta de error HTTP 404, tu aplicación debería realizar una sincronización completa. Si no recibes nextPageToken en la respuesta, no hay actualizaciones para recuperar y puedes almacenar el historyId que se muestra para una solicitud futura.

labelId

string

Solo muestra mensajes con una etiqueta que coincida con el ID.

historyTypes[]

enum (HistoryType)

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 (History)
    }
  ],
  "nextPageToken": string,
  "historyId": string
}
Campos
history[]

object (History)

Lista de registros del historial. Por lo general, cualquier messages que se encuentre en la respuesta solo tendrá los campos id y threadId propagados.

nextPageToken

string

Token de página para recuperar la página siguiente de resultados de la lista.

historyId

string

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 (Message)
    }
  ],
  "messagesAdded": [
    {
      object (MessageAdded)
    }
  ],
  "messagesDeleted": [
    {
      object (MessageDeleted)
    }
  ],
  "labelsAdded": [
    {
      object (LabelAdded)
    }
  ],
  "labelsRemoved": [
    {
      object (LabelRemoved)
    }
  ]
}
Campos
id

string

El ID de secuencia del buzón de correo.

messages[]

object (Message)

Se modificó la lista de mensajes en este registro del historial. Los campos de tipos de cambio específicos, como messagesAdded, pueden duplicar mensajes en este campo. Recomendamos utilizar los campos específicos de tipo de cambio en lugar de estos campos.

messagesAdded[]

object (MessageAdded)

Mensajes que se agregaron al buzón de correo de este registro del historial.

messagesDeleted[]

object (MessageDeleted)

Mensajes borrados (no enviados a la papelera) del buzón en este registro del historial.

labelsAdded[]

object (LabelAdded)

Etiquetas que se agregaron a los mensajes en este registro del historial.

labelsRemoved[]

object (LabelRemoved)

Se quitaron las etiquetas de los mensajes en este registro del historial.

MessageAdded

Representación JSON
{
  "message": {
    object (Message)
  }
}
Campos
message

object (Message)

MessageDeleted

Representación JSON
{
  "message": {
    object (Message)
  }
}
Campos
message

object (Message)

LabelAdded

Representación JSON
{
  "message": {
    object (Message)
  },
  "labelIds": [
    string
  ]
}
Campos
message

object (Message)

labelIds[]

string

Se agregaron los IDs de etiqueta al mensaje.

LabelRemoved

Representación JSON
{
  "message": {
    object (Message)
  },
  "labelIds": [
    string
  ]
}
Campos
message

object (Message)

labelIds[]

string

Se quitaron los ID de etiqueta del mensaje.