Method: properties.runFunnelReport

string

省略可。イベントがトラッキングされる Google アナリティクスのプロパティの ID。URL パスで指定され、本文では指定されていません。詳しくは、プロパティ ID を確認するをご覧ください。バッチ リクエスト内では、このプロパティは指定しないか、バッチレベルのプロパティと一致している必要があります。

例: properties/1234

boolean

オープン ファネルでは、ファネルの途中のステップから開始したユーザーもすべてカウントされます。クローズド ファネルでは、ファネルの最初のステップを経たユーザー以外は無視されます。省略可。指定しない場合、クローズド ファネルが使用されます。

object (FunnelStep)

このファネルの順次ステップ。

string

このステップの固有の名前。指定しない場合、ステップには 1 から始まるインデックス名が付けられます（例: 「0. ", "1. 」など）。この名前は、funnelStepName ディメンションによって返される文字列値を定義します。たとえば、リクエストの 3 番目のファネルのステップで name = Purchase を指定すると、ファネル レポートのレスポンスで 3. Purchase が生成されます。

boolean

true の場合、このステップは前のステップの直後に行う必要があります。false の場合、前のステップとこのステップの間にイベントが発生する可能性があります。指定しない場合、isDirectlyFollowedBy は false として扱われます。

object (FunnelFilterExpression)

ユーザーがファネルの各ステップに含まれる条件。

string (Duration format)

指定した場合、このステップは前のステップの完了からこの期間内に完了する必要があります。withinDurationFromPriorStep には、マイクロ秒単位のエンドポイントが含まれます。たとえば、5 秒の期間は 4.9 秒または 5.0 秒で完了できますが、5 秒と 1 マイクロ秒では完了できません。

withinDurationFromPriorStep は省略可能です。指定しない場合、ステップは任意の期間で区切ることができます。

s で終わる小数 9 桁までの秒単位の期間。例: "3.5s"。

object (FunnelFilterExpressionList)

andGroup の FunnelFilterExpression は AND 関係にあります。

object (FunnelFilterExpressionList)

orGroup の FunnelFilterExpression は OR 関係にあります。

object (FunnelFilterExpression)

FunnelFilterExpression が notExpression ではない。

object (FunnelFieldFilter)

ディメンションまたは指標のファネル フィルタ。

object (FunnelEventFilter)

単一のイベント名のイベントに一致するフィルタを作成します。パラメータ フィルタ式が指定されている場合、単一のイベント名とパラメータ フィルタ式の両方に一致するイベントのサブセットのみが、このイベント フィルタに一致します。

object (FunnelFilterExpression)

ファネル フィルタ式のリスト。

string

ディメンション名または指標名。

object (StringFilter)

文字列関連のフィルタ。

object (InListFilter)

リスト内の値のフィルタ。

object (NumericFilter)

数値または日付の値のフィルタ。

object (BetweenFilter)

2 つの値の間のフィルタ。

string

このフィルタは、この単一のイベント名のイベントに一致します。イベント名は必須です。

object (FunnelParameterFilterExpression)

指定した場合、このフィルタは、単一のイベント名とパラメータ フィルタ式に一致するイベントを照合します。

パラメータ フィルタ式内では、パラメータ フィルタのみを使用できます。

object (FunnelParameterFilterExpressionList)

andGroup の FunnelParameterFilterExpression は AND 関係にあります。

object (FunnelParameterFilterExpressionList)

orGroup の FunnelParameterFilterExpression は OR 関係にあります。

object (FunnelParameterFilterExpression)

FunnelParameterFilterExpression が notExpression ではない。

object (FunnelParameterFilter)

プリミティブなファネル パラメータ フィルタ。

object (FunnelParameterFilterExpression)

ファネル パラメータのフィルタ式のリスト。

string

このフィルタは、指定されたイベント パラメータで評価されます。イベント パラメータは、イベントのパラメータとして記録されます。イベント パラメータには、「firebase_screen」や「currency」などのフィールドが含まれます。

イベント パラメータはセグメントとファネルでのみ使用でき、EventFilter の子孫フィルタでのみ使用できます。EventFilter の子フィルタでは、イベント パラメータまたはアイテム パラメータのいずれかを使用する必要があります。

