Method: properties.runFunnelReport

string

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

例: properties/1234

{
  "startDate": string,
  "endDate": string,
  "name": string
}

string

クエリの開始日（この日付を含む）。YYYY-MM-DD の形式で指定します。endDate より後の日付は指定できません。NdaysAgo、yesterday、today の形式も使用できます。その場合、日付はプロパティのレポートのタイムゾーンに基づいて推定されます。

string

クエリの終了日（両端を含む）。YYYY-MM-DD の形式で指定します。startDate より前の日付を指定することはできません。NdaysAgo、yesterday、today の形式も使用できます。その場合、日付はプロパティのレポートのタイムゾーンに基づいて推定されます。

string

この期間に名前を割り当てます。レポート レスポンスでは、ディメンション dateRange にこの名前が設定されます。設定した場合、date_range_ または RESERVED_ で始めることはできません。設定しない場合、期間の名前はリクエスト内のゼロから始まるインデックス（date_range_0、date_range_1 など）になります。

{
  "isOpenFunnel": boolean,
  "steps": [
    {
      object (FunnelStep)
    }
  ]
}

boolean

オープン ファネルでは、ユーザーはどのステップからでもファネルに入ります。クローズド ファネルでは、最初のステップからファネルを開始する必要があります。省略可。指定しない場合は、クローズド ファネルが使用されます。

object (FunnelStep)

このファネルの一連のステップ。

{
  "name": string,
  "isDirectlyFollowedBy": boolean,
  "filterExpression": {
    object (FunnelFilterExpression)
  },
  "withinDurationFromPriorStep": string
}

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"。

