Method: users.history.list

Wyświetla historię wszystkich zmian wprowadzonych w danej skrzynce pocztowej. Wyniki z historii są zwracane w kolejności chronologicznej (rosnąco 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. Specjalna wartość me może służyć do wskazania uwierzytelnionego użytkownika.

Parametry zapytania

Parametry
maxResults

integer (uint32 format)

Maksymalna liczba rekordów historii do zwrócenia. Domyślna wartość w tym polu to 100. Maksymalna dozwolona wartość w tym polu to 500.

pageToken

string

Token strony do pobrania określonej strony z wynikami na liście.

startHistoryId

string

To pole jest wymagane. Zwraca rekordy historii po określonym obiekcie startHistoryId. Podany startHistoryId powinien zostać uzyskany z parametru historyId wiadomości, wątku lub poprzedniej odpowiedzi list. Identyfikatory historyczne zwiększają się chronologicznie, ale nie przylegają do siebie, a między prawidłowymi identyfikatorami są losowe przerwy. Podanie nieprawidłowego lub nieaktualnego kodu startHistoryId zazwyczaj zwraca kod błędu HTTP 404. historyId jest zwykle ważny przez co najmniej tydzień, ale w niektórych przypadkach może być ważny tylko przez kilka godzin. Jeśli otrzymasz odpowiedź o błędzie HTTP 404, aplikacja powinna przeprowadzić pełną synchronizację. Jeśli w odpowiedzi nie otrzymasz żadnego parametru nextPageToken, oznacza to, że nie ma żadnych aktualizacji do pobrania. Zwrócony plik historyId możesz zapisać na potrzeby przyszłego żądania.

labelId

string

Zwracaj tylko wiadomości z etykietą odpowiadającą identyfikatorowi.

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 zapisów historii. Każdy element messages zawarty w odpowiedzi będzie miał zwykle wypełnione tylko pola id i threadId.

nextPageToken

string

Token strony, aby pobrać następną stronę 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 po autoryzacji.

HistoryType

Wartości w polu enum
messageAdded
messageDeleted
labelAdded
labelRemoved

Historia

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

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 określonych typów zmian, takich jak messagesAdded, mogą spowodować duplikowanie wiadomości. Zamiast tego zalecamy użycie konkretnych pól 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 zostały 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

Identyfikatory etykiet zostały usunięte z wiadomości.