- แหล่งข้อมูล: ReportTask
- ReportDefinition
- มิติข้อมูล
- DimensionExpression
- CaseExpression
- ConcatenateExpression
- เมตริก
- DateRange
- FilterExpression
- FilterExpressionList
- ตัวกรอง
- StringFilter
- MatchType
- InListFilter
- NumericFilter
- การดำเนินการ
- NumericValue
- BetweenFilter
- MetricAggregation
- OrderBy
- MetricOrderBy
- DimensionOrderBy
- OrderType
- CohortSpec
- กลุ่มประชากรตามรุ่น
- CohortsRange
- รายละเอียด
- CohortReportSettings
- ReportMetadata
- สถานะ
- เมธอด
ทรัพยากร: ReportTask
การกำหนดค่างานรายงานที่เฉพาะเจาะจง
การแสดง JSON |
---|
{ "name": string, "reportDefinition": { object ( |
ช่อง | |
---|---|
name |
เอาต์พุตเท่านั้น ตัวระบุ ชื่อทรัพยากรงานของรายงานที่มอบหมายไว้ในระหว่างการสร้าง รูปแบบ: "properties/{property}/reportTasks/{reportTask}" |
reportDefinition |
ไม่บังคับ คำจำกัดความของรายงานเพื่อดึงข้อมูลรายงาน ซึ่งอธิบายโครงสร้างของรายงาน โดยทั่วไปจะมีช่องที่จะรวมไว้ในรายงานและเกณฑ์ที่จะใช้ในการกรองข้อมูล |
reportMetadata |
เอาต์พุตเท่านั้น ข้อมูลเมตาของรายงานสำหรับงานรายงานหนึ่งๆ ซึ่งให้ข้อมูลเกี่ยวกับรายงาน โดยทั่วไปจะประกอบด้วยข้อมูลต่อไปนี้ ชื่อทรัพยากรของรายงาน สถานะของรายงาน การประทับเวลาที่สร้างรายงาน ฯลฯ |
ReportDefinition
คำจำกัดความของการเรียกใช้รายงาน
การแสดง JSON |
---|
{ "dimensions": [ { object ( |
ช่อง | |
---|---|
dimensions[] |
ไม่บังคับ ขนาดที่ขอและแสดง |
metrics[] |
ไม่บังคับ เมตริกที่ขอและแสดง |
dateRanges[] |
ไม่บังคับ ช่วงวันที่ของข้อมูลที่จะอ่าน หากมีการขอช่วงวันที่หลายช่วง แถวการตอบกลับแต่ละแถวจะมีดัชนีช่วงวันที่ที่อิงกับ 0 หากช่วงวันที่ 2 ช่วงทับซ้อนกัน ข้อมูลเหตุการณ์สำหรับวันที่ทับซ้อนจะรวมอยู่ในแถวคำตอบของทั้ง 2 ช่วงวันที่ ต้องไม่ได้ระบุ |
dimensionFilter |
ไม่บังคับ ตัวกรองมิติข้อมูลช่วยให้คุณขอค่ามิติข้อมูลที่เจาะจงในรายงานได้ หากต้องการเรียนรู้เพิ่มเติม โปรดดูพื้นฐานของตัวกรองมิติข้อมูลเพื่อดูตัวอย่าง เมตริกใช้ในตัวกรองนี้ไม่ได้ |
metricFilter |
ไม่บังคับ เงื่อนไขตัวกรองของเมตริก นำไปใช้หลังจากรวมแถวของรายงานแล้ว ซึ่งคล้ายกับวลีที่มีใน SQL ใช้มิติข้อมูลในตัวกรองนี้ไม่ได้ |
offset |
ไม่บังคับ จำนวนแถวของแถวเริ่มต้นจากพื้นที่เก็บข้อมูล Google Analytics แถวแรกจะนับเป็นแถว 0 เมื่อสร้างงานรายงาน พารามิเตอร์ |
limit |
ไม่บังคับ จำนวนแถวที่จะแสดงผลในรายงาน หากไม่ระบุ ระบบจะแสดงผล 10,000 แถว API จะแสดงผลแถวสูงสุด 250,000 แถวต่อคำขอ ไม่ว่าคุณจะขอกี่แถวก็ตาม นอกจากนี้ API อาจแสดงผลแถวน้อยกว่า |
metricAggregations[] |
ไม่บังคับ การรวมเมตริก ค่าเมตริกแบบรวมจะแสดงในแถวที่มีการตั้งค่า levelValue เป็น "RESERVED_(MetricAggregation)" |
orderBys[] |
ไม่บังคับ ระบุวิธีเรียงลำดับแถวในคำตอบ |
currencyCode |
ไม่บังคับ รหัสสกุลเงินในรูปแบบ ISO4217 เช่น "AED", "USD", "JPY" หากช่องดังกล่าวว่างเปล่า รายงานจะใช้สกุลเงินเริ่มต้นของพร็อพเพอร์ตี้ |
cohortSpec |
ไม่บังคับ กลุ่มประชากรตามรุ่นที่เชื่อมโยงกับคำขอนี้ หากมีกลุ่มประชากรตามรุ่นในคำขอ จะต้องมีมิติข้อมูล "กลุ่มประชากรตามรุ่น" ด้วย |
keepEmptyRows |
ไม่บังคับ หากเป็น "เท็จ" หรือ "ไม่ได้ระบุ" ระบบจะไม่แสดงผลแต่ละแถวที่มีเมตริกทั้งหมดเท่ากับ 0 หากเป็นค่าจริง ระบบจะแสดงผลแถวเหล่านี้หากไม่มีการนําออกแยกกันโดยตัวกรอง ไม่ว่าจะตั้งค่า เช่น หากพร็อพเพอร์ตี้ไม่เคยบันทึกเหตุการณ์ |
มิติข้อมูล
มิติข้อมูลคือลักษณะของข้อมูล เช่น เมืองมิติข้อมูลจะระบุเมืองที่เกิดเหตุการณ์ ค่ามิติข้อมูลในคำตอบของรายงานคือสตริง เช่น เมืองอาจเป็น "ปารีส" หรือ "นิวยอร์ก"
การแสดง JSON |
---|
{
"name": string,
"dimensionExpression": {
object ( |
ช่อง | |
---|---|
name |
ชื่อของมิติข้อมูล โปรดดูมิติข้อมูล API สำหรับรายการชื่อมิติข้อมูลที่วิธีการรายงานหลักรองรับ เช่น หากระบุ
|
dimensionExpression |
มิติข้อมูลหนึ่งอาจเป็นผลลัพธ์ของนิพจน์ของมิติข้อมูลหลายมิติ เช่น มิติข้อมูล "country, city": Concatenate(country, ", ", city) |
DimensionExpression
ใช้เพื่อแสดงมิติข้อมูลที่เป็นผลมาจากสูตรของมิติข้อมูลหลายส่วน ตัวอย่างการใช้งาน 1) ตัวพิมพ์เล็ก(ส่วนข้อมูล) 2) เชื่อมต่อ(มิติข้อมูล 1, สัญลักษณ์, มิติข้อมูล2)
การแสดง JSON |
---|
{ // Union field |
ช่อง | |
---|---|
ฟิลด์สหภาพ one_expression ระบุนิพจน์มิติข้อมูล 1 ประเภทสำหรับ DimensionExpression one_expression ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้เท่านั้น |
|
lowerCase |
ใช้เพื่อแปลงค่ามิติข้อมูลเป็นตัวพิมพ์เล็ก |
upperCase |
ใช้เพื่อแปลงค่ามิติข้อมูลเป็นอักษรตัวพิมพ์ใหญ่ |
concatenate |
ใช้เพื่อรวมค่ามิติข้อมูลเป็นมิติข้อมูลเดียว เช่น มิติข้อมูล "country, city": Concatenate(country, ", ", city) |
CaseExpression
ใช้เพื่อแปลงค่ามิติข้อมูลเป็นกรณีเดียว
การแสดง JSON |
---|
{ "dimensionName": string } |
ช่อง | |
---|---|
dimensionName |
ชื่อของมิติข้อมูล ชื่อต้องอ้างอิงกลับไปที่ชื่อในช่องมิติข้อมูลของคำขอ |
ConcatenateExpression
ใช้เพื่อรวมค่ามิติข้อมูลเป็นมิติข้อมูลเดียว
การแสดง JSON |
---|
{ "dimensionNames": [ string ], "delimiter": string } |
ช่อง | |
---|---|
dimensionNames[] |
ชื่อของมิติข้อมูล ชื่อต้องอ้างอิงกลับไปที่ชื่อในช่องมิติข้อมูลของคำขอ |
delimiter |
ตัวคั่นที่วางไว้ระหว่างชื่อมิติข้อมูล ตัวคั่นมักเป็นอักขระตัวเดียว เช่น "|" หรือ "," แต่สามารถเป็นสตริงที่ยาวกว่าได้ หากค่ามิติข้อมูลมีตัวคั่น ค่าทั้ง 2 รายการจะแสดงในการตอบสนองโดยไม่มีความแตกต่าง เช่น หากค่ามิติข้อมูล 1 = "US,FR", ค่ามิติข้อมูล 2 = "JP" และตัวคั่น = "," คำตอบจะมี "US,FR,JP" |
เมตริก
การวัดเชิงปริมาณของรายงาน ตัวอย่างเช่น เมตริก eventCount
คือจำนวนเหตุการณ์ทั้งหมด อนุญาตให้มีเมตริกไม่เกิน 10 รายการ
การแสดง JSON |
---|
{ "name": string, "expression": string, "invisible": boolean } |
ช่อง | |
---|---|
name |
ชื่อเมตริก ดูรายการชื่อเมตริกที่วิธีการรายงานหลักรองรับ เช่น หากระบุ
|
expression |
นิพจน์ทางคณิตศาสตร์สำหรับเมตริกที่ได้มา ตัวอย่างเช่น จำนวนเหตุการณ์ในเมตริกต่อผู้ใช้คือ |
invisible |
ระบุว่าเมตริกจะไม่แสดงในการตอบกลับรายงานหรือไม่ หากมองไม่เห็นเมตริก เมตริกจะไม่สร้างคอลัมน์ในคำตอบ แต่ใช้ได้ใน |
DateRange
ชุดวันที่ต่อเนื่องกัน: startDate
, startDate + 1
, ..., endDate
อนุญาตให้มีช่วงวันที่ได้ไม่เกิน 4 ช่วง
การแสดง JSON |
---|
{ "startDate": string, "endDate": string, "name": string } |
ช่อง | |
---|---|
startDate |
วันที่เริ่มต้นที่ครอบคลุมสำหรับการค้นหาในรูปแบบ |
endDate |
วันที่สิ้นสุดการรวมสำหรับการค้นหาในรูปแบบ |
name |
กำหนดชื่อให้กับช่วงวันที่นี้ มิติข้อมูล |
FilterExpression
เพื่อแสดงตัวกรองมิติข้อมูลหรือเมตริก ช่องในFilterExpression เดียวกันต้องเป็นมิติข้อมูลทั้งหมดหรือเมตริกทั้งหมด
การแสดง JSON |
---|
{ // Union field |
ช่อง | |
---|---|
ฟิลด์สหภาพ expr ระบุนิพจน์ตัวกรอง 1 ประเภทสำหรับ FilterExpression expr ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้เท่านั้น |
|
andGroup |
นิพจน์ตัวกรองใน andGroup มีความสัมพันธ์ AND |
orGroup |
นิพจน์ตัวกรองใน orGroup มีความสัมพันธ์ OR |
notExpression |
filterExpression ไม่ใช่ของ notExpression |
filter |
ตัวกรองพื้นฐาน ในFilterExpression เดียวกัน ชื่อช่องทั้งหมดของตัวกรองจะต้องเป็นมิติข้อมูลทั้งหมดหรือเมตริกทั้งหมด |
FilterExpressionList
รายการนิพจน์ตัวกรอง
การแสดง JSON |
---|
{
"expressions": [
{
object ( |
ช่อง | |
---|---|
expressions[] |
รายการนิพจน์ตัวกรอง |
กรอง
นิพจน์เพื่อกรองค่ามิติข้อมูลหรือเมตริก
การแสดง JSON |
---|
{ "fieldName": string, // Union field |
ช่อง | |
---|---|
fieldName |
ชื่อมิติข้อมูลหรือชื่อเมตริก ต้องเป็นชื่อที่กำหนดไว้ในมิติข้อมูลหรือเมตริก |
ฟิลด์สหภาพ one_filter ระบุตัวกรอง 1 ประเภทสำหรับFilter one_filter ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้เท่านั้น |
|
stringFilter |
ตัวกรองที่เกี่ยวข้องกับสตริง |
inListFilter |
ตัวกรองสำหรับค่าในรายการ |
numericFilter |
ตัวกรองสำหรับค่าตัวเลขหรือวันที่ |
betweenFilter |
ตัวกรองสำหรับระหว่าง 2 ค่า |
StringFilter
ตัวกรองสำหรับสตริง
การแสดง JSON |
---|
{
"matchType": enum ( |
ช่อง | |
---|---|
matchType |
ประเภทการทำงานของคีย์เวิร์ดสำหรับตัวกรองนี้ |
value |
ค่าสตริงที่ใช้สำหรับการจับคู่ |
caseSensitive |
หากเป็น "จริง" ค่าสตริงจะคำนึงถึงตัวพิมพ์เล็กและตัวพิมพ์ใหญ่ |
MatchType
ประเภทการทำงานของตัวกรองสตริง
Enum | |
---|---|
MATCH_TYPE_UNSPECIFIED |
ไม่ระบุ |
EXACT |
ค่าสตริงตรงกันทั้งหมด |
BEGINS_WITH |
เริ่มต้นด้วยค่าสตริง |
ENDS_WITH |
ลงท้ายด้วยค่าสตริง |
CONTAINS |
มีค่าสตริง |
FULL_REGEXP |
จับคู่นิพจน์ทั่วไปกับค่าสตริงโดยสมบูรณ์ |
PARTIAL_REGEXP |
การจับคู่บางส่วนสำหรับนิพจน์ทั่วไปกับค่าสตริง |
InListFilter
ผลลัพธ์ต้องอยู่ในรายการค่าสตริง
การแสดง JSON |
---|
{ "values": [ string ], "caseSensitive": boolean } |
ช่อง | |
---|---|
values[] |
รายการค่าสตริง ต้องระบุ |
caseSensitive |
หากเป็น "จริง" ค่าสตริงจะคำนึงถึงตัวพิมพ์เล็กและตัวพิมพ์ใหญ่ |
NumericFilter
ตัวกรองสำหรับค่าตัวเลขหรือวันที่
การแสดง JSON |
---|
{ "operation": enum ( |
ช่อง | |
---|---|
operation |
ประเภทการดำเนินการสำหรับตัวกรองนี้ |
value |
ค่าตัวเลขหรือค่าวันที่ |
การดำเนินการ
การดำเนินการที่ใช้กับตัวกรองตัวเลข
Enum | |
---|---|
OPERATION_UNSPECIFIED |
ไม่ระบุ |
EQUAL |
เท่ากับ |
LESS_THAN |
น้อยกว่า |
LESS_THAN_OR_EQUAL |
น้อยกว่าหรือเท่ากับ |
GREATER_THAN |
มากกว่า |
GREATER_THAN_OR_EQUAL |
มากกว่าหรือเท่ากับ |
NumericValue
เพื่อแสดงตัวเลข
การแสดง JSON |
---|
{ // Union field |
ช่อง | |
---|---|
ฟิลด์สหภาพ one_value ค่าตัวเลข one_value ค่าใดค่าหนึ่งต้องเป็นค่าใดค่าหนึ่งต่อไปนี้ |
|
int64Value |
ค่าจำนวนเต็ม |
doubleValue |
ค่า Double |
BetweenFilter
เพื่อแสดงให้เห็นว่าผลลัพธ์ต้องอยู่ระหว่าง 2 จำนวน (นับรวมด้วย)
การแสดง JSON |
---|
{ "fromValue": { object ( |
ช่อง | |
---|---|
fromValue |
ขึ้นต้นด้วยหมายเลขนี้ |
toValue |
ลงท้ายด้วยหมายเลขนี้ |
MetricAggregation
แสดงการรวมเมตริก
Enum | |
---|---|
METRIC_AGGREGATION_UNSPECIFIED |
โอเปอเรเตอร์ที่ไม่ระบุ |
TOTAL |
โอเปอเรเตอร์ SUM |
MINIMUM |
โอเปอเรเตอร์ขั้นต่ำ |
MAXIMUM |
โอเปอเรเตอร์สูงสุด |
COUNT |
โอเปอเรเตอร์การนับ |
OrderBy
ลำดับตามจะกำหนดวิธีจัดเรียงแถวในคำตอบ เช่น การจัดลำดับแถวตามจำนวนเหตุการณ์จากมากไปน้อยเป็นการเรียงลำดับ 1 แถว และการเรียงลำดับแถวตามสตริงชื่อเหตุการณ์ถือเป็นการเรียงลำดับที่ต่างกัน
การแสดง JSON |
---|
{ "desc": boolean, // Union field |
ช่อง | |
---|---|
desc |
หากจริง ให้จัดเรียงตามลำดับจากมากไปน้อย |
ฟิลด์สหภาพ one_order_by ระบุคำสั่งซื้อ 1 ประเภทตามสำหรับ OrderBy one_order_by ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้เท่านั้น |
|
metric |
จัดเรียงผลลัพธ์ตามค่าของเมตริก |
dimension |
จัดเรียงผลลัพธ์ตามค่าของมิติข้อมูล |
MetricOrderBy
จัดเรียงตามค่าเมตริก
การแสดง JSON |
---|
{ "metricName": string } |
ช่อง | |
---|---|
metricName |
ชื่อเมตริกในคำขอสั่งซื้อ |
DimensionOrderBy
จัดเรียงตามค่ามิติข้อมูล
การแสดง JSON |
---|
{
"dimensionName": string,
"orderType": enum ( |
ช่อง | |
---|---|
dimensionName |
ชื่อมิติข้อมูลในคำขอเรียงลำดับตาม |
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 ( |
ช่อง | |
---|---|
cohorts[] |
กำหนดเกณฑ์การเลือกเพื่อจัดกลุ่มผู้ใช้เป็นกลุ่มประชากรตามรุ่น รายงานกลุ่มประชากรตามรุ่นส่วนใหญ่จะกำหนดกลุ่มประชากรตามรุ่นเพียงกลุ่มเดียว หากระบุกลุ่มประชากรตามรุ่นหลายกลุ่ม ระบบจะจดจำกลุ่มประชากรตามรุ่นแต่ละกลุ่มได้ในรายงานตามชื่อของกลุ่มประชากรตามรุ่น |
cohortsRange |
รายงานกลุ่มประชากรตามรุ่นจะติดตามกลุ่มประชากรตามรุ่นในช่วงวันที่การรายงานที่ขยายออกไป ช่วงนี้จะระบุระยะเวลาชดเชยสำหรับการติดตามกลุ่มประชากรตามรุ่น |
cohortReportSettings |
การตั้งค่าที่ไม่บังคับสำหรับรายงานกลุ่มประชากรตามรุ่น |
กลุ่มประชากรตามรุ่น
กำหนดเกณฑ์การเลือกกลุ่มประชากรตามรุ่น กลุ่มประชากรตามรุ่นคือกลุ่มผู้ใช้ที่มีลักษณะอย่างหนึ่งเหมือนกัน เช่น ผู้ใช้ที่มี firstSessionDate
เดียวกันอยู่ในกลุ่มประชากรตามรุ่นเดียวกัน
การแสดง JSON |
---|
{
"name": string,
"dimension": string,
"dateRange": {
object ( |
ช่อง | |
---|---|
name |
กำหนดชื่อให้กับกลุ่มประชากรตามรุ่นนี้ มิติข้อมูล |
dimension |
มิติข้อมูลที่กลุ่มประชากรตามรุ่นใช้ จำเป็นและรองรับเฉพาะ |
dateRange |
กลุ่มประชากรตามรุ่นจะเลือกผู้ใช้ที่มีวันสัมผัสครั้งแรกระหว่างวันที่เริ่มต้นและวันที่สิ้นสุดที่กำหนดไว้ใน ในคำขอกลุ่มประชากรตามรุ่น คุณต้องระบุ โดยทั่วไป |
CohortsRange
กําหนดค่าช่วงวันที่การรายงานที่ขยายสําหรับรายงานกลุ่มประชากรตามรุ่น ระบุระยะเวลาออฟเซ็ตเพื่อติดตามกลุ่มประชากรตามรุ่น
การแสดง JSON |
---|
{
"granularity": enum ( |
ช่อง | |
---|---|
granularity |
ต้องระบุ รายละเอียดที่ใช้ในการตีความ |
startOffset |
หาก หาก หาก |
endOffset |
ต้องระบุ หาก หาก หาก |
รายละเอียด
รายละเอียดที่ใช้ในการตีความ startOffset
และ endOffset
สำหรับช่วงวันที่เพิ่มเติมของการรายงานสำหรับรายงานกลุ่มประชากรตามรุ่น
Enum | |
---|---|
GRANULARITY_UNSPECIFIED |
ไม่ควรระบุ |
DAILY |
รายละเอียดรายวัน ใช้กันโดยทั่วไปหาก dateRange ของกลุ่มประชากรตามรุ่นเป็นวันเดียวและคำขอมี cohortNthDay |
WEEKLY |
รายละเอียดรายสัปดาห์ ใช้บ่อยหาก dateRange ของกลุ่มประชากรตามรุ่นมีระยะเวลา 1 สัปดาห์ (เริ่มตั้งแต่วันอาทิตย์และสิ้นสุดในวันเสาร์) และคำขอมี cohortNthWeek |
MONTHLY |
รายละเอียดรายเดือน ใช้บ่อยหาก dateRange ของกลุ่มประชากรตามรุ่นมีระยะเวลา 1 เดือนและคำขอมี cohortNthMonth |
CohortReportSettings
การตั้งค่าที่ไม่บังคับของรายงานกลุ่มประชากรตามรุ่น
การแสดง JSON |
---|
{ "accumulate": boolean } |
ช่อง | |
---|---|
accumulate |
หากเป็นจริง จะรวบรวมผลลัพธ์ตั้งแต่วันที่สัมผัสครั้งแรกจนถึงวันที่สิ้นสุด ไม่รองรับใน |
ReportMetadata
ข้อมูลเมตาของรายงานสำหรับงานรายงานหนึ่งๆ
การแสดง JSON |
---|
{
"creationQuotaTokensCharged": integer,
"state": enum ( |
ช่อง | |
---|---|
creationQuotaTokensCharged |
เอาต์พุตเท่านั้น โทเค็นโควต้าทั้งหมดที่เรียกเก็บระหว่างการสร้างรายงาน เนื่องจากจำนวนโทเค็นนี้อิงตามกิจกรรมจากสถานะ |
state |
เอาต์พุตเท่านั้น สถานะปัจจุบันของงานรายงานนี้ |
beginCreatingTime |
เอาต์พุตเท่านั้น เวลาที่เรียก การประทับเวลาจะอยู่ในรูปแบบ RFC3339 UTC "Zulu" ที่มีความละเอียดระดับนาโนวินาทีและมีตัวเลขที่เป็นเศษส่วนได้สูงสุด 9 หลัก ตัวอย่าง: |
taskRowCount |
เอาต์พุตเท่านั้น จำนวนแถวทั้งหมดในผลการรายงาน ระบบจะป้อนข้อมูลในช่องนี้เมื่อสถานะเปิดใช้งานอยู่ คุณใช้ |
errorMessage |
เอาต์พุตเท่านั้น ระบบจะเติมข้อความแสดงข้อผิดพลาดหากรายงานทำงานไม่สำเร็จในระหว่างการสร้าง |
totalRowCount |
เอาต์พุตเท่านั้น จำนวนแถวทั้งหมดในพื้นที่เก็บข้อมูลของ Google Analytics หากต้องการค้นหาแถวข้อมูลเพิ่มเติมนอกเหนือจากรายงานปัจจุบัน แถวเหล่านั้นสามารถเริ่มงานรายงานใหม่ตาม
ตัวอย่างเช่น สมมติว่า |
รัฐ
สถานะการประมวลผล
Enum | |
---|---|
STATE_UNSPECIFIED |
ระบบจะไม่ใช้สถานะที่ไม่ระบุ |
CREATING |
ระบบกำลังสร้างรายงานนี้และจะพร้อมใช้งานในอนาคต การสร้างจะเกิดขึ้นทันทีหลังจากการเรียก CreateReport |
ACTIVE |
รายงานถูกสร้างเสร็จแล้วและพร้อมสำหรับการค้นหา |
FAILED |
สร้างรายงานไม่สำเร็จ |
วิธีการ |
|
---|---|
|
เริ่มสร้างงานรายงาน |
|
รับข้อมูลเมตาของรายงานเกี่ยวกับงานรายงานที่ต้องการ |
|
แสดงรายการงานรายงานทั้งหมดสําหรับพร็อพเพอร์ตี้ |
|
เรียกเนื้อหาของงานรายงาน |