Method: reports.batchGet

傳回 Analytics (分析) 資料。

HTTP 要求

POST https://analyticsreporting.googleapis.com/v4/reports:batchGet

此網址使用 gRPC 轉碼語法。

要求主體

要求主體的資料會採用以下結構:

JSON 表示法
{
  "reportRequests": [
    {
      object(ReportRequest)
    }
  ],
  "useResourceQuotas": boolean
}
欄位
reportRequests[]

object(ReportRequest)

每個要求,都會有各自的回應。最多只能有 5 個要求。所有要求應使用相同的 dateRangesviewIdsegmentssamplingLevelcohortGroup

useResourceQuotas

boolean

啟用以資源為基礎的配額 (預設為 False)。如果將這個欄位設為 True,則每個資料檢視 (設定檔) 的配額取決於要求的運算費用。請注意,採用以費用為準的配額會增加取樣率。(SMALL 為 1,000 萬個,LARGE 為 1 億)。詳情請參閱限制和配額說明文件

回應主體

如果成功,回應主體即會包含具有以下結構的資料:

主要是來自 Reporting API batchGet 呼叫報告的主要回應類別。

JSON 表示法
{
  "reports": [
    {
      object(Report)
    }
  ],
  "queryCost": number,
  "resourceQuotasRemaining": {
    object(ResourceQuotasRemaining)
  }
}
欄位
reports[]

object(Report)

對應於各個要求的回應。

queryCost

number

執行查詢時扣除的資源配額權杖數量。包含所有回應。

resourceQuotasRemaining

object(ResourceQuotasRemaining)

屬性的剩餘資源配額量。

授權範圍

需要下列其中一種 OAuth 範圍:

  • https://www.googleapis.com/auth/analytics.readonly
  • https://www.googleapis.com/auth/analytics

ReportRequest

指定 Reporting API 要求的主要要求類別。

JSON 表示法
{
  "viewId": string,
  "dateRanges": [
    {
      object(DateRange)
    }
  ],
  "samplingLevel": enum(Sampling),
  "dimensions": [
    {
      object(Dimension)
    }
  ],
  "dimensionFilterClauses": [
    {
      object(DimensionFilterClause)
    }
  ],
  "metrics": [
    {
      object(Metric)
    }
  ],
  "metricFilterClauses": [
    {
      object(MetricFilterClause)
    }
  ],
  "filtersExpression": string,
  "orderBys": [
    {
      object(OrderBy)
    }
  ],
  "segments": [
    {
      object(Segment)
    }
  ],
  "pivots": [
    {
      object(Pivot)
    }
  ],
  "cohortGroup": {
    object(CohortGroup)
  },
  "pageToken": string,
  "pageSize": number,
  "includeEmptyRows": boolean,
  "hideTotals": boolean,
  "hideValueRanges": boolean
}
欄位
viewId

string

用來擷取資料的 Analytics (分析) 資料檢視 IDbatchGet 方法中的每個 ReportRequest 都必須包含相同的 viewId

dateRanges[]

object(DateRange)

要求中的日期範圍。要求最多只能有 2 個日期範圍。回應包含請求中每個日期範圍每個維度組合的一組指標值。因此,如果有兩個日期範圍,就會有兩組指標值,分別用於原始日期範圍和第二個日期範圍。不應為同類群組或效期價值要求指定 reportRequest.dateRanges 欄位。如未提供日期範圍,預設日期範圍為 (startDate: current date - 7 days, endDate: current date - 1 days)。batchGet 方法中的每個 ReportRequest 都必須包含相同的 dateRanges 定義。

samplingLevel

enum(Sampling)

所需報表範例大小。如果未指定 samplingLevel 欄位,則會使用 DEFAULT 取樣層級。batchGet 方法中的每個 ReportRequest 都必須包含相同的 samplingLevel 定義。詳情請參閱開發人員指南

dimensions[]

object(Dimension)

要求的維度。要求總數最多可有 9 個維度。

dimensionFilterClauses[]

object(DimensionFilterClause)

用於篩選維度值的維度篩選器子句。邏輯上與 AND 運算子合併。請注意,篩選作業會在所有維度匯總前進行,因此傳回的指標只會代表相關維度的總數。

metrics[]

object(Metric)

要求的指標。要求必須指定至少一個指標。要求總數最多可以有 10 個指標。

metricFilterClauses[]

object(MetricFilterClause)

指標篩選器子句。邏輯上與 AND 運算子合併。指標篩選器只會查看第一個日期範圍,不會比較日期範圍。請注意,指標匯總完成後,系統才會篩選指標。

filtersExpression

string

用於限制要求傳回資料的維度或指標篩選器。如要使用 filtersExpression,請提供要篩選的維度或指標,後面加上篩選器運算式。舉例來說,以下運算式會選取以 Firefox 開頭的 ga:browser 維度;ga:browser=~^Firefox。如要進一步瞭解維度和指標篩選器,請參閱「篩選器參考資料」一文。

