メソッド: reports.batchGet

アナリティクス データを返します。

HTTP リクエスト

POST https://analyticsreporting.googleapis.com/v4/reports:batchGet

(この URI は URI テンプレート構文を使用します。)

リクエストの本文

リクエストの本文には、次の構造を持つデータが含まれます。

JSON 表現

{
  "reportRequests": [
    {
      object(ReportRequest)
    }
  ],
}
フィールド名 タイプ 説明
reportRequests[] object(ReportRequest) 各リクエストには、別々のレスポンスが返されます。リクエストは最大で 5 つ送信できます。すべてのリクエストには、同じ dateRangesviewIdsegmentssamplingLevel、および cohortGroup が含まれている必要があります。

レスポンスの本文

成功した場合、レスポンスの本文には、次の構造を持つデータが含まれます。

Reporting API batchGet 呼び出しからのレポートを保持するメインの Response クラス。

JSON 表現

{
  "reports": [
    {
      object(Report)
    }
  ],
}
フィールド名 タイプ 説明
reports[] object(Report) 各リクエストに対応するレスポンス。

承認

次の OAuth スコープのいずれかが必要です。

  • https://www.googleapis.com/auth/analytics.readonly
  • https://www.googleapis.com/auth/analytics

ReportRequest

Reporting API リクエストを指定するメインの Request クラス。

JSON 表現

{
  "viewId": string,
  "dateRanges": [
    {
      object(DateRange)
    }
  ],
  "samplingLevel": enum(Sampling),
  "dimensions": [
    {
      object(Dimension)
    }
  ],
  "dimensionFilterClauses": [
    {
      object(DimensionFilterClause)
    }
  ],
  "metrics": [
    {
      object(Metric)
    }
  ],
  "metricFilterClauses": [
    {
      object(MetricFilterClause)
    }
  ],
  "filtersExpression": string,
  "orderBys": [
    {
      object(OrderBy)
    }
  ],
  "segments": [
    {
      object(Segment)
    }
  ],
  "pivots": [
    {
      object(Pivot)
    }
  ],
  "cohortGroup": {
    object(CohortGroup)
  },
  "pageToken": string,
  "pageSize": number,
  "includeEmptyRows": boolean,
  "hideTotals": boolean,
  "hideValueRanges": boolean,
}
フィールド名 タイプ 説明
viewId string データを取得するアナリティクスのビュー ID。同じ batchGet メソッド内の ReportRequest にはすべて同じ viewId が含まれている必要があります。
dateRanges[] object(DateRange) リクエストの期間。リクエストには、最大 2 つの期間を指定できます。レスポンスには、リクエストの各期間のディメンションの組み合わせごとに指標値のセットが含まれます。そのため、期間が 2 つある場合は、2 セットの指標値が存在します(1 つは、最初の期間の指標値、もう 1 つは 2 番目の期間の指標値です)。コホートまたはライフタイム バリューのリクエストでは、reportRequest.dateRanges フィールドを指定しないでください。期間を指定しない場合、デフォルトの期間は、(startDate: 現在の日付 - 7 日、endDate: 現在の日付 - 1 日)になります。同じ batchGet メソッド内の ReportRequest にはすべて同じ dateRanges 定義が含まれている必要があります。
samplingLevel enum(Sampling) 目的のレポートのサンプルサイズ。samplingLevel フィールドを指定しない場合は、DEFAULT のサンプリング レベルが使用されます。同じ batchGet メソッド内の ReportRequest にはすべて同じ samplingLevel 定義が含まれている必要があります。詳しくは、デベロッパー ガイドをご覧ください。
dimensions[] object(Dimension) リクエストするディメンション。リクエストには、合計 7 つのディメンションを指定できます。
dimensionFilterClauses[] object(DimensionFilterClause) ディメンション値をフィルタリングするためのディメンション フィルタの句。AND 演算子で論理的に結合されます。フィルタリングは、ディメンションの集計前に実行されます。そのため、返される指標は、関連するディメンションのみの合計を表すことに注意してください。
metrics[] object(Metric) リクエストする指標。少なくとも 1 つの指標を指定する必要があります。リクエストには、合計 10 個の指標を指定できます。
metricFilterClauses[] object(MetricFilterClause) 指標フィルタの句。AND 演算子で論理的に結合されます。指標フィルタは、最初の期間のみを参照し、比較期間は参照しません。指標のフィルタリングは、指標の集計後に実行されることに注意してください。
filtersExpression string リクエストで返されるデータを制限するディメンションまたは指標のフィルタ。filtersExpression を使用するには、フィルタリング対象のディメンションまたは指標に続けてフィルタ式を指定します。たとえば、式 ga:browser=~^Firefox では、Firefox で始まる ga:browser ディメンションが選択されます。ディメンションと指標のフィルタについて詳しくは、フィルタ リファレンスをご覧ください。
orderBys[] object(OrderBy) 出力行の並べ替え順。2 つの行を比較するために、差が検出されるまで後続の要素が順番に適用されます。出力のすべての期間の行の順序は同じになります。
segments[] object(Segment) リクエストで返されたデータをセグメント化します。セグメント定義は、セグメント リクエストのサブセットを調べるのに役立ちます。1 つのリクエストには、最大 4 つのセグメントを含めることができます。同じ batchGet メソッド内の ReportRequest にはすべて同じ segments 定義が含まれている必要があります。セグメントを含むリクエストには、ga:segment ディメンションが必要です。
pivots[] object(Pivot) ピボットの定義。リクエストには、最大 2 つのピボットを指定できます。
cohortGroup object(CohortGroup) このリクエストに関連付けられているコホート グループ。リクエストにコホート グループが含まれている場合は、ga:cohort ディメンションが存在する必要があります。同じ batchGet メソッド内の ReportRequest にはすべて同じ cohortGroup 定義が含まれている必要があります。
pageToken string 結果の次のページを取得するための連続トークン。これをリクエストに追加すると、pageToken の後の行が返されます。pageToken は、reports.batchGet リクエストに対するレスポンスにおいて nextPageToken パラメータで返された値を指定します。
pageSize number ページサイズは、ページングを設定するためのもので、返される最大行数を指定します。ページサイズは 0 以上にしてください。デフォルトでは、1 回のクエリで 1,000 行が返されます。指定した値に関係なく、アナリティクス Core Reporting API から返される行数は、リクエストにつき最大 100,000 行です。ディメンション セグメントの数が予想より少ない場合、リクエストしたよりも少ない行数が返されます。たとえば、ga:country の有効な値は 300 個に満たないため、国のみでセグメント化すると、pageSize に 300 より大きな値を設定しても、取得できる行数は 300 行以下です。
includeEmptyRows boolean false に設定すると、返される指標がすべて 0 に等しい場合は、レスポンスに行が含まれません。デフォルトは false です(そのような行が除外されます)。
hideTotals boolean true に設定すると、すべての期間において、一致するすべての行のすべての指標の合計が非表示になります。デフォルトは false です(合計が返されます)。
hideValueRanges boolean true に設定すると、一致するすべての行で最小値と最大値が非表示になります。デフォルトは false です(値の範囲が返されます)。