string

このフィルタは、指定されたアイテム パラメータで評価されます。アイテム パラメータは、アイテム配列のパラメータとしてログに記録されます。アイテム パラメータには、「item_name」や「item_category」などのフィールドが含まれます。

アイテム パラメータはセグメントとファネルでのみ使用でき、EventFilter の子孫フィルタでのみ使用できます。EventFilter の子フィルタでは、イベント パラメータまたはアイテム パラメータのいずれかを使用する必要があります。

アイテム パラメータは、e コマース イベントでのみ使用できます。e コマース イベントについて詳しくは、e コマースの測定ガイドをご覧ください。

object (StringFilter)

文字列関連のフィルタ。

object (InListFilter)

リスト内の値のフィルタ。

object (NumericFilter)

数値または日付の値のフィルタ。

object (BetweenFilter)

2 つの値の間のフィルタ。

object (Dimension)

ファネル表のサブレポート レスポンスに追加されたディメンション列。内訳項目は、各ファネルのステップを分類します。funnelBreakdown が指定されている場合は、有効な breakdownDimension が必要です。

string (int64 format)

レスポンスで返すブレークダウン ディメンションの個別の値の最大数。上限が指定されていない場合は、5 の limit が使用されます。上限は 0 より大きく、15 を超えることはできません。

object (Dimension)

ファネル ビジュアリゼーションのサブレポートのレスポンスに追加されたディメンション列。次のアクション ディメンションは、ユーザーが i 番目のファネルのステップに到達した後の、このディメンションの次のディメンション値を返します。

現在、nextActionDimension は eventName と、pageTitle や pagePath などのほとんどのページ / スクリーン ディメンションのみをサポートしています。nextActionDimension はディメンション式にできません。

string (int64 format)

レスポンスで返すブレークダウン ディメンションの個別の値の最大数。上限が指定されていない場合は、5 の limit が使用されます。上限は 0 より大きく、5 を超えることはできません。

string

このセグメントの名前。指定しない場合、セグメントの名前は「セグメント」になります。この名前は、segment ディメンションによって返される文字列値を定義します。segment ディメンションは、リクエスト内のセグメントの 1 から始まるインデックス番号をセグメント名の先頭に付加します（例: 「1. Segment", "2. セグメント」など）。

object (UserSegment)

ユーザー セグメントとは、サイトやアプリを利用したユーザーのサブセットのことです。

object (SessionSegment)

セッション セグメントは、サイトやアプリで発生したセッションのサブセットです。

object (EventSegment)

イベント セグメントは、サイトやアプリでトリガーされたイベントのサブセットです。

object (UserSegmentCriteria)

このセグメントに含まれるユーザーを定義します。省略可。

object (UserSegmentExclusion)

このセグメントから除外されるユーザーを定義します。省略可。

object (UserSegmentConditionGroup)

ユーザーがこの条件を満たすのは、ユーザーが andConditionGroups のそれぞれと andSequenceGroups のそれぞれに一致する場合です。andSequenceGroups が指定されている場合、andConditionGroups は空にできます。

object (UserSegmentSequenceGroup)

ユーザーがこの条件を満たすのは、ユーザーが andSequenceGroups のそれぞれと andConditionGroups のそれぞれに一致する場合です。andConditionGroups が指定されている場合、andSequenceGroups は空にできます。

enum (UserCriteriaScoping)

条件グループに一致するかどうかに基づいて、セグメントにデータを含めるか除外するかが決まります。このスコープ設定では、条件グループが一致するかどうかを判断する前に segmentFilterExpression が評価されるイベントの数を定義します。たとえば、conditionScoping = USER_CRITERIA_WITHIN_SAME_SESSION の場合、セッション内のすべてのイベントで式が評価され、このユーザーに対して条件グループが一致するかどうかが判断されます。たとえば、conditionScoping = USER_CRITERIA_WITHIN_SAME_EVENT の場合、式は単一のイベントで評価され、このユーザーに対して条件グループが一致するかどうかが判断されます。

省略可。指定しない場合は conditionScoping = ACROSS_ALL_SESSIONS が使用されます。

object (SegmentFilterExpression)

