Method: properties.runReport

Google 애널리틱스 이벤트 데이터의 맞춤 보고서를 반환합니다. 보고서에는 Google 애널리틱스 추적 코드에서 수집한 데이터에서 파생된 통계가 포함됩니다. API에서 반환된 데이터는 요청된 측정기준 및 측정항목의 열이 있는 테이블 형식입니다. 측정항목은 활성 사용자 또는 이벤트 수와 같이 속성의 사용자 활동을 개별적으로 측정한 것입니다. 측정기준은 국가 또는 이벤트 이름과 같은 몇 가지 일반적인 기준에 따라 측정항목을 분류합니다.

요청 구성 및 응답 이해에 관한 가이드는 보고서 만들기를 참고하세요.

HTTP 요청

POST https://analyticsdata.googleapis.com/v1beta/{property=properties/*}:runReport

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

경로 매개변수

매개변수
property

string

이벤트가 추적되는 Google 애널리틱스 속성 식별자입니다. 본문이 아닌 URL 경로에 지정됩니다. 자세한 내용은 속성 ID를 찾을 수 있는 위치를 참고하세요. 일괄 요청 내에서 이 속성은 지정되지 않거나 일괄 처리 수준 속성과 일관되어야 합니다.

예: properties/1234

요청 본문

요청 본문에는 다음과 같은 구조의 데이터가 포함됩니다.

JSON 표현 
{
  "dimensions": [
    {
      object (Dimension)
    }
  ],
  "metrics": [
    {
      object (Metric)
    }
  ],
  "dateRanges": [
    {
      object (DateRange)
    }
  ],
  "dimensionFilter": {
    object (FilterExpression)
  },
  "metricFilter": {
    object (FilterExpression)
  },
  "offset": string,
  "limit": string,
  "metricAggregations": [
    enum (MetricAggregation)
  ],
  "orderBys": [
    {
      object (OrderBy)
    }
  ],
  "currencyCode": string,
  "cohortSpec": {
    object (CohortSpec)
  },
  "keepEmptyRows": boolean,
  "returnPropertyQuota": boolean,
  "comparisons": [
    {
      object (Comparison)
    }
  ]
}
필드
dimensions[]

object (Dimension)

요청되고 표시되는 측정기준입니다.
metrics[]

object (Metric)

요청되고 표시되는 측정항목입니다.
dateRanges[]

object (DateRange)

읽을 데이터의 기간입니다. 여러 기간이 요청되면 각 응답 행에 0부터 시작하는 기간 색인이 포함됩니다. 두 기간이 겹치는 경우 겹치는 날짜의 이벤트 데이터가 두 기간의 응답 행에 모두 포함됩니다. 코호트 요청에서는 이 dateRanges를 지정하지 않아야 합니다.
dimensionFilter

object (FilterExpression)

측정기준 필터를 사용하면 보고서에서 특정 측정기준 값만 요청할 수 있습니다. 자세한 내용은 측정기준 필터 기본사항에서 예를 참고하세요. 이 필터에서는 측정항목을 사용할 수 없습니다.
metricFilter

object (FilterExpression)

측정항목의 필터 절입니다. SQL having 절과 마찬가지로 보고서 행을 집계한 후에 적용됩니다. 이 필터에서는 측정기준을 사용할 수 없습니다.
offset

string (int64 format)

시작 행의 행 수입니다. 첫 번째 행은 행 0으로 계산됩니다.

페이지로 나누는 경우 첫 번째 요청은 오프셋을 지정하지 않거나 오프셋을 0으로 설정합니다. 첫 번째 요청은 첫 번째 limit 행을 반환합니다. 두 번째 요청은 오프셋을 첫 번째 요청의 limit로 설정합니다. 두 번째 요청은 두 번째 limit 행을 반환합니다.

이 페이지 나누기 매개변수에 대한 자세한 내용은 페이지 나누기를 참고하세요.
limit

string (int64 format)

반환할 행의 개수입니다. 지정하지 않으면 10,000개의 행이 반환됩니다. 요청한 행 수와 관계없이 API는 요청당 최대 250,000개의 행을 반환합니다. limit는 양수여야 합니다.

API는 limit만큼 측정기준 값이 없는 경우 요청된 limit보다 적은 행을 반환할 수도 있습니다. 예를 들어 country 측정기준의 가능한 값은 300개 미만이므로 country만 보고하는 경우 limit를 더 높은 값으로 설정하더라도 300개 이상의 행을 가져올 수 없습니다.

이 페이지 나누기 매개변수에 대한 자세한 내용은 페이지 나누기를 참고하세요.
metricAggregations[]

enum (MetricAggregation)

측정항목의 집계입니다. 집계된 측정항목 값은 dimensionValues가 'RESERVED_(MetricAggregation)'으로 설정된 행에 표시됩니다. 비교와 여러 기간을 모두 포함하는 집계는 기간을 기준으로 집계됩니다.
orderBys[]

object (OrderBy)

응답에서 행이 정렬되는 방식을 지정합니다. 비교와 여러 기간을 모두 포함하는 요청에는 비교에 정렬 기준이 적용됩니다.
currencyCode

string

'AED', 'USD', 'JPY'와 같은 ISO4217 형식의 통화 코드입니다. 필드가 비어 있으면 보고서에서 속성의 기본 통화를 사용합니다.
cohortSpec

object (CohortSpec)

이 요청과 연결된 코호트 그룹입니다. 요청에 코호트 그룹이 있는 경우 '코호트' 측정기준이 있어야 합니다.
keepEmptyRows

boolean

false이거나 지정되지 않은 경우 모든 측정항목이 0인 각 행은 반환되지 않습니다. true인 경우 필터로 별도로 삭제되지 않으면 이러한 행이 반환됩니다.

이 keepEmptyRows 설정과 관계없이 Google 애널리틱스 속성에서 기록한 데이터만 보고서에 표시할 수 있습니다.

예를 들어 속성이 purchase 이벤트를 기록하지 않는 경우 eventName 측정기준 및 eventCount 측정항목에 대한 쿼리에는 행 eventName: 'purchase' 및 eventCount: 0이 없습니다.
returnPropertyQuota

boolean

이 Google 애널리틱스 속성의 할당량의 현재 상태를 반환할지 전환합니다. 할당량은 PropertyQuota에 반환됩니다.
comparisons[]

object (Comparison)

선택사항입니다. 요청되고 표시되는 비교의 구성입니다. 요청에는 응답에서 비교 열을 수신하기 위한 비교 필드만 필요합니다.

응답 본문

성공한 경우 응답 본문에 RunReportResponse의 인스턴스가 포함됩니다.

승인 범위

다음 OAuth 범위 중 하나가 필요합니다.

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