Method: properties.runReport

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

HTTP 요청

POST https://analyticsdata.googleapis.com/v1alpha/{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)
    }
  ],
  "conversionSpec": {
    object (ConversionSpec)
  }
}
필드
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은 양수여야 합니다.

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

이 페이지로 나누기 매개변수에 대해 자세히 알아보려면 페이지로 나누기를 참고하세요.
metricAggregations[]

enum (MetricAggregation)

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

object (OrderBy)

선택사항입니다. 대답에서 행이 정렬되는 방식을 지정합니다. 비교와 여러 기간이 모두 포함된 요청에는 비교에 order by가 적용됩니다.
currencyCode

string

선택사항입니다. ISO4217 형식의 통화 코드입니다(예: 'AED', 'USD', 'JPY'). 필드가 비어 있으면 보고서에서 속성의 기본 통화를 사용합니다.
cohortSpec

object (CohortSpec)

선택사항입니다. 이 요청과 연결된 동질 집단 그룹입니다. 요청에 동질 집단 그룹이 있는 경우 '동질 집단' 측정기준이 있어야 합니다.
keepEmptyRows

boolean

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

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

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

boolean

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

object (Comparison)

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

object (ConversionSpec)

선택사항입니다. 전환 보고를 제어합니다. 이 필드는 선택사항입니다. 이 필드가 설정되거나 전환 측정항목이 요청되면 보고서는 전환 보고서가 됩니다.

응답 본문

요청에 해당하는 응답 보고서 표입니다.

성공한 경우 응답 본문은 다음과 같은 구조의 데이터를 포함합니다.

JSON 표현 
{
  "dimensionHeaders": [
    {
      object (DimensionHeader)
    }
  ],
  "metricHeaders": [
    {
      object (MetricHeader)
    }
  ],
  "rows": [
    {
      object (Row)
    }
  ],
  "totals": [
    {
      object (Row)
    }
  ],
  "maximums": [
    {
      object (Row)
    }
  ],
  "minimums": [
    {
      object (Row)
    }
  ],
  "rowCount": integer,
  "metadata": {
    object (ResponseMetaData)
  },
  "propertyQuota": {
    object (PropertyQuota)
  },
  "kind": string,
  "nextPageToken": string
}
필드
dimensionHeaders[]

object (DimensionHeader)

측정기준 열을 설명합니다. DimensionHeader의 수와 DimensionHeader의 순서는 행에 있는 측정기준과 일치합니다.
metricHeaders[]

object (MetricHeader)

측정항목 열을 설명합니다. MetricHeader의 수와 MetricHeader의 순서가 행에 있는 측정항목과 일치합니다.
rows[]

object (Row)

보고서의 측정기준 값 조합 및 측정항목 값의 행입니다.
totals[]

object (Row)

요청된 경우 측정항목의 합계 값입니다.
maximums[]

object (Row)

요청된 경우 측정항목의 최댓값입니다.
minimums[]

object (Row)

요청된 경우 측정항목의 최솟값입니다.
rowCount

integer

응답에서 반환된 행 수와 관계없이 쿼리 결과의 총 행 수입니다. 예를 들어 쿼리에서 175개의 행이 반환되고 API 요청에 limit = 50이 포함된 경우 응답에는 rowCount = 175가 포함되지만 행은 50개만 포함됩니다.

이 페이지로 나누기 매개변수에 대해 자세히 알아보려면 페이지로 나누기를 참고하세요.
metadata

object (ResponseMetaData)

보고서의 메타데이터입니다.
propertyQuota

object (PropertyQuota)

이 요청을 포함한 애널리틱스 속성의 할당량 상태입니다.
kind

string

이 메시지의 리소스 종류를 식별합니다. 이 kind는 항상 고정 문자열 'analyticsData#runReport'입니다. JSON의 응답 유형을 구분하는 데 유용합니다.
nextPageToken

string

다음 페이지를 검색하기 위해 pageToken으로 전송할 수 있는 토큰입니다. 이 필드를 생략하면 후속 페이지가 표시되지 않습니다.

승인 범위

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

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

비교

개별 비교를 정의합니다. 대부분의 요청에는 보고서에서 비교 간에 비교할 수 있도록 여러 비교가 포함됩니다.

JSON 표현 
{
  "name": string,

  // Union field one_comparison can be only one of the following:
  "dimensionFilter": {
    object (FilterExpression)
  },
  "comparison": string
  // End of list of possible types for union field one_comparison.
}
필드
name

string

각 비교는 대답에 별도의 행을 생성합니다. 응답에서 이 비교는 이 이름으로 식별됩니다. 이름이 지정되지 않으면 저장된 비교 표시 이름이 사용됩니다.

통합 필드 one_comparison.

one_comparison는 다음 중 하나여야 합니다.
dimensionFilter

object (FilterExpression)

기본 비교
comparison

string

비교의 리소스 이름으로 식별되는 저장된 비교입니다. 예: 'comparisons/1234'

ConversionSpec

전환 보고를 제어합니다.

JSON 표현 
{
  "conversionActions": [
    string
  ],
  "attributionModel": enum (AttributionModel)
}
필드
conversionActions[]

string

보고서에 포함할 전환 액션 ID입니다. 비어 있으면 모든 전환이 포함됩니다. 유효한 전환 액션 ID는 properties.getMetadata 메서드의 응답에 있는 conversions 목록 내의 conversionAction 필드에서 가져올 수 있습니다. 예를 들어 'conversionActions/1234'입니다.
attributionModel

enum (AttributionModel)

전환 보고서에서 사용할 기여 분석 모델입니다. 지정하지 않으면 DATA_DRIVEN이 사용됩니다.

AttributionModel

전환 보고서에서 사용할 기여 분석 모델

열거형
ATTRIBUTION_MODEL_UNSPECIFIED 지정되지 않은 기여 분석 모델입니다.
DATA_DRIVEN 기여 분석이 유료 및 자연 검색 데이터 기반 모델을 기반으로 함
LAST_CLICK 기여 분석이 유료 및 자연 검색 마지막 클릭 모델을 기반으로 함