Method: users.watch

Menyiapkan atau memperbarui pengamatan notifikasi push di kotak surat pengguna tertentu.

Permintaan HTTP

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

URL ini menggunakan sintaksis gRPC Transcoding.

Parameter jalur

Parameter
userId

string

Alamat email pengguna. Nilai khusus me dapat digunakan untuk menunjukkan pengguna terautentikasi.

Isi permintaan

Isi permintaan memuat data dengan struktur berikut:

Representasi JSON 
{
  "labelIds": [
    string
  ],
  "labelFilterAction": enum (LabelFilterAction),
  "labelFilterBehavior": enum (LabelFilterAction),
  "topicName": string
}
Kolom
labelIds[]

string

Daftar labelId untuk membatasi notifikasi. Secara default, jika tidak ditentukan, semua perubahan akan didorong. Jika ditentukan, maka akan menentukan label mana yang diperlukan agar notifikasi push dapat dibuat.
labelFilterAction
(deprecated)

enum (LabelFilterAction)

Perilaku pemfilteran labelIds list yang ditentukan. Kolom ini tidak digunakan lagi karena menyebabkan perilaku yang salah dalam beberapa kasus; sebagai gantinya, gunakan labelFilterBehavior.
labelFilterBehavior

enum (LabelFilterAction)

Perilaku pemfilteran labelIds list yang ditentukan. Kolom ini menggantikan labelFilterAction; jika ditetapkan, labelFilterAction akan diabaikan.
topicName

string

Nama topik Google Cloud Pub/Sub API yang sepenuhnya memenuhi syarat untuk memublikasikan peristiwa. Nama topik ini harus sudah ada di Cloud Pub/Sub dan Anda harus sudah memberikan izin "publish" kepada Gmail di topik tersebut. Misalnya, "projects/my-project-identifier/topics/my-topic-name" (menggunakan format penamaan topik "v1" Cloud Pub/Sub).

Perhatikan bahwa bagian "my-project-identifier" harus sama persis dengan ID project developer Google Anda (yang menjalankan permintaan menonton ini).

Isi respons

Respons smartwatch untuk notifikasi push.

Jika berhasil, isi respons memuat data dengan struktur berikut:

Representasi JSON 
{
  "historyId": string,
  "expiration": string
}
Kolom
historyId

string

ID catatan histori saat ini dari kotak surat.
expiration

string (int64 format)

Kapan Gmail akan berhenti mengirim notifikasi untuk pembaruan kotak surat (epoch millis). Panggil watch lagi sebelum waktu ini untuk memperpanjang masa berlaku smartwatch.

Cakupan otorisasi

Memerlukan salah satu cakupan OAuth berikut:

  • 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

Untuk mengetahui informasi selengkapnya, lihat OAuth 2.0 Overview.

LabelFilterAction

Perilaku pemfilteran daftar labelIds ditentukan.

Enum
include Hanya menerima notifikasi push untuk perubahan pesan yang terkait dengan labelId yang ditentukan.
exclude Mendapatkan notifikasi push untuk semua perubahan pesan kecuali yang terkait dengan labelId yang ditentukan.