Method: users.watch

Belirtilen kullanıcı posta kutusunda bir push bildirimi kol saati ayarlayın veya güncelleyin.

HTTP isteği

POST https://gmail.googleapis.com/gmail/v1/users/{userId}/watch

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.

İstek içeriği

İstek gövdesi aşağıdaki yapıya sahip verileri içerir:

JSON gösterimi 
{
  "labelIds": [
    string
  ],
  "labelFilterAction": enum (LabelFilterAction),
  "labelFilterBehavior": enum (LabelFilterAction),
  "topicName": string
}
Alanlar
labelIds[]

string

Bildirimlerin kısıtlanacağı labelId'lerin listesi. Belirtilmemesi durumunda varsayılan olarak tüm değişiklikler aktarılır. Belirtilirse push bildiriminin oluşturulması için hangi etiketlerin gerekli olduğunu belirtir.
labelFilterAction
(deprecated)

enum (LabelFilterAction)

labelIds list için filtreleme davranışı belirtildi. Bazı durumlarda yanlış davranışa yol açtığı için bu alan kullanımdan kaldırılmıştır. bunun yerine labelFilterBehavior kullanın.
labelFilterBehavior

enum (LabelFilterAction)

labelIds list için filtreleme davranışı belirtildi. Bu alan, labelFilterAction alanının yerini almıştır; ayarlanırsa labelFilterAction yoksayılır.
topicName

string

Etkinliklerin yayınlanacağı tam nitelikli Google Cloud Pub/Sub API konu adı. Bu konu adının Cloud Pub/Sub'da mevcut olması gerekir ve Gmail'e "yayınla" izni vermiş olmanız gerekir. üzerinde değişiklik yapılamaz. Örneğin, "projeler/projem-tanımlayıcı/konular/konu-adım" (Cloud Pub/Sub "v1" konu adlandırma biçimi kullanılarak).

"my-project-identifier" değerinin bölümü, Google geliştirici proje kimliğinizle (bu izleme isteğini yürüten kimlik) tam olarak eşleşmelidir.

Yanıt gövdesi

Push bildirimi kol saati yanıtı.

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

JSON gösterimi 
{
  "historyId": string,
  "expiration": string
}
Alanlar
historyId

string

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

string (int64 format)

Gmail'in, posta kutusu güncellemeleri için bildirim göndermeye son vereceği zaman (epoch milisaniye). Kol saatini yenilemek için bu tarihten önce watch adlı kişiyi tekrar arayın.

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.

LabelFilterAction

Etiket kimliği listesinin filtreleme davranışı belirtildi.

Sıralamalar
include Yalnızca belirtilen labelId'lerle ilgili mesaj değişiklikleri için push bildirimleri alın.
exclude Belirtilen labelId'lerle ilgili olanlar dışındaki tüm mesaj değişiklikleri için push bildirimleri alın.