- HTTP 要求
- 路徑參數
- 要求主體
- 回應主體
- 授權範圍
- 漏斗
- FunnelStep
- FunnelFilterExpression
- FunnelFilterExpressionList
- FunnelFieldFilter
- FunnelEventFilter
- FunnelParameterFilterExpression
- FunnelParameterFilterExpressionList
- FunnelParameterFilter
- FunnelBreakdown
- FunnelNextAction
- FunnelVisualizationType
- 區隔
- UserSegment
- UserSegmentCriteria
- UserSegmentConditionGroup
- UserCriteriaScoping
- SegmentFilterExpression
- SegmentFilterExpressionList
- SegmentFilter
- SegmentFilterScoping
- SegmentEventFilter
- SegmentParameterFilterExpression
- SegmentParameterFilterExpressionList
- SegmentParameterFilter
- SegmentParameterFilterScoping
- UserSegmentSequenceGroup
- UserSequenceStep
- UserSegmentExclusion
- UserExclusionDuration
- SessionSegment
- SessionSegmentCriteria
- SessionSegmentConditionGroup
- SessionCriteriaScoping
- SessionSegmentExclusion
- SessionExclusionDuration
- EventSegment
- EventSegmentCriteria
- EventSegmentConditionGroup
- EventCriteriaScoping
- EventSegmentExclusion
- EventExclusionDuration
- FunnelSubReport
- FunnelResponseMetadata
- SamplingMetadata
- PropertyQuota
- QuotaStatus
- 試試看!
傳回 Google Analytics (分析) 事件資料的自訂漏斗報表。API 傳回的資料會以表格形式呈現,所請求維度和指標的欄。
「程序探索」會以視覺化方式呈現使用者完成某件事所採取的步驟,讓您迅速瞭解使用者完成或不完成各個步驟的情況,(比方說潛在客戶選購產品/服務及結帳的過程,以及光顧過一次的新客戶如何成為常客),掌握這項資訊後,您就可以改善效率不佳或遭放棄的客戶流程。詳情請參閱「GA4 漏斗探索」一文。
這種方法在 Alpha 版穩定性階段推出,用意是在進入 Beta 版前,先收集有關語法和功能的意見回饋。如要針對這個 API 提出意見,請填寫 Google Analytics Data API 漏斗報表意見回饋。
HTTP 要求
POST https://analyticsdata.googleapis.com/v1alpha/{property=properties/*}:runFunnelReport
這個網址使用 gRPC 轉碼語法。
路徑參數
參數 | |
---|---|
property |
選用設定。Google Analytics (分析) GA4 資源 ID,其中包含追蹤事件的相關資料。已在網址路徑指定,而非主體。詳情請參閱「查看資源 ID 的方式」一文。在批次要求中,此屬性應未指定,或是與批次層級屬性一致。 範例:properties/1234 |
要求主體
要求主體的資料會採用以下結構:
JSON 表示法 |
---|
{ "dateRanges": [ { object ( |
欄位 | |
---|---|
dateRanges[] |
選用設定。要讀取的資料日期範圍。如果要求多個日期範圍,則每個回應列都會包含以 0 為基礎的日期範圍索引。如果兩個日期範圍重疊,這兩個日期範圍的事件資料會納入這兩個日期範圍的回應列中。 |
funnel |
選用設定。此要求的漏斗設定。這項漏斗設定是必要項目。 |
funnelBreakdown |
選用設定。如有指定,這個細目會在漏斗表格子報表回應中加入維度。這個細目維度可將每個漏斗步驟擴大為細分維度的不重複值。舉例來說,如果按照「 |
funnelNextAction |
選用設定。如有指定,下一個動作會在漏斗視覺呈現子報表回應中加入維度。這個後續動作維度會將每個漏斗步驟擴大為下一個動作的專屬價值。舉例來說,「 下一步僅支援 |
funnelVisualizationType |
選用設定。「漏斗視覺呈現」類型可控制漏斗視覺化子報表回應中顯示的維度。如未指定,則會使用 |
segments[] |
選用設定。區隔的設定。區隔是資源資料的子集。在包含區隔的漏斗報表中,系統會在每個區隔中評估漏斗。 此要求中指定的每個區段會在回應中分別產生一個資料列;在回應中,每個路段都會以名稱識別。 區隔參數為選用項目。要求最多僅能包含 4 個區隔。 |
limit |
選用設定。要傳回的列數。如果未指定,則會傳回 10,000 列。無論您要求的數量為何,API 每個要求最多只能傳回 250,000 個資料列。 如果維度值數量不是 |
dimensionFilter |
選用設定。維度篩選器可讓您只要求報表中的特定維度值。詳情請參閱「建立報表:維度篩選器」一文中的範例。這個篩選器無法使用指標。 |
returnPropertyQuota |
選用設定。切換是否要傳回這項 Analytics (分析) 資源的配額目前的狀態。系統會在 PropertyQuota 中傳回配額。 |
回應主體
漏斗報表回應包含兩份子報表。這兩個子報表是不同的維度和指標組合。
如果成功,回應主體即會包含具有以下結構的資料:
JSON 表示法 |
---|
{ "funnelTable": { object ( |
欄位 | |
---|---|
funnelTable |
漏斗表格是一份報表,內含漏斗步驟、區隔、細分維度、活躍使用者、完成率、放棄率和放棄率。 只有在您要求區隔的情況下,區隔維度才會出現在回應中。只有收到請求時,回覆中才會顯示細分維度。 |
funnelVisualization |
漏斗視覺呈現是一份報表,內含漏斗步驟、區隔、日期、後續動作維度和活躍使用者。 只有在您要求區隔的情況下,區隔維度才會出現在回應中。只有透過 |
propertyQuota |
這項 Analytics (分析) 資源的配額狀態 (包括這項要求)。 |
kind |
識別此訊息的資源種類。這個 |
授權範圍
需要下列其中一種 OAuth 範圍:
https://www.googleapis.com/auth/analytics.readonly
https://www.googleapis.com/auth/analytics
漏斗
在漏斗報表要求中設定漏斗。程序會在使用者完成一系列步驟時記錄他們。
「程序探索」會以視覺化方式呈現使用者完成某件事所採取的步驟,讓您迅速瞭解使用者完成或不完成各個步驟的情況,(比方說潛在客戶選購產品/服務及結帳的過程,以及光顧過一次的新客戶如何成為常客),掌握這項資訊後,您就可以改善效率不佳或遭放棄的客戶流程。
JSON 表示法 |
---|
{
"isOpenFunnel": boolean,
"steps": [
{
object ( |
欄位 | |
---|---|
isOpenFunnel |
在開放式漏斗中,使用者可以在任何步驟進入漏斗,但在封閉式漏斗中,則必須在第一個步驟中進入漏斗。選用設定。如果未指定,系統會使用封閉式漏斗。 |
steps[] |
這個漏斗的順序步驟。 |
FunnelStep
步驟用來定義您要評估的使用者歷程。步驟包含一或多個條件,使用者必須符合指定條件,才會納入漏斗流程的步驟。
JSON 表示法 |
---|
{
"name": string,
"isDirectlyFollowedBy": boolean,
"filterExpression": {
object ( |
欄位 | |
---|---|
name |
這個步驟的專屬名稱。如果未指定,步驟將以 1 為基礎的索引名稱命名 (例如「0. "、"1. " 等)。此名稱定義了 |
isDirectlyFollowedBy |
如果為 true,這個步驟必須直接執行上一個步驟。如果為 false,上一個步驟和這個步驟之間可能會出現事件。如未指定,系統會將 |
filterExpression |
使用者必須符合哪些條件,才會納入漏斗歷程的步驟。 |
withinDurationFromPriorStep |
如有指定,這個步驟就必須在前一個步驟完成期間完成。
時間長度以秒為單位,最多可有 9 個小數位數,並結尾為「 |
FunnelFilterExpression
表示漏斗篩選器的組合。
JSON 表示法 |
---|
{ // Union field |
欄位 | |
---|---|
聯集欄位 expr 。為 FunnelFilterExpression 指定一種類型的篩選器。expr 只能採用下列其中一種設定: |
|
andGroup |
|
orGroup |
|
notExpression |
FunnelFilterExpression 並非 |
funnelFieldFilter |
維度或指標的程序篩選器。 |
funnelEventFilter |
建立符合單一事件名稱事件的篩選器。如果指定參數篩選器運算式,只有部分事件同時符合單一事件名稱和參數篩選器運算式才會符合這個事件篩選器。 |
FunnelFilterExpressionList
漏斗篩選器運算式清單。
JSON 表示法 |
---|
{
"expressions": [
{
object ( |
欄位 | |
---|---|
expressions[] |
漏斗篩選器運算式清單。 |
FunnelFieldFilter
篩選維度或指標值的運算式。
JSON 表示法 |
---|
{ "fieldName": string, // Union field |
欄位 | |
---|---|
fieldName |
維度名稱或指標名稱。 |
聯集欄位 one_filter 。指定一種篩選器類型。one_filter 只能是下列其中一項: |
|
stringFilter |
字串相關篩選器。 |
inListFilter |
清單值中的篩選器。 |
numericFilter |
數字或日期值的篩選器。 |
betweenFilter |
兩個值之間的篩選器。 |
FunnelEventFilter
建立符合單一事件名稱事件的篩選器。如果指定參數篩選器運算式,只有部分事件同時符合單一事件名稱和參數篩選器運算式才會符合這個事件篩選器。
JSON 表示法 |
---|
{
"eventName": string,
"funnelParameterFilterExpression": {
object ( |
欄位 | |
---|---|
eventName |
這個篩選器會比對單一事件名稱的事件。必須提供事件名稱。 |
funnelParameterFilterExpression |
如有指定,這個篩選器會比對同時符合單一事件名稱和參數篩選運算式的事件。 在參數篩選器運算式中,只能使用參數篩選器。 |
FunnelParameterFilterExpression
用參數表示漏斗篩選器組合。
JSON 表示法 |
---|
{ // Union field |
欄位 | |
---|---|
聯集欄位 expr 。為 FunnelParameterFilterExpression 指定一種類型的篩選器。expr 只能採用下列其中一種設定: |
|
andGroup |
|
orGroup |
|
notExpression |
FunnelParameterFilterExpression 「並非」 |
funnelParameterFilter |
原始漏斗參數篩選器。 |
FunnelParameterFilterExpressionList
漏斗參數篩選器運算式清單。
JSON 表示法 |
---|
{
"expressions": [
{
object ( |
欄位 | |
---|---|
expressions[] |
漏斗參數篩選器運算式清單。 |
FunnelParameterFilter
用於篩選漏斗中參數值的運算式。
JSON 表示法 |
---|
{ // Union field |
欄位 | |
---|---|
聯集欄位 one_parameter 。要篩選的欄位。one_parameter 只能是下列其中一項: |
|
eventParameterName |
這個篩選器會根據指定事件參數進行評估。系統會將事件參數記錄為事件參數。事件參數包含「firebase_screen」和「currency」等欄位。 事件參數只能用於區隔和漏斗,而且只能用於 EventFilter 的子系篩選器。在 EventFilter 的子篩選器中,應使用事件或項目參數。 |
itemParameterName |
這個篩選器會根據指定的項目參數進行評估。項目參數會在項目陣列中以參數的形式記錄。項目參數包含「item_name」和「item_category」等欄位。 項目參數只能用於區隔和漏斗,而且只能用於 EventFilter 的子系篩選器。在 EventFilter 的子篩選器中,應使用事件或項目參數。 項目參數僅適用於電子商務事件。如要進一步瞭解電子商務事件,請參閱「評估電子商務」指南。 |
聯集欄位 one_filter 。指定一種篩選器類型。one_filter 只能是下列其中一項: |
|
stringFilter |
字串相關篩選器。 |
inListFilter |
清單值中的篩選器。 |
numericFilter |
數字或日期值的篩選器。 |
betweenFilter |
兩個值之間的篩選器。 |
FunnelBreakdown
細目會在漏斗表格子報表回應中加入維度。
JSON 表示法 |
---|
{
"breakdownDimension": {
object ( |
欄位 | |
---|---|
breakdownDimension |
漏斗表格子報表回應中新增的維度欄。細分維度可細分每個漏斗步驟。指定 |
limit |
要回應中,細分維度的不重複值數量上限。如未指定限制,系統會使用 |
FunnelNextAction
「下一個動作」會在使用者完成某個步驟、但使用者完成下一個步驟前,顯示維度的值。舉例來說,如果 nextActionDimension
為 eventName
,則當使用者進入 i
漏斗步驟、但使用者達成第 i+1
個漏斗步驟前,第 i
個漏斗步驟列中的 nextActionDimension
就會傳回第一個事件。
JSON 表示法 |
---|
{
"nextActionDimension": {
object ( |
欄位 | |
---|---|
nextActionDimension |
已新增至漏斗視覺呈現子報表回應的維度欄。下一個動作維度會在使用者完成第
|
limit |
要回應中,細分維度的不重複值數量上限。如未指定限制,系統會使用 |
FunnelVisualizationType
控管漏斗視覺呈現子報表回應中顯示的維度。
列舉 | |
---|---|
FUNNEL_VISUALIZATION_TYPE_UNSPECIFIED |
未指定類型。 |
STANDARD_FUNNEL |
標準 (階梯) 漏斗。回應中的漏斗視覺呈現子報表不會包含日期。 |
TRENDED_FUNNEL |
趨勢 (折線圖) 漏斗。回應中的漏斗視覺呈現子報表會包含日期維度。 |
區隔
區隔是 Analytics (分析) 中的一小部分資料。以您的整個使用者群為例,某個區隔可能是來自特定國家/地區或城市的使用者,另一個區隔也許是購買特定產品、瀏覽網站某個部分或在應用程式中觸發特定事件的訪客。
詳情請參閱「GA4 區隔建立工具」一文。
JSON 表示法 |
---|
{ "name": string, // Union field |
欄位 | |
---|---|
name |
此區隔的名稱。如果未指定,區隔就會命名為「區隔」。此名稱定義了 |
聯集欄位 one_segment_scope 。區隔是在一個範圍內指定。one_segment_scope 只能是下列其中一項: |
|
userSegment |
使用者區隔是指曾與網站或應用程式互動的使用者。 |
sessionSegment |
工作階段區隔是指在您網站或應用程式上發生的工作階段子集。 |
eventSegment |
「事件區隔」是指在您網站或應用程式中觸發的一組事件。 |
UserSegment
使用者區隔是指曾與您網站或應用程式互動的使用者,例如曾消費過的使用者,或是已將商品加入購物車但未完成購買的使用者。
JSON 表示法 |
---|
{ "userInclusionCriteria": { object ( |
欄位 | |
---|---|
userInclusionCriteria |
定義這個區隔包含的使用者。選用。 |
exclusion |
定義要從這個區隔中排除的使用者。選用。 |
UserSegmentCriteria
如果使用者的事件符合條件,就表示使用者符合條件。
JSON 表示法 |
---|
{ "andConditionGroups": [ { object ( |
欄位 | |
---|---|
andConditionGroups[] |
如果使用者符合這些 |
andSequenceGroups[] |
如果使用者符合這些 |
UserSegmentConditionGroup
條件可用來指定 Analytics (分析) 要在區隔中納入或排除哪些資料。
JSON 表示法 |
---|
{ "conditionScoping": enum ( |
欄位 | |
---|---|
conditionScoping |
根據區隔是否符合條件群組,決定要在區隔中納入或排除資料。這項範圍定義了在判定條件群組是否相符之前, 選用設定。如未指定,系統會使用 |
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 。為 SegmentFilterExpression 指定一種類型的篩選器。expr 只能採用下列其中一種設定: |
|
andGroup |
|
orGroup |
|
notExpression |
SegmentFilterExpression 「不」為 |
segmentFilter |
原始區隔篩選器。 |
segmentEventFilter |
建立符合單一事件名稱事件的篩選器。如果指定參數篩選器運算式,只有部分事件同時符合單一事件名稱和參數篩選器運算式才會符合這個事件篩選器。 |
SegmentFilterExpressionList
區隔篩選運算式清單。
JSON 表示法 |
---|
{
"expressions": [
{
object ( |
欄位 | |
---|---|
expressions[] |
區隔篩選運算式清單 |
SegmentFilter
篩選維度或指標值的運算式。
JSON 表示法 |
---|
{ "fieldName": string, "filterScoping": { object ( |
欄位 | |
---|---|
fieldName |
維度名稱或指標名稱。 |
filterScoping |
指定篩選器的範圍。 |
聯集欄位 one_filter 。為 Filter 指定一種類型的篩選器。one_filter 只能採用下列其中一種設定: |
|
stringFilter |
字串相關篩選器。 |
inListFilter |
清單值中的篩選器。 |
numericFilter |
數字或日期值的篩選器。 |
betweenFilter |
兩個值之間的篩選器。 |
SegmentFilterScoping
範圍可指定在評估區隔篩選器時,應如何將多個事件的維度和指標納入考量。
JSON 表示法 |
---|
{ "atAnyPointInTime": boolean } |
欄位 | |
---|---|
atAnyPointInTime |
如果 這個 只有在條件範圍為 如果條件範圍為 |
SegmentEventFilter
建立符合單一事件名稱事件的篩選器。如果指定參數篩選器運算式,只有部分事件同時符合單一事件名稱和參數篩選器運算式才會符合這個事件篩選器。
JSON 表示法 |
---|
{
"eventName": string,
"segmentParameterFilterExpression": {
object ( |
欄位 | |
---|---|
eventName |
這個篩選器會比對單一事件名稱的事件。必須提供事件名稱。 |
segmentParameterFilterExpression |
如有指定,這個篩選器會比對同時符合單一事件名稱和參數篩選運算式的事件。 在參數篩選器運算式中,只能使用參數篩選器。 |
SegmentParameterFilterExpression
以參數表示區隔篩選器的組合。
JSON 表示法 |
---|
{ // Union field |
欄位 | |
---|---|
聯集欄位 expr 。為 SegmentParameterFilterExpression 指定一種類型的篩選器。expr 只能採用下列其中一種設定: |
|
andGroup |
|
orGroup |
|
notExpression |
SegmentParameterFilterExpression 「並非」 |
segmentParameterFilter |
原始區隔參數篩選器。 |
SegmentParameterFilterExpressionList
區隔參數篩選器運算式的清單。
JSON 表示法 |
---|
{
"expressions": [
{
object ( |
欄位 | |
---|---|
expressions[] |
區隔參數篩選器運算式的清單。 |
SegmentParameterFilter
用於篩選區隔中參數值的運算式。
JSON 表示法 |
---|
{ "filterScoping": { object ( |
欄位 | |
---|---|
filterScoping |
指定篩選器的範圍。 |
聯集欄位 one_parameter 。要篩選的欄位。one_parameter 只能是下列其中一項: |
|
eventParameterName |
這個篩選器會根據指定事件參數進行評估。系統會將事件參數記錄為事件參數。事件參數包含「firebase_screen」和「currency」等欄位。 事件參數只能用於區隔和漏斗,而且只能用於 EventFilter 的子系篩選器。在 EventFilter 的子篩選器中,應使用事件或項目參數。 |
itemParameterName |
這個篩選器會根據指定的項目參數進行評估。項目參數會在項目陣列中以參數的形式記錄。項目參數包含「item_name」和「item_category」等欄位。 項目參數只能用於區隔和漏斗,而且只能用於 EventFilter 的子系篩選器。在 EventFilter 的子篩選器中,應使用事件或項目參數。 項目參數僅適用於電子商務事件。如要進一步瞭解電子商務事件,請參閱「評估電子商務」指南。 |
聯集欄位 one_filter 。指定一種篩選器類型。one_filter 只能是下列其中一項: |
|
stringFilter |
字串相關篩選器。 |
inListFilter |
清單值中的篩選器。 |
numericFilter |
數字或日期值的篩選器。 |
betweenFilter |
兩個值之間的篩選器。 |
SegmentParameterFilterScoping
範圍可指定在評估區隔參數篩選器時,應如何將多個事件納入考量。
JSON 表示法 |
---|
{ "inAnyNDayPeriod": string } |
欄位 | |
---|---|
inAnyNDayPeriod |
先在指定期間內累積參數,再套用篩選器。只有在條件範圍為 舉例來說,如果 不要為了在日期範圍開始之前多放送 N 天回溯期而延長日期範圍。舉例來說,如果報表涵蓋 2021 年 11 月 1 日到 2021 年 11 月 10 日,而
|
UserSegmentSequenceGroup
定義使用者必須按照特定順序發生,才能成為區隔成員。
JSON 表示法 |
---|
{ "sequenceScoping": enum ( |
欄位 | |
---|---|
sequenceScoping |
您在指定範圍時必須滿足所有序列步驟,使用者才能比對序列。例如,如果是 選用設定。如未指定,系統會使用 |
sequenceMaximumDuration |
定義整個序列必須發生在哪個時間範圍內,例如 30 分鐘。
時間長度以秒為單位,最多可有 9 個小數位數,並結尾為「 |
userSequenceSteps[] |
依順序排列的條件步驟。使用者的事件必須完成每個步驟,使用者才能與 |
UserSequenceStep
這種條件必須符合使用者指定的步驟順序,才能比對序列。
JSON 表示法 |
---|
{ "isDirectlyFollowedBy": boolean, "stepScoping": enum ( |
欄位 | |
---|---|
isDirectlyFollowedBy |
如果為 true,完成這個步驟的事件必須是發生最後一個步驟的事件之後的下一個事件。如果為 false,這個步驟會間接跟著前一個步驟,例如前一個步驟和步驟之間可能有事件。第一個步驟 |
stepScoping |
此序列步驟必須在使用者限定範圍內符合序列。例如,如果是 選用設定。如未指定, |
segmentFilterExpression |
如果使用者的事件與此序列步驟相符,就符合這個序列步驟。運算式可用於表示維度、指標和/或參數的條件。 |
UserSegmentExclusion
指定要排除在這個區隔中的使用者。
JSON 表示法 |
---|
{ "userExclusionDuration": enum ( |
欄位 | |
---|---|
userExclusionDuration |
指定當使用者與 選用設定。如未指定,系統會使用 |
userExclusionCriteria |
如果使用者符合這項條件,就不再屬於「 |
UserExclusionDuration
列舉使用者符合 userExclusionCriteria
時,排除時間長度的選項。
列舉 | |
---|---|
USER_EXCLUSION_DURATION_UNSPECIFIED |
未指定的排除時間長度。請勿指定。 |
USER_EXCLUSION_TEMPORARY |
在使用者符合 userExclusionCriteria 條件的期間,暫時將使用者從區隔中排除。 |
USER_EXCLUSION_PERMANENT |
當使用者符合 userExclusionCriteria 條件時,將從區隔中永久排除這些使用者。 |
SessionSegment
工作階段區隔是指在您網站/應用程式中發生的工作階段,例如來自特定廣告活動的所有工作階段。
JSON 表示法 |
---|
{ "sessionInclusionCriteria": { object ( |
欄位 | |
---|---|
sessionInclusionCriteria |
定義這個區隔包含哪些工作階段。選用。 |
exclusion |
定義要從這個區隔中排除的工作階段。選用。 |
SessionSegmentCriteria
如果工作階段的事件滿足條件中的條件,工作階段就會比對出條件。
JSON 表示法 |
---|
{
"andConditionGroups": [
{
object ( |
欄位 | |
---|---|
andConditionGroups[] |
如果工作階段符合這些 |
SessionSegmentConditionGroup
條件可用來指定 Analytics (分析) 要在區隔中納入或排除哪些資料。
JSON 表示法 |
---|
{ "conditionScoping": enum ( |
欄位 | |
---|---|
conditionScoping |
根據區隔是否符合條件群組,決定要在區隔中納入或排除資料。這項範圍定義了在判定條件群組是否相符之前, 選用設定。如未指定,系統會使用 |
segmentFilterExpression |
系統會根據資料與這個運算式相符的條件,決定要在區隔中納入或排除資料。運算式可用於表示維度、指標和/或參數的條件。 |
SessionCriteriaScoping
「範圍」功能會指定在評估工作階段是否符合條件時,要將哪些事件納入考量。
列舉 | |
---|---|
SESSION_CRITERIA_SCOPING_UNSPECIFIED |
未指定條件的範圍。請勿指定。 |
SESSION_CRITERIA_WITHIN_SAME_EVENT |
只要一個事件符合條件,該工作階段就會與條件相符。 |
SESSION_CRITERIA_WITHIN_SAME_SESSION |
只要一個工作階段符合條件,該工作階段就會與條件相符。 |
SessionSegmentExclusion
指定要從這個區隔排除的工作階段。
JSON 表示法 |
---|
{ "sessionExclusionDuration": enum ( |
欄位 | |
---|---|
sessionExclusionDuration |
指定工作階段與 選用設定。如未指定,系統會使用 |
sessionExclusionCriteria |
如果工作階段符合這項條件,則系統會將該工作階段從 |
SessionExclusionDuration
列舉當工作階段與 sessionExclusionCriteria
相符時,排除項目的效期選項。
列舉 | |
---|---|
SESSION_EXCLUSION_DURATION_UNSPECIFIED |
未指定的排除時間長度。請勿指定。 |
SESSION_EXCLUSION_TEMPORARY |
在工作階段符合 sessionExclusionCriteria 條件期間,暫時將工作階段從區隔中排除。 |
SESSION_EXCLUSION_PERMANENT |
如果工作階段符合 sessionExclusionCriteria 條件,從區隔中永久排除工作階段。 |
EventSegment
事件區隔是指在您網站或應用程式上觸發的一組事件,例如特定地區的所有購買事件,或是在特定作業系統上發生的 app_exception 事件。
JSON 表示法 |
---|
{ "eventInclusionCriteria": { object ( |
欄位 | |
---|---|
eventInclusionCriteria |
定義這個區隔包含哪些事件。選用。 |
exclusion |
用來定義要從這個區隔中排除哪些事件。選用。 |
EventSegmentCriteria
如果事件符合條件,就會與條件達成比對。
JSON 表示法 |
---|
{
"andConditionGroups": [
{
object ( |
欄位 | |
---|---|
andConditionGroups[] |
如果事件與這些 |
EventSegmentConditionGroup
條件可用來指定 Analytics (分析) 要在區隔中納入或排除哪些資料。
JSON 表示法 |
---|
{ "conditionScoping": enum ( |
欄位 | |
---|---|
conditionScoping |
選用設定。如未指定,系統會使用 |
segmentFilterExpression |
系統會根據資料與這個運算式相符的條件,決定要在區隔中納入或排除資料。運算式可用於表示維度、指標和/或參數的條件。 |
EventCriteriaScoping
範圍功能會指定在評估事件是否符合條件時,要將哪些事件納入考量。
列舉 | |
---|---|
EVENT_CRITERIA_SCOPING_UNSPECIFIED |
未指定條件的範圍。請勿指定。 |
EVENT_CRITERIA_WITHIN_SAME_EVENT |
只要單一事件符合條件,該事件就會與條件相符。 |
EventSegmentExclusion
指定要排除這個區隔中的哪些事件。
JSON 表示法 |
---|
{ "eventExclusionDuration": enum ( |
欄位 | |
---|---|
eventExclusionDuration |
選用設定。如未指定,系統會使用 |
eventExclusionCriteria |
如果事件符合這項條件,系統會將該事件從「 |
EventExclusionDuration
列舉當事件與 eventExclusionCriteria
相符時,排除項目的效期選項。
列舉 | |
---|---|
EVENT_EXCLUSION_DURATION_UNSPECIFIED |
未指定的排除時間長度。請勿指定。 |
EVENT_EXCLUSION_PERMANENT |
如果事件符合 eventExclusionCriteria 條件,從區隔中永久排除事件。 |
FunnelSubReport
漏斗子報表包含維度和指標資料值。舉例來說,假設有 12 位使用者抵達漏斗的第二個步驟,
JSON 表示法 |
---|
{ "dimensionHeaders": [ { object ( |
欄位 | |
---|---|
dimensionHeaders[] |
說明維度欄。漏斗報表一律會在子報表回應中納入漏斗步驟維度。如有需要,回應中可能會顯示細分、日期和後續動作等其他維度。 |
metricHeaders[] |
說明指標欄。漏斗報表一律會在子報表回應中納入活躍使用者。漏斗表格會提供其他指標,例如完成率、放棄率和放棄率。 |
rows[] |
報表中維度值組合和指標值的資料列。 |
metadata |
漏斗報表的中繼資料。 |
FunnelResponseMetadata
漏斗報表的回應中繼資料提供漏斗報表的其他相關資訊。
JSON 表示法 |
---|
{
"samplingMetadatas": [
{
object ( |
欄位 | |
---|---|
samplingMetadatas[] |
如果漏斗報表結果經過取樣,則代表此漏斗報表中使用的事件百分比。每個日期範圍都會填入一個 但如果結果未經過取樣,就不會定義這個欄位。 |
SamplingMetadata
如果漏斗報表結果經過取樣,則中繼資料會說明這份報表在某日期範圍內使用了多少百分比的事件。取樣是指分析龐大資料集中的一部分資料,從龐大的資料集中發掘出實用資訊。
JSON 表示法 |
---|
{ "samplesReadCount": string, "samplingSpaceSize": string } |
欄位 | |
---|---|
samplesReadCount |
這份取樣報表中某個日期範圍內讀取的事件總數。這是這項資源在漏斗報表中所分析的子集大小。 |
samplingSpaceSize |
這項資源的資料中,在特定日期範圍內可能無法分析的事件總數。取樣可提供較大資料集的實用資訊,這是較大資料集的大小。 如要計算此漏斗報表中的可用資料百分比,請計算「 |
PropertyQuota
這項 Analytics (分析) 資源所有配額目前的狀態。如果資源的任何配額已用盡,則該資源的所有要求都會傳回「資源用盡」錯誤。
JSON 表示法 |
---|
{ "tokensPerDay": { object ( |
欄位 | |
---|---|
tokensPerDay |
標準 Analytics (分析) 資源每天最多可使用 200,000 個權杖;Analytics (分析) 360 資源每天可使用 2,000,000 個權杖。大多數要求使用的符記數量不到 10 個。 |
tokensPerHour |
標準 Analytics (分析) 資源每小時最多可使用 40,000 個符記;Analytics (分析) 360 資源每小時可使用 40 萬個權杖。API 要求只會使用一組符記,該數字會從所有每小時、每日和每項專案的每小時配額中扣除。 |
concurrentRequests |
標準 Analytics (分析) 資源最多可傳送 10 項並行要求,Analytics (分析) 360 資源最多可同時傳送 50 個並行要求。 |
serverErrorsPerProjectPerHour |
標準 Analytics (分析) 資源和雲端專案組合每小時最多可有 10 個伺服器錯誤;Analytics (分析) 360 資源和雲端專案組合每小時最多可發生 50 個伺服器錯誤。 |
potentiallyThresholdedRequestsPerHour |
Analytics (分析) 資源最多可傳送 120 個要求,其中含有可能設有閾值的維度。在批次要求中,如果請求中包含可能設有閾值的維度,則每項報表要求都會分別計入這項配額。 |
tokensPerProjectPerHour |
Analytics (分析) 資源每小時最多可使用每項專案 35% 的權杖。就標準 Analytics (分析) 資源而言,每個專案每小時最多可以使用 14,000 個符記,而 Analytics (分析) 360 資源每小時則可在每個專案中使用 140,000 個符記。API 要求只會使用一組符記,該數字會從所有每小時、每日和每項專案的每小時配額中扣除。 |
QuotaStatus
特定配額群組的目前狀態。
JSON 表示法 |
---|
{ "consumed": integer, "remaining": integer } |
欄位 | |
---|---|
consumed |
此要求耗用的配額。 |
remaining |
提出這項要求後的剩餘配額。 |