orderBys[]

object(OrderBy)

為輸出資料列排序。如要比較兩列,系統會依序套用下列元素,直到發現差異為止。輸出中的所有日期範圍會使用相同的資料列順序。

segments[]

object(Segment)

區隔要求所傳回的資料。區隔定義有助於您查看區隔要求的子集。每項要求最多可包含四個區隔。batchGet 方法中的每個 ReportRequest 都必須包含相同的 segments 定義。包含區隔的要求必須具有 ga:segment 維度。

pivots[]

object(Pivot)

資料透視定義。要求最多只能有 2 個資料透視。

cohortGroup

object(CohortGroup)

與這項要求相關聯的同類群組群組。如果要求中有同類群組群組,就必須使用 ga:cohort 維度。batchGet 方法中的每個 ReportRequest 都必須包含相同的 cohortGroup 定義。

pageToken

string

用於取得下一頁下一頁的接續權杖。將這項資訊新增至要求,將傳回 pageToken 後面的資料列。pageToken 必須是回應 page.batchGet 要求中「nextPageToken」參數所傳回的值。

pageSize

number

頁面大小適用於分頁,並指定傳回的資料列數量上限。頁面大小應為 >= 0。查詢會傳回預設的 1,000 列資料。無論您提出的要求數量為何,Analytics (分析) Core Reporting API 最多可在每個要求中傳回 100,000 列。此外,如果維度區隔數量不如預期,也可以傳回較少的資料列。舉例來說,ga:country 的值少於 300 個,因此如果按國家/地區劃分,即使將 pageSize 設為更高的值,最多只能有 300 列。

includeEmptyRows

boolean

如果設為 False,則所有擷取的指標都等於零時,回應不會包含資料列。預設值為 false,系統會排除這些資料列。

hideTotals

boolean

如果設為 true,系統會針對各個日期範圍隱藏所有相符資料列的所有指標總計。預設值為 false,系統會傳回總數。

hideValueRanges

boolean

如果設為 true,系統會隱藏所有相符資料列的最小值和最大值。預設值為 False,而且系統會傳回值範圍。

取樣

取樣層級的值。

列舉
SAMPLING_UNSPECIFIED 如果未指定 samplingLevel 欄位,則會使用 DEFAULT 取樣層級。
DEFAULT 傳回取樣大小,以平衡速度和準確率。
SMALL 它會傳回取樣範圍較小的快速回應。
LARGE 使用大型取樣大小傳回更準確的回應。但這可能會導致回應速度變慢。

維度

維度是指資料的屬性,舉例來說,「ga:city」維度可指出工作階段的來源城市,例如「巴黎」或「紐約」。

JSON 表示法
{
  "name": string,
  "histogramBuckets": [
    string
  ]
}
欄位
name

string

要擷取的維度名稱,例如 ga:browser

histogramBuckets[]

string (int64 format)

如果不是空值,系統會將字串值置於字串後方的 int64 中。如果維度值不是整數值的字串表示法,則會轉換為零。值區值必須遞增。每個值區在下半部都關閉,上端則是開啟的。「第一個」值區包含小於第一個邊界的所有值,「最後一個」值區則包含無限量的所有值。值區中的維度值會轉換為新的維度值。例如,如果提供「0, 1, 3, 4, 7」的清單,就會傳回下列值區:

  • 值區 #1:值 < 0, 維度值 <0&ltt;
  • 值區 #2:[0,1] 中的值,維度值等於「0」。
  • 值區 #3:[1,3] 中的值,維度值等於「1-2」
  • 值區 #4:[3,4] 中的值,維度值等於「3」。
  • 值區 #5:[4,7] 中的值,維度值等於「4-6」
  • 值區 #6:值 >= 7,維度值 &7t”

注意:如果您要對任何維度套用直方圖異動,並依此維度使用該維度,建議您使用 HISTOGRAM_BUCKET 排序類型。否則,維度值會依字典 (字典) 順序排序。以遞增字典順序如下為例:

《50》、「1001+」、「121-100」和「50-120」

遞增的 HISTOGRAM_BUCKET 順序如下:

"50"、"50-120"、"121-1000"、"1001+"

用戶端必須針對自己的直方圖變化維度明確要求 "orderType": "HISTOGRAM_BUCKET"

維度篩選器子句

一組維度篩選器。設定運算子值以指定邏輯合併方式。

JSON 表示法
{
  "operator": enum(FilterLogicalOperator),
  "filters": [
    {
      object(DimensionFilter)
    }
  ]
}
欄位
operator

enum(FilterLogicalOperator)

結合多個維度篩選器的運算子。如果未指定,系統會將其視為 OR

