Thông báo tự động

Tài liệu này mô tả cách dùng thông báo đẩy để thông báo cho ứng dụng khi tài nguyên thay đổi.

Tổng quan

API Thư mục cung cấp thông báo đẩy cho phép bạn theo dõi những thay đổi về tài nguyên. Bạn có thể sử dụng tính năng này để cải thiện hiệu suất của ứng dụng. Tính năng này cho phép bạn loại bỏ mạng bổ sung và tính toán chi phí liên quan đến các tài nguyên thăm dò ý kiến để xác định xem các tài nguyên đó có thay đổi hay không. Bất cứ khi nào tài nguyên đã xem thay đổi, Directory API sẽ thông báo cho ứng dụng của bạn.

Để sử dụng thông báo đẩy, bạn phải làm 2 việc sau:

  • Thiết lập URL nhận hoặc trình nhận lệnh gọi lại "webhook".

    Đây là một máy chủ HTTPS xử lý các thông báo thông báo API được kích hoạt khi một tài nguyên thay đổi.

  • Thiết lập kênh thông báo cho từng điểm cuối tài nguyên mà bạn muốn xem.

    Kênh chỉ định thông tin định tuyến cho nội dung thông báo. Trong quá trình thiết lập kênh, bạn phải xác định URL cụ thể mà bạn muốn nhận thông báo. Bất cứ khi nào tài nguyên của kênh thay đổi, Directory API sẽ gửi một thông báo dưới dạng yêu cầu POST đến URL đó.

Hiện tại, API Thư mục hỗ trợ thông báo về những thay đổi đối với tài nguyên Người dùng.

Tạo kênh thông báo

Để yêu cầu thông báo đẩy, bạn phải thiết lập kênh thông báo cho từng tài nguyên bạn muốn theo dõi. Sau khi bạn thiết lập kênh thông báo, Directory API sẽ thông báo cho ứng dụng của bạn khi có bất kỳ thay đổi nào đối với tài nguyên đã xem.

Đưa ra yêu cầu xem

Mỗi tài nguyên API Thư mục có thể xem đều có một phương thức watch liên kết tại URI có dạng sau:

https://www.googleapis.com/API_NAME/API_VERSION/RESOURCE_PATH/watch

Để thiết lập kênh thông báo cho các thông báo về thay đổi đối với một tài nguyên cụ thể, hãy gửi yêu cầu POST đến phương thức watch cho tài nguyên đó.

Mỗi kênh thông báo được liên kết với cả một người dùng cụ thể và một tài nguyên (hoặc nhóm tài nguyên) cụ thể. Yêu cầu watch sẽ không thành công trừ phi người dùng hoặc tài khoản dịch vụ hiện tại sở hữu hoặc có quyền truy cập vào tài nguyên này.

Ví dụ

Tất cả các yêu cầu xem cho tài nguyên User trong một miền đều có dạng chung:

POST https://admin.googleapis.com/admin/directory/v1/users/watch?domain=domain&event=event
Authorization: Bearer auth_token_for_current_user
Content-Type: application/json

{
  "id": "01234567-89ab-cdef-0123456789ab", // Your channel ID.
  "type": "web_hook",
  "address": "https://mydomain.com/notifications", // Your receiving URL.
  ...
  "token": "target=myApp-myFilesChannelDest", // (Optional) Your channel token.
  "params": {
    "ttl": 3600 // (Optional) Your requested time-to-live for this channel.
  }
}

Sử dụng thông số domain và event để chỉ định miền và loại sự kiện mà bạn muốn nhận thông báo.

Tất cả các yêu cầu đồng hồ về tài nguyên Người dùng cho khách hàng đều có biểu mẫu chung:

POST https://admin.googleapis.com/admin/directory/users/v1/watch?customer=customer&event=event
Authorization: Bearer auth_token_for_current_user
Content-Type: application/json

