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

รายการ labelIds เพื่อจำกัดการแจ้งเตือน หากไม่ระบุโดยค่าเริ่มต้น ระบบจะพุชการเปลี่ยนแปลงทั้งหมด หากระบุไว้ จะกำหนดว่าป้ายกำกับใดที่จำเป็นสำหรับการสร้างข้อความ 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 ที่ระบุ