この式に一致するかどうかに基づいて、データがセグメントに含まれるか除外されるかが決まります。式は、ディメンション、指標、パラメータの条件を表します。

object (SegmentFilterExpressionList)

andGroup の SegmentFilterExpression は AND 関係にあります。

object (SegmentFilterExpressionList)

orGroup の SegmentFilterExpression は OR 関係にあります。

object (SegmentFilterExpression)

SegmentFilterExpression が notExpression ではない。

object (SegmentFilter)

プリミティブ セグメント フィルタ。

object (SegmentEventFilter)

単一のイベント名のイベントに一致するフィルタを作成します。パラメータ フィルタ式が指定されている場合、単一のイベント名とパラメータ フィルタ式の両方に一致するイベントのサブセットのみが、このイベント フィルタに一致します。

object (SegmentFilterExpression)

セグメント フィルタ式のリスト

string

ディメンション名または指標名。

object (SegmentFilterScoping)

フィルタのスコープを指定します。

object (StringFilter)

文字列関連のフィルタ。

object (InListFilter)

リスト内の値のフィルタ。

object (NumericFilter)

数値または日付の値のフィルタ。

object (BetweenFilter)

2 つの値の間のフィルタ。

boolean

atAnyPointInTime が true の場合、このフィルタは、リクエストの日付範囲内のいずれかのイベントで true と評価されると、すべてのイベントで true と評価されます。

この atAnyPointInTime パラメータは、レポートのイベントの期間を延長するものではありません。atAnyPointInTime が true の場合、このフィルタの評価時にレポートの期間内のイベントのみが考慮されます。

この atAnyPointInTime は、条件のスコープが ACROSS_ALL_SESSIONS の場合にのみ指定でき、シーケンスでは指定できません。

条件のスコープが ACROSS_ALL_SESSIONS の場合、指定しないと atAnyPointInTime = false が使用されます。

string

このフィルタは、この単一のイベント名のイベントに一致します。イベント名は必須です。

object (SegmentParameterFilterExpression)

指定した場合、このフィルタは、単一のイベント名とパラメータ フィルタ式に一致するイベントを照合します。

パラメータ フィルタ式内では、パラメータ フィルタのみを使用できます。

object (SegmentParameterFilterExpressionList)

andGroup の SegmentParameterFilterExpression は AND 関係にあります。

object (SegmentParameterFilterExpressionList)

orGroup の SegmentParameterFilterExpression は OR 関係にあります。

object (SegmentParameterFilterExpression)

SegmentParameterFilterExpression が notExpression ではない。

object (SegmentParameterFilter)

プリミティブ セグメント パラメータ フィルタ。

object (SegmentParameterFilterExpression)

セグメント パラメータ フィルタ式のリスト。

object (SegmentParameterFilterScoping)

フィルタのスコープを指定します。

string

このフィルタは、指定されたイベント パラメータで評価されます。イベント パラメータは、イベントのパラメータとして記録されます。イベント パラメータには、「firebase_screen」や「currency」などのフィールドが含まれます。

イベント パラメータはセグメントとファネルでのみ使用でき、EventFilter の子孫フィルタでのみ使用できます。EventFilter の子フィルタでは、イベント パラメータまたはアイテム パラメータのいずれかを使用する必要があります。

string

このフィルタは、指定されたアイテム パラメータで評価されます。アイテム パラメータは、アイテム配列のパラメータとしてログに記録されます。アイテム パラメータには、「item_name」や「item_category」などのフィールドが含まれます。

アイテム パラメータはセグメントとファネルでのみ使用でき、EventFilter の子孫フィルタでのみ使用できます。EventFilter の子フィルタでは、イベント パラメータまたはアイテム パラメータのいずれかを使用する必要があります。

アイテム パラメータは、e コマース イベントでのみ使用できます。e コマース イベントについて詳しくは、e コマースの測定ガイドをご覧ください。

object (StringFilter)

文字列関連のフィルタ。

object (InListFilter)

リスト内の値のフィルタ。

object (NumericFilter)

数値または日付の値のフィルタ。

object (BetweenFilter)

2 つの値の間のフィルタ。

string (int64 format)