{
  "id": "01234567-89ab-cdef-0123456789ab", // Your channel ID.
  "type": "web_hook",
  "address": "https://mydomain.com/notifications", // Your receiving URL.
  ...
  "token": "target=myApp-myFilesChannelDest", // (Optional) Your channel token.
  "params": {
    "ttl": 3600 // (Optional) Your requested time-to-live for this channel.
  }
}

Sử dụng các thông số customer và event để chỉ định mã nhận dạng duy nhất cho Tài khoản Google của khách hàng và loại sự kiện mà bạn muốn nhận thông báo.

event có thể có các giá trị sau:

  • add: sự kiện do người dùng tạo
  • delete: sự kiện do người dùng xoá
  • makeAdmin: sự kiện thay đổi trạng thái quản trị viên của người dùng
  • undelete: sự kiện đã huỷ xoá người dùng
  • update: sự kiện do người dùng cập nhật

Lưu ý: Các ví dụ sau đây bỏ qua phần nội dung yêu cầu để đảm bảo sự rõ ràng.

Theo dõi các sự kiện do người dùng tạo cho miền mydomain.com:

POST https://admin.googleapis.com/admin/directory/v1/users/watch?domain=mydomain.com&event=add

Theo dõi các sự kiện do người dùng tạo cho khách hàng my_customer:

POST https://admin.googleapis.com/admin/directory/v1/users/watch?customer=my_customer&event=add

Thuộc tính bắt buộc

Với mỗi yêu cầu watch, bạn phải cung cấp các trường sau:

  • Một chuỗi thuộc tính id nhận dạng duy nhất kênh thông báo mới này trong dự án của bạn. Bạn nên dùng một giá trị nhận dạng duy nhất trên toàn cầu (UUID) hoặc bất kỳ chuỗi duy nhất nào tương tự. Độ dài tối đa: 64 ký tự.

    Giá trị mã nhận dạng bạn đặt sẽ được lặp lại trong tiêu đề HTTP X-Goog-Channel-Id của mọi thông báo mà bạn nhận được cho kênh này.

  • Chuỗi thuộc tính type được đặt thành giá trị web_hook.

  • Chuỗi thuộc tính address được đặt thành URL theo dõi và phản hồi thông báo cho kênh thông báo này. Đây là URL gọi lại webhook và phải sử dụng HTTPS.

    Xin lưu ý rằng Directory API chỉ có thể gửi thông báo đến địa chỉ HTTPS này nếu có một chứng chỉ SSL hợp lệ được cài đặt trên máy chủ web của bạn. Chứng chỉ không hợp lệ bao gồm:

    • Chứng chỉ tự ký.
    • Chứng chỉ do một nguồn không đáng tin cậy ký.
    • Chứng chỉ đã bị thu hồi.
    • Các chứng chỉ có tiêu đề không khớp với tên máy chủ đích.

Thuộc tính tuỳ chọn

Bạn cũng có thể chỉ định các trường không bắt buộc này bằng yêu cầu watch:

  • Thuộc tính token chỉ định một giá trị chuỗi tuỳ ý để dùng làm mã thông báo kênh. Bạn có thể dùng mã thông báo kênh cho nhiều mục đích. Ví dụ: bạn có thể sử dụng mã thông báo để xác minh rằng mỗi tin nhắn đến đều dành cho một kênh mà ứng dụng của bạn đã tạo – để đảm bảo rằng thông báo không bị giả mạo – hoặc để chuyển thông báo đến đúng đích đến trong ứng dụng dựa trên mục đích của kênh này. Độ dài tối đa: 256 ký tự.

    Mã thông báo này được đưa vào tiêu đề HTTP X-Goog-Channel-Token trong mọi thông báo mà ứng dụng của bạn nhận được cho kênh này.

    Nếu sử dụng mã thông báo kênh, bạn nên:

    • Sử dụng định dạng mã hoá có thể mở rộng, chẳng hạn như tham số truy vấn URL. Ví dụ: forwardTo=hr&createdBy=mobile

    • Không gửi dữ liệu nhạy cảm như mã thông báo OAuth.

  • Chuỗi thuộc tính expiration được đặt thành Dấu thời gian Unix (tính bằng mili giây) ngày và giờ mà bạn muốn API Thư mục ngừng gửi thông báo cho kênh thông báo này.

    Nếu một kênh có thời gian hết hạn, thì kênh đó sẽ được đưa vào dưới dạng giá trị của tiêu đề HTTP X-Goog-Channel-Expiration (ở định dạng mà con người có thể đọc được) trong mọi thông báo mà ứng dụng của bạn nhận được cho kênh này.

