תשלוף ותחזיר התראה שהוגדרה לארגונים המשויכים לחשבון השירות שאומת עבור הבקשה. אם אין התראה בהמתנה, קבוצת ההתראות עשויה להיות ריקה.
כדי לקבל אישור בתוך 20 שניות, עליך לקבל אישור מארגון מסוים.AcknowledgeNotificationSet, אלא אם קבוצת ההתראות ריקה.
הודעות שלא מקבלים אישור בתוך 20 שניות יתווספו בסופו של דבר בתגובה לבקשה אחרת של PullNotificationSet, והודעות שלא יוענקו בעתיד יימחקו בהתאם למדיניות המערכת של Google Cloud Platform Pub/Sub.
ניתן לבצע מספר בקשות בו-זמנית כדי לאחזר התראות, ובמקרה כזה ההתראות הממתינות (אם יהיו) יפוצלו בין כל המתקשרים, אם יש כאלה.
אם לא מוצגות התראות, מוצגת רשימה ריקה של התראות.
הבקשות הבאות עשויות להחזיר התראות נוספות ברגע שיהיו זמינות.
שליחת בקשה
בקשת HTTP
POST https://www.googleapis.com/androidenterprise/v1/enterprises/pullNotificationSet
פרמטרים
שם הפרמטר | ערך | תיאור |
---|---|---|
פרמטרים אופציונליים של שאילתה | ||
requestMode |
string |
מצב הבקשה לאחזור התראות.
ציון הערך 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 |
השעה שבה ההודעה פורסמה באלפיות השנייה מאז 1970-01-01T00:00:00Z. ההגדרה הזו תמיד תופיע. | |
notification[].productApprovalEvent |
nested object |
התראות על שינויים בסטטוס האישור של מוצר. | |
notification[].productApprovalEvent.productId |
string |
המזהה של המוצר (למשל, "app:com.google.android.gm") שסטטוס האישור שלו השתנה. השדה הזה תמיד יופיע. | |
notification[].productApprovalEvent.approved |
string |
אם המוצר אושר או לא אושר. השדה הזה תמיד יופיע.
הערכים הקבילים הם:
|
|
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 |
הסיבה לכשל בהתקנה. השדה הזה תמיד יופיע.
הערכים הקבילים הם:
|
|
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.כדי לקבל פרטים על ההרשאות האלה, יש להשתמש ב-EMM API. | |
notification[].newPermissionsEvent.approvedPermissions[] |
list |
קבוצת ההרשאות שמנהל המערכת הארגוני כבר אישר עבור האפליקציה הזו. אפשר להשתמש ב-Permissions.כדי לקבל פרטים על ההרשאות האלה, יש להשתמש ב-EMM API. | |
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 |
המצב החדש של המוצר. השדה הזה תמיד יופיע.
הערכים הקבילים הם:
|
|
notification[].newDeviceEvent |
nested object |
התראות לגבי מכשירים חדשים. | |
notification[].newDeviceEvent.userId |
string |
המזהה של המשתמש. השדה הזה תמיד יופיע. | |
notification[].newDeviceEvent.deviceId |
string |
מזהה Android של המכשיר. השדה הזה תמיד יופיע. | |
notification[].newDeviceEvent.managementType |
string |
מזהה את המידה שבה המכשיר נשלט על ידי ה-EMM ב-Android במגוון פריסות פריסה. הערכים האפשריים כוללים:
הערכים הקבילים הם:
|
|
notification[].notificationType |
string |
סוג ההתראה.
הערכים הקבילים הם:
|
|
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 |
חותמת הזמן של המועד שבו האפליקציה הגדירה את המצב באלפיות השנייה מתחילת התקופה. השדה הזה תמיד יופיע. | |
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 |