filters[]

object(DimensionFilter)

一組重複的篩選器。並根據指定的運算子進行邏輯合併。

篩選器邏輯

邏輯合併方式。

列舉
OPERATOR_UNSPECIFIED 未指定的運算子。系統會將其視為 OR
OR 邏輯 OR 運算子。
AND 邏輯 AND 運算子。

維度篩選器

維度篩選器可指定維度的篩選選項,

JSON 表示法
{
  "dimensionName": string,
  "not": boolean,
  "operator": enum(Operator),
  "expressions": [
    string
  ],
  "caseSensitive": boolean
}
欄位
dimensionName

string

要做為篩選依據的維度。尺寸篩選器必須包含維度。

not

boolean

邏輯 NOT 運算子。如果這個布林值設為 true,報表就會排除相符的維度值。預設值為 False。

operator

enum(Operator)

如何比對維度與運算式。預設值為 REGEXP。

expressions[]

string

要比對的字串或規則運算式。除非運算子為 IN_LIST,否則系統只會使用清單的第一個值進行比較。如果設為 IN_LIST 運算子,系統會使用整份清單來篩選維度,如 IN_LIST 運算子的說明所述。

caseSensitive

boolean

比對應為區分大小寫?預設值為 False。

運算子

支援不同的比對類型。

列舉
OPERATOR_UNSPECIFIED 如未指定比對類型,系統會將其視為 REGEXP
REGEXP 系統會將比對運算式視為規則運算式。所有比對類型都不會視為規則運算式。
BEGINS_WITH 比對出與提供的比對運算式開頭的值。
ENDS_WITH 比對結尾與提供運算式相符的值。
PARTIAL 子字串比對。
EXACT 這個值應完全符合比對運算式。
NUMERIC_EQUAL

整數比較篩選器。系統會忽略這些運算式的敏感度,並將運算式視為代表整數的字串。失敗條件:

  • 如果運算式不是 int64,用戶端應會發生錯誤。
  • 無效的 int64 值輸入維度將一律與篩選條件不符。
NUMERIC_GREATER_THAN 檢查維度在數值方面的值是否大於比對運算式。請參閱 NUMERIC_EQUALS 的說明。
NUMERIC_LESS_THAN 檢查維度數值是否小於比對運算式。請參閱 NUMERIC_EQUALS 的說明。
IN_LIST

這個選項可用來指定維度篩選器,其中的運算式可從所選值清單中挑選任何值。這樣一來,就不必評估多個完全比對維度篩選器,但每個回應資料列都有「OR'ed」。例如:

expressions: ["A", "B", "C"]

任何維度列的值為 A、B 或 C,都會與這個 DimensionsFilter 相符。

指標

指標是量化測量資料,舉例來說,「ga:users」指標代表指定時間範圍內的使用者總數。

JSON 表示法
{
  "expression": string,
  "alias": string,
  "formattingType": enum(MetricType)
}
欄位
expression

string

要求中的指標運算式。表式是由一或多個指標和數字所組成。可接受的運算子包括:加號 (+)、減號 (-)、否定 (一元 -)、除以 (/)、乘以 (*)、括號、正數 (0 至 9) 和小數點,而且不得超過 1024 個字元。ga:totalRefunds/ga:users 範例,在多數情況下,指標運算式只是單一指標名稱,例如 ga:users。新增混合 MetricType (例如CURRENCY + PERCENTAGE) 指標會導致非預期的結果。

alias

string

指標運算式的別名是運算式的替代名稱。別名可用於篩選及排序。如果運算式並非單一指標,而且是用於篩選和排序的複雜運算式,則此為選用欄位。此別名也會用於回應欄標頭。

formattingType

enum(MetricType)

指定指標運算式的格式,例如 INTEGER

MetricType

指標類型。

列舉
METRIC_TYPE_UNSPECIFIED 未指定指標類型。
INTEGER 整數指標。
FLOAT 浮動指標。
CURRENCY 貨幣指標。
PERCENT 百分比指標。
TIME 時間指標,採 HH:MM:SS 格式。

MetricFilterClause

代表一組指標篩選器。設定運算子值以指定邏輯合併方式。

JSON 表示法
{
  "operator": enum(FilterLogicalOperator),
  "filters": [
    {
      object(MetricFilter)
    }
  ]
}
欄位
operator

enum(FilterLogicalOperator)

結合多個指標篩選器的運算子。如果未指定,系統會將其視為 OR

filters[]

object(MetricFilter)

一組重複的篩選器。並根據指定的運算子進行邏輯合併。

指標篩選器

MetricFilter 指定指標的篩選器。

JSON 表示法
{
  "metricName": string,
  "not": boolean,
  "operator": enum(Operator),
  "comparisonValue": string
}
欄位
metricName

string

