Method: properties.runRealtimeReport

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

คำขอ HTTP

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

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

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

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

string

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

ตัวอย่าง: พร็อพเพอร์ตี้/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)

การรวมเมตริก ค่าเมตริกรวมจะแสดงในแถวที่มีการตั้งค่าdimensions เป็น "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 การตอบกลับจะมีแถวจำนวนแถว = 175 แต่มีเพียง 50 แถวเท่านั้น
propertyQuota

object (PropertyQuota)

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

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

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

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