Method: users.history.list

Belirli bir 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

Listedeki belirli bir sonuç sayfasını almak için kullanılan 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 bir list yanıtının historyId bölümünden alınmalıdır. Geçmiş kimlikleri kronolojik olarak artar ancak geçerli kimlikler arasında rastgele boşluklar olduğundan bitişik değildir. Geçersiz veya güncel olmayan bir startHistoryId sağlamak genellikle HTTP 404 hata kodunu döndürür. historyId genellikle en az bir hafta geçerlidir ancak 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ıt içinde nextPageToken almazsanız alınacak güncelleme yoktur ve döndürülen historyId öğesini gelecekteki bir istek için saklayabilirsiniz.
labelId

string

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

enum (HistoryType)

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

İstek metni

İ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 genellikle yalnızca id ve threadId alanlarını doldurur.
nextPageToken

string

Listedeki sonuçların sonraki sayfasını almak için kullanılan 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 OAuth 2.0 Overview sayfasına bakın.

HistoryType

Sıralamalar
messageAdded
messageDeleted
labelAdded
labelRemoved

Geçmiş

Kullanıcının posta kutusunda yapılan değişikliklerin 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ı kopyalayabilir. Bunun yerine, değişikliğin türüne özel alanları kullanmanızı öneririz.
messagesAdded[]

object (MessageAdded)

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

object (MessageDeleted)

Bu geçmiş kaydında, posta kutusundan silinen (çöp kutusuna taşınmayan) iletiler.
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

İletiye eklenen etiket kimlikleri.

LabelRemoved

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

object (Message)
labelIds[]

string

İletiden kaldırılan etiket kimlikleri.