Method: batchRunReports

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

คำขอ HTTP

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

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

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

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

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

object (Entity)

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

requests[]

object (RunReportRequest)

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

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

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

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

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

object (RunReportResponse)

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

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

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

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

RunReportRequest

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

การแสดง 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 ช่วงทับซ้อนกัน ข้อมูลเหตุการณ์สำหรับวันที่ทับซ้อนจะรวมอยู่ในแถวคำตอบของทั้ง 2 ช่วงวันที่ ต้องไม่ได้ระบุ dateRanges นี้ในคำขอกลุ่มประชากรตามรุ่น

offset

string (int64 format)

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

limit

string (int64 format)

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

metricAggregations[]

enum (MetricAggregation)

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