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)

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

funnel

object (Funnel)

選用設定。此要求的漏斗設定。這項漏斗設定是必要項目。

funnelBreakdown

object (FunnelBreakdown)

選用設定。如有指定,這個細目會在漏斗表格子報表回應中加入維度。這個細目維度可將每個漏斗步驟擴大為細分維度的不重複值。舉例來說,如果按照「deviceCategory」維度細分資料,系統就會為「mobile」、「tablet」、「desktop」和總計建立資料列。

funnelNextAction

object (FunnelNextAction)

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

下一步僅支援 eventName 和大部分網頁 / 畫面維度,例如 pageTitlepagePath

funnelVisualizationType

enum (FunnelVisualizationType)

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

segments[]

object (Segment)

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

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

區隔參數為選用項目。要求最多僅能包含 4 個區隔。

limit

string (int64 format)

選用設定。要傳回的列數。如果未指定,則會傳回 10,000 列。無論您要求的數量為何,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)

FunnelFilterExpression 並非 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 具有 OR 關係,

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

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

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

dimensionFilterorderBysdimensionExpressionpivotsname 會參照維度。

dimensionExpression

object (DimensionExpression)

多個維度可能是多個維度的運算式結果。例如,維度「country, city」: concatenate(country, ", ", city)。

DimensionExpression

用來表示維度,這是多個維度公式的結果。使用範例:1) 以下版本(維度) 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)

用來將維度值合併為單一維度。例如,維度「country, city」: concatenate(country, ", ", city)。

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,則當使用者進入 i 漏斗步驟、但使用者達成第 i+1 個漏斗步驟前,第 i 個漏斗步驟列中的 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 開始) 開頭區隔名稱 (例如「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)

如果使用者符合這些 andConditionGroups 和所有 andSequenceGroups,就表示使用者符合這項條件。如果指定 andSequenceGroupsandConditionGroups 可能空白。

andSequenceGroups[]

object (UserSegmentSequenceGroup)

如果使用者符合這些 andSequenceGroups 和所有 andConditionGroups,就表示使用者符合這項條件。如果指定 andConditionGroupsandSequenceGroups 可能空白。

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)

SegmentFilterExpression 「不」為 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,這個篩選器就會針對所有事件評估為 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-03,以及 2021-11-02 至 2021-11-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」,國家/地區 ID 為「JP」,事件計數為 15,事件計數為:

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

object (DimensionValue)

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

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 資源每小時可使用 40 萬個權杖。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

提出這項要求後的剩餘配額。