Enterprises: pullNotificationSet

Ruft einen Benachrichtigungssatz für die Unternehmen ab, die mit dem Dienstkonto verknüpft sind, das für die Anfrage authentifiziert wurde, und gibt ihn zurück. Die Benachrichtigungsgruppe ist möglicherweise leer, wenn keine Benachrichtigungen ausstehen.
Eine zurückgegebene Benachrichtigungsgruppe muss innerhalb von 20 Sekunden durch Aufrufen von „Enterprises.AcknowledgeNotificationSet“ bestätigt werden, es sei denn, die Benachrichtigungsgruppe ist leer.
Benachrichtigungen, die nicht innerhalb von 20 Sekunden bestätigt werden, werden in der Antwort auf eine weitere PullNotificationSet-Anfrage wieder aufgenommen. Benachrichtigungen, die nie bestätigt werden, werden gemäß der Google Cloud Platform Pub/Sub-Systemrichtlinie gelöscht.
Es können mehrere Anfragen gleichzeitig ausgeführt werden, um Benachrichtigungen abzurufen. In diesem Fall werden ausstehende Benachrichtigungen (falls vorhanden) auf die einzelnen Aufrufer aufgeteilt.
Wenn keine Benachrichtigungen vorhanden sind, wird eine leere Benachrichtigungsliste zurückgegeben. Bei nachfolgenden Anfragen werden möglicherweise weitere Benachrichtigungen zurückgegeben, sobald sie verfügbar sind.

Anfrage

HTTP-Anfrage

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

Parameter

Parametername Wert Beschreibung
Optionale Suchparameter
requestMode string Der Anfragemodus für das Abrufen von Benachrichtigungen.
Wenn du waitForNotifications angibst, wird die Anfrage blockiert und wartet, bis eine oder mehrere Benachrichtigungen vorhanden sind. Andernfalls wird eine leere Benachrichtigungsliste zurückgegeben, wenn nach einiger Zeit keine Benachrichtigungen vorhanden sind.
Wenn du returnImmediately angibst, werden in der Anfrage sofort die ausstehenden Benachrichtigungen zurückgegeben. Wenn keine Benachrichtigungen vorhanden sind, wird eine leere Liste zurückgegeben.
Wenn keine Angabe gemacht wird, lautet der Standardwert waitForNotifications.

Zulässige Werte sind:
  • returnImmediately
  • waitForNotifications

Autorisierung

Für diese Anfrage ist eine Autorisierung mit dem folgenden Umfang erforderlich:

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

Weitere Informationen finden Sie auf der Seite Authentifizierung und Autorisierung.

Anfragetext

Mit dieser Methode keinen Anfragetext bereitstellen.

Antwort

Bei Erfolg gibt diese Methode einen Antworttext mit der folgenden Struktur zurück:

{
  "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
      }
    }
  ]
}
Name der Eigenschaft Wert Beschreibung Hinweise
notificationSetId string Die ID des Benachrichtigungssets, die erforderlich ist, um die Benachrichtigung mit der API „Enterprises.AcknowledgeNotification“ als empfangen zu kennzeichnen. Dieser Teil wird weggelassen, wenn keine Benachrichtigungen vorhanden sind.
notification[] list Die empfangenen Benachrichtigungen. Wenn keine Benachrichtigungen vorhanden sind, ist der Wert leer.
notification[].enterpriseId string Die ID des Unternehmens, für das die Benachrichtigung gesendet wird. Dieser Wert ist immer vorhanden.
notification[].timestampMillis long Die Zeit, zu der die Benachrichtigung veröffentlicht wurde, in Millisekunden seit dem 01.01.1970 00:00:00 UTC. Dieser Wert ist immer vorhanden.
notification[].productApprovalEvent nested object Benachrichtigungen zu Änderungen am Genehmigungsstatus eines Produkts.
notification[].productApprovalEvent.productId string Die ID des Produkts (z.B. „app:com.google.android.gm“), für das sich der Genehmigungsstatus geändert hat. Dieses Feld ist immer vorhanden.
notification[].productApprovalEvent.approved string Gibt an, ob das Produkt genehmigt oder abgelehnt wurde. Dieses Feld ist immer vorhanden.

