Method: properties.runReport

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

คำขอ HTTP

POST https://analyticsdata.googleapis.com/v1alpha/{property=properties/*}:runReport

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

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

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

string

ต้องระบุ ตัวระบุพร็อพเพอร์ตี้ Google Analytics ที่มีการติดตามเหตุการณ์ ระบุในเส้นทาง URL ไม่ใช่ในเนื้อหา ดูข้อมูลเพิ่มเติมได้ที่วิธีค้นหารหัสพร็อพเพอร์ตี้ ในคำขอแบบกลุ่ม พร็อพเพอร์ตี้นี้ควรไม่ระบุหรือสอดคล้องกับพร็อพเพอร์ตี้ระดับกลุ่ม

ตัวอย่าง: properties/1234

เนื้อความของคำขอ

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

การแสดง JSON 
{
  "dimensions": [
    {
      object (Dimension)
    }
  ],
  "metrics": [
    {
      object (Metric)
    }
  ],
  "dateRanges": [
    {
      object (DateRange)
    }
  ],
  "dimensionFilter": {
    object (FilterExpression)
  },
  "metricFilter": {
    object (FilterExpression)
  },
  "offset": string,
  "limit": string,
  "metricAggregations": [
    enum (MetricAggregation)
  ],
  "orderBys": [
    {
      object (OrderBy)
    }
  ],
  "currencyCode": string,
  "cohortSpec": {
    object (CohortSpec)
  },
  "keepEmptyRows": boolean,
  "returnPropertyQuota": boolean,
  "comparisons": [
    {
      object (Comparison)
    }
  ],
  "conversionSpec": {
    object (ConversionSpec)
  }
}
ฟิลด์
dimensions[]

object (Dimension)

ไม่บังคับ มิติข้อมูลที่ขอและแสดง
metrics[]

object (Metric)

ไม่บังคับ เมตริกที่ขอและแสดง
dateRanges[]

object (DateRange)

ไม่บังคับ ช่วงวันที่ของข้อมูลที่จะอ่าน หากมีการขอช่วงวันที่หลายช่วง แต่ละแถวการตอบกลับจะมีดัชนีช่วงวันที่ที่อิงตาม 0 หากช่วงวันที่ 2 ช่วงทับซ้อนกัน ระบบจะรวมข้อมูลเหตุการณ์ของวันที่ทับซ้อนกันไว้ในแถวการตอบกลับของทั้ง 2 ช่วงวันที่ ในคำขอกลุ่มประชากรตามรุ่น dateRanges นี้ต้องไม่ระบุ
dimensionFilter

object (FilterExpression)

ไม่บังคับ ตัวกรองมิติข้อมูลช่วยให้คุณขอเฉพาะค่ามิติข้อมูลที่ต้องการในรายงานได้ ดูข้อมูลเพิ่มเติมได้ที่พื้นฐานของตัวกรองมิติข้อมูลเพื่อดูตัวอย่าง ใช้เมตริกในตัวกรองนี้ไม่ได้
metricFilter

object (FilterExpression)

ไม่บังคับ ข้อความตัวกรองของเมตริก ใช้หลังจากรวมแถวของรายงานแล้ว ซึ่งคล้ายกับอนุประโยค HAVING ของ SQL ใช้มิติข้อมูลในตัวกรองนี้ไม่ได้
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 เช่น มิติข้อมูล country มีค่าที่เป็นไปได้น้อยกว่า 300 ค่า ดังนั้นเมื่อรายงานเฉพาะ country คุณจะได้รับแถวไม่เกิน 300 แถว แม้ว่าจะตั้งค่า limit ให้สูงขึ้นก็ตาม

ดูข้อมูลเพิ่มเติมเกี่ยวกับพารามิเตอร์การแบ่งหน้าได้ที่การแบ่งหน้า
metricAggregations[]

enum (MetricAggregation)

ไม่บังคับ การรวมเมตริก ค่าเมตริกที่รวบรวมจะแสดงในแถวที่ตั้งค่า dimensionValues เป็น "RESERVED_(MetricAggregation)" การรวมซึ่งรวมทั้งการเปรียบเทียบและช่วงวันที่หลายช่วงจะได้รับการรวมตามช่วงวันที่
orderBys[]

object (OrderBy)

ไม่บังคับ ระบุวิธีจัดเรียงแถวในการตอบกลับ คำขอที่มีทั้งการเปรียบเทียบและช่วงวันที่หลายช่วงจะมีการใช้ ORDER BY กับการเปรียบเทียบ
currencyCode

string

ไม่บังคับ รหัสสกุลเงินในรูปแบบ ISO4217 เช่น "AED", "USD", "JPY" หากช่องว่าง รายงานจะใช้สกุลเงินเริ่มต้นของพร็อพเพอร์ตี้
cohortSpec

object (CohortSpec)

ไม่บังคับ กลุ่มประชากรตามรุ่นที่เชื่อมโยงกับคำขอนี้ หากมีกลุ่มกลุ่มประชากรตามรุ่นในคำขอ จะต้องมีมิติข้อมูล "กลุ่มประชากรตามรุ่น"
keepEmptyRows

boolean

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

ไม่ว่าkeepEmptyRowsการตั้งค่านี้จะเป็นอย่างไร ระบบจะแสดงได้เฉพาะข้อมูลที่พร็อพเพอร์ตี้ Google Analytics บันทึกไว้ในรายงานเท่านั้น

