Method: projects.androidApps.deliveryData.list

แสดงรายการข้อมูลการนำส่งรวมสำหรับแอปพลิเคชัน Android ที่ระบุ

คำขอ HTTP

GET https://fcmdata.googleapis.com/v1beta1/{parent=projects/*/androidApps/*}/deliveryData

URL ใช้ไวยากรณ์การแปลง gRPC

พารามิเตอร์เส้นทาง

พารามิเตอร์
parent

string

ต้องระบุ แอปพลิเคชันสำหรับแสดงข้อมูลการนำส่ง รูปแบบ: projects/{projectId}/androidApps/{appId}

พารามิเตอร์การค้นหา

พารามิเตอร์
pageSize

integer

จำนวนรายการสูงสุดที่จะแสดง บริการอาจแสดงผลน้อยกว่าค่านี้ หากไม่ระบุ ระบบจะแสดงผลไม่เกิน 1,000 รายการ ค่าสูงสุดคือ 10,000 ค่าที่มากกว่า 10,000 จะถูกจำกัดไว้ที่ 10,000 ซึ่งค่าเริ่มต้นนี้อาจเปลี่ยนแปลงเมื่อเวลาผ่านไป

pageToken

string

โทเค็นของหน้าเว็บที่ได้รับจากการโทร ListAndroidDeliveryDataRequest ก่อนหน้า ระบุพารามิเตอร์นี้เพื่อเรียกข้อมูลหน้าถัดไป เมื่อใส่เลขหน้า พารามิเตอร์อื่นๆ ทั้งหมดที่ให้กับ ListAndroidDeliveryDataRequest ต้องตรงกับการเรียกใช้ที่ระบุโทเค็นของหน้าเว็บ

เนื้อความของคำขอ

เนื้อหาของคำขอต้องว่างเปล่า

เนื้อหาการตอบกลับ

ข้อความตอบกลับสำหรับ deliveryData.list

หากทำสำเร็จ เนื้อหาการตอบกลับจะมีข้อมูลที่มีโครงสร้างต่อไปนี้

การแสดง JSON
{
  "androidDeliveryData": [
    {
      object (AndroidDeliveryData)
    }
  ],
  "nextPageToken": string
}
ช่อง
androidDeliveryData[]

object (AndroidDeliveryData)

ข้อมูลการนำส่งของแอปที่ระบุ โดยแต่ละชุดจะมีรายการแอป วันที่ และป้ายกำกับข้อมูลวิเคราะห์อยู่ 1 รายการ

nextPageToken

string

โทเค็นซึ่งสามารถส่งเป็น pageToken เพื่อเรียกข้อมูลหน้าถัดไป หากเว้นช่องนี้ไว้ จะไม่มีหน้าลำดับต่อมา

ขอบเขตการให้สิทธิ์

ต้องใช้ขอบเขต OAuth ต่อไปนี้

  • https://www.googleapis.com/auth/cloud-platform

ข้อมูลการนำส่งของ Android

ข้อมูลการส่งข้อความสำหรับชุดค่าผสมวันที่ แอป และป้ายกำกับข้อมูลวิเคราะห์หนึ่งๆ

การแสดง JSON
{
  "appId": string,
  "date": {
    object (Date)
  },
  "analyticsLabel": string,
  "data": {
    object (Data)
  }
}
ช่อง
appId

string

รหัสแอปที่ส่งข้อความถึง

date

object (Date)

วันที่ที่แสดงในรายการนี้

analyticsLabel

string

ป้ายกำกับข้อมูลวิเคราะห์ที่เชื่อมโยงกับข้อความที่ส่ง ระบบจะจัดกลุ่มข้อความทั้งหมดที่ส่งโดยไม่มีป้ายกำกับข้อมูลวิเคราะห์ไว้ด้วยกันในรายการเดียว

data

object (Data)

ข้อมูลของ appId, date และ analyticsLabel ที่ระบุ

วันที่

