Method: users.history.list

Elenca la cronologia di tutte le modifiche apportate alla casella di posta specificata. I risultati della cronologia vengono restituiti in ordine cronologico (con un aumento di 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. È possibile utilizzare il valore speciale me per indicare l'utente autenticato.

Parametri di ricerca

Parametri
maxResults

integer (uint32 format)

Numero massimo di record della cronologia da restituire. L'impostazione predefinita 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 valore startHistoryId specificato. Il valore startHistoryId fornito deve essere ottenuto dall'elemento historyId di un messaggio, di un thread o di una risposta list precedente. Gli ID cronologia aumentano cronologicamente, ma non sono contigui con lacune casuali tra gli ID validi. Se specifichi un valore 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, l'applicazione dovrebbe eseguire una sincronizzazione completa. Se non ricevi nextPageToken nella risposta, non ci sono aggiornamenti da recuperare e puoi archiviare il valore historyId restituito per una richiesta futura.
labelId

string

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

enum (HistoryType)

Tipi di cronologia che la funzione deve restituire

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 dati storici. Per qualsiasi messages contenuto nella risposta in genere vengono 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 attuale della casella 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 alle autorizzazioni.

HistoryType

Enum
messageAdded
messageDeleted
labelAdded
labelRemoved

Cronologia

Il record di una modifica alla casella di posta dell'utente. Ogni modifica della cronologia può influire su 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 casella di posta.
messages[]

object (Message)

Elenco dei messaggi modificati in questa cronologia. I campi relativi a tipi di modifiche specifici, come messagesAdded, potrebbero duplicare i messaggi in questo campo. Consigliamo di utilizzare invece questi 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 spostati nel cestino) dalla casella di posta di questa cronologia.
labelsAdded[]

object (LabelAdded)

Etichette aggiunte ai messaggi in questa cronologia.
labelsRemoved[]

object (LabelRemoved)

Etichette rimosse dai messaggi in questa 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.