DateRange

連続的な日の集合、つまり startDate、startDate + 1 日、...、endDate のようなひと続きの期間です。開始日と終了日は ISO8601 の日付形式(YYYY-MM-DD)で指定します。

JSON 表現

{
  "startDate": string,
  "endDate": string,
}
フィールド名 タイプ 説明
startDate string クエリの開始日。YYYY-MM-DD 形式で指定します。
endDate string クエリの終了日。YYYY-MM-DD 形式で指定します。

サンプリング

サンプリング レベルの値。

列挙値 説明
SAMPLING_UNSPECIFIED samplingLevel フィールドを指定しない場合は、DEFAULT のサンプリング レベルが使用されます。
DEFAULT 速度と精度のバランスがとれたサンプルサイズでレスポンスが返されます。
SMALL サンプリング サイズを小さくすることにより、高速なレスポンスが返されます。
LARGE サンプリング サイズを大きくすることにより、より正確なレスポンスが返されます。ただし、レスポンス速度が低下する場合があります。

ディメンション

ディメンションはデータの属性です。たとえば、ディメンション ga:city はセッションの性質を示し、「横浜」、「川崎」などセッションが発生した市区町村を示します。

JSON 表現

{
  "name": string,
  "histogramBuckets": [
    string
  ],
}
フィールド名 タイプ 説明
name string 取得するディメンションの名前(例: ga:browser)。
histogramBuckets[] string
(int64 format)

空でない場合は、文字列が int64 に変換された後、ディメンション値がバケットに格納されます。整数値を文字列として表現していないディメンション値は、ゼロに変換されます。バケットの値は、昇順にする必要があります。各バケットは、下限はクローズし、上限はオープンしています。「最初」のバケットには最初の境界未満のすべての値が含まれます。「最後」のバケットには無限大までのすべての値が含まれます。バケット内のディメンション値は、新しいディメンション値に変換されます。たとえば、「0, 1, 3, 4, 7」というリストが指定された場合は、以下のバケットが返されます。

  • バケット 1: 0 未満の値、"0 未満" のディメンション値
  • バケット 2: [0,1) の値、"0" のディメンション値
  • バケット 3: [1,3) の値、"1-2" のディメンション値
  • バケット 4: [3,4) の値、"3" のディメンション値
  • バケット 5: [4,7) の値、"4-6" のディメンション値
  • バケット 6: 7 以上の値、"7+" のディメンション値

注: いずれかのディメンションでヒストグラムの変更を適用し、並べ替えでそのディメンションを使用している場合は、並べ替えの種類 HISTOGRAM_BUCKET をその目的で使用する必要があります。そうしない場合、ディメンション値は辞書(辞書式)順序に従って並べ替えられます。たとえば、辞書の昇順は以下のようになります。

"<50"、"1001+"、"121-1000"、"50-120"

HISTOGRAM_BUCKET の昇順は以下のようになります。

"<50"、"50-120"、"121-1000"、"1001+"

クライアントは、ヒストグラムが変更されたディメンションに対して、"orderType": "HISTOGRAM_BUCKET" を明示的にリクエストする必要があります。

DimensionFilterClause

ディメンション フィルタのグループ。演算子の値を設定し、フィルタを論理的に結合する方法を指定します。

JSON 表現

{
  "operator": enum(FilterLogicalOperator),
  "filters": [
    {
      object(DimensionFilter)
    }
  ],
}
フィールド名 タイプ 説明
operator enum(FilterLogicalOperator) 複数のディメンション フィルタを結合するための演算子。指定しない場合は、OR として処理されます。
filters[] object(DimensionFilter) 反復される一連のフィルタ。指定された演算子に基づいて、論理的に結合されます。

