REST Resource: properties.reportTasks

แหล่งข้อมูล: ReportTask

การกำหนดค่างานรายงานที่เจาะจง

การแสดง JSON 
{
  "name": string,
  "reportDefinition": {
    object (ReportDefinition)
  },
  "reportMetadata": {
    object (ReportMetadata)
  }
}
ช่อง
name

string

เอาต์พุตเท่านั้น ตัวระบุ ชื่อทรัพยากรงานของรายงานที่กำหนดระหว่างการสร้าง รูปแบบ: "properties/{property}/reportTasks/{reportTask}"
reportDefinition

object (ReportDefinition)

ไม่บังคับ คำจำกัดความของรายงานสำหรับดึงข้อมูลรายงาน ซึ่งอธิบายโครงสร้างของรายงาน โดยทั่วไปจะมีช่องที่จะรวมไว้ในรายงานและเกณฑ์ที่จะใช้ในการกรองข้อมูล
reportMetadata

object (ReportMetadata)

เอาต์พุตเท่านั้น ข้อมูลเมตาของรายงานสำหรับงานรายงานที่เฉพาะเจาะจง ซึ่งให้ข้อมูลเกี่ยวกับรายงาน โดยทั่วไปจะมีข้อมูลต่อไปนี้ ได้แก่ ชื่อทรัพยากรของรายงาน สถานะของรายงาน การประทับเวลาที่สร้างรายงาน ฯลฯ

ReportDefinition

คำจำกัดความของวิธีการเรียกใช้รายงาน

การแสดง 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
}
ช่อง
dimensions[]

object (Dimension)

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

object (Metric)

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

object (DateRange)

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

object (FilterExpression)

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

object (FilterExpression)

ไม่บังคับ ข้อความตัวกรองของเมตริก นำไปใช้หลังจากรวมแถวของรายงาน ซึ่งคล้ายกับเงื่อนไขที่มี SQL ใช้มิติข้อมูลในตัวกรองนี้ไม่ได้
offset

string (int64 format)

ไม่บังคับ จำนวนแถวของแถวเริ่มต้นจากพื้นที่เก็บข้อมูลของ Google Analytics แถวแรกจะนับเป็นแถว 0

เมื่อสร้างงานรายงาน พารามิเตอร์ offset และ limit จะกำหนดชุดย่อยของแถวข้อมูลจากพื้นที่เก็บข้อมูลของ Google Analytics เพื่อรวมไว้ในรายงานที่สร้างขึ้น ตัวอย่างเช่น หากมีทั้งหมด 300,000 แถวในพื้นที่เก็บข้อมูล Google Analytics งานรายงานเริ่มต้นอาจมี 10,000 แถวแรกโดยจำกัดที่ 10,000 แถวและมีออฟเซ็ตเป็น 0 ต่อมา งานรายงานอีกงานอาจครอบคลุม 10,000 แถวถัดไปโดยมีขีดจำกัด 10,000 แถวและชดเชย 10,000 แถว
limit

string (int64 format)

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

นอกจากนี้ API อาจแสดงผลแถวน้อยกว่า limit ที่ขอด้วย หากมีค่ามิติข้อมูลไม่มากเท่ากับ limit ตัวอย่างเช่น มีค่าที่เป็นไปได้น้อยกว่า 300 ค่าสำหรับมิติข้อมูล country ดังนั้นเมื่อรายงานเฉพาะ country จะมีแถวได้ไม่เกิน 300 แถว แม้ว่าคุณจะตั้งค่า limit เป็นค่าที่สูงกว่าก็ตาม
metricAggregations[]

enum (MetricAggregation)

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

object (OrderBy)

ไม่บังคับ ระบุลำดับแถวในการตอบกลับ
currencyCode

string

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

object (CohortSpec)

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

boolean

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

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

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

มิติข้อมูล

มิติข้อมูลคือลักษณะของข้อมูล ตัวอย่างเช่น มิติข้อมูลเมืองจะระบุเมืองที่เกิดเหตุการณ์ ค่ามิติข้อมูลในคำตอบของรายงานคือสตริง ตัวอย่างเช่น เมืองอาจเป็น "ปารีส" หรือ "New York"