要篩選的指標。metricFilter 必須包含指標名稱。指標名稱可以是先前定義為指標的別名,也可以是指標運算式。

not

boolean

邏輯 NOT 運算子。如果這個布林值設為 true,報表就會排除相符的指標值。預設值為 False。

operator

enum(Operator)

指標為 EQUALLESS_THANGREATER_THAN:compareValue,預設值為 EQUAL。如果運算子是 IS_MISSING,請檢查指標是否遺漏,並忽略比較值。

comparisonValue

string

要比較的值。

運算子

不同的比較類型選項。

列舉
OPERATOR_UNSPECIFIED 如未指定運算子,系統會將其視為 EQUAL
EQUAL 指標的值應與比較值完全相同。
LESS_THAN 這項指標的值必須小於比較值。
GREATER_THAN 指標值是否大於比較值。
IS_MISSING 驗證缺少指標。未將比較值納入考量。

OrderBy

指定排序選項。

JSON 表示法
{
  "fieldName": string,
  "orderType": enum(OrderType),
  "sortOrder": enum(SortOrder)
}
欄位
fieldName

string

要排序的欄位。預設排列順序是遞增。範例:ga:browser。請注意,你只能指定一個欄位來排序。舉例來說,ga:browser, ga:city 無效。

orderType

enum(OrderType)

訂單類型。預設的 orderType 為 VALUE

sortOrder

enum(SortOrder)

欄位的排序順序。

OrderType

OrderType 可決定排序順序的決定方式。

列舉
ORDER_TYPE_UNSPECIFIED 系統會將未指定的訂單類型按照值排序。
VALUE 排序順序是根據所選欄的值計算,且只會查看第一個日期範圍。
DELTA 排序順序是根據所選前兩個值在所選日期範圍內的值之間的差異。僅有兩個日期範圍可用。
SMART 排序順序是根據所選欄的加權值計算。如果欄的格式為「不適用」,則這個比率的加權值將是 (n + totals.n)/(d + totals.d),僅適用於代表比率的指標。
HISTOGRAM_BUCKET 直方圖順序類型僅適用於含有非空白直方圖的維度欄。
DIMENSION_AS_INTEGER 如果尺寸是固定長度,則一般排序即可正常運作。如果維度是變數長度,您可以使用 DIMENSION_AS_INTEGER

SortOrder

排序的排序順序。

列舉
SORT_ORDER_UNSPECIFIED 如果未指定排列順序,則預設為遞增。
ASCENDING 遞增排序。欄位會以遞增方式排序。
DESCENDING 遞減排序。欄位會以遞減方式排序。

區隔

需要區隔報表的區隔定義。「區隔」是 Analytics (分析) 資料子集。以某些使用者組合為例,一個「區隔」可能是特定國家/地區或城市的使用者。

JSON 表示法
{

  // Union field dynamicOrById can be only one of the following:
  "dynamicSegment": {
    object(DynamicSegment)
  },
  "segmentId": string
  // End of list of possible types for union field dynamicOrById.
}
欄位
聯集欄位 dynamicOrById。您可使用 DynamicSegment 的動態定義,或是利用內建或自訂區隔的 ID 來定義區隔。dynamicOrById 只能是下列其中一項:
dynamicSegment

object(DynamicSegment)

要求中的動態區隔定義。

segmentId

string

內建或自訂區隔的區隔 ID,例如 gaid::-3

動態區隔

在要求中定義區隔的動態區隔定義。區隔可以選取使用者或工作階段,也可以同時選取這兩個選項。

JSON 表示法
{
  "name": string,
  "userSegment": {
    object(SegmentDefinition)
  },
  "sessionSegment": {
    object(SegmentDefinition)
  }
}
欄位
name

string

動態區隔的名稱。

userSegment

object(SegmentDefinition)

使用者區隔,選取要納入區隔的使用者。

sessionSegment

object(SegmentDefinition)

用來選取要納入區隔的工作階段區隔。

區隔定義

SegmentDefinition 定義了一組 SegmentFilters 與一組 AND 作業合併使用。

JSON 表示法
{
  "segmentFilters": [
    {
      object(SegmentFilter)
    }
  ]
}
欄位
segmentFilters[]

object(SegmentFilter)

區隔是由一組區隔篩選器所定義,結合了邏輯的 AND 運算。

區隔篩選器

區隔篩選器會將區隔定義為簡單或序列區隔。簡單的區隔條件內含維度和指標,可用於選取工作階段或使用者。序列區隔條件可根據序列條件選取使用者或工作階段。

JSON 表示法
{
  "not": boolean,

  // Union field simpleOrSequence can be only one of the following:
  "simpleSegment": {
    object(SimpleSegment)
  },
  "sequenceSegment": {
    object(SequenceSegment)
  }
  // End of list of possible types for union field simpleOrSequence.
}
欄位
not

