Method: users.history.list

Belirli bir posta kutusundaki tüm değişikliklerin geçmişini listeler. Geçmiş sonuçları kronolojik sırada (historyId artarak) 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

Sayfa jetonu 'nu kullanın.
startHistoryId

string

Zorunlu. Belirtilen startHistoryId tarihinden sonraki geçmiş kayıtlarını döndürür. Sağlanan startHistoryId, bir mesajın, ileti dizisinin veya önceki list yanıtının historyId özelliğinden 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 eski bir startHistoryId sağlanması 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 gerçekleştirmelidir. Yanıtta nextPageToken yoksa alınacak bir güncelleme yoktur ve döndürülen historyId değerini gelecekteki bir istekte kullanılmak üzere saklayabilirsiniz.
labelId

string

Yalnızca kimlikle eşleşen 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 herhangi bir messages genellikle yalnızca id ve threadId alanları doldurulur.
nextPageToken

string

Sayfa jetonu 'nu kullanın.
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 göz atın.

HistoryType

Sıralamalar
messageAdded
messageDeleted
labelAdded
labelRemoved

İzledikleriniz

Kullanıcının posta kutusunda yapılan değişikliklerin kaydı. Her geçmiş değişikliği, birden fazla mesajı farklı ş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. Belirli değişiklik türlerine ait alanlar (ör. messagesAdded) bu alandaki iletilerin kopyasını oluşturabilir. Bunun yerine belirli değişiklik türü alanlarını kullanmanızı öneririz.
messagesAdded[]

object (MessageAdded)

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

object (MessageDeleted)

Bu geçmiş kaydında posta kutusundan silinen (Çöp Kutusuna gönderilmeyen) iletiler.
labelsAdded[]

object (LabelAdded)

Bu geçmiş kaydındaki iletilere etiketler eklendi.
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

Etiket kimlikleri iletiden kaldırıldı.