Method: properties.runFunnelReport

傳回 Google Analytics (分析) 事件資料的自訂漏斗報表。API 傳回的資料會以表格形式顯示要求的維度和指標。

「程序探索」會以視覺化方式呈現使用者完成某件事所採取的步驟,讓您迅速瞭解使用者完成或不完成各個步驟的情況,(比方說潛在客戶選購產品/服務及結帳的過程,以及光顧過一次的新客戶如何成為常客),掌握這項資訊後,您就能改善效率不佳或遭放棄的客戶歷程。詳情請參閱「GA4 漏斗探索」一文。

這種方法在 Alpha 版穩定性階段推出,用意是在進入 Beta 版前,先收集有關語法和功能的意見回饋。若要提出您對這個 API 的寶貴意見,請填寫 Google Analytics (分析) Data API 程序報表意見回饋表

HTTP 要求

POST https://analyticsdata.googleapis.com/v1alpha/{property=properties/*}:runFunnelReport

這個網址使用 gRPC 轉碼語法。

路徑參數

參數
property

string

選用設定。追蹤事件的 Google Analytics (分析) GA4 資源 ID。會在網址路徑 (而非內文) 中指定。詳情請參閱「如何查看資源 ID」一文。在批次要求中,這個屬性應未指定或與批次層級屬性一致。

範例:Properties/1234

要求主體

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

JSON 表示法
{
  "dateRanges": [
    {
      object (DateRange)
    }
  ],
  "funnel": {
    object (Funnel)
  },
  "funnelBreakdown": {
    object (FunnelBreakdown)
  },
  "funnelNextAction": {
    object (FunnelNextAction)
  },
  "funnelVisualizationType": enum (FunnelVisualizationType),
  "segments": [
    {
      object (Segment)
    }
  ],
  "limit": string,
  "dimensionFilter": {
    object (FilterExpression)
  },
  "returnPropertyQuota": boolean
}
欄位
dateRanges[]

object (DateRange)

選用設定。要讀取的資料日期範圍。如果要求多個日期範圍,每個回應列都會包含以零為基準的日期範圍索引。如果兩個日期範圍重疊,兩個日期範圍的回應資料列中都會包含重疊天數的事件資料。

funnel

object (Funnel)

選用設定。這項要求漏斗的設定。必須提供這項漏斗設定。

funnelBreakdown

object (FunnelBreakdown)

選用設定。如有指定,這項細目會在漏斗表格子報表回應中加入維度。這個細分維度會將每個漏斗步驟展開為細分維度的專屬值。舉例來說,按「deviceCategory」維度劃分的資料時,會建立 mobiletabletdesktop 和總計的資料列。

funnelNextAction

object (FunnelNextAction)

選用設定。如已指定,後續動作會在漏斗視覺呈現子報表回應中加入維度。這個下一個動作維度會將每個漏斗步驟展開為下一個動作的專屬值。舉例來說,eventName 維度的下一個動作會為多個事件 (例如 session_startclick) 和總計建立資料列。

下一步僅支援 eventName 以及大多數的網頁 / 畫面尺寸,例如 pageTitlepagePath

funnelVisualizationType

enum (FunnelVisualizationType)

選用設定。漏斗視覺呈現類型控管了漏斗視覺呈現子報表回應中顯示的維度。如未指定,則會使用 STANDARD_FUNNEL

segments[]

object (Segment)

選用設定。區隔設定。區隔是資源資料子集。在設有區隔的漏斗報表中,系統會在每個區隔中評估漏斗。

此要求中指定的每個區段會在回應中產生獨立的資料列;在回應中,每個區段都會由名稱識別。

區隔參數是選用項目,要求最多可包含 4 個區隔。

limit

string (int64 format)

選用設定。要傳回的列數。如未指定,系統會傳回 10,000 個資料列。無論您請求多少個 API,API 最多只能傳回 250,000 列資料。limit 必須為正數。

如果維度值少於 limit,API 傳回的列數也可以少於要求的 limit

dimensionFilter

object (FilterExpression)

選用設定。維度篩選器能讓您只要求報表中特定的維度值。詳情請參閱「建立報表:維度篩選器」一文中的範例。指標無法用於這個篩選器。

returnPropertyQuota

boolean

選用設定。切換是否要傳回這項 Analytics (分析) 資源配額的目前狀態。配額會在 PropertyQuota 中傳回。

回應主體

漏斗報表回應包含兩份子報表。這兩份子報表是不同的維度和指標組合。

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

JSON 表示法
{
  "funnelTable": {
    object (FunnelSubReport)
  },
  "funnelVisualization": {
    object (FunnelSubReport)
  },
  "propertyQuota": {
    object (PropertyQuota)
  },
  "kind": string
}
欄位
funnelTable

object (FunnelSubReport)

漏斗表格是包含漏斗步驟、區隔、細分維度、活躍使用者、完成率、放棄率和放棄率的報表。

只有在要求區隔時,回應中才會顯示區隔維度。只有在收到請求時,回應中才會顯示細分維度。

funnelVisualization

object (FunnelSubReport)

「漏斗視覺呈現」是包含漏斗步驟、區隔、日期、下一個動作維度和活躍使用者的報表。

只有在要求區隔時,回應中才會顯示區隔維度。只有透過 TRENDED_FUNNEL 漏斗類型請求的日期維度,才會出現在此回應中。只有在收到請求的情況下,回應中才會出現下一個動作維度。

propertyQuota

object (PropertyQuota)

這項 Analytics (分析) 資源的配額狀態 (包括這項要求)。

kind

string

指出這則訊息屬於哪種資源。這個 kind 一律是固定字串「analyticsData#runFunnelReport」。適合用來區分 JSON 中的回應類型。

授權範圍

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

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

DateRange

連續天數組合:startDatestartDate + 1、...、endDate。要求最多可指定 4 個日期範圍。

JSON 表示法
{
  "startDate": string,
  "endDate": string,
  "name": string
}
欄位
startDate

string

查詢的開始日期 (含),格式為 YYYY-MM-DD。不得晚於 endDate。系統也接受 NdaysAgoyesterdaytoday 格式,在此情況下,系統會根據資源的報表時區推斷日期。

endDate

string

查詢的結束日期,格式為 YYYY-MM-DD。不得早於 startDate。系統也接受 NdaysAgoyesterdaytoday 格式,在此情況下,系統會根據資源的報表時區推斷日期。

name

string

為這個日期範圍指定名稱。在報表回應中,維度「dateRange」會列為這個名稱。如果有設定,開頭不得為 date_range_RESERVED_。如未設定,日期範圍會以要求中的索引為零來命名:date_range_0date_range_1 等。

漏斗圖

在漏斗報表要求中設定漏斗。使用者通過一系列步驟時就會產生漏斗報表。