FilterLogicalOperator

フィルタを論理的に結合する方法。

列挙値 説明
OPERATOR_UNSPECIFIED 演算子が未指定です。OR として処理されます。
OR 論理 OR 演算子。
AND 論理 AND 演算子。

DimensionFilter

ディメンション フィルタでは、ディメンションのフィルタリング オプションを指定します。

JSON 表現

{
  "dimensionName": string,
  "not": boolean,
  "operator": enum(Operator),
  "expressions": [
    string
  ],
  "caseSensitive": boolean,
}
フィールド名 タイプ 説明
dimensionName string フィルタを適用するディメンション。DimensionFilter には、ディメンションを含める必要があります。
not boolean 論理演算子 NOT。このブール値を true に設定すると、一致するディメンション値がレポートから除外されます。デフォルトは false です。
operator enum(Operator) ディメンションを式に一致させる方法。デフォルトは REGEXP です。
expressions[] string 一致させる文字列または正規表現。演算子が IN_LIST でない場合は、リストの先頭の値のみが比較に使用されます。演算子が IN_LIST の場合は、IN_LIST 演算子の説明にあるとおり、リスト全体を使用して、ディメンションがフィルタリングされます。
caseSensitive boolean 一致で大文字と小文字を区別するかどうか。デフォルトは false です。

演算子

さまざまなマッチタイプがサポートされています。

列挙値 説明
OPERATOR_UNSPECIFIED マッチタイプを指定しない場合は、REGEXP として処理されます。
REGEXP 一致式が正規表現として処理されます。他のマッチタイプはいずれも、正規表現としては処理されません。
BEGINS_WITH 指定された一致式で始まる値を一致させます。
ENDS_WITH 指定された一致式で終わる値を一致させます。
PARTIAL 部分一致。
EXACT 値が一致式全体と一致する必要があります。
NUMERIC_EQUAL

整数を比較するフィルタ。大文字と小文字の区別は無視され、式は整数を表す文字列と見なされます。失敗の条件を以下に示します。

  • 式が有効な int64 でない場合は、クライアントでエラーが発生します。
  • 有効な int64 値でない入力ディメンションは、フィルタに一致しません。
NUMERIC_GREATER_THAN ディメンションが一致式よりも数値的に大きいかどうかを調べます。制限については、NUMERIC_EQUALS の説明をご覧ください。
NUMERIC_LESS_THAN ディメンションが一致式よりも数値的に小さいかどうかを調べます。制限については、NUMERIC_EQUALS の説明をご覧ください。
IN_LIST

このオプションは、選択された値のリストから任意の値を取得できる式を持つディメンション フィルタを指定するために使用されます。すべての単一のレスポンス行について、論理和演算された複数の完全一致ディメンション フィルタを評価しないようにすることができます。例:


expressions: ["A", "B", "C"]

ディメンションの値が A、B、C のいずれかであるすべてのレスポンス行が、この DimensionFilter に一致します。

指標

指標は、定量的な測定結果です。たとえば、指標 ga:users は、リクエストした期間のユーザーの総数を示します。

JSON 表現

{
  "expression": string,
  "alias": string,
  "formattingType": enum(MetricType),
}
フィールド名 タイプ 説明
expression string リクエスト内の指標式。式は 1 つ以上の指標と数値から構成されます。使用できる演算子は、加算(+)、減算(-)、否定(単項 -)、除算(/)、乗算(*)、括弧、正の基数(0-9)です。これらの演算子は、小数を含めることができ、最大 1,024 文字に制限されています。例: ga:totalRefunds/ga:users。ほとんどの場合、指標式は、ga:users のような 1 つの指標名です。MetricType を組み合わせて(例: CURRENCY + PERCENTAGE)指標を追加すると、予期しない結果が発生することがあります。
alias string 指標式のエイリアスは、式の代替名です。エイリアスは、フィルタリングと並べ替えに使用できます。このフィールドはオプションです。式が 1 つの指標ではなく、複雑な式で、フィルタリングや並べ替えで使用できない場合に便利です。エイリアスは、レスポンス列ヘッダーでも使用されます。
formattingType enum(MetricType) 指標式の書式設定の方法を指定します(INTEGER など)。

MetricType

指標のタイプ

列挙値 説明
METRIC_TYPE_UNSPECIFIED 指標のタイプは指定されません。
INTEGER 整数の指標。
FLOAT 浮動小数点の指標。
CURRENCY 通貨の指標。
PERCENT パーセントの指標。
TIME 時間の指標(HH:MM:SS 形式)。

MetricFilterClause

指標フィルタのグループを表します。演算子の値を設定し、フィルタを論理的に結合する方法を指定します。

JSON 表現

{
  "operator": enum(FilterLogicalOperator),
  "filters": [
    {
      object(MetricFilter)
    }
  ],
}
フィールド名 タイプ 説明
operator enum(FilterLogicalOperator) 複数の指標フィルタを結合するための演算子。指定しない場合は、OR として処理されます。
filters[] object(MetricFilter) 反復される一連のフィルタ。指定された演算子に基づいて、論理的に結合されます。

MetricFilter

MetricFilter では、指標のフィルタを指定します。

JSON 表現

