Method: properties.runReport

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

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

คำขอ HTTP

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

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

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

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

string

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

ตัวอย่าง: property/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 ของแถวแรก คำขอที่ 2 ตั้งค่าออฟเซ็ตเป็น limit ของคำขอแรก คำขอที่ 2 แสดง limit แถวที่ 2

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

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

string

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

object (CohortSpec)

กลุ่มประชากรตามรุ่นที่เชื่อมโยงกับคำขอนี้ หากมีกลุ่มประชากรตามรุ่นในคำขอ จะต้องมีมิติข้อมูล "กลุ่มประชากรตามรุ่น" ด้วย
keepEmptyRows

boolean

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

ไม่ว่าจะตั้งค่า keepEmptyRows นี้อย่างไร รายงานจะแสดงเฉพาะข้อมูลที่พร็อพเพอร์ตี้ Google Analytics (GA4) บันทึกไว้เท่านั้น

เช่น หากพร็อพเพอร์ตี้ไม่เคยบันทึกเหตุการณ์ purchase การค้นหามิติข้อมูล eventName และเมตริก eventCount จะไม่มีแถว eventName: "purchase" และ eventCount: 0
returnPropertyQuota

boolean

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

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

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

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

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

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