- คำขอ HTTP
- พารามิเตอร์เส้นทาง
- เนื้อหาคำขอ
- เนื้อหาการตอบกลับ
- ขอบเขตการให้สิทธิ์
- ResponseMetaData
- SchemaRestrictionResponse
- ActiveMetricRestriction
- RestrictedMetricType
- ลองใช้งาน
เรียกข้อมูลเนื้อหาของงานรายงาน หลังจากขอ reportTasks.create
แล้ว คุณจะเรียกดูเนื้อหาของรายงานได้เมื่อรายงานทำงานอยู่ วิธีนี้จะแสดงข้อผิดพลาดหากสถานะของงานรายงานไม่ใช่ ACTIVE
การตอบกลับการค้นหาจะแสดงแถวแบบตาราง & ในรายงาน
คำขอ HTTP
POST https://analyticsdata.googleapis.com/v1alpha/{name=properties/*/reportTasks/*}:query
URL ใช้ไวยากรณ์การแปลง gRPC
พารามิเตอร์เส้นทาง
พารามิเตอร์ | |
---|---|
name |
ต้องระบุ ชื่อแหล่งที่มาของรายงาน รูปแบบ: |
เนื้อหาของคำขอ
เนื้อหาของคำขอมีข้อมูลที่มีโครงสร้างต่อไปนี้
การแสดง JSON |
---|
{ "offset": string, "limit": string } |
ช่อง | |
---|---|
offset |
ไม่บังคับ จำนวนแถวของแถวเริ่มต้นในรายงาน แถวแรกจะนับเป็นแถว 0 เมื่อแบ่งหน้า คำขอแรกไม่ได้ระบุออฟเซ็ต หรือเทียบเท่า ตั้งค่าออฟเซ็ตเป็น 0 คำขอแรกแสดงผล ดูข้อมูลเพิ่มเติมเกี่ยวกับพารามิเตอร์การใส่เลขหน้านี้ได้ที่การใส่เลขหน้า |
limit |
ไม่บังคับ จำนวนแถวที่จะแสดงผลจากรายงาน หากไม่ระบุ ระบบจะแสดงผล 10,000 แถว API จะส่งกลับจำนวนแถวสูงสุด 250,000 แถวต่อคำขอ ไม่ว่าคุณจะขอกี่แถวก็ตาม นอกจากนี้ API อาจแสดงผลแถวน้อยกว่า ดูข้อมูลเพิ่มเติมเกี่ยวกับพารามิเตอร์การใส่เลขหน้านี้ได้ที่การใส่เลขหน้า |
เนื้อหาการตอบกลับ
เนื้อหาของรายงานที่เกี่ยวข้องกับงานของรายงาน
หากทำสำเร็จ เนื้อหาการตอบกลับจะมีข้อมูลซึ่งมีโครงสร้างดังต่อไปนี้
การแสดง JSON |
---|
{ "dimensionHeaders": [ { object ( |
ช่อง | |
---|---|
dimensionHeaders[] |
อธิบายคอลัมน์มิติข้อมูล จำนวน DimensionHeaders และลำดับของ DimensionHeaders ตรงกับมิติข้อมูลที่แสดงในแถว |
metricHeaders[] |
อธิบายคอลัมน์เมตริก จำนวน MetricHeaders และลำดับของ MetricHeaders จะตรงกับเมตริกที่มีในแถว |
rows[] |
แถวของชุดค่าผสมมิติข้อมูลและค่าเมตริกในรายงาน |
totals[] |
หากมีการร้องขอ ค่ารวมของเมตริก |
maximums[] |
ค่าของเมตริกสูงสุด หากมีการร้องขอ |
minimums[] |
ค่าต่ำสุดของเมตริก หากมีการร้องขอ |
rowCount |
จำนวนแถวทั้งหมดในผลการค้นหา |
metadata |
ข้อมูลเมตาของรายงาน |
ขอบเขตการให้สิทธิ์
ต้องใช้ขอบเขต OAuth รายการใดรายการหนึ่งต่อไปนี้
https://www.googleapis.com/auth/analytics.readonly
https://www.googleapis.com/auth/analytics
ResponseMetaData
ข้อมูลเมตาของคำตอบที่มีข้อมูลเพิ่มเติมเกี่ยวกับเนื้อหารายงาน
การแสดง JSON |
---|
{
"dataLossFromOtherRow": boolean,
"schemaRestrictionResponse": {
object ( |
ช่อง | |
---|---|
dataLossFromOtherRow |
หากเป็น "จริง" หมายความว่าที่เก็บข้อมูลแบบผสมบางชุดจะรวมกันเป็น "(อื่นๆ)" แถว ซึ่งอาจเกิดขึ้นได้สําหรับรายงาน High Cardinality ระบบจะสร้างพารามิเตอร์ข้อมูลเมตา dataLossFromOtherRow ตามตารางข้อมูลรวมที่ใช้ในรายงาน ระบบจะป้อนข้อมูลพารามิเตอร์อย่างถูกต้องโดยไม่คำนึงถึงตัวกรองและขีดจำกัดในรายงาน ตัวอย่างเช่น แถว (อื่นๆ) อาจถูกตัดออกจากรายงานเนื่องจากคำขอมีตัวกรองใน sessionSource = google ระบบจะยังคงป้อนข้อมูลพารามิเตอร์นี้หากมีการสูญเสียข้อมูลจากแถวอื่นในข้อมูลรวมของอินพุตที่ใช้ในการสร้างรายงานนี้ ดูข้อมูลเพิ่มเติมได้ที่เกี่ยวกับแถว (อื่นๆ) และการสุ่มตัวอย่างข้อมูล |
schemaRestrictionResponse |
อธิบายข้อจำกัดของสคีมาที่บังคับใช้อยู่อย่างต่อเนื่องในการสร้างรายงานนี้ ดูข้อมูลเพิ่มเติมได้ที่การจัดการการเข้าถึงและข้อจํากัดด้านข้อมูล |
currencyCode |
รหัสสกุลเงินที่ใช้ในรายงานนี้ มีจุดประสงค์เพื่อใช้ในการจัดรูปแบบเมตริกสกุลเงิน เช่น รหัสสกุลเงินคือการเข้ารหัสสตริงของประเภทสกุลเงินจากมาตรฐาน ISO 4217 (https://en.wikipedia.org/wiki/ISO_4217) เช่น "USD", "EUR", "JPY" ดูข้อมูลเพิ่มเติมได้ที่ https://support.google.com/analytics/answer/9796179 |
timeZone |
เขตเวลาปัจจุบันของที่พัก มีไว้เพื่อตีความมิติข้อมูลตามเวลา เช่น |
emptyReason |
หากระบุเหตุผลที่เว้นว่างไว้ รายงานจะว่างเปล่าเนื่องจากนี้ |
subjectToThresholding |
หาก |
SchemaRestrictionResponse
ข้อจำกัดของสคีมาที่บังคับใช้อยู่อย่างต่อเนื่องในการสร้างรายงานนี้ ดูข้อมูลเพิ่มเติมได้ที่การจัดการการเข้าถึงและข้อจํากัดด้านข้อมูล
การแสดง JSON |
---|
{
"activeMetricRestrictions": [
{
object ( |
ช่อง | |
---|---|
activeMetricRestrictions[] |
ข้อจำกัดทั้งหมดที่บังคับใช้อย่างต่อเนื่องในการสร้างรายงาน ตัวอย่างเช่น |
ActiveMetricRestriction
เมตริกที่ถูกจํากัดไว้สำหรับการสร้างรายงาน
การแสดง JSON |
---|
{
"restrictedMetricTypes": [
enum ( |
ช่อง | |
---|---|
restrictedMetricTypes[] |
เหตุผลของข้อจำกัดของเมตริกนี้ |
metricName |
ชื่อของเมตริกที่ถูกจำกัด |
RestrictedMetricType
หมวดหมู่ของข้อมูลที่คุณอาจถูกจำกัดไม่ให้ดูในพร็อพเพอร์ตี้ GA4 บางรายการ
Enum | |
---|---|
RESTRICTED_METRIC_TYPE_UNSPECIFIED |
ไม่ได้ระบุประเภท |
COST_DATA |
เมตริกค่าใช้จ่าย เช่น adCost |
REVENUE_DATA |
เมตริกรายได้ เช่น purchaseRevenue |