Method: properties.runAccessReport

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

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

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

HTTP リクエスト

POST https://analyticsadmin.googleapis.com/v1beta/{entity=properties/*}: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)

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

string (int64 format)

開始行の行数。最初の行は行 0 としてカウントされます。オフセットが指定されていない場合、オフセットは 0 として扱われます。オフセットがゼロの場合、このメソッドは 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」、「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