Enterprises: pullNotificationSet

שולפת ומחזירה התראה שהוגדרה לארגונים שמשויכים חשבון השירות שאומת בשביל הבקשה. קבוצת ההתראות עשויה ריקה אם אין התראות בהמתנה.
אם קבוצת ההתראות חזרה, צריך לאשר אותה תוך 20 שניות על ידי קריאה ל-Enterprises.AcknowledgeNotificationSet, אלא אם קבוצת ההתראות ריקה.
התראות שלא יאושרו תוך 20 שניות: ייכללו שוב בסופו של דבר בתגובה ל-PullNotificationSet אחר בקשות שלא מאושרות, יימחקו בסופו של דבר בהתאם למדיניות המערכת של Google Cloud Platform Pub/Sub.
יכול להיות שיתבצעו כמה בקשות בו-זמנית לאחזור התראות. במקרה כזה, ההתראות בהמתנה (אם יש כאלה) יתחלקו בין כל מבצע הקריאה החוזרת, אם יש כאלה.
אם לא קיימות התראות, תוחזר רשימת התראות ריקה. בקשות נוספות עשויות להחזיר התראות נוספות ברגע שהן יהיו זמינות.

בקשה

בקשת HTTP

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

פרמטרים

שם הפרמטר ערך תיאור
פרמטרים אופציונליים של שאילתה
requestMode string מצב הבקשה לשליפת התראות.
ציון המאפיין waitForNotifications יגרום לבקשה לחסום ולהמתין עד שתהיה התראה אחת או יותר, או להחזיר התראה רשימת התראות ריקה, אם לא מופיעות התראות לאחר זמן מה.
ציון הערך returnImmediately יגרום לבקשה להחזיר באופן מיידי את ההתראות הממתינות, או רשימה ריקה אם לא התראות קיימות.
אם לא צוין, ברירת המחדל היא waitForNotifications.

הערכים הקבילים הם:
  • "returnImmediately"
  • "waitForNotifications"

אישור

הבקשה הזו מחייבת הרשאה עם ההיקף הבא:

היקף
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 המזהה של קבוצת ההתראות, שנדרש כדי לסמן שההתראה התקבלה באמצעות Enterprises.AcknowledgeNotification API. אם לא יהיו התראות, הן יושמטו.
notification[] list ההתראות שהתקבלו או ריקות אם לא קיימות התראות.
notification[].enterpriseId string המזהה של הארגון שלגביו נשלחת ההתראה. השדה הזה תמיד יופיע.
notification[].timestampMillis long המועד שבו ההתראה פורסמה, באלפיות שנייה מאז 1 בינואר 1970 בשעה 00:00:00Z. השדה הזה תמיד יופיע.
notification[].productApprovalEvent nested object התראות על שינויים בסטטוס האישור של מוצר.
notification[].productApprovalEvent.productId string מזהה המוצר (למשל, 'app:com.google.android.gm') שסטטוס האישור שלו השתנה. השדה הזה תמיד יוצג.
notification[].productApprovalEvent.approved string האם המוצר אושר או לא אושר. השדה הזה תמיד יוצג.

הערכים הקבילים הם:
  • "approved"
  • "unapproved"
  • "unknown"
notification[].installFailureEvent nested object התראות על כשל בהתקנת האפליקציה.
notification[].installFailureEvent.productId string המזהה של המוצר (למשל, 'app:com.google.android.gm') שבו התרחש אירוע כשל ההתקנה. השדה הזה תמיד יופיע.
notification[].installFailureEvent.deviceId string מזהה Android של המכשיר. השדה הזה תמיד יוצג.
notification[].installFailureEvent.userId string המזהה של המשתמש. השדה הזה תמיד יוצג.
notification[].installFailureEvent.failureReason string הסיבה לכשל בהתקנה. השדה הזה תמיד יוצג.

הערכים הקבילים הם:
  • "timeout"
  • "unknown"
