Method: properties.runFunnelReport

Google アナリティクスのイベントデータのカスタマイズされた目標到達プロセス レポートを返します。API から返されるデータは、リクエストされたディメンションと指標の列を含む表形式です。

目標到達プロセスデータ探索では、ユーザーがコンバージョンに至るまでのステップをビジュアル表示し、各ステップでのユーザーの動向をすばやく確認できます。たとえば、見込み顧客がどのように買い物客になり、その後どのように顧客に変わるか、一見客がどのようにリピーターになるのかといったことです。こうした情報から、非効率なカスタマー ジャーニーや、放棄されるカスタマー ジャーニーの改善を図ることができます。詳しくは、GA4 のファネル データ探索をご覧ください。

この方法は、ベータ版に入る前に構文や機能に関するフィードバックを収集する目的で、アルファ版（安定版）で導入されています。この API についてのフィードバックをお寄せいただくには、Google Analytics Data API の目標到達プロセス レポートのフィードバックにご記入ください。

HTTP リクエスト

POST https://analyticsdata.googleapis.com/v1alpha/{property=properties/*}:runFunnelReport

この URL は gRPC Transcoding 構文を使用します。

パスパラメータ

パラメータ
property

string

省略可。イベントがトラッキングされる Google アナリティクス プロパティ ID。本文ではなく URL パスで指定します。詳しくは、プロパティ 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)

省略可。読み取るデータの日付範囲。複数の期間がリクエストされた場合、各レスポンス行にはゼロベースの期間インデックスが含まれます。2 つの期間が重複する場合、重複する日のイベントデータは、両方の期間のレスポンスの行に含まれます。
funnel

object (Funnel)

省略可。このリクエストの目標到達プロセスの設定。この目標到達プロセスの設定は必須です。
funnelBreakdown

object (FunnelBreakdown)

省略可。指定すると、この内訳が目標到達プロセスの表のサブレポート レスポンスにディメンションとして追加されます。この内訳ディメンションを使用すると、各目標到達プロセスのステップが内訳ディメンションの一意の値に拡張されます。たとえば、deviceCategory ディメンションの内訳では、mobile、tablet、desktop、合計の行が作成されます。
funnelNextAction

object (FunnelNextAction)

省略可。指定すると、次のアクションにより、目標到達プロセスの可視化サブレポートのレスポンスにディメンションが追加されます。この「次のアクション」ディメンションは、各目標到達プロセスのステップを、次のアクションの一意の値に拡張します。たとえば、eventName ディメンションの次のアクションでは、複数のイベント（session_start や click など）と合計の行が作成されます。

次の操作では、eventName と、pageTitle や pagePath などのほとんどのページ / スクリーンのディメンションのみがサポートされます。
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

省略可。このアナリティクス プロパティの割り当ての現在の状態を返すかどうかを切り替えます。割り当ては PropertyQuota で返されます。

レスポンスの本文

目標到達プロセス レポートのレスポンスには、2 つのサブレポートが含まれます。2 つのサブレポートは、ディメンションと指標の組み合わせが異なります。

成功した場合、レスポンスの本文には次の構造のデータが含まれます。

JSON 表現 
{
  "funnelTable": {
    object (FunnelSubReport)
  },
  "funnelVisualization": {
    object (FunnelSubReport)
  },
  "propertyQuota": {
    object (PropertyQuota)
  },
  "kind": string
}
フィールド
funnelTable

object (FunnelSubReport)

ファネル表は、ファネルのステップ、セグメント、内訳ディメンション、アクティブ ユーザー数、完了率、放棄数、放棄率を含むレポートです。

セグメント ディメンションは、セグメントがリクエストされた場合にのみ、このレスポンスに存在します。内訳ディメンションがこのレスポンスに含まれるのは、リクエストされた場合のみです。
funnelVisualization

object (FunnelSubReport)

目標到達プロセスの可視化は、目標到達プロセスのステップ、セグメント、日付、次のアクションのディメンション、アクティブ ユーザーを含むレポートです。

セグメント ディメンションは、セグメントがリクエストされた場合にのみ、このレスポンスに存在します。日付ディメンションがこのレスポンスに含まれるのは、TRENDED_FUNNEL 目標到達プロセス タイプでリクエストされた場合のみです。次のアクション ディメンションは、リクエストされた場合にのみレスポンスに含まれます。
propertyQuota

