Pull Notification Set

Pulls and returns a notification set for the enterprises associated with the service account authenticated for the request

1 variables
36 variables

Pulls and returns a notification set for the enterprises associated with the service account authenticated for the request. The notification set may be empty if no notification are pending. A notification set returned needs to be acknowledged within 20 seconds by calling Enterprises.AcknowledgeNotificationSet, unless the notification set is empty. Notifications that are not acknowledged within the 20 seconds will eventually be included again in the response to another PullNotificationSet request, and those that are never acknowledged will ultimately be deleted according to the Google Cloud Platform Pub/Sub system policy. Multiple requests might be performed concurrently to retrieve notifications, in which case the pending notifications (if any) will be split among each caller, if any are pending. If no notifications are present, an empty notification list is returned. Subsequent requests may return more notifications once they become available

Authorization

To use this building block you will have to grant access to at least one of the following scopes:

  • Manage corporate Android devices

Input

This building block consumes 1 input parameters

  = Parameter name
  = Format

requestMode ENUMERATION

The request mode for pulling notifications. Specifying waitForNotifications will cause the request to block and wait until one or more notifications are present, or return an empty notification list if no notifications are present after some time. Speciying returnImmediately will cause the request to immediately return the pending notifications, or an empty list if no notifications are present. If omitted, defaults to waitForNotifications

Output

This building block provides 36 output parameters

  = Parameter name
  = Format

kind STRING

Identifies what kind of resource this is. Value: the fixed string "androidenterprise#notificationSet"

notification[] OBJECT

A notification of one event relating to an enterprise

notification[].appRestrictionsSchemaChangeEvent OBJECT

An event generated when a new app version is uploaded to Google Play and its app restrictions schema changed. To fetch the app restrictions schema for an app, use Products.getAppRestrictionsSchema on the EMM API

notification[].appRestrictionsSchemaChangeEvent.productId STRING

The id of the product (e.g. "app:com.google.android.gm") for which the app restriction schema changed. This field will always be present

notification[].appUpdateEvent OBJECT

An event generated when a new version of an app is uploaded to Google Play. Notifications are sent for new public versions only: alpha, beta, or canary versions do not generate this event. To fetch up-to-date version history for an app, use Products.Get on the EMM API

notification[].appUpdateEvent.productId STRING

The id of the product (e.g. "app:com.google.android.gm") that was updated. This field will always be present

notification[].deviceReportUpdateEvent OBJECT

An event generated when an updated device report is available

notification[].deviceReportUpdateEvent.deviceId STRING

The Android ID of the device. This field will always be present

notification[].deviceReportUpdateEvent.report OBJECT

Device report updated with the latest app states for managed apps on the device

notification[].deviceReportUpdateEvent.report.lastUpdatedTimestampMillis INTEGER

The timestamp of the last report update in milliseconds since epoch. This field will always be present

notification[].deviceReportUpdateEvent.userId STRING

The ID of the user. This field will always be present

notification[].enterpriseId STRING

The ID of the enterprise for which the notification is sent. This will always be present

notification[].installFailureEvent OBJECT

An event generated when an app installation failed on a device

notification[].installFailureEvent.deviceId STRING

The Android ID of the device. This field will always be present

notification[].installFailureEvent.failureDetails STRING

Additional details on the failure if applicable

notification[].installFailureEvent.failureReason STRING

The reason for the installation failure. This field will always be present

notification[].installFailureEvent.productId STRING

The id of the product (e.g. "app:com.google.android.gm") for which the install failure event occured. This field will always be present

notification[].installFailureEvent.userId STRING

The ID of the user. This field will always be present

notification[].newDeviceEvent OBJECT

An event generated when a new device is ready to be managed

notification[].newDeviceEvent.deviceId STRING

The Android ID of the device. This field will always be present

notification[].newDeviceEvent.dpcPackageName STRING

Policy app on the device

notification[].newDeviceEvent.managementType STRING

Identifies the extent to which the device is controlled by an Android EMM in various deployment configurations.

Possible values include:

  • "managedDevice", a device where the DPC is set as device owner,
  • "managedProfile", a device where the DPC is set as profile owner.

notification[].newDeviceEvent.userId STRING

The ID of the user. This field will always be present

notification[].newPermissionsEvent OBJECT

An event generated when new permissions are added to an app

notification[].newPermissionsEvent.approvedPermissions[] STRING

notification[].newPermissionsEvent.productId STRING

The id of the product (e.g. "app:com.google.android.gm") for which new permissions were added. This field will always be present

notification[].newPermissionsEvent.requestedPermissions[] STRING

notification[].notificationType STRING

Type of the notification

notification[].productApprovalEvent OBJECT

An event generated when a product's approval status is changed

notification[].productApprovalEvent.approved STRING

Whether the product was approved or unapproved. This field will always be present

notification[].productApprovalEvent.productId STRING

The id of the product (e.g. "app:com.google.android.gm") for which the approval status has changed. This field will always be present

notification[].productAvailabilityChangeEvent OBJECT

An event generated whenever a product's availability changes

notification[].productAvailabilityChangeEvent.availabilityStatus STRING

The new state of the product. This field will always be present

notification[].productAvailabilityChangeEvent.productId STRING

The id of the product (e.g. "app:com.google.android.gm") for which the product availability changed. This field will always be present

notification[].timestampMillis INTEGER

The time when the notification was published in milliseconds since 1970-01-01T00:00:00Z. This will always be present

notificationSetId STRING

The notification set ID, required to mark the notification as received with the Enterprises.AcknowledgeNotification API. This will be omitted if no notifications are present