Method: reports.batchGet

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

HTTP リクエスト

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

この URL は gRPC Transcoding 構文を使用します。

リクエスト本文

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

JSON 表現 
{
  "reportRequests": [
    {
      object(ReportRequest)
    }
  ],
  "useResourceQuotas": boolean
}
フィールド
reportRequests[]

object(ReportRequest)

各リクエストには、別々のレスポンスが返されます。リクエストは最大で 5 つ送信できます。すべてのリクエストで dateRanges、viewId、segments、samplingLevel、cohortGroup が同じである必要があります。
useResourceQuotas

boolean

リソースベースの割り当てを有効にします（デフォルトは False）。このフィールドを True に設定した場合、ビュー（プロファイル）ごとの割り当てはリクエストの計算コストによって管理されます。費用ベースの割り当てを使用すると、有効なサンプリング レートが高くなるので注意してください。（SMALL は 1, 000 万、LARGE は 1 億。詳細については、上限と割り当てに関するドキュメントをご覧ください。

レスポンスの本文

成功すると、レスポンスの本文に次の構造のデータが含まれます。

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

JSON 表現 
{
  "reports": [
    {
      object(Report)
    }
  ],
  "queryCost": number,
  "resourceQuotasRemaining": {
    object(ResourceQuotasRemaining)
  }
}
フィールド
reports[]

object(Report)

各リクエストに対応するレスポンス。
queryCost

number

クエリの実行によって差し引かれたリソース割り当てトークンの量。すべてのレスポンスが含まれます。

resourceQuotasRemaining

object(ResourceQuotasRemaining)

プロパティの残りのリソース割り当て量。

認可スコープ

次の 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。1 つの batchGet メソッド内のすべての ReportRequest に同じ viewId が含まれている必要があります。
dateRanges[]

object(DateRange)

リクエストの期間。リクエストでは最大 2 つの期間を指定できます。レスポンスには、リクエストの各期間のディメンションの組み合わせごとに一連の指標値が含まれます。そのため、期間が 2 つある場合は、元の期間の指標値と 2 番目の期間の指標値の 2 セットが表示されます。コホートまたはライフタイム バリューのリクエストでは、reportRequest.dateRanges フィールドを指定しないでください。期間を指定しない場合、デフォルトの期間は、（startDate: 現在の日付 - 7 日、endDate: 現在の日付 - 1 日）になります。1 つの batchGet メソッド内のすべての ReportRequest には、同じ dateRanges 定義が含まれている必要があります。
samplingLevel

enum(Sampling)

目的のレポートのサンプルサイズ。samplingLevel フィールドが指定されていない場合は、DEFAULT サンプリング レベルが使用されます。1 つの batchGet メソッド内のすべての ReportRequest には、同じ samplingLevel 定義が含まれている必要があります。詳しくは、デベロッパー ガイドをご覧ください。

dimensions[]

object(Dimension)

リクエストされたサイズ。リクエストには合計 9 個のディメンションを含めることができます。
dimensionFilterClauses[]

object(DimensionFilterClause)

ディメンション値をフィルタリングするためのディメンション フィルタの句。AND 演算子で論理的に結合されます。フィルタリングはディメンションの集計前に行われるため、返される指標は該当するディメンションのみの合計を表します。

metrics[]

object(Metric)

リクエストされた指標。少なくとも 1 つの指標を指定する必要があります。リクエストには合計 10 個の指標を含めることができます。
metricFilterClauses[]

object(MetricFilterClause)

指標フィルタの句。AND 演算子で論理的に結合されます。指標フィルタは、最初の期間のみを参照し、比較期間は参照しません。指標のフィルタリングは、指標の集計後に行われます。
filtersExpression

string