การแสดง JSON 
{
  "name": string,
  "dimensionExpression": {
    object (DimensionExpression)
  }
}
ช่อง
name

string

ชื่อของมิติข้อมูล ดูมิติข้อมูล API สำหรับรายการชื่อมิติข้อมูลที่วิธีการรายงานหลักรองรับ เช่น runReport และ batchRunReports ดูมิติข้อมูลแบบเรียลไทม์สำหรับรายการชื่อมิติข้อมูลที่เมธอด runRealtimeReport รองรับ ดูมิติข้อมูลช่องทางสำหรับรายการชื่อมิติข้อมูลที่เมธอด runFunnelReport รองรับ

หากระบุ dimensionExpression แล้ว name อาจเป็นสตริงใดก็ได้ที่ต้องการภายในชุดอักขระที่อนุญาต ตัวอย่างเช่น หาก dimensionExpression เชื่อม country และ city เข้าด้วยกัน คุณสามารถเรียกมิติข้อมูลนั้นว่า countryAndCity ชื่อมิติข้อมูลที่คุณเลือกต้องตรงกับนิพจน์ทั่วไป ^[a-zA-Z0-9_]$

name อ้างอิงมิติข้อมูลใน dimensionFilter, orderBys, dimensionExpression และ pivots
dimensionExpression

object (DimensionExpression)

มิติข้อมูลหนึ่งอาจเป็นผลมาจากนิพจน์ของมิติข้อมูลหลายรายการ เช่น มิติข้อมูล "ประเทศ, เมือง": เชื่อมต่อ(ประเทศ, ", ", เมือง)

DimensionExpression

ใช้เพื่อแสดงมิติข้อมูลที่เกิดจากสูตรของมิติข้อมูลหลายรายการ ตัวอย่างการใช้งาน ได้แก่ 1) ตัวพิมพ์เล็ก(มิติข้อมูล) 2) เชื่อมต่อ(มิติข้อมูล 1 สัญลักษณ์ มิติข้อมูล 2)

การแสดง JSON 
{

  // Union field one_expression can be only one of the following:
  "lowerCase": {
    object (CaseExpression)
  },
  "upperCase": {
    object (CaseExpression)
  },
  "concatenate": {
    object (ConcatenateExpression)
  }
  // End of list of possible types for union field one_expression.
}
ช่อง
ช่องการรวม one_expression ระบุนิพจน์มิติข้อมูล 1 ประเภทสำหรับ DimensionExpression one_expression ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้
lowerCase

object (CaseExpression)

ใช้เพื่อแปลงค่ามิติข้อมูลเป็นตัวพิมพ์เล็ก
upperCase

object (CaseExpression)

ใช้เพื่อแปลงค่ามิติข้อมูลเป็นตัวพิมพ์ใหญ่
concatenate

object (ConcatenateExpression)

ใช้เพื่อรวมค่ามิติข้อมูลกับมิติข้อมูลเดียว เช่น มิติข้อมูล "ประเทศ, เมือง": เชื่อมต่อ(ประเทศ, ", ", เมือง)

CaseExpression

ใช้เพื่อแปลงค่ามิติข้อมูลเป็นกรณีเดียว

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

string

ชื่อของมิติข้อมูล ชื่อต้องอ้างอิงกลับไปที่ชื่อในช่องมิติข้อมูลของคำขอ

ConcatenateExpression

ใช้เพื่อรวมค่ามิติข้อมูลกับมิติข้อมูลเดียว

การแสดง JSON 
{
  "dimensionNames": [
    string
  ],
  "delimiter": string
}
ช่อง
dimensionNames[]

string

ชื่อของมิติข้อมูล ชื่อต้องอ้างอิงถึงชื่อในช่องมิติข้อมูลของคำขอ
delimiter

string

ตัวคั่นที่วางไว้ระหว่างชื่อมิติข้อมูล

