リクエストで認証されたサービス アカウントに関連付けられているエンタープライズ用の通知セットを取得して返します。通知セットは
保留中の通知がない場合は空になります。
返された通知セットは、通知セットが空でない場合、Enterprises.AcknowledgeNotificationSet を呼び出して 20 秒以内に確認応答する必要があります。
20 秒以内に確認応答が送信されなかった通知は、最終的に別の PullNotificationSet リクエストのレスポンスに再び含まれます。確認応答が送信されなかった通知は、最終的に Google Cloud Platform Pub/Sub システム ポリシーに従って削除されます。
画像を取得するために複数のリクエストが同時に実行される
その場合、保留中の通知(ある場合)は
保留中の場合は各呼び出し元の間で分割されます。
通知が存在しない場合は、空の通知リストが返されます。
後続のリクエストについては、
できます。
リクエスト
HTTP リクエスト
POST https://www.googleapis.com/androidenterprise/v1/enterprises/pullNotificationSet
パラメータ
パラメータ名 | 値 | 説明 |
---|---|---|
省略可能なクエリ パラメータ | ||
requestMode |
string |
通知を pull するためのリクエスト モード。
waitForNotifications を指定すると、リクエストが
1 つ以上の通知が存在するのを待つか
しばらくしても通知が存在しない場合は空の通知リスト。
returnImmediately を指定すると、リクエストが
保留中の通知がすぐに返されるか、通知がない場合は空のリストが返されます。
通知があります。
省略した場合、デフォルトの waitForNotifications になります。
指定できる値は次のとおりです。 <ph type="x-smartling-placeholder">
|
承認
このリクエストには、次のスコープによる認証が必要です。
スコープ |
---|
https://www.googleapis.com/auth/androidenterprise |
詳細については、認証と認可のページをご覧ください。
リクエスト本文
このメソッドをリクエストの本文に含めないでください。
レスポンス
成功すると、このメソッドは次の構造を含むレスポンスの本文を返します。
{ "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 } ] } ] } } } ] }
プロパティ名 | 値 | 説明 | メモ |
---|---|---|---|
notificationSetId |
string |
通知セット ID。Enterprises.AcknowledgeNotification API で通知を受信したとマークするために必要です。通知がない場合、このフィールドは省略されます。 | |
notification[] |
list |
受信した通知数。通知が存在しない場合は空です。 | |
notification[].enterpriseId |
string |
通知の送信先となる企業の ID。これは常に存在します。 | |
notification[].timestampMillis |
long |
通知がパブリッシュされた時刻(1970-01-01T00:00:00Z からのミリ秒数)。これは常に存在します。 | |
notification[].productApprovalEvent |
nested object |
商品の承認状況の変更に関する通知。 | |
notification[].productApprovalEvent.productId |
string |
承認ステータスが変更された商品の ID(例: app:com.google.android.gm)。このフィールドは常に存在します。 | |
notification[].productApprovalEvent.approved |
string |
商品が承認済みか未承認か。このフィールドは常に存在します。
有効な値は次のとおりです。
|
|
notification[].installFailureEvent |
nested object |
アプリのインストール エラーに関する通知。 | |
notification[].installFailureEvent.productId |
string |
インストール エラー イベントが発生したプロダクトの ID(例: app:com.google.android.gm)。このフィールドは常に存在します。 | |
notification[].installFailureEvent.deviceId |
string |
デバイスの Android ID。このフィールドは常に存在します。 | |
notification[].installFailureEvent.userId |
string |
ユーザーの ID。このフィールドは常に存在します。 | |
notification[].installFailureEvent.failureReason |
string |
インストールが失敗した理由。このフィールドは常に存在します。
有効な値は次のとおりです。
|
|
notification[].installFailureEvent.failureDetails |
string |
失敗に関する補足情報(該当する場合)。 | |
notification[].appUpdateEvent |
nested object |
アプリのアップデートに関する通知。 | |
notification[].appUpdateEvent.productId |
string |
更新された商品の ID(例: app:com.google.android.gm)。このフィールドは常に存在します。 | |
notification[].newPermissionsEvent |
nested object |
新しいアプリの権限に関する通知。 | |
notification[].newPermissionsEvent.productId |
string |
新しい権限が追加されたプロダクトの ID(例: app:com.google.android.gm)。このフィールドは常に存在します。 | |
notification[].newPermissionsEvent.requestedPermissions[] |
list |
アプリが現在リクエストしている権限のセット。これらの権限の詳細を取得するには、EMM API の Permissions.Get を使用します。 | |
notification[].newPermissionsEvent.approvedPermissions[] |
list |
企業の管理者がこのアプリケーションに対してすでに承認している一連の権限。これらの権限の詳細を取得するには、EMM API の Permissions.Get を使用します。 | |
notification[].appRestrictionsSchemaChangeEvent |
nested object |
新しいアプリ制限スキーマの変更に関する通知。 | |
notification[].appRestrictionsSchemaChangeEvent.productId |
string |
アプリ制限スキーマが変更された商品の ID(例: app:com.google.android.gm)。このフィールドは常に存在します。 | |
notification[].productAvailabilityChangeEvent |
nested object |
商品の在庫状況の変更に関する通知。 | |
notification[].productAvailabilityChangeEvent.productId |
string |
商品の在庫状況が変更された商品の ID(例: app:com.google.android.gm)。このフィールドは常に存在します。 | |
notification[].productAvailabilityChangeEvent.availabilityStatus |
string |
商品の新しい状態。このフィールドは常に存在します。
有効な値は次のとおりです。
|
|
notification[].newDeviceEvent |
nested object |
新しいデバイスに関する通知。 | |
notification[].newDeviceEvent.userId |
string |
ユーザーの ID。このフィールドは常に存在します。 | |
notification[].newDeviceEvent.deviceId |
string |
デバイスの Android ID。このフィールドは常に存在します。 | |
notification[].newDeviceEvent.managementType |
string |
さまざまなデプロイ構成で、Android EMM によってデバイスがどの程度制御されているかを示します。 有効な値は次のとおりです。
指定できる値は次のとおりです。 <ph type="x-smartling-placeholder">
|
|
notification[].notificationType |
string |
通知のタイプ。
有効な値は次のとおりです。
|
|
notification[].newDeviceEvent.dpcPackageName |
string |
デバイス上のポリシーアプリ | |
notification[].deviceReportUpdateEvent |
nested object |
デバイス レポートの更新に関する通知。 | |
notification[].deviceReportUpdateEvent.userId |
string |
ユーザーの ID。このフィールドは常に存在します。 | |
notification[].deviceReportUpdateEvent.deviceId |
string |
デバイスの Android ID。このフィールドは常に存在します。 | |
notification[].deviceReportUpdateEvent.report |
nested object |
デバイス レポートが最新のアプリの状態に更新されました。このフィールドは常に存在します。 | |
notification[].deviceReportUpdateEvent.report.lastUpdatedTimestampMillis |
long |
最後のレポート更新のタイムスタンプ(エポックからのミリ秒)。このフィールドは常に存在します。 | |
notification[].deviceReportUpdateEvent.report.appState[] |
list |
デバイス上の管理対象アプリによって設定されるアプリの状態のリスト。アプリの状態は、アプリのデベロッパーが定義します。このフィールドは常に存在します。 | |
notification[].deviceReportUpdateEvent.report.appState[].packageName |
string |
アプリのパッケージ名。このフィールドは常に存在します。 | |
notification[].deviceReportUpdateEvent.report.appState[].keyedAppState[] |
list |
キー付きアプリ状態のリスト。このフィールドは常に存在します。 | |
notification[].deviceReportUpdateEvent.report.appState[].keyedAppState[].key |
string |
アプリが何のために状態を提供しているかを示すキー。キーの内容はアプリのデベロッパーが設定します。XSS を防ぐには、キーを表示する前にキーから HTML をすべて削除することをおすすめします。このフィールドは常に存在します。 | |
notification[].deviceReportUpdateEvent.report.appState[].keyedAppState[].stateTimestampMillis |
long |
アプリが状態を設定したときのタイムスタンプ(エポックからのミリ秒単位)。このフィールドは常に存在します。 | |
notification[].deviceReportUpdateEvent.report.appState[].keyedAppState[].severity |
string |
アプリの状態の重大度。このフィールドは常に存在します。
有効な値は次のとおりです。
|
|
notification[].deviceReportUpdateEvent.report.appState[].keyedAppState[].message |
string |
アプリの状態を説明する、人が読める形式の自由形式のメッセージ。(エラー メッセージなど)。XSS を防ぐために、メッセージを表示する前に、メッセージの HTML をすべて削除することをおすすめします。 | |
notification[].deviceReportUpdateEvent.report.appState[].keyedAppState[].data |
string |
機械読み取り可能なデータのための追加フィールド。(数値や JSON オブジェクトなど)。XSS を防ぐため、表示する前にデータから HTML をすべて削除することをおすすめします。 | |
kind |
string |