- Yêu cầu HTTP
- Tham số đường dẫn
- Nội dung yêu cầu
- Nội dung phản hồi
- Phạm vi uỷ quyền
- LabelFilterAction
Thiết lập hoặc cập nhật đồng hồ thông báo đẩy trên hộp thư của người dùng cụ thể.
Yêu cầu HTTP
POST https://gmail.googleapis.com/gmail/v1/users/{userId}/watch
URL sử dụng cú pháp Chuyển mã gRPC.
Tham số đường dẫn
Các tham số | |
---|---|
userId |
Địa chỉ email của người dùng. Bạn có thể sử dụng giá trị đặc biệt |
Nội dung yêu cầu
Nội dung yêu cầu chứa dữ liệu có cấu trúc sau:
Biểu diễn dưới dạng JSON |
---|
{ "labelIds": [ string ], "labelFilterAction": enum ( |
Các trường | |
---|---|
labelIds[] |
Danh sách labelIds để hạn chế thông báo. Theo mặc định, nếu bạn không chỉ định thì tất cả thay đổi sẽ bị đẩy ra. Nếu được chỉ định, thì hệ thống sẽ chỉ ra nhãn nào là bắt buộc để tạo thông báo đẩy. |
labelFilterAction |
Đã chỉ định hành vi lọc của |
labelFilterBehavior |
Đã chỉ định hành vi lọc của |
topicName |
Tên chủ đề API Google Cloud Pub/Sub đủ điều kiện để phát hành sự kiện. Tên chủ đề này phải tồn tại trong Cloud Pub/Sub và bạn phải đã cấp quyền "xuất bản" cho Gmail. Ví dụ: "projects/my-project-identifier/topics/my-topic-name" (bằng định dạng đặt tên chủ đề "v1" trên Cloud Pub/Sub). Xin lưu ý rằng phần "my-project-identifier" phải khớp chính xác với mã dự án dành cho nhà phát triển của Google (mã thực hiện yêu cầu xem này). |
Nội dung phản hồi
Phản hồi đồng hồ thông báo đẩy.
Nếu thành công, phần nội dung phản hồi sẽ chứa dữ liệu có cấu trúc sau:
Biểu diễn dưới dạng JSON |
---|
{ "historyId": string, "expiration": string } |
Các trường | |
---|---|
historyId |
Mã của bản ghi lịch sử hiện tại của hộp thư. |
expiration |
Thời điểm Gmail ngừng gửi thông báo về thông tin cập nhật hộp thư (tính bằng mili giây thời gian bắt đầu của hệ thống). Hãy gọi lại |
Phạm vi uỷ quyền
Yêu cầu một trong các phạm vi OAuth sau:
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
Để biết thêm thông tin, hãy xem Hướng dẫn uỷ quyền.
LabelFilterAction
Hành vi lọc của danh sách labelIds đã chỉ định.
Enum | |
---|---|
include |
Chỉ nhận thông báo đẩy khi có các thay đổi về tin nhắn liên quan đến labelIds đã chỉ định. |
exclude |
Nhận thông báo đẩy về mọi thay đổi đối với thông báo, ngoại trừ những thay đổi liên quan đến labelIds đã chỉ định. |