เช่น หากพร็อพเพอร์ตี้ไม่เคยบันทึกเหตุการณ์ purchase การค้นหามิติข้อมูล eventName และเมตริก eventCount จะไม่มีแถว eventName: "purchase" และ eventCount: 0
returnPropertyQuota

boolean

ไม่บังคับ สลับว่าจะแสดงสถานะปัจจุบันของโควต้าของพร็อพเพอร์ตี้ Google Analytics นี้หรือไม่ โควต้าจะแสดงใน PropertyQuota
comparisons[]

object (Comparison)

ไม่บังคับ การกำหนดค่าของการเปรียบเทียบที่ขอและแสดง คำขอต้องมีเฉพาะฟิลด์การเปรียบเทียบเท่านั้นจึงจะรับคอลัมน์การเปรียบเทียบในการตอบกลับได้
conversionSpec

object (ConversionSpec)

ไม่บังคับ ควบคุมการรายงาน Conversion ช่องนี้จะระบุหรือไม่ก็ได้ หากตั้งค่าฟิลด์นี้หรือขอเมตริก Conversion ใดๆ รายงานจะเป็นรายงาน Conversion

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

ตารางรายงานการตอบกลับที่สอดคล้องกับคำขอ

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

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

object (DimensionHeader)

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

object (MetricHeader)

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

object (Row)

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

object (Row)

หากมีการขอ ค่ารวมของเมตริก
maximums[]

object (Row)

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

object (Row)

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

integer

จำนวนแถวทั้งหมดในผลการค้นหา ไม่ว่าจำนวนแถวที่แสดงผลในการตอบกลับจะเป็นเท่าใดก็ตาม ตัวอย่างเช่น หากการค้นหาแสดงผล 175 แถวและมี limit = 50 ในคำขอ API การตอบกลับจะมี rowCount = 175 แต่มีเพียง 50 แถว

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

object (ResponseMetaData)

ข้อมูลเมตาของรายงาน
propertyQuota

object (PropertyQuota)

สถานะโควต้าของพร็อพเพอร์ตี้ Google Analytics นี้ รวมถึงคำขอนี้
kind

string

ระบุประเภทของทรัพยากรที่ข้อความนี้เป็น kind นี้จะเป็นสตริงคงที่ "analyticsData#runReport" เสมอ มีประโยชน์ในการแยกความแตกต่างระหว่างประเภทการตอบกลับใน JSON
nextPageToken

string

โทเค็นที่ส่งเป็น pageToken เพื่อเรียกข้อมูลหน้าถัดไปได้ หากละเว้นช่องนี้ จะไม่มีหน้าถัดไป

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

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

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

การเปรียบเทียบ

กำหนดการเปรียบเทียบแต่ละรายการ คำขอส่วนใหญ่จะมีการเปรียบเทียบหลายรายการเพื่อให้รายงานเปรียบเทียบระหว่างการเปรียบเทียบ

การแสดง JSON 
{
  "name": string,

  // Union field one_comparison can be only one of the following:
  "dimensionFilter": {
    object (FilterExpression)
  },
  "comparison": string
  // End of list of possible types for union field one_comparison.
}
ช่อง
name

string

การเปรียบเทียบแต่ละครั้งจะสร้างแถวแยกกันในการตอบกลับ ในการตอบกลับ ระบบจะระบุการเปรียบเทียบนี้ด้วยชื่อนี้ หากไม่ได้ระบุชื่อ เราจะใช้ชื่อที่แสดงของการเปรียบเทียบที่บันทึกไว้

ฟิลด์ Union one_comparison

one_comparison ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้เท่านั้น
dimensionFilter

object (FilterExpression)

การเปรียบเทียบพื้นฐาน
comparison

string

การเปรียบเทียบที่บันทึกไว้ซึ่งระบุโดยชื่อทรัพยากรของการเปรียบเทียบ เช่น "comparisons/1234"

ConversionSpec

ควบคุมการรายงาน Conversion

การแสดง JSON 
{
  "conversionActions": [
    string
  ],
  "attributionModel": enum (AttributionModel)
}
ช่อง
conversionActions[]

string

รหัสการกระทำที่ถือเป็น Conversion ที่จะรวมไว้ในรายงาน หากเว้นว่างไว้ ระบบจะรวม Conversion ทั้งหมด คุณดึงรหัสการกระทำที่ถือเป็น Conversion ที่ถูกต้องได้จากฟิลด์ conversionAction ภายในรายการ conversions ในการตอบกลับของเมธอด properties.getMetadata เช่น "conversionActions/1234"
attributionModel

enum (AttributionModel)

รูปแบบการระบุแหล่งที่มาที่จะใช้ในรายงาน Conversion หากไม่ระบุ ระบบจะใช้ DATA_DRIVEN

AttributionModel

รูปแบบการระบุแหล่งที่มาที่จะใช้ในรายงาน Conversion

Enum
ATTRIBUTION_MODEL_UNSPECIFIED รูปแบบการระบุแหล่งที่มาที่ไม่ได้ระบุ
DATA_DRIVEN Attribution อิงตามรูปแบบที่อิงตามข้อมูลแบบมีค่าใช้จ่ายและข้อมูลในบริบททั่วไป
LAST_CLICK การระบุแหล่งที่มาอิงตามรูปแบบคลิกสุดท้ายแบบมีค่าใช้จ่ายและแบบทั่วไป