Method: properties.runRealtimeReport

속성의 실시간 이벤트 데이터에 관한 맞춤 보고서를 반환합니다. 이벤트가 Google 애널리틱스로 전송된 후 몇 초 후에 실시간 보고서에 표시됩니다. 실시간 보고서에는 현재 시점부터 30분 전까지의 기간 (Google 애널리틱스 360 속성의 경우 최대 60분) 동안 이벤트 및 사용 데이터가 표시됩니다.

실시간 요청을 구성하고 응답을 이해하기 위한 가이드는 실시간 보고서 만들기를 참고하세요.

HTTP 요청

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

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

경로 매개변수

매개변수
property

string

이벤트가 추적되는 Google 애널리틱스 GA4 속성 식별자입니다. 본문이 아닌 URL 경로에 지정됩니다. 자세한 내용은 속성 ID를 찾을 수 있는 위치를 참고하세요.

예: properties/1234

요청 본문

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

JSON 표현 
{
  "dimensions": [
    {
      object (Dimension)
    }
  ],
  "metrics": [
    {
      object (Metric)
    }
  ],
  "dimensionFilter": {
    object (FilterExpression)
  },
  "metricFilter": {
    object (FilterExpression)
  },
  "limit": string,
  "metricAggregations": [
    enum (MetricAggregation)
  ],
  "orderBys": [
    {
      object (OrderBy)
    }
  ],
  "returnPropertyQuota": boolean,
  "minuteRanges": [
    {
      object (MinuteRange)
    }
  ]
}
필드
dimensions[]

object (Dimension)

요청 및 표시된 측정기준
metrics[]

object (Metric)

요청 및 표시된 측정항목입니다.
dimensionFilter

object (FilterExpression)

측정기준의 필터 절입니다. 이 필터에는 측정항목을 사용할 수 없습니다.
metricFilter

object (FilterExpression)

측정항목의 필터 절입니다. SQL 포함 절과 비슷하게 사후 집계 단계에서 적용됩니다. 이 필터에는 측정기준을 사용할 수 없습니다.
limit

string (int64 format)

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

API는 측정기준 값이 limit만큼 많지 않으면 요청된 limit보다 적은 행을 반환할 수도 있습니다. 예를 들어 country 측정기준에 사용할 수 있는 값은 300개 미만이므로 country에 대해서만 보고하는 경우 limit을 더 높은 값으로 설정하더라도 행이 300개를 초과할 수 없습니다.
metricAggregations[]

enum (MetricAggregation)

측정항목의 집계입니다. 집계된 측정항목 값은치가 'RESERVED_(MetricAggregation)'로 설정된 행에 표시됩니다.
orderBys[]

object (OrderBy)

응답에서 행이 정렬되는 방식을 지정합니다.
returnPropertyQuota

boolean

이 애널리틱스 속성 실시간 할당량의 현재 상태를 반환할지 여부를 전환합니다. 할당량은 PropertyQuota에 반환됩니다.
minuteRanges[]

object (MinuteRange)

읽을 이벤트 데이터의 분 범위입니다. 지정하지 않으면 지난 30분에 해당하는 1분 범위가 사용됩니다. 여러 분 범위가 요청된 경우 각 응답 행에는 0 기반 분 범위 색인이 포함됩니다. 2분 범위가 겹치는 경우 두 분 범위의 응답 행에 겹치는 분의 이벤트 데이터가 포함됩니다.

응답 본문

성공할 경우 응답 본문에 다음 구조의 데이터가 포함됩니다.

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

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

object (DimensionHeader)

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

object (MetricHeader)

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

object (Row)

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

object (Row)

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

object (Row)

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

object (Row)

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

integer

쿼리 결과의 총 행 수입니다. rowCount는 응답에서 반환되는 행 수와 limit 요청 매개변수와는 별개입니다. 예를 들어 쿼리에서 175개 행을 반환하고 API 요청에 50개 중 limit개를 포함하면 응답에 rowCount에는 175개 중 50개 행만 포함됩니다.
propertyQuota

object (PropertyQuota)

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

string

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

승인 범위

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

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

분 범위

연속된 분 세트: startMinutesAgo, startMinutesAgo + 1, ..., endMinutesAgo 요청은 최대 2분 동안 허용됩니다.

JSON 표현 
{
  "name": string,
  "startMinutesAgo": integer,
  "endMinutesAgo": integer
}
필드
name

string

이 분 범위에 이름을 할당합니다. 측정기준(dateRange)의 값이 보고서 응답에서 지정되어 있습니다. 이 속성을 설정하면 date_range_ 또는 RESERVED_로 시작할 수 없습니다. 설정하지 않으면 요청의 0 기반 색인(date_range_0, date_range_1 등)에 따라 분 범위의 이름이 지정됩니다.
startMinutesAgo

integer

몇 분 전부터의 쿼리(분 단위)로 시작(해당 시간)합니다. 예를 들어 "startMinutesAgo": 29는 보고서에 29분 전의 이벤트 데이터를 포함하도록 지정합니다. endMinutesAgo 이후일 수 없습니다.

지정하지 않으면 startMinutesAgo의 기본값은 29입니다. 표준 애널리틱스 속성은 최대 30분의 이벤트 데이터 (startMinutesAgo <= 29)를 요청할 수 있고 360 애널리틱스 속성은 최대 60분의 이벤트 데이터 (startMinutesAgo <= 59)를 요청할 수 있습니다.
endMinutesAgo

integer

현재 시간(분)을 기준으로 하는 쿼리의 종료 분입니다. startMinutesAgo 이전이어야 합니다. 예를 들어 "endMinutesAgo": 15는 보고서에 15분 전의 이벤트 데이터를 포함하도록 지정합니다.

지정하지 않으면 endMinutesAgo의 기본값은 0입니다. 표준 애널리틱스 속성은 지난 30분 동안의 이벤트 데이터 (endMinutesAgo <= 29)를 요청할 수 있으며, 360 애널리틱스 속성은 지난 60분 동안의 이벤트 데이터 (endMinutesAgo <= 59) 중 언제든지 1분을 요청할 수 있습니다.