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 ช่วง ในคําขอ Cohort คุณต้องไม่ระบุ 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)

กลุ่ม Cohort ที่เชื่อมโยงกับคําขอนี้ หากมีกลุ่ม Cohort ในคําขอ จะต้องมีมิติข้อมูล "Cohort"
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