Method: users.watch

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

Tham số
userId

string

Địa chỉ email của người dùng. Giá trị đặc biệt me có thể dùng để cho biết người dùng đã được xác thực.

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 (LabelFilterAction),
  "labelFilterBehavior": enum (LabelFilterAction),
  "topicName": string
}
Trường
labelIds[]

string

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ả các thay đổi sẽ bị đẩy ra. Nếu bạn chỉ định, thì hệ thống sẽ chỉ ra những nhãn nào cần phải có để tạo thông báo đẩy.
labelFilterAction
(deprecated)

enum (LabelFilterAction)

Đã chỉ định hành vi lọc của labelIds list. Trường này không được dùng nữa vì gây ra hành vi không chính xác trong một số trường hợp; hãy sử dụng labelFilterBehavior.
labelFilterBehavior

enum (LabelFilterAction)

Đã chỉ định hành vi lọc của labelIds list. Trường này thay thế cho labelFilterAction; nếu được đặt, labelFilterAction sẽ bị bỏ qua.
topicName

string

Tên chủ đề của API Google Cloud Pub/Sub đủ điều kiện để xuất bản 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 quyền truy cập vào nội dung đó. Ví dụ: "projects/my-project-identifier/topics/my-topic-name" (sử dụng định dạng đặt tên chủ đề "v1" của Cloud Pub/Sub).

Lưu ý rằng thuộc tính "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ã dự án thực hiện yêu cầu đồng hồ này).

Nội dung phản hồi

Phản hồi của đồng hồ có 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
}
Trường
historyId

string

Mã của bản ghi nhật ký hiện tại của hộp thư.
expiration

string (int64 format)

Khi Gmail ngừng gửi thông báo cập nhật hộp thư (mili giây). Hãy gọi lại cho watch trước thời gian này để gia hạn đồng hồ.

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 được chỉ định.

Enum
include Chỉ nhận thông báo đẩy cho những thay đổi về thông báo liên quan đến labelIds đã chỉ định.
exclude Nhận thông báo đẩy cho tất cả thay đổi về thông báo, ngoại trừ những thay đổi liên quan đến labelIds đã chỉ định.