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 プロパティの識別子。本文ではなく 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)

（省略可）セグメントの設定。セグメントはプロパティのデータのサブセットです。セグメントを含むファネル レポートでは、ファネルはセグメントごとに評価されます。

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

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

DateRange

連続する日付のセット: 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)

この目標到達プロセスの連続するステップ。

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

StringFilter

文字列のフィルタ

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 の場合、文字列値で大文字と小文字が区別されます。

NumericFilter

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

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 には次のいずれか 1 つだけを指定できます。
int64Value

string (int64 format)

整数値
doubleValue

number

double 値

BetweenFilter

結果が 2 つの数値の間（両端を含む）でなければならないことを示すため。

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

object (NumericValue)

次の番号で始まります。
toValue

object (NumericValue)

末尾がこの番号になります。

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 の NOT です。
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)

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

ディメンション

ディメンションはデータの属性です。たとえば、ディメンション「city」は、イベントが発生した都市を示します。レポートのレスポンスのディメンション値は文字列です。たとえば、都市は「Paris」や「New York」になります。

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

string

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

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

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

object (DimensionExpression)

1 つの Dimension が、複数の Dimension の式の結果である場合もあります。例: ディメンション「country, city」: concatenate(country, ", ", city)。

DimensionExpression

複数のディメンションの数式の結果であるディメンションを表現するために使用します。使用例: 1)lowerCase(dimension) 2) concatenate(dimension1, symbol, 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」: concatenate(country, ", ", city)。

CaseExpression

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

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

string

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

ConcatenateExpression

ディメンション値を 1 つのディメンションにまとめるために使用します。

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

string

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

string

ディメンション名を区切る区切り文字。

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

FunnelNextAction

「次のアクション」は、ユーザーが 1 歩を達成してから、同じユーザーが次のステップを達成する前のディメンションの値を示します。たとえば、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)

レスポンスで返す内訳ディメンションの個別値の最大数。上限が指定されていない場合は、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. セグメント」、「2. Segment] など）。
共用体フィールド 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 あるイベントで条件が満たされた場合、ユーザーはその条件に合致します。
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_count」、フィルタの条件が 5 より大きい場合、このフィルタでは、レポート期間内の連続する 3 日の期間ごとに購入イベントのイベント数が累積され、ユーザーはこのフィルタの基準を満たし、連続する 3 日間の購入イベント数が 5 を超えると、このフィルタの条件を満たします。たとえば、2021 年 11 月 1 日～ 2021 年 11 月 3 日、2021 年 11 月 2 日～ 2021 年 11 月 4 日、2021 年 11 月 3 日～ 2021 年 11 月 5 日などが検討されます。

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

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

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

object (SegmentFilterExpression)

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

SessionCriteriaScoping

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

列挙型
SESSION_CRITERIA_SCOPING_UNSPECIFIED 条件のスコープが指定されていません。指定しないでください。
SESSION_CRITERIA_WITHIN_SAME_EVENT あるイベントで条件が満たされた場合、そのセッションは条件に一致します。
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 あるイベント内で条件が満たされた場合、そのイベントは条件を満たしています。

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 の条件を満たす場合は、セグメントからイベントを完全に除外します。

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

レポートの指標列について説明します。レポートでリクエストされた表示可能な指標により、行と MetricHeaders 内に列エントリが生成されます。ただし、フィルタや式でのみ使用される指標ではレポートに列が作成されません。それに応じて、ヘッダーも作成されません。

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 キロメートル単位の長さ。特別な浮動小数点型。

行

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

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

たとえば、eventName が「in_app_purchase」、countryId が「JP」、eventCount が 15 の行は次のようになります。

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

object (DimensionValue)

リクエストされたディメンション値のリスト。PivotReport では、dimensionValues はピボットに含まれるディメンションに対してのみリストされます。
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)

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

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

SamplingMetadata

ファネル レポートの結果がサンプリングされている場合、このメタデータは、このファネル レポートが特定の期間に使用されたイベントの割合（%）を示します。サンプリングとは、大規模なデータセットから有意義な情報を明らかにするために、すべてのデータのサブセットを分析する手法です。

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

QuotaStatus

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

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

integer

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

integer

このリクエストの完了後に残った割り当て。