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 ช่วงทับซ้อนกัน ข้อมูลเหตุการณ์สำหรับวันที่ทับซ้อนจะรวมอยู่ในแถวคำตอบของทั้ง 2 ช่วงวันที่ ต้องไม่ได้ระบุ dateRanges นี้ในคำขอกลุ่มประชากรตามรุ่น

dimensionFilter

object (FilterExpression)

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

metricFilter

object (FilterExpression)

ไม่บังคับ เงื่อนไขตัวกรองของเมตริก นำไปใช้หลังจากรวมแถวของรายงานแล้ว ซึ่งคล้ายกับวลีที่มีใน 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)

ไม่บังคับ การรวมเมตริก ค่าเมตริกแบบรวมจะแสดงในแถวที่มีการตั้งค่า levelValue เป็น "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

มิติข้อมูล

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

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

string

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

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

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

dimensionExpression

object (DimensionExpression)

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

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)

ใช้เพื่อรวมค่ามิติข้อมูลเป็นมิติข้อมูลเดียว เช่น มิติข้อมูล "country, city": 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 รองรับ ดูเมตริก 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 มีความสัมพันธ์ AND

orGroup

object (FilterExpressionList)

นิพจน์ตัวกรองใน orGroup มีความสัมพันธ์ 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 จำนวน (นับรวมด้วย)

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

object (NumericValue)

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

toValue

object (NumericValue)

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

MetricAggregation

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

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

OrderBy

ลำดับตามจะกำหนดวิธีจัดเรียงแถวในคำตอบ เช่น การจัดลำดับแถวตามจำนวนเหตุการณ์จากมากไปน้อยเป็นการเรียงลำดับ 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_ ไม่ได้ หากไม่ได้ตั้งค่า กลุ่มประชากรตามรุ่นจะตั้งชื่อตามดัชนีที่อิงตาม 0 cohort_0, cohort_1 เป็นต้น

dimension

string

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

dateRange

object (DateRange)

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

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

โดยทั่วไป dateRange นี้ควรสอดคล้องกับรายละเอียดของกลุ่มประชากรตามรุ่น หาก CohortsRange ใช้รายละเอียดแบบรายวัน dateRange นี้อาจเป็นแบบ 1 วัน หาก 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

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