boolean

如為 true,則代表簡單或序列區隔的輔助設定。舉例來說,如要比對來自「紐約」的所有造訪,我們可以按照以下方式定義區隔:

  "sessionSegment": {
    "segmentFilters": [{
      "simpleSegment" :{
        "orFiltersForSegment": [{
          "segmentFilterClauses":[{
            "dimensionFilter": {
              "dimensionName": "ga:city",
              "expressions": ["New York"]
            }
          }]
        }]
      },
      "not": "True"
    }]
  },

聯集欄位 simpleOrSequence。是簡單的區隔或序列區隔定義。simpleOrSequence 只能是下列其中一項:
simpleSegment

object(SimpleSegment)

簡易區隔條件是由一或多個維度/指標條件組成,可合併

sequenceSegment

object(SequenceSegment)

序列條件是由一或多個步驟組成,其中每個步驟是由一或多個維度/指標條件定義。多個步驟可以與特殊序列運算子搭配使用。

簡易區隔

簡易區隔條件是由一或多個可組合的維度/指標條件所組成。

JSON 表示法
{
  "orFiltersForSegment": [
    {
      object(OrFiltersForSegment)
    }
  ]
}
欄位
orFiltersForSegment[]

object(OrFiltersForSegment)

區隔篩選器群組,與邏輯 AND 運算子結合。

OrFiltersForSegment

OR 群組中的區隔篩選器清單與邏輯 OR 運算子合併。

JSON 表示法
{
  "segmentFilterClauses": [
    {
      object(SegmentFilterClause)
    }
  ]
}
欄位
segmentFilterClauses[]

object(SegmentFilterClause)

要與 OR 運算子合併的區隔篩選器清單。

區隔篩選器子句

要用於區隔定義的篩選器子句,可以是指標或維度篩選器。

JSON 表示法
{
  "not": boolean,

  // Union field dimensionOrMetricFilter can be only one of the following:
  "dimensionFilter": {
    object(SegmentDimensionFilter)
  },
  "metricFilter": {
    object(SegmentMetricFilter)
  }
  // End of list of possible types for union field dimensionOrMetricFilter.
}
欄位
not

boolean

與篩選器的補充項目 (!) 相符。

聯集欄位 dimensionOrMetricFilter。維度或指標篩選器。dimensionOrMetricFilter 只能是下列其中一項:
dimensionFilter

object(SegmentDimensionFilter)

區隔定義的維度篩選器。

metricFilter

object(SegmentMetricFilter)

區隔定義的指標篩選器。

區隔維度篩選器

維度篩選器可指定維度的篩選選項,

JSON 表示法
{
  "dimensionName": string,
  "operator": enum(Operator),
  "caseSensitive": boolean,
  "expressions": [
    string
  ],
  "minComparisonValue": string,
  "maxComparisonValue": string
}
欄位
dimensionName

string

要套用篩選器的維度名稱。

operator

enum(Operator)

用於比對維度與運算式的運算子。

caseSensitive

boolean

如果比對相符項目須區分大小寫,系統會忽略 IN_LIST 運算子。

expressions[]

string

運算式清單,所有運算子都只使用第一個元素

minComparisonValue

string

BETWEEN 比對類型的比較值下限。

maxComparisonValue

string

BETWEEN 比對類型的比較值上限。

運算子

支援不同的比對類型。

列舉
OPERATOR_UNSPECIFIED 如未指定比對類型,系統會將其視為 REGEXP 類型。
REGEXP 系統會將比對運算式視為規則運算式。所有其他比對類型都不會視為規則運算式。
BEGINS_WITH 比對開頭為所提供比對運算式的值。
ENDS_WITH 比對結尾與提供運算式相符的值。
PARTIAL 子字串比對。
EXACT 這個值應完全符合比對運算式。
IN_LIST

這個選項可用來指定維度篩選器,其中的運算式可從所選值清單中挑選任何值。這樣一來,就不必評估多個完全比對維度篩選器,但每個回應資料列都有「OR'ed」。例如:

expressions: ["A", "B", "C"]

任何維度列的值為 A、B 或 C,都會與這個 DimensionsFilter 相符。

NUMERIC_LESS_THAN

整數比較篩選器。系統會忽略這些運算式的敏感度,並將運算式視為代表整數的字串。失敗條件:

  • 如果運算式不是 int64,用戶端應會發生錯誤。
  • 輸入非 int64 值的輸入維度,永遠不會與篩選條件相符。

檢查維度數值是否小於比對運算式。

NUMERIC_GREATER_THAN 檢查維度在數值方面的值是否大於比對運算式。
NUMERIC_BETWEEN 檢查維度的數值是否與比對運算式的最小值和最大值之間相符 (已排除邊界)。

區隔指標篩選器

要用於區隔篩選器子句的指標篩選器。

