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)

レスポンスで返される内訳ディメンションの個別の値の最大数。上限が指定されていない場合、limit は 5 になります。上限は 0 より大きく、15 を超えないようにしてください。

object (Dimension)

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

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

string (int64 format)

レスポンスで返される内訳ディメンションの個別の値の最大数。上限が指定されていない場合、limit は 5 になります。上限は 0 より大きく、5 を超えないようにしてください。

string

このセグメントの名前。指定しない場合、セグメントの名前は「セグメント」になります。この名前は、segment ディメンションによって返される文字列値を定義します。segment ディメンションのセグメント名には、リクエスト内のセグメントの 1 ベースのインデックス番号が接頭辞として付加されます（例: 「1. セグメント」と「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 の場合、式は 1 つのイベントで評価され、このユーザーに対して条件グループが一致するかどうかが決まります。

省略可。指定しない場合は 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 パラメータが「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-01 ～ 2021-11-10 で、inAnyNDayPeriod = 3 の場合、レポートの期間外のアクティビティ データは読み込まれないため、最初の 2 日間の期間は実質的に短縮されます。たとえば、最初の 4 つの期間は、2021-11-01 ～ 2021-11-01、2021-11-01 ～ 2021-11-02、2021-11-01 ～ 2021-11-03、2021-11-02 ～ 2021-11-04 になります。

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 の場合、式は 1 つのイベントで評価され、このセッションで条件グループが一致するかどうかが決まります。

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

object (SegmentFilterExpression)

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

enum (SessionExclusionDuration)

セッションが sessionExclusionCriteria に一致した場合の除外期間を指定します。

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

object (SessionSegmentCriteria)

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

object (EventSegmentCriteria)

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

object (EventSegmentExclusion)

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

object (EventSegmentConditionGroup)

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

enum (EventCriteriaScoping)

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

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

object (SegmentFilterExpression)

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

enum (EventExclusionDuration)

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

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

object (EventSegmentCriteria)

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

object (DimensionHeader)

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

object (MetricHeader)

指標列を記述します。目標到達プロセス レポートのサブレポートのレスポンスには、常にアクティブ ユーザーが含まれます。目標到達プロセスの表には、完了率、放棄数、放棄率などの追加の指標が含まれます。

object (Row)

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

object (FunnelResponseMetadata)

目標到達プロセス レポートのメタデータ。

object (SamplingMetadata)

目標到達プロセス レポートの結果がサンプリングされている場合は、この目標到達プロセス レポートで使用されたイベントの割合を示します。期間ごとに 1 つの samplingMetadatas が入力されます。各 samplingMetadatas は、リクエストで指定された期間に対応しています。

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