ตัวคั่นมักเป็นอักขระเดี่ยว เช่น "|" หรือ "," แต่อาจเป็นสตริงที่ยาวกว่า หากค่ามิติข้อมูลมีตัวคั่น ค่าทั้ง 2 อย่างจะแสดงโดยไม่มีความแตกต่าง เช่น หากมิติข้อมูล 1 ค่า = "US,FR", ค่ามิติข้อมูล 2 = "JP" และตัวคั่น = "," คำตอบก็จะมี "US,FR,JP"

เมตริก

การวัดเชิงปริมาณของรายงาน ตัวอย่างเช่น เมตริก eventCount คือจํานวนเหตุการณ์ทั้งหมด คำขอมีเมตริกได้ไม่เกิน 10 รายการ

การแสดง JSON 
{
  "name": string,
  "expression": string,
  "invisible": boolean
}
ช่อง
name

string

ชื่อของเมตริก โปรดดูรายการชื่อเมตริกที่วิธีการรายงานหลักรองรับที่เมตริก API เช่น runReport และ batchRunReports ดูเมตริกแบบเรียลไทม์สำหรับรายการชื่อเมตริกที่เมธอด runRealtimeReport รองรับ ดูเมตริก Funnel สำหรับรายการชื่อเมตริกที่เมธอด runFunnelReport รองรับ

หากระบุ expression แล้ว name อาจเป็นสตริงใดก็ได้ที่ต้องการภายในชุดอักขระที่อนุญาต ตัวอย่างเช่น หาก expression คือ screenPageViews/sessions คุณสามารถเรียกชื่อเมตริกนั้นว่า = viewsPerSession ชื่อเมตริกที่เลือกต้องตรงกับนิพจน์ทั่วไป ^[a-zA-Z0-9_]$

อ้างอิงเมตริกโดย name ใน metricFilter, orderBys และเมตริก expression
expression

string

นิพจน์ทางคณิตศาสตร์สำหรับเมตริกที่ได้มา เช่น จำนวนเหตุการณ์ของเมตริกต่อผู้ใช้คือ eventCount/totalUsers
invisible

boolean

ระบุว่าเมตริกจะไม่แสดงในคำตอบของรายงานหรือไม่ หากเมตริกไม่ปรากฏ เมตริกจะไม่แสดงคอลัมน์ในคำตอบ แต่สามารถใช้ใน metricFilter, orderBys หรือเมตริก expression

DateRange

ชุดวันที่ต่อเนื่อง: startDate, startDate + 1, ..., endDate คำขออนุญาตให้มีช่วงวันที่ได้ไม่เกิน 4 ช่วง

การแสดง JSON 
{
  "startDate": string,
  "endDate": string,
  "name": string
}
ช่อง
startDate

string

วันที่เริ่มต้นที่ครอบคลุมสำหรับการค้นหาในรูปแบบ YYYY-MM-DD จะอยู่หลัง endDate ไม่ได้ ระบบยอมรับรูปแบบ NdaysAgo, yesterday หรือ today ด้วย ในกรณีนี้ วันที่จะอนุมานตามเขตเวลาในการรายงานของพร็อพเพอร์ตี้
endDate

string

วันที่สิ้นสุดแบบรวมสำหรับการค้นหาในรูปแบบ YYYY-MM-DD ต้องไม่อยู่ก่อนวันที่ startDate ระบบยอมรับรูปแบบ NdaysAgo, yesterday หรือ today ด้วย ในกรณีนี้ วันที่จะอนุมานตามเขตเวลาในการรายงานของพร็อพเพอร์ตี้
name

string

กำหนดชื่อให้กับช่วงวันที่นี้ มิติข้อมูล dateRange จะมีค่าสำหรับชื่อนี้ในการตอบกลับรายงาน หากตั้งค่าไว้ จะขึ้นต้นด้วย date_range_ หรือ RESERVED_ ไม่ได้ หากไม่ได้ตั้งค่า ช่วงวันที่จะตั้งชื่อตามดัชนีฐาน 0 ในคำขอ: date_range_0, date_range_1 ฯลฯ

FilterExpression