แสดงวันที่ในปฏิทินบางส่วนหรือทั้งหมด เช่น วันเกิด มีการระบุเวลาของวันและเขตเวลาไว้ที่อื่นหรือไม่มีนัยสำคัญ วันที่จะสัมพันธ์กับปฏิทินเกรกอเรียน ซึ่งอาจเป็นอย่างใดอย่างหนึ่งต่อไปนี้

  • วันที่แบบเต็ม โดยมีค่าปี เดือน และวันที่ไม่ใช่ 0
  • 1 เดือนและวัน โดยมี 0 ปี (เช่น วันครบรอบ)
  • ปีหนึ่งๆ มี 0 เดือนและมี 0 วัน
  • 1 ปีและเดือน โดยมี 0 วัน (เช่น วันที่หมดอายุของบัตรเครดิต)

ประเภทที่เกี่ยวข้อง:

การแสดง JSON
{
  "year": integer,
  "month": integer,
  "day": integer
}
ช่อง
year

integer

ปีของวันที่ ต้องเป็นตัวเลขตั้งแต่ 1 ถึง 9999 หรือ 0 เพื่อระบุวันที่ที่ไม่มีปี

month

integer

เดือนของปี ต้องมีค่าตั้งแต่ 1 ถึง 12 หรือ 0 เพื่อระบุปีที่ไม่มีเดือนและวัน

day

integer

วันของเดือน ต้องมีค่าตั้งแต่ 1 ถึง 31 และจะใช้ได้สำหรับปีและเดือน หรือ 0 เพื่อระบุปีเพียงอย่างเดียว หรือ 1 ปีและเดือนที่วันไม่มีนัยสำคัญ

ข้อมูล

ข้อมูลที่แสดงรายละเอียดเกี่ยวกับการส่งข้อความ

การแสดง JSON
{
  "countMessagesAccepted": string,
  "countNotificationsAccepted": string,
  "messageOutcomePercents": {
    object (MessageOutcomePercents)
  },
  "deliveryPerformancePercents": {
    object (DeliveryPerformancePercents)
  },
  "messageInsightPercents": {
    object (MessageInsightPercents)
  },
  "proxyNotificationInsightPercents": {
    object (ProxyNotificationInsightPercents)
  }
}
ช่อง
countMessagesAccepted

string (int64 format)

จำนวนข้อความที่ FCM ยอมรับสำหรับอุปกรณ์ Android อุปกรณ์เป้าหมายต้องเลือกใช้การรวบรวมข้อมูลการใช้งานและการวินิจฉัย

countNotificationsAccepted

string (int64 format)

จำนวนการแจ้งเตือนที่ FCM ยอมรับสำหรับอุปกรณ์ Android อุปกรณ์เป้าหมายต้องเลือกใช้การรวบรวมข้อมูลการใช้งานและการวินิจฉัย

messageOutcomePercents

object (MessageOutcomePercents)

รายละเอียดเฉพาะสำหรับผลลัพธ์การส่งข้อความ

deliveryPerformancePercents

object (DeliveryPerformancePercents)

ข้อมูลเพิ่มเติมเกี่ยวกับประสิทธิภาพการนำส่งสำหรับข้อความที่ส่งสำเร็จ

messageInsightPercents

object (MessageInsightPercents)

ข้อมูลเชิงลึกทั่วไปเพิ่มเติมเกี่ยวกับการส่งข้อความ

proxyNotificationInsightPercents

object (ProxyNotificationInsightPercents)

ข้อมูลเชิงลึกเพิ่มเติมเกี่ยวกับการส่งการแจ้งเตือนพร็อกซี

MessageresultPercents

รายละเอียดเปอร์เซ็นต์ของผลลัพธ์การส่งข้อความ หมวดหมู่เหล่านี้ไม่เกี่ยวข้องกัน เปอร์เซ็นต์ทั้งหมดจะคำนวณโดยใช้ countMessagesAccepted เป็นตัวหาร หมวดหมู่เหล่านี้อาจไม่ได้คำนึงถึงผลลัพธ์ข้อความทั้งหมด

การแสดง JSON
{
  "delivered": number,
  "pending": number,
  "collapsed": number,
  "droppedTooManyPendingMessages": number,
  "droppedAppForceStopped": number,
  "droppedDeviceInactive": number,
  "droppedTtlExpired": number
}
ช่อง
delivered