「程序探索」會以視覺化方式呈現使用者完成某件事所採取的步驟,讓您迅速瞭解使用者完成或不完成各個步驟的情況,(比方說潛在客戶選購產品/服務及結帳的過程,以及光顧過一次的新客戶如何成為常客),然後根據這些資料來改善曾有消費者放棄或成效不佳的客戶流程。

JSON 表示法
{
  "isOpenFunnel": boolean,
  "steps": [
    {
      object (FunnelStep)
    }
  ]
}
欄位
isOpenFunnel

boolean

在開放式漏斗中,使用者可以在任何步驟進入漏斗,而在封閉式漏斗中,使用者必須在第一個步驟進入漏斗。選用設定。如果未指定,則使用封閉式漏斗。

steps[]

object (FunnelStep)

這個漏斗的序列步驟。

FunnelStep

步驟用來定義您要評估的使用者歷程。步驟包含一或多個條件,使用者必須符合這些條件才會納入漏斗流程的步驟。

JSON 表示法
{
  "name": string,
  "isDirectlyFollowedBy": boolean,
  "filterExpression": {
    object (FunnelFilterExpression)
  },
  "withinDurationFromPriorStep": string
}
欄位
name

string

此步驟的專屬名稱。如果未指定,步驟將以 1 的索引名稱命名 (例如「0. "、"1. 」等。這個名稱會定義 funnelStepName 維度傳回的字串值。舉例來說,在要求的第三個漏斗步驟中指定 name = Purchase,即可在漏斗報表回應中產生 3. Purchase

isDirectlyFollowedBy

boolean

如果為 true,這個步驟必須直接跟進上一步。如果為 false,上一步驟與這個步驟之間可能會出現事件。如未指定,系統會將 isDirectlyFollowedBy 視為 false。

filterExpression

object (FunnelFilterExpression)

使用者必須符合的條件,才會納入漏斗流程的步驟。

withinDurationFromPriorStep

string (Duration format)

如有指定,這個步驟必須在前一個步驟完成作業的時間內完成。withinDurationFromPriorStep 包含以微秒精細度為範圍的端點。舉例來說,時間長度為 5 秒的秒數,則必須在 4.9 或 5.0 秒時完成,但不得設為 5 秒和 1 微秒。

withinDurationFromPriorStep 是選用項目,如果未指定,步驟可以用任何時間長度分隔。

持續時間以秒為單位,最多 9 個小數位數,結尾為「s」,例如:"3.5s"

FunnelFilterExpression

表示漏斗篩選器的組合。

JSON 表示法
{

  // Union field expr can be only one of the following:
  "andGroup": {
    object (FunnelFilterExpressionList)
  },
  "orGroup": {
    object (FunnelFilterExpressionList)
  },
  "notExpression": {
    object (FunnelFilterExpression)
  },
  "funnelFieldFilter": {
    object (FunnelFieldFilter)
  },
  "funnelEventFilter": {
    object (FunnelEventFilter)
  }
  // End of list of possible types for union field expr.
}
欄位
聯集欄位 expr。為 FunnelFilterExpression 指定一種篩選條件。expr 只能採用下列其中一種設定:
andGroup

object (FunnelFilterExpressionList)

andGroup 中的 FunnelFilterExpression 具有 AND 關係。

orGroup

object (FunnelFilterExpressionList)

orGroup 中的 FunnelFilterexpression 具有 OR 關係。

notExpression

object (FunnelFilterExpression)

FunnelFilter 運算式「不」是 notExpression

funnelFieldFilter

object (FunnelFieldFilter)

維度或指標的漏斗篩選器。

funnelEventFilter

object (FunnelEventFilter)

建立篩選器,比對單一事件名稱的事件。如果指定參數篩選運算式,則只有符合單一事件名稱和參數篩選運算式的事件子集相符。

FunnelFilterExpressionList

漏斗篩選器運算式清單。

JSON 表示法
{
  "expressions": [
    {
      object (FunnelFilterExpression)
    }
  ]
}
欄位
expressions[]

object (FunnelFilterExpression)

漏斗篩選器運算式清單。

FunnelFieldFilter

篩選維度或指標值的運算式。

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。指定一種篩選器類型。one_filter 只能是下列其中一項:
stringFilter

object (StringFilter)

字串相關篩選器。

inListFilter

object (InListFilter)

清單值中的篩選器。

numericFilter

object (NumericFilter)

數字或日期值的篩選器。

betweenFilter

object (BetweenFilter)

兩個值之間的篩選器。

StringFilter

字串篩選器

JSON 表示法
{
  "matchType": enum (MatchType),
  "value": string,
  "caseSensitive": boolean
}
欄位
matchType

enum (MatchType)

此篩選器的比對類型。

value

string

用於比對的字串值。

caseSensitive

boolean

如果為 true,字串值會區分大小寫。

MatchType

字串篩選器的比對類型

列舉
MATCH_TYPE_UNSPECIFIED 未指定
EXACT 字串值完全比對。
BEGINS_WITH 開頭為字串值。
ENDS_WITH 此結尾為字串值。
CONTAINS 包含字串值。
FULL_REGEXP 完整比對規則運算式與字串值。
PARTIAL_REGEXP 與含有字串值的規則運算式部分比對。

InListFilter

結果必須在字串值清單中。

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

string

字串值清單。不得空白。

caseSensitive

boolean

如果為 true,字串值會區分大小寫。

NumericFilter

數字或日期值的篩選器。

JSON 表示法
{
  "operation": enum (Operation),
  "value": {
    object (NumericValue)
  }
}
欄位
operation

enum (Operation)

這個篩選器的作業類型,

value

object (NumericValue)

數字值或日期值。

作業

套用至數值篩選器的作業

列舉
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

雙重值

BetweenFilter

表示結果必須介於兩個數字之間 (含首尾)。

JSON 表示法
{
  "fromValue": {
    object (NumericValue)
  },
  "toValue": {
    object (NumericValue)
  }
}
欄位
fromValue

object (NumericValue)

以此數字開頭。

toValue

object (NumericValue)

以此號碼結尾。

FunnelEventFilter

建立篩選器,比對單一事件名稱的事件。如果指定參數篩選運算式,則只有符合單一事件名稱和參數篩選運算式的事件子集相符。

JSON 表示法
{
  "eventName": string,
  "funnelParameterFilterExpression": {
    object (FunnelParameterFilterExpression)
  }
}
欄位
eventName

string

這個篩選器會比對這個單一事件名稱的事件。必須提供事件名稱。

funnelParameterFilterExpression

object (FunnelParameterFilterExpression)

如果指定,這個篩選器會比對同時符合單一事件名稱和參數篩選運算式的事件。

在參數篩選運算式中,只能使用參數篩選器。

FunnelParameterFilterExpression

說明參數的漏斗篩選器組合。

JSON 表示法
{

  // Union field expr can be only one of the following:
  "andGroup": {
    object (FunnelParameterFilterExpressionList)
  },
  "orGroup": {
    object (FunnelParameterFilterExpressionList)
  },
  "notExpression": {
    object (FunnelParameterFilterExpression)
  },
  "funnelParameterFilter": {
    object (FunnelParameterFilter)
  }
  // End of list of possible types for union field expr.
}
欄位
聯集欄位 expr。為 FunnelParameterFilterExpression 指定一種篩選條件。expr 只能採用下列其中一種設定:
andGroup

object (FunnelParameterFilterExpressionList)

andGroup 中的 FunnelParameterFilterExpression 具有 AND 關係。

orGroup

object (FunnelParameterFilterExpressionList)

orGroup 中的 FunnelParameterFilterExpression 具有「或」關係。

notExpression

object (FunnelParameterFilterExpression)

FunnelParameterFilterExpression 「不」為 notExpression

funnelParameterFilter

object (FunnelParameterFilter)

原始漏斗參數篩選器。

FunnelParameterFilterExpressionList

漏斗參數篩選器運算式的清單。

JSON 表示法
{
  "expressions": [
    {
      object (FunnelParameterFilterExpression)
    }
  ]
}
欄位
expressions[]

object (FunnelParameterFilterExpression)

漏斗參數篩選器運算式的清單。

FunnelParameterFilter

用於篩選漏斗中參數值的運算式。

JSON 表示法
{

  // Union field one_parameter can be only one of the following:
  "eventParameterName": string,
  "itemParameterName": string
  // End of list of possible types for union field one_parameter.

  // 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.
}
欄位
聯集欄位 one_parameter。要篩選的欄位。one_parameter 只能是下列其中一項:
eventParameterName

string

系統會依指定的事件參數評估這個篩選器。系統會將事件參數記錄為事件參數。事件參數包含「firebase_screen」和「currency」等欄位。

事件參數只能用於區隔和漏斗,而且只能用於 EventFilter 中的子篩選器。在 EventFilter 的子篩選器中,應使用事件或項目參數。

itemParameterName

string

這個篩選器會根據指定的項目參數進行評估。項目參數會以參數形式記錄在項目陣列中。商品參數包含「item_name」和「item_category」等欄位。

項目參數只能用於區隔和漏斗,且只能用於 EventFilter 中的子篩選器。在 EventFilter 的子篩選器中,應使用事件或項目參數。

項目參數僅適用於電子商務事件。如要進一步瞭解電子商務事件,請參閱「評估電子商務」指南。

聯集欄位 one_filter。指定一種篩選器類型。one_filter 只能是下列其中一項:
stringFilter

object (StringFilter)

字串相關篩選器。

inListFilter

object (InListFilter)

清單值中的篩選器。

numericFilter

object (NumericFilter)

數字或日期值的篩選器。

betweenFilter

object (BetweenFilter)

兩個值之間的篩選器。

FunnelBreakdown

細目會在漏斗表格子報表回應中新增維度。

JSON 表示法
{
  "breakdownDimension": {
    object (Dimension)
  },
  "limit": string
}
欄位
breakdownDimension

object (Dimension)

加入漏斗表格子報表回應的維度欄。細分維度會細分每個漏斗步驟。指定 funnelBreakdown 時,必須提供有效的 breakdownDimension

limit

string (int64 format)

要在回應中傳回的細分維度不重複值數量上限。如未指定上限,則會使用 5limit。上限值必須大於 0 且不得超過 15。

維度

維度是資料的屬性。舉例來說,「城市」維度會指出事件的來源城市。報表回應中的維度值是字串,例如城市可以是「巴黎」或「紐約」。

JSON 表示法
{
  "name": string,
  "dimensionExpression": {
    object (DimensionExpression)
  }
}
欄位
name

string

維度的名稱。請參閱 API 維度,查看核心報表方法 (例如 runReportbatchRunReports) 支援的維度名稱清單。如要查看 runRealtimeReport 方法支援的維度名稱清單,請參閱「即時維度」。如需 runFunnelReport 方法支援的維度名稱清單,請參閱漏斗維度

如果指定 dimensionExpressionname 可以是您希望允許的字元集內的任何字串。舉例來說,如果 dimensionExpression 串連 countrycity,您就可以呼叫該維度 countryAndCity。您選擇的維度名稱必須與規則運算式 ^[a-zA-Z0-9_]$ 相符。

dimensionFilterorderBysdimensionExpressionpivots 中的 name 會參照維度。

dimensionExpression

object (DimensionExpression)

一個維度可以是多個維度的運算式的結果。例如「國家/地區, 城市」維度: concatenate(country, ", ", 城市)。

DimensionExpression

用於表示維度 (多個維度公式的結果)。使用範例:1) UnderCase(dimension) 2) concatenate(dimension1, 符號, 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, ", ", 城市)。