เพื่อแสดงตัวกรองมิติข้อมูลหรือเมตริก ฟิลด์ในFilterExpression เดียวกันจะต้องเป็นมิติข้อมูลทั้งหมดหรือเมตริกทั้งหมด

การแสดง JSON 
{

  // Union field expr can be only one of the following:
  "andGroup": {
    object (FilterExpressionList)
  },
  "orGroup": {
    object (FilterExpressionList)
  },
  "notExpression": {
    object (FilterExpression)
  },
  "filter": {
    object (Filter)
  }
  // End of list of possible types for union field expr.
}
ช่อง
ช่องการรวม expr ระบุนิพจน์ตัวกรอง 1 ประเภทสำหรับ FilterExpression expr ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้
andGroup

object (FilterExpressionList)

นิพจน์ตัวกรองใน andGroup มีความสัมพันธ์แบบ "และ"
orGroup

object (FilterExpressionList)

นิพจน์ตัวกรองในหรือกลุ่มมีความสัมพันธ์แบบ OR
notExpression

object (FilterExpression)

FilterExpression ไม่ใช่ notExpression
filter

object (Filter)

ตัวกรองพื้นฐาน ในFilterExpression เดียวกัน ชื่อช่องทั้งหมดของตัวกรองจะต้องเป็นมิติข้อมูลทั้งหมดหรือเมตริกทั้งหมด

FilterExpressionList

รายการนิพจน์ตัวกรอง

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

object (FilterExpression)

รายการนิพจน์ตัวกรอง

ตัวกรอง

นิพจน์เพื่อกรองค่ามิติข้อมูลหรือเมตริก

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

  // Union field one_filter can be only one of the following:
  "stringFilter": {
    object (StringFilter)
  },
  "inListFilter": {
    object (InListFilter)
  },
  "numericFilter": {
    object (NumericFilter)
  },
  "betweenFilter": {
    object (BetweenFilter)
  }
  // End of list of possible types for union field one_filter.
}
ช่อง
fieldName

string

ชื่อมิติข้อมูลหรือชื่อเมตริก ต้องเป็นชื่อที่กำหนดไว้ในมิติข้อมูลหรือเมตริก
ช่องการรวม one_filter ระบุตัวกรอง 1 ประเภทสำหรับ Filter one_filter ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้
stringFilter

object (StringFilter)

ตัวกรองที่เกี่ยวข้องกับสตริง
inListFilter

object (InListFilter)

ตัวกรองสำหรับค่าในรายการ
numericFilter

object (NumericFilter)

ตัวกรองสำหรับค่าตัวเลขหรือวันที่
betweenFilter

object (BetweenFilter)

ตัวกรองสำหรับระหว่าง 2 ค่า

StringFilter

ตัวกรองสำหรับสตริง

การแสดง JSON 
{
  "matchType": enum (MatchType),
  "value": string,
  "caseSensitive": boolean
}
ช่อง
matchType

enum (MatchType)

ประเภทการทำงานของคีย์เวิร์ดสำหรับตัวกรองนี้
value

string

ค่าสตริงที่ใช้สำหรับการจับคู่
caseSensitive

boolean

หากเป็น "จริง" ค่าสตริงจะคำนึงถึงตัวพิมพ์เล็กและตัวพิมพ์ใหญ่

MatchType

ประเภทการทำงานของคีย์เวิร์ดของตัวกรองสตริง

Enum
MATCH_TYPE_UNSPECIFIED ไม่ระบุ
EXACT ค่าสตริงที่ตรงกันทั้งหมด
BEGINS_WITH เริ่มต้นด้วยค่าสตริง
ENDS_WITH ลงท้ายด้วยค่าสตริง
CONTAINS มีค่าสตริง
FULL_REGEXP การจับคู่เต็มรูปแบบสำหรับนิพจน์ทั่วไปที่มีค่าสตริง
PARTIAL_REGEXP การจับคู่บางส่วนสำหรับนิพจน์ทั่วไปที่มีค่าสตริง

InListFilter

ผลลัพธ์จำเป็นต้องอยู่ในรายการค่าสตริง

การแสดง JSON 
{
  "values": [
    string
  ],
  "caseSensitive": boolean
}
ช่อง
values[]

