Method: properties.batchRunReports

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

คำขอ HTTP

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

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

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

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

string

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

ตัวอย่าง: properties/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

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

ตัวอย่าง: properties/1234
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)

ระบุวิธีจัดเรียงแถวในการตอบกลับ คำขอที่มีทั้งการเปรียบเทียบและช่วงวันที่หลายช่วงจะมีการใช้ ORDER BY กับการเปรียบเทียบ
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)

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