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 ディメンション別に内訳を表示すると、mobiletabletdesktop、および合計の行が作成されます。

funnelNextAction

object (FunnelNextAction)

(省略可)指定すると、次のアクションにより、目標到達プロセスのビジュアリゼーションのサブレポートのレスポンスにディメンションが追加されます。この「次のアクション」ディメンションにより、ファネルの各ステップが次のアクションの固有の値に展開されます。たとえば、「eventName」ディメンションの次のアクションでは、複数のイベント(session_startclick など)と合計の行が作成されます。

次のアクションは、eventName と、ほとんどのページ / スクリーン ディメンション(pageTitlepagePath など)のみをサポートしています。

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

startDatestartDate + 1、...、endDate のように連続した日付のセット。リクエストには最大 4 つの期間を指定できます。

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

string

クエリの開始日(包括的開始日)。YYYY-MM-DD の形式で指定します。endDate より後にすることはできません。NdaysAgoyesterdaytoday の形式も使用できます。この場合、日付はプロパティのレポートのタイムゾーンに基づいて推測されます。

endDate

string

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

name

string

この期間に名前を割り当てます。レポートのレスポンスでは、ディメンション dateRange にこの名前が付けられます。設定した場合、date_range_ または RESERVED_ で始めることはできません。設定しない場合、期間の名前はリクエスト内のゼロから始まるインデックス(date_range_0date_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.
}
フィールド
共用体フィールド exprFunnelFilterExpression のフィルタを 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 つの値の間のフィルタ。

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 は、次のいずれかになります。
int64Value

string (int64 format)

整数値

doubleValue

number

double 値

BetweenFilter

結果が 2 つの数値の間にある必要があることを表す。

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

object (NumericValue)

この番号で始まります。

toValue

object (NumericValue)

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

FunnelEventFilter

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

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.
}
フィールド
共用体フィールド exprFunnelParameterFilterExpression のフィルタを 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 配列にパラメータとして記録されます。商品アイテム パラメータには、「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)

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

ディメンション

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

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

string

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

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

ディメンションは、dimensionFilterorderBysdimensionExpressionpivotsname によって参照されます。

dimensionExpression

object (DimensionExpression)

1 つのディメンションが、複数のディメンションの式の結果である場合もあります。たとえば、ディメンション「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_expressionDimensionExpression に 1 種類のディメンション式を指定します。one_expression は次のいずれかになります。
lowerCase

object (CaseExpression)

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

upperCase

object (CaseExpression)

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

concatenate

object (ConcatenateExpression)

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

CaseExpression

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

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 ステップを達成した後、同じユーザーが次のステップを達成する前のディメンションの値を示します。たとえば、nextActionDimensioneventName の場合、i 番目のファネルのステップ行の nextActionDimension は、ユーザーがファネルの i 番目のステップに到達したイベントの後、i+1 番目のファネルのステップを達成する前の最初のイベントを返します。

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

object (Dimension)

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

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

limit

string (int64 format)

レスポンスで返す内訳ディメンションの個別の値の最大数。上限が指定されていない場合は、5limit が使用されます。上限は 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. セグメント」など)。

共用体フィールド 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)

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

andSequenceGroups[]

object (UserSegmentSequenceGroup)

ユーザーがこれらの andSequenceGroupsandConditionGroups のそれぞれにマッチした場合、この条件に一致することになります。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.
}
フィールド
共用体フィールド exprSegmentFilterExpression のフィルタを 1 つ指定します。expr は次のいずれかになります。
andGroup

object (SegmentFilterExpressionList)

andGroup の SegmentFilterExpression は AND 関係にあります。

orGroup

object (SegmentFilterExpressionList)

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

notExpression

object (SegmentFilterExpression)

SegmentFilterExpression は notExpression の NOT です。

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_filterFilter のフィルタを 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

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

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.
}
フィールド
共用体フィールド exprSegmentParameterFilterExpression のフィルタを 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 配列にパラメータとして記録されます。商品アイテム パラメータには、「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 年 11 月 11 日~ 2021 年 11 月 11 日~ 2021 年 11 月 11 日となります。

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 の場合にのみ許可されます。

(省略可)指定しない場合、stepScopingsequenceScoping と同じ UserCriteriaScoping を使用します。

segmentFilterExpression

object (SegmentFilterExpression)

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

UserSegmentExclusion

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

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

enum (UserExclusionDuration)

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

(省略可)指定しない場合は、USER_EXCLUSION_TEMPORARYuserExclusionDuration が使用されます。

userExclusionCriteria

object (UserSegmentCriteria)

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

UserExclusionDuration

ユーザーが userExclusionCriteria と一致する場合に除外の有効期間を列挙します。

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

SessionSegment

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

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_SESSIONconditionScoping が使用されます。

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_TEMPORARYsessionExclusionDuration が使用されます。

sessionExclusionCriteria

object (SessionSegmentCriteria)

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

SessionExclusionDuration

セッションが sessionExclusionCriteria と一致する場合に除外の存続期間を指定するオプションを列挙します。

列挙型
SESSION_EXCLUSION_DURATION_UNSPECIFIED 除外期間が指定されていません。指定しないでください。
SESSION_EXCLUSION_TEMPORARY セッションが「sessionExclusionCriteria」条件を満たす期間中は、セグメントからセッションを一時的に除外します。
SESSION_EXCLUSION_PERMANENT セッションが「sessionExclusionCriteria」条件を満たしている場合、そのセッションをセグメントから完全に除外します。

EventSegment

イベント セグメントは、サイトやアプリで発生したイベントのサブセットです。たとえば、特定の地域で発生したすべての purchase イベントや、特定のオペレーティング システムで発生した 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_EVENTconditionScoping が使用されます。

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_PERMANENTeventExclusionDuration が使用されます。

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

object (FilterExpressionList)

andGroup の FilterExpressions は AND 関係です。

orGroup

object (FilterExpressionList)

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

notExpression

object (FilterExpression)

FilterExpression は、notExpression の NOT 型です。

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_filterFilter のフィルタを 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

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

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 では、ディメンション値がピボットに含まれるディメンションについてのみリストされます。

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 には、次のいずれかのみを指定できます。
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

測定値。type については、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 プロパティでは 2,000,000 トークンを使用できます。ほとんどの場合、リクエストで使用するトークンは 10 個未満です。

tokensPerHour

object (QuotaStatus)

1 時間あたり、標準のアナリティクス プロパティでは最大 40,000 トークンを使用できますが、アナリティクス 360 プロパティでは 40,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

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