Method: users.history.list

Elenca la cronologia di tutte le modifiche apportate alla casella postale specificata. I risultati della cronologia vengono restituiti in ordine cronologico (historyId crescente).

Richiesta HTTP

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

L'URL utilizza la sintassi di transcodifica gRPC.

Parametri del percorso

Parametri
userId

string

L'indirizzo email dell'utente. Il valore speciale me può essere utilizzato per indicare l'utente autenticato.

Parametri di query

Parametri
maxResults

integer (uint32 format)

Il numero massimo di record della cronologia da restituire. Il valore predefinito di questo campo è 100. Il valore massimo consentito per questo campo è 500.
pageToken

string

Token di pagina per recuperare una pagina specifica di risultati nell'elenco.
startHistoryId

string

Obbligatorio. Restituisce i record della cronologia dopo il startHistoryId specificato. Il startHistoryId fornito deve essere ottenuto dal historyId di un messaggio, di un thread o di una risposta list precedente. Gli ID cronologia aumentano in ordine cronologico, ma non sono contigui e presentano intervalli vuoti casuali tra gli ID validi. Se fornisci un startHistoryId non valido o scaduto, in genere viene restituito un codice di errore HTTP 404. Un historyId è in genere valido per almeno una settimana, ma in alcune rare circostanze può essere valido solo per poche ore. Se ricevi una risposta di errore HTTP 404, l'applicazione deve eseguire una sincronizzazione completa. Se nella risposta non ricevi alcun nextPageToken, non ci sono aggiornamenti da recuperare e puoi archiviare il historyId restituito per una richiesta futura.
labelId

string

Restituisce solo i messaggi con un'etichetta corrispondente all'ID.
historyTypes[]

enum (HistoryType)

Tipi di cronologia da restituire dalla funzione

Corpo della richiesta

Il corpo della richiesta deve essere vuoto.

Corpo della risposta

In caso di esito positivo, il corpo della risposta contiene dati con la seguente struttura:

Rappresentazione JSON 
{
  "history": [
    {
      object (History)
    }
  ],
  "nextPageToken": string,
  "historyId": string
}
Campi
history[]

object (History)

Elenco dei record della cronologia. Qualsiasi messages contenuto nella risposta in genere avrà compilati solo i campi id e threadId.
nextPageToken

string

Token di pagina per recuperare la pagina successiva dei risultati nell'elenco.
historyId

string

L'ID del record della cronologia corrente della casella postale.

Ambiti di autorizzazione

Richiede uno dei seguenti ambiti 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

Per saperne di più, consulta la OAuth 2.0 Overview.

HistoryType

Enum
messageAdded
messageDeleted
labelAdded
labelRemoved

Cronologia

Un record di una modifica alla casella postale dell'utente. Ogni modifica della cronologia può influire su più messaggi in più modi.

Rappresentazione JSON 
{
  "id": string,
  "messages": [
    {
      object (Message)
    }
  ],
  "messagesAdded": [
    {
      object (MessageAdded)
    }
  ],
  "messagesDeleted": [
    {
      object (MessageDeleted)
    }
  ],
  "labelsAdded": [
    {
      object (LabelAdded)
    }
  ],
  "labelsRemoved": [
    {
      object (LabelRemoved)
    }
  ]
}
Campi
id

string

L'ID sequenza della casella.
messages[]

object (Message)

Elenco dei messaggi modificati in questo record della cronologia. I campi per tipi di modifiche specifici, ad esempio messagesAdded, potrebbero duplicare i messaggi in questo campo. Ti consigliamo di utilizzare i campi specifici per il tipo di modifica.
messagesAdded[]

object (MessageAdded)

Messaggi aggiunti alla casella di posta in questo record della cronologia.
messagesDeleted[]

object (MessageDeleted)

Messaggi eliminati (non cestinati) dalla casella di posta in questo record della cronologia.
labelsAdded[]

object (LabelAdded)

Etichette aggiunte ai messaggi in questo record della cronologia.
labelsRemoved[]

object (LabelRemoved)

Etichette rimosse dai messaggi in questo record della cronologia.

MessageAdded

Rappresentazione JSON 
{
  "message": {
    object (Message)
  }
}
Campi
message

object (Message)

MessageDeleted

Rappresentazione JSON 
{
  "message": {
    object (Message)
  }
}
Campi
message

object (Message)

LabelAdded

Rappresentazione JSON 
{
  "message": {
    object (Message)
  },
  "labelIds": [
    string
  ]
}
Campi
message

object (Message)
labelIds[]

string

ID etichetta aggiunti al messaggio.

LabelRemoved

Rappresentazione JSON 
{
  "message": {
    object (Message)
  },
  "labelIds": [
    string
  ]
}
Campi
message

object (Message)
labelIds[]

string

ID etichetta rimossi dal messaggio.