مجموعه ای از اعلان را برای شرکت های مرتبط با حساب سرویس تأیید شده برای درخواست دریافت می کند و برمی گرداند. ممکن است مجموعه اعلانها خالی باشد اگر هیچ اعلانی در انتظار نباشد.
یک مجموعه اعلان برگشتی باید ظرف 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 است.مقادیر قابل قبول عبارتند از:
|
مجوز
این درخواست به مجوز با محدوده زیر نیاز دارد:
دامنه |
---|
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 | شناسه اندروید دستگاه. این میدان همیشه وجود خواهد داشت. | |
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.Get در EMM API برای بازیابی جزئیات این مجوزها استفاده کنید. | |
notification[].newPermissionsEvent. approvedPermissions[] | list | مجموعه مجوزهایی که سرپرست سازمان قبلاً برای این برنامه تأیید کرده است. از Permissions.Get در 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 | شناسه اندروید دستگاه. این میدان همیشه وجود خواهد داشت. | |
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 | شناسه اندروید دستگاه. این میدان همیشه وجود خواهد داشت. | |
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 |