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 アナリティクス GA4 プロパティ 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)

読み込むデータの期間。複数の期間をリクエストした場合、各レスポンス行には 0 から始まる期間インデックスが含まれます。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)

セグメントの構成。セグメントはプロパティのデータのサブセットです。セグメントを含む目標到達プロセス レポートでは、目標到達プロセスは各セグメントで評価されます。

このリクエストで指定された各セグメントは、レスポンスで別々の行を生成します。レスポンスでは、各セグメントは名前によって識別されます。

Segments パラメータは省略可能です。リクエストは 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

期間

連続する日数のセット: startDate、startDate + 1、...、endDate。リクエストは最大 4 つの期間で許可されます。

JSON 表現 
{
  "startDate": string,
  "endDate": string,
  "name": string
}
フィールド
startDate

string

クエリを含む開始日（YYYY-MM-DD 形式）。endDate より後にすることはできません。NdaysAgo、yesterday、today の形式も使用できます。この場合、宿泊施設のレポートのタイムゾーンに基づいて日付が推測されます。
endDate

string

クエリを含む終了日。YYYY-MM-DD の形式で指定します。startDate より前の日付は指定できません。NdaysAgo、yesterday、today の形式も使用できます。この場合、宿泊施設のレポートのタイムゾーンに基づいて日付が推測されます。
name

string

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

ファネル

目標到達プロセス レポート リクエストで目標到達プロセスを設定します。目標到達プロセスは、一連のステップを通過したユーザーをレポートします。

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

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

boolean

オープン型の目標到達プロセスでは、ユーザーはどのステップでも目標到達プロセスに入ることができます。クローズド型の目標到達プロセスでは、ユーザーは最初のステップで目標到達プロセスに入る必要があります。（省略可）指定しない場合は、クローズド型の目標到達プロセスが使用されます。
steps[]

