- HTTP リクエスト
- パスパラメータ
- リクエストの本文
- レスポンスの本文
- 認可スコープ
- ファネル
- FunnelStep
- FunnelFilterExpression
- FunnelFilterExpressionList
- FunnelFieldFilter
- FunnelEventFilter
- FunnelParameterFilterExpression
- FunnelParameterFilterExpressionList
- FunnelParameterFilter
- FunnelBreakdown
- FunnelNextAction
- FunnelVisualizationType
- セグメント
- UserSegment
- UserSegmentCriteria
- UserSegmentConditionGroup
- UserCriteriaScoping
- SegmentFilterExpression
- SegmentFilterExpressionList
- SegmentFilter
- SegmentFilterScoping
- SegmentEventFilter
- SegmentParameterFilterExpression
- SegmentParameterFilterExpressionList
- SegmentParameterFilter
- SegmentParameterFilterScoping
- UserSegmentSequenceGroup
- UserSequenceStep
- UserSegmentExclusion
- UserExclusionDuration
- SessionSegment
- SessionSegmentCriteria
- SessionSegmentConditionGroup
- SessionCriteriaScoping
- SessionSegmentExclusion
- SessionExclusionDuration
- EventSegment
- EventSegmentCriteria
- EventSegmentConditionGroup
- EventCriteriaScoping
- EventSegmentExclusion
- EventExclusionDuration
- FunnelSubReport
- FunnelResponseMetadata
- SamplingMetadata
- PropertyQuota
- QuotaStatus
- 試してみる
Google アナリティクスのイベントデータのカスタマイズされた目標到達プロセス レポートを返します。API から返されるデータは、リクエストされたディメンションと指標の列を含む表です。
目標到達プロセスデータ探索では、ユーザーがコンバージョンに至るまでのステップをビジュアル表示し、各ステップでのユーザーの動向をすばやく確認できます。たとえば、見込み顧客がどのように買い物客になり、その後どのように顧客に変わるか、一見客がどのようにリピーターになるのかといったことです。この情報により、非効率的または放棄されたカスタマー ジャーニーを改善できます。詳しくは、GA4 のファネル データ探索をご覧ください。
この方法は、ベータ版に入る前に構文や機能に関するフィードバックを収集する目的で、アルファ版(安定版)で導入されています。この API に関するフィードバックは、Google Analytics Data API の目標到達プロセス レポートのフィードバックにご記入ください。
HTTP リクエスト
POST https://analyticsdata.googleapis.com/v1alpha/{property=properties/*}:runFunnelReport
この URL は gRPC Transcoding 構文を使用します。
パスパラメータ
パラメータ | |
---|---|
property |
省略可。イベントがトラッキングされる Google アナリティクス GA4 プロパティの識別子。本文ではなく URL パスで指定します。詳しくは、プロパティ ID を確認する方法をご覧ください。バッチ リクエスト内では、このプロパティを指定しないか、バッチレベルのプロパティと一致させる必要があります。 例: properties/1234 |
リクエスト本文
リクエストの本文には、次の構造のデータが含まれます。
JSON 表現 |
---|
{ "dateRanges": [ { object ( |
フィールド | |
---|---|
dateRanges[] |
省略可。読み取るデータの期間。複数の期間をリクエストすると、各レスポンス行にゼロから始まる期間のインデックスが含まれます。2 つの期間が重複している場合は、重複する日のイベントデータが両方の期間のレスポンス行に含まれます。 |
funnel |
省略可。このリクエストのファネルの設定。このファネル設定は必須です。 |
funnelBreakdown |
省略可。指定すると、この内訳により、ファネル テーブルのサブレポートのレスポンスにディメンションが追加されます。この内訳ディメンションでは、ファネルの各ステップが内訳ディメンションの一意の値に展開されます。たとえば、 |
funnelNextAction |
省略可。指定すると、次のアクションによって、目標到達プロセスのビジュアリゼーションのサブレポートのレスポンスにディメンションが追加されます。この「次のアクション」ディメンションでは、目標到達プロセスの各ステップが、次のアクションの一意の値に展開されます。たとえば、「 次のアクションは、 |
funnelVisualizationType |
省略可。目標到達プロセスのビジュアリゼーション タイプでは、目標到達プロセスのビジュアリゼーションのサブレポートのレスポンスに表示されるディメンションを制御します。指定しない場合は |
segments[] |
省略可。セグメントの構成セグメントはプロパティのデータのサブセットです。セグメントを含むファネル レポートでは、ファネルはセグメントごとに評価されます。 このリクエストで指定された各セグメントは、レスポンスに別々の行を生成します。レスポンスでは、各セグメントが名前で識別されます。 セグメント パラメータは省略可能です。リクエストは 4 つのセグメントに制限されます。 |
limit |
省略可。返される行数。指定しない場合は、10,000 行が返されます。API は、リクエストした数に関係なく、リクエストあたり最大 250,000 行を返します。 また、ディメンション値の数が |
dimensionFilter |
省略可。ディメンション フィルタを使用すると、特定のディメンション値のみをレポートに表示できます。詳しくは、レポートの作成: ディメンション フィルタで例をご覧ください。このフィルタでは指標を使用できません。 |
returnPropertyQuota |
省略可。このアナリティクス プロパティの割り当ての現在の状態を返すかどうかを切り替えます。割り当ては 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
「次のアクション」は、ユーザーが 1 ステップを達成した後、同じユーザーが次のステップを達成するまでの間のディメンションの値を示します。たとえば、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 日あたり最大 20 万トークン、アナリティクス 360 プロパティでは 1 日あたり 200 万トークンを使用できます。ほとんどの場合、リクエストで使用するトークンは 10 個未満です。 |
tokensPerHour |
標準のアナリティクス プロパティでは 1 時間あたり最大 40,000 トークン、アナリティクス 360 プロパティでは 1 時間あたり 400,000 トークンを使用できます。API リクエストで消費されるトークンの数は 1 つだけです。その数は、1 時間、1 日、プロジェクトごとの 1 時間あたりのすべての割り当てから差し引かれます。 |
concurrentRequests |
標準のアナリティクス プロパティでは、最大 10 個の同時リクエストを送信できます。アナリティクス 360 プロパティでは、最大 50 個の同時リクエストを使用できます。 |
serverErrorsPerProjectPerHour |
サーバーエラーは、標準のアナリティクス プロパティとクラウド プロジェクトのペアでは 1 時間あたり最大 10 件、アナリティクス 360 プロパティとクラウド プロジェクトのペアでは 1 時間あたり最大 50 件です。 |
potentiallyThresholdedRequestsPerHour |
アナリティクスのプロパティは、1 時間あたり最大 120 件のリクエストを送信でき、ディメンションにしきい値が設定されている可能性があります。バッチ リクエストでは、リクエストにしきい値が設定される可能性があるディメンションが含まれている場合、各レポート リクエストはこの割り当てに対して個別にカウントされます。 |
tokensPerProjectPerHour |
アナリティクスのプロパティでは、1 プロジェクトあたり 1 時間あたり最大 35% のトークンを使用できます。つまり、標準のアナリティクス プロパティでは 1 プロジェクトあたり 1 時間あたり最大 14,000 トークン、アナリティクス 360 プロパティでは 1 プロジェクトあたり 1 時間あたり最大 140,000 トークンを使用できます。API リクエストで消費されるトークンの数は 1 つだけです。その数は、1 時間、1 日、プロジェクトごとの 1 時間あたりのすべての割り当てから差し引かれます。 |
QuotaStatus
特定の割り当てグループの現在の状態。
JSON 表現 |
---|
{ "consumed": integer, "remaining": integer } |
フィールド | |
---|---|
consumed |
このリクエストによって消費される割り当て。 |
remaining |
このリクエストの後に残っている割り当て。 |