Method: users.history.list

Wyświetla historię wszystkich zmian w danej skrzynce pocztowej. Wyniki z historii są wyświetlane w kolejności chronologicznej (rosnąco o 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. Do wskazywania uwierzytelnionego użytkownika można użyć wartości specjalnej me.

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, który pozwala pobrać konkretną stronę wyników na liście.
startHistoryId

string

Wymagane. Zwraca rekordy historii po określonej wartości startHistoryId. Podaną wartość startHistoryId należy uzyskać z wywołania historyId wiadomości, wątku lub poprzedniej odpowiedzi list. Identyfikatory historii zwiększają się chronologicznie, ale nie sąsiadują z losowymi lukami między prawidłowymi identyfikatorami. Podanie nieprawidłowego lub nieaktualnego atrybutu startHistoryId zwykle 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 żądania nextPageToken, nie ma żadnych aktualizacji do pobrania i możesz zapisać zwrócone dane historyId na potrzeby przyszłego żądania.
labelId

string

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

enum (HistoryType)

Typy historii, które funkcja ma zwrócić

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. Wszystkie pola messages zawarte w odpowiedzi będą zwykle wypełnione tylko w polach id i threadId.
nextPageToken

string

Token strony, który pozwala 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 protokołu 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 na temat autoryzacji.

HistoryType

Wartości w polu enum
messageAdded
messageDeleted
labelAdded
labelRemoved

Historia

Rejestr zmian w skrzynce pocztowej użytkownika. Każda zmiana w historii może mieć wpływ 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 określonych typów zmian, takie jak messagesAdded, mogą powodować duplikowanie wiadomości w tym polu. Zamiast tego zalecamy używanie 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 ze skrzynki pocztowej (nie przeniesione do kosza) 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.