Kéo và trả về một nhóm thông báo cho các doanh nghiệp được liên kết với tài khoản dịch vụ đã được xác thực cho yêu cầu. Tập hợp thông báo có thể trống nếu không có thông báo nào đang chờ xử lý.
Bạn cần xác nhận một tập hợp thông báo được trả về trong vòng 20 giây bằng cách gọi Enterprises.AcknowledgeNotificationSet, trừ phi tập hợp thông báo đó trống.
Các thông báo không được xác nhận trong vòng 20 giây cuối cùng sẽ được đưa vào lại trong phản hồi cho một yêu cầu PullNotificationSet khác, còn những thông báo không bao giờ được xác nhận cuối cùng sẽ bị xoá theo chính sách hệ thống Pub/Sub của Google Cloud Platform.
Nhiều yêu cầu có thể được thực hiện đồng thời để truy xuất thông báo. Trong trường hợp đó, các thông báo đang chờ xử lý (nếu có) sẽ được phân chia giữa từng phương thức gọi, nếu có thông báo đang chờ xử lý.
Nếu không có thông báo nào, hệ thống sẽ trả về danh sách thông báo trống.
Các yêu cầu tiếp theo có thể trả về thêm thông báo khi có.
Yêu cầu
Yêu cầu HTTP
POST https://www.googleapis.com/androidenterprise/v1/enterprises/pullNotificationSet
Thông số
Tên thông số | Giá trị | Mô tả |
---|---|---|
Thông số truy vấn không bắt buộc | ||
requestMode |
string |
Chế độ yêu cầu để lấy thông báo.
Việc chỉ định waitForNotifications sẽ khiến yêu cầu chặn và đợi cho đến khi có một hoặc nhiều thông báo hoặc trả về danh sách thông báo trống nếu không có thông báo nào sau một khoảng thời gian.
Việc chỉ định returnImmediately sẽ khiến yêu cầu trả về ngay các thông báo đang chờ xử lý hoặc danh sách trống nếu không có thông báo nào.
Nếu bạn bỏ qua thuộc tính này, giá trị mặc định sẽ là waitForNotifications .
Các giá trị được chấp nhận là:
|
Ủy quyền
Yêu cầu này yêu cầu uỷ quyền với phạm vi sau:
Phạm vi |
---|
https://www.googleapis.com/auth/androidenterprise |
Để biết thêm thông tin, hãy xem trang xác thực và uỷ quyền.
Nội dung yêu cầu
Không cung cấp nội dung yêu cầu bằng phương thức này.
Phản hồi
Nếu thành công, phương thức này sẽ trả về một phần nội dung phản hồi có cấu trúc sau:
{ "kind": "androidenterprise#notificationSet", "notificationSetId": string, "notification": [ { "enterpriseId": string, "timestampMillis": long, "notificationType": string, "productApprovalEvent": { "productId": string, "approved": string }, "installFailureEvent": { "productId": string, "deviceId": string, "userId": string, "failureReason": string, "failureDetails": string }, "appUpdateEvent": { "productId": string }, "newPermissionsEvent": { "productId": string, "requestedPermissions": [ string ], "approvedPermissions": [ string ] }, "appRestrictionsSchemaChangeEvent": { "productId": string }, "productAvailabilityChangeEvent": { "productId": string, "availabilityStatus": string }, "newDeviceEvent": { "userId": string, "deviceId": string, "managementType": string, "dpcPackageName": string }, "deviceReportUpdateEvent": { "userId": string, "deviceId": string, "report": { "lastUpdatedTimestampMillis": long, "appState": [ { "packageName": string, "keyedAppState": [ { "key": string, "stateTimestampMillis": long, "severity": string, "message": string, "data": string } ] } ] } }, "enterpriseUpgradeEvent": { "upgradeState": string } } ] }
Tên tài sản | Giá trị | Mô tả | Ghi chú |
---|---|---|---|
notificationSetId |
string |
Mã nhận dạng nhóm thông báo, bắt buộc phải có để đánh dấu thông báo là đã nhận được bằng API Enterprises.AcknowledgeNotification. Phần này sẽ bị bỏ qua nếu không có thông báo nào. | |
notification[] |
list |
Thông báo đã nhận được hoặc trống nếu không có thông báo nào. | |
notification[].enterpriseId |
string |
Mã nhận dạng của doanh nghiệp mà thông báo được gửi đến. Phần này sẽ luôn xuất hiện. | |
notification[].timestampMillis |
long |
Thời gian phát hành thông báo tính bằng mili giây kể từ ngày 01 tháng 1 năm 1970 00:00:00Z. Phần này sẽ luôn xuất hiện. | |
notification[].productApprovalEvent |
nested object |
Thông báo về những thay đổi đối với trạng thái phê duyệt của sản phẩm. | |
notification[].productApprovalEvent.productId |
string |
Mã nhận dạng của sản phẩm (ví dụ: "app:com.google.android.gm") có trạng thái phê duyệt đã thay đổi. Trường này sẽ luôn xuất hiện. | |
notification[].productApprovalEvent.approved |
string |
Liệu sản phẩm có được phê duyệt hay không. Trường này sẽ luôn xuất hiện.
Các giá trị được chấp nhận là:
|
|
notification[].installFailureEvent |
nested object |
Thông báo về việc không cài đặt được ứng dụng. | |
notification[].installFailureEvent.productId |
string |
Mã nhận dạng của sản phẩm (ví dụ: "app:com.google.android.gm") mà sự kiện cài đặt không thành công đã xảy ra. Trường này sẽ luôn xuất hiện. | |
notification[].installFailureEvent.deviceId |
string |
Mã nhận dạng Android của thiết bị. Trường này sẽ luôn xuất hiện. | |
notification[].installFailureEvent.userId |
string |
Mã nhận dạng của người dùng. Trường này sẽ luôn xuất hiện. | |
notification[].installFailureEvent.failureReason |
string |
Lý do không cài đặt được. Trường này sẽ luôn xuất hiện.
Các giá trị được chấp nhận là:
|
|
notification[].installFailureEvent.failureDetails |
string |
Thông tin bổ sung về lỗi (nếu có). | |
notification[].appUpdateEvent |
nested object |
Thông báo về bản cập nhật ứng dụng. | |
notification[].appUpdateEvent.productId |
string |
Mã nhận dạng của sản phẩm (ví dụ: "app:com.google.android.gm") đã được cập nhật. Trường này sẽ luôn xuất hiện. | |
notification[].newPermissionsEvent |
nested object |
Thông báo về quyền mới của ứng dụng. | |
notification[].newPermissionsEvent.productId |
string |
Mã nhận dạng của sản phẩm (ví dụ: "app:com.google.android.gm") mà bạn đã thêm các quyền mới. Trường này sẽ luôn xuất hiện. | |
notification[].newPermissionsEvent.requestedPermissions[] |
list |
Tập hợp các quyền mà ứng dụng hiện đang yêu cầu. Sử dụng Permissions.Get trên API EMM để truy xuất thông tin chi tiết về các quyền này. | |
notification[].newPermissionsEvent.approvedPermissions[] |
list |
Tập hợp các quyền mà quản trị viên doanh nghiệp đã phê duyệt cho ứng dụng này. Sử dụng Permissions.Get trên API EMM để truy xuất thông tin chi tiết về các quyền này. | |
notification[].appRestrictionsSchemaChangeEvent |
nested object |
Thông báo về các thay đổi mới đối với giản đồ hạn chế ứng dụng. | |
notification[].appRestrictionsSchemaChangeEvent.productId |
string |
Mã nhận dạng của sản phẩm (ví dụ: "app:com.google.android.gm") mà giản đồ hạn chế ứng dụng đã thay đổi. Trường này sẽ luôn xuất hiện. | |
notification[].productAvailabilityChangeEvent |
nested object |
Thông báo về những thay đổi đối với tình trạng còn hàng của sản phẩm. | |
notification[].productAvailabilityChangeEvent.productId |
string |
Mã của sản phẩm (ví dụ: "app:com.google.android.gm") mà tình trạng còn hàng của sản phẩm đã thay đổi. Trường này sẽ luôn xuất hiện. | |
notification[].productAvailabilityChangeEvent.availabilityStatus |
string |
Trạng thái mới của sản phẩm. Trường này sẽ luôn xuất hiện.
Các giá trị được chấp nhận là:
|
|
notification[].newDeviceEvent |
nested object |
Thông báo về thiết bị mới. | |
notification[].newDeviceEvent.userId |
string |
Mã nhận dạng của người dùng. Trường này sẽ luôn xuất hiện. | |
notification[].newDeviceEvent.deviceId |
string |
Mã nhận dạng Android của thiết bị. Trường này sẽ luôn xuất hiện. | |
notification[].newDeviceEvent.managementType |
string |
Xác định mức độ thiết bị được một EMM Android kiểm soát trong nhiều cấu hình triển khai. Các giá trị có thể là:
Các giá trị được chấp nhận là:
|
|
notification[].notificationType |
string |
Loại thông báo.
Các giá trị được chấp nhận là:
|
|
notification[].newDeviceEvent.dpcPackageName |
string |
Ứng dụng chính sách trên thiết bị. | |
notification[].deviceReportUpdateEvent |
nested object |
Thông báo về nội dung cập nhật trong báo cáo thiết bị. | |
notification[].deviceReportUpdateEvent.userId |
string |
Mã nhận dạng của người dùng. Trường này sẽ luôn xuất hiện. | |
notification[].deviceReportUpdateEvent.deviceId |
string |
Mã nhận dạng Android của thiết bị. Trường này sẽ luôn xuất hiện. | |
notification[].deviceReportUpdateEvent.report |
nested object |
Báo cáo thiết bị đã cập nhật trạng thái ứng dụng mới nhất. Trường này sẽ luôn xuất hiện. | |
notification[].deviceReportUpdateEvent.report.lastUpdatedTimestampMillis |
long |
Dấu thời gian của lần cập nhật báo cáo gần đây nhất tính bằng mili giây kể từ thời gian bắt đầu của hệ thống. Trường này sẽ luôn xuất hiện. | |
notification[].deviceReportUpdateEvent.report.appState[] |
list |
Danh sách trạng thái ứng dụng do các ứng dụng được quản lý đặt trên thiết bị. Trạng thái ứng dụng do nhà phát triển ứng dụng xác định. Trường này sẽ luôn xuất hiện. | |
notification[].deviceReportUpdateEvent.report.appState[].packageName |
string |
Tên gói của ứng dụng. Trường này sẽ luôn xuất hiện. | |
notification[].deviceReportUpdateEvent.report.appState[].keyedAppState[] |
list |
Danh sách các trạng thái ứng dụng được khoá. Trường này sẽ luôn xuất hiện. | |
notification[].deviceReportUpdateEvent.report.appState[].keyedAppState[].key |
string |
Khoá cho biết ứng dụng đang cung cấp trạng thái cho đối tượng nào. Nội dung của khoá là do nhà phát triển ứng dụng thiết lập. Để ngăn chặn XSS, bạn nên xoá mọi HTML khỏi khoá trước khi hiển thị khoá đó. Trường này sẽ luôn xuất hiện. | |
notification[].deviceReportUpdateEvent.report.appState[].keyedAppState[].stateTimestampMillis |
long |
Dấu thời gian của thời điểm ứng dụng đặt trạng thái tính bằng mili giây kể từ thời gian bắt đầu của hệ thống. Trường này sẽ luôn xuất hiện. | |
notification[].deviceReportUpdateEvent.report.appState[].keyedAppState[].severity |
string |
Mức độ nghiêm trọng của trạng thái ứng dụng. Trường này sẽ luôn xuất hiện.
Các giá trị được chấp nhận là:
|
|
notification[].deviceReportUpdateEvent.report.appState[].keyedAppState[].message |
string |
Thông báo ở dạng tự do, người dùng có thể đọc được, mô tả trạng thái ứng dụng. Ví dụ: thông báo lỗi. Để ngăn chặn XSS, bạn nên xoá mọi HTML khỏi thông báo trước khi hiển thị. | |
notification[].deviceReportUpdateEvent.report.appState[].keyedAppState[].data |
string |
Trường bổ sung dành cho dữ liệu mà máy có thể đọc được. Ví dụ: một số hoặc đối tượng JSON. Để ngăn chặn XSS, bạn nên xoá mọi HTML khỏi dữ liệu trước khi hiển thị dữ liệu đó. | |
kind |
string |
||
notification[].enterpriseUpgradeEvent |
nested object |
Thông báo về việc nâng cấp lên phiên bản dành cho doanh nghiệp. | |
notification[].enterpriseUpgradeEvent.upgradeState |
string |
Trạng thái nâng cấp.
Các giá trị được chấp nhận là:
|