number

เปอร์เซ็นต์ของข้อความที่ยอมรับทั้งหมดที่ส่งไปยังอุปกรณ์ได้สำเร็จ

pending

number

เปอร์เซ็นต์ของข้อความที่ยอมรับในวันนี้แต่ไม่ได้ส่งและไม่ได้ส่ง เนื่องจากอุปกรณ์ถูกตัดการเชื่อมต่อ (ณ สิ้นวัน America/Los_Angeles เมื่อมีการส่งข้อความไปยัง FCM) ระบบจะส่งส่วนหนึ่งของข้อความเหล่านี้ในวันถัดไปเมื่ออุปกรณ์เชื่อมต่อ แต่ข้อความอื่นๆ อาจส่งไปที่อุปกรณ์ที่ไม่เชื่อมต่อใหม่ในที่สุด

collapsed

number

เปอร์เซ็นต์ของข้อความที่ยอมรับซึ่งข้อความอื่นยุบ

droppedTooManyPendingMessages

number

เปอร์เซ็นต์ของข้อความที่ยอมรับซึ่งถูกปฏิเสธเนื่องจากมีข้อความที่ยุบไม่ได้ซึ่งส่งไม่ได้จำนวนมากเกินไป กล่าวอย่างเจาะจงคือ อินสแตนซ์ของแอปแต่ละรายการสามารถจัดเก็บข้อความที่รอดำเนินการได้ 100 ข้อความเท่านั้นบนเซิร์ฟเวอร์ของเราสำหรับอุปกรณ์ที่ไม่ได้เชื่อมต่อ เมื่ออุปกรณ์นั้นเชื่อมต่ออีกครั้ง ระบบจะส่งข้อความดังกล่าว เมื่อมีข้อความที่รอดำเนินการมากกว่าจำนวนสูงสุด เราจะเรียก OnClosedMessages() ใน SDK แทนการส่งข้อความ

droppedAppForceStopped

number

เปอร์เซ็นต์ของข้อความที่ยอมรับถูกปฏิเสธเนื่องจากแอปพลิเคชันถูกบังคับให้หยุดลงบนอุปกรณ์ ณ เวลาที่ส่ง และการลองใหม่ไม่สำเร็จ

droppedDeviceInactive

number

เปอร์เซ็นต์ของข้อความที่ยอมรับซึ่งถูกปฏิเสธเนื่องจากไม่มีการใช้งานอุปกรณ์เป้าหมาย FCM จะส่งข้อความออกหากเซิร์ฟเวอร์ของเราพิจารณาว่าอุปกรณ์เป้าหมายไม่มีการใช้งาน หากอุปกรณ์เชื่อมต่ออีกครั้ง เราจะเรียกใช้ OnDeletedMessages() ใน SDK แทนการส่งข้อความ

droppedTtlExpired

number

เปอร์เซ็นต์ของข้อความที่ยอมรับซึ่งหมดอายุเนื่องจาก Time To Live (TTL) ผ่านไปก่อนที่อุปกรณ์เป้าหมายจะเชื่อมต่ออีกครั้ง

เปอร์เซ็นต์ประสิทธิภาพการแสดงโฆษณา

ภาพรวมของประสิทธิภาพการส่งสำหรับข้อความที่ส่งสำเร็จ เปอร์เซ็นต์ทั้งหมดจะคำนวณโดยใช้ countMessagesAccepted เป็นตัวหาร หมวดหมู่เหล่านี้แยกออกต่างหากไม่ได้ ข้อความอาจล่าช้าด้วยเหตุผลหลายประการ

การแสดง JSON
{
  "deliveredNoDelay": number,
  "delayedDeviceOffline": number,
  "delayedDeviceDoze": number,
  "delayedMessageThrottled": number,
  "delayedUserStopped": number
}
ช่อง
deliveredNoDelay

number

เปอร์เซ็นต์ของข้อความที่ยอมรับซึ่งส่งไปยังอุปกรณ์โดยไม่มีความล่าช้าจากระบบ FCM