Để biết thêm thông tin chi tiết về yêu cầu, hãy tham khảo phương thức watch cho tài nguyên Người dùng trong Tài liệu tham khảo API.

Xem phản hồi

Nếu yêu cầu watch tạo thành công một kênh thông báo, thì yêu cầu sẽ trả về một mã trạng thái HTTP 200 OK.

Nội dung thông báo của phản hồi trên đồng hồ cung cấp thông tin về kênh thông báo bạn vừa tạo, như trong ví dụ dưới đây.

{
  "kind": "api#channel",
  "id": "01234567-89ab-cdef-0123456789ab", // ID you specified for this channel.
  "resourceId": "B4ibMJiIhTjAQd7Ff2K2bexk8G4", // ID of the watched resource.
  "resourceUri": "https://admin.googleapis.com/admin/directory/v1/users?domain=domain&event=event", // Version-specific ID of the watched resource.
  "token": "target=myApp-myFilesChannelDest", // Present only if one was provided.
  "expiration": 1384823632000, // Actual expiration time as Unix timestamp (in ms), if applicable.
}

Ngoài các thuộc tính mà bạn đã gửi theo yêu cầu, thông tin được trả về cũng bao gồm resourceId và resourceUri để xác định tài nguyên đang được xem trên kênh thông báo này.

Bạn có thể truyền thông tin được trả về đến các thao tác khác trên kênh thông báo, chẳng hạn như khi bạn muốn ngừng nhận thông báo.

Để biết thêm thông tin chi tiết về phản hồi, hãy tham khảo phương thức watch của tài nguyên Người dùng trong Tài liệu tham khảo API.

Đồng bộ hoá thư

Sau khi tạo kênh thông báo để xem tài nguyên, Directory API sẽ gửi thông báo sync để cho biết rằng thông báo đang bắt đầu. Giá trị tiêu đề HTTP X-Goog-Resource-State của những thông báo này là sync. Do các vấn đề về thời gian mạng, bạn có thể nhận được thông báo sync ngay cả trước khi nhận được phản hồi của phương thức watch.

Bạn có thể bỏ qua thông báo sync, nhưng bạn cũng có thể sử dụng thông báo này. Ví dụ: Nếu quyết định không muốn giữ lại kênh nữa, bạn có thể sử dụng các giá trị X-Goog-Channel-ID và X-Goog-Resource-ID trong lệnh gọi để ngừng nhận thông báo. Bạn cũng có thể sử dụng thông báo sync để thực hiện một số hoạt động khởi tạo nhằm chuẩn bị cho các sự kiện sau này.

Dưới đây là định dạng của các thông báo sync mà API Thư mục gửi đến URL nhận.

POST https://mydomain.com/notifications // Your receiving URL.
X-Goog-Channel-ID: channel-ID-value
X-Goog-Channel-Token: channel-token-value
X-Goog-Channel-Expiration: expiration-date-and-time // In human-readable format. Present only if the channel expires.
X-Goog-Resource-ID: identifier-for-the-watched-resource
X-Goog-Resource-URI: version-specific-URI-of-the-watched-resource
X-Goog-Resource-State: sync
X-Goog-Message-Number: 1

Thông báo đồng bộ hoá luôn có giá trị tiêu đề HTTP X-Goog-Message-Number là 1. Mỗi thông báo tiếp theo của kênh này sẽ có một số thông báo lớn hơn số thông báo trước đó, mặc dù số thông báo sẽ không theo tuần tự.