{
  "metricName": string,
  "not": boolean,
  "operator": enum(Operator),
  "comparisonValue": string,
}
フィールド名 タイプ 説明
metricName string フィルタ対象の指標。metricFilter には、指標名を含める必要があります。指標名は、以前指標として定義したエイリアスを指定することも、指標式を指定することもできます。
not boolean 論理演算子 NOT。このブール値を true に設定すると、一致した指標値がレポートから除外されます。デフォルトは false です。
operator enum(Operator) 条件とする比較の内容(指標が comparisonValue と比べて小さい(LESS_THAN)、大きい(GREATER_THAN)、または等しい(EQUAL))を指定します。デフォルトは EQUAL です。演算子が IS_MISSING の場合、comparisonValue は無視し、指標が欠落しているかどうかを確認します。
comparisonValue string 比較対象の値。

演算子

各種の比較タイプのオプションです。

列挙値 説明
OPERATOR_UNSPECIFIED 演算子を指定しない場合は、EQUAL として処理されます。
EQUAL 指標値は、比較値と正確に一致している必要があります。
LESS_THAN 指標値は、比較値より小さくなければなりません。
GREATER_THAN 指標値は、比較値より大きくなければなりません。
IS_MISSING 指標が欠落しているかどうか検証されます。comparisonValue は考慮されません。

OrderBy

並べ替えオプションを指定します。

JSON 表現

{
  "fieldName": string,
  "orderType": enum(OrderType),
  "sortOrder": enum(SortOrder),
}
フィールド名 タイプ 説明
fieldName string 並べ替えの基準にするフィールド。デフォルトの並べ替え順は昇順です(例: ga:browser)。ここでは、並べ替えのために指定できるフィールドは 1 つのみであることに注意してください。たとえば、ga:browser, ga:city は無効です。
orderType enum(OrderType) 並べ替えのタイプ。デフォルトの orderType は VALUE です。
sortOrder enum(SortOrder) フィールドの並べ替え順。

OrderType

OrderType は、並べ替え順の決定方法を制御します。

列挙値 説明
ORDER_TYPE_UNSPECIFIED 並べ替えのタイプを指定しない場合は、値に基づく並べ替えとして処理されます。
VALUE 並べ替え順は、選択した列の値に基づきます。参照するのは、先頭の期間のみです。
DELTA 並べ替え順は、先頭の 2 つの期間における選択した列の値の差に基づきます。期間が 2 つある場合にのみ使用できます。
SMART 並べ替え順は、選択した列の加重値に基づきます。列の形式が n/d の場合、この比率の加重値は (n + totals.n)/(d + totals.d) になります。比率を表す指標でのみ使用できます。
HISTOGRAM_BUCKET ヒストグラムの並べ替えのタイプは、空でないヒストグラム バケットを持つディメンション列にのみ適用できます。
DIMENSION_AS_INTEGER ディメンションが固定長の数値の場合は、通常の並べ替えを使用できます。DIMENSION_AS_INTEGER を使用できるのは、ディメンションが可変長の数値の場合です。

SortOrder

並べ替えの順序。

列挙値 説明
SORT_ORDER_UNSPECIFIED 並べ替え順を指定しない場合、デフォルトは昇順です。
ASCENDING 昇順で並べ替え。フィールドが昇順で並べ替えられます。
DESCENDING 降順で並べ替え。フィールドが降順で並べ替えられます。

Segment

レポートをセグメント化する必要がある場合のセグメント定義。セグメントはアナリティクスのデータのサブセットです。たとえば、すべてのユーザーのうち、特定の国や都市のユーザーだけを 1 つのセグメントに設定できます。

JSON 表現

{

  // Union field dynamicOrById can be only one of the following:
  "dynamicSegment": {
    object(DynamicSegment)
  },
  "segmentId": string,
  // End of list of possible types for union field dynamicOrById.
}
フィールド名 タイプ 説明
Union フィールド dynamicOrById。セグメントは、DynamicSegment を使用して動的に定義することも、組み込みセグメントまたはカスタム セグメントの ID を使用して定義することもできます。dynamicOrById は、以下のいずれか 1 つのみが可能です。
dynamicSegment object(DynamicSegment) リクエストの動的セグメント定義。
segmentId string 組み込みセグメントまたはカスタム セグメントのセグメント ID(例: gaid::-3)。

DynamicSegment

リクエスト内のセグメントを定義するための動的セグメント定義。セグメントでは、ユーザーとセッションのいずれかまたは両方を選択できます。

JSON 表現

{
  "name": string,
  "userSegment": {
    object(SegmentDefinition)
  },
  "sessionSegment": {
    object(SegmentDefinition)
  },
}
フィールド名 タイプ 説明
name string 動的セグメントの名前。
userSegment object(SegmentDefinition) セグメントに含めるユーザーを選択するためのユーザー セグメント。
sessionSegment object(SegmentDefinition) セグメントに含めるセッションを選択するためのセッション セグメント。

SegmentDefinition

SegmentDefinition では、AND 論理演算子で結合される一連の SegmentFilters となるセグメントを定義します。

JSON 表現

{
  "segmentFilters": [
    {
      object(SegmentFilter)
    }
  ],
}
フィールド名 タイプ 説明
segmentFilters[] object(SegmentFilter) セグメントは、AND 論理演算子で結合される一連のセグメント フィルタで定義されます。

SegmentFilter

SegmentFilter では、シンプル セグメントまたはシーケンス セグメントになるセグメントを定義します。シンプル セグメントの条件には、セッションまたはユーザーを選択するディメンションおよび指標の条件が含まれます。シーケンス セグメントの条件を使用した場合は、順次条件に基づいてユーザーまたはセッションを選択できます。