{

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

object (FunnelFilterExpressionList)

andGroup の FunnelFilterExpression は AND 関係です。

object (FunnelFilterExpressionList)

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

object (FunnelFilterExpression)

FunnelFilterExpression が notExpression の NOT になっています。

object (FunnelFieldFilter)

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

object (FunnelEventFilter)

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

{
  "expressions": [
    {
      object (FunnelFilterExpression)
    }
  ]
}

object (FunnelFilterExpression)

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

{
  "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.
}

string

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

object (StringFilter)

文字列関連のフィルタ。

object (InListFilter)

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

object (NumericFilter)

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

object (BetweenFilter)

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

{
  "matchType": enum (MatchType),
  "value": string,
  "caseSensitive": boolean
}

enum (MatchType)

このフィルタのマッチタイプ。

string

照合に使用される文字列値。

boolean

true の場合、文字列値の大文字と小文字は区別されます。

{
  "values": [
    string
  ],
  "caseSensitive": boolean
}

string

文字列値のリスト。空でない必要があります。

boolean

true の場合、文字列値の大文字と小文字は区別されます。

{
  "operation": enum (Operation),
  "value": {
    object (NumericValue)
  }
}

enum (Operation)

このフィルタのオペレーション タイプ。

object (NumericValue)

数値または日付値。

{

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

string (int64 format)

整数値

number

double 値

{
  "fromValue": {
    object (NumericValue)
  },
  "toValue": {
    object (NumericValue)
  }
}

object (NumericValue)

この番号で始まります。

object (NumericValue)

末尾がこの番号。

{
  "eventName": string,
  "funnelParameterFilterExpression": {
    object (FunnelParameterFilterExpression)
  }
}

string

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

object (FunnelParameterFilterExpression)

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

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

{

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

object (FunnelParameterFilterExpressionList)

andGroup の FunnelParameterFilterExpression は AND 関係です。

object (FunnelParameterFilterExpressionList)

orGroup の FunnelParameterFilterExpression は OR 関係です。

object (FunnelParameterFilterExpression)

FunnelParameterFilterExpression が notExpression の NOT です。

object (FunnelParameterFilter)

ファネルの基本パラメータ フィルタ。

{
  "expressions": [
    {
      object (FunnelParameterFilterExpression)
    }
  ]
}

object (FunnelParameterFilterExpression)

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

{

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

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 つの値の間のフィルタ。

{
  "breakdownDimension": {
    object (Dimension)
  },
  "limit": string
}

object (Dimension)

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

string (int64 format)

レスポンスで返す内訳ディメンションの個別の値の最大数。上限が指定されていない場合は、5 の limit が使用されます。上限は 0 以下、15 以下にする必要があります。

{
  "name": string,
  "dimensionExpression": {
    object (DimensionExpression)
  }
}

string

ディメンションの名前。runReport や batchRunReports などの主要なレポート メソッドでサポートされているディメンション名の一覧については、API ディメンションをご覧ください。runRealtimeReport メソッドでサポートされているディメンション名の一覧については、リアルタイム ディメンションをご覧ください。runFunnelReport メソッドでサポートされているディメンション名の一覧については、ファネル ディメンションをご覧ください。

dimensionExpression を指定した場合、name には、使用可能な文字セット内の任意の文字列を指定できます。たとえば、dimensionExpression が country と city を連結する場合、そのディメンションを countryAndCity と呼び出せます。選択するディメンション名は、正規表現 ^[a-zA-Z0-9_]$ と一致する必要があります。

ディメンションは、dimensionFilter、orderBys、dimensionExpression、pivots の name によって参照されます。

object (DimensionExpression)

1 つのディメンションは、複数のディメンションの式の結果になることがあります。たとえば、ディメンション「country, city」の場合は concatenate(country, ", ", city)。

{

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

object (CaseExpression)

ディメンション値を小文字に変換するために使用します。

object (CaseExpression)

ディメンション値を大文字に変換するために使用します。

object (ConcatenateExpression)

ディメンション値を 1 つのディメンションにまとめるために使用します。たとえば、ディメンション「country, city」の場合は concatenate(country, ", ", city)。

{
  "dimensionName": string
}

string

ディメンションの名前。この名前は、リクエストのディメンション フィールド内の名前を参照する必要があります。

{
  "dimensionNames": [
    string
  ],
  "delimiter": string
}

string

ディメンションの名前。この名前は、リクエストのディメンション フィールド内の名前を参照する必要があります。

string

ディメンション名の間に配置される区切り文字。

区切り文字は多くの場合、| や "," などの 1 文字ですが、より長い文字列にすることもできます。ディメンション値に区切り文字が含まれている場合は、レスポンスに両方が区別なく含まれます。たとえば、ディメンション 1 の値が「US,FR」、ディメンション 2 の値が「JP」、区切り文字が「,」の場合、レスポンスには「US,FR,JP」が含まれます。

{
  "nextActionDimension": {
    object (Dimension)
  },
  "limit": string
}

object (Dimension)

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

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

string (int64 format)

レスポンスで返す内訳ディメンションの個別の値の最大数。上限が指定されていない場合は、5 の limit が使用されます。上限は 0 以下、5 以下にする必要があります。

{
  "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.
}

string

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

object (UserSegment)

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

object (SessionSegment)

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

object (EventSegment)

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

{
  "userInclusionCriteria": {
    object (UserSegmentCriteria)
  },
  "exclusion": {
    object (UserSegmentExclusion)
  }
}

object (UserSegmentCriteria)

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

object (UserSegmentExclusion)

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

{
  "andConditionGroups": [
    {
      object (UserSegmentConditionGroup)
    }
  ],
  "andSequenceGroups": [
    {
      object (UserSegmentSequenceGroup)
    }
  ]
}

object (UserSegmentConditionGroup)

ユーザーがこれらの andConditionGroups と andSequenceGroups のそれぞれに一致する場合、この条件に一致します。andSequenceGroups が指定されている場合、andConditionGroups は空になることがあります。

object (UserSegmentSequenceGroup)

ユーザーがこれらの andSequenceGroups と andConditionGroups のそれぞれに一致する場合、この条件に一致します。andConditionGroups が指定されている場合、andSequenceGroups は空になることがあります。

{
  "conditionScoping": enum (UserCriteriaScoping),
  "segmentFilterExpression": {
    object (SegmentFilterExpression)
  }
}

enum (UserCriteriaScoping)

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

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

object (SegmentFilterExpression)

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

{

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

object (SegmentFilterExpressionList)

andGroup の SegmentFilterExpression は AND 関係です。

object (SegmentFilterExpressionList)

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

object (SegmentFilterExpression)

SegmentFilterExpression が notExpression の NOT である。

object (SegmentFilter)

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

object (SegmentEventFilter)

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

{
  "expressions": [
    {
      object (SegmentFilterExpression)
    }
  ]
}

object (SegmentFilterExpression)

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

{
  "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.
}

string

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

object (SegmentFilterScoping)

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

object (StringFilter)

文字列関連のフィルタ。

object (InListFilter)

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

object (NumericFilter)

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

object (BetweenFilter)

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

{
  "atAnyPointInTime": boolean
}

boolean

atAnyPointInTime が true の場合、このフィルタは、リクエストの期間内のイベントに対して true と評価されると、すべてのイベントで true と評価されます。

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

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

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

{
  "eventName": string,
  "segmentParameterFilterExpression": {
    object (SegmentParameterFilterExpression)
  }
}

string

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

object (SegmentParameterFilterExpression)

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

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

{

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

object (SegmentParameterFilterExpressionList)

andGroup の SegmentParameterFilterExpression は AND 関係です。

object (SegmentParameterFilterExpressionList)

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

object (SegmentParameterFilterExpression)

SegmentParameterFilterExpression が notExpression の NOT である。

object (SegmentParameterFilter)

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

{
  "expressions": [
    {
      object (SegmentParameterFilterExpression)
    }
  ]
}

object (SegmentParameterFilterExpression)

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

{
  "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.
}

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 つの値の間のフィルタ。

{
  "inAnyNDayPeriod": string
}

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-01 ～ 2021-11-01、2021-11-01 ～ 2021-11-02、2021-11-01 ～ 2021-11-03、2021-10-2011 ～ 2021-11-01 になります。

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

{
  "sequenceScoping": enum (UserCriteriaScoping),
  "sequenceMaximumDuration": string,
  "userSequenceSteps": [
    {
      object (UserSequenceStep)
    }
  ]
}

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 と一致するようにするには、イベントが各ステップを完了する必要があります。

{
  "isDirectlyFollowedBy": boolean,
  "stepScoping": enum (UserCriteriaScoping),
  "segmentFilterExpression": {
    object (SegmentFilterExpression)
  }
}

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)

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

{
  "userExclusionDuration": enum (UserExclusionDuration),
  "userExclusionCriteria": {
    object (UserSegmentCriteria)
  }
}

enum (UserExclusionDuration)

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

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

object (UserSegmentCriteria)

この条件を満たすユーザーは、userExclusionDuration のセグメントのメンバーから除外されます。

{
  "sessionInclusionCriteria": {
    object (SessionSegmentCriteria)
  },
  "exclusion": {
    object (SessionSegmentExclusion)
  }
}

object (SessionSegmentCriteria)

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

object (SessionSegmentExclusion)

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

{
  "andConditionGroups": [
    {
      object (SessionSegmentConditionGroup)
    }
  ]
}

object (SessionSegmentConditionGroup)

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

{
  "conditionScoping": enum (SessionCriteriaScoping),
  "segmentFilterExpression": {
    object (SegmentFilterExpression)
  }
}

enum (SessionCriteriaScoping)

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

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

object (SegmentFilterExpression)

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

{
  "sessionExclusionDuration": enum (SessionExclusionDuration),
  "sessionExclusionCriteria": {
    object (SessionSegmentCriteria)
  }
}

enum (SessionExclusionDuration)

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

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

object (SessionSegmentCriteria)

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

{
  "eventInclusionCriteria": {
    object (EventSegmentCriteria)
  },
  "exclusion": {
    object (EventSegmentExclusion)
  }
}

object (EventSegmentCriteria)

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

object (EventSegmentExclusion)

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

{
  "andConditionGroups": [
    {
      object (EventSegmentConditionGroup)
    }
  ]
}

object (EventSegmentConditionGroup)

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

{
  "conditionScoping": enum (EventCriteriaScoping),
  "segmentFilterExpression": {
    object (SegmentFilterExpression)
  }
}

enum (EventCriteriaScoping)

conditionScoping は常に EVENT_CRITERIA_WITHIN_SAME_EVENT になります。

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

object (SegmentFilterExpression)

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

{
  "eventExclusionDuration": enum (EventExclusionDuration),
  "eventExclusionCriteria": {
    object (EventSegmentCriteria)
  }
}

enum (EventExclusionDuration)

eventExclusionDuration は常に PERMANENTLY_EXCLUDE になります。

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

object (EventSegmentCriteria)

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

{

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

object (FilterExpressionList)

andGroup の FilterExpressions は AND 関係です。

object (FilterExpressionList)

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

object (FilterExpression)

FilterExpression が notExpression の NOT である。

object (Filter)

プリミティブ フィルタ。同じ FilterExpression で、フィルタのフィールド名はすべて、すべてのディメンションまたはすべての指標にする必要があります。

{
  "expressions": [
    {
      object (FilterExpression)
    }
  ]
}

object (FilterExpression)

フィルタ式のリスト。

{
  "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.
}

string

ディメンション名または指標名。ディメンションまたは指標で定義された名前を指定する必要があります。

object (StringFilter)

文字列関連のフィルタ。

object (InListFilter)

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

object (NumericFilter)

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

object (BetweenFilter)

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

{
  "dimensionHeaders": [
    {
      object (DimensionHeader)
    }
  ],
  "metricHeaders": [
    {
      object (MetricHeader)
    }
  ],
  "rows": [
    {
      object (Row)
    }
  ],
  "metadata": {
    object (FunnelResponseMetadata)
  }
}

object (DimensionHeader)

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

object (MetricHeader)

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

object (Row)

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

object (FunnelResponseMetadata)

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

{
  "name": string
}

string

ディメンションの名前。

{
  "name": string,
  "type": enum (MetricType)
}

string

指標の名前。

enum (MetricType)

指標のデータ型。

{
  "dimensionValues": [
    {
      object (DimensionValue)
    }
  ],
  "metricValues": [
    {
      object (MetricValue)
    }
  ]
}

object (DimensionValue)

リクエストされたディメンション値のリスト。ピボット レポートでは、ディメンションの値は、ピボットに含まれるディメンションに対してのみリストされます。

object (MetricValue)

リクエストされた表示可能な指標値のリスト。

{

  // Union field one_value can be only one of the following:
  "value": string
  // End of list of possible types for union field one_value.
}

string

ディメンション タイプが文字列の場合は、文字列の値。

{

  // Union field one_value can be only one of the following:
  "value": string
  // End of list of possible types for union field one_value.
}

string

測定値。タイプについては、MetricHeader をご覧ください。

{
  "samplingMetadatas": [
    {
      object (SamplingMetadata)
    }
  ]
}

object (SamplingMetadata)

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

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

{
  "samplesReadCount": string,
  "samplingSpaceSize": string
}

string (int64 format)

このサンプル レポートで特定の期間に読み取られたイベントの合計数。このファネル レポートで分析されたこのプロパティのデータのサブセットのサイズです。

string (int64 format)

このプロパティのデータに含まれるイベントのうち、特定の期間にこの目標到達プロセス レポートで分析できたものの合計数。サンプリングにより、より大きなデータセットに関する有意義な情報が得られます。これは、より大きなデータセットのサイズです。

このファネル レポートで使用された利用可能なデータの割合を計算するには、samplesReadCount/samplingSpaceSize を計算します。

{
  "tokensPerDay": {
    object (QuotaStatus)
  },
  "tokensPerHour": {
    object (QuotaStatus)
  },
  "concurrentRequests": {
    object (QuotaStatus)
  },
  "serverErrorsPerProjectPerHour": {
    object (QuotaStatus)
  },
  "potentiallyThresholdedRequestsPerHour": {
    object (QuotaStatus)
  },
  "tokensPerProjectPerHour": {
    object (QuotaStatus)
  }
}

object (QuotaStatus)

標準のアナリティクス プロパティでは 1 日あたり最大 20 万トークン、アナリティクス 360 プロパティでは 1 日あたり 200 万トークンを使用できます。ほとんどの場合、リクエストで使用するトークンは 10 個未満です。

object (QuotaStatus)

標準のアナリティクス プロパティでは 1 時間あたり最大 40,000 トークン、アナリティクス 360 プロパティでは 1 時間あたり 400,000 トークンを使用できます。API リクエストで消費されるトークンの数は 1 つだけです。その数は、1 時間、1 日、プロジェクトごとの 1 時間あたりのすべての割り当てから差し引かれます。

object (QuotaStatus)

標準のアナリティクス プロパティでは、最大 10 個の同時リクエストを送信できます。アナリティクス 360 プロパティでは、最大 50 個の同時リクエストを使用できます。

object (QuotaStatus)

サーバーエラーは、標準のアナリティクス プロパティとクラウド プロジェクトのペアでは 1 時間あたり最大 10 件、アナリティクス 360 プロパティとクラウド プロジェクトのペアでは 1 時間あたり最大 50 件です。

object (QuotaStatus)

アナリティクスのプロパティは、1 時間あたり最大 120 件のリクエストを送信でき、ディメンションにしきい値が設定されている可能性があります。バッチ リクエストでは、リクエストにしきい値が設定される可能性があるディメンションが含まれている場合、各レポート リクエストはこの割り当てに対して個別にカウントされます。

object (QuotaStatus)

アナリティクスのプロパティでは、1 プロジェクトあたり 1 時間あたり最大 35% のトークンを使用できます。つまり、標準のアナリティクス プロパティでは 1 プロジェクトあたり 1 時間あたり最大 14,000 トークン、アナリティクス 360 プロパティでは 1 プロジェクトあたり 1 時間あたり最大 140,000 トークンを使用できます。API リクエストで消費されるトークンの数は 1 つだけです。その数は、1 時間、1 日、プロジェクトごとの 1 時間あたりのすべての割り当てから差し引かれます。

{
  "consumed": integer,
  "remaining": integer
}

integer

このリクエストによって消費される割り当て。

integer

このリクエストの後に残っている割り当て。