Method: users.watch

Belirtilen kullanıcı posta kutusunda bir push bildirimi kol saatini 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ıyla birlikte veriler 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. Varsayılan olarak, belirtilmezse tüm değişiklikler dışa aktarılır. Belirtilirse push bildiriminin oluşturulması için hangi etiketlerin gerekli olduğunu belirtir.
labelFilterAction
(deprecated)

enum (LabelFilterAction)

labelIds list filtreleme davranışı belirtildi. Bu alan, bazı durumlarda hatalı davranışa neden olduğu için kullanımdan kaldırılmıştır. Bunun yerine labelFilterBehavior alanını kullanın.
labelFilterBehavior

enum (LabelFilterAction)

labelIds list filtreleme davranışı belirtildi. Bu alan, labelFilterAction öğesinin yerini alı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 zaten mevcut olması zorunludur ve konu için Gmail'e "yayınlama" izni vermiş olmanız gerekir. Örneğin, "projeler/projem-tanımlayıcım/konular/konum-adı" (Cloud Pub/Sub "v1" konu adlandırma biçimi kullanılarak).

"proje-tanımlayıcım" bölümünün, Google geliştirici proje kimliğinizle (bu izleme isteğini yürüten kimlik) tam olarak eşleşmesi gerektiğini unutmayın.

Yanıt gövdesi

Push bildirimi saat 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 mevcut geçmiş kaydının kimliği.
expiration

string (int64 format)

Gmail'in, posta kutusu güncellemeleri için bildirim göndermeyi durduracağı zaman (sıfır milisaniye). Kol saatini yenilemek için bu tarihten önce tekrar watch numaralı telefonu 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ılavuzuna göz atın.

LabelFilterAction

Belirtilen labelIds listesinin filtreleme davranışı.

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 hariç tüm mesaj değişiklikleri için push bildirimleri alın.