Method: properties.batchRunPivotReports

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

คำขอ HTTP

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

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

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

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

string

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

ตัวอย่าง: properties/1234

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

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

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

object (RunPivotReportRequest)

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

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

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

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

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

object (RunPivotReportResponse)

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

string

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

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

ต้องใช้ขอบเขต OAuth ต่อไปนี้

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

RunPivotReportRequest

คําขอสร้างรายงาน Pivot

การแสดง JSON 
{
  "property": string,
  "dimensions": [
    {
      object (Dimension)
    }
  ],
  "metrics": [
    {
      object (Metric)
    }
  ],
  "dateRanges": [
    {
      object (DateRange)
    }
  ],
  "pivots": [
    {
      object (Pivot)
    }
  ],
  "dimensionFilter": {
    object (FilterExpression)
  },
  "metricFilter": {
    object (FilterExpression)
  },
  "currencyCode": string,
  "cohortSpec": {
    object (CohortSpec)
  },
  "keepEmptyRows": boolean,
  "returnPropertyQuota": boolean,
  "comparisons": [
    {
      object (Comparison)
    }
  ]
}
ช่อง
property

string

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

ตัวอย่าง: properties/1234
dimensions[]

object (Dimension)

มิติข้อมูลที่ขอ มิติข้อมูลที่กําหนดทั้งหมดต้องใช้กับรายการใดรายการหนึ่งต่อไปนี้ dimensionExpression, dimensionFilter, pivots, orderBy
metrics[]

object (Metric)

เมตริกที่ขอ ต้องระบุเมตริกอย่างน้อย 1 รายการ เมตริกที่กําหนดทั้งหมดต้องใช้กับรายการใดรายการหนึ่งต่อไปนี้ metric_expression, metricFilter, orderBy
dateRanges[]

object (DateRange)

ช่วงวันที่ที่จะดึงข้อมูลเหตุการณ์สําหรับรายงาน หากระบุช่วงวันที่หลายช่วง ระบบจะใช้ข้อมูลเหตุการณ์จากแต่ละช่วงวันที่ในรายงาน มิติข้อมูลพิเศษที่มีชื่อช่อง "dateRange" สามารถรวมอยู่ในชื่อช่องของ Pivot ได้ หากรวมไว้ รายงานจะเปรียบเทียบระหว่างช่วงวันที่ ในคําขอกลุ่มประชากรตามรุ่น dateRanges นี้ต้องไม่ระบุ
pivots[]

object (Pivot)

อธิบายรูปแบบภาพมิติข้อมูลของรายงานในคอลัมน์หรือแถว การรวมของ fieldNames (ชื่อมิติข้อมูล) ใน Pivot ทั้งหมดต้องเป็นชุดย่อยของชื่อมิติข้อมูลที่กําหนดไว้ในมิติข้อมูล Pivot 2 รายการใช้มิติข้อมูลเดียวกันไม่ได้ มิติข้อมูลจะปรากฏก็ต่อเมื่อปรากฏในตาราง Pivot เท่านั้น
dimensionFilter

object (FilterExpression)

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

object (FilterExpression)

ข้อความตัวกรองของเมตริก ใช้ในระยะหลังการรวมข้อมูล ซึ่งคล้ายกับประโยคที่มีของ SQL คุณต้องขอเมตริกเพื่อใช้ในตัวกรองนี้ คุณใช้มิติข้อมูลในตัวกรองนี้ไม่ได้
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)

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