Method: properties.reportTasks.query

เรียกเนื้อหาของงานรายงาน หลังจากขอ reportTasks.create คุณจะดึงเนื้อหารายงานได้เมื่อรายงานเริ่มทำงาน วิธีนี้จะแสดงผลข้อผิดพลาดหากสถานะของงานรายงานไม่ใช่ ACTIVE การตอบสนองต่อการค้นหาจะแสดงค่าแถวและคอลัมน์แบบตารางของรายงาน

คำขอ HTTP

POST https://analyticsdata.googleapis.com/v1alpha/{name=properties/*/reportTasks/*}:query

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

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

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

string

ต้องระบุ ชื่อแหล่งที่มาของรายงาน รูปแบบ: properties/{property}/reportTasks/{report}

เนื้อหาของคำขอ

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

การแสดง JSON 
{
  "offset": string,
  "limit": string
}
ช่อง
offset

string (int64 format)

ไม่บังคับ จำนวนแถวของแถวเริ่มต้นในรายงาน แถวแรกจะนับเป็นแถว 0

เมื่อแบ่งหน้า คำขอแรกจะไม่ระบุออฟเซ็ต หรือเทียบเท่า จะตั้งค่าออฟเซ็ตเป็น 0 โดยคำขอแรกจะแสดงผล limit ของแถวแรก คำขอที่ 2 ตั้งค่าออฟเซ็ตเป็น limit ของคำขอแรก คำขอที่ 2 แสดง limit แถวที่ 2

ดูข้อมูลเพิ่มเติมเกี่ยวกับพารามิเตอร์การใส่เลขหน้าได้ที่การใส่เลขหน้า
limit

string (int64 format)

ไม่บังคับ จำนวนแถวที่จะแสดงผลจากรายงาน หากไม่ระบุ ระบบจะแสดงผล 10,000 แถว API จะแสดงผลแถวสูงสุด 250,000 แถวต่อคำขอ ไม่ว่าคุณจะขอกี่แถวก็ตาม limit ต้องเป็นค่าบวก

นอกจากนี้ API อาจแสดงผลแถวน้อยกว่า limit ที่ขอด้วย หากไม่มีค่ามิติข้อมูลมากเท่ากับ limit ส่วนจำนวนแถวที่ใช้ได้กับ QueryReportTaskRequest ยังถูกจำกัดตามขีดจำกัดของ ReportTask ที่เกี่ยวข้องอีกด้วย การสืบค้นข้อมูลสามารถเรียกข้อมูลแถว ReportTask.limit ได้สูงสุด ตัวอย่างเช่น หาก ReportTask มีขีดจำกัดอยู่ที่ 1,000 รายการ คำขอ reportTasks.query ที่มีออฟเซ็ต=900 และขีดจำกัด=500 จะแสดงแถวไม่เกิน 100 แถว

ดูข้อมูลเพิ่มเติมเกี่ยวกับพารามิเตอร์การใส่เลขหน้าได้ที่การใส่เลขหน้า

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

เนื้อหารายงานที่เกี่ยวข้องกับงานการรายงาน

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

การแสดง JSON 
{
  "dimensionHeaders": [
    {
      object (DimensionHeader)
    }
  ],
  "metricHeaders": [
    {
      object (MetricHeader)
    }
  ],
  "rows": [
    {
      object (Row)
    }
  ],
  "totals": [
    {
      object (Row)
    }
  ],
  "maximums": [
    {
      object (Row)
    }
  ],
  "minimums": [
    {
      object (Row)
    }
  ],
  "rowCount": integer,
  "metadata": {
    object (ResponseMetaData)
  }
}
ช่อง
dimensionHeaders[]

object (DimensionHeader)

อธิบายคอลัมน์มิติข้อมูล จำนวน DimensionHeaders และการจัดลำดับของ DimensionHeaders ตรงกับมิติข้อมูลที่แสดงในแถว
metricHeaders[]

object (MetricHeader)

อธิบายคอลัมน์เมตริก จำนวน MetricHeaders และการจัดลำดับของ MetricHeaders ตรงกับเมตริกที่แสดงในแถว
rows[]

object (Row)

แถวของชุดค่าผสมมิติข้อมูลและค่าเมตริกในรายงาน
totals[]

object (Row)

ค่าเมตริกทั้งหมด หากมีคำขอ
maximums[]

object (Row)

ค่าสูงสุดของเมตริก หากมีการร้องขอ
minimums[]

object (Row)

ค่าต่ำสุดของเมตริก หากมีคำขอ
rowCount

integer

จำนวนแถวทั้งหมดในผลลัพธ์การค้นหา
metadata

object (ResponseMetaData)

ข้อมูลเมตาสำหรับรายงาน

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

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

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

ResponseMetaData

ข้อมูลเมตาของการตอบกลับที่มีข้อมูลเพิ่มเติมเกี่ยวกับเนื้อหาในรายงาน

การแสดง JSON 
{
  "dataLossFromOtherRow": boolean,
  "schemaRestrictionResponse": {
    object (SchemaRestrictionResponse)
  },
  "currencyCode": string,
  "timeZone": string,
  "emptyReason": string,
  "subjectToThresholding": boolean
}
ช่อง
dataLossFromOtherRow

