Method: users.watch

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

Permintaan HTTP

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

URL menggunakan sintaksis gRPC Transcoding.

Parameter jalur

Parameter
userId

string

Alamat email pengguna. Nilai khusus me dapat digunakan untuk menunjukkan pengguna yang diautentikasi.

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 di-push. Jika ditentukan, label mana yang diperlukan untuk membuat notifikasi push akan ditentukan.
labelFilterAction
(deprecated)

enum (LabelFilterAction)

Perilaku pemfilteran labelIds list 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 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 telah memberikan izin "publikasi" gmail di dalamnya. Misalnya, "projects/my-project-identifier/topics/my-topic-name" (menggunakan format penamaan topik Cloud Pub/Sub "v1").

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

Isi respons

Respons smartwatch notifikasi push.

Jika berhasil, isi respons memuat data dengan struktur berikut:

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

string

ID kumpulan data histori kotak surat saat ini.
expiration

string (int64 format)

Kapan Gmail akan berhenti mengirim notifikasi untuk pembaruan kotak surat (epoch millis). Panggil watch lagi sebelum waktu ini untuk memperpanjang 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 Panduan otorisasi.

LabelFilterAction

Perilaku pemfilteran daftar labelIds ditentukan.

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