Method: properties.batchRunReports

แสดงผลรายงานหลายรายการเป็นกลุ่ม รายงานทั้งหมดต้องเป็นสําหรับพร็อพเพอร์ตี้ GA4 เดียวกัน

คำขอ HTTP

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

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

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

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

string

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

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

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

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

การแสดง JSON 
{
  "requests": [
    {
      object (RunReportRequest)
    }
  ]
}
ช่อง
requests[]

object (RunReportRequest)

คำขอแต่ละรายการ แต่ละคำขอมีการตอบกลับการรายงานแยกจากกัน คำขอแบบกลุ่มแต่ละรายการอนุญาตให้มีคำขอได้สูงสุด 5 คำขอ

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

การตอบกลับเป็นกลุ่มที่มีรายงานหลายรายการ

หากทำสำเร็จ เนื้อหาการตอบกลับจะมีข้อมูลซึ่งมีโครงสร้างดังต่อไปนี้

การแสดง JSON 
{
  "reports": [
    {
      object (RunReportResponse)
    }
  ],
  "kind": string
}
ช่อง
reports[]

object (RunReportResponse)

คำตอบแต่ละรายการ การตอบกลับแต่ละรายการจะมีคำขอรายงานแยกต่างหาก
kind

string

ระบุประเภทของแหล่งข้อมูลสำหรับข้อความนี้ kind นี้เป็นสตริงแบบคงที่ "analyticsData#batchRunReports" เสมอ มีประโยชน์ในการแยกความแตกต่างระหว่างประเภทการตอบกลับใน JSON

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

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

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

RunReportRequest

คำขอสร้างรายงาน

การแสดง JSON 
{
  "property": string,
  "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)
    }
  ]
}
ช่อง
property

string

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

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

object (Dimension)

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

object (Metric)

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

object (DateRange)

ช่วงวันที่ของข้อมูลที่จะอ่าน หากมีการขอช่วงวันที่หลายช่วง แถวการตอบกลับแต่ละแถวจะมีดัชนีช่วงวันที่ที่ยึดตาม 0 หากช่วงวันที่ 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 ตัวอย่างเช่น มีค่าที่เป็นไปได้น้อยกว่า 300 ค่าสำหรับมิติข้อมูล country ดังนั้นเมื่อรายงานเฉพาะ country จะมีแถวได้ไม่เกิน 300 แถว แม้ว่าคุณจะตั้งค่า limit เป็นค่าที่สูงกว่าก็ตาม

ดูข้อมูลเพิ่มเติมเกี่ยวกับพารามิเตอร์การใส่เลขหน้านี้ได้ที่การใส่เลขหน้า
metricAggregations[]

enum (MetricAggregation)

การรวมเมตริก ค่าเมตริกรวมจะแสดงในแถวที่มีการตั้งค่าdimensions เป็น "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
comparisons[]

object (Comparison)

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