- درخواست HTTP
- پارامترهای مسیر
- پارامترهای پرس و جو
- درخواست بدن
- بدن پاسخگو
- محدوده مجوز
- AndroidDeliveryData
- تاریخ
- داده ها
- MessageOutcomePercents
- درصد عملکرد تحویل
- MessageInsightPercents
- آن را امتحان کنید!
داده های تحویل انبوه را برای برنامه Android داده شده فهرست کنید.
درخواست HTTP
GET https://fcmdata.googleapis.com/v1beta1/{parent=projects/*/androidApps/*}/deliveryData
URL از دستور GRPC Transcoding استفاده می کند.
پارامترهای مسیر
مولفه های | |
---|---|
parent | ضروری. برنامهای که دادههای تحویل را فهرست میکند. قالب: |
پارامترهای پرس و جو
مولفه های | |
---|---|
pageSize | حداکثر تعداد ورودی برای بازگشت. این سرویس ممکن است کمتر از این مقدار را بازگرداند. اگر نامشخص باشد، حداکثر 1000 ورودی برگردانده می شود. حداکثر مقدار 10000 است. مقادیر بالای 10000 به 10000 محدود می شود. این پیش فرض ممکن است در طول زمان تغییر کند. |
pageToken | یک نشانه صفحه، دریافت شده از تماس قبلی |
درخواست بدن
بدنه درخواست باید خالی باشد.
بدن پاسخگو
در صورت موفقیت آمیز بودن، بدنه پاسخ حاوی داده هایی با ساختار زیر است:
پیام پاسخ برای deliveryData.list.
نمایندگی JSON |
---|
{
"androidDeliveryData": [
{
object ( |
زمینه های | |
---|---|
androidDeliveryData[] | داده های تحویل برای برنامه ارائه شده. برای هر ترکیبی از برنامه، تاریخ و برچسب تجزیه و تحلیل، یک ورودی وجود خواهد داشت. |
nextPageToken | یک نشانه، که می تواند به عنوان |
محدوده مجوز
به محدوده OAuth زیر نیاز دارد:
-
https://www.googleapis.com/auth/cloud-platform
AndroidDeliveryData
داده های تحویل پیام برای یک تاریخ معین، برنامه و ترکیب برچسب تجزیه و تحلیل.
نمایندگی JSON |
---|
{ "appId": string, "date": { object ( |
زمینه های | |
---|---|
appId | شناسه برنامه ای که پیام ها به آن ارسال شده است. |
date | تاریخ نشان داده شده توسط این ورودی. |
analyticsLabel | برچسب تجزیه و تحلیل مرتبط با پیام های ارسال شده. همه پیامهایی که بدون برچسب تجزیه و تحلیل ارسال میشوند در یک ورودی گروهبندی میشوند. |
data | دادههای مربوط به |
تاریخ
نمایانگر یک تاریخ تقویم کامل یا جزئی، مانند روز تولد است. زمان روز و منطقه زمانی یا در جای دیگری مشخص شده است یا ناچیز است. تاریخ مربوط به تقویم میلادی است. این می تواند نشان دهنده یکی از موارد زیر باشد:
- تاریخ کامل، با مقادیر سال، ماه و روز غیر صفر.
- یک ماه و روز، با یک سال صفر (مثلاً یک سالگرد).
- یک سال به تنهایی، با یک ماه صفر و یک روز صفر.
- یک سال و یک ماه، با روز صفر (مثلاً تاریخ انقضای کارت اعتباری).
انواع مرتبط:
-
google.type.TimeOfDay
-
google.type.DateTime
-
google.protobuf.Timestamp
نمایندگی JSON |
---|
{ "year": integer, "month": integer, "day": integer } |
زمینه های | |
---|---|
year | سال تاریخ. برای تعیین تاریخ بدون سال باید از 1 تا 9999 یا 0 باشد. |
month | ماه از یک سال. باید از 1 تا 12 یا 0 باشد تا یک سال بدون ماه و روز مشخص شود. |
day | روز یک ماه. باید از 1 تا 31 باشد و برای سال و ماه معتبر باشد، یا 0 برای مشخص کردن یک سال به تنهایی یا یک سال و ماهی که در آن روز مهم نیست، معتبر باشد. |
داده ها
جزئیات تحویل پیام
نمایندگی JSON |
---|
{ "countMessagesAccepted": string, "messageOutcomePercents": { object ( |
زمینه های | |
---|---|
countMessagesAccepted | تعداد پیامهای پذیرفته شده توسط FCM برای دستگاههای Android. دستگاه مورد نظر باید در جمع آوری اطلاعات استفاده و تشخیصی شرکت کرده باشد. |
messageOutcomePercents | تفکیک منحصر به فرد متقابل از نتایج تحویل پیام. |
deliveryPerformancePercents | اطلاعات اضافی درباره عملکرد تحویل پیامهایی که با موفقیت تحویل داده شدند. |
messageInsightPercents | بینش عمومی اضافی درباره تحویل پیام. |
MessageOutcomePercents
درصد تفکیک نتایج تحویل پیام. این دسته بندی ها متقابل هستند. همه درصدها با countMessagesAccepted
به عنوان مخرج محاسبه می شوند. این دستهها ممکن است برای همه پیامدهای پیام در نظر نگیرند.
نمایندگی JSON |
---|
{ "delivered": number, "pending": number, "droppedTooManyPendingMessages": number, "droppedAppForceStopped": number, "droppedDeviceInactive": number } |
زمینه های | |
---|---|
delivered | درصد تمام پیامهای پذیرفته شده که با موفقیت به دستگاه تحویل داده شدند. |
pending | درصد پیامهای پذیرفتهشده در این روز که به دلیل قطع شدن دستگاه، حذف نشدند و تحویل داده نشدند (از پایان روز آمریکا/لس_آنجلس که پیام به FCM ارسال شد). بخشی از این پیامها روز بعد هنگام اتصال دستگاه تحویل داده میشود، اما ممکن است قسمتی از این پیامها به دستگاههایی ارسال شود که در نهایت هرگز دوباره وصل نمیشوند. |
droppedTooManyPendingMessages | درصد پیامهای پذیرفتهشده که به دلیل تعداد زیاد پیامهای غیرقابل جمعشدگی تحویلنگرفته حذف شدند. به طور خاص، هر نمونه برنامه فقط می تواند 100 پیام معلق در سرورهای ما برای دستگاهی که قطع شده است ذخیره کند. هنگامی که آن دستگاه دوباره وصل می شود، آن پیام ها تحویل داده می شوند. زمانی که تعداد پیامهای معلق بیشتر از حداکثر باشد، به جای ارسال پیامها ، OnDeletedMessages() را در SDK خود فراخوانی میکنیم. |
droppedAppForceStopped | درصد پیامهای پذیرفتهشده که به دلیل توقف اجباری برنامه در دستگاه در زمان تحویل و تلاشهای مجدد ناموفق بودند، حذف شدند. |
droppedDeviceInactive | درصد پیام های پذیرفته شده که به دلیل غیرفعال بودن دستگاه مورد نظر حذف شده اند. اگر دستگاه مورد نظر توسط سرورهای ما غیرفعال تشخیص داده شود، FCM پیامها را ارسال میکند. اگر دستگاهی دوباره وصل شد، به جای ارسال پیامها ، OnDeletedMessages() را در SDK خود فراخوانی میکنیم. |
درصد عملکرد تحویل
نمای کلی عملکرد تحویل برای پیام هایی که با موفقیت تحویل داده شدند. همه درصدها با countMessagesAccepted
به عنوان مخرج محاسبه می شوند. این دسته بندی ها متقابلاً منحصر به فرد نیستند. یک پیام به دلایل متعددی می تواند به تعویق بیفتد.
نمایندگی JSON |
---|
{ "deliveredNoDelay": number, "delayedDeviceOffline": number, "delayedDeviceDoze": number, "delayedMessageThrottled": number, "delayedUserStopped": number } |
زمینه های | |
---|---|
deliveredNoDelay | درصد پیام های پذیرفته شده که بدون تاخیر از سیستم FCM به دستگاه تحویل داده شده است. |
delayedDeviceOffline | درصد پیامهای پذیرفتهشده که به دلیل متصل نبودن دستگاه مورد نظر در زمان ارسال با تأخیر مواجه شدهاند. این پیام ها در نهایت با اتصال مجدد دستگاه تحویل داده شدند. |
delayedDeviceDoze | درصد پیامهای پذیرفتهشده که به دلیل اینکه دستگاه در حالت دوز قرار داشت، با تأخیر مواجه شدند. فقط پیام های اولویت عادی باید به دلیل حالت چرت زدن به تاخیر بیفتند. |
delayedMessageThrottled | درصد پیامهای پذیرفتهشدهای که بهدلیل خفهشدن پیام به تأخیر افتادهاند، مانند خفهشدن پیام قابل جمعکردن یا کاهش حداکثر نرخ پیام . |
delayedUserStopped | درصد پیامهای پذیرفتهشده که به دلیل توقف نمایه کاربر دستگاه مورد نظر در دستگاه مورد نظر در زمان ارسال، با تأخیر مواجه شدند. پیامها در نهایت با راهاندازی مجدد نمایه کاربر تحویل داده شدند. |
MessageInsightPercents
اطلاعات تکمیلی در مورد تحویل پیام همه درصدها با countMessagesAccepted
به عنوان مخرج محاسبه می شوند.
نمایندگی JSON |
---|
{ "priorityLowered": number } |
زمینه های | |
---|---|
priorityLowered | درصد پیام های پذیرفته شده که اولویت آنها از زیاد به عادی کاهش یافته است. برای تنظیم اولویت پیام به اسناد مراجعه کنید. |