このドキュメントでは、Google アナリティクス Reporting API v4 のリソースベースの割り当てについて説明します。この機能は、アナリティクス 360 でのみお使いいただけます。この API に適用される制限について詳しくは、制限と割り当てをご覧ください。
はじめに
共有リソースの可用性と信頼性を確保するために、Analytics Reporting API にアクセスするすべてのプロジェクトに制限と割り当てが適用されます。大規模なデータセットに対してクエリを実行する場合、Analytics Reporting API でサンプリングが行われる可能性があり、データの結果に影響する可能性があります。
リソースベースの割り当てシステムは、新しい割り当てシステムで、Analytics の Reporting API を使用しながら、アナリティクス 360 アカウントのサンプリングしきい値を引き上げることができます。このシステムは省略可能で、Google API Console の割り当てページで報告される制限など、ビューとプロジェクトに適用される既存の制限から独立しています。
リソースベースの割り当て
すべてのリクエストが同じ条件で作成されるわけではありません。必要となる計算コストはリクエストによって大きく異なります。リソースベースの割り当ては、アナリティクス レポートのインフラストラクチャを保護しつつ、サンプリングしきい値の引き上げを可能にするための機能です。
各プロパティには、一定量のクエリ リソース トークンが割り当てられます。API クライアントは、相対クエリリソース トークンと引き換えに、サンプリング フィールドのしきい値を引き上げたオプションのフィールドを追加できます。計算コストが高いリクエストにはトークンが必要です。
サンプリングしきい値
Google アナリティクス API v4 を使用してデータをリクエストする場合、対象期間のセッション数（プロパティ単位）に基づいて、以下の一般的なサンプリングしきい値が適用されます。
- アナリティクス スタンダード: 50 万セッション
- アナリティクス 360: 100 万セッション
- リソースベースの割り当てに基づくアナリティクス 360: 1 億セッション
リソースベースの割り当てを有効にする
特定のリクエストでリソースベースの割り当てを有効にするには、API 呼び出しの batchGet メソッドにオプションのフィールド useResourceQuotas を含める必要があります。
{
"reportRequests": [{object(ReportRequest)}],
"useResourceQuotas": boolean,
}
例:
{
"reportRequests":[
{
"viewId":"XXXX",
"dateRanges":[
{
"startDate":"2017-06-15",
"endDate":"2017-06-30"
}],
"metrics":[
{
"expression":"ga:sessions"
}],
"dimensions": [
{
"name":"ga:browser"
}]
}],
"useResourceQuotas": true
}
クエリ リソースコストのレスポンス フィールド
batchGet メソッドの呼び出しごとに、queryCost フィールドがレスポンスに含まれます。
{
"reports": [{ object(Report) }],
"queryCost": number
}
queryCost フィールドは、batchGet リクエスト内のすべての ReportRequests の合計リソース費用を表す整数です。例:
{
"reports": [
{
"columnHeader": {...},
"data": {
"rows": [...]
}
}
],
"queryCost": 1337
}
割り当て
アナリティクス 360 プロパティの割り当て
- 1 プロパティにつき、1 日あたり 100,000 クエリコスト単位
- 1 プロパティにつき、1 時間あたり 25,000 クエリコスト単位
割り当ての上限を超えると RESOURCE_EXHAUSTED が返されます。詳しくは、エラー レスポンスをご覧ください。
コスト計算
リクエストのコストは以下に比例します。
- 期間の長さ
- ビュー内のヒット数
- リクエストされたディメンションの基数
- リクエストされたディメンションと指標の数
- セグメントとフィルタ定義の複雑さ
- リクエストされた情報の処理状態（昨日のデータより、今日のデータをリクエストする方がコストが大きくなります）
- クエリタイム インポートのディメンションと指標の存在
API の制限と使用法
リソースベースの割り当てに加え、アナリティクス API v4 に適用される制限と割り当てがあります。
備考
queryCostレスポンス フィールドは、リクエストの計算コストを表します。金銭的な費用は発生しません。API は無料で使用できます。- 当日および特定の過去のデータ（1 歳以上）は、
useResourceQuotasの設定にかかわらず、サンプリングが行われる場合があります。 - リクエストのサンプリングしきい値を引き上げることができなかった場合、リソース割り当てトークンは差し引かれません（サンプリングされたレスポンスは、常にリソース割り当てコストがゼロです）。
- レスポンスに
samplesReadCounts、samplingSpaceSizesという値がある場合、レポートにはサンプリングされたデータが含まれます。
プロジェクトの使用量上限を確認して変更する手順、または割り当ての増加をリクエストする手順は次のとおりです。
- プロジェクトの請求先アカウントをまだ保有していない場合は、アカウントを作成します。
- API Console で API ライブラリの [有効な API] ページに移動し、リストから API を選択します。
- 割り当て関連の設定を表示および変更するには、[割り当て] を選択します。使用統計情報を表示するには、[使用量] を選択します。