Gia hạn các kênh thông báo

Một kênh thông báo có thể có thời gian hết hạn, với giá trị được xác định theo yêu cầu của bạn hoặc theo giới hạn nội bộ hoặc giá trị mặc định bất kỳ của Directory API (sử dụng giá trị có tính hạn chế cao hơn). Thời gian hết hạn của kênh (nếu có) sẽ được đưa vào dưới dạng dấu thời gian Unix (tính bằng mili giây) trong thông tin mà phương thức watch trả về. Ngoài ra, ngày và giờ hết hạn sẽ được đưa vào (ở định dạng mà con người có thể đọc được) trong mọi nội dung thông báo mà ứng dụng của bạn nhận được cho kênh này trong tiêu đề HTTP X-Goog-Channel-Expiration.

Hiện tại, không có cách tự động để gia hạn kênh thông báo. Khi một kênh sắp hết hạn, bạn phải thay thế kênh đó bằng một kênh mới bằng cách gọi phương thức watch. Như thường lệ, bạn phải sử dụng một giá trị duy nhất cho thuộc tính id của kênh mới. Xin lưu ý rằng có thể có khoảng thời gian "trùng lặp" khi 2 kênh thông báo cho cùng một tài nguyên hoạt động.

Nhận thông báo

Bất cứ khi nào tài nguyên đã xem thay đổi, ứng dụng của bạn sẽ nhận được một thông báo mô tả sự thay đổi đó. Directory API gửi những thông báo này ở dạng yêu cầu POST HTTPS đến URL mà bạn đã chỉ định làm tài sản address cho kênh thông báo này.

Diễn giải định dạng thông báo thông báo

Tất cả các thông báo đều bao gồm một nhóm tiêu đề HTTP có tiền tố X-Goog-. Một số loại thông báo cũng có thể có nội dung thông báo.

Tiêu đề

Thông báo thông báo do API Directory gửi tới URL nhận của bạn có các tiêu đề HTTP sau đây:

Đầu trang Nội dung mô tả
Luôn hiển thị
X-Goog-Channel-ID UUID hoặc chuỗi duy nhất khác mà bạn cung cấp để xác định kênh thông báo này.
X-Goog-Message-Number Số nguyên xác định thông báo này cho kênh thông báo này. Giá trị luôn là 1 đối với thông báo sync. Số thông báo sẽ tăng lên trong mỗi thông báo tiếp theo trên kênh, nhưng không theo tuần tự.
X-Goog-Resource-ID Một giá trị không rõ ràng xác định tài nguyên được xem. Mã này là ổn định trên các phiên bản API.
X-Goog-Resource-State Trạng thái tài nguyên mới đã kích hoạt thông báo. Các giá trị có thể sử dụng: sync hoặc tên sự kiện.
X-Goog-Resource-URI Giá trị nhận dạng dành riêng cho từng phiên bản API của tài nguyên được theo dõi.
Thỉnh thoảng có mặt
X-Goog-Channel-Expiration Ngày và giờ hết hạn kênh thông báo, thể hiện ở định dạng con người có thể đọc được. Chỉ hiển thị nếu được xác định.
X-Goog-Channel-Token Mã thông báo kênh thông báo mà ứng dụng của bạn đã đặt mà bạn có thể dùng để xác minh nguồn thông báo. Chỉ hiển thị nếu được xác định.

Thư thông báo cho người dùng có chứa các thông tin sau trong nội dung yêu cầu:

Tài sản Nội dung mô tả
kind Xác định đây là tài nguyên Người dùng. Giá trị: chuỗi cố định "admin#directory#user".
id Giá trị nhận dạng duy nhất của tài nguyên người dùng.
etag ETag của thông báo. Khác với thẻ ETag của tài nguyên Người dùng.
primaryEmail Địa chỉ email chính của người dùng.