delayedDeviceOffline

number

เปอร์เซ็นต์ของข้อความที่ยอมรับซึ่งล่าช้าเนื่องจากอุปกรณ์เป้าหมายไม่ได้เชื่อมต่อในขณะที่ส่ง ข้อความเหล่านี้จะส่งออกไปในที่สุดเมื่ออุปกรณ์เชื่อมต่ออีกครั้ง

delayedDeviceDoze

number

เปอร์เซ็นต์ของข้อความที่ยอมรับซึ่งล่าช้าเนื่องจากอุปกรณ์อยู่ในโหมด Doze ล่าช้าเฉพาะข้อความที่มีลำดับความสำคัญปกติเนื่องจากโหมด Doze

delayedMessageThrottled

number

เปอร์เซ็นต์ของข้อความที่ยอมรับซึ่งล่าช้าเนื่องจากการควบคุมข้อความ เช่น การควบคุมข้อความที่ยุบได้หรือการควบคุมอัตราข้อความสูงสุด

delayedUserStopped

number

เปอร์เซ็นต์ของข้อความที่ยอมรับซึ่งล่าช้าเนื่องจากมีการหยุดโปรไฟล์ผู้ใช้ในอุปกรณ์เป้าหมายขณะส่ง ระบบส่งข้อความในที่สุดเมื่อมีการเริ่มต้นโปรไฟล์ผู้ใช้อีกครั้ง

MessageInsightPercents

ข้อมูลเพิ่มเติมเกี่ยวกับการส่งข้อความ เปอร์เซ็นต์ทั้งหมดจะคำนวณโดยใช้ countMessagesAccepted เป็นตัวหาร

การแสดง JSON
{
  "priorityLowered": number
}
ช่อง
priorityLowered

number

เปอร์เซ็นต์ของข้อความที่ยอมรับซึ่งมีลำดับความสำคัญลดลงจากสูงไปเป็นปกติ โปรดดูเอกสารประกอบเกี่ยวกับการตั้งค่าลำดับความสำคัญของข้อความ

ProxyNotificationInsightPercent

ข้อมูลเพิ่มเติมเกี่ยวกับการส่งการแจ้งเตือนผ่านพร็อกซี เปอร์เซ็นต์ทั้งหมดจะคำนวณโดยใช้ countNotificationsAccepted เป็นตัวหาร

การแสดง JSON
{
  "proxied": number,
  "failed": number,
  "skippedUnsupported": number,
  "skippedNotThrottled": number,
  "skippedUnconfigured": number,
  "skippedOptedOut": number
}
ช่อง
proxied

number

เปอร์เซ็นต์ของการแจ้งเตือนที่ยอมรับซึ่งบริการ Google Play ทำพร็อกซีได้สำเร็จ

failed

number

เปอร์เซ็นต์ของการแจ้งเตือนที่ยอมรับซึ่งส่งพร็อกซีไม่สำเร็จ โดยทั่วไปกรณีนี้มักเกิดจากข้อยกเว้นที่เกิดขึ้นขณะเรียกใช้ notifyAsPackage

skippedUnsupported

number

เปอร์เซ็นต์ของการแจ้งเตือนที่ยอมรับซึ่งข้าม เนื่องจากผู้รับไม่รองรับการแจ้งเตือนผ่านพร็อกซี

skippedNotThrottled

number

เปอร์เซ็นต์ของการแจ้งเตือนที่ยอมรับซึ่งข้ามเนื่องจากไม่มีการควบคุมข้อความ

skippedUnconfigured

number

เปอร์เซ็นต์ของการแจ้งเตือนที่ยอมรับซึ่งถูกข้ามเนื่องจากไม่มีการกำหนดค่าที่จำเป็นสำหรับการใช้พร็อกซีสำหรับการแจ้งเตือน

skippedOptedOut

number

เปอร์เซ็นต์ของการแจ้งเตือนที่ยอมรับซึ่งข้ามเนื่องจากแอปไม่อนุญาตให้ข้อความเหล่านี้ส่งผ่านพร็อกซี