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)

ข้อความตัวกรองของเมตริก ใช้ในระยะหลังการรวมข้อมูล ซึ่งคล้ายกับประโยคที่มีของ 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)