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

ResponseMetaData

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

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

boolean

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

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

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

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

object (SamplingMetadata)

หากผลลัพธ์ของรายงานนี้สุ่มตัวอย่าง ข้อมูลนี้จะอธิบายเปอร์เซ็นต์ของเหตุการณ์ที่ใช้ในรายงานนี้ ระบบจะป้อนข้อมูล samplingMetadatas 1 รายการสำหรับแต่ละช่วงวันที่ samplingMetadatas แต่ละรายการสอดคล้องกับช่วงวันที่ตามลำดับที่ระบุช่วงวันที่ในคำขอ

อย่างไรก็ตาม หากไม่ได้สุ่มตัวอย่างผลลัพธ์ ระบบจะไม่กำหนดฟิลด์นี้
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

หมวดหมู่ของข้อมูลที่อาจถูกจํากัดไม่ให้ดูในพร็อพเพอร์ตี้ Google Analytics บางรายการ

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