JSON 表示法
{
  "scope": enum(Scope),
  "metricName": string,
  "operator": enum(Operator),
  "comparisonValue": string,
  "maxComparisonValue": string
}
欄位
scope

enum(Scope)

指標範圍的定義了該指標的定義層級。指定的指標範圍必須等於或大於資料模型中定義的主要範圍。主要範圍是指區隔選擇的使用者或工作階段。

metricName

string

要篩選的指標。metricFilter 必須包含指標名稱。

operator

enum(Operator)

指定要比較的指標。預設為 EQUAL

comparisonValue

string

要比較的值。如果運算子是 BETWEEN,系統會將此值視為最低比較值。

maxComparisonValue

string

最大比較值僅適用於 BETWEEN 運算子。

範圍

指標範圍的定義了該指標的定義層級:PRODUCTHITSESSIONUSER。如果指標值超出主要範圍,也能回報指標值。例如:ga:pageviewsga:transactions 可以在 SESSIONUSER 層級中報告,只需在這些工作階段中發生的每個命中加 36 小時,或將這些使用者加起來。

列舉
UNSPECIFIED_SCOPE 如果未指定範圍,則預設為區隔範圍 USERSESSION,視區隔嘗試選擇使用者或工作階段而定。
PRODUCT 產品範圍。
HIT 命中範圍。
SESSION 工作階段範圍。
USER 使用者範圍。

運算子

不同的比較類型選項。

列舉
UNSPECIFIED_OPERATOR 系統會將未指定的運算子視為 LESS_THAN 運算子。
LESS_THAN 檢查指標值是否小於比較值。
GREATER_THAN 檢查指標值是否大於比較值。
EQUAL 等號運算子。
BETWEEN 運算子之間最多可以指定最小值和最大值。我們會使用 LTGT 進行比較。

序列區隔

序列條件是由一或多個步驟組成,其中每個步驟是由一或多個維度/指標條件定義。多個步驟可以與特殊序列運算子搭配使用。

JSON 表示法
{
  "segmentSequenceSteps": [
    {
      object(SegmentSequenceStep)
    }
  ],
  "firstStepShouldMatchFirstHit": boolean
}
欄位
segmentSequenceSteps[]

object(SegmentSequenceStep)

序列中的步驟清單。

firstStepShouldMatchFirstHit

boolean

如有設定,第一個步驟條件就必須與訪客的第一個命中相符 (在日期範圍內)。

SegmentSequenceStep

區隔序列定義。

JSON 表示法
{
  "orFiltersForSegment": [
    {
      object(OrFiltersForSegment)
    }
  ],
  "matchType": enum(MatchType)
}
欄位
orFiltersForSegment[]

object(OrFiltersForSegment)

序列時,其清單為「或」分組的篩選器,與 AND 運算子結合。

matchType

enum(MatchType)

指定步驟是緊接在前一個步驟之前,還是有可能在下一個步驟之前。

比對類型

序列的比對類型。

列舉
UNSPECIFIED_MATCH_TYPE 系統會將未指定的比對類型視為優先順序。
PRECEDES 運算子表示前一個步驟早於下一個步驟。
IMMEDIATELY_PRECEDES 運算子表示前一個步驟緊接在下一個步驟之前。

舞動

「資料透視」會說明要求中的資料透視部分。「資料透視」可針對第二維度資料進行資料透視,藉此調整某些報表的表格資訊。

JSON 表示法
{
  "dimensions": [
    {
      object(Dimension)
    }
  ],
  "dimensionFilterClauses": [
    {
      object(DimensionFilterClause)
    }
  ],
  "metrics": [
    {
      object(Metric)
    }
  ],
  "startGroup": number,
  "maxGroupCount": number
}
欄位
dimensions[]

object(Dimension)

顯示為資料透視欄的維度清單。資料透視表最多只能有 4 個維度。請求中的維度總數限制是資料透視維度的一部分。

dimensionFilterClauses[]

object(DimensionFilterClause)

DimensionsFilterClauses 在邏輯上與 AND 運算子合併:只有所有 DimensionsFilterClauses 包含的資料會影響此資料透視區域的值。維度篩選器可用於限制資料透視區域中顯示的資料欄。舉例來說,如果您在資料透視區域內有 ga:browser 這個請求的維度,並指定了鍵篩選器,只將 ga:browser 限制為「IE」或「Firefox」,則只有這兩個瀏覽器會顯示為資料欄。

metrics[]

object(Metric)

資料透視指標。限制指標是要求中允許的指標總數的一部分。

startGroup

number

如果請求了 k 指標,報表就會包含一些以資料為基礎的 k 欄 (以資料欄為單位)。舉例來說,如果您針對維度「ga:browser」旋轉資料透視表,系統就會在「Firefox」、系統會依照第一個資料透視維度的字母順序排序,以及第二個資料透視維度的字母順序排序,依此類推。舉例來說,如果 Firefox、IE 和 Chrome 的第一個值總數分別為 8、2、8,則資料欄的順序會是 Chrome、Firefox、IE。