object (PropertyQuota)

このアナリティクス プロパティの割り当て状態（このリクエストを含む）。
kind

string

このメッセージのリソースの種類を示します。この kind は常に固定文字列「analyticsData#runFunnelReport」です。JSON でレスポンス タイプを区別する場合に便利です。

認可スコープ

次の OAuth スコープのいずれかが必要です。

  • https://www.googleapis.com/auth/analytics.readonly
  • https://www.googleapis.com/auth/analytics

ファネル

目標到達プロセス レポート リクエストで目標到達プロセスを構成します。目標到達プロセス レポートでは、ユーザーが一連のステップを経過する様子を確認できます。

目標到達プロセスデータ探索では、ユーザーがコンバージョンに至るまでのステップをビジュアル表示し、各ステップでのユーザーの動向をすばやく確認できます。たとえば、見込み顧客がどのように買い物客になり、その後どのように顧客に変わるか、一見客がどのようにリピーターになるのかといったことです。この情報から、非効率なカスタマー ジャーニーや、放棄されるカスタマー ジャーニーの改善を図ることができます。

JSON 表現 
{
  "isOpenFunnel": boolean,
  "steps": [
    {
      object (FunnelStep)
    }
  ]
}
フィールド
isOpenFunnel

boolean

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

object (FunnelStep)

このファネルの順序付けられたステップ。

FunnelStep

ステップでは、測定するカスタマー ジャーニーを定義します。ステップには、ユーザーがファネルの各ステップに含まれる条件を 1 つ以上含めます。

JSON 表現 
{
  "name": string,
  "isDirectlyFollowedBy": boolean,
  "filterExpression": {
    object (FunnelFilterExpression)
  },
  "withinDurationFromPriorStep": string
}
フィールド
name

string

このステップのわかりやすい名前。指定しない場合、ステップには 1 ベースの番号付きの名前が付けられます（例: 0. ", "1. 」など）を追加します。この名前は、funnelStepName ディメンションによって返される文字列値を定義します。たとえば、リクエストの 3 番目の目標到達プロセスのステップで 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 は省略可能です。指定しない場合、ステップは任意の時間で区切ることができます。

s で終わる小数 9 桁までの秒単位の期間。例: "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 に 1 種類のフィルタを指定します。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。1 種類のフィルタを指定します。one_filter は次のいずれかになります。
stringFilter

object (StringFilter)

文字列関連のフィルタ。
inListFilter

object (InListFilter)

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

object (NumericFilter)

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

object (BetweenFilter)

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

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 に 1 種類のフィルタを指定します。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 の下位フィルタでは、イベント パラメータまたはアイテム パラメータのいずれかを使用する必要があります。

アイテム パラメータは e コマース イベントでのみ使用できます。e コマース イベントについて詳しくは、e コマースの測定ガイドをご覧ください。
共用体フィールド one_filter。1 種類のフィルタを指定します。one_filter は次のいずれかになります。
stringFilter

object (StringFilter)

文字列関連のフィルタ。
inListFilter

object (InListFilter)

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

object (NumericFilter)

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

object (BetweenFilter)

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

FunnelBreakdown

内訳を使用すると、目標到達プロセスの表のサブレポート レスポンスにディメンションが追加されます。

JSON 表現 
{
  "breakdownDimension": {
    object (Dimension)
  },
  "limit": string
}
フィールド
breakdownDimension

object (Dimension)

目標到達プロセスの表のサブレポート レスポンスに追加されたディメンション列。内訳ディメンションを使用すると、各目標到達プロセスのステップを分類できます。funnelBreakdown が指定されている場合は、有効な breakdownDimension が必要です。
limit

string (int64 format)

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

FunnelNextAction

次のアクションは、ユーザーがステップを達成した後、同じユーザーが次のステップを達成するまでのディメンションの値を示します。たとえば、nextActionDimension が eventName の場合、i 番目の目標到達プロセスのステップの行の nextActionDimension は、ユーザーが i 番目の目標到達プロセスのステップに到達するイベントの後に発生し、ユーザーが i+1 番目の目標到達プロセスのステップに到達する前に発生した最初のイベントを返します。

JSON 表現 
{
  "nextActionDimension": {
    object (Dimension)
  },
  "limit": string
}
フィールド
nextActionDimension

