Method: accounts.runAccessReport

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

プロパティごとにデータアクセス レポートをリクエストできます。レポートはどのプロパティでもリクエストできますが、割り当てに関連しないディメンションは、Google アナリティクス 360 のプロパティでのみリクエストできます。この方法は、管理者のみが使用できます。

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

HTTP リクエスト

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

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

パスパラメータ

パラメータ
entity

string

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

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

リクエスト本文

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

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,
  "includeAllUsers": boolean,
  "expandGroups": boolean
}
フィールド
dimensions[]

object (AccessDimension)

リクエストされ、レスポンスに表示されるディメンション。リクエストできるディメンションは最大 9 個です。
metrics[]

object (AccessMetric)

リクエストされ、レスポンスに表示される指標。リクエストは最大 10 個の指標を使用できます。
dateRanges[]

object (AccessDateRange)

読み取るアクセス レコードの期間。複数の期間をリクエストすると、各レスポンス行にゼロから始まる期間のインデックスが含まれます。2 つの期間が重複している場合は、重複する日のアクセス レコードが両方の期間の回答行に含まれます。リクエストは最大 2 つの期間を指定できます。
dimensionFilter

object (AccessFilterExpression)

ディメンション フィルタを使用すると、フィルタに一致する特定のディメンション値にレポートのレスポンスを制限できます。例: 単一ユーザーのアクセス レコードのフィルタリング。詳細については、ディメンション フィルタの基礎で例をご覧ください。このフィルタでは指標を使用できません。
metricFilter

object (AccessFilterExpression)

指標フィルタを使用すると、フィルタに一致する特定の指標値にレポートのレスポンスを制限できます。指標フィルタは、SQLHave-句と同様に、レポートの行を集計した後に適用されます。このフィルタではディメンションを使用できません。
offset

string (int64 format)

開始行の行数。最初の行は行 0 としてカウントされます。offset が指定されていない場合は、0 として扱われます。offset がゼロの場合、このメソッドは limit エントリを含む結果の最初のページを返します。

このページ設定パラメータの詳細については、ページ設定をご覧ください。
limit

string (int64 format)

返される行数。指定しない場合は、10,000 行が返されます。API は、リクエストした数に関係なく、リクエストあたり最大 100,000 行を返します。limit は正数でなければなりません。

API は、残りの行の数が limit より少ない場合、リクエストした limit よりも少ない行を返すことがあります。たとえば、ディメンション「country」に使用できる値が 300 個未満であるため、country のみのレポートでは、limit により大きな値を設定しても、取得できる行数は 300 行までです。

このページ設定パラメータの詳細については、ページ設定をご覧ください。
timeZone

string

このリクエストのタイムゾーン（指定されている場合）。指定しない場合は、プロパティのタイムゾーンが使用されます。リクエストのタイムゾーンは、レポートの開始日と終了日を解釈するために使用されます。

IANA タイムゾーン データベース（https://www.iana.org/time-zones)の文字列としてフォーマットされます。たとえば、「America/New_York」や「Asia/Tokyo」などです。
orderBys[]

object (AccessOrderBy)

レスポンス内の行の順序を指定します。
returnEntityQuota

boolean

このアナリティクス プロパティの割り当ての現在の状態を返すかどうかを切り替えます。割り当ては AccessQuota に返されます。アカウント レベルのリクエストの場合、このフィールドは false にする必要があります。
includeAllUsers

boolean

省略可。API 呼び出しを行ったことのないユーザーをレスポンスに含めるかどうかを決定します。true の場合、API 呼び出しを行ったかどうかにかかわらず、指定したプロパティまたはアカウントへのアクセス権を持つすべてのユーザーがレスポンスに含まれます。false の場合、API 呼び出しを行ったユーザーのみが含まれます。
expandGroups

boolean

省略可。ユーザー グループ内のユーザーを返すかどうかを決定します。このフィールドは、includeAllUsers が true に設定されている場合にのみ機能します。true の場合、指定したプロパティまたはアカウントにアクセスできるすべてのユーザーを返します。false の場合、直接アクセス権を持つユーザーのみが返されます。

レスポンスの本文

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

承認スコープ

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

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