- Żądanie HTTP
- Parametry ścieżki
- Parametry zapytania
- Treść żądania
- Treść odpowiedzi
- Zakresy autoryzacji
- HistoryType
- Historia
- MessageAdded
- MessageDeleted
- LabelAdded
- LabelRemoved
- Wypróbuj
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 |
Adres e-mail użytkownika. Do wskazywania uwierzytelnionego użytkownika można użyć wartości specjalnej |
Parametry zapytania
Parametry | |
---|---|
maxResults |
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 |
Token strony, który pozwala pobrać konkretną stronę wyników na liście. |
startHistoryId |
Wymagane. Zwraca rekordy historii po określonej wartości |
labelId |
Zwracaj tylko wiadomości z etykietą pasującą do identyfikatora. |
historyTypes[] |
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 ( |
Pola | |
---|---|
history[] |
Lista rekordów historii. Wszystkie pola |
nextPageToken |
Token strony, który pozwala pobrać następną stronę wyników na liście. |
historyId |
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 ( |
Pola | |
---|---|
id |
Identyfikator sekwencji skrzynki pocztowej. |
messages[] |
Lista wiadomości zmienionych w tym rekordzie historii. Pola określonych typów zmian, takie jak |
messagesAdded[] |
Wiadomości dodane do skrzynki pocztowej w tym rekordzie historii. |
messagesDeleted[] |
Wiadomości usunięte ze skrzynki pocztowej (nie przeniesione do kosza) w tym rekordzie historii. |
labelsAdded[] |
Etykiety dodane do wiadomości w tym rekordzie historii. |
labelsRemoved[] |
Etykiety zostały usunięte z wiadomości w tym rekordzie historii. |
MessageAdded
Zapis JSON |
---|
{
"message": {
object ( |
Pola | |
---|---|
message |
|
MessageDeleted
Zapis JSON |
---|
{
"message": {
object ( |
Pola | |
---|---|
message |
|
LabelAdded
Zapis JSON |
---|
{
"message": {
object ( |
Pola | |
---|---|
message |
|
labelIds[] |
Identyfikatory etykiet dodane do wiadomości. |
LabelRemoved
Zapis JSON |
---|
{
"message": {
object ( |
Pola | |
---|---|
message |
|
labelIds[] |
Identyfikatory etykiet zostały usunięte z wiadomości. |