Method: properties.runRealtimeReport

Google Analytics Realtime API는 속성의 실시간 이벤트 데이터에 대한 맞춤 보고서를 반환합니다. 이 보고서에는 최근 30분 동안의 이벤트 및 사용량이 표시됩니다.

HTTP 요청

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

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

경로 매개변수

매개변수
property

string

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

예: properties/1234

요청 본문

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

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

object (Dimension)

요청 및 표시된 측정기준입니다.
metrics[]

object (Metric)

요청 및 표시되는 측정항목입니다.
limit

string (int64 format)

반환할 행 수입니다. limit 매개변수를 지정하지 않으면 10,000개의 행이 반환됩니다. API는 요청하는 횟수에 관계없이 요청당 최대 100,000개의 행을 반환합니다.
dimensionFilter

object (FilterExpression)

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

object (FilterExpression)

측정항목의 필터 절입니다. SQL 포함 절과 유사하게 집계 후 단계에 적용됩니다. 이 필터에 사용할 측정항목을 요청해야 합니다. 이 필터에 측정기준을 사용할 수 없습니다.
metricAggregations[]

enum (MetricAggregation)

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

object (OrderBy)

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

boolean

이 애널리틱스 속성의 Realtime 할당량의 현재 상태를 반환할지 여부를 지정합니다. 할당량은 PropertyQuota에 반환됩니다.

응답 본문

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

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

JSON 표현 
{
  "dimensionHeaders": [
    {
      object (DimensionHeader)
    }
  ],
  "metricHeaders": [
    {
      object (MetricHeader)
    }
  ],
  "rows": [
    {
      object (Row)
    }
  ],
  "totals": [
    {
      object (Row)
    }
  ],
  "maximums": [
    {
      object (Row)
    }
  ],
  "minimums": [
    {
      object (Row)
    }
  ],
  "rowCount": integer,
  "propertyQuota": {
    object (PropertyQuota)
  }
}
입력란
dimensionHeaders[]

object (DimensionHeader)

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

object (MetricHeader)

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

object (Row)

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

object (Row)

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

object (Row)

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

object (Row)

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

integer

응답에 반환된 행 수와 관계없이 쿼리 결과의 총 행 수입니다. 예를 들어 쿼리에서 175개 행을 반환하고 API 요청에 제한 = 50을 포함하면 응답에 rowCount = 175개이지만 50개의 행만 포함됩니다.
propertyQuota

object (PropertyQuota)

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

승인 범위

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

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