Enterprises: pullNotificationSet

Menarik dan menampilkan kumpulan notifikasi untuk perusahaan yang terkait dengan akun layanan yang diautentikasi untuk permintaan. Set notifikasi mungkin kosong jika tidak ada notifikasi yang tertunda.
Set notifikasi yang ditampilkan harus dikonfirmasi dalam waktu 20 detik dengan memanggil Enterprises.AcknowledgeNotificationSet, kecuali jika set notifikasi kosong.
Notifikasi yang tidak dikonfirmasi dalam waktu 20 detik pada akhirnya akan disertakan lagi dalam respons terhadap permintaan PullNotificationSet lain, dan notifikasi yang tidak pernah dikonfirmasi pada akhirnya akan dihapus sesuai dengan kebijakan sistem Pub/Sub Google Cloud Platform.
Beberapa permintaan dapat dilakukan secara serentak untuk mengambil notifikasi. Dalam hal ini, notifikasi yang tertunda (jika ada) akan dibagi di antara setiap pemanggil, jika ada yang tertunda.
Jika tidak ada notifikasi, daftar notifikasi kosong akan ditampilkan. Permintaan berikutnya dapat menampilkan lebih banyak notifikasi setelah tersedia.

Permintaan

Permintaan HTTP

POST https://www.googleapis.com/androidenterprise/v1/enterprises/pullNotificationSet

Parameter

Nama parameter Nilai Deskripsi
Parameter kueri opsional
requestMode string Mode permintaan untuk mengambil notifikasi.
Menentukan waitForNotifications akan menyebabkan permintaan diblokir dan menunggu hingga satu atau beberapa notifikasi muncul, atau menampilkan daftar notifikasi kosong jika tidak ada notifikasi setelah beberapa waktu.
Menentukan returnImmediately akan menyebabkan permintaan segera menampilkan notifikasi yang tertunda, atau daftar kosong jika tidak ada notifikasi.
Jika dihilangkan, setelan defaultnya adalah waitForNotifications.

Nilai yang dapat diterima adalah:
  • "returnImmediately"
  • "waitForNotifications"

Otorisasi

Permintaan ini memerlukan otorisasi dengan cakupan berikut:

Cakupan
https://www.googleapis.com/auth/androidenterprise

Untuk mengetahui informasi selengkapnya, lihat halaman autentikasi dan otorisasi.

Isi permintaan

Jangan berikan isi permintaan dengan metode ini.

Respons

Jika berhasil, metode ini akan menampilkan isi respons dengan struktur berikut:

{
  "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
      }
    }
  ]
}
Nama properti Nilai Deskripsi Catatan
notificationSetId string ID kumpulan notifikasi, yang diperlukan untuk menandai notifikasi sebagai diterima dengan Enterprises.AcknowledgeNotification API. Ini akan dihilangkan jika tidak ada notifikasi.
notification[] list Notifikasi yang diterima, atau kosong jika tidak ada notifikasi.
notification[].enterpriseId string ID perusahaan yang menerima notifikasi. Ini akan selalu ada.
notification[].timestampMillis long Waktu saat notifikasi dipublikasikan dalam milidetik sejak 1970-01-01T00:00:00Z. Ini akan selalu ada.
notification[].productApprovalEvent nested object Notifikasi tentang perubahan status persetujuan produk.
notification[].productApprovalEvent.productId string ID produk (misalnya, "app:com.google.android.gm") yang status persetujuannya telah berubah. Kolom ini akan selalu ada.
notification[].productApprovalEvent.approved string Apakah produk disetujui atau tidak disetujui. Kolom ini akan selalu ada.

Nilai yang dapat diterima adalah:
  • "approved"
  • "unapproved"
  • "unknown"
notification[].installFailureEvent nested object Notifikasi tentang kegagalan penginstalan aplikasi.
notification[].installFailureEvent.productId string ID produk (misalnya, "app:com.google.android.gm") yang mengalami peristiwa kegagalan penginstalan. Kolom ini akan selalu ada.
notification[].installFailureEvent.deviceId string ID Android perangkat. Kolom ini akan selalu ada.
notification[].installFailureEvent.userId string ID pengguna. Kolom ini akan selalu ada.
notification[].installFailureEvent.failureReason string Alasan kegagalan penginstalan. Kolom ini akan selalu ada.

Nilai yang dapat diterima adalah:
  • "timeout"
  • "unknown"
notification[].installFailureEvent.failureDetails string Detail tambahan tentang kegagalan jika berlaku.
notification[].appUpdateEvent nested object Notifikasi tentang update aplikasi.
notification[].appUpdateEvent.productId string ID produk (misalnya, "app:com.google.android.gm") yang diperbarui. Kolom ini akan selalu ada.
notification[].newPermissionsEvent nested object Notifikasi tentang izin aplikasi baru.
notification[].newPermissionsEvent.productId string ID produk (misalnya, "app:com.google.android.gm") yang izin barunya ditambahkan. Kolom ini akan selalu ada.
notification[].newPermissionsEvent.requestedPermissions[] list Kumpulan izin yang saat ini diminta aplikasi. Gunakan Permissions.Get di EMM API untuk mengambil detail tentang izin ini.
notification[].newPermissionsEvent.approvedPermissions[] list Kumpulan izin yang telah disetujui admin perusahaan untuk aplikasi ini. Gunakan Permissions.Get di EMM API untuk mengambil detail tentang izin ini.
notification[].appRestrictionsSchemaChangeEvent nested object Notifikasi tentang perubahan skema batasan aplikasi baru.
notification[].appRestrictionsSchemaChangeEvent.productId string ID produk (misalnya, "app:com.google.android.gm") yang skema pembatasan aplikasinya diubah. Kolom ini akan selalu ada.
notification[].productAvailabilityChangeEvent nested object Notifikasi tentang perubahan ketersediaan produk.
notification[].productAvailabilityChangeEvent.productId string ID produk (misalnya, "app:com.google.android.gm") yang ketersediaan produknya berubah. Kolom ini akan selalu ada.
notification[].productAvailabilityChangeEvent.availabilityStatus string Status baru produk. Kolom ini akan selalu ada.

