Method: properties.runAccessReport

데이터 액세스 레코드의 맞춤설정된 보고서를 반환합니다. 이 보고서는 사용자가 Google 애널리틱스 보고 데이터를 읽을 때마다 기록된 기록을 제공합니다. 액세스 기록은 최대 2년 동안 보관됩니다.

속성에 대한 데이터 액세스 보고서를 요청할 수 있습니다. 모든 속성에 대해 보고서를 요청할 수 있지만 할당량과 관련 없는 측정기준은 Google 애널리틱스 360 속성에서만 요청할 수 있습니다. 이 방법은 관리자만 사용할 수 있습니다.

이러한 데이터 액세스 기록에는 GA UI 보고, GA UI 탐색 분석, GA Data API, 그리고 Firebase 및 연결을 통해 Google 애널리틱스에서 데이터를 가져올 수 있는 AdMob 이러한 레코드에는 스트림 추가 또는 속성의 시간대 변경과 같은 속성 구성 변경사항이 포함되지 않습니다. 구성 변경 내역은 searchChangeHistoryEvents를 참조하세요.

이 API에 대한 의견을 보내려면 Google 애널리틱스 액세스 보고서 의견 양식을 작성하세요.

HTTP 요청

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

URL은 gRPC 트랜스코딩 문법을 사용합니다.

경로 매개변수

매개변수
entity

string

데이터 액세스 보고서는 속성 수준 또는 계정 수준에서 요청을 지원합니다. 계정 수준에서 요청된 경우 데이터 액세스 보고서에는 해당 계정의 모든 속성에 대한 모든 액세스 권한이 포함됩니다.

속성 수준에서 요청하려면 항목이 'properties/123'과 같은 형태여야 합니다. '123'인 경우 는 Google 애널리틱스 속성 ID입니다. 계정 수준에서 요청하려면 '1234'가 Google 애널리틱스 계정 ID인 경우 '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)

읽을 액세스 기록의 기간입니다. 여러 기간이 요청되면 각 응답 행에 0을 기반으로 하는 기간 색인이 포함됩니다. 두 기간이 겹치는 경우 겹치는 날짜의 액세스 기록이 두 기간의 응답 행에 포함됩니다. 요청은 최대 2개의 기간까지 허용됩니다.
dimensionFilter

object (AccessFilterExpression)

측정기준 필터를 사용하면 필터와 일치하는 특정 측정기준 값으로 보고서 응답을 제한할 수 있습니다. 예를 들어 단일 사용자의 액세스 레코드를 필터링합니다. 자세한 내용은 측정기준 필터의 기본사항에 나온 예를 참고하세요. 이 필터에서는 측정항목을 사용할 수 없습니다.
metricFilter

object (AccessFilterExpression)

측정항목 필터를 사용하면 필터와 일치하는 특정 측정항목 값으로 보고서 응답을 제한할 수 있습니다. 측정항목 필터는 SQL의 절처럼 보고서의 행을 집계한 후에 적용됩니다. 이 필터에서는 측정기준을 사용할 수 없습니다.
offset

string (int64 format)

시작 행의 행 수입니다. 첫 번째 행은 0행으로 계산됩니다. 오프셋을 지정하지 않으면 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' 또는 '아시아/도쿄'라고 입력합니다.
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