Method: runReport

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

คำขอ HTTP

POST https://analyticsdata.googleapis.com/v1alpha:runReport

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

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

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

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

object (Entity)

พร็อพเพอร์ตี้ที่มีการติดตามเหตุการณ์ ภายในคำขอแบบกลุ่ม เอนทิตีนี้ไม่ควรระบุหรือสอดคล้องกับเอนทิตีระดับกลุ่ม
dimensions[]

object (Dimension)

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

object (Metric)

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

object (DateRange)

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

string (int64 format)

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

string (int64 format)

จำนวนแถวที่จะแสดงผล หากไม่ระบุพารามิเตอร์ limit ระบบจะแสดงผล 10,000 แถว API จะส่งกลับจำนวนแถวสูงสุด 100,000 แถวต่อคำขอ ไม่ว่าคุณจะขอกี่แถวก็ตาม
metricAggregations[]

enum (MetricAggregation)

การรวมเมตริก ค่าเมตริกรวมจะแสดงในแถวที่มีการตั้งค่าdimensions เป็น "RESERVED_(MetricAggregation)"
dimensionFilter

object (FilterExpression)

ข้อความตัวกรองของมิติข้อมูล คุณต้องขอให้ใช้มิติข้อมูลในตัวกรองนี้ ใช้เมตริกในตัวกรองนี้ไม่ได้
metricFilter

object (FilterExpression)

ข้อความตัวกรองของเมตริก ใช้ในขั้นตอนการรวมโพสต์ ซึ่งคล้ายกับเงื่อนไขการมีของ SQL ต้องขอเมตริกเพื่อใช้ในตัวกรองนี้ ใช้มิติข้อมูลในตัวกรองนี้ไม่ได้
orderBys[]

object (OrderBy)

ระบุลำดับแถวในการตอบกลับ
currencyCode

string

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

object (CohortSpec)

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

boolean

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

boolean

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

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

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

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

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

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