Nilai yang dapat diterima adalah:
  • "available"
  • "removed"
  • "unknown"
  • "unpublished"
notification[].newDeviceEvent nested object Notifikasi tentang perangkat baru.
notification[].newDeviceEvent.userId string ID pengguna. Kolom ini akan selalu ada.
notification[].newDeviceEvent.deviceId string ID Android perangkat. Kolom ini akan selalu ada.
notification[].newDeviceEvent.managementType string Mengidentifikasi sejauh mana perangkat dikontrol oleh EMM Android dalam berbagai konfigurasi deployment.

Nilai yang memungkinkan mencakup:
  • "managedDevice", perangkat tempat DPC ditetapkan sebagai pemilik perangkat,
  • "managedProfile", perangkat tempat DPC ditetapkan sebagai pemilik profil.


Nilai yang dapat diterima adalah:
  • "managedDevice"
  • "managedProfile"
notification[].notificationType string Jenis notifikasi.

Nilai yang dapat diterima adalah:
  • "appRestricionsSchemaChange"
  • "appUpdate"
  • "deviceReportUpdate"
  • "enterpriseUpgrade"
  • "installFailure"
  • "newDevice"
  • "newPermissions"
  • "productApproval"
  • "productAvailabilityChange"
  • "testNotification"
  • "unknown"
notification[].newDeviceEvent.dpcPackageName string Aplikasi kebijakan di perangkat.
notification[].deviceReportUpdateEvent nested object Notifikasi tentang pembaruan laporan perangkat.
notification[].deviceReportUpdateEvent.userId string ID pengguna. Kolom ini akan selalu ada.
notification[].deviceReportUpdateEvent.deviceId string ID Android perangkat. Kolom ini akan selalu ada.
notification[].deviceReportUpdateEvent.report nested object Laporan perangkat diperbarui dengan status aplikasi terbaru. Kolom ini akan selalu ada.
notification[].deviceReportUpdateEvent.report.lastUpdatedTimestampMillis long Stempel waktu pembaruan laporan terakhir dalam milidetik sejak epoch. Kolom ini akan selalu ada.
notification[].deviceReportUpdateEvent.report.appState[] list Daftar status aplikasi yang ditetapkan oleh aplikasi terkelola di perangkat. Status aplikasi ditentukan oleh developer aplikasi. Kolom ini akan selalu ada.
notification[].deviceReportUpdateEvent.report.appState[].packageName string Nama paket aplikasi. Kolom ini akan selalu ada.
notification[].deviceReportUpdateEvent.report.appState[].keyedAppState[] list Daftar status aplikasi dengan kunci. Kolom ini akan selalu ada.
notification[].deviceReportUpdateEvent.report.appState[].keyedAppState[].key string Kunci yang menunjukkan status yang disediakan aplikasi. Konten kunci ditetapkan oleh developer aplikasi. Untuk mencegah XSS, sebaiknya hapus HTML apa pun dari kunci sebelum menampilkannya. Kolom ini akan selalu ada.
notification[].deviceReportUpdateEvent.report.appState[].keyedAppState[].stateTimestampMillis long Stempel waktu saat aplikasi menetapkan status dalam milidetik sejak epoch. Kolom ini akan selalu ada.
notification[].deviceReportUpdateEvent.report.appState[].keyedAppState[].severity string Tingkat keparahan status aplikasi. Kolom ini akan selalu ada.

Nilai yang dapat diterima adalah:
  • "severityError"
  • "severityInfo"
notification[].deviceReportUpdateEvent.report.appState[].keyedAppState[].message string Pesan bentuk bebas yang dapat dibaca manusia yang menjelaskan status aplikasi. Misalnya, pesan error. Untuk mencegah XSS, sebaiknya hapus HTML apa pun dari pesan sebelum menampilkannya.
notification[].deviceReportUpdateEvent.report.appState[].keyedAppState[].data string Kolom tambahan yang ditujukan untuk data yang dapat dibaca mesin. Misalnya, angka atau objek JSON. Untuk mencegah XSS, sebaiknya hapus HTML apa pun dari data sebelum menampilkannya.
kind string
notification[].enterpriseUpgradeEvent nested object Notifikasi tentang upgrade perusahaan.
notification[].enterpriseUpgradeEvent.upgradeState string Status upgrade.

Nilai yang dapat diterima adalah:
  • "upgradeStateSucceeded"
  • "upgradeStateUnspecified"