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 ไม่ใช่ส่วนเนื้อหา หากต้องการเรียนรู้เพิ่มเติม โปรดดูตำแหน่งของรหัสพร็อพเพอร์ตี้

ตัวอย่าง: property/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 ตัวอย่างเช่น มิติข้อมูล country มีค่าที่เป็นไปได้น้อยกว่า 300 ค่า ดังนั้นเมื่อรายงานเฉพาะ country คุณจะมีแถวได้ไม่เกิน 300 แถว แม้ว่าคุณจะตั้งค่า limit เป็นค่าที่สูงกว่าก็ตาม
metricAggregations[]

enum (MetricAggregation)

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

object (OrderBy)

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

boolean

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

object (MinuteRange)

ช่วงนาทีของข้อมูลเหตุการณ์ที่อ่าน หากไม่ระบุ ระบบจะใช้ช่วง 1 นาทีสำหรับ 30 นาทีที่ผ่านมา หากมีการขอช่วงนาทีหลายช่วง แถวการตอบกลับแต่ละแถวจะมีดัชนีช่วงนาทีที่อิงตามศูนย์ หากช่วง 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)