- คำขอ 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 |