- คำขอ HTTP
- พารามิเตอร์เส้นทาง
- เนื้อความของคำขอ
- เนื้อหาการตอบกลับ
- ขอบเขตการให้สิทธิ์
- RunPivotReportRequest
- ลองใช้งาน
แสดงผลรายงาน Pivot หลายรายการเป็นกลุ่ม รายงานทั้งหมดต้องเป็นของพร็อพเพอร์ตี้ GA4 เดียวกัน
คำขอ HTTP
POST https://analyticsdata.googleapis.com/v1beta/{property=properties/*}:batchRunPivotReports
URL ใช้ไวยากรณ์การแปลง gRPC
พารามิเตอร์เส้นทาง
พารามิเตอร์ | |
---|---|
property |
ตัวระบุพร็อพเพอร์ตี้ GA4 ของ Google Analytics ที่มีการติดตามเหตุการณ์ ระบุในเส้นทาง URL ไม่ใช่ส่วนเนื้อหา หากต้องการเรียนรู้เพิ่มเติม โปรดดูตำแหน่งของรหัสพร็อพเพอร์ตี้ ต้องระบุคุณสมบัตินี้สำหรับกลุ่ม พร็อพเพอร์ตี้ภายใน RunPivotReportRequest อาจไม่ได้ระบุหรือสอดคล้องกับพร็อพเพอร์ตี้นี้ ตัวอย่าง: property/1234 |
เนื้อหาของคำขอ
เนื้อหาของคำขอมีข้อมูลซึ่งมีโครงสร้างต่อไปนี้
การแสดง JSON |
---|
{
"requests": [
{
object ( |
ช่อง | |
---|---|
requests[] |
คำขอแต่ละรายการ แต่ละคำขอจะมีการตอบกลับจากรายงาน Pivot ที่แยกจากกัน คำขอแบบกลุ่มแต่ละรายการอนุญาตให้มีได้สูงสุด 5 รายการ |
เนื้อหาการตอบกลับ
การตอบกลับเป็นกลุ่มที่มีรายงาน Pivot หลายรายการ
หากทำสำเร็จ เนื้อหาการตอบกลับจะมีข้อมูลซึ่งมีโครงสร้างดังต่อไปนี้
การแสดง JSON |
---|
{
"pivotReports": [
{
object ( |
ช่อง | |
---|---|
pivotReports[] |
คำตอบแต่ละรายการ แต่ละคำตอบจะมีคำขอรายงาน Pivot แยกจากกัน |
kind |
ระบุว่าข้อความนี้เป็นทรัพยากรประเภทใด โดย |
ขอบเขตการให้สิทธิ์
ต้องใช้ขอบเขต OAuth อย่างใดอย่างหนึ่งต่อไปนี้
https://www.googleapis.com/auth/analytics.readonly
https://www.googleapis.com/auth/analytics
RunPivotReportRequest
คำขอสร้างรายงาน Pivot
การแสดง JSON |
---|
{ "property": string, "dimensions": [ { object ( |
ช่อง | |
---|---|
property |
ตัวระบุพร็อพเพอร์ตี้ GA4 ของ Google Analytics ที่มีการติดตามเหตุการณ์ ระบุในเส้นทาง URL ไม่ใช่ส่วนเนื้อหา หากต้องการเรียนรู้เพิ่มเติม โปรดดูตำแหน่งของรหัสพร็อพเพอร์ตี้ ภายในคำขอแบบกลุ่ม พร็อพเพอร์ตี้นี้ไม่ควรระบุหรือสอดคล้องกับพร็อพเพอร์ตี้ระดับกลุ่ม ตัวอย่าง: property/1234 |
dimensions[] |
มิติข้อมูลที่ขอ มิติข้อมูลที่กําหนดทั้งหมดต้องใช้โดยค่าใดค่าหนึ่งต่อไปนี้ ลักษณะเฉพาะ (Expression), มิติข้อมูลตัวกรอง, Pivots, orderBys (orderBys) |
metrics[] |
เมตริกที่ขอ ต้องระบุเมตริกอย่างน้อย 1 รายการ เมตริกที่กำหนดไว้ทั้งหมดจะต้องใช้เมตริกใดค่าหนึ่งต่อไปนี้Metric_expression, MetricFilter, orderBys |
dateRanges[] |
ช่วงวันที่ที่จะดึงข้อมูลเหตุการณ์สำหรับรายงาน หากระบุช่วงวันที่หลายช่วง ระบบจะใช้ข้อมูลเหตุการณ์จากแต่ละช่วงวันที่ในรายงาน มิติข้อมูลพิเศษที่มีชื่อช่อง "dateRange" สามารถรวมอยู่ในชื่อช่องของ Pivot หากมี รายงานจะเปรียบเทียบระหว่างช่วงวันที่ ต้องไม่ได้ระบุ |
pivots[] |
อธิบายรูปแบบภาพของมิติข้อมูลของรายงานในคอลัมน์หรือแถว การรวมชื่อฟิลด์ (ชื่อมิติข้อมูล) ใน Pivot ทั้งหมดต้องเป็นชุดย่อยของชื่อมิติข้อมูลที่กำหนดไว้ในมิติข้อมูล จุดเปลี่ยน 2 รายการที่แชร์มิติข้อมูลได้ มิติข้อมูลจะแสดงเมื่อปรากฏใน Pivot เท่านั้น |
dimensionFilter |
อนุประโยคของตัวกรองขนาด ต้องขอมิติข้อมูลในตัวกรองนี้ เมตริกใช้ในตัวกรองนี้ไม่ได้ |
metricFilter |
เงื่อนไขตัวกรองของเมตริก ใช้ในขั้นตอนการรวมโพสต์ คล้ายกับคำสั่งที่มีใน SQL ต้องมีการขอเมตริกเพื่อใช้ในตัวกรองนี้ ใช้มิติข้อมูลในตัวกรองนี้ไม่ได้ |
currencyCode |
รหัสสกุลเงินในรูปแบบ ISO4217 เช่น "AED", "USD", "JPY" หากช่องดังกล่าวว่างเปล่า รายงานจะใช้สกุลเงินเริ่มต้นของพร็อพเพอร์ตี้ |
cohortSpec |
กลุ่มประชากรตามรุ่นที่เชื่อมโยงกับคำขอนี้ หากมีกลุ่มประชากรตามรุ่นในคำขอ จะต้องมีมิติข้อมูล "กลุ่มประชากรตามรุ่น" ด้วย |
keepEmptyRows |
หากเป็น "เท็จ" หรือ "ไม่ได้ระบุ" ระบบจะไม่แสดงผลแต่ละแถวที่มีเมตริกทั้งหมดเท่ากับ 0 หากเป็นค่าจริง ระบบจะแสดงผลแถวเหล่านี้หากไม่มีการนําออกแยกกันโดยตัวกรอง ไม่ว่าจะตั้งค่า เช่น หากพร็อพเพอร์ตี้ไม่เคยบันทึกเหตุการณ์ |
returnPropertyQuota |
สลับว่าจะให้แสดงสถานะปัจจุบันของโควต้าพร็อพเพอร์ตี้ Analytics นี้หรือไม่ ระบบจะส่งโควต้ากลับมาใน PropertyQuota |
comparisons[] |
ไม่บังคับ การกําหนดค่าการเปรียบเทียบที่ขอและแสดง คำขอต้องมีทั้งช่องการเปรียบเทียบและมิติข้อมูลการเปรียบเทียบเพื่อรับคอลัมน์การเปรียบเทียบในคำตอบ |