notification[].installFailureEvent.failureDetails string פרטים נוספים על הכשל, אם רלוונטי.
notification[].appUpdateEvent nested object התראות לגבי עדכוני אפליקציות.
notification[].appUpdateEvent.productId string המזהה של המוצר (למשל, 'app:com.google.android.gm') שעודכן. השדה הזה תמיד יוצג.
notification[].newPermissionsEvent nested object התראות על הרשאות חדשות לאפליקציות.
notification[].newPermissionsEvent.productId string מזהה המוצר (למשל, 'app:com.google.android.gm') שעבורו נוספו הרשאות חדשות. השדה הזה תמיד יופיע.
notification[].newPermissionsEvent.requestedPermissions[] list קבוצת ההרשאות שהאפליקציה מבקשת כרגע. כדי לאחזר פרטים על ההרשאות האלה, משתמשים ב-Permissions.Get ב-EMM API.
notification[].newPermissionsEvent.approvedPermissions[] list קבוצת ההרשאות שהאדמין בארגון כבר אישר לאפליקציה הזו. כדי לאחזר פרטים על ההרשאות האלה, צריך להשתמש ב'הרשאות'. כדאי להיכנס ל-API של EMM.
notification[].appRestrictionsSchemaChangeEvent nested object התראות על שינויים חדשים בסכימה של ההגבלות על האפליקציות.
notification[].appRestrictionsSchemaChangeEvent.productId string מזהה המוצר (למשל, 'app:com.google.android.gm') שבו השתנתה סכימת ההגבלות על האפליקציה. השדה הזה תמיד יוצג.
notification[].productAvailabilityChangeEvent nested object התראות על שינויים בזמינות של מוצרים.
notification[].productAvailabilityChangeEvent.productId string מזהה המוצר (למשל, 'app:com.google.android.gm') שעבורו זמינות המוצר השתנתה. השדה הזה תמיד יוצג.
notification[].productAvailabilityChangeEvent.availabilityStatus string המצב החדש של המוצר. השדה הזה תמיד יופיע.

הערכים הקבילים הם:
  • "available"
  • "removed"
  • "unknown"
  • "unpublished"
notification[].newDeviceEvent nested object התראות על מכשירים חדשים.
notification[].newDeviceEvent.userId string המזהה של המשתמש. השדה הזה תמיד יוצג.
notification[].newDeviceEvent.deviceId string מזהה ה-Android של המכשיר. השדה הזה תמיד יוצג.
notification[].newDeviceEvent.managementType string מזהה את המידה שבה המכשיר נשלט על ידי EMM של Android בתצורות פריסה שונות.

הערכים האפשריים כוללים:
  • managedDevice – מכשיר שבו בקר ה-DPC מוגדר כבעלים של המכשיר,
  • managedProfile, מכשיר שבו ה-DPC מוגדר כבעלים של הפרופיל.


הערכים הקבילים הם:
  • "managedDevice"
  • "managedProfile"
notification[].notificationType string סוג ההתראה.

הערכים הקבילים הם:
  • "appRestricionsSchemaChange"
  • "appUpdate"
  • "deviceReportUpdate"
  • "installFailure"
  • "newDevice"
  • "newPermissions"
  • "productApproval"
  • "productAvailabilityChange"
  • "testNotification"
  • "unknown"
notification[].newDeviceEvent.dpcPackageName string אפליקציית המדיניות במכשיר.
notification[].deviceReportUpdateEvent nested object התראות לגבי עדכונים לגבי דיווח על מכשירים.
notification[].deviceReportUpdateEvent.userId string המזהה של המשתמש. השדה הזה תמיד יוצג.
notification[].deviceReportUpdateEvent.deviceId string מזהה ה-Android של המכשיר. השדה הזה תמיד יוצג.
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 חותמת הזמן של המועד שבו האפליקציה הגדירה את המצב, באלפיות השנייה מאז epoch. השדה הזה תמיד יוצג.
notification[].deviceReportUpdateEvent.report.appState[].keyedAppState[].severity string חומרת מצב האפליקציה. השדה הזה תמיד יוצג.

הערכים הקבילים הם:
  • "severityError"
  • "severityInfo"
notification[].deviceReportUpdateEvent.report.appState[].keyedAppState[].message string הודעה שכתובה בצורה חופשית וקריאה לאנשים, שמתארת את מצב האפליקציה. לדוגמה, הודעת שגיאה. כדי למנוע XSS, מומלץ להסיר HTML מההודעה לפני הצגתו.
notification[].deviceReportUpdateEvent.report.appState[].keyedAppState[].data string שדה נוסף המיועד לנתונים קריאים למחשבים. לדוגמה, מספר או אובייקט JSON. כדי למנוע XSS, מומלץ להסיר HTML מהנתונים לפני הצגתו.
kind string