JSON 表現

{
  "not": boolean,

  // Union field simpleOrSequence can be only one of the following:
  "simpleSegment": {
    object(SimpleSegment)
  },
  "sequenceSegment": {
    object(SequenceSegment)
  },
  // End of list of possible types for union field simpleOrSequence.
}
フィールド名 タイプ 説明
not boolean

true の場合は、シンプル セグメントまたはシーケンス セグメントの補数と一致させます。たとえば、「New York」以外からのアクセスをすべて一致させるには、以下のようにセグメントを定義します。


  "sessionSegment": {
    "segmentFilters": [{
      "simpleSegment" :{
        "orFiltersForSegment": [{
          "segmentFilterClauses":[{
            "dimensionFilter": {
              "dimensionName": "ga:city",
              "expressions": ["New York"]
            }
          }]
        }]
      },
      "not": "True"
    }]
  },
Union フィールド simpleOrSequence。シンプル セグメント定義またはシーケンス セグメント定義です。simpleOrSequence は、以下のいずれか 1 つのみが可能です。
simpleSegment object(SimpleSegment) シンプル セグメント条件は、結合可能な 1 つ以上のディメンション条件または指標条件から構成されます。
sequenceSegment object(SequenceSegment) シーケンス条件は、1 つ以上のステップで構成されます。この場合、各ステップは、1 つ以上のディメンション条件または指標条件で定義されます。特殊なシーケンス演算子を使用して、複数のステップを組み合わせることができます。

SimpleSegment

シンプル セグメント条件は、結合可能な 1 つ以上のディメンション条件または指標条件から構成されます。

JSON 表現

{
  "orFiltersForSegment": [
    {
      object(OrFiltersForSegment)
    }
  ],
}
フィールド名 タイプ 説明
orFiltersForSegment[] object(OrFiltersForSegment) AND 論理演算子で結合されるセグメント フィルタのグループのリスト。

OrFiltersForSegment

OR グループ内のセグメント フィルタのリストは OR 論理演算子で結合されます。

JSON 表現

{
  "segmentFilterClauses": [
    {
      object(SegmentFilterClause)
    }
  ],
}
フィールド名 タイプ 説明
segmentFilterClauses[] object(SegmentFilterClause) OR 演算子で結合されるセグメント フィルタのリスト。

SegmentFilterClause

セグメント定義で使用されるフィルタ句は、指標またはディメンション フィルタにすることができます。

JSON 表現

{
  "not": boolean,

  // Union field dimensionOrMetricFilter can be only one of the following:
  "dimensionFilter": {
    object(SegmentDimensionFilter)
  },
  "metricFilter": {
    object(SegmentMetricFilter)
  },
  // End of list of possible types for union field dimensionOrMetricFilter.
}
フィールド名 タイプ 説明
not boolean フィルタの補集合を一致させます(!)。
Union フィールド dimensionOrMetricFilter。ディメンションまたは指標のフィルタ dimensionOrMetricFilter は、以下のいずれか 1 つのみが可能です。
dimensionFilter object(SegmentDimensionFilter) セグメント定義のディメンション フィルタ。
metricFilter object(SegmentMetricFilter) セグメント定義の指標フィルタ。

SegmentDimensionFilter

ディメンション フィルタでは、ディメンションのフィルタリング オプションを指定します。

JSON 表現

{
  "dimensionName": string,
  "operator": enum(Operator),
  "caseSensitive": boolean,
  "expressions": [
    string
  ],
  "minComparisonValue": string,
  "maxComparisonValue": string,
}
フィールド名 タイプ 説明
dimensionName string フィルタを適用するディメンションの名前。
operator enum(Operator) ディメンションを式に一致させるために使用する演算子。
caseSensitive boolean 一致に大文字と小文字の区別がある場合、IN_LIST 演算子では無視されます。
expressions[] string 式のリスト。すべての演算子で先頭の要素のみが使用されます。
minComparisonValue string BETWEEN マッチタイプの最小比較値。
maxComparisonValue string BETWEEN マッチタイプの最大比較値。

演算子

さまざまなマッチタイプがサポートされています。

列挙値 説明
OPERATOR_UNSPECIFIED マッチタイプを指定しない場合は、REGEXP として処理されます。
REGEXP 一致式が正規表現として処理されます。他のマッチタイプはいずれも、正規表現としては処理されません。
BEGINS_WITH 指定された一致式で始まる値を一致させます。
ENDS_WITH 指定された一致式で終わる値を一致させます。
PARTIAL 部分一致。
EXACT 値が一致式全体と一致する必要があります。
IN_LIST

このオプションは、選択された値のリストから任意の値を取得できる式を持つディメンション フィルタを指定するために使用されます。すべての単一のレスポンス行について、論理和演算された複数の完全一致ディメンション フィルタを評価しないようにすることができます。例:


expressions: ["A", "B", "C"]

ディメンションの値が A、B、C のいずれかであるすべてのレスポンス行が、この DimensionFilter に一致します。

NUMERIC_LESS_THAN

整数を比較するフィルタ。大文字と小文字の区別は無視され、式は整数を表す文字列と見なされます。失敗の条件を以下に示します。

  • 式が有効な int64 でない場合は、クライアントでエラーが発生します。
  • 有効な int64 値でない入力ディメンションは、フィルタに一致しません。

