Method: users.history.list

Wyświetla historię wszystkich zmian w danej skrzynce pocztowej. Wyniki historii są zwracane w kolejności chronologicznej (rosnącej historyId).

Żądanie HTTP

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

Adres URL używa składni transkodowania gRPC.

Parametry ścieżki

Parametry
userId

string

Adres e-mail użytkownika. Wartość specjalna me może służyć do wskazywania uwierzytelnionego użytkownika.

Parametry zapytania

Parametry
maxResults

integer (uint32 format)

Maksymalna liczba zwracanych rekordów historii. Domyślna wartość tego pola to 100. Maksymalna dozwolona wartość tego pola to 500.
pageToken

string

token strony, aby pobrać określoną stronę wyników na liście;
startHistoryId

string

Wymagane. Zwraca rekordy historyczne po określonym startHistoryId. Podany identyfikator startHistoryId powinien pochodzić z historyId wiadomości, wątku lub poprzedniej odpowiedzi list. Identyfikatory historii są numerowane chronologicznie, ale nie są ciągłe, ponieważ występują między nimi losowe przerwy. Podanie nieprawidłowego lub nieaktualnego elementu startHistoryId powoduje zwrócenie kodu błędu HTTP 404. historyId jest zwykle ważny przez co najmniej tydzień, ale w niektórych wyjątkowych przypadkach może być ważny tylko przez kilka godzin. Jeśli otrzymasz odpowiedź z błędem HTTP 404, aplikacja powinna wykonać pełną synchronizację. Jeśli w odpowiedzi nie ma wartości nextPageToken, oznacza to, że nie ma żadnych aktualizacji do pobrania. Możesz jednak zapisać zwróconą wartość historyId na potrzeby przyszłego żądania.
labelId

string

Zwracaj tylko wiadomości z etykietą pasującą do identyfikatora.
historyTypes[]

enum (HistoryType)

Typy historii zwracane przez funkcję

Treść żądania

Treść żądania musi być pusta.

Treść odpowiedzi

W przypadku powodzenia treść żądania zawiera dane o następującej strukturze:

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

object (History)

Lista rekordów historii. W przypadku dowolnego elementu messages zawartego w odpowiedzi zwykle wypełnione są tylko pola id i threadId.
nextPageToken

string

Token strony do pobrania następnej strony wyników na liście.
historyId

string

Identyfikator bieżącego rekordu historii skrzynki pocztowej.

Zakresy autoryzacji

Wymaga jednego z tych zakresów 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

Więcej informacji znajdziesz w przewodniku dotyczącym autoryzacji.

HistoryType

Wartości w polu enum
messageAdded
messageDeleted
labelAdded
labelRemoved

Historia

Rekord zmiany skrzynki pocztowej użytkownika. Każda zmiana historii może wpływać na wiele wiadomości na wiele sposobów.

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

string

Identyfikator sekwencji skrzynki pocztowej.
messages[]

object (Message)

Lista wiadomości zmienionych w tym rekordzie historii. Pola dotyczące określonych typów zmian, np. messagesAdded, mogą zawierać zduplikowane komunikaty. Zamiast tego zalecamy użycie odpowiednich pól typu zmiany.
messagesAdded[]

object (MessageAdded)

Wiadomości dodane do skrzynki pocztowej w tym rekordzie historii.
messagesDeleted[]

object (MessageDeleted)

Wiadomości usunięte (a nie przeniesione do Kosza) z skrzynki pocztowej w tym rekordzie historii.
labelsAdded[]

object (LabelAdded)

Etykiety dodane do wiadomości w tym rekordzie historii.
labelsRemoved[]

object (LabelRemoved)

Etykiety usunięte z wiadomości w tym rekordzie historii.

MessageAdded

Zapis JSON 
{
  "message": {
    object (Message)
  }
}
Pola
message

object (Message)

MessageDeleted

Zapis JSON 
{
  "message": {
    object (Message)
  }
}
Pola
message

object (Message)

LabelAdded

Zapis JSON 
{
  "message": {
    object (Message)
  },
  "labelIds": [
    string
  ]
}
Pola
message

object (Message)
labelIds[]

string

identyfikatory etykiet dodane do wiadomości.

LabelRemoved

Zapis JSON 
{
  "message": {
    object (Message)
  },
  "labelIds": [
    string
  ]
}
Pola
message

object (Message)
labelIds[]

string

z wiadomości usunięto identyfikatory etykiet;