string

รายการค่าสตริง ต้องระบุ
caseSensitive

boolean

หากเป็น "จริง" ค่าสตริงจะคำนึงถึงตัวพิมพ์เล็กและตัวพิมพ์ใหญ่

NumericFilter

ตัวกรองสำหรับค่าตัวเลขหรือวันที่

การแสดง JSON 
{
  "operation": enum (Operation),
  "value": {
    object (NumericValue)
  }
}
ช่อง
operation

enum (Operation)

ประเภทการดำเนินการสำหรับตัวกรองนี้
value

object (NumericValue)

ค่าตัวเลขหรือค่าวันที่

การดำเนินการ

การดำเนินการที่ใช้กับตัวกรองตัวเลข

Enum
OPERATION_UNSPECIFIED ไม่ระบุ
EQUAL เท่ากับ
LESS_THAN น้อยกว่า
LESS_THAN_OR_EQUAL น้อยกว่าหรือเท่ากับ
GREATER_THAN มากกว่า
GREATER_THAN_OR_EQUAL มากกว่าหรือเท่ากับ

NumericValue

เพื่อแทนตัวเลข

การแสดง JSON 
{

  // Union field one_value can be only one of the following:
  "int64Value": string,
  "doubleValue": number
  // End of list of possible types for union field one_value.
}
ช่อง
ช่องการรวม one_value ค่าตัวเลข one_value ค่าใดค่าหนึ่งต้องเป็นค่าใดค่าหนึ่งต่อไปนี้
int64Value

string (int64 format)

ค่าจำนวนเต็ม
doubleValue

number

ค่า Double

BetweenFilter

เพื่อแสดงว่าผลลัพธ์ต้องอยู่ระหว่างตัวเลข 2 ตัว (รวม 2 ตัว)

การแสดง JSON 
{
  "fromValue": {
    object (NumericValue)
  },
  "toValue": {
    object (NumericValue)
  }
}
ช่อง
fromValue

object (NumericValue)

ขึ้นต้นด้วยตัวเลขนี้
toValue

object (NumericValue)

ลงท้ายด้วยหมายเลขนี้

MetricAggregation

แสดงการรวมเมตริก

Enum
METRIC_AGGREGATION_UNSPECIFIED โอเปอเรเตอร์ที่ไม่ได้ระบุ
TOTAL โอเปอเรเตอร์ SUM
MINIMUM โอเปอเรเตอร์ขั้นต่ำ
MAXIMUM โอเปอเรเตอร์สูงสุด
COUNT โอเปอเรเตอร์การนับ

สั่งโดย

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

การแสดง JSON 
{
  "desc": boolean,

  // Union field one_order_by can be only one of the following:
  "metric": {
    object (MetricOrderBy)
  },
  "dimension": {
    object (DimensionOrderBy)
  }
  // End of list of possible types for union field one_order_by.
}
ช่อง
desc

boolean

หากเป็น "จริง" จะจัดเรียงตามลำดับจากมากไปน้อย
ช่องการรวม one_order_by ระบุคำสั่งซื้อ 1 ประเภทตาม OrderBy one_order_by ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้
metric

object (MetricOrderBy)

จัดเรียงผลลัพธ์ตามค่าของเมตริก
dimension

object (DimensionOrderBy)

จัดเรียงผลลัพธ์ตามค่าของมิติข้อมูล

MetricOrderBy

จัดเรียงตามค่าเมตริก

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

string

ชื่อเมตริกในคำขอเรียงลำดับ

DimensionOrderBy

จัดเรียงตามค่ามิติข้อมูล

การแสดง JSON 
{
  "dimensionName": string,
  "orderType": enum (OrderType)
}
ช่อง
dimensionName

string

ชื่อมิติข้อมูลในคำขอเพื่อเรียงลำดับ
orderType

enum (OrderType)

ควบคุมกฎสำหรับการจัดลำดับค่าของมิติข้อมูล

OrderType

กฎสำหรับเรียงลำดับค่ามิติข้อมูลสตริง

