Method: users.history.list

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

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 pagina per recuperare una pagina specifica di risultati nell'elenco.
startHistoryId

string

Obbligatorio. Restituisce i record della cronologia dopo il startHistoryId specificato. Il valore 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 casuali tra gli ID validi. Se fornisci un startHistoryId non valido o obsoleto, in genere viene restituito un codice di errore HTTP 404. In genere, un historyId è valido per almeno una settimana, ma in alcuni rari casi può essere valido solo per poche ore. Se ricevi una risposta di errore HTTP 404, la tua applicazione dovrebbe eseguire una sincronizzazione completa. Se non ricevi nextPageToken nella risposta, non ci sono aggiornamenti da recuperare e puoi memorizzare il nextPageToken restituito per una richiesta futura.historyId
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 di record della cronologia. In genere, qualsiasi messages contenuto nella risposta avrà solo i campi id e threadId compilati.
nextPageToken

string

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

string

L'ID del record della cronologia corrente della cassetta di posta.

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 ulteriori informazioni, consulta la Guida all'autorizzazione.

HistoryType

Enum
messageAdded
messageDeleted
labelAdded
labelRemoved

Cronologia

Un record di una modifica alla casella di posta dell'utente. Ogni modifica alla cronologia può interessare più messaggi in diversi 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 cassetta postale.
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 di tipo di modifica specifici anziché questo.
messagesAdded[]

object (MessageAdded)

Messaggi aggiunti alla cassetta postale in questo record della cronologia.
messagesDeleted[]

object (MessageDeleted)

Messaggi eliminati (non nel Cestino) dalla cassetta postale 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.