Method: properties.runRealtimeReport

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

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

คำขอ HTTP

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

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

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

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

string

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

ตัวอย่าง: properties/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)

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

string (int64 format)

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

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

enum (MetricAggregation)

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

object (OrderBy)

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

boolean

สลับว่าจะแสดงสถานะปัจจุบันของโควต้าแบบเรียลไทม์ของพร็อพเพอร์ตี้ Google 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)

สถานะโควต้าแบบเรียลไทม์ของพร็อพเพอร์ตี้ Google 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)