このページは Cloud Translation API によって翻訳されました。

Method: accounts.runAccessReport

HTTP リクエスト
パスパラメータ
リクエストの本文
- JSON 表現
レスポンスの本文
認可スコープ
試してみる

データアクセスレコードのカスタマイズレポートを返します。このレポートには、ユーザーが Google アナリティクスのレポートデータを読み取るたびに記録が記録されます。アクセスレコードは最大 2 年間保持されます。

プロパティのデータアクセスレポートをリクエストできます。プロパティは Google アナリティクス 360 に含まれている必要があります。この方法は管理者が利用できます。

データアクセスレコードには、GA4 UI レポート、GA4 UI データ探索ツール、GA4 Data API、およびリンクを介して Google アナリティクスからデータを取得できる Firebase や AdMob などの他のサービスが含まれます。これらのレコードには、プロパティの設定変更（ストリームの追加、プロパティのタイムゾーンの変更など）は含まれません。構成の変更履歴については、searchChangeHistoryEvents をご覧ください。

HTTP リクエスト

POST https://analyticsadmin.googleapis.com/v1beta/{entity=accounts/*}:runAccessReport

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

パスパラメータ

パラメータ

パラメータ
`entity`	`string` データアクセスレポートは、プロパティレベルまたはアカウントレベルでのリクエストをサポートします。アカウント単位でリクエストした場合、データアクセスレポートには、そのアカウントに含まれるすべてのプロパティに対するすべてのアクセス権が含まれます。プロパティレベルでリクエストするには、「123」が GA4 プロパティ ID の場合、エンティティは「properties/123」などにする必要があります。アカウントレベルでリクエストするには、「1234」が GA4 アカウント ID の場合、エンティティは「accounts/1234」などである必要があります。

entity

string

データアクセスレポートは、プロパティレベルまたはアカウントレベルでのリクエストをサポートします。アカウント単位でリクエストした場合、データアクセスレポートには、そのアカウントに含まれるすべてのプロパティに対するすべてのアクセス権が含まれます。

プロパティレベルでリクエストするには、「123」が GA4 プロパティ ID の場合、エンティティは「properties/123」などにする必要があります。アカウントレベルでリクエストするには、「1234」が GA4 アカウント ID の場合、エンティティは「accounts/1234」などである必要があります。

リクエスト本文

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

JSON 表現

JSON 表現
{ "dimensions": [ { object (`AccessDimension`) } ], "metrics": [ { object (`AccessMetric`) } ], "dateRanges": [ { object (`AccessDateRange`) } ], "dimensionFilter": { object (`AccessFilterExpression`) }, "metricFilter": { object (`AccessFilterExpression`) }, "offset": string, "limit": string, "timeZone": string, "orderBys": [ { object (`AccessOrderBy`) } ], "returnEntityQuota": boolean }

{
  "dimensions": [
    {
      object (AccessDimension)
    }
  ],
  "metrics": [
    {
      object (AccessMetric)
    }
  ],
  "dateRanges": [
    {
      object (AccessDateRange)
    }
  ],
  "dimensionFilter": {
    object (AccessFilterExpression)
  },
  "metricFilter": {
    object (AccessFilterExpression)
  },
  "offset": string,
  "limit": string,
  "timeZone": string,
  "orderBys": [
    {
      object (AccessOrderBy)
    }
  ],
  "returnEntityQuota": boolean
}

フィールド
`dimensions[]`	`object (AccessDimension)` リクエストされてレスポンスに表示されるディメンション。リクエストに使用できるディメンションは 9 個までです。
`metrics[]`	`object (AccessMetric)` リクエストされ、レスポンスに表示される指標。リクエストには、最大 10 個の指標を使用できます。
`dateRanges[]`	`object (AccessDateRange)` 読み込むアクセスレコードの期間。複数の期間をリクエストした場合、各レスポンス行には 0 から始まる期間インデックスが含まれます。2 つの期間が重複している場合は、重複する期間のアクセスレコードが両方の期間のレスポンス行に含まれます。リクエストは最大 2 つの期間で許可されます。
`dimensionFilter`	`object (AccessFilterExpression)` ディメンションフィルタを使用すると、レポートの応答を、フィルタに一致する特定のディメンション値に制限できます。たとえば、1 人のユーザーのアクセスレコードをフィルタします。詳しくは、ディメンションフィルタの基礎知識をご覧ください。このフィルタでは指標を使用できません。
`metricFilter`	`object (AccessFilterExpression)` 指標フィルタを使用すると、レポートの応答を、フィルタに一致する特定の指標値に制限できます。指標フィルタは、レポートの行を集計した後に適用されます。これは SQL 句を使用する場合と同様です。このフィルタではディメンションを使用できません。
`offset`	`string (int64 format)` 開始行の行数。最初の行は 0 行目としてカウントされます。オフセットが指定されていない場合、0 として扱われます。オフセットがゼロの場合、このメソッドは `limit` エントリを持つ結果の最初のページを返します。ページネーションパラメータの詳細については、ページ分けをご覧ください。
`limit`	`string (int64 format)` 返される行数。指定しない場合、10,000 行が返されます。API は、リクエストの数に関係なく、リクエストごとに最大 100,000 行を返します。`limit` は正の値で指定してください。 `limit` より行数が少ない場合、API はリクエストされた `limit` よりも少ない行数を返すことがあります。たとえば、ディメンション `country` に指定できる値は 300 個未満であるため、`country` のみに関するレポートでは、`limit` を 100 より大きい値に設定しても、追加できる行数は 300 を超えることはありません。ページネーションパラメータの詳細については、ページ分けをご覧ください。
`timeZone`	`string` このリクエストのタイムゾーン（指定する場合）。指定しない場合は、プロパティのタイムゾーンが使用されます。リクエストのタイムゾーンは、レポートの開始日と終了日を解釈するために使用されます。 IANA タイムゾーンデータベース（https://www.iana.org/time-zones）の文字列の形式（例: America/New_York、Asia/Tokyo）。
`orderBys[]`	`object (AccessOrderBy)` レスポンス内の行の順序を指定します。
`returnEntityQuota`	`boolean` このアナリティクスプロパティの割り当ての現在の状態を返すかどうかを切り替えます。割り当ては AccessQuota で返されます。アカウント単位のリクエストの場合、このフィールドは false である必要があります。

レスポンスの本文

成功した場合、レスポンスの本文には RunAccessReportResponse のインスタンスが含まれます。

認可スコープ

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

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