- HTTP リクエスト
- パスパラメータ
- リクエストの本文
- レスポンスの本文
- 認可スコープ
- ファネル
<ph type="x-smartling-placeholder">
- </ph>
- JSON 表現
- FunnelStep
<ph type="x-smartling-placeholder">
- </ph>
- JSON 表現
- FunnelFilterExpression
<ph type="x-smartling-placeholder">
- </ph>
- JSON 表現
- FunnelFilterExpressionList
<ph type="x-smartling-placeholder">
- </ph>
- JSON 表現
- FunnelFieldFilter
<ph type="x-smartling-placeholder">
- </ph>
- JSON 表現
- FunnelEventFilter
<ph type="x-smartling-placeholder">
- </ph>
- JSON 表現
- FunnelParameterFilterExpression
<ph type="x-smartling-placeholder">
- </ph>
- JSON 表現
- FunnelParameterFilterExpressionList
<ph type="x-smartling-placeholder">
- </ph>
- JSON 表現
- FunnelParameterFilter
<ph type="x-smartling-placeholder">
- </ph>
- JSON 表現
- FunnelBreakdown
<ph type="x-smartling-placeholder">
- </ph>
- JSON 表現
- FunnelNextAction
<ph type="x-smartling-placeholder">
- </ph>
- JSON 表現
- FunnelVisualizationType
- セグメント
<ph type="x-smartling-placeholder">
- </ph>
- JSON 表現
- UserSegment
<ph type="x-smartling-placeholder">
- </ph>
- JSON 表現
- UserSegmentCriteria
<ph type="x-smartling-placeholder">
- </ph>
- JSON 表現
- UserSegmentConditionGroup
<ph type="x-smartling-placeholder">
- </ph>
- JSON 表現
- UserCriteriaScoping
- SegmentFilterExpression
<ph type="x-smartling-placeholder">
- </ph>
- JSON 表現
- SegmentFilterExpressionList
<ph type="x-smartling-placeholder">
- </ph>
- JSON 表現
- SegmentFilter
<ph type="x-smartling-placeholder">
- </ph>
- JSON 表現
- SegmentFilterScoping
<ph type="x-smartling-placeholder">
- </ph>
- JSON 表現
- SegmentEventFilter
<ph type="x-smartling-placeholder">
- </ph>
- JSON 表現
- SegmentParameterFilterExpression
<ph type="x-smartling-placeholder">
- </ph>
- JSON 表現
- SegmentParameterFilterExpressionList
<ph type="x-smartling-placeholder">
- </ph>
- JSON 表現
- SegmentParameterFilter
<ph type="x-smartling-placeholder">
- </ph>
- JSON 表現
- SegmentParameterFilterScoping
<ph type="x-smartling-placeholder">
- </ph>
- JSON 表現
- UserSegmentSequenceGroup
<ph type="x-smartling-placeholder">
- </ph>
- JSON 表現
- UserSequenceStep
<ph type="x-smartling-placeholder">
- </ph>
- JSON 表現
- UserSegmentExclusion
<ph type="x-smartling-placeholder">
- </ph>
- JSON 表現
- UserExclusionDuration
- SessionSegment
<ph type="x-smartling-placeholder">
- </ph>
- JSON 表現
- SessionSegmentCriteria
<ph type="x-smartling-placeholder">
- </ph>
- JSON 表現
- SessionSegmentConditionGroup
<ph type="x-smartling-placeholder">
- </ph>
- JSON 表現
- SessionCriteriaScoping
- SessionSegmentExclusion
<ph type="x-smartling-placeholder">
- </ph>
- JSON 表現
- SessionExclusionDuration
- EventSegment
<ph type="x-smartling-placeholder">
- </ph>
- JSON 表現
- EventSegmentCriteria
<ph type="x-smartling-placeholder">
- </ph>
- JSON 表現
- EventSegmentConditionGroup
<ph type="x-smartling-placeholder">
- </ph>
- JSON 表現
- EventCriteriaScoping
- EventSegmentExclusion
<ph type="x-smartling-placeholder">
- </ph>
- JSON 表現
- EventExclusionDuration
- FunnelSubReport
<ph type="x-smartling-placeholder">
- </ph>
- JSON 表現
- FunnelResponseMetadata
<ph type="x-smartling-placeholder">
- </ph>
- JSON 表現
- SamplingMetadata
<ph type="x-smartling-placeholder">
- </ph>
- JSON 表現
- PropertyQuota
<ph type="x-smartling-placeholder">
- </ph>
- JSON 表現
- QuotaStatus
<ph type="x-smartling-placeholder">
- </ph>
- JSON 表現
- 試してみる
Google アナリティクスのイベントデータのカスタマイズされたファネル レポートを返します。API から返されるデータは、リクエストされたディメンションと指標の列を含む表として返されます。
目標到達プロセスデータ探索では、ユーザーがコンバージョンに至るまでのステップをビジュアル表示し、各ステップでのユーザーの動向をすばやく確認できます。たとえば、見込み顧客がどのように買い物客になり、その後どのように顧客に変わるか、一見客がどのようにリピーターになるのかといったことです。この情報により、非効率なカスタマー ジャーニーや放棄されたカスタマー ジャーニーを改善できます。詳しくは、GA4 のファネル データ探索をご覧ください。
この方法は、ベータ版に入る前に構文や機能に関するフィードバックを収集する目的で、アルファ版(安定版)で導入されています。この API に関するフィードバックを送信する場合は、Google Analytics Data API のファネル レポートに関するフィードバックにご記入ください。
HTTP リクエスト
POST https://analyticsdata.googleapis.com/v1alpha/{property=properties/*}:runFunnelReport
この URL は gRPC Transcoding 構文を使用します。
パスパラメータ
パラメータ | |
---|---|
property |
省略可。イベントがトラッキングされる Google アナリティクス GA4 プロパティ ID。URL パスで指定され、本文では指定されません。詳しくは、プロパティ ID を確認する方法をご覧ください。バッチ リクエスト内では、このプロパティを指定しないか、バッチレベルのプロパティと一致させる必要があります。 例: properties/1234 |
リクエスト本文
リクエストの本文には、次の構造のデータが含まれます。
JSON 表現 |
---|
{ "dateRanges": [ { object ( |
フィールド | |
---|---|
dateRanges[] |
省略可。読み取るデータの期間。複数の期間がリクエストされた場合、レスポンスの各行には 0 を基準とした期間インデックスが含まれます。2 つの期間が重複する場合、重複する日付のイベントデータが両方の期間のレスポンス行に含まれます。 |
funnel |
省略可。このリクエストのファネルの設定。この目標到達プロセスの設定は必須です。 |
funnelBreakdown |
省略可。この内訳を指定すると、ファネル テーブルのサブレポート レスポンスにディメンションが追加されます。この内訳ディメンションでは、ファネルの各ステップが内訳ディメンションの一意の値に展開されます。たとえば、「 |
funnelNextAction |
省略可。指定すると、次のアクションで、ファネルのビジュアリゼーションのサブレポートのレスポンスにディメンションが追加されます。この「次のアクション」ディメンションでは、ファネルの各ステップが次のアクションに固有の値に展開されます。たとえば、「 「次のアクション」は、 |
funnelVisualizationType |
省略可。ファネルのビジュアリゼーション タイプでは、ファネルのビジュアリゼーション サブレポートのレスポンスに存在するディメンションを制御します。指定しない場合は |
segments[] |
省略可。セグメントの構成。セグメントは、プロパティのデータのサブセットです。セグメントを含むファネル レポートでは、ファネルはセグメントごとに評価されます。 このリクエストで指定された各セグメントは、レスポンスで個別の行を生成します。各セグメントはその名前で識別されます。 Segments パラメータは省略可能です。リクエストは 4 つのセグメントに制限されます。 |
limit |
省略可。返される行数。指定しない場合は、10,000 行が返されます。指定した行数にかかわらず、API はリクエストごとに最大 250,000 行を返します。 また、ディメンション値が |
dimensionFilter |
省略可。ディメンション フィルタを使用すると、レポート内の特定のディメンション値のみを要求することができます。詳しくは、レポートの作成: ディメンション フィルタをご覧ください。このフィルタでは指標を使用できません。 |
returnPropertyQuota |
省略可。このアナリティクス プロパティの割り当ての現在の状態を返すかどうかを切り替えます。Quota は PropertyQuota で返されます。 |
レスポンスの本文
ファネル レポートのレスポンスには 2 つのサブレポートが含まれています。この 2 つのサブレポートは、ディメンションと指標の組み合わせが異なっています。
成功した場合、レスポンスの本文には次の構造のデータが含まれます。
JSON 表現 |
---|
{ "funnelTable": { object ( |
フィールド | |
---|---|
funnelTable |
ファネルの表は、ファネルのステップ、セグメント、内訳ディメンション、アクティブ ユーザー数、完了率、放棄率、放棄率を含むレポートです。 セグメント ディメンションは、セグメントがリクエストされた場合にのみ、このレスポンスに含まれます。内訳ディメンションは、リクエストされた場合にのみこのレスポンスに表示されます。 |
funnelVisualization |
ファネルのビジュアリゼーションは、ファネルのステップ、セグメント、日付、次のアクションのディメンション、アクティブ ユーザー数を含むレポートです。 セグメント ディメンションは、セグメントがリクエストされた場合にのみ、このレスポンスに含まれます。日付ディメンションは、 |
propertyQuota |
このリクエストを含む、このアナリティクス プロパティの割り当て状態。 |
kind |
このメッセージのリソースの種類を指定します。この |
認可スコープ
次の OAuth スコープのいずれかが必要です。
https://www.googleapis.com/auth/analytics.readonly
https://www.googleapis.com/auth/analytics
ファネル
ファネル レポート リクエストでファネルを設定します。ファネルでは、ユーザーが一連のステップを通過したときに、そのユーザーが報告されます。
目標到達プロセスデータ探索では、ユーザーがコンバージョンに至るまでのステップをビジュアル表示し、各ステップでのユーザーの動向をすばやく確認できます。たとえば、見込み顧客がどのように買い物客になり、その後どのように顧客に変わるか、一見客がどのようにリピーターになるのかといったことです。この情報から、非効率なカスタマー ジャーニーや、放棄されるカスタマー ジャーニーの改善を図ることができます。
JSON 表現 |
---|
{
"isOpenFunnel": boolean,
"steps": [
{
object ( |
フィールド | |
---|---|
isOpenFunnel |
オープン型のファネルでは、どのステップからでも開始できます。クローズド型のファネルでは、最初のステップから開始する必要があります。省略可。指定しない場合は、クローズド ファネルが使用されます。 |
steps[] |
このファネルの一連のステップ。 |
FunnelStep
ステップでは、測定するカスタマー ジャーニーを定義します。ステップには、ユーザーがファネル ジャーニーのそのステップに含まれるために満たす必要がある 1 つ以上の条件が含まれます。
JSON 表現 |
---|
{
"name": string,
"isDirectlyFollowedBy": boolean,
"filterExpression": {
object ( |
フィールド | |
---|---|
name |
このステップの固有名。指定しない場合、ステップには 1 をベースとしたインデックス付き名(例: 「0.」、「1.」など)。この名前は、 |
isDirectlyFollowedBy |
true の場合、このステップは前のステップの直後に行う必要があります。false の場合、前のステップとこのステップの間にイベントが発生している可能性があります。指定しない場合、 |
filterExpression |
ユーザーがファネル ジャーニーのステップに含まれる条件。 |
withinDurationFromPriorStep |
指定する場合、このステップは前のステップの完了からこの期間内に完了する必要があります。
|
FunnelFilterExpression
ファネル フィルタの組み合わせを表します。
JSON 表現 |
---|
{ // Union field |
フィールド | |
---|---|
共用体フィールド expr 。FunnelFilterExpression に 1 種類のフィルタを指定します。expr は次のいずれかになります。 |
|
andGroup |
|
orGroup |
|
notExpression |
FunnelFilterExpression が |
funnelFieldFilter |
ディメンションまたは指標のファネル フィルタ。 |
funnelEventFilter |
単一のイベント名のイベントに一致するフィルタを作成します。パラメータ フィルタ式を指定すると、単一のイベント名とパラメータ フィルタ式の両方に一致するイベントのサブセットのみが、このイベント フィルタに一致します。 |
FunnelFilterExpressionList
ファネル フィルタ式のリスト。
JSON 表現 |
---|
{
"expressions": [
{
object ( |
フィールド | |
---|---|
expressions[] |
ファネル フィルタ式のリスト。 |
FunnelFieldFilter
ディメンションまたは指標の値をフィルタする式。
JSON 表現 |
---|
{ "fieldName": string, // Union field |
フィールド | |
---|---|
fieldName |
ディメンション名または指標名。 |
共用体フィールド one_filter 。1 種類のフィルタを指定します。one_filter は次のいずれかになります。 |
|
stringFilter |
文字列関連のフィルタ。 |
inListFilter |
リスト値のフィルタ。 |
numericFilter |
数値または日付の値のフィルタ。 |
betweenFilter |
2 つの値の間のフィルタ。 |
FunnelEventFilter
単一のイベント名のイベントに一致するフィルタを作成します。パラメータ フィルタ式を指定すると、単一のイベント名とパラメータ フィルタ式の両方に一致するイベントのサブセットのみが、このイベント フィルタに一致します。
JSON 表現 |
---|
{
"eventName": string,
"funnelParameterFilterExpression": {
object ( |
フィールド | |
---|---|
eventName |
このフィルタは、この単一のイベント名のイベントに一致します。イベント名は必須です。 |
funnelParameterFilterExpression |
指定すると、このフィルタは単一のイベント名とパラメータのフィルタ式の両方に一致するイベントに一致します。 パラメータ フィルタ式内では、パラメータ フィルタのみを使用できます。 |
FunnelParameterFilterExpression
パラメータでのファネル フィルタの組み合わせを表します。
JSON 表現 |
---|
{ // Union field |
フィールド | |
---|---|
共用体フィールド expr 。FunnelParameterFilterExpression に 1 種類のフィルタを指定します。expr は次のいずれかになります。 |
|
andGroup |
|
orGroup |
|
notExpression |
FunnelParameterFilterExpression が |
funnelParameterFilter |
目標到達プロセスのプリミティブ パラメータ フィルタ。 |
FunnelParameterFilterExpressionList
ファネル パラメータのフィルタ式のリスト。
JSON 表現 |
---|
{
"expressions": [
{
object ( |
フィールド | |
---|---|
expressions[] |
ファネル パラメータのフィルタ式のリスト。 |
FunnelParameterFilter
ファネル内のパラメータ値をフィルタする式。
JSON 表現 |
---|
{ // Union field |
フィールド | |
---|---|
共用体フィールド one_parameter 。フィルタされるフィールド。one_parameter は次のいずれかになります。 |
|
eventParameterName |
このフィルタは、指定されたイベント パラメータで評価されます。イベント パラメータは、イベントのパラメータとして記録されます。イベント パラメータには「firebase_screen」などのフィールドが含まれるおよび"currency"。 イベント パラメータはセグメントとEventFilter の子孫フィルタ内でのみ使用できます。EventFilter の子孫フィルタでは、イベント パラメータまたはアイテム パラメータを使用する必要があります。 |
itemParameterName |
このフィルタは、指定されたアイテム パラメータに基づいて評価されます。アイテム パラメータは、アイテム配列にパラメータとして記録されます。アイテム パラメータに「item_name」などのフィールドが含まれるおよび「item_category」。 アイテム パラメータはセグメントとEventFilter の子孫フィルタ内でのみ使用できます。EventFilter の子孫フィルタでは、イベント パラメータまたはアイテム パラメータを使用する必要があります。 アイテム パラメータは e コマース イベントでのみ使用できます。e コマース イベントについて詳しくは、e コマースを測定するをご覧ください。 |
共用体フィールド one_filter 。1 種類のフィルタを指定します。one_filter は次のいずれかになります。 |
|
stringFilter |
文字列関連のフィルタ。 |
inListFilter |
リスト値のフィルタ。 |
numericFilter |
数値または日付の値のフィルタ。 |
betweenFilter |
2 つの値の間のフィルタ。 |
FunnelBreakdown
内訳を使用すると、ファネル テーブルのサブレポートのレスポンスにディメンションが追加されます。
JSON 表現 |
---|
{
"breakdownDimension": {
object ( |
フィールド | |
---|---|
breakdownDimension |
ファネル テーブルのサブレポートのレスポンスに追加されたディメンション列。内訳ディメンションでは、ファネルの各ステップの内訳が表示されます。 |
limit |
レスポンスで返される、内訳ディメンションの個別の値の最大数。制限が指定されていない場合は、 |
FunnelNextAction
「次のアクション」は、ユーザーがステップを達成してから次のステップに到達するまでのディメンションの値を示します。たとえば、nextActionDimension
が eventName
の場合、ファネルの i
番目のステップの nextActionDimension
は、ユーザーを i
番目のファネルのステップに適格とされたイベントの後、かつユーザーがファネルの i+1
番目のステップを達成する前の最初のイベントを返します。
JSON 表現 |
---|
{
"nextActionDimension": {
object ( |
フィールド | |
---|---|
nextActionDimension |
ファネルのビジュアリゼーションのサブレポートのレスポンスに追加されたディメンション列。「次のアクション」ディメンションは、ユーザーが目標到達プロセスの
|
limit |
レスポンスで返される、内訳ディメンションの個別の値の最大数。制限が指定されていない場合は、 |
FunnelVisualizationType
ファネルのビジュアリゼーションのサブレポートのレスポンスに含まれるディメンションを制御します。
列挙型 | |
---|---|
FUNNEL_VISUALIZATION_TYPE_UNSPECIFIED |
未指定のタイプ。 |
STANDARD_FUNNEL |
標準的な(段階的な)ファネル。回答のファネルのビジュアリゼーションのサブレポートには日付は含まれません。 |
TRENDED_FUNNEL |
ファネルのトレンドグラフ(折れ線グラフ)。レスポンスのファネルのビジュアリゼーション サブレポートには、日付ディメンションが含まれます。 |
セグメント
セグメントはアナリティクスのデータの一部です。たとえば、すべてのユーザーのうち、特定の国や都市のユーザーだけを 1 つのセグメントに設定したり、また、特定の商品ラインを購入したユーザーや、サイトの特定のページにアクセスしたユーザー、アプリで特定のイベントをトリガーしたユーザーを別のセグメントに指定したりすることができます。
詳しくは、GA4 セグメント ビルダーをご覧ください。
JSON 表現 |
---|
{ "name": string, // Union field |
フィールド | |
---|---|
name |
このセグメントの名前。指定しない場合、セグメントの名前は「Segment」になります。この名前は、 |
共用体フィールド one_segment_scope 。セグメントは 1 つのスコープで指定されます。one_segment_scope は次のいずれかになります。 |
|
userSegment |
ユーザー セグメントは、サイトまたはアプリを利用したユーザーのサブセットです。 |
sessionSegment |
セッション セグメントは、サイトまたはアプリで発生したセッションのサブセットです。 |
eventSegment |
イベント セグメントは、サイトまたはアプリで発生したイベントのサブセットです。 |
UserSegment
ユーザー セグメントは、サイトまたはアプリを利用したユーザーのサブセットです。たとえば、過去に購入したことのあるユーザーなどです。ショッピング カートに商品を追加したものの、購入には至らなかったユーザー
JSON 表現 |
---|
{ "userInclusionCriteria": { object ( |
フィールド | |
---|---|
userInclusionCriteria |
このセグメントに含めるユーザーを定義します。省略可。 |
exclusion |
このセグメントから除外するユーザーを定義します。省略可。 |
UserSegmentCriteria
ユーザーのイベントが条件の条件を満たしている場合、ユーザーは条件に一致します。
JSON 表現 |
---|
{ "andConditionGroups": [ { object ( |
フィールド | |
---|---|
andConditionGroups[] |
ユーザーがこれらの |
andSequenceGroups[] |
ユーザーがこれらの |
UserSegmentConditionGroup
条件を指定すると、セグメントに含めるデータと、セグメントから除外するデータをアナリティクスで指定できます。
JSON 表現 |
---|
{ "conditionScoping": enum ( |
フィールド | |
---|---|
conditionScoping |
セグメントへのデータは、条件グループと一致するかどうかに基づいてセグメントへの追加と除外が行われます。このスコープでは、条件グループと一致するかどうかを判断する前に 省略可。指定しない場合は、 |
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 。SegmentFilterExpression に 1 種類のフィルタを指定します。expr は次のいずれかになります。 |
|
andGroup |
|
orGroup |
|
notExpression |
SegmentFilterExpression が |
segmentFilter |
プリミティブ セグメント フィルタ。 |
segmentEventFilter |
単一のイベント名のイベントに一致するフィルタを作成します。パラメータ フィルタ式を指定すると、単一のイベント名とパラメータ フィルタ式の両方に一致するイベントのサブセットのみが、このイベント フィルタに一致します。 |
SegmentFilterExpressionList
セグメント フィルタ式のリスト。
JSON 表現 |
---|
{
"expressions": [
{
object ( |
フィールド | |
---|---|
expressions[] |
セグメント フィルタ式のリスト |
SegmentFilter
ディメンションまたは指標の値をフィルタする式。
JSON 表現 |
---|
{ "fieldName": string, "filterScoping": { object ( |
フィールド | |
---|---|
fieldName |
ディメンション名または指標名。 |
filterScoping |
フィルタのスコープを指定します。 |
共用体フィールド one_filter 。Filter に 1 種類のフィルタを指定します。one_filter は次のいずれかになります。 |
|
stringFilter |
文字列関連のフィルタ。 |
inListFilter |
リスト値のフィルタ。 |
numericFilter |
数値または日付の値のフィルタ。 |
betweenFilter |
2 つの値の間のフィルタ。 |
SegmentFilterScoping
スコープでは、ディメンションとセグメント フィルタを評価する際は、複数のイベントの指標を考慮する必要があります。
JSON 表現 |
---|
{ "atAnyPointInTime": boolean } |
フィールド | |
---|---|
atAnyPointInTime |
この この 条件のスコープが |
SegmentEventFilter
単一のイベント名のイベントに一致するフィルタを作成します。パラメータ フィルタ式を指定すると、単一のイベント名とパラメータ フィルタ式の両方に一致するイベントのサブセットのみが、このイベント フィルタに一致します。
JSON 表現 |
---|
{
"eventName": string,
"segmentParameterFilterExpression": {
object ( |
フィールド | |
---|---|
eventName |
このフィルタは、この単一のイベント名のイベントに一致します。イベント名は必須です。 |
segmentParameterFilterExpression |
指定すると、このフィルタは単一のイベント名とパラメータのフィルタ式の両方に一致するイベントに一致します。 パラメータ フィルタ式内では、パラメータ フィルタのみを使用できます。 |
SegmentParameterFilterExpression
パラメータのセグメント フィルタの組み合わせを表します。
JSON 表現 |
---|
{ // Union field |
フィールド | |
---|---|
共用体フィールド expr 。SegmentParameterFilterExpression に 1 種類のフィルタを指定します。expr は次のいずれかになります。 |
|
andGroup |
|
orGroup |
|
notExpression |
SegmentParameterFilterExpression が |
segmentParameterFilter |
プリミティブ セグメント パラメータ フィルタ。 |
SegmentParameterFilterExpressionList
セグメント パラメータのフィルタ式のリスト。
JSON 表現 |
---|
{
"expressions": [
{
object ( |
フィールド | |
---|---|
expressions[] |
セグメント パラメータのフィルタ式のリスト。 |
SegmentParameterFilter
セグメント内のパラメータ値をフィルタする式。
JSON 表現 |
---|
{ "filterScoping": { object ( |
フィールド | |
---|---|
filterScoping |
フィルタのスコープを指定します。 |
共用体フィールド one_parameter 。フィルタされるフィールド。one_parameter は次のいずれかになります。 |
|
eventParameterName |
このフィルタは、指定されたイベント パラメータで評価されます。イベント パラメータは、イベントのパラメータとして記録されます。イベント パラメータには「firebase_screen」などのフィールドが含まれるおよび"currency"。 イベント パラメータはセグメントとEventFilter の子孫フィルタ内でのみ使用できます。EventFilter の子孫フィルタでは、イベント パラメータまたはアイテム パラメータを使用する必要があります。 |
itemParameterName |
このフィルタは、指定されたアイテム パラメータに基づいて評価されます。アイテム パラメータは、アイテム配列にパラメータとして記録されます。アイテム パラメータに「item_name」などのフィールドが含まれるおよび「item_category」。 アイテム パラメータはセグメントとEventFilter の子孫フィルタ内でのみ使用できます。EventFilter の子孫フィルタでは、イベント パラメータまたはアイテム パラメータを使用する必要があります。 アイテム パラメータは e コマース イベントでのみ使用できます。e コマース イベントについて詳しくは、e コマースを測定するをご覧ください。 |
共用体フィールド one_filter 。1 種類のフィルタを指定します。one_filter は次のいずれかになります。 |
|
stringFilter |
文字列関連のフィルタ。 |
inListFilter |
リスト値のフィルタ。 |
numericFilter |
数値または日付の値のフィルタ。 |
betweenFilter |
2 つの値の間のフィルタ。 |
SegmentParameterFilterScoping
スコープでは、セグメント パラメータ フィルタを評価する際に、複数のイベントをどのように考慮するかを指定します。
JSON 表現 |
---|
{ "inAnyNDayPeriod": string } |
フィールド | |
---|---|
inAnyNDayPeriod |
フィルタを適用する前に、指定した期間のパラメータを累積します。条件のスコープが たとえば、 日付範囲は、期間の開始前後に丸 N 日間という目的では拡張されません。たとえば、レポートの対象期間が 2021 年 11 月 1 日~ 2021 年 11 月 10 日で、
|
UserSegmentSequenceGroup
ユーザーがセグメントのメンバーとなるために、特定の順序で発生する条件を定義します。
JSON 表現 |
---|
{ "sequenceScoping": enum ( |
フィールド | |
---|---|
sequenceScoping |
ユーザーがシーケンスに一致するには、すべてのシーケンス ステップがスコーピング内で満たされる必要があります。たとえば 省略可。指定しない場合は、 |
sequenceMaximumDuration |
シーケンス全体が行われる必要がある期間を定義します。(例: 30 分)。
|
userSequenceSteps[] |
順序付けられた条件ステップ。ユーザーが |
UserSequenceStep
このユーザーがシーケンスに一致するために、指定されたステップ順に発生する必要がある条件。
JSON 表現 |
---|
{ "isDirectlyFollowedBy": boolean, "stepScoping": enum ( |
フィールド | |
---|---|
isDirectlyFollowedBy |
true の場合、このステップを満たすイベントは、最後のステップを満たすイベントの直後のイベントである必要があります。false の場合、このステップは前のステップの後に間接的に実施されます。たとえば、前のステップとこのステップの間にイベントがある場合があります。最初のステップでは、 |
stepScoping |
ユーザーがシーケンスに一致するには、このシーケンス ステップをスコーピングで満たす必要があります。たとえば 省略可。指定しない場合、 |
segmentFilterExpression |
ユーザーのイベントがこの式に一致する場合、ユーザーはこのシーケンス ステップに一致します。式は、ディメンション、指標、パラメータの条件を表現します。 |
UserSegmentExclusion
このセグメントから除外するユーザーを指定します。
JSON 表現 |
---|
{ "userExclusionDuration": enum ( |
フィールド | |
---|---|
userExclusionDuration |
ユーザーが 省略可。指定しない場合は、 |
userExclusionCriteria |
この条件を満たしているユーザーは、 |
UserExclusionDuration
ユーザーが userExclusionCriteria
に一致した場合に除外が継続される期間のオプションを列挙します。
列挙型 | |
---|---|
USER_EXCLUSION_DURATION_UNSPECIFIED |
除外期間が指定されていません。指定しないでください。 |
USER_EXCLUSION_TEMPORARY |
ユーザーが userExclusionCriteria 条件を満たしている期間中は、そのセグメントから一時的にユーザーを除外します。 |
USER_EXCLUSION_PERMANENT |
userExclusionCriteria の条件を満たしたユーザーをセグメントから完全に除外します。 |
SessionSegment
セッション セグメントfとはサイトやアプリで発生したセッションのサブセットのことで、特定の広告キャンペーンから発生したすべてのセッションなどが該当します。
JSON 表現 |
---|
{ "sessionInclusionCriteria": { object ( |
フィールド | |
---|---|
sessionInclusionCriteria |
このセグメントに含めるセッションを定義します。省略可。 |
exclusion |
このセグメントから除外するセッションを定義します。省略可。 |
SessionSegmentCriteria
セッションのイベントが条件に一致する場合、そのセッションは条件に一致します。
JSON 表現 |
---|
{
"andConditionGroups": [
{
object ( |
フィールド | |
---|---|
andConditionGroups[] |
セッションがこれらの |
SessionSegmentConditionGroup
条件を指定すると、セグメントに含めるデータと、セグメントから除外するデータをアナリティクスで指定できます。
JSON 表現 |
---|
{ "conditionScoping": enum ( |
フィールド | |
---|---|
conditionScoping |
セグメントへのデータは、条件グループと一致するかどうかに基づいてセグメントへの追加と除外が行われます。このスコープでは、条件グループと一致するかどうかを判断する前に 省略可。指定しない場合は、 |
segmentFilterExpression |
データは、この式に一致するかどうかに基づいてセグメントに含められるか除外されます。式は、ディメンション、指標、パラメータの条件を表現します。 |
SessionCriteriaScoping
スコープでは、セッションが条件を満たしているかどうかを評価する際に考慮するイベントを指定します。
列挙型 | |
---|---|
SESSION_CRITERIA_SCOPING_UNSPECIFIED |
条件の範囲が指定されていません。指定しないでください。 |
SESSION_CRITERIA_WITHIN_SAME_EVENT |
1 つのイベント内で条件を満たしている場合、セッションは条件に一致します。 |
SESSION_CRITERIA_WITHIN_SAME_SESSION |
1 つのセッションで条件が満たされると、そのセッションは条件に一致することになります。 |
SessionSegmentExclusion
このセグメントから除外するセッションを指定します。
JSON 表現 |
---|
{ "sessionExclusionDuration": enum ( |
フィールド | |
---|---|
sessionExclusionDuration |
セッションが 省略可。指定しない場合は、 |
sessionExclusionCriteria |
セッションがこの条件を満たしている場合、そのセッションは |
SessionExclusionDuration
セッションが sessionExclusionCriteria
に一致する場合に除外が継続される期間のオプションを列挙します。
列挙型 | |
---|---|
SESSION_EXCLUSION_DURATION_UNSPECIFIED |
除外期間が指定されていません。指定しないでください。 |
SESSION_EXCLUSION_TEMPORARY |
セッションが sessionExclusionCriteria 条件を満たすセッションを一時的にセグメントから除外します。 |
SESSION_EXCLUSION_PERMANENT |
セッションが sessionExclusionCriteria 条件を満たしている場合は、そのセッションをセグメントから完全に除外します。 |
EventSegment
イベント セグメントは、サイトまたはアプリで発生したイベントのサブセットです。(例: 特定の場所で発生したすべての購入イベント)。特定のオペレーティング システムで発生した app_exception イベントです。
JSON 表現 |
---|
{ "eventInclusionCriteria": { object ( |
フィールド | |
---|---|
eventInclusionCriteria |
このセグメントに含めるイベントを定義します。省略可。 |
exclusion |
このセグメントから除外するイベントを定義します。省略可。 |
EventSegmentCriteria
イベントが条件の条件を満たしている場合、イベントは条件に一致します。
JSON 表現 |
---|
{
"andConditionGroups": [
{
object ( |
フィールド | |
---|---|
andConditionGroups[] |
イベントがこれらの各 |
EventSegmentConditionGroup
条件を指定すると、セグメントに含めるデータと、セグメントから除外するデータをアナリティクスで指定できます。
JSON 表現 |
---|
{ "conditionScoping": enum ( |
フィールド | |
---|---|
conditionScoping |
省略可。指定しない場合は、 |
segmentFilterExpression |
データは、この式に一致するかどうかに基づいてセグメントに含められるか除外されます。式は、ディメンション、指標、パラメータの条件を表現します。 |
EventCriteriaScoping
スコープは、イベントが条件を満たしているかどうかを評価する際に考慮するイベントを指定するものです。
列挙型 | |
---|---|
EVENT_CRITERIA_SCOPING_UNSPECIFIED |
条件の範囲が指定されていません。指定しないでください。 |
EVENT_CRITERIA_WITHIN_SAME_EVENT |
1 つのイベント内で条件が満たされると、そのイベントは条件に一致します。 |
EventSegmentExclusion
このセグメントで除外するイベントを指定します。
JSON 表現 |
---|
{ "eventExclusionDuration": enum ( |
フィールド | |
---|---|
eventExclusionDuration |
省略可。指定しない場合は、 |
eventExclusionCriteria |
イベントがこの条件を満たしている場合、 |
EventExclusionDuration
イベントが eventExclusionCriteria
に一致する場合に除外が継続される期間のオプションを列挙します。
列挙型 | |
---|---|
EVENT_EXCLUSION_DURATION_UNSPECIFIED |
除外期間が指定されていません。指定しないでください。 |
EVENT_EXCLUSION_PERMANENT |
イベントが eventExclusionCriteria の条件を満たしている場合は、セグメントからイベントを完全に除外します。 |
FunnelSubReport
ファネル サブレポートには、ディメンションと指標のデータの値が含まれます。たとえば、12 人のユーザーがファネルの 2 番目のステップに到達したとします。
JSON 表現 |
---|
{ "dimensionHeaders": [ { object ( |
フィールド | |
---|---|
dimensionHeaders[] |
ディメンション列について説明します。ファネル レポートでは、サブレポートのレスポンスにファネルのステップのディメンションが常に含まれます。リクエストに応じて、内訳、日付、次のアクションなどの追加ディメンションがレスポンスに含まれることがあります。 |
metricHeaders[] |
指標の列について説明します。ファネル レポートのサブレポート レスポンスには、常にアクティブ ユーザーが含まれます。ファネルの表には、完了率、放棄率、放棄率などの指標も追加されています。 |
rows[] |
レポート内のディメンション値の組み合わせと指標値の行。 |
metadata |
ファネル レポートのメタデータ。 |
FunnelResponseMetadata
ファネル レポートのレスポンス メタデータには、ファネル レポートに関する追加情報が含まれます。
JSON 表現 |
---|
{
"samplingMetadatas": [
{
object ( |
フィールド | |
---|---|
samplingMetadatas[] |
ファネル レポートの結果がサンプリングされる場合、このファネル レポートで使用されるイベントの割合が表示されます。期間ごとに 1 つの ただし、結果がサンプリングされない場合、このフィールドは定義されません。 |
SamplingMetadata
ファネル レポートの結果がサンプリングされる場合、このメタデータは、期間中にこのファネル レポート内で使用されたイベントの割合を表します。サンプリングとは、大規模なデータセットから有意な情報を引き出すために、すべてのデータのサブセットを分析する手法です。
JSON 表現 |
---|
{ "samplesReadCount": string, "samplingSpaceSize": string } |
フィールド | |
---|---|
samplesReadCount |
このサンプル レポートで期間中に読み取られたイベントの合計数。このファネル レポートで分析された、このプロパティのデータのサブセットのサイズです。 |
samplingSpaceSize |
このプロパティのデータに存在するイベントのうち、期間中にこのファネル レポートで分析できたイベントの合計数。サンプリングにより、より大きなデータセットに関する有意な情報が明らかになります。これは、大規模なデータセットのサイズです。 このファネル レポートで使用されている利用可能なデータの割合を計算するには、 |
PropertyQuota
このアナリティクス プロパティのすべての割り当ての現在の状態。プロパティの割り当てを使い切ると、そのプロパティに対するすべてのリクエストでリソース不足エラーが返されます。
JSON 表現 |
---|
{ "tokensPerDay": { object ( |
フィールド | |
---|---|
tokensPerDay |
標準のアナリティクス プロパティでは、1 日あたり最大 200,000 トークンを使用できます。アナリティクス 360 プロパティでは、1 日あたり 2,000,000 個のトークンを使用できます。ほとんどの場合、リクエストで使用するトークンは 10 個未満です。 |
tokensPerHour |
標準のアナリティクス プロパティでは、1 時間あたり最大 40,000 トークンを使用できます。アナリティクス 360 プロパティでは、1 時間あたり 400,000 トークンを使用できます。1 つの API リクエストで消費されるトークンの数は、時間、日、プロジェクトごとの 1 時間ごとの割り当てすべてから差し引かれます。 |
concurrentRequests |
標準のアナリティクス プロパティでは、最大 10 個の同時リクエストを送信できます。アナリティクス 360 プロパティでは、最大 50 件の同時リクエストを使用できます。 |
serverErrorsPerProjectPerHour |
標準のアナリティクス プロパティとクラウド プロジェクトのペアでは、1 時間あたり最大 10 件のサーバーエラーが発生する可能性があります。アナリティクス 360 のプロパティとクラウド プロジェクトのペアでは、1 時間あたり最大 50 件のサーバーエラーが発生する可能性があります。 |
potentiallyThresholdedRequestsPerHour |
アナリティクス プロパティでは、しきい値となるディメンションを含むリクエストを 1 時間あたり最大 120 件送信できます。バッチ リクエストでは、しきい値が適用されたディメンションがリクエストに含まれている場合、各レポート リクエストはこの割り当てに対して個別にカウントされます。 |
tokensPerProjectPerHour |
アナリティクス プロパティでは、プロジェクトごとに 1 時間あたり最大 35% のトークンを使用できます。標準のアナリティクス プロパティでは、プロジェクトごとに 1 時間あたり最大 14,000 トークンを使用できます。アナリティクス 360 プロパティでは、プロジェクトごとに 1 時間あたり 140,000 トークンを使用できます。1 つの API リクエストで消費されるトークンの数は、時間、日、プロジェクトごとの 1 時間ごとの割り当てすべてから差し引かれます。 |
QuotaStatus
特定の割り当てグループの現在の状態。
JSON 表現 |
---|
{ "consumed": integer, "remaining": integer } |
フィールド | |
---|---|
consumed |
このリクエストで使用された割り当て。 |
remaining |
このリクエストの後に残っている割り当て。 |