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