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 ที่มี offset=900 และ limit=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