object (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 は省略可能です。指定しない場合、ステップは任意の時間で区切られます。

小数点以下 9 桁以下で指定し、末尾が「s」で終わる秒数。例: "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)

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

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

文字列フィルタ

文字列のフィルタ

JSON 表現 
{
  "matchType": enum (MatchType),
  "value": string,
  "caseSensitive": boolean
}
フィールド
matchType

enum (MatchType)

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

string

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

boolean

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

MatchType

文字列フィルタのマッチタイプ

列挙型
MATCH_TYPE_UNSPECIFIED 指定なし
EXACT 文字列値の完全一致。
BEGINS_WITH 文字列値で始まります。
ENDS_WITH 文字列値で終わります。
CONTAINS 文字列値が含まれます。
FULL_REGEXP 正規表現に文字列値と完全に一致。
PARTIAL_REGEXP 正規表現を文字列値に部分一致で照合します。

InListFilter

結果は文字列値のリストである必要があります。

JSON 表現 
{
  "values": [
    string
  ],
  "caseSensitive": boolean
}
フィールド
values[]

string

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

boolean

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

数値フィルタ

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

JSON 表現 
{
  "operation": enum (Operation),
  "value": {
    object (NumericValue)
  }
}
フィールド
operation

enum (Operation)

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

object (NumericValue)

数値または日付の値。

オペレーション

数値フィルタに適用されたオペレーション

列挙型
OPERATION_UNSPECIFIED （指定なし）
EQUAL 等しい
LESS_THAN 次より小さい
LESS_THAN_OR_EQUAL 次の値以下
GREATER_THAN 次の値を上回る
GREATER_THAN_OR_EQUAL 次の値以上

NumericValue

数値を表す。

JSON 表現 
{

  // 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.
}
フィールド
共用体フィールド one_value。one_value には、次のいずれかの値のみを指定できます。
int64Value

string (int64 format)

整数値
doubleValue

number

double 値

範囲のフィルタ

結果が 2 つの数値（両端を含む）でなければならないことを表します。

JSON 表現 
{
  "fromValue": {
    object (NumericValue)
  },
  "toValue": {
    object (NumericValue)
  }
}
フィールド
fromValue

object (NumericValue)

この数字から始まります。
toValue

object (NumericValue)

末尾はこの数字です。

FunnelEventFilter

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

JSON 表現 
{
  "eventName": string,
  "funnelParameterFilterExpression": {
    object (FunnelParameterFilterExpression)
  }
}
フィールド
eventName

string

このフィルタは、この 1 つのイベント名のイベントに一致します。イベント名は必須です。
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 つの値のフィルタ。

目標到達プロセスの内訳

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

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

object (Dimension)

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

string (int64 format)

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

ディメンション

ディメンションはデータの属性です。たとえば、ディメンション city は、イベントが発生した都市を示します。レポート レスポンスのディメンションの値は文字列です。たとえば、都市は「パリ」や「ニューヨーク」などです。

JSON 表現 
{
  "name": string,
  "dimensionExpression": {
    object (DimensionExpression)
  }
}
フィールド
name

string

ディメンションの名前。ディメンション名のリストについては、API ディメンションをご覧ください。

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

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

object (DimensionExpression)

1 つのディメンションは、複数のディメンションの式の結果になります。たとえば、ディメンション「country, city」は連結（country、"、"、city）になります。

DimensionExpression

複数のディメンションの数式の結果であるディメンションを表現するために使用されます。使用例: 1）lowerCase（dimension）2）concatate（dimension1、symb、dimension2）。

JSON 表現 
{

  // 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.
}
フィールド
共用体フィールド one_expression。DimensionExpression のディメンション式を 1 種類指定します。one_expression は次のいずれかになります。
lowerCase

object (CaseExpression)

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

object (CaseExpression)

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

object (ConcatenateExpression)

ディメンション値を 1 つのディメンションに組み合わせるために使用します。たとえば、ディメンション「country, city」は連結（country、"、"、city）になります。

ケース式

ディメンション値を 1 つのケースに変換するために使用します。

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

string

ディメンションの名前。この名前は、リクエストのディメンション フィールドの名前を参照しなければなりません。

連結式

ディメンション値を 1 つのディメンションに組み合わせるために使用します。

JSON 表現 
{
  "dimensionNames": [
    string
  ],
  "delimiter": string
}
フィールド
dimensionNames[]

string

ディメンションの名前。この名前は、リクエストのディメンション フィールドの名前を参照しなければなりません。
delimiter

string

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

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

FunnelNextAction

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

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

object (Dimension)

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

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

string (int64 format)

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

FunnelVisualizationType（目標到達プロセスの可視化タイプ）

目標到達プロセスの可視化サブレポート レスポンスに存在するディメンションを管理します。

列挙型
FUNNEL_VISUALIZATION_TYPE_UNSPECIFIED 未指定のタイプ。
STANDARD_FUNNEL 標準の（段階的な）目標到達プロセスレスポンスの目標到達プロセス サブレポートに日付は含まれません。
TRENDED_FUNNEL 目標到達プロセス（折れ線グラフ）レスポンスの目標到達プロセスのサブレポートには、日付ディメンションが含まれます。

分類して表示

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

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

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 ディメンションから返される文字列値を定義します。segment ディメンションでは、リクエスト内のセグメントを表す 1 から始まるインデックス番号がセグメント名の先頭に付加されます（例: 1）。Segment」、「2. Segment」など）。
共用体フィールド one_segment_scope。セグメントは 1 つのスコープで指定します。one_segment_scope は次のいずれかになります。
userSegment

object (UserSegment)

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

object (SessionSegment)

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

object (EventSegment)

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

ユーザー セグメント

ユーザー セグメントは、サイトやアプリになんらかの形で関わったユーザーのサブセットで、商品を購入したことがあるユーザーや、ショッピング カートに商品を追加したものの、購入はしていないユーザーなどが該当します。

JSON 表現 
{
  "userInclusionCriteria": {
    object (UserSegmentCriteria)
  },
  "exclusion": {
    object (UserSegmentExclusion)
  }
}
フィールド
userInclusionCriteria

object (UserSegmentCriteria)

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

object (UserSegmentExclusion)

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

ユーザー セグメントの条件

ユーザーのイベントが条件の条件を満たしている場合、ユーザーはその条件に一致することになります。

JSON 表現 
{
  "andConditionGroups": [
    {
      object (UserSegmentConditionGroup)
    }
  ],
  "andSequenceGroups": [
    {
      object (UserSegmentSequenceGroup)
    }
  ]
}
フィールド
andConditionGroups[]

object (UserSegmentConditionGroup)

ユーザーがこの andConditionGroups と andSequenceGroups のそれぞれに一致する場合、この基準に一致します。andSequenceGroups が指定されている場合、andConditionGroups は空になる可能性があります。
andSequenceGroups[]

object (UserSegmentSequenceGroup)

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

ユーザー セグメントの条件グループ

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

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)

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

ユーザー条件のスコープ設定

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

列挙型
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)

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

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

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

JSON 表現 
{
  "eventName": string,
  "segmentParameterFilterExpression": {
    object (SegmentParameterFilterExpression)
  }
}
フィールド
eventName

string

このフィルタは、この 1 つのイベント名のイベントに一致します。イベント名は必須です。
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_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 月 1 日～ 2021 年 11 月 1 日、2021 年 11 月 1 日～ 2021 年 11 月 2 日、2021 年 11 月 1 日～ 2021 年 11 月 3 日、2021 年 10 月 1 日～ 2021 年 11 月 2 日になります。

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

