- HTTP リクエスト
- パスパラメータ
- リクエストの本文
- レスポンスの本文
- 認可スコープ
- RunReportRequest
<ph type="x-smartling-placeholder">
- </ph>
- JSON 表現
- 試してみる
複数のレポートを一括して返します。レポートはすべて、同じ GA4 プロパティのものである必要があります。
HTTP リクエスト
POST https://analyticsdata.googleapis.com/v1beta/{property=properties/*}:batchRunReports
この URL は gRPC Transcoding 構文を使用します。
パスパラメータ
パラメータ | |
---|---|
property |
イベントがトラッキングされる Google アナリティクス GA4 プロパティ ID。URL パスで指定され、本文では指定されません。詳しくは、プロパティ ID を確認する方法をご覧ください。このプロパティはバッチに指定する必要があります。RunReportRequest 内のプロパティは、指定されていないか、このプロパティと一致している可能性があります。 例: properties/1234 |
リクエスト本文
リクエストの本文には、次の構造のデータが含まれます。
JSON 表現 |
---|
{
"requests": [
{
object ( |
フィールド | |
---|---|
requests[] |
個別のリクエスト。各リクエストには、個別のレポート レスポンスが含まれます。1 つのバッチ リクエストでは最大 5 件のリクエストを実行できます。 |
レスポンスの本文
複数のレポートを含むバッチ レスポンス。
成功した場合、レスポンスの本文には次の構造のデータが含まれます。
JSON 表現 |
---|
{
"reports": [
{
object ( |
フィールド | |
---|---|
reports[] |
個々の回答。各レスポンスには個別のレポート リクエストが含まれます。 |
kind |
このメッセージのリソースの種類を指定します。この |
認可スコープ
次の OAuth スコープのいずれかが必要です。
https://www.googleapis.com/auth/analytics.readonly
https://www.googleapis.com/auth/analytics
RunReportRequest
レポートを生成するリクエスト。
JSON 表現 |
---|
{ "property": string, "dimensions": [ { object ( |
フィールド | |
---|---|
property |
イベントがトラッキングされる Google アナリティクス GA4 プロパティ ID。URL パスで指定され、本文では指定されません。詳しくは、プロパティ ID を確認する方法をご覧ください。バッチ リクエスト内では、このプロパティを指定しないか、バッチレベルのプロパティと一致させる必要があります。 例: properties/1234 |
dimensions[] |
リクエストして表示されたディメンション。 |
metrics[] |
リクエストされ、表示される指標。 |
dateRanges[] |
読み取るデータの期間。複数の期間がリクエストされた場合、レスポンスの各行には 0 を基準とした期間インデックスが含まれます。2 つの期間が重複する場合、重複する日付のイベントデータが両方の期間のレスポンス行に含まれます。コホート リクエストでは、この |
dimensionFilter |
ディメンション フィルタを使用すると、レポート内の特定のディメンション値のみを要求することができます。詳しくは、ディメンション フィルタの基礎で例をご覧ください。このフィルタでは指標を使用できません。 |
metricFilter |
指標のフィルタ句。SQL の has 句と同様に、レポートの行の集計後に適用されます。このフィルタではディメンションを使用できません。 |
offset |
開始行の行数。最初の行は行 0 としてカウントされます。 ページングでは、最初のリクエストでオフセットが指定されていません。または、offset を 0 に設定します。最初のリクエストは、行の最初の ページ分けパラメータの詳細については、ページ分けをご覧ください。 |
limit |
返される行数。指定しない場合は、10,000 行が返されます。指定した行数にかかわらず、API はリクエストごとに最大 250,000 行を返します。 また、ディメンション値が ページ分けパラメータの詳細については、ページ分けをご覧ください。 |
metricAggregations[] |
指標の集計。集計された指標値は、dimensionValues が「RESERVED_(MetricAggregation)」に設定されている行に表示されます。 |
orderBys[] |
レスポンスの行の順序を指定します。 |
currencyCode |
ISO 4217 形式の通貨コード(「AED」、「USD」、「JPY」など)。このフィールドが空の場合、レポートにはプロパティのデフォルトの通貨が使用されます。 |
cohortSpec |
このリクエストに関連付けられているコホート グループ。リクエストにコホート グループがある場合は、「コホート」をディメンションが必要です。 |
keepEmptyRows |
false または指定されていない場合、すべての指標が 0 に等しい各行は返されません。true の場合、これらの行は、フィルタで個別に削除されない場合に返されます。 この たとえば、あるプロパティで |
returnPropertyQuota |
このアナリティクス プロパティの割り当ての現在の状態を返すかどうかを切り替えます。Quota は PropertyQuota で返されます。 |
comparisons[] |
省略可。リクエストして表示される比較の構成。レスポンスで比較列を受け取るためには、このリクエストの比較フィールドのみが必要です。 |