- Żą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 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 |
Adres e-mail użytkownika. Specjalna wartość |
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 do pobrania określonej strony z wynikami na liście. |
startHistoryId |
To pole jest wymagane. Zwraca rekordy historii po określonym obiekcie |
labelId |
Zwracaj tylko wiadomości z etykietą odpowiadającą identyfikatorowi. |
historyTypes[] |
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 ( |
Pola | |
---|---|
history[] |
Lista zapisów historii. Każdy element |
nextPageToken |
Token strony, aby 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 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 ( |
Pola | |
---|---|
id |
Identyfikator sekwencji skrzynki pocztowej. |
messages[] |
Lista wiadomości zmienionych w tym rekordzie historii. Pola określonych typów zmian, takich jak |
messagesAdded[] |
Wiadomości dodane do skrzynki pocztowej w tym rekordzie historii. |
messagesDeleted[] |
Wiadomości usunięte (nie przeniesione do kosza) ze skrzynki pocztowej 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. |