Method: users.history.list

Muestra una lista del historial de todos los cambios de un buzón determinado. Los resultados del historial se muestran en orden cronológico (aumenta la cantidad de 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 la 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, subproceso o respuesta list anterior. Los IDs del historial aumentan cronológicamente, pero no son contiguos o hay espacios aleatorios entre los IDs válidos. Si proporcionas un startHistoryId no válido o desactualizado, por lo general, se muestra un código de error HTTP 404. Un historyId suele ser válido durante al menos una semana, pero en algunas circunstancias excepcionales puede ser válido solo durante unas horas. Si recibes una respuesta de error HTTP 404, tu aplicación debería realizar una sincronización completa. Si no recibes ninguna nextPageToken en la respuesta, no habrá actualizaciones para recuperar y podrás almacenar el historyId que se muestra para una solicitud futura.
labelId

string

Solo mostrar mensajes con una etiqueta que coincida con el ID
historyTypes[]

enum (HistoryType)

Tipos de historial que muestra 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 históricos. Por lo general, todos los messages contenidos en la respuesta solo tendrán los campos id y threadId propagados.
nextPageToken

string

Token de la 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 de correo.

Alcances de autorización

Se necesita uno de los siguientes permisos 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

Enumeraciones
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 varias 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 la secuencia del buzón de correo.
messages[]

object (Message)

Lista de mensajes modificados en este registro de historial. Es posible que los campos para tipos de cambio específicos, como messagesAdded, dupliquen los mensajes en este campo. Recomendamos usar los campos específicos de tipo de cambio en lugar de esto.
messagesAdded[]

object (MessageAdded)

Mensajes agregados a la casilla de correo de este registro de historial.
messagesDeleted[]

object (MessageDeleted)

Mensajes eliminados (no enviados a la Papelera) de la casilla de correo de este registro de historial.
labelsAdded[]

object (LabelAdded)

Se agregaron etiquetas a los mensajes de este registro del historial.
labelsRemoved[]

object (LabelRemoved)

Etiquetas eliminadas 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 IDs de etiqueta del mensaje.