Method: properties.batchRunReports

컬렉션을 사용해 정리하기 내 환경설정을 기준으로 콘텐츠를 저장하고 분류하세요.

여러 보고서를 일괄적으로 반환합니다. 모든 보고서는 동일한 GA4 속성에 대한 것이어야 합니다.

HTTP 요청

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

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

경로 매개변수

매개변수
property

string

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

예: properties/1234

요청 본문

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

JSON 표현
{
  "requests": [
    {
      object (RunReportRequest)
    }
  ]
}
필드
requests[]

object (RunReportRequest)

개별 요청 각 요청에는 별도의 보고서 응답이 있습니다. 각 일괄 요청에는 최대 5개의 요청이 허용됩니다.

응답 본문

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

여러 보고서가 포함된 일괄 응답입니다.

JSON 표현
{
  "reports": [
    {
      object (RunReportResponse)
    }
  ],
  "kind": string
}
필드
reports[]

object (RunReportResponse)

개별 응답. 응답마다 별도의 보고서 요청이 있습니다.

kind

string

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

승인 범위

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

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

RunReportRequest

보고서 생성 요청입니다.

JSON 표현
{
  "property": string,
  "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
}
필드
property

string

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

예: properties/1234

dimensions[]

object (Dimension)

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

metrics[]

object (Metric)

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

dateRanges[]

object (DateRange)

읽을 데이터의 기간입니다. 여러 기간이 요청된 경우 각 응답 행에는 0 기반 기간 색인이 포함됩니다. 두 기간이 겹치는 경우 겹치는 기간의 이벤트 데이터가 두 기간 모두의 응답 행에 포함됩니다. 동질 집단 요청에서 이 dateRanges을 지정하지 않아야 합니다.

dimensionFilter

object (FilterExpression)

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

metricFilter

object (FilterExpression)

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

offset

string (int64 format)

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

페이징할 때 첫 번째 요청은 오프셋을 지정하지 않거나 그에 상응하는 오프셋을 0으로 설정합니다. 첫 번째 요청은 행의 첫 번째 limit를 반환합니다. 두 번째 요청은 오프셋을 첫 번째 요청의 limit로 설정합니다. 두 번째 요청은 행의 두 번째 limit를 반환합니다.

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

limit

string (int64 format)

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

또한 limit 값이 측정기준 값만큼 많지 않으면 API는 요청된 limit보다 적은 수의 행을 반환할 수도 있습니다. 예를 들어 country 측정기준에 사용할 수 있는 값은 300개 미만이므로 country에 대해서만 보고할 때는 limit을 더 높은 값으로 설정해도 300개가 넘는 행을 얻을 수 없습니다.

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

metricAggregations[]

enum (MetricAggregation)

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

orderBys[]

object (OrderBy)

응답에서 행의 순서를 지정합니다.

currencyCode

string

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

cohortSpec

object (CohortSpec)

이 요청과 연결된 동질 집단 그룹 요청에 동질 집단 그룹이 있으면 '동질 집단' 측정기준이 있어야 합니다.

keepEmptyRows

boolean

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

returnPropertyQuota

boolean

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