ディメンションが一致式よりも数値的に小さいかどうかを調べます。

NUMERIC_GREATER_THAN ディメンションが一致式よりも数値的に大きいかどうかを調べます。
NUMERIC_BETWEEN ディメンションが数値的に一致式の下限値と上限値の間にあるかどうかを調べます。下限値と上限値そのものは一致範囲に含まれません。

SegmentMetricFilter

セグメント フィルタ句で使用される指標フィルタ。

JSON 表現

{
  "scope": enum(Scope),
  "metricName": string,
  "operator": enum(Operator),
  "comparisonValue": string,
  "maxComparisonValue": string,
}
フィールド名 タイプ 説明
scope enum(Scope) 指標のスコープにより、その指標が定義されるレベルが規定されます。指定された指標スコープは、データモデルで定義されたプライマリ スコープ以上である必要があります。プライマリ スコープは、セグメントで選択されているのがユーザーかセッションかによって決まります。
metricName string フィルタ対象の指標。metricFilter には、指標名を含める必要があります。
operator enum(Operator) 指標を比較するために実行する演算子を指定します。デフォルトは EQUAL です。
comparisonValue string 比較対象の値。演算子が BETWEEN の場合、この値は比較範囲の下限値として扱われます。
maxComparisonValue string 比較範囲の上限値です。BETWEEN 演算子でのみ使用されます。

スコープ

指標のスコープにより、その指標が定義されるレベルが規定されます(PRODUCTHITSESSION、または USER)。指標値は、そのプライマリ スコープより大きなスコープで報告することもできます。たとえば、ga:pageviewsga:transactions は、セッションまたはユーザーで発生するヒットごとに追加することで、セッション レベルとユーザーレベルで報告できます。

列挙値 説明
UNSPECIFIED_SCOPE スコープが指定されていない場合は、セグメントで選択を試みているのがユーザーとセッションのいずれであるかに応じて、条件スコープ USER または SESSION にデフォルト設定されます。
PRODUCT 商品スコープ。
HIT ヒットスコープ。
SESSION セッション スコープ。
USER ユーザー スコープ。

演算子

各種の比較タイプのオプションです。

列挙値 説明
UNSPECIFIED_OPERATOR 演算子が指定されていない場合は、LESS_THAN 演算子として処理されます。
LESS_THAN 指標値が比較値より小さいかどうかを調べます。
GREATER_THAN 指標値が比較値より大きいかどうかを調べます。
EQUAL 等号演算子。
BETWEEN Between 演算子。上限値と下限値は一致範囲に含まれません。比較には LTGT が使用されます。

SequenceSegment

シーケンス条件は、1 つ以上のステップで構成されます。この場合、各ステップは、1 つ以上のディメンション条件または指標条件で定義されます。特殊なシーケンス演算子を使用して、複数のステップを組み合わせることができます。

JSON 表現

{
  "segmentSequenceSteps": [
    {
      object(SegmentSequenceStep)
    }
  ],
  "firstStepShouldMatchFirstHit": boolean,
}
フィールド名 タイプ 説明
segmentSequenceSteps[] object(SegmentSequenceStep) シーケンスのステップのリスト。
firstStepShouldMatchFirstHit boolean 設定した場合、最初のステップの条件は、(期間内の)ユーザーの最初のヒットに一致する必要があります。

SegmentSequenceStep

セグメント シーケンスの定義。

JSON 表現

{
  "orFiltersForSegment": [
    {
      object(OrFiltersForSegment)
    }
  ],
  "matchType": enum(MatchType),
}
フィールド名 タイプ 説明
orFiltersForSegment[] object(OrFiltersForSegment) シーケンスは、OR でグループ化されたフィルタを AND 演算子で結合したリストで指定されます。
matchType enum(MatchType) ステップを直ちに先行して実行するか、それとも次のステップの前の任意のタイミングで実行するかを指定します。

MatchType

シーケンスのマッチタイプ。

列挙値 説明
UNSPECIFIED_MATCH_TYPE マッチタイプを指定しないと、PRECEDES として処理されます。
PRECEDES 前のステップが次のステップより先に実行されることを示します。
IMMEDIATELY_PRECEDES 前のステップが次のステップの直前に実行されることを示します。

ピボット

ピボットは、リクエストのピボット セクションを示します。ピボットは、セカンダリ ディメンションのデータをピボットし、特定のレポートのテーブルに含まれる情報を再配置するのに役立ちます。

JSON 表現

{
  "dimensions": [
    {
      object(Dimension)
    }
  ],
  "dimensionFilterClauses": [
    {
      object(DimensionFilterClause)
    }
  ],
  "metrics": [
    {
      object(Metric)
    }
  ],
  "startGroup": number,
  "maxGroupCount": number,
}
フィールド名 タイプ 説明
dimensions[] object(Dimension) ピボット列として表示するディメンションのリスト。ピボットには、最大 4 つのディメンションを指定できます。ピボット ディメンションは、リクエストで許可されているディメンション総数の制限の一部です。
dimensionFilterClauses[] object(DimensionFilterClause) DimensionFilterClause は、AND 演算子で論理的に結合されます。このすべての DimensionFilterClause に含まれるデータのみが、このピボットの地域項目の値に影響します。ディメンション フィルタを使用すると、ピボットの地域項目に表示される列を制限できます。たとえば、ピボットの地域項目に、リクエストされたディメンションとして ga:browser があり、ga:browser を「IE」または「Firefox」のみに制限するキーフィルタを指定した場合は、これらの 2 つのブラウザのみが列として表示されます。
metrics[] object(Metric) ピボット指標。ピボット指標は、リクエストで許可されている指標総数の制限の一部です。
startGroup number