リクエストに対して返されるデータを制限するディメンション フィルタまたは指標フィルタ。filtersExpression を使用するには、フィルタするディメンションまたは指標に続けてフィルタ式を指定します。たとえば、次の式では、Firefox で始まる ga:browser ディメンション ga:browser=~^Firefox を選択します。ディメンションと指標のフィルタの詳細については、フィルタ リファレンスをご覧ください。

orderBys[]

object(OrderBy)

出力行の並べ替え順。2 つの行を比較するために、差が検出されるまで後続の要素が順番に適用されます。出力のすべての日付範囲の行の順序は同じになります。
segments[]

object(Segment)

リクエストに対して返されたデータをセグメント化する。セグメント定義は、セグメント リクエストのサブセットを調べるのに役立ちます。リクエストには最大 4 つのセグメントを含めることができます。1 つの batchGet メソッド内のすべての ReportRequest には、同じ segments 定義が含まれている必要があります。セグメントを含むリクエストには、ga:segment ディメンションが必要です。
pivots[]

object(Pivot)

ピボットの定義。リクエストには最大 2 つのピボットを設定できます。
cohortGroup

object(CohortGroup)

このリクエストに関連付けられているコホート グループ。リクエストにコホート グループがある場合は、ga:cohort ディメンションを指定する必要があります。1 つの 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 行までです。

includeEmptyRows

boolean

false に設定すると、返される指標がすべて 0 に等しい場合は、レスポンスに行が含まれません。デフォルトは false で、このような行は除外されます。

hideTotals

boolean

true に設定すると、すべての期間において、一致するすべての行のすべての指標の合計が非表示になります。デフォルトは false で、合計を返します。
hideValueRanges

boolean

true に設定すると、一致するすべての行で最小値と最大値が非表示になります。デフォルトは false で、値の範囲が返されます。

サンプリング

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

列挙型
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 のような単一の指標名です。混合 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)

指標 EQUAL、LESS_THAN、GREATER_THAN のいずれかが compareValue であり、デフォルトは 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 降順で並べ替え。フィールドが降順で並べ替えられます。

分類して表示

レポートをセグメント化する必要がある場合のセグメント定義。セグメントはアナリティクスのデータのサブセットです。たとえば、すべてのユーザーのうち、特定の国や都市のユーザーだけを 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.
}
フィールド
共用体フィールド dynamicOrById。セグメントは、DynamicSegment または組み込みセグメントまたはカスタム セグメントの ID を使用して動的に定義できます。dynamicOrById は次のいずれかになります。
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"
    }]
  },

共用体フィールド simpleOrSequence。単純なセグメント定義か、シーケンス セグメント定義か。simpleOrSequence は次のいずれかになります。
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

フィルタの補数（!）と照合します。
共用体フィールド dimensionOrMetricFilter。ディメンションまたは指標のフィルタ。dimensionOrMetricFilter は次のいずれかになります。
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 演算子でのみ使用されます。

範囲

指標のスコープは、その指標が定義されるレベル（PRODUCT、HIT、SESSION、USER）を定義します。指標値は、プライマリ スコープよりも大きいスコープで報告することもできます。例: 「ga:pageviews」と「ga:transactions」は、これらのセッションまたはユーザーで発生したヒットごとに加算するだけで、SESSION および USER 単位でレポートできます。

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

演算子

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

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

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 前のステップが次のステップの直前に実行されることを示します。

ピボット

ピボットには、リクエストのピボット セクションが記述されます。[ピボット] を使用すると、2 つ目のディメンションでデータをピボット処理して、特定のレポートの表内の情報を並べ替えることができます。

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 個の値のうち最初の「total」の降順で決まります。これで順序を決定できない場合は、最初に先頭のピボット ディメンションの辞書式順序、次に 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 の値が偽の場合:

  • 指標値は管理画面のコホート レポートの値とほぼ同じになります。
  • コホート定義の期間は、カレンダーの週と月に合わせる必要があります。つまり、ga:cohortNthWeek をリクエストする場合、コホート定義の startDate は日曜日、endDate はその次の土曜日に、ga:cohortNthMonth は startDate をその月の 1 日、endDate をその月の最終日にする必要があります。

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

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

