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,
  "samplingLevel": enum (SamplingLevel)
}
ช่อง
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)

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

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

ไม่บังคับ ระบุวิธีจัดเรียงแถวในการตอบกลับ
currencyCode

string

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

object (CohortSpec)

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

boolean

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

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

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

enum (SamplingLevel)

ไม่บังคับ ระดับการสุ่มตัวอย่างของรายงาน

มิติข้อมูล

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

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

string

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

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

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

object (DimensionExpression)

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

DimensionExpression

ใช้เพื่อแสดงมิติข้อมูลซึ่งเป็นผลลัพธ์ของสูตรของมิติข้อมูลหลายรายการ ตัวอย่างการใช้งาน: 1) lowerCase(dimension) 2) concatenate(dimension1, symbol, dimension2)

การแสดง 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 ระบุนิพจน์มิติข้อมูลประเภทใดประเภทหนึ่งสําหรับ DimensionExpression one_expression ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้เท่านั้น
lowerCase

object (CaseExpression)

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

object (CaseExpression)

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

object (ConcatenateExpression)

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

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

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

หากระบุ 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)

FilterExpressions ใน andGroup มีความสัมพันธ์แบบ "และ"
orGroup

object (FilterExpressionList)

FilterExpressions ใน orGroup มีความสัมพันธ์แบบ "หรือ"
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)
  },
  "emptyFilter": {
    object (EmptyFilter)
  }
  // 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 ค่า
emptyFilter

object (EmptyFilter)

ตัวกรองสำหรับค่าว่าง เช่น ค่า "(not set)" และ ""

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 ตัวเลข (รวม)

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

object (NumericValue)

ขึ้นต้นด้วยหมายเลขนี้
toValue

object (NumericValue)

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

EmptyFilter

ประเภทนี้ไม่มีช่อง

กรองค่าว่าง

MetricAggregation

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

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

OrderBy

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

การแสดง 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 จัดเรียงตัวอักษรและตัวเลขคละกันตาม Code Point ของ Unicode เช่น "2" < "A" < "X" < "b" < "z"
CASE_INSENSITIVE_ALPHANUMERIC การจัดเรียงตัวอักษรและตัวเลขคละกันโดยไม่คำนึงถึงตัวพิมพ์เล็กและตัวพิมพ์ใหญ่ตาม Code Point ของ Unicode แบบตัวพิมพ์เล็ก เช่น "2" < "A" < "b" < "X" < "z"
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_ หากไม่ได้ตั้งค่าไว้ ระบบจะตั้งชื่อกลุ่มประชากรตามดัชนีฐาน 0 เช่น 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 ของกลุ่มประชากรตามรุ่นคือ 1 วันและคําขอมี cohortNthDay
WEEKLY รายละเอียดระดับรายสัปดาห์ ใช้กันโดยทั่วไปหาก dateRange ของกลุ่มประชากรตามรุ่นมีระยะเวลา 1 สัปดาห์ (เริ่มตั้งแต่วันอาทิตย์และสิ้นสุดในวันเสาร์) และคำขอมี cohortNthWeek
MONTHLY รายละเอียดรายเดือน ใช้กันโดยทั่วไปหาก dateRange ของกลุ่มประชากรตามรุ่นมีระยะเวลา 1 เดือนและคําขอมี cohortNthMonth

CohortReportSettings

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

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

boolean

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

SamplingLevel

หมวดหมู่ของระดับการสุ่มตัวอย่างสําหรับคําขอ

Enum
SAMPLING_LEVEL_UNSPECIFIED ประเภทที่ไม่ระบุ
LOW ใช้ระดับการสุ่มตัวอย่าง 10 ล้านรายการกับพร็อพเพอร์ตี้มาตรฐาน และ 100 ล้านรายการกับพร็อพเพอร์ตี้ Google Analytics 360
MEDIUM ใช้ได้เฉพาะกับพร็อพเพอร์ตี้ Google Analytics 360 ที่มีระดับการสุ่มตัวอย่าง 1,000 ล้าน
UNSAMPLED มีให้บริการเฉพาะในพร็อพเพอร์ตี้ Google Analytics 360 การสํารวจแบบไม่สุ่มตัวอย่างจะแม่นยํากว่าและสามารถเปิดเผยข้อมูลเชิงลึกที่ไม่ปรากฏในการสํารวจแบบมาตรฐานได้ ดูข้อมูลเพิ่มเติมได้ที่ https://support.google.com/analytics/answer/10896953

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

 ดึงข้อมูลเนื้อหาของงานรายงาน