Method: properties.runRealtimeReport

แสดงรายงานที่กำหนดเองของข้อมูลเหตุการณ์แบบเรียลไทม์สำหรับพร็อพเพอร์ตี้ของคุณ เหตุการณ์จะปรากฏในรายงานแบบเรียลไทม์ไม่กี่วินาทีหลังจากที่ส่งไปยัง Google Analytics รายงานแบบเรียลไทม์จะแสดงเหตุการณ์และข้อมูลการใช้งานในช่วงระยะเวลาตั้งแต่ปัจจุบันจนถึง 30 นาทีที่ผ่านมา (สูงสุด 60 นาทีสําหรับพร็อพเพอร์ตี้ Google Analytics 360)

สำหรับคำแนะนำในการสร้างคำขอแบบเรียลไทม์และ ดูการสร้างรายงานแบบเรียลไทม์เพื่อทำความเข้าใจคำตอบ

คำขอ HTTP

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

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

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

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

string

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

เช่น พร็อพเพอร์ตี้/1234

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

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

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

object (Dimension)

มิติข้อมูลที่ขอและแสดง
metrics[]

object (Metric)

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

object (FilterExpression)

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

object (FilterExpression)

ข้อความตัวกรองของเมตริก ใช้ในขั้นตอนการรวมโพสต์ ซึ่งคล้ายกับเงื่อนไขการมีของ SQL ใช้มิติข้อมูลในตัวกรองนี้ไม่ได้
limit

string (int64 format)

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

นอกจากนี้ API อาจแสดงผลแถวน้อยกว่า limit ที่ขอด้วย หากมีค่ามิติข้อมูลไม่มากเท่ากับ limit ตัวอย่างเช่น มีค่าที่เป็นไปได้น้อยกว่า 300 ค่าสำหรับมิติข้อมูล country ดังนั้นเมื่อรายงานเฉพาะ country จะมีแถวได้ไม่เกิน 300 แถว แม้ว่าคุณจะตั้งค่า limit เป็นค่าที่สูงกว่าก็ตาม
metricAggregations[]

enum (MetricAggregation)

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

object (OrderBy)

ระบุลำดับแถวในการตอบกลับ
returnPropertyQuota

boolean

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

object (MinuteRange)

ช่วงนาทีของข้อมูลเหตุการณ์ที่จะอ่าน หากไม่ระบุ ระบบจะใช้ช่วง 1 นาทีสำหรับ 30 นาทีที่ผ่านมา หากมีการขอช่วงนาทีหลายช่วง แถวการตอบกลับแต่ละแถวจะมีดัชนีช่วงนาทีที่อิงตาม 0 หากช่วง 2 นาทีทับซ้อนกัน ข้อมูลเหตุการณ์ของนาทีที่ทับซ้อนกันจะรวมอยู่ในแถวการตอบกลับสำหรับช่วงนาทีทั้ง 2 ช่วง

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

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

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

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

object (DimensionHeader)

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

object (MetricHeader)

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

object (Row)

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

object (Row)

หากมีการร้องขอ ค่ารวมของเมตริก
maximums[]

object (Row)

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

object (Row)

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

integer

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

object (PropertyQuota)

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

string

ระบุประเภทของแหล่งข้อมูลสำหรับข้อความนี้ kind นี้เป็นสตริงแบบคงที่ "analyticsData#runRealtimeReport" เสมอ มีประโยชน์ในการแยกความแตกต่างระหว่างประเภทการตอบกลับใน JSON

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

ต้องใช้ขอบเขต 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

string

กำหนดชื่อให้ช่วงนาทีนี้ มิติข้อมูล dateRange จะมีค่าสำหรับชื่อนี้ในการตอบกลับรายงาน หากตั้งค่าไว้ จะขึ้นต้นด้วย date_range_ หรือ RESERVED_ ไม่ได้ หากไม่ได้ตั้งค่า ระบบจะตั้งชื่อช่วงนาทีตามดัชนีที่อิงตาม 0 ในคำขอ เช่น date_range_0, date_range_1 เป็นต้น
startMinutesAgo

integer

นาทีเริ่มต้นที่รวมเวลาการค้นหาเป็นจำนวนนาทีก่อนหน้าปัจจุบัน ตัวอย่างเช่น "startMinutesAgo": 29 ระบุว่ารายงานควรรวมข้อมูลเหตุการณ์ตั้งแต่ 29 นาทีที่ผ่านมาหรือหลังจากนั้น จะอยู่หลัง endMinutesAgo ไม่ได้

หากไม่ระบุ startMinutesAgo จะมีค่าเริ่มต้นเป็น 29 พร็อพเพอร์ตี้ Analytics มาตรฐานสามารถขอข้อมูลเหตุการณ์ได้จนถึง 30 นาทีที่ผ่านมา (startMinutesAgo <= 29) และพร็อพเพอร์ตี้ Analytics 360 สามารถขอข้อมูลเหตุการณ์ได้สูงสุด 60 นาทีที่ผ่านมา (startMinutesAgo <= 59)
endMinutesAgo

integer

นาทีสิ้นสุดรวมสำหรับการค้นหาเป็นจำนวนนาทีก่อนหน้าปัจจุบัน ต้องไม่อยู่ก่อนวันที่ startMinutesAgo ตัวอย่างเช่น "endMinutesAgo": 15 ระบุว่ารายงานควรรวมข้อมูลเหตุการณ์จากก่อนหน้า 15 นาทีที่ผ่านมา

หากไม่ระบุ ค่าเริ่มต้น endMinutesAgo จะเป็น 0 พร็อพเพอร์ตี้ Analytics มาตรฐานสามารถขอข้อมูลเหตุการณ์ในช่วง 30 นาทีที่ผ่านมา (endMinutesAgo <= 29) และพร็อพเพอร์ตี้ Analytics 360 สามารถขอข้อมูลเหตุการณ์ในช่วง 60 นาทีที่ผ่านมา (endMinutesAgo <= 59) ได้