Enum
ORDER_TYPE_UNSPECIFIED ไม่ระบุ
ALPHANUMERIC จัดเรียงอักขระและตัวเลขตามจุดรหัส Unicode เช่น "2" < "A" < "X" < "b" < "z"
CASE_INSENSITIVE_ALPHANUMERIC ตัวอักษรและตัวเลขคละกันที่ไม่คำนึงถึงตัวพิมพ์เล็กและตัวพิมพ์ใหญ่จะจัดเรียงตามจุดโค้ด Unicode ตัวพิมพ์เล็ก เช่น "2" < "A" < "b" < "X" < "z"
NUMERIC ระบบจะแปลงค่ามิติข้อมูลเป็นตัวเลขก่อนจัดเรียง เช่น ในการจัดเรียง NUMERIC แบบ "25" < "100" และจัดเรียง ALPHANUMERIC เป็น "100" < "25" ค่ามิติข้อมูลที่ไม่ใช่ตัวเลขทั้งหมดมีค่าลำดับเท่ากันด้านล่างค่าตัวเลขทั้งหมด

CohortSpec

ข้อกำหนดของกลุ่มประชากรตามรุ่นสำหรับรายงานกลุ่มประชากรตามรุ่น

รายงานกลุ่มประชากรตามรุ่นจะสร้างอนุกรมเวลาของการคงผู้ใช้ไว้สำหรับกลุ่มประชากรตามรุ่น เช่น คุณอาจเลือกกลุ่มประชากรตามรุ่นของผู้ใช้ที่ได้มาในสัปดาห์แรกของเดือนกันยายน และติดตามกลุ่มประชากรตามรุ่นนั้นในอีก 6 สัปดาห์ การเลือกผู้ใช้ที่ได้มาในสัปดาห์แรกของกลุ่มประชากรตามรุ่นในเดือนกันยายนจะแสดงในออบเจ็กต์ cohort ระบบได้ระบุกลุ่มประชากรตามรุ่นดังกล่าวในช่วง 6 สัปดาห์ถัดไปไว้ในออบเจ็กต์ cohortsRange

โปรดดูตัวอย่างต่อไปนี้ที่หัวข้อตัวอย่างรายงานกลุ่มประชากรตามรุ่น

การตอบกลับของรายงานอาจแสดงอนุกรมเวลารายสัปดาห์ที่สมมติว่าแอปของคุณรักษา 60% ของกลุ่มประชากรตามรุ่นนี้หลังจากผ่านไป 3 สัปดาห์และ 25% ของกลุ่มประชากรตามรุ่นนี้หลังจากผ่านไป 6 สัปดาห์ เปอร์เซ็นต์ 2 ค่านี้คำนวณได้โดยใช้เมตริก cohortActiveUsers/cohortTotalUsers และจะแยกเป็นแถวในรายงาน

การแสดง JSON 
{
  "cohorts": [
    {
      object (Cohort)
    }
  ],
  "cohortsRange": {
    object (CohortsRange)
  },
  "cohortReportSettings": {
    object (CohortReportSettings)
  }
}
ช่อง
cohorts[]

object (Cohort)

กำหนดเกณฑ์การเลือกเพื่อจัดกลุ่มผู้ใช้เป็นกลุ่มประชากรตามรุ่น

รายงานกลุ่มประชากรตามรุ่นส่วนใหญ่กําหนดกลุ่มประชากรตามรุ่นเพียงกลุ่มเดียว หากระบุกลุ่มประชากรตามรุ่นหลายกลุ่ม ชื่อกลุ่มประชากรตามรุ่นแต่ละกลุ่มจะรับรู้ได้ในรายงาน
cohortsRange

object (CohortsRange)

รายงานกลุ่มประชากรตามรุ่นจะติดตามกลุ่มประชากรตามรุ่นในช่วงวันที่ที่รายงานเพิ่มเติม ช่วงนี้ระบุระยะเวลาชดเชยเพื่อติดตามกลุ่มประชากรตามรุ่น
cohortReportSettings

object (CohortReportSettings)

