- คำขอ HTTP
- พารามิเตอร์เส้นทาง
- เนื้อความของคำขอ
- เนื้อหาการตอบกลับ
- ขอบเขตการให้สิทธิ์
- MinuteRange
- ลองใช้งาน
แสดงผลรายงานที่กำหนดเองของข้อมูลเหตุการณ์แบบเรียลไทม์สำหรับพร็อพเพอร์ตี้ เหตุการณ์จะปรากฏในรายงานแบบเรียลไทม์ในไม่กี่วินาทีหลังจากที่มีการส่งเหตุการณ์นั้นไปยัง Google Analytics รายงานแบบเรียลไทม์จะแสดงเหตุการณ์และข้อมูลการใช้งานในช่วงเวลาตั้งแต่ปัจจุบันจนถึง 30 นาทีที่ผ่านมา (สูงสุด 60 นาทีสําหรับพร็อพเพอร์ตี้ Google Analytics 360)
ดูคําแนะนําในการสร้างคําขอแบบเรียลไทม์และทําความเข้าใจคําตอบที่หัวข้อการสร้างรายงานแบบเรียลไทม์
คำขอ HTTP
POST https://analyticsdata.googleapis.com/v1beta/{property=properties/*}:runRealtimeReport
URL ใช้ไวยากรณ์การแปลง gRPC
พารามิเตอร์เส้นทาง
พารามิเตอร์ | |
---|---|
property |
ตัวระบุพร็อพเพอร์ตี้ GA4 ของ Google Analytics ที่มีการติดตามเหตุการณ์ ระบุในเส้นทาง URL ไม่ใช่ส่วนเนื้อหา หากต้องการเรียนรู้เพิ่มเติม โปรดดูตำแหน่งของรหัสพร็อพเพอร์ตี้ ตัวอย่าง: property/1234 |
เนื้อหาของคำขอ
เนื้อหาของคำขอมีข้อมูลซึ่งมีโครงสร้างต่อไปนี้
การแสดง JSON |
---|
{ "dimensions": [ { object ( |
ช่อง | |
---|---|
dimensions[] |
ขนาดที่ขอและแสดง |
metrics[] |
เมตริกที่ขอและแสดง |
dimensionFilter |
อนุประโยคของตัวกรองขนาด เมตริกใช้ในตัวกรองนี้ไม่ได้ |
metricFilter |
เงื่อนไขตัวกรองของเมตริก ใช้ในขั้นตอนการรวมโพสต์ คล้ายกับคำสั่งที่มีใน SQL ใช้มิติข้อมูลในตัวกรองนี้ไม่ได้ |
limit |
จำนวนแถวที่จะแสดงผล หากไม่ระบุ ระบบจะแสดงผล 10,000 แถว API จะแสดงผลแถวสูงสุด 250,000 แถวต่อคำขอ ไม่ว่าคุณจะขอกี่แถวก็ตาม นอกจากนี้ API อาจแสดงผลแถวน้อยกว่า |
metricAggregations[] |
การรวมเมตริก ค่าเมตริกแบบรวมจะแสดงในแถวที่มีการตั้งค่า levelValue เป็น "RESERVED_(MetricAggregation)" |
orderBys[] |
ระบุวิธีเรียงลำดับแถวในคำตอบ |
returnPropertyQuota |
สลับว่าจะให้แสดงสถานะปัจจุบันของโควต้าแบบเรียลไทม์ของพร็อพเพอร์ตี้ Analytics นี้หรือไม่ ระบบจะส่งโควต้ากลับมาใน PropertyQuota |
minuteRanges[] |
ช่วงนาทีของข้อมูลเหตุการณ์ที่อ่าน หากไม่ระบุ ระบบจะใช้ช่วง 1 นาทีสำหรับ 30 นาทีที่ผ่านมา หากมีการขอช่วงนาทีหลายช่วง แถวการตอบกลับแต่ละแถวจะมีดัชนีช่วงนาทีที่อิงตามศูนย์ หากช่วง 2 นาทีทับซ้อนกัน ข้อมูลเหตุการณ์ของนาทีที่ทับซ้อนกันจะรวมอยู่ในแถวการตอบสนองของช่วงนาทีทั้งสอง |
เนื้อหาการตอบกลับ
ตารางรายงานแบบเรียลไทม์ของการตอบกลับที่เกี่ยวข้องกับคำขอ
หากทำสำเร็จ เนื้อหาการตอบกลับจะมีข้อมูลซึ่งมีโครงสร้างดังต่อไปนี้
การแสดง JSON |
---|
{ "dimensionHeaders": [ { object ( |
ช่อง | |
---|---|
dimensionHeaders[] |
อธิบายคอลัมน์มิติข้อมูล จำนวน DimensionHeaders และการจัดลำดับของ DimensionHeaders ตรงกับมิติข้อมูลที่แสดงในแถว |
metricHeaders[] |
อธิบายคอลัมน์เมตริก จำนวน MetricHeaders และการจัดลำดับของ MetricHeaders ตรงกับเมตริกที่แสดงในแถว |
rows[] |
แถวของชุดค่าผสมมิติข้อมูลและค่าเมตริกในรายงาน |
totals[] |
ค่าเมตริกทั้งหมด หากมีคำขอ |
maximums[] |
ค่าสูงสุดของเมตริก หากมีการร้องขอ |
minimums[] |
ค่าต่ำสุดของเมตริก หากมีคำขอ |
rowCount |
จำนวนแถวทั้งหมดในผลลัพธ์การค้นหา |
propertyQuota |
สถานะโควต้าแบบเรียลไทม์ของพร็อพเพอร์ตี้ Analytics นี้รวมถึงคำขอนี้ |
kind |
ระบุประเภททรัพยากรของข้อความนี้ |
ขอบเขตการให้สิทธิ์
ต้องใช้ขอบเขต OAuth อย่างใดอย่างหนึ่งต่อไปนี้
https://www.googleapis.com/auth/analytics.readonly
https://www.googleapis.com/auth/analytics
MinuteRange
ชุดนาทีต่อเนื่อง: startMinutesAgo
, startMinutesAgo 1
, ..., endMinutesAgo
คําขออนุญาตให้มีได้สูงสุด 2 นาที
การแสดง JSON |
---|
{ "name": string, "startMinutesAgo": integer, "endMinutesAgo": integer } |
ช่อง | |
---|---|
name |
กำหนดชื่อให้กับช่วงนาทีนี้ มิติข้อมูล |
startMinutesAgo |
นาทีเริ่มต้นที่ครอบคลุมของการค้นหาเป็นจำนวนนาทีก่อนหน้าตอนนี้ ตัวอย่างเช่น หากไม่ระบุ |
endMinutesAgo |
นาทีสุดท้ายที่รวมสำหรับการค้นหา ซึ่งเป็นจำนวนนาทีก่อนหน้าในขณะนี้ ต้องไม่เกินวันที่ หากไม่ระบุ |