Method: users.watch

ตั้งค่าหรืออัปเดตนาฬิกาข้อความ Push ในกล่องจดหมายของผู้ใช้ที่ระบุ

คำขอ HTTP

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

URL ใช้ไวยากรณ์การแปลง gRPC

พารามิเตอร์เส้นทาง

พารามิเตอร์
userId

string

อีเมลของผู้ใช้ สามารถใช้ค่าพิเศษ me เพื่อระบุผู้ใช้ที่ตรวจสอบสิทธิ์แล้ว

เนื้อหาของคำขอ

เนื้อหาของคำขอมีข้อมูลที่มีโครงสร้างต่อไปนี้

การแสดง JSON 
{
  "labelIds": [
    string
  ],
  "labelFilterAction": enum (LabelFilterAction),
  "labelFilterBehavior": enum (LabelFilterAction),
  "topicName": string
}
ช่อง
labelIds[]

string

รายการ labelId ที่จะจำกัดการแจ้งเตือน โดยค่าเริ่มต้น หากไม่ระบุ ระบบจะพุชการเปลี่ยนแปลงทั้งหมด หากระบุไว้ จะบ่งบอกว่าต้องใช้ป้ายกำกับใดเพื่อสร้างข้อความ Push
labelFilterAction
(deprecated)

enum (LabelFilterAction)

ระบุลักษณะการกรองของ labelIds list แล้ว ช่องนี้เลิกใช้งานแล้วเนื่องจากทำให้เกิดลักษณะการทำงานที่ไม่ถูกต้องในบางกรณี ใช้ labelFilterBehavior แทน
labelFilterBehavior

enum (LabelFilterAction)

ระบุลักษณะการกรองของ labelIds list แล้ว ช่องนี้จะแทนที่ labelFilterAction หากตั้งค่าไว้ ระบบจะไม่สนใจ labelFilterAction
topicName

string

ชื่อหัวข้อ Google Cloud Pub/Sub API ที่มีคุณสมบัติครบถ้วนสำหรับเผยแพร่เหตุการณ์ ชื่อหัวข้อนี้ต้องมีอยู่ใน Cloud Pub/Sub และคุณต้องให้สิทธิ์ "เผยแพร่" ของ Gmail แล้ว เช่น "projects/my-project-identifier/topics/my-topic-name" (โดยใช้รูปแบบการตั้งชื่อหัวข้อ Cloud Pub/Sub "v1")

โปรดทราบว่าส่วน "my-project-identifier" ต้องตรงกับรหัสโปรเจ็กต์นักพัฒนาซอฟต์แวร์ Google ของคุณ (เวอร์ชันที่ดำเนินการตามคำขอนี้)

เนื้อหาการตอบกลับ

การตอบกลับของนาฬิกาที่มีข้อความ Push

หากทำสำเร็จ เนื้อหาการตอบกลับจะมีข้อมูลซึ่งมีโครงสร้างดังต่อไปนี้

การแสดง JSON 
{
  "historyId": string,
  "expiration": string
}
ช่อง
historyId

string

รหัสของระเบียนประวัติปัจจุบันของกล่องจดหมาย
expiration

string (int64 format)

เวลาที่ Gmail จะหยุดส่งการแจ้งเตือนการอัปเดตกล่องจดหมาย (Epoch millis) โปรดโทรติดต่อ watch อีกครั้งก่อนเวลาดังกล่าวเพื่อต่ออายุนาฬิกา

ขอบเขตการให้สิทธิ์

ต้องมีขอบเขต OAuth อย่างใดอย่างหนึ่งต่อไปนี้

  • 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

โปรดดูข้อมูลเพิ่มเติมที่คู่มือการให้สิทธิ์

LabelFilterAction

ลักษณะการกรองของรายการ labelIds ที่ระบุ

Enum
include รับเฉพาะข้อความ Push สําหรับการเปลี่ยนแปลงข้อความที่เกี่ยวข้องกับ labelId ที่ระบุ
exclude รับข้อความ Push สำหรับการเปลี่ยนแปลงข้อความทั้งหมด ยกเว้นการเปลี่ยนแปลงที่เกี่ยวข้องกับ labelId ที่ระบุ