k 個の指標がリクエストされた場合、レスポンスでは、データに応じて k の倍数の列がレポートに含まれます。たとえば、ディメンション ga:browser に対してピボットを実行した場合、「Firefox」の列が k 個、「IE」の列が k 個、「Chrome」の列が k 個取得されるといった具合です。列のグループの順序は、k 個の値の先頭の「合計」の降順で決定されます。これで順序を決定できない場合は、最初に先頭のピボット ディメンションの辞書式順序、次に 2 番目のピボット ディメンションの辞書式順序というように順序が決定されます。たとえば、Firefox、IE、Chrome の先頭の値の合計がそれぞれ 8、2、8 の場合、列の順序は、Chrome、Firefox、IE になります。

レスポンスに含める k 個の列のグループは、以下のフィールドを使用して選択できます。

maxGroupCount number 返されるグループの最大数を指定します。デフォルトは 10、最大値は 1,000 です。

CohortGroup

コホート グループを定義します。例:

"cohortGroup": {
  "cohorts": [{
    "name": "cohort 1",
    "type": "FIRST_VISIT_DATE",
    "dateRange": { "startDate": "2015-08-01", "endDate": "2015-08-01" }
  },{
    "name": "cohort 2"
     "type": "FIRST_VISIT_DATE"
     "dateRange": { "startDate": "2015-07-01", "endDate": "2015-07-01" }
  }]
}
JSON 表現

{
  "cohorts": [
    {
      object(Cohort)
    }
  ],
  "lifetimeValue": boolean,
}
フィールド名 タイプ 説明
cohorts[] object(Cohort) コホートの定義。
lifetimeValue boolean

ライフタイム バリュー(LTV)を有効にします。LTV では、さまざまなチャネルを通じて獲得されたユーザーのライフタイム バリューが測定されます。詳しくは、コホート分析およびライフタイム バリューをご覧ください。lifetimeValue の値が false の場合は、以下のようになります。

  • 指標値は管理画面のコホート レポートの値とほぼ同じになります。
  • コホート定義の期間をカレンダーの週および月に合わせて調整する必要があります。つまり、ga:cohortNthWeek をリクエストしている間、コホート定義の startDate は Sunday、endDate は次の Saturday にする必要があります。また、ga:cohortNthMonth の場合、startDate は月の初日、endDate は月の末日にする必要があります。

lifetimeValue が true のときは、以下のようになります。

  • 指標値は管理画面のライフタイム バリュー レポートの値に一致します。
  • ライフタイム バリュー レポートは、ユーザーを獲得した日から 90 日間でどのようにユーザーの価値(収益)が増加し、エンゲージメント(アプリビュー、目標の完了数、セッション数、セッション継続時間)が促進されたかを示します。
  • 指標が時間増分ごとのユーザーあたりの累積平均として計算されます。
  • コホート定義の期間をカレンダーの週と月の境界に合わせて調整する必要がありません。
  • viewIdアプリビュー ID でなければなりません。

コホート

コホートを定義します。コホートとは、共通の特性を持つユーザーのグループです。たとえば、獲得日が同じすべてのユーザーは同じコホートに属します。

JSON 表現

{
  "name": string,
  "type": enum(Type),
  "dateRange": {
    object(DateRange)
  },
}
フィールド名 タイプ 説明
name string コホートの一意の名前。定義しない場合、名前は、cohort_[1234...] という値を使用して自動的に生成されます。
type enum(Type) コホートのタイプ。現在、サポートされるタイプは、FIRST_VISIT_DATE のみです。このフィールドを指定しない場合、コホートは FIRST_VISIT_DATE タイプのコホートとして処理されます。
dateRange object(DateRange) これは FIRST_VISIT_DATE コホートで使用されます。このコホートでは、最初のアクセス日が DateRange で定義された開始日と終了日の間であるユーザーが選択されます。期間はコホート リクエストに応じて調整する必要があります。リクエストに ga:cohortNthDay が含まれている場合、これは正確に 1 日でなければなりません。ga:cohortNthWeek が含まれている場合、これは週の境界に合わせて調整する必要があります(開始日が日曜日、終了日が土曜日)。ga:cohortNthMonth の場合は、期間を月に合わせて調整する必要があります(開始日が月の初日、終了日が月の末日)。LTV リクエストの場合、そのような制限はありません。reportsRequest.dateRanges フィールドに期間を指定する必要はありません。

タイプ

コホートのタイプ。

列挙値 説明
UNSPECIFIED_COHORT_TYPE 指定しない場合は、FIRST_VISIT_DATE として処理されます。
FIRST_VISIT_DATE 最初のアクセス日に基づいて選択されたコホート。

レポート

リクエストに対応するデータ レスポンス。

JSON 表現

{
  "columnHeader": {
    object(ColumnHeader)
  },
  "data": {
    object(ReportData)
  },
  "nextPageToken": string,
}
フィールド名 タイプ 説明
columnHeader object(ColumnHeader) 列ヘッダー。
data object(ReportData) レスポンス データ。
nextPageToken string リスト内の次のページの結果を取得するページトークン。

ColumnHeader

列ヘッダー。

