Method: users.history.list

Lista o histórico de todas as mudanças na caixa de correio especificada. Os resultados da história são retornados em ordem cronológica (historyId crescente).

Solicitação HTTP

GET https://gmail.googleapis.com/gmail/v1/users/{userId}/history

O URL usa a sintaxe de transcodificação gRPC.

Parâmetros de caminho

Parâmetros
userId

string

O endereço de e-mail do usuário. O valor especial me pode ser usado para indicar o usuário autenticado.

Parâmetros de consulta

Parâmetros
maxResults

integer (uint32 format)

Número máximo de registros de histórico a serem retornados. O padrão desse campo é 100. O valor máximo permitido para esse campo é 500.
pageToken

string

Token de página para recuperar uma página específica de resultados na lista.
startHistoryId

string

Obrigatório. Retorna registros de histórico após o startHistoryId especificado. O startHistoryId fornecido precisa ser extraído do historyId de uma mensagem, conversa ou resposta list anterior. Os IDs de histórico aumentam cronologicamente, mas não são contíguos, com lacunas aleatórias entre os IDs válidos. O fornecimento de um startHistoryId inválido ou desatualizado geralmente retorna um código de erro HTTP 404. Um historyId geralmente é válido por pelo menos uma semana, mas, em algumas circunstâncias raras, pode ser válido por apenas algumas horas. Se você receber uma resposta de erro HTTP 404, o aplicativo precisará fazer uma sincronização completa. Se você não receber nextPageToken na resposta, não há atualizações para recuperar e você pode armazenar o historyId retornado para uma solicitação futura.
labelId

string

Só retorna mensagens com um rótulo correspondente ao ID.
historyTypes[]

enum (HistoryType)

Tipos de histórico que serão retornados pela função

Corpo da solicitação

O corpo da solicitação precisa estar vazio.

Corpo da resposta

Se bem-sucedido, o corpo da resposta exibirá os dados com a seguinte estrutura:

Representação JSON 
{
  "history": [
    {
      object (History)
    }
  ],
  "nextPageToken": string,
  "historyId": string
}
Campos
history[]

object (History)

Lista de registros de histórico. Normalmente, os campos messages contidos na resposta só têm os campos id e threadId preenchidos.
nextPageToken

string

Token da página para recuperar a próxima página de resultados na lista.
historyId

string

O ID do registro de histórico atual da caixa de correio.

Escopos de autorização

Requer um dos seguintes escopos do 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 mais informações, consulte o guia de autorização.

HistoryType

Enums
messageAdded
messageDeleted
labelAdded
labelRemoved

Histórico

Um registro de uma mudança na caixa de e-mails do usuário. Cada alteração no histórico pode afetar várias mensagens de várias maneiras.

Representação JSON 
{
  "id": string,
  "messages": [
    {
      object (Message)
    }
  ],
  "messagesAdded": [
    {
      object (MessageAdded)
    }
  ],
  "messagesDeleted": [
    {
      object (MessageDeleted)
    }
  ],
  "labelsAdded": [
    {
      object (LabelAdded)
    }
  ],
  "labelsRemoved": [
    {
      object (LabelRemoved)
    }
  ]
}
Campos
id

string

O ID da sequência da caixa de correio.
messages[]

object (Message)

Lista de mensagens alteradas neste registro de histórico. Os campos de tipos de mudança específicos, como messagesAdded, podem duplicar mensagens nesse campo. Recomendamos o uso dos campos específicos de tipo de mudança em vez disso.
messagesAdded[]

object (MessageAdded)

Mensagens adicionadas à caixa de correio neste registro de histórico.
messagesDeleted[]

object (MessageDeleted)

Mensagens excluídas (não lixadas) da caixa de mensagens neste registro de histórico.
labelsAdded[]

object (LabelAdded)

Rótulos adicionados às mensagens neste registro de histórico.
labelsRemoved[]

object (LabelRemoved)

Rótulos removidos das mensagens neste registro de histórico.

MessageAdded

Representação JSON 
{
  "message": {
    object (Message)
  }
}
Campos
message

object (Message)

MessageDeleted

Representação JSON 
{
  "message": {
    object (Message)
  }
}
Campos
message

object (Message)

LabelAdded

Representação JSON 
{
  "message": {
    object (Message)
  },
  "labelIds": [
    string
  ]
}
Campos
message

object (Message)
labelIds[]

string

IDs dos rótulos adicionados à mensagem.

LabelRemoved

Representação JSON 
{
  "message": {
    object (Message)
  },
  "labelIds": [
    string
  ]
}
Campos
message

object (Message)
labelIds[]

string

IDs de rótulo removidos da mensagem.