Method: properties.runRealtimeReport

Realtime API ของ Google Analytics จะแสดงรายงานที่กำหนดเองของข้อมูลเหตุการณ์แบบเรียลไทม์สำหรับพร็อพเพอร์ตี้ของคุณ รายงานเหล่านี้แสดงกิจกรรมและการใช้งานในช่วง 30 นาทีที่ผ่านมา

คำขอ HTTP

POST https://analyticsdata.googleapis.com/v1alpha/{property=properties/*}:runRealtimeReport

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

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

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

string

ตัวระบุพร็อพเพอร์ตี้ GA4 ของ Google Analytics ที่มีการติดตามเหตุการณ์ ระบุในเส้นทาง URL ไม่ใช่ส่วนเนื้อหา หากต้องการเรียนรู้เพิ่มเติม โปรดดูตำแหน่งของรหัสพร็อพเพอร์ตี้

ตัวอย่าง: property/1234

เนื้อหาของคำขอ

เนื้อหาของคำขอมีข้อมูลซึ่งมีโครงสร้างต่อไปนี้

การแสดง JSON 
{
  "dimensions": [
    {
      object (Dimension)
    }
  ],
  "metrics": [
    {
      object (Metric)
    }
  ],
  "limit": string,
  "dimensionFilter": {
    object (FilterExpression)
  },
  "metricFilter": {
    object (FilterExpression)
  },
  "metricAggregations": [
    enum (MetricAggregation)
  ],
  "orderBys": [
    {
      object (OrderBy)
    }
  ],
  "returnPropertyQuota": boolean
}
ช่อง
dimensions[]

object (Dimension)

ขนาดที่ขอและแสดง
metrics[]

object (Metric)

เมตริกที่ขอและแสดง
limit

string (int64 format)

จำนวนแถวที่จะแสดงผล หากไม่ได้ระบุพารามิเตอร์ limit ระบบจะแสดงผล 10,000 แถว API จะแสดงผลแถวสูงสุด 100,000 แถวต่อคำขอ ไม่ว่าคุณจะขอกี่แถวก็ตาม
dimensionFilter

object (FilterExpression)

อนุประโยคของตัวกรองขนาด ต้องขอมิติข้อมูลในตัวกรองนี้ เมตริกใช้ในตัวกรองนี้ไม่ได้
metricFilter

object (FilterExpression)

เงื่อนไขตัวกรองของเมตริก ใช้ในขั้นตอนการรวมโพสต์ คล้ายกับคำสั่งที่มีใน SQL ต้องมีการขอเมตริกเพื่อใช้ในตัวกรองนี้ ใช้มิติข้อมูลในตัวกรองนี้ไม่ได้
metricAggregations[]

enum (MetricAggregation)

การรวมเมตริก ค่าเมตริกแบบรวมจะแสดงในแถวที่มีการตั้งค่า levelValue เป็น "RESERVED_(MetricAggregation)"
orderBys[]

object (OrderBy)

ระบุวิธีเรียงลำดับแถวในคำตอบ
returnPropertyQuota

boolean

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

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

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

ตารางรายงานแบบเรียลไทม์ของการตอบกลับที่เกี่ยวข้องกับคำขอ

การแสดง JSON 
{
  "dimensionHeaders": [
    {
      object (DimensionHeader)
    }
  ],
  "metricHeaders": [
    {
      object (MetricHeader)
    }
  ],
  "rows": [
    {
      object (Row)
    }
  ],
  "totals": [
    {
      object (Row)
    }
  ],
  "maximums": [
    {
      object (Row)
    }
  ],
  "minimums": [
    {
      object (Row)
    }
  ],
  "rowCount": integer,
  "propertyQuota": {
    object (PropertyQuota)
  }
}
ช่อง
dimensionHeaders[]

object (DimensionHeader)

อธิบายคอลัมน์มิติข้อมูล จำนวน DimensionHeaders และการจัดลำดับของ DimensionHeaders ตรงกับมิติข้อมูลที่แสดงในแถว
metricHeaders[]

object (MetricHeader)

อธิบายคอลัมน์เมตริก จำนวน MetricHeaders และการจัดลำดับของ MetricHeaders ตรงกับเมตริกที่แสดงในแถว
rows[]

object (Row)

แถวของชุดค่าผสมมิติข้อมูลและค่าเมตริกในรายงาน
totals[]

object (Row)

ค่าเมตริกทั้งหมด หากมีคำขอ
maximums[]

object (Row)

ค่าสูงสุดของเมตริก หากมีการร้องขอ
minimums[]

object (Row)

ค่าต่ำสุดของเมตริก หากมีคำขอ
rowCount

integer

จำนวนแถวทั้งหมดในผลลัพธ์การค้นหา โดยไม่คำนึงถึงจำนวนแถวที่แสดงในคำตอบ เช่น หากการค้นหาแสดงผล 175 แถวและมีขีดจำกัด = 50 ในคำขอ API คำตอบจะมี rowsCount = 175 แถว แต่มีเพียง 50 แถว
propertyQuota

object (PropertyQuota)

สถานะโควต้าแบบเรียลไทม์ของพร็อพเพอร์ตี้ Analytics นี้รวมถึงคำขอนี้

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

ต้องใช้ขอบเขต OAuth อย่างใดอย่างหนึ่งต่อไปนี้

  • https://www.googleapis.com/auth/analytics.readonly
  • https://www.googleapis.com/auth/analytics