下文可讓您選擇回應中要包含哪些 k 欄群組。

maxGroupCount

number

指定要傳回的群組數量上限。預設值為 10,最大值為 1,000。

同類群組

定義同類群組。例如:

"cohortGroup": {
  "cohorts": [{
    "name": "cohort 1",
    "type": "FIRST_VISIT_DATE",
    "dateRange": { "startDate": "2015-08-01", "endDate": "2015-08-01" }
  },{
    "name": "cohort 2"
     "type": "FIRST_VISIT_DATE"
     "dateRange": { "startDate": "2015-07-01", "endDate": "2015-07-01" }
  }]
}
JSON 表示法
{
  "cohorts": [
    {
      object(Cohort)
    }
  ],
  "lifetimeValue": boolean
}
欄位
cohorts[]

object(Cohort)

同類群組的定義。

lifetimeValue

boolean

啟用效期價值 (LTV)。效期價值能評估透過不同管道開發的使用者效期價值。請參閱「同類群組分析」和「效期價值

  • 指標值與網頁介面同類群組報表中的值相似。
  • 同類群組定義日期範圍必須與日曆週和月份一致。舉例來說,在 ga:cohortNthWeek 中,同類群組定義中的 startDate 應為星期日,endDate 應為下一個星期六,ga:cohortNthMonthstartDate 應為當月第 1 天,endDate 應為當月的最後一天。

LifecycleValue 為 true 時:

  • 指標值會對應至網頁介面 Lifetime 值報表中的值。
  • 「效期價值」報表會顯示使用者開發 (收益) 和參與度 (應用程式瀏覽、目標達成數、工作階段和工作階段持續時間) 在最初 90 天內招攬使用者的方式。
  • 這項指標的計算方式是將每位使用者增加的累計平均值。
  • 同類群組定義的日期範圍不需要與日曆週和月份的界線一致。
  • viewId 必須是應用程式資料檢視 ID

同類群組

定義同類群組。同類群組是指具有共同特徵的使用者群組。舉例來說,「客戶開發日期」在同一天的使用者會歸為同一個同類群組。

JSON 表示法
{
  "name": string,
  "type": enum(Type),
  "dateRange": {
    object(DateRange)
  }
}
欄位
name

string

同類群組的專屬名稱。如果未定義名稱,則會自動使用同類群組_[1234...]的值。

type

enum(Type)

同類群組的類型。目前唯一支援的類型為 FIRST_VISIT_DATE。如果未指定這個欄位,系統會將同類群組視為 FIRST_VISIT_DATE 類型的同類群組。

dateRange

object(DateRange)

這個區隔會用於 FIRST_VISIT_DATE 同類群組,且同類群組會選取首次造訪日期在 DateRange 中定義的結束日期。同類群組要求的日期範圍應一致。如果要求中包含 ga:cohortNthDay,則應為整日,如果 ga:cohortNthWeek 應對應至週邊界 (從星期日開始至星期六結束),則 ga:cohortNthMonth 的日期範圍應與月份一致 (從第一天開始至當月最後一天結束)。生命週期價值要求則沒有這類限制。您不需要為 reportsRequest.dateRanges 欄位提供日期範圍。

類型

同類群組類型。

列舉
UNSPECIFIED_COHORT_TYPE 如未指定,系統會視為 FIRST_VISIT_DATE
FIRST_VISIT_DATE 根據首次造訪日期選取的同類群組。

檢舉

與要求對應的資料回應。

JSON 表示法
{
  "columnHeader": {
    object(ColumnHeader)
  },
  "data": {
    object(ReportData)
  },
  "nextPageToken": string
}
欄位
columnHeader

object(ColumnHeader)

欄標題。

data

object(ReportData)

回應資料。

nextPageToken

string

用於擷取清單中下一頁結果的頁面權杖。

欄標題

欄標題。

JSON 表示法
{
  "dimensions": [
    string
  ],
  "metricHeader": {
    object(MetricHeader)
  }
}
欄位
dimensions[]

string

回應中的維度名稱。

metricHeader

object(MetricHeader)

回應中指標的指標標頭。

MetricHeader

指標的標頭。

JSON 表示法
{
  "metricHeaderEntries": [
    {
      object(MetricHeaderEntry)
    }
  ],
  "pivotHeaders": [
    {
      object(PivotHeader)
    }
  ]
}
欄位
metricHeaderEntries[]

object(MetricHeaderEntry)

回應中指標的標頭。

pivotHeaders[]

object(PivotHeader)

回應中的資料透視表的標頭。

指標標頭項目

