Method: users.history.list

Zawiera historię wszystkich zmian wprowadzonych w danej skrzynce pocztowej. Wyniki historii są zwracane w kolejności chronologicznej (rosnąco według wartości 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 rekordów historii do zwrócenia. Domyślna wartość tego pola to 100. Maksymalna dozwolona wartość tego pola to 500.
pageToken

string

Token strony umożliwiający pobranie konkretnej strony wyników na liście.
startHistoryId

string

Wymagane. Zwraca rekordy historii po określonym startHistoryId. Podany identyfikator startHistoryId powinien pochodzić z pola historyId wiadomości, wątku lub poprzedniej odpowiedzi list. Identyfikatory historii są zwiększane chronologicznie, ale nie są ciągłe, ponieważ między prawidłowymi identyfikatorami występują losowe przerwy. Podanie nieprawidłowego lub nieaktualnego startHistoryId zwykle zwraca kod błędu HTTP 404. historyId jest zwykle ważny przez co najmniej tydzień, ale w rzadkich przypadkach może być ważny tylko przez kilka godzin. Jeśli otrzymasz odpowiedź z błędem HTTP 404, aplikacja powinna przeprowadzić pełną synchronizację. Jeśli w odpowiedzi nie ma żadnych nextPageToken, oznacza to, że nie ma żadnych aktualizacji do pobrania. Możesz zapisać zwrócony element historyId na potrzeby przyszłego żądania.
labelId

string

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

enum (HistoryType)

Typy historii, które mają być 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. Każdy element messages w odpowiedzi będzie zwykle zawierać tylko wypełnione 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 sekcji OAuth 2.0 Overview.

HistoryType

Wartości w polu enum
messageAdded
messageDeleted
labelAdded
labelRemoved

Historia

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

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 konkretnych typów zmian, np. messagesAdded, mogą duplikować wiadomości w tym polu. Zamiast tego zalecamy używanie pól dotyczących konkretnego typu zmiany.
messagesAdded[]

object (MessageAdded)

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

object (MessageDeleted)

Wiadomości usunięte (nie przeniesione do Kosza) ze 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 dodanych do wiadomości.

LabelRemoved

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

object (Message)
labelIds[]

string

Identyfikatory etykiet usunięte z wiadomości.