object (Dimension)

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

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

string (int64 format)

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

FunnelVisualizationType

目標到達プロセスの可視化サブレポートのレスポンスに含まれるディメンションを制御します。

列挙型
FUNNEL_VISUALIZATION_TYPE_UNSPECIFIED 未指定のタイプ。
STANDARD_FUNNEL 標準のファネル（ステップ）レスポンスの目標到達プロセスのビジュアリゼーション サブレポートには日付は含まれません。
TRENDED_FUNNEL ファネルのトレンドグラフ（折れ線グラフ）。レスポンスの目標到達プロセスの可視化サブレポートには、日付ディメンションが含まれます。

セグメント

セグメントはアナリティクスのデータの一部です。たとえば、すべてのユーザーのうち、特定の国や都市のユーザーだけを 1 つのセグメントに設定したり、また、特定の商品ラインを購入したユーザーや、サイトの特定のページにアクセスしたユーザー、アプリで特定のイベントをトリガーしたユーザーを別のセグメントに指定したりすることができます。

詳しくは、セグメント ビルダーをご覧ください。

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。セグメントは 1 つのスコープで指定します。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 のそれぞれに一致している必要があります。andSequenceGroups が指定されている場合、andConditionGroups は空にできます。
andSequenceGroups[]

object (UserSegmentSequenceGroup)

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

UserSegmentConditionGroup

条件を指定すると、セグメントに含めるデータや、セグメントから除外するデータを選択できます。

JSON 表現 
{
  "conditionScoping": enum (UserCriteriaScoping),
  "segmentFilterExpression": {
    object (SegmentFilterExpression)
  }
}
フィールド
conditionScoping

enum (UserCriteriaScoping)

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

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

object (SegmentFilterExpression)

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

UserCriteriaScoping

スコープでは、ユーザーが条件を満たしているかどうかを評価する際に考慮するイベントを指定します。

列挙型
USER_CRITERIA_SCOPING_UNSPECIFIED 未指定の条件のスコープ。指定しないでください。
USER_CRITERIA_WITHIN_SAME_EVENT 1 つのイベント内で条件が満たされた場合、そのユーザーは条件に一致します。
USER_CRITERIA_WITHIN_SAME_SESSION 1 回のセッションで条件が満たされた場合、そのユーザーは条件を満たしています。
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 に 1 種類のフィルタを指定します。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 に 1 種類のフィルタを指定します。one_filter は次のいずれかになります。
stringFilter

object (StringFilter)

文字列関連のフィルタ。
inListFilter

object (InListFilter)

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

object (NumericFilter)

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

object (BetweenFilter)

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

SegmentFilterScoping

スコープでは、セグメント フィルタを評価する際に複数のイベントのディメンションと指標をどのように考慮するかを指定します。

JSON 表現 
{
  "atAnyPointInTime": boolean
}
フィールド
atAnyPointInTime

boolean

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

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

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

条件のスコープが 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 に 1 種類のフィルタを指定します。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 の下位フィルタでは、イベント パラメータまたはアイテム パラメータのいずれかを使用する必要があります。

アイテム パラメータは e コマース イベントでのみ使用できます。e コマース イベントについて詳しくは、e コマースの測定ガイドをご覧ください。
共用体フィールド one_filter。1 種類のフィルタを指定します。one_filter は次のいずれかになります。
stringFilter

object (StringFilter)

文字列関連のフィルタ。
inListFilter

object (InListFilter)

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

object (NumericFilter)

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

object (BetweenFilter)

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

SegmentParameterFilterScoping

スコープでは、セグメント パラメータ フィルタの評価時に複数のイベントをどのように考慮するかを指定します。

JSON 表現 
{
  "inAnyNDayPeriod": string
}
フィールド
inAnyNDayPeriod

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 は各イベントに個別に適用されます。

UserSegmentSequenceGroup

ユーザーがセグメントのメンバーになるために特定の順序で発生する必要がある条件を定義します。

JSON 表現 
{
  "sequenceScoping": enum (UserCriteriaScoping),
  "sequenceMaximumDuration": string,
  "userSequenceSteps": [
    {
      object (UserSequenceStep)
    }
  ]
}
フィールド
sequenceScoping

enum (UserCriteriaScoping)

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

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

string (Duration format)

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

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