ユーザー セグメント シーケンス グループ

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

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 は省略可能です。指定しなかった場合は、任意の順序でシーケンスを完了できます。

小数点以下 9 桁以下で指定し、末尾が「s」で終わる秒数。例: "3.5s"。
userSequenceSteps[]

object (UserSequenceStep)

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

ユーザー シーケンスのステップ

このユーザーがシーケンスに一致するためには、指定したステップの順序で発生する条件。

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)

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

ユーザー セグメントの除外

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

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

enum (UserExclusionDuration)

ユーザーが userExclusionCriteria に一致する場合に除外の有効期限を指定します。

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

object (UserSegmentCriteria)

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

ユーザー除外期間

ユーザーが userExclusionCriteria に一致した場合に除外される期間を列挙します。

列挙型
USER_EXCLUSION_DURATION_UNSPECIFIED 除外期間が指定されていません。指定しないでください。
USER_EXCLUSION_TEMPORARY ユーザーが userExclusionCriteria 条件を満たしている期間中に、セグメントからユーザーを一時的に除外します。
USER_EXCLUSION_PERMANENT ユーザーが userExclusionCriteria 条件を満たしたことがある場合は、ユーザーをセグメントから完全に除外します。

セッション セグメント

セッション セグメントｆとはサイトやアプリで発生したセッションのサブセットのことで、特定の広告キャンペーンから発生したすべてのセッションなどが該当します。

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 条件を満たしている場合は、セッションをセグメントから完全に除外します。

イベント セグメント

イベント セグメントは、サイトやアプリでトリガーされたイベントのサブセットで、特定の場所で発生したすべての購入イベントや、特定のオペレーティング システムで発生した app_exception イベントなどが該当します。

JSON 表現 
{
  "eventInclusionCriteria": {
    object (EventSegmentCriteria)
  },
  "exclusion": {
    object (EventSegmentExclusion)
  }
}
フィールド
eventInclusionCriteria

object (EventSegmentCriteria)

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

object (EventSegmentExclusion)

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

イベント セグメント条件

イベントは、イベントが条件に適合する場合に一致します。

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

object (EventSegmentConditionGroup)

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

イベント セグメント条件グループ

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

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)

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

イベント条件のスコープ設定

スコープ指定では、イベントが条件を満たしているかどうかを判断する際に、検討するイベントを指定します。

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

イベント セグメントの除外

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

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

enum (EventExclusionDuration)

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

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

object (EventSegmentCriteria)

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

イベントの除外期間

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

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

FilterExpression

ディメンションまたは指標のフィルタを表します。同じ FilterExpression のフィールドは、すべてのディメンションまたは指標のいずれかにする必要があります。

JSON 表現 
{

  // 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.
}
フィールド
共用体フィールド expr。FilterExpression のフィルタ式を 1 種類指定します。expr は次のいずれかになります。
andGroup

object (FilterExpressionList)

andGroup の FilterExpressions は AND 関係にある。
orGroup

object (FilterExpressionList)

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

object (FilterExpression)

FilterExpression が NOTExpression ではない。
filter

object (Filter)

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

FilterExpressionList

フィルタ式のリスト。

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

object (FilterExpression)

フィルタ式のリスト。

フィルタ

ディメンション値または指標値をフィルタする式。

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。Filter のフィルタを 1 種類指定します。one_filter は次のいずれかになります。
stringFilter

object (StringFilter)

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

object (InListFilter)

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

object (NumericFilter)

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

object (BetweenFilter)

2 つの値のフィルタ。

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)

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

DimensionHeader

レポートのディメンション列を記述します。レポートでリクエストされるディメンションによって、行と DimensionHeaders 内に列エントリが生成されます。ただし、フィルタや式内でのみ使用されるディメンションは、レポート内に列を生成しません。したがって、これらのディメンションはヘッダーを生成しません。

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

string

ディメンションの名前。

MetricHeader

レポートの指標列を記述します。レポートでリクエストされる指標を表示すると、行と MetricHeader 内に列エントリが生成されます。ただし、フィルタや式内でのみ使用される指標では、レポート内の列は生成されません。したがって、これらの指標はヘッダーを生成しません。

JSON 表現 
{
  "name": string,
  "type": enum (MetricType)
}
フィールド
name

string

指標の名前。
type

enum (MetricType)

指標のデータ型。

MetricType

指標の値の型。

