REST Resource: subscriptions

{
  "name": string,
  "uid": string,
  "targetResource": string,
  "eventTypes": [
    string
  ],
  "payloadOptions": {
    object (PayloadOptions)
  },
  "notificationEndpoint": {
    object (NotificationEndpoint)
  },
  "state": enum (State),
  "suspensionReason": enum (ErrorType),
  "authority": string,
  "createTime": string,
  "updateTime": string,
  "reconciling": boolean,
  "etag": string,

  // Union field expiration can be only one of the following:
  "expireTime": string,
  "ttl": string
  // End of list of possible types for union field expiration.
}

string

Không bắt buộc. Bất biến. Giá trị nhận dạng. Tên tài nguyên của gói thuê bao.

Định dạng subscriptions/{subscription}

string

Chỉ có đầu ra. Giá trị nhận dạng duy nhất do hệ thống chỉ định cho gói thuê bao này.

string

Bắt buộc. Bất biến. Tài nguyên trên Google Workspace có chức năng giám sát các sự kiện, có định dạng là tên tài nguyên đầy đủ. Để tìm hiểu về các tài nguyên mục tiêu và những sự kiện mà các tài nguyên đó hỗ trợ, hãy xem bài viết Các sự kiện được hỗ trợ trong Google Workspace.

Người dùng chỉ có thể cho phép ứng dụng tạo một gói thuê bao cho một tài nguyên mục tiêu nhất định. Nếu ứng dụng của bạn cố gắng tạo một gói thuê bao khác có cùng thông tin đăng nhập người dùng, thì yêu cầu sẽ trả về lỗi ALREADY_EXISTS.

string

Bắt buộc. Bất biến. Danh sách không theo thứ tự. Thông tin đầu vào để tạo gói thuê bao. Nếu không, chỉ có thể xuất đầu ra. Một hoặc nhiều loại sự kiện cần nhận về tài nguyên mục tiêu. Được định dạng theo quy cách CloudEvents.

Các loại sự kiện được hỗ trợ phụ thuộc vào tài nguyên mục tiêu của gói thuê bao. Để biết thông tin chi tiết, hãy xem bài viết Các sự kiện được hỗ trợ trong Google Workspace.

Theo mặc định, bạn cũng nhận được các sự kiện về vòng đời gói thuê bao. Bạn không cần chỉ định các sự kiện trong vòng đời cho trường này.

Nếu bạn chỉ định một loại sự kiện không tồn tại cho tài nguyên mục tiêu, yêu cầu sẽ trả về một mã trạng thái HTTP 400 Bad Request.

object (PayloadOptions)

Không bắt buộc. Các lựa chọn về dữ liệu cần đưa vào tải trọng sự kiện. Chỉ hỗ trợ cho các sự kiện trong Google Chat.

object (NotificationEndpoint)

Bắt buộc. Bất biến. Điểm cuối mà gói thuê bao phân phối các sự kiện, chẳng hạn như một chủ đề Pub/Sub.

enum (State)

Chỉ có đầu ra. Trạng thái của gói thuê bao. Xác định xem gói thuê bao có thể nhận sự kiện và gửi sự kiện đó đến điểm cuối thông báo hay không.

enum (ErrorType)

Chỉ có đầu ra. Lỗi đã tạm ngưng gói thuê bao.

Để kích hoạt lại gói thuê bao, hãy khắc phục lỗi rồi gọi phương thức subscriptions.reactivate.

string

Chỉ có đầu ra. Người dùng đã cho phép tạo gói thuê bao.

Định dạng users/{user}

Đối với người dùng Google Workspace, giá trị {user} là trường user.id trong Directory API.

string (Timestamp format)

Chỉ có đầu ra. Thời điểm tạo gói thuê bao.

string (Timestamp format)

Chỉ có đầu ra. Lần gần nhất mà gói thuê bao được cập nhật.

boolean

Chỉ có đầu ra. Nếu giá trị là true, tức là gói thuê bao đang trong quá trình cập nhật.

string

Không bắt buộc. Giá trị tổng kiểm này được máy chủ tính toán dựa trên giá trị của các trường khác và có thể được gửi trong yêu cầu cập nhật để đảm bảo máy khách có giá trị đã cập nhật trước khi tiếp tục.

string (Timestamp format)

Giá trị mặc định không trống. Dấu thời gian theo giờ UTC khi gói thuê bao hết hạn. Luôn hiển thị trên đầu ra, bất kể nội dung nào được sử dụng trên đầu vào.

string (Duration format)

Chỉ nhập. Thời gian tồn tại (TTL) hoặc khoảng thời gian của gói thuê bao. Nếu bạn không chỉ định hoặc đặt thành 0, hãy sử dụng thời lượng tối đa có thể.

{
  "includeResource": boolean,
  "fieldMask": string
}

boolean

Không bắt buộc. Liệu tải trọng sự kiện có bao gồm dữ liệu về tài nguyên đã thay đổi hay không. Ví dụ: đối với một sự kiện tạo tin nhắn trong Google Chat, liệu tải trọng có chứa dữ liệu về tài nguyên Message hay không. Nếu là false, thì tải trọng sự kiện chỉ bao gồm tên của tài nguyên đã thay đổi.

string (FieldMask format)

Không bắt buộc. Nếu bạn đặt includeResource thành true, danh sách các trường cần đưa vào tải trọng sự kiện. Tách các trường bằng dấu phẩy. Ví dụ: Để thêm người gửi tin nhắn trong Google Chat và thời gian tạo, hãy nhập message.sender,message.createTime. Nếu bỏ qua, thì tải trọng sẽ bao gồm tất cả các trường cho tài nguyên.

Nếu bạn chỉ định một trường không tồn tại cho tài nguyên, hệ thống sẽ bỏ qua trường đó.

{

  // Union field endpoint can be only one of the following:
  "pubsubTopic": string
  // End of list of possible types for union field endpoint.
}

string

Bất biến. Chủ đề Cloud Pub/Sub nhận các sự kiện cho gói thuê bao.

Định dạng projects/{project}/topics/{topic}

Bạn phải tạo chủ đề trong cùng một dự án trên Google Cloud mà bạn dùng để tạo gói thuê bao này.

Khi chủ đề nhận được sự kiện, các sự kiện đó sẽ được mã hoá dưới dạng thông báo trên Cloud Pub/Sub. Để biết thông tin chi tiết, vui lòng xem bài viết Liên kết giao thức Google Cloud Pub/Sub cho CloudEvents.