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, orderBys
metrics[]

object (Metric)

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

object (DateRange)

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

object (Pivot)

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

object (FilterExpression)

ข้อความตัวกรองของมิติข้อมูล ต้องขอใช้มิติข้อมูลในตัวกรองนี้ ไม่สามารถใช้เมตริกในตัวกรองนี้
metricFilter

object (FilterExpression)

ข้อความตัวกรองของเมตริก ใช้ในระยะหลังการรวมข้อมูล ซึ่งคล้ายกับข้อความ having ใน SQL ต้องขอใช้เมตริกในตัวกรองนี้ ไม่สามารถใช้มิติข้อมูลในตัวกรองนี้
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)

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