Method: properties.runReport

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

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

คำขอ HTTP

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

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

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

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

string

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

ตัวอย่าง: properties/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,
  "comparisons": [
    {
      object (Comparison)
    }
  ]
}
ช่อง
dimensions[]

object (Dimension)

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

object (Metric)

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

object (DateRange)

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

object (FilterExpression)

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

object (FilterExpression)

ข้อความตัวกรองของเมตริก ใช้หลังจากรวบรวมข้อมูลแถวของรายงานแล้ว ซึ่งคล้ายกับนิพจน์ having ของ 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)

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

object (OrderBy)

ระบุวิธีจัดเรียงแถวในการตอบกลับ คําขอที่มีทั้งการเปรียบเทียบและช่วงวันที่หลายรายการจะมีลําดับตามที่ใช้กับการเปรียบเทียบ
currencyCode

string

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

object (CohortSpec)

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

boolean

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

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

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

boolean

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

object (Comparison)

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

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

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

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

ต้องใช้ขอบเขต OAuth ต่อไปนี้

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