Method: users.history.list

Lista o histórico de todas as alterações na caixa de correio especificada. Os resultados do histórico são retornados em ordem cronológica (crescente historyId).

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 este 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 recebido do historyId de uma mensagem, linha de execução 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. Fornecer um startHistoryId inválido ou desatualizado normalmente retorna um código de erro HTTP 404. Um historyId normalmente é válido por pelo menos uma semana, mas, em algumas circunstâncias raras, pode ser válido apenas por algumas horas. Se você receber uma resposta de erro HTTP 404, o aplicativo precisará executar uma sincronização completa. Se você não receber nextPageToken na resposta, não haverá atualizações a serem recuperadas e será possível armazenar o historyId retornado para uma solicitação futura.
labelId

string

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

enum (HistoryType)

Tipos de histórico a serem 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 do histórico. Qualquer messages contido na resposta normalmente tem apenas 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 do histórico atual da caixa de e-mails.

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 alteração na caixa de correio do usuário. Cada alteração do 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 e-mails.
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 usar os campos de tipo de alteração específicos no lugar deles.
messagesAdded[]

object (MessageAdded)

Mensagens adicionadas à caixa de e-mails neste registro de histórico.
messagesDeleted[]

object (MessageDeleted)

Mensagens excluídas (não para a lixeira) da caixa de correio neste registro de histórico.
labelsAdded[]

object (LabelAdded)

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

object (LabelRemoved)

Marcadores 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 de marcador adicionados à mensagem.

LabelRemoved

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

object (Message)
labelIds[]

string

Os IDs de marcador foram removidos da mensagem.