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 ที่จะรวมไว้ในรายงานที่สร้างขึ้น เช่น หากมีแถวทั้งหมด 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 เช่น มิติข้อมูล 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

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

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

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

object (DimensionExpression)

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

DimensionExpression

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

การแสดง JSON 
{

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "lowerCase": {
    object (CaseExpression)
  },
  "upperCase": {
    object (CaseExpression)
  },
  "concatenate": {
    object (ConcatenateExpression)
  }
  // End of mutually exclusive fields.
}
ช่อง
ระบุนิพจน์มิติข้อมูลประเภทใดประเภทหนึ่งสำหรับ DimensionExpression ต่อไปนี้คือรายการฟิลด์ที่ใช้ร่วมกันไม่ได้ ระบบจะตั้งค่าฟิลด์อย่างน้อย 1 รายการในการตอบกลับ
lowerCase

object (CaseExpression)

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

object (CaseExpression)

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

object (ConcatenateExpression)

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

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 
{

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "andGroup": {
    object (FilterExpressionList)
  },
  "orGroup": {
    object (FilterExpressionList)
  },
  "notExpression": {
    object (FilterExpression)
  },
  "filter": {
    object (Filter)
  }
  // End of mutually exclusive fields.
}
ช่อง
ระบุนิพจน์ตัวกรองประเภทใดประเภทหนึ่งสำหรับ FilterExpression ต่อไปนี้คือรายการฟิลด์ที่ใช้ร่วมกันไม่ได้ ระบบจะตั้งค่าฟิลด์อย่างน้อย 1 รายการในการตอบกลับ
andGroup

object (FilterExpressionList)

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

object (FilterExpressionList)

FilterExpressions ใน orGroup มีความสัมพันธ์แบบ OR
notExpression

object (FilterExpression)

FilterExpression ไม่ใช่ notExpression
filter

object (Filter)

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

FilterExpressionList

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

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

object (FilterExpression)

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

ตัวกรอง

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

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

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "stringFilter": {
    object (StringFilter)
  },
  "inListFilter": {
    object (InListFilter)
  },
  "numericFilter": {
    object (NumericFilter)
  },
  "betweenFilter": {
    object (BetweenFilter)
  },
  "emptyFilter": {
    object (EmptyFilter)
  }
  // End of mutually exclusive fields.
}
ช่อง
fieldName

string

ชื่อมิติข้อมูลหรือชื่อเมตริก ต้องเป็นชื่อที่กําหนดไว้ในมิติข้อมูลหรือเมตริก
ระบุตัวกรองประเภทใดประเภทหนึ่งสำหรับ Filter ต่อไปนี้คือรายการฟิลด์ที่ใช้ร่วมกันไม่ได้ ระบบจะตั้งค่าฟิลด์อย่างน้อย 1 รายการในการตอบกลับ
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 
{

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "int64Value": string,
  "doubleValue": number
  // End of mutually exclusive fields.
}
ช่อง
ค่าตัวเลขอย่างใดอย่างหนึ่ง รายการต่อไปนี้คือรายการฟิลด์ที่แยกกันอย่างสิ้นเชิง ระบบจะตั้งค่าฟิลด์อย่างน้อย 1 รายการในการตอบกลับ
int64Value

string (int64 format)

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

number

ค่า Double
สิ้นสุดฟิลด์ที่แยกกัน

BetweenFilter

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

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

object (NumericValue)

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

object (NumericValue)

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

EmptyFilter

ประเภทนี้ไม่มีฟิลด์

กรองค่าที่ว่างเปล่า ตรงกับค่ามิติข้อมูลที่เป็นค่า "" หรือ (not set) ใช้ตัวกรองนี้เพื่อจับคู่แถวที่มีค่ามิติข้อมูลที่ขาดหายไปหรือไม่ได้ป้อน หรือรวมเข้ากับ notExpression เพื่อยกเว้นออกจากรายงานโดยไม่ต้องกรองทั้ง "" และ (not set) แยกกัน

MetricAggregation

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

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

OrderBy

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

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

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "metric": {
    object (MetricOrderBy)
  },
  "dimension": {
    object (DimensionOrderBy)
  }
  // End of mutually exclusive fields.
}
ช่อง
desc

boolean

หากเป็นจริง จะจัดเรียงจากมากไปน้อย
ระบุประเภทการจัดเรียง 1 ประเภทสำหรับ OrderBy ต่อไปนี้คือรายการฟิลด์ที่ใช้ร่วมกันไม่ได้ ระบบจะตั้งค่าฟิลด์อย่างน้อย 1 รายการในการตอบกลับ
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 จัดเรียงตัวอักษรและตัวเลขโดยไม่คำนึงถึงตัวพิมพ์เล็กและตัวพิมพ์ใหญ่ตาม 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_ หากไม่ได้ตั้งค่า ระบบจะตั้งชื่อกลุ่มตามดัชนีที่อิงตามศูนย์ 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 นี้ให้ตรงกับเดือนได้ โดยเริ่มตั้งแต่วันที่ 1 และสิ้นสุดในวันสุดท้ายของเดือน

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

SamplingLevel

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

Enum
SAMPLING_LEVEL_UNSPECIFIED ประเภทที่ไม่ได้ระบุ
LOW ใช้ระดับการสุ่มตัวอย่าง 10 ล้านกับพร็อพเพอร์ตี้มาตรฐาน และ 100 ล้านกับพร็อพเพอร์ตี้ Google Analytics 360
MEDIUM ใช้ได้เฉพาะกับพร็อพเพอร์ตี้ Google Analytics 360 ที่มีระดับการสุ่มตัวอย่าง 1 พันล้าน
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

ใช้ RFC 3339 โดยเอาต์พุตที่สร้างขึ้นจะได้รับการแปลงเป็นรูปแบบ Z เสมอ และใช้ตัวเลขเศษส่วน 0, 3, 6 หรือ 9 หลัก นอกจากนี้ ระบบยังยอมรับออฟเซ็ตอื่นๆ นอกเหนือจาก "Z" ด้วย เช่น "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" หรือ "2014-10-02T15:01:23+05:30"
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

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