Method: users.watch

Belirtilen kullanıcı posta kutusunda push bildirimi izleme ayarını oluşturun 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. Kimliği doğrulanmış kullanıcıyı belirtmek için me özel değeri kullanılabilir.

İstek içeriği

İstek metni aşağıdaki yapıyla birlikte verileri içerir:

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

string

Bildirimleri kısıtlanacak labelId'lerin listesi. Belirtilmemişse varsayılan olarak tüm değişiklikler yayınlanır. Belirtilirse bir push bildiriminin oluşturulması için hangi etiketlerin gerekli olduğunu belirtir.
labelFilterAction
(deprecated)

enum (LabelFilterAction)

labelIds list için filtreleme davranışı belirtilmiş. Bazı durumlarda yanlış davranışa neden olduğu için bu alanın desteği sonlandırıldı. Bunun yerine labelFilterBehavior kullanın.
labelFilterBehavior

enum (LabelFilterAction)

labelIds list için filtreleme davranışı belirtilmiş. Bu alan labelFilterAction alanının 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ı Cloud Pub/Sub'da mevcut olmalıdır ve gmail için "yayınlama" iznini vermiş olmanız gerekir. Örneğin, "projects/proje-tanımlayıcım/konular/konu-adım" (Cloud Pub/Sub "v1" konu adlandırma biçimi kullanılarak).

"my-project-identifier" kısmının, Google geliştirici proje kimliğinizle (bu izleme isteğini yürüten) tam olarak eşleşmesi gerektiğini unutmayın.

Yanıt gövdesi

Push bildirimi izleme 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 (milisaniye cinsinden başlangıç zamanı). Kol saatini yenilemek için bu tarihten önce watch numaralı telefonu 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ılavuzuna bakın.

LabelFilterAction

labelIds listesinin filtreleme davranışı belirtilir.

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