Method: properties.runReport

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

แสดงผลรายงานที่กําหนดเองของข้อมูลเหตุการณ์ Google Analytics ของคุณ รายงานประกอบด้วยสถิติที่ได้มาจากข้อมูลที่รวบรวมโดยโค้ดติดตาม Google Analytics ข้อมูลที่ส่งกลับจาก API คือตารางที่มีคอลัมน์สําหรับมิติข้อมูลและเมตริกที่ขอ เมตริกคือการวัดกิจกรรมของผู้ใช้พร็อพเพอร์ตี้แต่ละรายการโดยเฉพาะ เช่น ผู้ใช้ที่ใช้งานอยู่หรือจํานวนเหตุการณ์ มิติข้อมูลจะแสดงเมตริกตามเกณฑ์ทั่วไปบางอย่าง เช่น ชื่อประเทศหรือเหตุการณ์

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

คำขอ HTTP

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

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

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

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

string

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

ตัวอย่าง: พร็อพเพอร์ตี้/1234

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

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

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

object (Dimension)

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

object (Metric)

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

object (DateRange)

ช่วงวันที่ของข้อมูลที่จะอ่าน หากมีการขอช่วงวันที่หลายรายการ แถวคําตอบแต่ละแถวจะมีดัชนีช่วงวันที่เป็น 0 หากช่วงวันที่ 2 ช่วงทับซ้อนกัน ระบบจะรวมข้อมูลเหตุการณ์สําหรับวันที่ทับซ้อนในแถวคําตอบของทั้ง 2 ช่วงวันที่ ในคําขอกลุ่มประชากรตามรุ่นต้องไม่ระบุ dateRanges นี้
dimensionFilter

object (FilterExpression)

ตัวกรองมิติข้อมูลช่วยให้คุณขอค่ามิติข้อมูลที่เฉพาะเจาะจงในรายงานได้ ดูตัวอย่างเพิ่มเติมได้ที่พื้นฐานของตัวกรองมิติข้อมูล ใช้เมตริกในตัวกรองนี้ไม่ได้
metricFilter

object (FilterExpression)

ตัวกรองตัวกรองของเมตริก ใช้หลังจากรวมแถวในรายงานแล้ว ซึ่งคล้ายกับอนุประโยค SQL ใช้มิติข้อมูลกับตัวกรองนี้ไม่ได้
offset

string (int64 format)

จํานวนแถวของแถวเริ่มต้น แถวแรกจะนับเป็นแถว 0

เมื่อสลับหน้า คําขอแรกไม่ได้ระบุออฟเซ็ต หรือกําหนดให้เป็น 0 คําขอแรกจะส่งกลับ limit แถวแรก คําขอที่สองตั้งค่าการชดเชยเป็น limit ของคําขอแรก คําขอที่ 2 แสดงผล limit แถวที่ 2

ดูข้อมูลเพิ่มเติมเกี่ยวกับพารามิเตอร์การใส่เลขหน้านี้ได้ที่การใส่เลขหน้า
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)

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

string

รหัสสกุลเงินในรูปแบบ ISO4217 เช่น "AED", "USD", "JPY" หากช่องว่างเปล่า รายงานจะใช้สกุลเงินเริ่มต้นของพร็อพเพอร์ตี้
cohortSpec

object (CohortSpec)

กลุ่มกลุ่มประชากรตามรุ่นที่เชื่อมโยงกับคําขอนี้ หากมีกลุ่มประชากรตามรุ่นในคําขอ มิติข้อมูล 'กลุ่มประชากรตามรุ่น&#39 จะต้องมีมิติข้อมูล
keepEmptyRows

boolean

หากเป็นเท็จหรือไม่ได้ระบุ จะไม่มีการแสดงแถวแต่ละแถวที่มีเมตริกเท่ากับ 0 หากเป็น "จริง" แถวเหล่านี้จะแสดงค่ากลับมาโดยที่ไม่ได้นําตัวกรองออกแยกต่างหาก
returnPropertyQuota

boolean

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

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

หากทำสำเร็จ เนื้อหาการตอบกลับจะมีอินสแตนซ์ RunReportResponse

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

ต้องมีขอบเขต OAuth อย่างใดอย่างหนึ่งต่อไปนี้

  • https://www.googleapis.com/auth/analytics.readonly
  • https://www.googleapis.com/auth/analytics