CaseExpression

用於將維度值轉換為單一大小寫。

JSON 表示法
{
  "dimensionName": string
}
欄位
dimensionName

string

維度的名稱。名稱必須參照要求維度欄位中的名稱。

ConcatenateExpression

用於將維度值合併到單一維度。

JSON 表示法
{
  "dimensionNames": [
    string
  ],
  "delimiter": string
}
欄位
dimensionNames[]

string

維度名稱。這些名稱必須參照要求中維度欄位中的名稱。

delimiter

string

維度名稱之間的分隔符號。

分隔符號通常是單一字元 (例如「|」或「,」),但可以是較長的字串。如果維度值包含分隔符號,兩者都會出現在回應中,不會出現區別。舉例來說,如果維度 1 值 =「US,FR」, 維度 2 值 = "JP",以及分隔符號 = ",",則回應會包含「US,FR,JP」。

FunnelNextAction

「下一步」用來指出使用者在達成下一個步驟前採取步驟之後的維度值。舉例來說,如果 nextActionDimensioneventName,那麼在ii 步步驟列中,符合條件的使用者進入第 i 個漏斗步驟,但在使用者完成i+1i+1 個步驟前的事件之後,就會傳回第一個事件。nextActionDimension

JSON 表示法
{
  "nextActionDimension": {
    object (Dimension)
  },
  "limit": string
}
欄位
nextActionDimension

object (Dimension)

維度欄已加到漏斗視覺呈現子報表回應。使用者完成第 i 個漏斗步驟後,下一個動作維度就會傳回這個維度的下一個維度值。

nextActionDimension 目前僅支援 eventName,以及大多數的網頁 / 畫面尺寸 (例如 pageTitlepagePath)。「nextActionDimension」不得為維度運算式。

limit

string (int64 format)