フィルタを適用する前に、指定した期間にわたってパラメータを累積します。条件のスコープが ACROSS_ALL_SESSIONS または WITHIN_SAME_SESSION の場合にのみサポートされます。パラメータが event_count の場合にのみサポートされます。

たとえば、inAnyNDayPeriod が 3、eventName が「purchase」、イベント パラメータが「event_count」、フィルタの条件が 5 より大きい場合、このフィルタはレポートの期間内の 3 日間の連続した期間ごとに購入イベントのイベント数を集計します。購入イベントの数が 3 日間の連続した期間で 5 を超えたユーザーは、このフィルタの条件を満たし、このセグメントに含まれます。たとえば、2021 年 11 月 1 日～ 2021 年 11 月 3 日、2021 年 11 月 2 日～ 2021 年 11 月 4 日、2021 年 11 月 3 日～ 2021 年 11 月 5 日などの期間が考慮されます。

期間の開始付近で N 日間の期間を確保するために、期間が延長されることはありません。たとえば、レポートの期間が 2021 年 11 月 1 日から 2021 年 11 月 10 日で、inAnyNDayPeriod = 3 の場合、レポートの期間外のイベントデータは読み取られないため、最初の 2 日間の期間は実質的に短縮されます。たとえば、最初の 4 つの期間は、2021 年 11 月 1 日～ 2021 年 11 月 1 日、2021 年 11 月 1 日～ 2021 年 11 月 2 日、2021 年 11 月 1 日～ 2021 年 11 月 3 日、2021 年 11 月 2 日～ 2021 年 11 月 4 日となります。

inAnyNDayPeriod は省略可能です。指定しない場合、segmentParameterFilter は各イベントに個別に適用されます。

enum (UserCriteriaScoping)

ユーザーがシーケンスに一致するには、シーケンスのすべてのステップがスコープ内で満たされている必要があります。たとえば、sequenceScoping = USER_CRITERIA_WITHIN_SAME_SESSION の場合、ユーザーがシーケンスに一致するには、すべてのシーケンス ステップが 1 つのセッション内で完了している必要があります。sequenceScoping = USER_CRITERIA_WITHIN_SAME_EVENT はサポートされていません。

省略可。指定しない場合は conditionScoping = ACROSS_ALL_SESSIONS が使用されます。

string (Duration format)

シーケンス全体が発生する期間を定義します（例: 30 分）。sequenceMaximumDuration には、マイクロ秒単位のエンドポイントが含まれます。たとえば、最大再生時間が 5 秒のシーケンスは 4.9 秒または 5.0 秒で完了できますが、5 秒 1 マイクロ秒では完了できません。

sequenceMaximumDuration は省略可能です。指定しない場合、シーケンスは任意の期間で完了できます。

s で終わる小数 9 桁までの秒単位の期間。例: "3.5s"。

object (UserSequenceStep)

条件ステップの順序付きシーケンス。ユーザーが UserSegmentSequenceGroup に一致するには、ユーザーのイベントが各ステップを完了する必要があります。

boolean

true の場合、このステップを満たすイベントは、前のステップを満たすイベントの直後のイベントでなければなりません。false の場合、このステップは前のステップの次の間接的ステップです。たとえば、前のステップとこのステップの間にイベントが発生している可能性があります。最初の手順では isDirectlyFollowedBy は false にする必要があります。

enum (UserCriteriaScoping)

このシーケンス ステップは、ユーザーがシーケンスと一致するためのスコープで満たされている必要があります。たとえば、sequenceScoping = WITHIN_SAME_SESSION の場合、ユーザーがシーケンスと一致するには、このシーケンス ステップを 1 つのセッション内で完了する必要があります。stepScoping = ACROSS_ALL_SESSIONS は、sequenceScoping = ACROSS_ALL_SESSIONS の場合にのみ許可されます。

省略可。指定しない場合、stepScoping は sequenceScoping と同じ UserCriteriaScoping を使用します。

object (SegmentFilterExpression)

ユーザーのイベントがこの式と一致する場合、ユーザーはこのシーケンス ステップに一致します。式は、ディメンション、指標、パラメータの条件を表します。

enum (UserExclusionDuration)

ユーザーが userExclusionCriteria に一致した場合に除外が継続される期間を指定します。

