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" หรือ "เอเชีย/โตเกียว"
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