- คำขอ HTTP
- พารามิเตอร์เส้นทาง
- เนื้อความของคำขอ
- เนื้อหาการตอบกลับ
- ขอบเขตการให้สิทธิ์
- LabelFilterAction
ตั้งค่าหรืออัปเดตนาฬิกาข้อความ Push ในกล่องจดหมายของผู้ใช้ที่ระบุ
คำขอ HTTP
POST https://gmail.googleapis.com/gmail/v1/users/{userId}/watch
URL ใช้ไวยากรณ์การแปลง gRPC
พารามิเตอร์เส้นทาง
พารามิเตอร์ | |
---|---|
userId |
อีเมลของผู้ใช้ สามารถใช้ค่าพิเศษ |
เนื้อหาของคำขอ
เนื้อหาของคำขอมีข้อมูลที่มีโครงสร้างต่อไปนี้
การแสดง JSON |
---|
{ "labelIds": [ string ], "labelFilterAction": enum ( |
ช่อง | |
---|---|
labelIds[] |
รายการ labelId ที่จะจำกัดการแจ้งเตือน โดยค่าเริ่มต้น หากไม่ระบุ ระบบจะพุชการเปลี่ยนแปลงทั้งหมด หากระบุไว้ จะบ่งบอกว่าต้องใช้ป้ายกำกับใดเพื่อสร้างข้อความ Push |
labelFilterAction |
ระบุลักษณะการกรองของ |
labelFilterBehavior |
ระบุลักษณะการกรองของ |
topicName |
ชื่อหัวข้อ 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 |
รหัสของระเบียนประวัติปัจจุบันของกล่องจดหมาย |
expiration |
เวลาที่ Gmail จะหยุดส่งการแจ้งเตือนการอัปเดตกล่องจดหมาย (Epoch millis) โปรดโทรติดต่อ |
ขอบเขตการให้สิทธิ์
ต้องมีขอบเขต 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 ที่ระบุ |