Method: users.watch

Thiết lập hoặc cập nhật thông báo đẩy cho 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ể dùng giá trị đặc biệt me để cho biết người dùng đã xác thực.

Nội dung yêu cầu

Nội dung yêu cầu chứa dữ liệu với 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ẽ được đẩy ra. Nếu được chỉ định, thì sẽ quyết định những nhãn nào cần thiết để 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ế labelFilterAction; nếu bạn đặt trường này, labelFilterAction sẽ bị bỏ qua.
topicName

string

Tên chủ đề đầy đủ của API Google Cloud Pub/Sub để xuất bản các 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 của nhà phát triển trên Google (mã dự án thực hiện yêu cầu này trên đồng hồ).

Nội dung phản hồi

Trả lờ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 ngừng gửi thông báo về nội dung cập nhật hộp thư (mili giây kể từ thời điểm bắt đầu). Hãy gọi lại 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 OAuth 2.0 Overview.

LabelFilterAction

Đã chỉ định hành vi lọc của danh sách labelIds.

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 được chỉ định.
exclude Nhận thông báo đẩy cho tất cả thay đổi về tin nhắn, ngoại trừ những thay đổi liên quan đến labelIds được chỉ định.