指標的標頭。

JSON 表示法
{
  "name": string,
  "type": enum(MetricType)
}
欄位
name

string

標頭名稱。

type

enum(MetricType)

指標的類型,例如 INTEGER

PivotHeader

要求中定義的各個資料透視區段的標頭。

JSON 表示法
{
  "pivotHeaderEntries": [
    {
      object(PivotHeaderEntry)
    }
  ],
  "totalPivotGroupsCount": number
}
欄位
pivotHeaderEntries[]

object(PivotHeaderEntry)

單一資料透視區段標題。

totalPivotGroupsCount

number

此資料透視表的群組總數。

PivotHeader 項目

各指標欄的標頭,與回應的資料透視部分要求的指標對應。

JSON 表示法
{
  "dimensionNames": [
    string
  ],
  "dimensionValues": [
    string
  ],
  "metric": {
    object(MetricHeaderEntry)
  }
}
欄位
dimensionNames[]

string

資料透視回應中的維度名稱。

dimensionValues[]

string

資料透視表中的維度值。

metric

object(MetricHeaderEntry)

資料透視表中的指標指標標頭。

報表資料

報表的資料部分。

JSON 表示法
{
  "rows": [
    {
      object(ReportRow)
    }
  ],
  "totals": [
    {
      object(DateRangeValues)
    }
  ],
  "rowCount": number,
  "minimums": [
    {
      object(DateRangeValues)
    }
  ],
  "maximums": [
    {
      object(DateRangeValues)
    }
  ],
  "samplesReadCounts": [
    string
  ],
  "samplingSpaceSizes": [
    string
  ],
  "isDataGolden": boolean,
  "dataLastRefreshed": string
}
欄位
rows[]

object(ReportRow)

每種不重複的維度組合都有一個 ReportRow。

totals[]

object(DateRangeValues)

在每個要求的日期範圍中,針對所有與查詢相符的資料列組合,系統會要求每個要求的值總計。值格式的總數會經過計算,方法是將值格式中提及的指標加總,然後再將值格式視為純量運算式。例如:「總量」會3 / (ga:sessions + 2)計算3 / ((sum of all relevant ga:sessions) + 2)。在總數之前計算總和。

rowCount

number

與此查詢相符的資料列總數。

minimums[]

object(DateRangeValues)

所有相符資料列的最小值和最大值。如果要求中的 hideValueRanges 為 false 或 rowCount 為零,則兩者皆為空白。

maximums[]

object(DateRangeValues)

所有相符資料列的最小值和最大值。如果要求中的 hideValueRanges 為 false 或 rowCount 為零,則兩者皆為空白。

samplesReadCounts[]

string (int64 format)

如果結果是取樣,則會傳回已讀取的樣本總數,每個日期範圍一次。如果結果未取樣,系統就不會定義這個欄位。詳情請參閱開發人員指南

samplingSpaceSizes[]

string (int64 format)

如果結果是取樣,則會傳回目前樣本總數,每個日期範圍各一個項目。如果結果未取樣,系統就不會定義這個欄位。詳情請參閱開發人員指南

isDataGolden

boolean

表示此回應是否為黃金。如果稍後要求,則完全相同時不會產生任何新的結果,資料將會呈金色。

dataLastRefreshed

string (Timestamp format)

報表資料上次更新的時間。計算在這段時間之前收到的命中資料都會包含在報表的計算方式中。

RFC3339 世界標準時間「Zulu」格式的時間戳記,精確度達奈秒單位,範例:"2014-10-02T15:01:23.045123456Z"

報告列

報表中的一列。

JSON 表示法
{
  "dimensions": [
    string
  ],
  "metrics": [
    {
      object(DateRangeValues)
    }
  ]
}
欄位
dimensions[]

string

要求尺寸的清單。

metrics[]

object(DateRangeValues)

每個要求日期範圍的指標清單。

日期範圍值

用來傳回單一日期範圍 / 維度組合的指標清單

JSON 表示法
{
  "values": [
    string
  ],
  "pivotValueRegions": [
    {
      object(PivotValueRegion)
    }
  ]
}
欄位
values[]

string

每個值都會對應至要求中的每個指標。

pivotValueRegions[]

object(PivotValueRegion)

每個資料透視區域的值。

資料透視值區域

資料透視表中的指標值。

JSON 表示法
{
  "values": [
    string
  ]
}
欄位
values[]

string

每個資料透視區域中的指標值。

剩餘資源配額

要求完成後,仍會保留資源的資源配額權杖。

JSON 表示法
{
  "dailyQuotaTokensRemaining": number,
  "hourlyQuotaTokensRemaining": number
}
欄位
dailyQuotaTokensRemaining

number

剩餘每日資源配額。

hourlyQuotaTokensRemaining

number

還剩每小時資源配額權杖。

試試看!