การตั้งค่าที่ไม่บังคับสําหรับรายงานกลุ่มประชากรตามรุ่น

กลุ่มร่วม

กำหนดเกณฑ์การเลือกกลุ่มประชากรตามรุ่น กลุ่มประชากรตามรุ่นคือกลุ่มผู้ใช้ที่มีลักษณะร่วมกัน เช่น ผู้ใช้ที่มี firstSessionDate เหมือนกันถือเป็นกลุ่มประชากรตามรุ่นกลุ่มเดียวกัน

การแสดง JSON 
{
  "name": string,
  "dimension": string,
  "dateRange": {
    object (DateRange)
  }
}
ช่อง
name

string

กำหนดชื่อให้กับกลุ่มประชากรตามรุ่นนี้ มิติข้อมูล cohort จะมีค่าสำหรับชื่อนี้ในการตอบกลับรายงาน หากตั้งค่าไว้ จะขึ้นต้นด้วย cohort_ หรือ RESERVED_ ไม่ได้ หากไม่ได้ตั้งค่า กลุ่มประชากรตามรุ่นจะตั้งชื่อตามดัชนีที่อิงตามศูนย์ cohort_0, cohort_1 ฯลฯ
dimension

string

มิติข้อมูลที่กลุ่มประชากรตามรุ่นใช้ จำเป็นและรองรับเฉพาะ firstSessionDate
dateRange

object (DateRange)

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

ในคำขอกลุ่มประชากรตามรุ่น ต้องมี dateRange นี้ และต้องไม่ระบุ dateRanges ใน RunReportRequest หรือ RunPivotReportRequest

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

CohortsRange

กำหนดค่าช่วงวันที่การรายงานแบบขยายสำหรับรายงานกลุ่มประชากรตามรุ่น ระบุระยะเวลาออฟเซ็ตเพื่อติดตามกลุ่มประชากรตามรุ่น

การแสดง JSON 
{
  "granularity": enum (Granularity),
  "startOffset": integer,
  "endOffset": integer
}
ช่อง
granularity

enum (Granularity)

ต้องระบุ รายละเอียดที่ใช้ในการตีความ startOffset และ endOffset ของช่วงวันที่การรายงานเพิ่มเติมสำหรับรายงานกลุ่มประชากรตามรุ่น
startOffset

integer

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

หาก granularity เท่ากับ DAILY ค่า startDate ของช่วงวันที่การรายงานที่ขยายจะเท่ากับ startDate ของกลุ่มประชากรตามรุ่นบวก startOffset วัน

หาก granularity เท่ากับ WEEKLY ค่า startDate ของช่วงวันที่การรายงานที่ขยายจะเท่ากับ startDate ของกลุ่มประชากรตามรุ่นบวก startOffset * 7 วัน

หาก granularity เท่ากับ MONTHLY ค่า startDate ของช่วงวันที่การรายงานที่ขยายจะเท่ากับ startDate ของกลุ่มประชากรตามรุ่นบวก startOffset * 30 วัน
endOffset

integer

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

หาก granularity เท่ากับ DAILY ค่า endDate ของช่วงวันที่การรายงานที่ขยายจะเท่ากับ endDate ของกลุ่มประชากรตามรุ่นบวก endOffset วัน

หาก granularity เท่ากับ WEEKLY ค่า endDate ของช่วงวันที่การรายงานที่ขยายจะเท่ากับ endDate ของกลุ่มประชากรตามรุ่นบวก endOffset * 7 วัน

หาก granularity เท่ากับ MONTHLY ค่า endDate ของช่วงวันที่การรายงานที่ขยายจะเท่ากับ endDate ของกลุ่มประชากรตามรุ่นบวก endOffset * 30 วัน

รายละเอียด

รายละเอียดที่ใช้ในการตีความ startOffset และ endOffset ของช่วงวันที่การรายงานเพิ่มเติมสำหรับรายงานกลุ่มประชากรตามรุ่น