要在回應中傳回的細分維度不重複值數量上限。如未指定上限,則會使用 5limit。限制必須超過 0 且不得超過 5。

FunnelVisualizationType

控制漏斗視覺呈現子報表回應中顯示的維度。

列舉
FUNNEL_VISUALIZATION_TYPE_UNSPECIFIED 未指定的類型。
STANDARD_FUNNEL 標準 (階梯式) 漏斗。回應中的漏斗視覺呈現子報表不會包含日期。
TRENDED_FUNNEL 趨勢 (折線圖) 漏斗。回應中的漏斗視覺呈現子報表將包含日期維度。

區隔

區隔是 Analytics (分析) 中的一小部分資料。以您的整個使用者群為例,某個區隔可能是來自特定國家/地區或城市的使用者,另一個區隔也許是購買特定產品、瀏覽網站某個部分或在應用程式中觸發特定事件的訪客。

詳情請參閱「GA4 區隔建立工具」一文。

JSON 表示法
{
  "name": string,

  // Union field one_segment_scope can be only one of the following:
  "userSegment": {
    object (UserSegment)
  },
  "sessionSegment": {
    object (SessionSegment)
  },
  "eventSegment": {
    object (EventSegment)
  }
  // End of list of possible types for union field one_segment_scope.
}
欄位
name

string

這個區隔的名稱。如果未指定,區隔會命名為「區隔」。這個名稱會定義 segment 維度傳回的字串值。「segment」維度的前置字元會以要求中區隔的索引號碼 (例如「1. 區隔」、「2. 區隔」等)。

聯集欄位 one_segment_scope。您只指定了一個範圍。one_segment_scope 只能是下列其中一項:
userSegment

object (UserSegment)

使用者區隔是指曾與您網站或應用程式互動的使用者。

sessionSegment

object (SessionSegment)

「工作階段區隔」是指在您網站或應用程式上發生的工作階段,

eventSegment

object (EventSegment)

「事件區隔」是指網站或應用程式上所觸發事件的子集。

UserSegment

使用者區隔是指曾與您網站或應用程式互動的使用者,例如曾經消費的使用者,以及將商品放進購物車但未完成購買的使用者。

JSON 表示法
{
  "userInclusionCriteria": {
    object (UserSegmentCriteria)
  },
  "exclusion": {
    object (UserSegmentExclusion)
  }
}
欄位
userInclusionCriteria

object (UserSegmentCriteria)

定義要納入這個區隔的使用者。選用。

exclusion

object (UserSegmentExclusion)

定義要在這個區隔中排除的使用者。選用。

UserSegmentCriteria

如果使用者的事件符合條件,使用者就會與條件相符。

JSON 表示法
{
  "andConditionGroups": [
    {
      object (UserSegmentConditionGroup)
    }
  ],
  "andSequenceGroups": [
    {
      object (UserSegmentSequenceGroup)
    }
  ]
}
欄位
andConditionGroups[]

object (UserSegmentConditionGroup)

如果使用者符合這些 andConditionGroupsandSequenceGroups 的每一個,就符合這項條件。如果指定 andSequenceGroups,則 andConditionGroups 可以空白。

andSequenceGroups[]

object (UserSegmentSequenceGroup)

如果使用者符合這些 andSequenceGroupsandConditionGroups 的每一個,就符合這項條件。如果指定 andConditionGroups,則 andSequenceGroups 可以空白。

UserSegmentConditionGroup

條件可用來指示 Analytics (分析) 應納入或排除區隔中的哪些資料。

JSON 表示法
{
  "conditionScoping": enum (UserCriteriaScoping),
  "segmentFilterExpression": {
    object (SegmentFilterExpression)
  }
}
欄位
conditionScoping

enum (UserCriteriaScoping)

系統會根據與條件群組相符的資料,在區隔中納入或排除資料。此範圍定義了在判定符合或否,條件群組之前評估 segmentFilterExpression 的事件數量。舉例來說,如果 conditionScoping = USER_CRITERIA_WITHIN_SAME_SESSION,系統會依據工作階段中的所有事件評估運算式,然後判斷條件群組是否與這位使用者相符。舉例來說,如果 conditionScoping = USER_CRITERIA_WITHIN_SAME_EVENT,系統會依據單一事件評估運算式,然後判斷條件群組與這位使用者是否相符。

選用設定。如未指定,則會使用 conditionScoping = ACROSS_ALL_SESSIONS

segmentFilterExpression

object (SegmentFilterExpression)

資料是否與這個運算式相符,才會納入區隔或從中排除。運算式可用來表示維度、指標和/或參數的條件。

UserCriteriaScoping

界定範圍可指定在評估使用者是否符合條件時要考慮哪些事件。

列舉
USER_CRITERIA_SCOPING_UNSPECIFIED 未指定條件的範圍。請勿指定。
USER_CRITERIA_WITHIN_SAME_EVENT 如果在單一事件中滿足條件,使用者就符合條件。
USER_CRITERIA_WITHIN_SAME_SESSION 如果在單一工作階段中滿足條件,使用者就符合條件。
USER_CRITERIA_ACROSS_ALL_SESSIONS 只要對使用者的任何事件符合條件,使用者就符合條件。

SegmentFilterExpression

表示區隔篩選器的組合。

JSON 表示法
{

  // Union field expr can be only one of the following:
  "andGroup": {
    object (SegmentFilterExpressionList)
  },
  "orGroup": {
    object (SegmentFilterExpressionList)
  },
  "notExpression": {
    object (SegmentFilterExpression)
  },
  "segmentFilter": {
    object (SegmentFilter)
  },
  "segmentEventFilter": {
    object (SegmentEventFilter)
  }
  // End of list of possible types for union field expr.
}
欄位
聯集欄位 expr。為 SegmentFilterExpression 指定一種篩選條件。expr 只能採用下列其中一種設定:
andGroup

object (SegmentFilterExpressionList)

andGroup 中的 SegmentFilterExpression 具有 AND 關係。

orGroup

object (SegmentFilterExpressionList)

orGroup 中的 SegmentFilterExpression 具有 OR 關係。

notExpression

object (SegmentFilterExpression)

SegmentFilter 運算式「不」是 notExpression

segmentFilter

object (SegmentFilter)

原始區隔篩選器。

segmentEventFilter

object (SegmentEventFilter)

建立篩選器,比對單一事件名稱的事件。如果指定參數篩選運算式,則只有符合單一事件名稱和參數篩選運算式的事件子集相符。

SegmentFilterExpressionList

區隔篩選器運算式清單。

JSON 表示法
{
  "expressions": [
    {
      object (SegmentFilterExpression)
    }
  ]
}
欄位
expressions[]

object (SegmentFilterExpression)

區隔篩選器運算式清單

SegmentFilter

篩選維度或指標值的運算式。

