Method: properties.batchRunPivotReports

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

คำขอ HTTP

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

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

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

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

string

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

เช่น พร็อพเพอร์ตี้/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

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

เช่น พร็อพเพอร์ตี้/1234
dimensions[]

object (Dimension)

มิติข้อมูลที่ขอ ต้องใช้มิติข้อมูลที่กำหนดทั้งหมดโดยค่าใดค่าหนึ่งต่อไปนี้ ได้แก่dimensionExpression, dimensionFilter, Pivot, orderBys
metrics[]

object (Metric)

เมตริกที่ขอ ต้องระบุเมตริกอย่างน้อย 1 รายการ ต้องใช้เมตริกที่กำหนดทั้งหมดโดยรายการใดรายการหนึ่งต่อไปนี้ ได้แก่metric_expression, contactsFilter, orderBys
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 (GA4) ในรายงานเท่านั้น

เช่น หากพร็อพเพอร์ตี้ไม่เคยบันทึกเหตุการณ์ purchase การค้นหาสำหรับมิติข้อมูล eventName และเมตริก eventCount จะไม่มีแถว eventName: "purchase" และ eventCount: 0
returnPropertyQuota

boolean

สลับว่าจะส่งคืนสถานะปัจจุบันของโควต้าของพร็อพเพอร์ตี้ Analytics นี้หรือไม่ โควต้าจะแสดงใน PropertyQuota
comparisons[]

object (Comparison)

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