boolean

หากเป็น "จริง" แสดงว่าที่เก็บข้อมูลของชุดค่าผสมมิติข้อมูลบางรายการรวมอยู่ในแถว "(อื่นๆ)" กรณีนี้อาจเกิดขึ้นสําหรับรายงาน High Cardinality

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

เช่น ระบบอาจนำแถว (อื่นๆ) ออกจากรายงานเนื่องจากคำขอมีตัวกรองเมื่อ sessionSource = google ระบบจะยังคงป้อนข้อมูลพารามิเตอร์นี้หากข้อมูลสูญหายจากแถวอื่นอยู่ในข้อมูลรวมของอินพุตที่ใช้ในการสร้างรายงานนี้

ดูข้อมูลเพิ่มเติมได้ที่เกี่ยวกับแถว (อื่นๆ) และการสุ่มตัวอย่างข้อมูล
schemaRestrictionResponse

object (SchemaRestrictionResponse)

อธิบายข้อจำกัดของสคีมาที่บังคับใช้ในการสร้างรายงานนี้อยู่ โปรดดูข้อมูลเพิ่มเติมที่หัวข้อการจัดการการเข้าถึงและข้อจํากัดด้านข้อมูล
currencyCode

string

รหัสสกุลเงินที่ใช้ในรายงานนี้ มีจุดประสงค์เพื่อใช้ในการจัดรูปแบบเมตริกสกุลเงิน เช่น purchaseRevenue สำหรับการแสดงภาพ หากมีการระบุ currencyCode ในคำขอ พารามิเตอร์การตอบกลับนี้จะสะท้อนถึงพารามิเตอร์คำขอ มิฉะนั้น พารามิเตอร์การตอบกลับนี้จะเป็น currencyCode ปัจจุบันของพร็อพเพอร์ตี้

รหัสสกุลเงินคือการเข้ารหัสสตริงของประเภทสกุลเงินจากมาตรฐาน ISO 4217 (https://en.wikipedia.org/wiki/ISO_4217) เช่น "USD", "EUR", "JPY" ดูข้อมูลเพิ่มเติมได้ที่ https://support.google.com/analytics/answer/9796179
timeZone

string

เขตเวลาปัจจุบันของที่พัก มีจุดประสงค์เพื่อใช้ตีความมิติข้อมูลตามเวลา เช่น hour และ minute จัดรูปแบบเป็นสตริงจากฐานข้อมูลเขตเวลาของ IANA (https://www.iana.org/time-zones) เช่น "America/New_York" หรือ "Asia/Tokyo"
emptyReason

string

หากระบุเหตุผลว่างเปล่า รายงานจะว่างเปล่าด้วยเหตุผลนี้
subjectToThresholding

boolean

หาก subjectToThresholding เป็นจริง รายงานนี้จะมีเกณฑ์การแสดงผล และจะแสดงเฉพาะข้อมูลที่ตรงตามเกณฑ์การรวมขั้นต่ำ ทั้งนี้ คําขออาจอยู่ภายใต้เกณฑ์ของเกณฑ์และไม่มีข้อมูลใดขาดหายไปจากรายงาน และจะเกิดขึ้นเมื่อข้อมูลทั้งหมดสูงกว่าเกณฑ์ โปรดดูข้อมูลเพิ่มเติมที่หัวข้อจำนวนข้อมูลขั้นต่ำที่ต้องการและเกี่ยวกับข้อมูลประชากรและความสนใจ

SchemaRestrictionResponse

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

การแสดง JSON 
{
  "activeMetricRestrictions": [
    {
      object (ActiveMetricRestriction)
    }
  ]
}
ช่อง
activeMetricRestrictions[]

object (ActiveMetricRestriction)

มีการใช้ข้อจำกัดทั้งหมดในการสร้างรายงานอย่างต่อเนื่อง ตัวอย่างเช่น purchaseRevenue จะมีประเภทการจำกัดเป็น REVENUE_DATA เสมอ แต่ระบบจะป้อนข้อมูลข้อจำกัดการตอบกลับที่ใช้งานอยู่นี้ต่อเมื่อบทบาทที่กำหนดเองของผู้ใช้ไม่อนุญาตให้เข้าถึง REVENUE_DATA

ActiveMetricRestriction

เมตริกถูกจํากัดในการสร้างรายงานอยู่

การแสดง JSON 
{
  "restrictedMetricTypes": [
    enum (RestrictedMetricType)
  ],
  "metricName": string
}
ช่อง
restrictedMetricTypes[]

enum (RestrictedMetricType)

เหตุผลสำหรับข้อจำกัดของเมตริกนี้
metricName

string

ชื่อของเมตริกที่ถูกจำกัด

RestrictedMetricType

หมวดหมู่ของข้อมูลที่คุณอาจถูกจำกัดไม่ให้ดูในพร็อพเพอร์ตี้ GA4 บางรายการ

Enum
RESTRICTED_METRIC_TYPE_UNSPECIFIED ไม่ระบุประเภท
COST_DATA เมตริกค่าใช้จ่าย เช่น adCost
REVENUE_DATA เมตริกรายได้ เช่น purchaseRevenue