Method: projects.androidApps.deliveryData.list

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

คำขอ HTTP

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

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

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

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

string

ที่จำเป็น. แอปพลิเคชันสำหรับแสดงรายการข้อมูลการจัดส่ง รูปแบบ: projects/{project_id}/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 )

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

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 ที่ระบุ

วันที่

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

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

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

การเป็นตัวแทน JSON
{
  "year": integer,
  "month": integer,
  "day": integer
}
เขตข้อมูล
year

integer

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

month

integer

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

day

integer

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

ข้อมูล

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

การเป็นตัวแทน JSON
{
  "countMessagesAccepted": string,
  "messageOutcomePercents": {
    object (MessageOutcomePercents)
  },
  "deliveryPerformancePercents": {
    object (DeliveryPerformancePercents)
  },
  "messageInsightPercents": {
    object (MessageInsightPercents)
  }
}
เขตข้อมูล
countMessagesAccepted

string ( int64 format)

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

messageOutcomePercents

object ( MessageOutcomePercents )

การแจกแจงผลลัพธ์การส่งข้อความที่ไม่เกิดร่วมกัน

deliveryPerformancePercents

object ( DeliveryPerformancePercents )

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

messageInsightPercents

object ( MessageInsightPercents )

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

ข้อความผลลัพธ์เปอร์เซ็นต์

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

การเป็นตัวแทน JSON
{
  "delivered": number,
  "pending": number,
  "droppedTooManyPendingMessages": number,
  "droppedAppForceStopped": number,
  "droppedDeviceInactive": number
}
เขตข้อมูล
delivered

number

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

pending

number

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

droppedTooManyPendingMessages

number

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

droppedAppForceStopped

number

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

droppedDeviceInactive

number

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

เปอร์เซ็นต์ประสิทธิภาพการจัดส่ง

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

การเป็นตัวแทน JSON
{
  "deliveredNoDelay": number,
  "delayedDeviceOffline": number,
  "delayedDeviceDoze": number,
  "delayedMessageThrottled": number,
  "delayedUserStopped": number
}
เขตข้อมูล
deliveredNoDelay

number

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

delayedDeviceOffline

number

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

delayedDeviceDoze

number

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

delayedMessageThrottled

number

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

delayedUserStopped

number

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

ข้อความข้อมูลเชิงลึกเปอร์เซ็นต์

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

การเป็นตัวแทน JSON
{
  "priorityLowered": number
}
เขตข้อมูล
priorityLowered

number

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