JSON 表現

{
  "dimensions": [
    string
  ],
  "metricHeader": {
    object(MetricHeader)
  },
}
フィールド名 タイプ 説明
dimensions[] string レスポンスのディメンション名。
metricHeader object(MetricHeader) レスポンスの指標に対する指標ヘッダー。

MetricHeader

指標のヘッダー。

JSON 表現

{
  "metricHeaderEntries": [
    {
      object(MetricHeaderEntry)
    }
  ],
  "pivotHeaders": [
    {
      object(PivotHeader)
    }
  ],
}
フィールド名 タイプ 説明
metricHeaderEntries[] object(MetricHeaderEntry) レスポンスの指標のヘッダー。
pivotHeaders[] object(PivotHeader) レスポンスのピボットのヘッダー。

MetricHeaderEntry

指標のヘッダー。

JSON 表現

{
  "name": string,
  "type": enum(MetricType),
}
フィールド名 タイプ 説明
name string ヘッダーの名前。
type enum(MetricType) 指標のタイプ(例: INTEGER)。

PivotHeader

リクエストで定義された各ピボット セクションのヘッダー。

JSON 表現

{
  "pivotHeaderEntries": [
    {
      object(PivotHeaderEntry)
    }
  ],
  "totalPivotGroupsCount": number,
}
フィールド名 タイプ 説明
pivotHeaderEntries[] object(PivotHeaderEntry) 単一のピボット セクション ヘッダー。
totalPivotGroupsCount number このピボットのグループの総数。

PivotHeaderEntry

レスポンスのピボット セクションでリクエストされた指標に対応する各指標列のヘッダー。

JSON 表現

{
  "dimensionNames": [
    string
  ],
  "dimensionValues": [
    string
  ],
  "metric": {
    object(MetricHeaderEntry)
  },
}
フィールド名 タイプ 説明
dimensionNames[] string ピボット レスポンスのディメンションの名前。
dimensionValues[] string ピボットのディメンションの値。
metric object(MetricHeaderEntry) ピボットの指標に対する指標ヘッダー。

ReportData

レポートのデータ部分。

JSON 表現

{
  "rows": [
    {
      object(ReportRow)
    }
  ],
  "totals": [
    {
      object(DateRangeValues)
    }
  ],
  "rowCount": number,
  "minimums": [
    {
      object(DateRangeValues)
    }
  ],
  "maximums": [
    {
      object(DateRangeValues)
    }
  ],
  "samplesReadCounts": [
    string
  ],
  "samplingSpaceSizes": [
    string
  ],
  "isDataGolden": boolean,
}
フィールド名 タイプ 説明
rows[] object(ReportRow) ディメンションの一意の組み合わせごとに 1 つの ReportRow があります。
totals[] object(DateRangeValues) リクエストされた期間ごとに、クエリに一致するすべての行について、リクエストされたすべての値の形式で合計が取得されます。値の形式の合計は、最初に値の形式で言及された指標を合計し、次に値の形式をスカラー式として評価することにより計算されます。たとえば、3 / (ga:sessions + 2) の合計を得るには、3 / ((関連するすべての ga:sessions の合計) + 2) を計算します。合計は、ページ設定の前に計算されます。
rowCount number このクエリの一致行の総数。
minimums[] object(DateRangeValues) すべての一致行で表示される最小値と最大値。リクエストの hideValueRanges が false、または rowCount がゼロの場合、これらは両方とも空です。
maximums[] object(DateRangeValues) すべての一致行で表示される最小値と最大値。リクエストの hideValueRanges が false、または rowCount がゼロの場合、これらは両方とも空です。
samplesReadCounts[] string
(int64 format)
結果がサンプリングされている場合に、読み取られたサンプルの総数が返されます(期間あたり 1 エントリ)。結果をサンプリングしない場合、このフィールドは定義されません。詳しくは、デベロッパー ガイドをご覧ください。
samplingSpaceSizes[] string
(int64 format)
結果がサンプリングされている場合に、存在するサンプルの総数が返されます(期間あたり 1 エントリ)。結果をサンプリングしない場合、このフィールドは定義されません。詳しくは、デベロッパー ガイドをご覧ください。
isDataGolden boolean このリクエストに対するレスポンスが Golden であるかどうかを示します。データが Golden になるのは、後で要求されたときに、まったく同じリクエストに対して異なる結果が生成されない場合です。

ReportRow

レポートの行。

JSON 表現

{
  "dimensions": [
    string
  ],
  "metrics": [
    {
      object(DateRangeValues)
    }
  ],
}
フィールド名 タイプ 説明
dimensions[] string リクエストされたディメンションのリスト。
metrics[] object(DateRangeValues) リクエストされた各 DateRange の指標のリスト。

DateRangeValues

DateRange / ディメンションの 1 つの組み合わせに対する指標のリストを返すために使用されます。

JSON 表現

{
  "values": [
    string
  ],
  "pivotValueRegions": [
    {
      object(PivotValueRegion)
    }
  ],
}
フィールド名 タイプ 説明
values[] string それぞれの値は、リクエストの各指標に対応します。
pivotValueRegions[] object(PivotValueRegion) それぞれのピボットの地域項目の値。

PivotValueRegion

ピボットの地域項目の指標値。

JSON 表現

{
  "values": [
    string
  ],
}
フィールド名 タイプ 説明
values[] string それぞれのピボットの地域項目の指標値。

試してみる