Enum
GRANULARITY_UNSPECIFIED ไม่ควรระบุ
DAILY รายละเอียดรายวัน ใช้กันโดยทั่วไปหาก dateRange ของกลุ่มประชากรตามรุ่นเป็นวันเดียวและคำขอมี cohortNthDay
WEEKLY รายละเอียดรายสัปดาห์ ใช้กันโดยทั่วไปหาก dateRange ของกลุ่มประชากรตามรุ่นมีระยะเวลา 1 สัปดาห์ (เริ่มในวันอาทิตย์และสิ้นสุดในวันเสาร์) และคำขอมี cohortNthWeek
MONTHLY รายละเอียดรายเดือน ใช้กันโดยทั่วไปหาก dateRange ของกลุ่มประชากรตามรุ่นมีระยะเวลา 1 เดือนและคำขอมี cohortNthMonth

CohortReportSettings

การตั้งค่าที่ไม่บังคับของรายงานกลุ่มประชากรตามรุ่น

การแสดง JSON 
{
  "accumulate": boolean
}
ช่อง
accumulate

boolean

หากเป็น "จริง" จะรวบรวมผลลัพธ์ตั้งแต่วันที่แตะครั้งแรกไปจนถึงวันที่สิ้นสุด ไม่รองรับใน RunReportRequest

ReportMetadata

ข้อมูลเมตาของรายงานสำหรับงานรายงานที่เฉพาะเจาะจง

การแสดง JSON 
{
  "creationQuotaTokensCharged": integer,
  "state": enum (State),
  "beginCreatingTime": string,
  "taskRowCount": integer,
  "errorMessage": string,
  "totalRowCount": integer
}
ช่อง
creationQuotaTokensCharged

integer

เอาต์พุตเท่านั้น โทเค็นโควต้าทั้งหมดที่เรียกเก็บระหว่างการสร้างรายงาน เนื่องจากจำนวนโทเค็นนี้อิงตามกิจกรรมจากสถานะ CREATING การเรียกเก็บเงินจากโทเค็นนี้จะได้รับการแก้ไขเมื่องานรายงานเข้าสู่สถานะ ACTIVE หรือ FAILED
state

enum (State)

เอาต์พุตเท่านั้น สถานะปัจจุบันของงานรายงานนี้
beginCreatingTime

string (Timestamp format)

เอาต์พุตเท่านั้น เวลาที่มีการเรียก reportTasks.create และรายงานเริ่มต้นสถานะ CREATING

การประทับเวลาเป็น RFC3339 UTC "Zulu" โดยมีความละเอียดระดับนาโนวินาทีและมีเลขเศษส่วนสูงสุด 9 หลัก ตัวอย่าง: "2014-10-02T15:01:23Z" และ "2014-10-02T15:01:23.045123456Z"
taskRowCount

integer

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

string

เอาต์พุตเท่านั้น ระบบจะเติมข้อความแสดงข้อผิดพลาดหากงานรายงานล้มเหลวระหว่างการสร้าง
totalRowCount

integer

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

taskRowCount แสดงจำนวนแถวที่เกี่ยวข้องกับรายงานปัจจุบันโดยเฉพาะ ในขณะที่ totalRowCount ครอบคลุมจำนวนแถวทั้งหมดในข้อมูลทั้งหมดที่ดึงมาจากพื้นที่เก็บข้อมูลของ Google Analytics

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

รัฐ

สถานะการประมวลผล

Enum
STATE_UNSPECIFIED ระบบจะไม่ใช้สถานะที่ไม่ได้ระบุ
CREATING กำลังสร้างรายงานและจะพร้อมใช้งานในอนาคต การสร้างจะเกิดขึ้นทันทีหลังจากการเรียกใช้ CreateReport
ACTIVE สร้างรายงานเสร็จสมบูรณ์และพร้อมสำหรับการค้นหาแล้ว
FAILED สร้างรายงานไม่สำเร็จ

เมธอด

create

 เริ่มการสร้างงานรายงาน

get

 รับข้อมูลเมตารายงานเกี่ยวกับงานรายงานที่ระบุ

list

 แสดงรายการงานรายงานทั้งหมดสําหรับพร็อพเพอร์ตี้

query

 เรียกข้อมูลเนื้อหาของงานรายงาน