コホート

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

JSON 表現 
{
  "name": string,
  "type": enum(Type),
  "dateRange": {
    object(DateRange)
  }
}
フィールド
name

string

コホートの一意の名前。名前が定義されていない場合、コホート_[1234...] の値とともに名前が自動生成されます。

type

enum(Type)

コホートのタイプ。現在サポートされているタイプは FIRST_VISIT_DATE のみです。このフィールドを指定しなかった場合、コホートは FIRST_VISIT_DATE タイプのコホートとして扱われます。

dateRange

object(DateRange)

これは FIRST_VISIT_DATE コホートで使用されます。このコホートでは、最初のアクセス日が DateRange で定義された開始日と終了日の間であるユーザーが選択されます。期間はコホート リクエストに応じて調整する必要があります。リクエストに ga:cohortNthDay が含まれる場合は 1 日の長さ、ga:cohortNthWeek の場合は週の境界（日曜日から土曜日まで）に合わせる必要があり、ga:cohortNthMonth の期間をその月に合わせる必要があります（1 日から始まり、月の末日に終了します）。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,
  "dataLastRefreshed": string
}
フィールド
rows[]

object(ReportRow)

ディメンションの一意の組み合わせごとに 1 つの ReportRow があります。
totals[]

object(DateRangeValues)

リクエストされた期間ごとに、クエリに一致するすべての行について、リクエストされたすべての値の形式で合計が取得されます。値の形式の合計は、最初に値の形式で言及された指標を合計し、次に値の形式をスカラー式として評価することにより計算されます。例: 3 / ((sum of all relevant ga:sessions) + 2) を計算する 3 / (ga:sessions + 2) の「合計」。合計はページ分けの前に計算されます。
rowCount

number

このクエリで一致する行の合計数。
minimums[]

object(DateRangeValues)

すべての一致行で表示される最小値と最大値。リクエストの hideValueRanges が false の場合、または rowCount が 0 の場合、これらは両方とも空になります。
maximums[]

object(DateRangeValues)

すべての一致行で表示される最小値と最大値。リクエストの hideValueRanges が false の場合、または rowCount が 0 の場合、これらは両方とも空になります。
samplesReadCounts[]

string (int64 format)

結果をサンプリングする場合は、読み取られたサンプルの総数が返されます（期間あたり 1 エンティティ）。結果をサンプリングしない場合、このフィールドは定義されません。詳しくは、デベロッパー ガイドをご覧ください。

samplingSpaceSizes[]

string (int64 format)

結果をサンプリングする場合は、存在するサンプルの総数が返されます（期間あたり 1 エンティティ）。結果をサンプリングしない場合、このフィールドは定義されません。詳しくは、デベロッパー ガイドをご覧ください。

isDataGolden

boolean

このリクエストに対するレスポンスが Golden であるかどうかを示します。データは、後でリクエストされてもまったく同じリクエストが新しい結果を生成しない場合にゴールデン データです。
dataLastRefreshed

string (Timestamp format)

レポートのデータが最後に更新された時刻。このタイムスタンプより前に発生したヒットはすべてレポートの計算に含まれます。

RFC3339 UTC「Zulu」形式のタイムスタンプ。精度はナノ秒（例: "2014-10-02T15:01:23.045123456Z"）。

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

各ピボットの地域における指標の値。

ResourceQuotasRemaining

リクエスト完了後のプロパティの残りのリソース割り当てトークン。

JSON 表現 
{
  "dailyQuotaTokensRemaining": number,
  "hourlyQuotaTokensRemaining": number
}
フィールド
dailyQuotaTokensRemaining

number

1 日のリソース割り当ての残り時間。

hourlyQuotaTokensRemaining

number

1 時間あたりのリソース割り当てトークンの残り時間。

試してみよう: