Method: properties.runPivotReport

แสดงผลรายงาน Pivot ที่กําหนดเองของข้อมูลเหตุการณ์ Google Analytics รายงาน Pivot เป็นรูปแบบที่ซับซ้อนและแสดงข้อมูลได้มากกว่ารายงานปกติ ในรายงาน Pivot มิติข้อมูลจะแสดงก็ต่อเมื่อรวมอยู่ใน Pivot คุณระบุ Pivot หลายรายการเพื่อวิเคราะห์ข้อมูลเพิ่มเติมได้

คำขอ HTTP

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

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

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

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

string

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

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

เนื้อหาคำขอ

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

การแสดง JSON
{
  "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)
    }
  ]
}
ช่อง
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)

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

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

หากทำสำเร็จ เนื้อหาการตอบกลับจะมีอินสแตนซ์ RunPivotReportResponse

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

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

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