Method: accounts.runAccessReport

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

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

データアクセスに関する記録には、Google アナリティクスの管理画面のレポート、Google アナリティクスの管理画面のデータ探索ツール、Google アナリティクスの Data API、その他のサービス（Firebase とリンクを介して Google アナリティクスからデータを取得できる AdMob です。これらのレコードには、ストリームの追加やプロパティのタイムゾーンの変更といったプロパティ設定の変更は含まれません。構成の変更履歴については、searchChangeHistoryEvents をご覧ください。

この API に関するフィードバックを送信するには、Google アナリティクス アクセス レポートのフィードバック フォームにご記入ください。

HTTP リクエスト

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

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

パスパラメータ

パラメータ
entity

string

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

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

リクエスト本文

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

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)

読み取るアクセス レコードの期間。複数の期間がリクエストされた場合、レスポンスの各行には 0 を基準とした期間インデックスが含まれます。2 つの期間が重複する場合、重複する日のアクセス レコードが両方の期間のレスポンス行に含まれます。指定できる期間は 2 つまでです。
dimensionFilter

object (AccessFilterExpression)

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

object (AccessFilterExpression)

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

string (int64 format)

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

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

string (int64 format)

返される行数。指定しない場合は、10,000 行が返されます。この API では、指定した行数に関係なく、リクエストごとに最大 100,000 行が返されます。limit は正数で指定してください。

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

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

string

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

IANA タイムゾーン データベース（https://www.iana.org/time-zones)の文字列としてフォーマットされています。例: 「America/New_York」または「アジア/東京」。
orderBys[]

object (AccessOrderBy)

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

boolean

このアナリティクス プロパティの割り当ての現在の状態を返すかどうかを切り替えます。Quota は 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