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 đã cho.

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

Thông số
userId

string

Địa chỉ email của người dùng. Bạn có thể sử dụng giá trị đặc biệt me để 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 labelId để hạn chế thông báo. Theo mặc định, nếu bạn không chỉ định, tất cả các thay đổi sẽ được đẩy ra. Nếu được chỉ định, thì sẽ chỉ định những nhãn nào cần thiết để tạo thông báo đẩy.
labelFilterAction
(deprecated)

enum (LabelFilterAction)

Hành vi lọc của labelIds list được chỉ định. Trường này không còn đượ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)

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

string

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 cho Gmail quyền "xuất bản" trên chủ đề đó. 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).

Xin lưu ý rằng phần "my-project-identifier" phải khớp chính xác với mã dự án nhà phát triển của Google (mã thực thi yêu cầu xem này).

Nội dung phản hồi

Phản hồi thông báo đẩy trên đồng hồ.

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)

Thời điểm Gmail sẽ ngừng gửi thông báo về nội dung cập nhật hộp thư (theo mili giây theo hệ thống). Gọi lại watch trước thời điểm 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 các thay đổi về thông báo liên quan đến labelId được chỉ định.
exclude Nhận thông báo đẩy về tất cả thay đổi đối với tin nhắn, ngoại trừ những thay đổi liên quan đến labelId được chỉ định.