Method: users.history.list

Belirtilen posta kutusunda yapılan tüm değişikliklerin geçmişini listeler. Geçmiş sonuçları kronolojik sırada (artan historyId) döndürülür.

HTTP isteği

GET https://gmail.googleapis.com/gmail/v1/users/{userId}/history

URL, gRPC Kod Dönüştürme söz dizimini kullanır.

Yol parametreleri

Parametreler
userId

string

Kullanıcının e-posta adresi. me özel değeri, kimliği doğrulanmış kullanıcıyı belirtmek için kullanılabilir.

Sorgu parametreleri

Parametreler
maxResults

integer (uint32 format)

Döndürülecek maksimum geçmiş kaydı sayısı. Bu alanın varsayılan değeri 100'dür. Bu alan için izin verilen maksimum değer 500'dür.
pageToken

string

Listedeki belirli bir sonuç sayfasını almak için sayfa jetonu.
startHistoryId

string

Zorunlu. Belirtilen startHistoryId tarihinden sonraki geçmiş kayıtlarını döndürür. Sağlanan startHistoryId, bir iletinin, ileti dizisinin veya önceki list yanıtının historyId öğesinden alınmalıdır. Geçmiş kimlikleri kronolojik olarak artar ancak geçerli kimlikler arasında rastgele boşluklarla bitişik değildir. Geçersiz veya güncel olmayan bir startHistoryId sağlamak genellikle HTTP 404 hata kodu döndürür. historyId, genellikle en az bir hafta boyunca geçerlidir ancak bazı nadir durumlarda yalnızca birkaç saat geçerli olabilir. HTTP 404 hata yanıtı alırsanız uygulamanız tam senkronizasyon gerçekleştirmelidir. Yanıtta nextPageToken almazsanız alınacak güncelleme olmaz ve döndürülen historyId öğesini gelecekteki bir istek için depolayabilirsiniz.
labelId

string

Yalnızca kimlikle eşleşen bir etikete sahip iletileri döndür.
historyTypes[]

enum (HistoryType)

İşlev tarafından döndürülecek geçmiş türleri

İstek içeriği

İstek metni boş olmalıdır.

Yanıt gövdesi

Başarılı olursa yanıt metni aşağıdaki yapıyla birlikte verileri içerir:

JSON gösterimi 
{
  "history": [
    {
      object (History)
    }
  ],
  "nextPageToken": string,
  "historyId": string
}
Alanlar
history[]

object (History)

Geçmiş kayıtlarının listesi. Yanıtta yer alan messages öğelerinde genellikle yalnızca id ve threadId alanları doldurulur.
nextPageToken

string

Listedeki sonuçların sonraki sayfasını almak için sayfa jetonu.
historyId

string

Posta kutusunun şu anki geçmiş kaydının kimliği.

Yetkilendirme kapsamları

Aşağıdaki OAuth kapsamlarından birini gerektirir:

  • 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

Daha fazla bilgi için Yetkilendirme kılavuzunu inceleyin.

HistoryType

Sıralamalar
messageAdded
messageDeleted
labelAdded
labelRemoved

Geçmiş

Kullanıcının posta kutusunda yapılan bir değişikliğin kaydı. Geçmişteki her değişiklik birden fazla mesajı çeşitli şekillerde etkileyebilir.

JSON gösterimi 
{
  "id": string,
  "messages": [
    {
      object (Message)
    }
  ],
  "messagesAdded": [
    {
      object (MessageAdded)
    }
  ],
  "messagesDeleted": [
    {
      object (MessageDeleted)
    }
  ],
  "labelsAdded": [
    {
      object (LabelAdded)
    }
  ],
  "labelsRemoved": [
    {
      object (LabelRemoved)
    }
  ]
}
Alanlar
id

string

Posta kutusu sıra kimliği.
messages[]

object (Message)

Bu geçmiş kaydında değiştirilen mesajların listesi. Belirli değişiklik türlerine ait alanlar (ör. messagesAdded), bu alandaki mesajların tekrarlanmasını sağlayabilir. Bunun yerine, spesifik değişiklik türü alanlarını kullanmanızı öneririz.
messagesAdded[]

object (MessageAdded)

İletiler, bu geçmiş kaydındaki posta kutusuna eklendi.
messagesDeleted[]

object (MessageDeleted)

Bu geçmiş kaydındaki posta kutusundan silinen (Çöp Kutusu'nda değil) iletiler.
labelsAdded[]

object (LabelAdded)

Bu geçmiş kaydındaki iletilere etiketler eklendi.
labelsRemoved[]

object (LabelRemoved)

Etiketler, bu geçmiş kaydındaki iletilerden kaldırıldı.

MessageAdded

JSON gösterimi 
{
  "message": {
    object (Message)
  }
}
Alanlar
message

object (Message)

MessageDeleted

JSON gösterimi 
{
  "message": {
    object (Message)
  }
}
Alanlar
message

object (Message)

LabelAdded

JSON gösterimi 
{
  "message": {
    object (Message)
  },
  "labelIds": [
    string
  ]
}
Alanlar
message

object (Message)
labelIds[]

string

İletiye eklenen etiket kimlikleri.

LabelRemoved

JSON gösterimi 
{
  "message": {
    object (Message)
  },
  "labelIds": [
    string
  ]
}
Alanlar
message

object (Message)
labelIds[]

string

Etiket kimlikleri iletiden kaldırıldı.