Ví dụ

Thông báo thông báo cho các sự kiện tài nguyên User có dạng chung:

POST https://mydomain.com/notifications // Your receiving URL.
Content-Type: application/json; utf-8
Content-Length: 0
X-Goog-Channel-ID: directoryApiId
X-Goog-Channel-Token: 398348u3tu83ut8uu38
X-Goog-Channel-Expiration: Tue, 29 Oct 2013 20:32:02 GMT
X-Goog-Resource-ID:  ret08u3rv24htgh289g
X-Goog-Resource-URI: 'https://admin.googleapis.com/admin/directory/v1/users?domain=domain&event=event
X-Goog-Resource-State:  event
X-Goog-Message-Number: 10

{
  "kind": "admin#directory#user",
  "id": long,
  "etag": string,
  "primaryEmail": string
}

Ví dụ về một sự kiện do người dùng xoá:

POST https://mydomain.com/notifications // Your receiving URL.
Content-Type: application/json; utf-8
Content-Length: 189
X-Goog-Channel-ID: deleteChannel
X-Goog-Channel-Token: 245t1234tt83trrt333
X-Goog-Channel-Expiration: Mon, 09 Dec 2013 22:24:23 GMT
X-Goog-Resource-ID:  B4ibMJiIhTjAQd7Ff2K2bexk8G4
X-Goog-Resource-URI: https://admin.googleapis.com/admin/directory/v1/users?domain=mydomain.com&event=delete&alt=json
X-Goog-Resource-State:  delete
X-Goog-Message-Number: 236440

{
  "kind": "admin#directory#user",
  "id": "111220860655841818702",
  "etag": "\"Mf8RAmnABsVfQ47MMT_18MHAdRE/evLIDlz2Fd9zbAqwvIp7Pzq8UAw\"",
  "primaryEmail": "user@mydomain.com"
}

Trả lời các thông báo

Để cho biết thành công, bạn có thể trả về bất kỳ mã trạng thái nào sau đây: 200, 201, 202, 204 hoặc 102.

Nếu dịch vụ của bạn dùng thư viện ứng dụng API của Google và trả về 500,502, 503 hoặc 504, thì Directory API sẽ thử lại với thời gian đợi luỹ thừa. Tất cả các mã trạng thái trả lại hàng khác được coi là một lỗi thông báo.

Dừng thông báo

Thuộc tính expiration kiểm soát thời điểm tự động dừng thông báo. Bạn có thể chọn ngừng nhận thông báo về một kênh cụ thể trước khi kênh đó hết hạn bằng cách gọi phương thức stop tại URI sau:

https://www.googleapis.com/admin/directory_v1/channels/stop

Phương thức này yêu cầu bạn cung cấp ít nhất là id của kênh và các thuộc tính resourceId, như trong ví dụ dưới đây. Xin lưu ý rằng nếu API Thư mục có một số loại tài nguyên chứa phương thức watch, thì chỉ có một phương thức stop.

Chỉ những người dùng có quyền phù hợp mới có thể dừng kênh. Cụ thể:

  • Nếu kênh được tạo bằng một tài khoản người dùng thông thường, thì chỉ chính người dùng đó từ cùng một ứng dụng (như được xác định bằng mã ứng dụng khách OAuth 2.0 từ mã thông báo xác thực) đã tạo kênh mới có thể dừng kênh.
  • Nếu kênh được tạo bằng một tài khoản dịch vụ, thì mọi người dùng của cùng một ứng dụng đều có thể dừng kênh đó.

Mã mẫu sau đây cho biết cách dừng nhận thông báo:

POST https://www.googleapis.com/admin/directory_v1/channels/stop
  
Authorization: Bearer CURRENT_USER_AUTH_TOKEN
Content-Type: application/json

{
  "id": "4ba78bf0-6a47-11e2-bcfd-0800200c9a66",
  "resourceId": "ret08u3rv24htgh289g"
}