- คำขอ HTTP
- พารามิเตอร์เส้นทาง
- เนื้อหาคำขอ
- เนื้อหาการตอบกลับ
- ขอบเขตการให้สิทธิ์
- RunReportRequest
- ลองใช้งาน
แสดงผลรายงานหลายรายการเป็นกลุ่ม รายงานทั้งหมดต้องเป็นสําหรับพร็อพเพอร์ตี้ GA4 เดียวกัน
คำขอ HTTP
POST https://analyticsdata.googleapis.com/v1beta/{property=properties/*}:batchRunReports
URL ใช้ไวยากรณ์การแปลง gRPC
พารามิเตอร์เส้นทาง
พารามิเตอร์ | |
---|---|
property |
ตัวระบุพร็อพเพอร์ตี้ GA4 ของ Google Analytics ที่มีการติดตามเหตุการณ์ ระบุไว้ในพาธ URL ไม่ใช่ส่วนเนื้อหา ดูข้อมูลเพิ่มเติมได้ในวิธีค้นหารหัสพร็อพเพอร์ตี้ ต้องระบุพร็อพเพอร์ตี้นี้สำหรับกลุ่ม คุณสมบัติภายใน RunReportRequest อาจไม่ได้ระบุหรือสอดคล้องกับคุณสมบัตินี้ เช่น พร็อพเพอร์ตี้/1234 |
เนื้อหาของคำขอ
เนื้อหาของคำขอมีข้อมูลที่มีโครงสร้างต่อไปนี้
การแสดง JSON |
---|
{
"requests": [
{
object ( |
ช่อง | |
---|---|
requests[] |
คำขอแต่ละรายการ แต่ละคำขอมีการตอบกลับการรายงานแยกจากกัน คำขอแบบกลุ่มแต่ละรายการอนุญาตให้มีคำขอได้สูงสุด 5 คำขอ |
เนื้อหาการตอบกลับ
การตอบกลับเป็นกลุ่มที่มีรายงานหลายรายการ
หากทำสำเร็จ เนื้อหาการตอบกลับจะมีข้อมูลซึ่งมีโครงสร้างดังต่อไปนี้
การแสดง JSON |
---|
{
"reports": [
{
object ( |
ช่อง | |
---|---|
reports[] |
คำตอบแต่ละรายการ การตอบกลับแต่ละรายการจะมีคำขอรายงานแยกต่างหาก |
kind |
ระบุประเภทของแหล่งข้อมูลสำหรับข้อความนี้ |
ขอบเขตการให้สิทธิ์
ต้องใช้ขอบเขต OAuth รายการใดรายการหนึ่งต่อไปนี้
https://www.googleapis.com/auth/analytics.readonly
https://www.googleapis.com/auth/analytics
RunReportRequest
คำขอสร้างรายงาน
การแสดง JSON |
---|
{ "property": string, "dimensions": [ { object ( |
ช่อง | |
---|---|
property |
ตัวระบุพร็อพเพอร์ตี้ GA4 ของ Google Analytics ที่มีการติดตามเหตุการณ์ ระบุไว้ในพาธ URL ไม่ใช่ส่วนเนื้อหา ดูข้อมูลเพิ่มเติมได้ในวิธีค้นหารหัสพร็อพเพอร์ตี้ ภายในคำขอแบบกลุ่ม พร็อพเพอร์ตี้นี้ไม่ควรระบุหรือสอดคล้องกับพร็อพเพอร์ตี้ระดับกลุ่ม เช่น พร็อพเพอร์ตี้/1234 |
dimensions[] |
มิติข้อมูลที่ขอและแสดง |
metrics[] |
เมตริกที่ขอและแสดง |
dateRanges[] |
ช่วงวันที่ของข้อมูลที่จะอ่าน หากมีการขอช่วงวันที่หลายช่วง แถวการตอบกลับแต่ละแถวจะมีดัชนีช่วงวันที่ที่ยึดตาม 0 หากช่วงวันที่ 2 ช่วงทับซ้อนกัน ข้อมูลกิจกรรมสำหรับวันที่ซ้อนทับกันจะรวมอยู่ในแถวการตอบกลับสำหรับช่วงวันที่ทั้งสอง ต้องระบุ |
dimensionFilter |
ตัวกรองมิติข้อมูลให้คุณขอเฉพาะค่ามิติข้อมูลที่ต้องการในรายงานได้ ดูข้อมูลเพิ่มเติมได้ที่พื้นฐานของตัวกรองมิติข้อมูล ใช้เมตริกในตัวกรองนี้ไม่ได้ |
metricFilter |
ข้อความตัวกรองของเมตริก นำไปใช้หลังจากรวมแถวของรายงาน ซึ่งคล้ายกับเงื่อนไขที่มี SQL ใช้มิติข้อมูลในตัวกรองนี้ไม่ได้ |
offset |
จำนวนแถวของแถวเริ่มต้น แถวแรกจะนับเป็นแถว 0 เมื่อแบ่งหน้า คำขอแรกไม่ได้ระบุออฟเซ็ต หรือเทียบเท่า ตั้งค่าออฟเซ็ตเป็น 0 คำขอแรกแสดงผล ดูข้อมูลเพิ่มเติมเกี่ยวกับพารามิเตอร์การใส่เลขหน้านี้ได้ที่การใส่เลขหน้า |
limit |
จำนวนแถวที่จะแสดงผล หากไม่ระบุ ระบบจะแสดงผล 10,000 แถว API จะส่งกลับจำนวนแถวสูงสุด 250,000 แถวต่อคำขอ ไม่ว่าคุณจะขอกี่แถวก็ตาม นอกจากนี้ API อาจแสดงผลแถวน้อยกว่า ดูข้อมูลเพิ่มเติมเกี่ยวกับพารามิเตอร์การใส่เลขหน้านี้ได้ที่การใส่เลขหน้า |
metricAggregations[] |
การรวมเมตริก ค่าเมตริกรวมจะแสดงในแถวที่มีการตั้งค่าdimensions เป็น "RESERVED_(MetricAggregation)" |
orderBys[] |
ระบุลำดับแถวในการตอบกลับ |
currencyCode |
รหัสสกุลเงินในรูปแบบ ISO4217 เช่น "AED", "USD", "JPY" หากช่องว่างเปล่า รายงานจะใช้สกุลเงินเริ่มต้นของพร็อพเพอร์ตี้ |
cohortSpec |
กลุ่มประชากรตามรุ่นที่เชื่อมโยงกับคำขอนี้ หากมีกลุ่มประชากรตามรุ่นในคำขอ "กลุ่มประชากรตามรุ่น" ต้องมีมิติข้อมูล |
keepEmptyRows |
หากเป็นเท็จหรือไม่ได้ระบุ ระบบจะไม่แสดงผลแต่ละแถวที่มีเมตริกทั้งหมดเท่ากับ 0 หากจริง ระบบจะแสดงผลแถวเหล่านี้หากไม่มีการนำออกแยกต่างหากโดยตัวกรอง ไม่ว่าการตั้งค่า เช่น หากพร็อพเพอร์ตี้ไม่เคยบันทึกเหตุการณ์ |
returnPropertyQuota |
สลับว่าจะส่งคืนสถานะปัจจุบันของโควต้าของพร็อพเพอร์ตี้ Analytics นี้หรือไม่ โควต้าจะแสดงใน PropertyQuota |
comparisons[] |
ไม่บังคับ การกำหนดค่าของการเปรียบเทียบที่ขอและแสดง คำขอต้องการเพียงช่องการเปรียบเทียบเพื่อให้ได้รับคอลัมน์การเปรียบเทียบในคำตอบ |