s で終わる小数 9 桁までの秒単位の期間。例: "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 の場合、ユーザーがシーケンスを一致させるには、このシーケンスの手順を 1 回のセッションで完了する必要があります。stepScoping = ACROSS_ALL_SESSIONS は、sequenceScoping = ACROSS_ALL_SESSIONS の場合にのみ許可されます。

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

object (SegmentFilterExpression)

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

UserSegmentExclusion

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

JSON 表現 
{
  "userExclusionDuration": enum (UserExclusionDuration),
  "userExclusionCriteria": {
    object (UserSegmentCriteria)
  }
}
フィールド
userExclusionDuration

enum (UserExclusionDuration)

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

省略可。指定しない場合、USER_EXCLUSION_TEMPORARY の userExclusionDuration が使用されます。
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

条件を指定すると、セグメントに含めるデータや、セグメントから除外するデータを選択できます。

JSON 表現 
{
  "conditionScoping": enum (SessionCriteriaScoping),
  "segmentFilterExpression": {
    object (SegmentFilterExpression)
  }
}
フィールド
conditionScoping

enum (SessionCriteriaScoping)

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

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

object (SegmentFilterExpression)

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

SessionCriteriaScoping

スコープでは、セッションが条件を満たしているかどうかを評価する際に考慮されるイベントを指定します。

列挙型
SESSION_CRITERIA_SCOPING_UNSPECIFIED 未指定の条件のスコープ。指定しないでください。
SESSION_CRITERIA_WITHIN_SAME_EVENT 1 つのイベント内で条件が満たされた場合、セッションは条件に一致します。
SESSION_CRITERIA_WITHIN_SAME_SESSION 1 つのセッション内で条件が満たされた場合、そのセッションは条件に一致します。

SessionSegmentExclusion

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

JSON 表現 
{
  "sessionExclusionDuration": enum (SessionExclusionDuration),
  "sessionExclusionCriteria": {
    object (SessionSegmentCriteria)
  }
}
フィールド
sessionExclusionDuration

enum (SessionExclusionDuration)

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

省略可。指定しない場合は、SESSION_EXCLUSION_TEMPORARY の sessionExclusionDuration が使用されます。
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

条件を指定すると、セグメントに含めるデータや、セグメントから除外するデータを選択できます。

JSON 表現 
{
  "conditionScoping": enum (EventCriteriaScoping),
  "segmentFilterExpression": {
    object (SegmentFilterExpression)
  }
}
フィールド
conditionScoping

enum (EventCriteriaScoping)

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

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

object (SegmentFilterExpression)

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

EventCriteriaScoping

スコープでは、イベントが条件を満たしているかどうかを評価する際に考慮するイベントを指定します。

列挙型
EVENT_CRITERIA_SCOPING_UNSPECIFIED 未指定の条件のスコープ。指定しないでください。
EVENT_CRITERIA_WITHIN_SAME_EVENT 1 つのイベント内で条件が満たされた場合、そのイベントは条件に一致します。

EventSegmentExclusion

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

JSON 表現 
{
  "eventExclusionDuration": enum (EventExclusionDuration),
  "eventExclusionCriteria": {
    object (EventSegmentCriteria)
  }
}
フィールド
eventExclusionDuration

enum (EventExclusionDuration)

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

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

object (EventSegmentCriteria)

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

EventExclusionDuration

イベントが eventExclusionCriteria と一致した場合の除外期間のオプションを列挙します。

列挙型
EVENT_EXCLUSION_DURATION_UNSPECIFIED 除外期間が指定されていません。指定しないでください。
EVENT_EXCLUSION_PERMANENT イベントが eventExclusionCriteria 条件を満たした場合、そのイベントをセグメントから完全に除外します。

FunnelSubReport

目標到達プロセスのサブレポートには、ディメンションと指標のデータ値が含まれます。たとえば、12 人のユーザーが目標到達プロセスの 2 番目のステップに到達しました。

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)

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

FunnelResponseMetadata

目標到達プロセス レポートのレスポンス メタデータには、目標到達プロセス レポートに関する追加情報が含まれます。

JSON 表現 
{
  "samplingMetadatas": [
    {
      object (SamplingMetadata)
    }
  ]
}
フィールド
samplingMetadatas[]

object (SamplingMetadata)

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

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