JSON 表示法
{
  "fieldName": string,
  "filterScoping": {
    object (SegmentFilterScoping)
  },

  // 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

維度名稱或指標名稱。

filterScoping

object (SegmentFilterScoping)

指定篩選器範圍。

聯集欄位 one_filter。為 Filter 指定一種篩選條件。one_filter 只能採用下列其中一種設定:
stringFilter

object (StringFilter)

字串相關篩選器。

inListFilter

object (InListFilter)

清單值中的篩選器。

numericFilter

object (NumericFilter)

數字或日期值的篩選器。

betweenFilter

object (BetweenFilter)

兩個值之間的篩選器。

SegmentFilterScoping

界定範圍可指定系統在評估區隔篩選器時,應如何將多個事件的維度和指標列入考量。

JSON 表示法
{
  "atAnyPointInTime": boolean
}
欄位
atAnyPointInTime

boolean

如果 atAnyPointInTime 為 true,這個篩選器會針對要求日期範圍內的任何事件評估為 true。

這個 atAnyPointInTime 參數不會擴大報表中事件的日期範圍。如果 atAnyPointInTime 為 true,在評估這個篩選器時,系統只會考慮報表日期範圍內的事件。

條件範圍為 ACROSS_ALL_SESSIONS 且無法透過序列指定時,才能指定這個 atAnyPointInTime

如果條件範圍是 ACROSS_ALL_SESSIONS,系統會在未指定的情況下使用 atAnyPointInTime = false。

SegmentEventFilter

建立篩選器,比對單一事件名稱的事件。如果指定參數篩選運算式,則只有符合單一事件名稱和參數篩選運算式的事件子集相符。

JSON 表示法
{
  "eventName": string,
  "segmentParameterFilterExpression": {
    object (SegmentParameterFilterExpression)
  }
}
欄位
eventName

string

這個篩選器會比對這個單一事件名稱的事件。必須提供事件名稱。

segmentParameterFilterExpression

object (SegmentParameterFilterExpression)

如果指定,這個篩選器會比對同時符合單一事件名稱和參數篩選運算式的事件。

在參數篩選運算式中,只能使用參數篩選器。

SegmentParameterFilterExpression

用於表示區隔篩選器對參數的組合。

JSON 表示法
{

  // Union field expr can be only one of the following:
  "andGroup": {
    object (SegmentParameterFilterExpressionList)
  },
  "orGroup": {
    object (SegmentParameterFilterExpressionList)
  },
  "notExpression": {
    object (SegmentParameterFilterExpression)
  },
  "segmentParameterFilter": {
    object (SegmentParameterFilter)
  }
  // End of list of possible types for union field expr.
}
欄位
聯集欄位 expr。為 SegmentParameterFilterExpression 指定一種篩選條件。expr 只能採用下列其中一種設定:
andGroup

object (SegmentParameterFilterExpressionList)

andGroup 中的 SegmentParameterFilterExpression 具有 AND 關係。

orGroup

object (SegmentParameterFilterExpressionList)

orGroup 中的 SegmentParameterFilterExpression 具有 OR 關係。

notExpression

object (SegmentParameterFilterExpression)

SegmentParameterFilterExpression 「不」為 notExpression

segmentParameterFilter

object (SegmentParameterFilter)

原始區隔參數篩選器。

SegmentParameterFilterExpressionList

區隔參數篩選器運算式清單。

JSON 表示法
{
  "expressions": [
    {
      object (SegmentParameterFilterExpression)
    }
  ]
}
欄位
expressions[]

object (SegmentParameterFilterExpression)

區隔參數篩選器運算式清單。

SegmentParameterFilter

篩選區隔中參數值的運算式。

JSON 表示法
{
  "filterScoping": {
    object (SegmentParameterFilterScoping)
  },

  // Union field one_parameter can be only one of the following:
  "eventParameterName": string,
  "itemParameterName": string
  // End of list of possible types for union field one_parameter.

  // 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.
}
欄位
filterScoping

object (SegmentParameterFilterScoping)

指定篩選器範圍。

聯集欄位 one_parameter。要篩選的欄位。one_parameter 只能是下列其中一項:
eventParameterName

string

系統會依指定的事件參數評估這個篩選器。系統會將事件參數記錄為事件參數。事件參數包含「firebase_screen」和「currency」等欄位。

事件參數只能用於區隔和漏斗,且只能用於 EventFilter 中的子篩選器。在 EventFilter 的子篩選器中,應使用事件或項目參數。

itemParameterName

string

這個篩選器會根據指定的項目參數進行評估。項目參數會以參數形式記錄在項目陣列中。商品參數包含「item_name」和「item_category」等欄位。

項目參數只能用於區隔和漏斗,且只能用於 EventFilter 中的子篩選器。在 EventFilter 的子篩選器中,應使用事件或項目參數。

項目參數僅適用於電子商務事件。如要進一步瞭解電子商務事件,請參閱「評估電子商務」指南。

聯集欄位 one_filter。指定一種篩選器類型。one_filter 只能是下列其中一項:
stringFilter

object (StringFilter)

字串相關篩選器。

inListFilter

object (InListFilter)

清單值中的篩選器。

numericFilter

object (NumericFilter)

數字或日期值的篩選器。

betweenFilter

object (BetweenFilter)

兩個值之間的篩選器。

SegmentParameterFilterScoping

範圍可以指定評估區隔參數篩選器時應考量多個事件的方式。

JSON 表示法
{
  "inAnyNDayPeriod": string
}
欄位
inAnyNDayPeriod

string (int64 format)

在套用篩選器前,在指定天數內累積參數。條件範圍限定為 ACROSS_ALL_SESSIONSWITHIN_SAME_SESSION 時才支援。只有在參數為 event_count 時才支援。

舉例來說,假設 inAnyNDayPeriod 為 3,而 eventName 是「purchase」,事件參數是「event_count」,而篩選器條件大於 5,則在報表日期範圍內,這個篩選器會累積每連續 3 天的購買事件發生事件計數;如果使用者連續 3 天內的購買事件數超過 5 天,就會通過這個篩選器的條件。例如 2021-11-01 到 2021-11-03、2021-11-02 至 2021-11-04、2021-11-03 至 2021-11-05 等。

日期範圍不會延長,是在日期範圍開始日期附近設定整個 N 天回溯期。舉例來說,如果報表時間範圍為 2021 年 11 月 1 日至 2021 年 11 月 10 日,inAnyNDayPeriod = 3,由於系統會讀取報表日期範圍以外的事件資料,因此只有前兩天會有效縮短。舉例來說,前四個期間為:2021-11-01 至 2021-11-01、2021-11-01 至 2021-11-02、2021-11-01 至 2021-11-04-02 至 2021-11-04-02。

inAnyNDayPeriod 為選用項目。如未指定,segmentParameterFilter 會個別套用至每個事件。

UserSegmentSequenceGroup

定義使用者須按照特定順序執行,才能成為區隔的成員。

JSON 表示法
{
  "sequenceScoping": enum (UserCriteriaScoping),
  "sequenceMaximumDuration": string,
  "userSequenceSteps": [
    {
      object (UserSequenceStep)
    }
  ]
}
欄位
sequenceScoping

enum (UserCriteriaScoping)

指定範圍時,所有序列步驟都必須滿足使用者序列。舉例來說,如果設為 sequenceScoping = USER_CRITERIA_WITHIN_SAME_SESSION,所有序列步驟都必須在一個工作階段中完成,使用者才會比對序列。我們不支援 sequenceScoping = USER_CRITERIA_WITHIN_SAME_EVENT

選用設定。如未指定,則會使用 conditionScoping = ACROSS_ALL_SESSIONS

sequenceMaximumDuration

string (Duration format)

定義整個序列必須發生的時間範圍,例如 30 分鐘。sequenceMaximumDuration 包含以微秒精細度為範圍的端點。舉例來說,持續時間上限為 5 秒的序列可以在 4.9 或 5.0 秒結束,但無法在 5 秒和 1 微秒結束。

sequenceMaximumDuration 是選用項目,如未指定,即可在任何時間範圍內完成序列。

持續時間以秒為單位,最多 9 個小數位數,結尾為「s」,例如:"3.5s"

userSequenceSteps[]

object (UserSequenceStep)

已排序的條件步驟序列。使用者的事件必須完成每個步驟,使用者才能比對 UserSegmentSequenceGroup

UserSequenceStep

這個條件必須在指定步驟順序中發生,才能讓這位使用者比對序列。

JSON 表示法
{
  "isDirectlyFollowedBy": boolean,
  "stepScoping": enum (UserCriteriaScoping),
  "segmentFilterExpression": {
    object (SegmentFilterExpression)
  }
}
欄位
isDirectlyFollowedBy

boolean

如果為 true,則完成這個步驟的事件必須是在最後一個步驟觸發的事件之後的下一個事件。如果為 false,這個步驟會間接跟著上一個步驟,舉例來說,上一個步驟與這個步驟之間可能會發生事件。第一個步驟的 isDirectlyFollowedBy 都必須為 false。

stepScoping

enum (UserCriteriaScoping)

界定範圍時,必須滿足這個序列步驟,使用者才能與序列相符。舉例來說,如果設為 sequenceScoping = WITHIN_SAME_SESSION,這個序列步驟必須在一個工作階段中完成,使用者才會比對序列。只有在 sequenceScoping = ACROSS_ALL_SESSIONS 時才能使用 stepScoping = ACROSS_ALL_SESSIONS

選用設定。如果未指定,stepScoping 會使用與 sequenceScoping 相同的 UserCriteriaScoping

segmentFilterExpression

object (SegmentFilterExpression)

如果使用者的事件與這個運算式相符,則符合這個序列步驟。運算式可用來表示維度、指標和/或參數的條件。

UserSegmentExclusion

指定要在這個區隔中排除的使用者。

JSON 表示法
{
  "userExclusionDuration": enum (UserExclusionDuration),
  "userExclusionCriteria": {
    object (UserSegmentCriteria)
  }
}
欄位
userExclusionDuration

enum (UserExclusionDuration)

指定當使用者與 userExclusionCriteria 相符時,排除條件會持續多久。

選用設定。如未指定,則會使用 USER_EXCLUSION_TEMPORARYuserExclusionDuration

userExclusionCriteria

object (UserSegmentCriteria)

如果使用者符合這項條件,就會從userExclusionDuration的區隔中排除。

UserExclusionDuration

列舉使用者與 userExclusionCriteria 相符時排除的持續時間長度。

列舉
USER_EXCLUSION_DURATION_UNSPECIFIED 未指定排除時間長度。請勿指定。
USER_EXCLUSION_TEMPORARY 在使用者符合 userExclusionCriteria 條件的期間,暫時從區隔中排除使用者。
USER_EXCLUSION_PERMANENT 如果使用者曾符合 userExclusionCriteria 條件,就會將使用者從區隔中永久排除。

SessionSegment

工作階段區隔是指在您網站/應用程式中發生的工作階段,例如來自特定廣告活動的所有工作階段。

JSON 表示法
{
  "sessionInclusionCriteria": {
    object (SessionSegmentCriteria)
  },
  "exclusion": {
    object (SessionSegmentExclusion)
  }
}
欄位
sessionInclusionCriteria

object (SessionSegmentCriteria)

定義要納入這個區隔的工作階段。選用。

exclusion

object (SessionSegmentExclusion)

定義要在這個區隔中排除的工作階段。選用。

SessionSegmentCriteria

如果工作階段的事件符合條件,工作階段就會與條件相符。

JSON 表示法
{
  "andConditionGroups": [
    {
      object (SessionSegmentConditionGroup)
    }
  ]
}
欄位
andConditionGroups[]

object (SessionSegmentConditionGroup)

如果工作階段符合這些 andConditionGroups 的每一個,就符合這項條件。

SessionSegmentConditionGroup

條件可用來指示 Analytics (分析) 應納入或排除區隔中的哪些資料。

JSON 表示法
{
  "conditionScoping": enum (SessionCriteriaScoping),
  "segmentFilterExpression": {
    object (SegmentFilterExpression)
  }
}
欄位
conditionScoping

enum (SessionCriteriaScoping)

系統會根據與條件群組相符的資料,在區隔中納入或排除資料。此範圍定義了在判定符合或否,條件群組之前評估 segmentFilterExpression 的事件數量。舉例來說,如果 conditionScoping = SESSION_CRITERIA_WITHIN_SAME_SESSION,系統會對工作階段中的所有事件評估運算式,然後判斷條件群組是否與這個工作階段相符。舉例來說,如果 conditionScoping = SESSION_CRITERIA_WITHIN_SAME_EVENT,系統會依據單一事件評估運算式,然後判定條件群組與這個工作階段相符。

選用設定。如未指定,則會使用 WITHIN_SAME_SESSIONconditionScoping

segmentFilterExpression

object (SegmentFilterExpression)

資料是否與這個運算式相符,才會納入區隔或從中排除。運算式可用來表示維度、指標和/或參數的條件。

SessionCriteriaScoping

範圍可以指定在評估工作階段是否符合條件時要考慮哪些事件。

列舉
SESSION_CRITERIA_SCOPING_UNSPECIFIED 未指定條件的範圍。請勿指定。
SESSION_CRITERIA_WITHIN_SAME_EVENT 如果在單一事件內滿足條件,工作階段就符合條件。
SESSION_CRITERIA_WITHIN_SAME_SESSION 如果在單一工作階段內滿足條件,工作階段就符合條件。

SessionSegmentExclusion

指定要在這個區隔中排除的工作階段。

JSON 表示法
{
  "sessionExclusionDuration": enum (SessionExclusionDuration),
  "sessionExclusionCriteria": {
    object (SessionSegmentCriteria)
  }
}
欄位
sessionExclusionDuration

enum (SessionExclusionDuration)

指定當工作階段與 sessionExclusionCriteria 相符時,排除條件會持續多久。

選用設定。如未指定,則會使用 SESSION_EXCLUSION_TEMPORARYsessionExclusionDuration

sessionExclusionCriteria

object (SessionSegmentCriteria)

如果工作階段符合這項條件,該工作階段就會從「sessionExclusionDuration」的區隔中排除。

SessionExclusionDuration

列舉當工作階段與 sessionExclusionCriteria 相符時,排除的持續時間長度。

列舉
SESSION_EXCLUSION_DURATION_UNSPECIFIED 未指定排除時間長度。請勿指定。
SESSION_EXCLUSION_TEMPORARY 在工作階段符合 sessionExclusionCriteria 條件期間,暫時從區隔中排除工作階段。
SESSION_EXCLUSION_PERMANENT 如果工作階段符合 sessionExclusionCriteria 條件,請從區隔中永久排除工作階段。

EventSegment

「事件區隔」是指在您網站或應用程式中觸發的所有事件,例如特定地區發生的所有購買事件,以及特定作業系統上發生的 app_exception 事件。

JSON 表示法
{
  "eventInclusionCriteria": {
    object (EventSegmentCriteria)
  },
  "exclusion": {
    object (EventSegmentExclusion)
  }
}
欄位
eventInclusionCriteria

object (EventSegmentCriteria)

定義要納入這個區隔的事件。選用。

exclusion

object (EventSegmentExclusion)

定義要在這個區隔中排除哪些事件。選用。

EventSegmentCriteria

如果事件符合條件,即與條件相符。

JSON 表示法
{
  "andConditionGroups": [
    {
      object (EventSegmentConditionGroup)
    }
  ]
}
欄位
andConditionGroups[]

object (EventSegmentConditionGroup)

如果事件符合這些 andConditionGroups 各個條件,就符合這項條件。

EventSegmentConditionGroup

條件可用來指示 Analytics (分析) 應納入或排除區隔中的哪些資料。

JSON 表示法
{
  "conditionScoping": enum (EventCriteriaScoping),
  "segmentFilterExpression": {
    object (SegmentFilterExpression)
  }
}
欄位
conditionScoping

enum (EventCriteriaScoping)

conditionScoping 一律應為 EVENT_CRITERIA_WITHIN_SAME_EVENT

選用設定。如未指定,則會使用 EVENT_CRITERIA_WITHIN_SAME_EVENTconditionScoping

segmentFilterExpression

object (SegmentFilterExpression)

資料是否與這個運算式相符,才會納入區隔或從中排除。運算式可用來表示維度、指標和/或參數的條件。

EventCriteriaScoping

界定範圍會指定在評估事件是否符合條件時要考慮哪些事件。

列舉
EVENT_CRITERIA_SCOPING_UNSPECIFIED 未指定條件的範圍。請勿指定。
EVENT_CRITERIA_WITHIN_SAME_EVENT 如果在單一事件中滿足條件,該事件就會符合條件。

EventSegmentExclusion

指定要在這個區隔中排除哪些事件。

JSON 表示法
{
  "eventExclusionDuration": enum (EventExclusionDuration),
  "eventExclusionCriteria": {
    object (EventSegmentCriteria)
  }
}
欄位
eventExclusionDuration

enum (EventExclusionDuration)

eventExclusionDuration 一律應為 PERMANENTLY_EXCLUDE

選用設定。如未指定,則會使用 EVENT_EXCLUSION_PERMANENTeventExclusionDuration

eventExclusionCriteria

object (EventSegmentCriteria)

如果事件符合這項條件,該事件就會從「eventExclusionDuration」區隔的成員資格中排除。

EventExclusionDuration

列舉當事件與 eventExclusionCriteria 相符時,排除的持續時間選項。

列舉
EVENT_EXCLUSION_DURATION_UNSPECIFIED 未指定排除時間長度。請勿指定。
EVENT_EXCLUSION_PERMANENT 如果事件符合 eventExclusionCriteria 條件,請從區隔中永久排除事件。

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。為 FilterExpression 指定一種篩選運算式類型。expr 只能採用下列其中一種設定:
andGroup

object (FilterExpressionList)

和 Group 中的 FilterExpressions 具有 AND 關係。

orGroup

object (FilterExpressionList)

orGroup 中的 FilterExpressions 具有 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。為 Filter 指定一種篩選條件。one_filter 只能採用下列其中一種設定:
stringFilter

object (StringFilter)

字串相關篩選器。

inListFilter

object (InListFilter)

清單值中的篩選器。

numericFilter

object (NumericFilter)

數字或日期值的篩選器。

betweenFilter

object (BetweenFilter)

兩個值之間的篩選器。

FunnelSubReport

漏斗子報表包含維度和指標資料值。舉例來說,有 12 位使用者完成了漏斗的第二個步驟。

JSON 表示法
{
  "dimensionHeaders": [
    {
      object (DimensionHeader)
    }
  ],
  "metricHeaders": [
    {
      object (MetricHeader)
    }
  ],
  "rows": [
    {
      object (Row)
    }
  ],
  "metadata": {
    object (FunnelResponseMetadata)
  }
}
欄位
dimensionHeaders[]

object (DimensionHeader)

說明維度欄。漏斗報表一律會在子報表回應中加入漏斗步驟維度。如未收到要求,回應中可能會包含其他維度,例如細目、日期和後續動作。

metricHeaders[]

object (MetricHeader)

說明指標欄。漏斗報表一律會在子報表回應中納入活躍使用者。漏斗表格包含其他指標,例如完成率、放棄率和放棄率。

rows[]

object (Row)

報表中的維度值組合和指標值列。

metadata

object (FunnelResponseMetadata)

漏斗報表的中繼資料。

DimensionHeader

說明報表中的維度欄。報表中請求的維度會在列和 DimensionsHeaders 中產生欄項目。不過,只用於篩選器或運算式的維度不會在報表中產生資料欄,也一樣不會產生標題。

JSON 表示法
{
  "name": string
}
欄位
name

string

維度的名稱。

MetricHeader

說明報表中的指標欄。報表中請求的可見指標會在列和 MetricHeaders 中產生欄項目。不過,只用於篩選器或運算式的指標不會在報表中產生資料欄,相應的指標不會產生標題。

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

string

指標的名稱。

type

enum (MetricType)

指標的資料類型。

MetricType

指標的值類型。

列舉
METRIC_TYPE_UNSPECIFIED 未指定的類型。
TYPE_INTEGER 整數類型。
TYPE_FLOAT 浮點類型。
TYPE_SECONDS 時間長度;特殊浮點類型。
TYPE_MILLISECONDS 持續時間 (以毫秒為單位);特殊浮點類型。
TYPE_MINUTES 持續時間 (分鐘),特殊浮點類型。
TYPE_HOURS 持續時間,以小時為單位;特殊浮點類型。
TYPE_STANDARD 標準類型的自訂指標;特殊浮點類型。
TYPE_CURRENCY 金額;特殊浮點類型。
TYPE_FEET 長度 (英尺);特殊浮點類型。
TYPE_MILES 長度 (以英里為單位),特殊浮點類型。
TYPE_METERS 長度 (公尺),特殊浮點類型。
TYPE_KILOMETERS 長度 (以公里為單位),特殊浮點類型。

資料列

各列的報表資料。舉例來說,如果 RunReportRequest 包含:

"dimensions": [
  {
    "name": "eventName"
  },
  {
    "name": "countryId"
  }
],
"metrics": [
  {
    "name": "eventCount"
  }
]

其中一列的 eventName 為「in_app_purchase」,「JP」為國家/地區編號,以及 15 為 eventCount,則如下所示:

"dimensionValues": [
  {
    "value": "in_app_purchase"
  },
  {
    "value": "JP"
  }
],
"metricValues": [
  {
    "value": "15"
  }
]
JSON 表示法
{
  "dimensionValues": [
    {
      object (DimensionValue)
    }
  ],
  "metricValues": [
    {
      object (MetricValue)
    }
  ]
}
欄位
dimensionValues[]

object (DimensionValue)

要求的維度值清單。在 PivotReport 中,只有包含資料透視的維度才會列出 dimensionValue。

metricValues[]

object (MetricValue)

要求的可見指標值清單。

DimensionValue

維度的值。

JSON 表示法
{

  // Union field one_value can be only one of the following:
  "value": string
  // End of list of possible types for union field one_value.
}
欄位
聯集欄位 one_value。其中一種維度值 one_value 只能採用下列其中一種格式:
value

string

如果維度類型是字串,這個值會視為字串。

MetricValue

指標的值。

JSON 表示法
{

  // Union field one_value can be only one of the following:
  "value": string
  // End of list of possible types for union field one_value.
}
欄位
聯集欄位 one_value。其中一個指標值「one_value」只能是下列其中一種:
value

string

評估價值。請參閱 MetricHeader 瞭解類型。

FunnelResponseMetadata

漏斗報表的回應中繼資料包含漏斗報表的其他相關資訊。

JSON 表示法
{
  "samplingMetadatas": [
    {
      object (SamplingMetadata)
    }
  ]
}
欄位
samplingMetadatas[]

object (SamplingMetadata)

如果漏斗報表結果為取樣,表示這份漏斗報表中使用了多少百分比的事件。每個日期範圍都會填入一個 samplingMetadatas。每個 samplingMetadatas 都會對應至要求中指定日期範圍的順序。

不過,如果系統沒有取樣結果,就不會定義這個欄位。

SamplingMetadata

如果漏斗報表結果經過取樣,這項中繼資料說明這份中繼資料,說明這份漏斗報表中在某個日期範圍內使用了多少百分比的事件。取樣是指分析所有資料的部分,從龐大的資料集中找出有意義的資訊。

JSON 表示法
{
  "samplesReadCount": string,
  "samplingSpaceSize": string
}
欄位
samplesReadCount

string (int64 format)

這份取樣報表中在特定日期範圍內讀取的事件總數。這是此漏斗報表中分析的資源子集大小。

samplingSpaceSize

string (int64 format)

這項資源的資料在特定日期範圍內,可供分析的事件總數。取樣可讓你瞭解較大資料集的有意義資訊,也就是較大資料集的大小。

如要計算這份漏斗報表使用的可用資料百分比,請計算 samplesReadCount/samplingSpaceSize

PropertyQuota

這項 Analytics (分析) 資源所有配額的目前狀態。如果資源有任何配額用盡,所有對該資源發出的要求都會傳回「資源用盡」錯誤。

JSON 表示法
{
  "tokensPerDay": {
    object (QuotaStatus)
  },
  "tokensPerHour": {
    object (QuotaStatus)
  },
  "concurrentRequests": {
    object (QuotaStatus)
  },
  "serverErrorsPerProjectPerHour": {
    object (QuotaStatus)
  },
  "potentiallyThresholdedRequestsPerHour": {
    object (QuotaStatus)
  },
  "tokensPerProjectPerHour": {
    object (QuotaStatus)
  }
}
欄位
tokensPerDay

object (QuotaStatus)

標準 Analytics (分析) 資源每天最多可以使用 200,000 個權杖;Analytics (分析) 360 資源每天可使用 2,000,000 個權杖。大多數要求使用的符記數量不到 10 個。

tokensPerHour

object (QuotaStatus)

標準 Analytics (分析) 資源每小時最多可使用 40,000 個權杖;Analytics (分析) 360 資源每小時可使用 400,000 個權杖。API 要求會使用一個權杖,該數字會從每小時、每日和每項專案的所有每小時配額中扣除。

concurrentRequests

object (QuotaStatus)

標準 Analytics (分析) 資源最多可以傳送 10 個並行要求,Analytics (分析) 360 資源最多可以使用 50 項並行要求。

serverErrorsPerProjectPerHour

object (QuotaStatus)

標準 Analytics (分析) 資源和雲端專案組合每小時最多可有 10 個伺服器錯誤;Analytics (分析) 360 資源和雲端專案組合每小時最多可有 50 個伺服器錯誤。

potentiallyThresholdedRequestsPerHour

object (QuotaStatus)

Analytics (分析) 資源每小時可傳送最多 120 個要求,且維度可能未達門檻。在批次要求中,如果某個要求內含可能設有限制的維度,則每個報表要求都會分別計入這項配額。

tokensPerProjectPerHour

object (QuotaStatus)

Analytics (分析) 資源每小時最多可使用 35% 的符記。在標準 Analytics (分析) 資源的用量中,每個專案每小時最多只能使用 14,000 個權杖,而 Analytics (分析) 360 資源每小時可以使用每項專案 140,000 個權杖。API 要求會使用一個權杖,該數字會從每小時、每日和每項專案的所有每小時配額中扣除。

QuotaStatus

特定配額群組的目前狀態。

JSON 表示法
{
  "consumed": integer,
  "remaining": integer
}
欄位
consumed

integer

此要求耗用的配額。

remaining

integer

此要求後的剩餘配額。