Method: properties.runRealtimeReport

จัดทุกอย่างให้เป็นระเบียบอยู่เสมอด้วยคอลเล็กชัน บันทึกและจัดหมวดหมู่เนื้อหาตามค่ากำหนดของคุณ

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

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

คำขอ HTTP

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

URL ใช้ไวยากรณ์ gRPC Transcoding

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

พารามิเตอร์
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 จะแสดงแถวได้สูงสุด 100,000 แถวต่อคําขอ ไม่ว่าคุณจะขอกี่รายการ limit ต้องเป็นค่าบวก

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

enum (MetricAggregation)

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

object (OrderBy)

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

boolean

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

object (MinuteRange)

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

อธิบายคอลัมน์มิติข้อมูล จํานวน มิติข้อมูลส่วนหัว และการจัดลําดับมิติข้อมูลของส่วนหัวตรงกับมิติข้อมูลที่แสดงในแถว
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

ช่วงนาที

ชุดนาทีที่อยู่ติดกัน: 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)