Method: users.history.list

Belirtilen posta kutusunda yapılan tüm değişikliklerin geçmişini listeler. Geçmiş sonuçları kronolojik sırayla (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. Kimliği doğrulanmış kullanıcıyı belirtmek için me özel değeri 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

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

string

Zorunlu. Belirtilen startHistoryId'ten sonraki geçmiş kayıtlarını döndürür. Sağlanan startHistoryId, bir mesajın, ileti dizisinin veya önceki list yanıtın historyId öğesinden alınmalıdır. Geçmiş kimlikleri kronolojik olarak artar ancak geçerli kimlikler arasında rastgele boşluklar bulunur. Geçersiz veya güncel olmayan bir startHistoryId göndermek genellikle HTTP 404 hata kodu döndürür. historyId genellikle en az bir hafta 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 yapmalıdır. Yanıtta nextPageToken yoksa alınabilecek güncelleme yoktur ve döndürülen historyId değerini gelecekteki bir istek için saklayabilirsiniz.
labelId

string

Yalnızca kimlikle eşleşen bir etikete sahip iletileri döndürme.
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 tüm messages'lerde genellikle yalnızca id ve threadId alanları doldurulur.
nextPageToken

string

Listede sonraki sayfanın sonuçlarını almak için sayfa jetonu.
historyId

string

Posta kutusunun mevcut 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ılavuzuna bakın.

HistoryType

Sıralamalar
messageAdded
messageDeleted
labelAdded
labelRemoved

Geçmiş

Kullanıcının posta kutusunda yapılan bir değişikliğin kaydı. Her geçmiş değişikliği, birden fazla mesajı birden fazla şekilde 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. messagesAdded gibi belirli değişiklik türlerine ait alanlar, bu alandaki mesajları kopyalayabilir. Bunun yerine belirli değişiklik türü alanlarını kullanmanızı öneririz.
messagesAdded[]

object (MessageAdded)

Bu geçmiş kaydında posta kutusuna eklenen mesajlar.
messagesDeleted[]

object (MessageDeleted)

Bu geçmiş kaydındaki posta kutusundan silinen (Çöp Kutusu'na taşınmayan) mesajlar.
labelsAdded[]

object (LabelAdded)

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

object (LabelRemoved)

Bu geçmiş kaydındaki iletilerden kaldırılan etiketler.

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

İletilere eklenen etiket kimlikleri.

LabelRemoved

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

object (Message)
labelIds[]

string

İletideki etiket kimlikleri kaldırıldı.