省略可。指定しない場合は、USER_EXCLUSION_TEMPORARY の userExclusionDuration が使用されます。

object (UserSegmentCriteria)

ユーザーがこの条件を満たしている場合、そのユーザーは userExclusionDuration の間、セグメントのメンバーシップから除外されます。

object (SessionSegmentCriteria)

このセグメントに含まれるセッションを定義します。省略可。

object (SessionSegmentExclusion)

このセグメントで除外するセッションを定義します。省略可。

object (SessionSegmentConditionGroup)

セッションがこれらの andConditionGroups のそれぞれに一致する場合、セッションはこの条件に一致します。

enum (SessionCriteriaScoping)

条件グループに一致するかどうかに基づいて、セグメントにデータを含めるか除外するかが決まります。このスコープ設定では、条件グループが一致するかどうかを判断する前に segmentFilterExpression が評価されるイベントの数を定義します。たとえば、conditionScoping = SESSION_CRITERIA_WITHIN_SAME_SESSION の場合、式はセッション内のすべてのイベントで評価され、このセッションで条件グループが一致するかどうかが判断されます。たとえば、conditionScoping = SESSION_CRITERIA_WITHIN_SAME_EVENT の場合、式は単一のイベントで評価され、このセッションで条件グループが一致するかどうかが判断されます。

省略可。指定しない場合、conditionScoping の WITHIN_SAME_SESSION が使用されます。

object (SegmentFilterExpression)

この式に一致するかどうかに基づいて、データがセグメントに含まれるか除外されるかが決まります。式は、ディメンション、指標、パラメータの条件を表します。

enum (SessionExclusionDuration)

セッションが sessionExclusionCriteria と一致した場合に除外が継続される期間を指定します。

省略可。指定しない場合、sessionExclusionDuration の SESSION_EXCLUSION_TEMPORARY が使用されます。

object (SessionSegmentCriteria)

セッションがこの条件を満たす場合、そのセッションは sessionExclusionDuration のセグメントのメンバーシップから除外されます。

object (EventSegmentCriteria)

このセグメントに含めるイベントを定義します。省略可。

object (EventSegmentExclusion)

このセグメントで除外するイベントを定義します。省略可。

object (EventSegmentConditionGroup)

イベントがこれらの各 andConditionGroups に一致する場合、イベントはこの条件に一致します。

enum (EventCriteriaScoping)

conditionScoping は常に EVENT_CRITERIA_WITHIN_SAME_EVENT にする必要があります。

省略可。指定しない場合、conditionScoping の EVENT_CRITERIA_WITHIN_SAME_EVENT が使用されます。

object (SegmentFilterExpression)

この式に一致するかどうかに基づいて、データがセグメントに含まれるか除外されるかが決まります。式は、ディメンション、指標、パラメータの条件を表します。

enum (EventExclusionDuration)

eventExclusionDuration は常に PERMANENTLY_EXCLUDE にする必要があります。

省略可。指定しない場合、eventExclusionDuration の EVENT_EXCLUSION_PERMANENT が使用されます。

object (EventSegmentCriteria)

イベントがこの条件を満たす場合、そのイベントは eventExclusionDuration のセグメントのメンバーシップから除外されます。

object (DimensionHeader)

ディメンション列について説明します。ファネル レポートには、常にサブレポート レスポンスにファネルのステップ ディメンションが含まれます。リクエストに応じて、内訳、日付、次のアクションなどの追加のディメンションがレスポンスに含まれることがあります。

object (MetricHeader)

指標列について説明します。ファネル レポートには、常にアクティブ ユーザーがサブレポートのレスポンスに含まれます。ファネル テーブルには、完了率、離脱数、離脱率などの指標も含まれます。

object (Row)

レポートのディメンション値の組み合わせと指標値の行。

object (FunnelResponseMetadata)

ファネル レポートのメタデータ。

object (SamplingMetadata)

ファネル レポートの結果がサンプリングされている場合、このファネル レポートで使用されたイベントの割合が表示されます。各期間に対して 1 つの samplingMetadatas が入力されます。各 samplingMetadatas は、リクエストで指定された順序で期間に対応します。

ただし、結果がサンプリングされていない場合、このフィールドは定義されません。