- בקשת HTTP
- פרמטרים של נתיב
- פרמטרי שאילתה
- גוף הבקשה
- גוף תגובה
- היקף ההרשאה
- AndroidDeliveryData
- תַאֲרִיך
- נתונים
- MessageOutcomePercents
- ביצועי משלוח אחוזים
- MessageInsightPercents
- נסה זאת!
רשום נתוני מסירה מצטברים עבור אפליקציית Android הנתונה.
בקשת HTTP
GET https://fcmdata.googleapis.com/v1beta1/{parent=projects/*/androidApps/*}/deliveryData
כתובת האתר משתמשת בתחביר GRPC Transcoding .
פרמטרים של נתיב
פרמטרים | |
---|---|
parent | נדרש. האפליקציה שעבורה רשום נתוני מסירה. פורמט: |
פרמטרי שאילתה
פרמטרים | |
---|---|
pageSize | המספר המרבי של ערכים להחזרה. ייתכן שהשירות יחזיר פחות מהערך הזה. אם לא יצוין, לכל היותר 1,000 ערכים יוחזרו. הערך המקסימלי הוא 10,000; ערכים מעל 10,000 יהיו מוגבלים ל-10,000. ברירת מחדל זו עשויה להשתנות עם הזמן. |
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 | אחוז ההודעות המקובלות שעדיפותן ירדה מגבוה לרגיל. עיין בתיעוד להגדרת עדיפות הודעה . |