Enterprises: pullNotificationSet

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ý.
Cần xác nhận một nhóm thông báo được trả về trong vòng 20 giây bằng cách gọi Enterprises.ConfirmNotificationSet, trừ khi bộ thông báo trống.
Những thông báo không được xác nhận trong vòng 20 giây sẽ cuối cùng sẽ được đưa vào lại phản hồi cho một PullNotificationSet khác và những yêu cầu không bao giờ được xác nhận cuối cùng sẽ bị xoá theo chính sách hệ thống Google Cloud Platform Pub/Sub.
Nhiều yêu cầu có thể được thực hiện đồng thời để truy xuất trong trường hợp đó thông báo đang chờ xử lý (nếu có) sẽ được được chia cho từng phương thức gọi (nếu có).
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ề các thông báo khác sau khi nhận được sẵn 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 này chặn và đợi cho đến khi có một hoặc nhiều thông báo hoặc trả về một 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 ngay lập tức trả về các thông báo đang chờ xử lý hoặc một danh sách trống nếu không có thông bá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à:
  • "returnImmediately"
  • "waitForNotifications"

Ủy quyền

Yêu cầu này cần được cho phép có 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

Đừ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ề nội dung phản hồi có cấu trúc như 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
                }
              ]
            }
          ]
        }
      }
    }
  ]
}
Tên tài sản Giá trị Mô tả Ghi chú
notificationSetId string Mã nhóm thông báo bắt buộc để đánh dấu thông báo là đã nhận bằng Enterprises.ConfirmNotification API. Thao tác này sẽ bị bỏ qua nếu không có thông bá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ã của doanh nghiệp nhận thông báo. Phần này sẽ luôn xuất hiện.
notification[].timestampMillis long Thời gian khi thông báo được xuất bản tính bằng mili giây kể từ 1970-01-01T00:00:00Z. Thông tin 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ã 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à:
  • "approved"
  • "unapproved"
  • "unknown"
notification[].installFailureEvent nested object Thông báo về lỗi cài đặt ứng dụng.
notification[].installFailureEvent.productId string Mã của sản phẩm (ví dụ: "app:com.google.android.gm") đã xảy ra sự kiện lỗi cài đặt. 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 cài đặt không thành công. Trường này sẽ luôn xuất hiện.

Các giá trị được chấp nhận là:
  • "timeout"
  • "unknown"
notification[].installFailureEvent.failureDetails string Thông tin bổ sung về lỗi này (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ã 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 cho ứ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 quyền mà ứng dụng hiện đang yêu cầu. Sử dụng Quyền.Truy xuất 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 Quyền.Truy xuất 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ề những thay đổi mới trong 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ề việc thay đổi tình trạng còn hàng của sản phẩm.
notification[].productAvailabilityChangeEvent.productId string Mã nhận dạng 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à:
  • "available"
  • "removed"
  • "unknown"
  • "unpublished"
notification[].newDeviceEvent nested object Thông báo về thiết bị mới.
notification[].newDeviceEvent.userId string Mã 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ể bao gồm:
  • "managedDevice", một thiết bị mà DPC được đặt làm chủ sở hữu thiết bị,
  • "managedProfile", một thiết bị mà DPC được đặt làm chủ sở hữu hồ sơ.


Các giá trị được chấp nhận là:
  • "managedDevice"
  • "managedProfile"
notification[].notificationType string Loại thông báo.

Các giá trị được chấp nhận là:
  • "appRestricionsSchemaChange"
  • "appUpdate"
  • "deviceReportUpdate"
  • "installFailure"
  • "newDevice"
  • "newPermissions"
  • "productApproval"
  • "productAvailabilityChange"
  • "testNotification"
  • "unknown"
notification[].newDeviceEvent.dpcPackageName string Ứng dụng chính sách trên thiết bị.
notification[].deviceReportUpdateEvent nested object Thông báo cập nhật 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 các trạng thái mới nhất của ứng dụng. 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ý thiết lập trên thiết bị. Trạng thái ứng dụng là 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 trạng thái của ứ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á 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 Tính 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à:
  • "severityError"
  • "severityInfo"
notification[].deviceReportUpdateEvent.report.appState[].keyedAppState[].message string Thông báo dạng tự do, con người có thể đọc được, mô tả trạng thái ứng dụng. Ví dụ: thông báo lỗi. Để ngăn XSS, chúng tôi khuyên bạn nên xoá mọi HTML khỏi thư trước khi hiển thị 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