列挙型
METRIC_TYPE_UNSPECIFIED 未指定のタイプ。
TYPE_INTEGER 整数型。
TYPE_FLOAT 浮動小数点型。
TYPE_SECONDS 再生時間（秒）: 特別な浮動小数点型。
TYPE_MILLISECONDS ミリ秒単位の時間。特殊な浮動小数点型です。
TYPE_MINUTES 所要時間（分単位）。特殊な浮動小数点型です。
TYPE_HOURS 時間（時間）。特別な浮動小数点型。
TYPE_STANDARD 標準タイプのカスタム指標。特殊な浮動小数点型です。
TYPE_CURRENCY 金額（特別な浮動小数点型）。
TYPE_FEET 長さ（フィート）。特別な浮動小数点型。
TYPE_MILES 長さ: マイル、特別な浮動小数点型。
TYPE_METERS メートル単位の長さ。特殊な浮動小数点型です。
TYPE_KILOMETERS キロメートル単位の長さ。特殊な浮動小数点型です。

Row

各行のデータをレポートします。たとえば、RunReportRequest に次が含まれているとします。

"dimensions": [
  {
    "name": "eventName"
  },
  {
    "name": "countryId"
  }
],
"metrics": [
  {
    "name": "eventCount"
  }
]

1 つの行で、イベント名が「in_app_purchase」、countryId が「JP」、イベント数が 15 の場合は、次のようになります。

"dimensionValues": [
  {
    "value": "in_app_purchase"
  },
  {
    "value": "JP"
  }
],
"metricValues": [
  {
    "value": "15"
  }
]
JSON 表現 
{
  "dimensionValues": [
    {
      object (DimensionValue)
    }
  ],
  "metricValues": [
    {
      object (MetricValue)
    }
  ]
}
フィールド
dimensionValues[]

object (DimensionValue)

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

object (MetricValue)

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

DimensionValue

ディメンションの値。

JSON 表現 
{

  // Union field one_value can be only one of the following:
  "value": string
  // End of list of possible types for union field one_value.
}
フィールド
共用体フィールド one_value。ディメンション値 one_value には、次のいずれか 1 つのみを指定できます。
value

string

ディメンションの型が文字列の場合は、文字列として値。

MetricValue

指標の値。

JSON 表現 
{

  // Union field one_value can be only one of the following:
  "value": string
  // End of list of possible types for union field one_value.
}
フィールド
共用体フィールド one_value。指標値 one_value は次のいずれかになります。
value

string

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

FunnelResponseMetadata

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

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

object (SamplingMetadata)

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

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

サンプリング メタデータ

目標到達プロセス レポートの結果をサンプリングする場合、この目標到達プロセス レポートで一定の期間に使用されたイベントの割合を示すメタデータです。サンプリングとは、大規模なデータセットから有益な情報を見つけるために、すべてのデータのサブセットを分析する手法のことです。

JSON 表現 
{
  "samplesReadCount": string,
  "samplingSpaceSize": string
}
フィールド
samplesReadCount

string (int64 format)

特定の期間に実行されたこのサンプル レポートで読み取られたイベントの合計数。この目標到達プロセス レポートで分析された、このプロパティのデータのサブセットのサイズです。
samplingSpaceSize

string (int64 format)

このプロパティのデータに存在し、目標到達プロセスレポートで一定期間に分析できたイベントの総数です。サンプリングにより、大規模データセットに関する重要な情報が明らかになり、これが大規模なデータセットのサイズとなります。

この目標到達プロセス レポートで使用可能なデータの割合を計算するには、samplesReadCount/samplingSpaceSize を計算します。

PropertyQuota

このアナリティクス プロパティのすべての割り当ての現在の状態。プロパティの割り当てが上限に達すると、そのプロパティへのすべてのリクエストでリソース不足エラーが返されます。

JSON 表現 
{
  "tokensPerDay": {
    object (QuotaStatus)
  },
  "tokensPerHour": {
    object (QuotaStatus)
  },
  "concurrentRequests": {
    object (QuotaStatus)
  },
  "serverErrorsPerProjectPerHour": {
    object (QuotaStatus)
  },
  "potentiallyThresholdedRequestsPerHour": {
    object (QuotaStatus)
  },
  "tokensPerProjectPerHour": {
    object (QuotaStatus)
  }
}
フィールド
tokensPerDay

object (QuotaStatus)

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

object (QuotaStatus)

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

object (QuotaStatus)

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

object (QuotaStatus)

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

object (QuotaStatus)

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

object (QuotaStatus)

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

QuotaStatus

特定の割り当てグループの現在の状態。

JSON 表現 
{
  "consumed": integer,
  "remaining": integer
}
フィールド
consumed

integer

このリクエストによって使用された割り当て。
remaining

integer

このリクエストの後に割り当てが残ります。