Zulässige Werte sind:
  • approved
  • unapproved
  • unknown
notification[].installFailureEvent nested object Benachrichtigungen über fehlgeschlagene App-Installationen
notification[].installFailureEvent.productId string Die ID des Produkts (z.B. „app:com.google.android.gm“), für das das Installationsfehlerereignis aufgetreten ist. Dieses Feld ist immer vorhanden.
notification[].installFailureEvent.deviceId string Die Android-ID des Geräts. Dieses Feld ist immer vorhanden.
notification[].installFailureEvent.userId string Die ID des Nutzers. Dieses Feld ist immer vorhanden.
notification[].installFailureEvent.failureReason string Der Grund für den Installationsfehler. Dieses Feld ist immer vorhanden.

Zulässige Werte sind:
  • timeout
  • unknown
notification[].installFailureEvent.failureDetails string Zusätzliche Details zum Fehler, sofern zutreffend.
notification[].appUpdateEvent nested object Benachrichtigungen zu App-Updates
notification[].appUpdateEvent.productId string Die ID des aktualisierten Produkts (z.B. „app:com.google.android.gm“). Dieses Feld ist immer vorhanden.
notification[].newPermissionsEvent nested object Benachrichtigungen zu neuen App-Berechtigungen
notification[].newPermissionsEvent.productId string Die ID des Produkts (z.B. „app:com.google.android.gm“), für das neue Berechtigungen hinzugefügt wurden. Dieses Feld ist immer vorhanden.
notification[].newPermissionsEvent.requestedPermissions[] list Die Berechtigungen, die die App derzeit anfordert. Verwenden Sie Permissions.Get in der EMM API, um Details zu diesen Berechtigungen abzurufen.
notification[].newPermissionsEvent.approvedPermissions[] list Die Berechtigungen, die der Unternehmensadministrator bereits für diese Anwendung genehmigt hat. Verwenden Sie Permissions.Get in der EMM API, um Details zu diesen Berechtigungen abzurufen.
notification[].appRestrictionsSchemaChangeEvent nested object Benachrichtigungen zu neuen Änderungen am Schema für App-Einschränkungen
notification[].appRestrictionsSchemaChangeEvent.productId string Die ID des Produkts (z.B. „app:com.google.android.gm“), für das sich das Schema für App-Einschränkungen geändert hat. Dieses Feld ist immer vorhanden.
notification[].productAvailabilityChangeEvent nested object Benachrichtigungen zu Änderungen der Produktverfügbarkeit
notification[].productAvailabilityChangeEvent.productId string Die ID des Produkts (z.B. „app:com.google.android.gm“), für das sich die Produktverfügbarkeit geändert hat. Dieses Feld ist immer vorhanden.
notification[].productAvailabilityChangeEvent.availabilityStatus string Der neue Zustand des Produkts. Dieses Feld ist immer vorhanden.

Zulässige Werte sind:
  • available
  • removed
  • unknown
  • unpublished
notification[].newDeviceEvent nested object Benachrichtigungen zu neuen Geräten
notification[].newDeviceEvent.userId string Die ID des Nutzers. Dieses Feld ist immer vorhanden.
notification[].newDeviceEvent.deviceId string Die Android-ID des Geräts. Dieses Feld ist immer vorhanden.
notification[].newDeviceEvent.managementType string Gibt an, inwieweit das Gerät in verschiedenen Bereitstellungskonfigurationen von einem Android-EMM gesteuert wird.

Mögliche Werte:
  • managedDevice“, ein Gerät, auf dem der DPC als Geräteeigentümer festgelegt ist,
  • managedProfile“, ein Gerät, auf dem der DPC als Profilinhaber festgelegt ist.


Zulässige Werte sind:
  • managedDevice
  • managedProfile
notification[].notificationType string Art der Benachrichtigung.

Zulässige Werte sind:
  • appRestricionsSchemaChange
  • appUpdate
  • deviceReportUpdate
  • enterpriseUpgrade
  • installFailure
  • newDevice
  • newPermissions
  • productApproval
  • productAvailabilityChange
  • testNotification
  • unknown
notification[].newDeviceEvent.dpcPackageName string Richtlinien-App auf dem Gerät
notification[].deviceReportUpdateEvent nested object Benachrichtigungen zu Aktualisierungen von Geräteberichten
notification[].deviceReportUpdateEvent.userId string Die ID des Nutzers. Dieses Feld ist immer vorhanden.
notification[].deviceReportUpdateEvent.deviceId string Die Android-ID des Geräts. Dieses Feld ist immer vorhanden.
notification[].deviceReportUpdateEvent.report nested object Der Gerätebericht wurde mit den neuesten App-Status aktualisiert. Dieses Feld ist immer vorhanden.
notification[].deviceReportUpdateEvent.report.lastUpdatedTimestampMillis long Der Zeitstempel der letzten Berichtsaktualisierung in Millisekunden seit der Epoche. Dieses Feld ist immer vorhanden.
notification[].deviceReportUpdateEvent.report.appState[] list Liste der App-Status, die von verwalteten Apps auf dem Gerät festgelegt wurden. App-Status werden von den Entwicklern der App festgelegt. Dieses Feld ist immer vorhanden.
notification[].deviceReportUpdateEvent.report.appState[].packageName string Der Paketname der App. Dieses Feld ist immer vorhanden.
notification[].deviceReportUpdateEvent.report.appState[].keyedAppState[] list Liste der App-Status mit Schlüsseln. Dieses Feld ist immer vorhanden.
notification[].deviceReportUpdateEvent.report.appState[].keyedAppState[].key string Schlüssel, der angibt, für was die App einen Status bereitstellt. Der Inhalt des Schlüssels wird vom Entwickler der App festgelegt. Um XSS zu verhindern, empfehlen wir, vor der Anzeige alle HTML-Elemente aus dem Schlüssel zu entfernen. Dieses Feld ist immer vorhanden.
notification[].deviceReportUpdateEvent.report.appState[].keyedAppState[].stateTimestampMillis long Zeitstempel, zu dem die App den Status festgelegt hat, in Millisekunden seit der Epoche. Dieses Feld ist immer vorhanden.
notification[].deviceReportUpdateEvent.report.appState[].keyedAppState[].severity string Schweregrad des App-Status. Dieses Feld ist immer vorhanden.

Zulässige Werte sind:
  • severityError
  • severityInfo
notification[].deviceReportUpdateEvent.report.appState[].keyedAppState[].message string Eine für Menschen lesbare Nachricht im freien Format, die den App-Status beschreibt. Zum Beispiel eine Fehlermeldung. Um XSS zu verhindern, empfehlen wir, vor dem Anzeigen der Nachricht jeglichen HTML-Code daraus zu entfernen.
notification[].deviceReportUpdateEvent.report.appState[].keyedAppState[].data string Zusätzliches Feld für maschinenlesbare Daten. Beispielsweise eine Zahl oder ein JSON-Objekt. Um XSS zu verhindern, empfehlen wir, vor der Anzeige alle HTML-Elemente aus den Daten zu entfernen.
kind string
notification[].enterpriseUpgradeEvent nested object Benachrichtigungen zum Upgrade auf die Enterprise-Version.
notification[].enterpriseUpgradeEvent.upgradeState string Upgrade-Status.

Zulässige Werte sind:
  • upgradeStateSucceeded
  • upgradeStateUnspecified