Method: properties.reportTasks.query

보고서 작업의 콘텐츠를 검색합니다. reportTasks.create를 요청한 후 보고서가 활성화되면 보고서 콘텐츠를 검색할 수 있습니다. 이 메서드는 보고서 작업의 상태가 ACTIVE가 아니면 오류를 반환합니다. 쿼리 응답은 보고서의 표 형식 행 및 열 값을 반환합니다.

HTTP 요청

POST https://analyticsdata.googleapis.com/v1alpha/{name=properties/*/reportTasks/*}:query

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

경로 매개변수

매개변수
name

string

필수 항목입니다. 보고서 소스 이름입니다. 형식: properties/{property}/reportTasks/{report}

요청 본문

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

JSON 표현 
{
  "offset": string,
  "limit": string
}
입력란
offset

string (int64 format)

선택사항입니다. 보고서에서 시작 행의 행 수입니다. 첫 번째 행은 0행으로 계산됩니다.

페이징할 때 첫 번째 요청은 오프셋을 지정하지 않습니다. 즉, 오프셋을 0으로 설정합니다. 첫 번째 요청은 행의 처음 limit를 반환합니다. 두 번째 요청은 첫 번째 요청의 limit로 오프셋을 설정합니다. 두 번째 요청은 행의 두 번째 limit를 반환합니다.

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

string (int64 format)

선택사항입니다. 보고서에서 반환할 행의 개수입니다. 지정하지 않으면 10,000개의 행이 반환됩니다. API는 요청하는 횟수에 관계없이 요청당 최대 250,000개의 행을 반환합니다. limit은(는) 양수여야 합니다.

측정기준 값이 limit만큼 많지 않은 경우 API가 요청된 limit보다 적은 수의 행을 반환할 수도 있습니다. QueryReportTaskRequest에 사용할 수 있는 행 수는 연결된 ReportTask의 제한에 의해 추가로 제한됩니다. 쿼리는 최대 ReportTask.limit개의 행을 검색할 수 있습니다. 예를 들어 ReportTask의 한도가 1,000개인 경우 offset=900 및 limit=500인 reportTasks.query 요청은 최대 100개의 행을 반환합니다.

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

응답 본문

보고서 작업에 해당하는 보고서 콘텐츠입니다.

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

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

object (DimensionHeader)

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

object (MetricHeader)

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

object (Row)

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

object (Row)

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

object (Row)

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

object (Row)

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

integer

쿼리 결과의 총 행 수입니다.
metadata

object (ResponseMetaData)

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

승인 범위

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

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

ResponseMetaData

보고서 콘텐츠에 대한 추가 정보를 포함하는 응답의 메타데이터입니다.

JSON 표현 
{
  "dataLossFromOtherRow": boolean,
  "schemaRestrictionResponse": {
    object (SchemaRestrictionResponse)
  },
  "currencyCode": string,
  "timeZone": string,
  "emptyReason": string,
  "subjectToThresholding": boolean
}
입력란
dataLossFromOtherRow

boolean

true인 경우 측정기준 조합의 일부 버킷이 '(기타)' 행으로 집계됨을 나타냅니다. 이 문제는 카디널리티가 높은 보고서에서 발생할 수 있습니다.

메타데이터 매개변수 dataLossFromOtherRow는 보고서에 사용된 집계 데이터 테이블을 기반으로 채워집니다. 매개변수는 보고서의 필터 및 제한과 관계없이 정확하게 채워집니다.

예를 들어 요청에 sessionSource = google에 대한 필터가 포함되어 있으므로 보고서에서 (other) 행이 삭제될 수 있습니다. 이 보고서를 생성하는 데 사용된 입력 집계 데이터에 다른 행의 데이터 손실이 있는 경우 이 매개변수가 계속 채워집니다.

자세한 내용은 (기타) 행 및 데이터 샘플링에 대한 정보를 참고하세요.
schemaRestrictionResponse

object (SchemaRestrictionResponse)

이 보고서를 만들 때 시행된 스키마 제한사항을 설명합니다. 자세한 내용은 액세스 및 데이터 제한 관리를 참고하세요.
currencyCode

string

이 보고서에 사용된 통화 코드입니다. 시각화를 위해 통화 측정항목의 형식을 지정할 때 사용됩니다(예: purchaseRevenue). 요청에 currencyCode가 지정된 경우 이 응답 매개변수는 요청 매개변수를 반영합니다. 그렇지 않으면 이 응답 매개변수가 속성의 현재 currencyCode입니다.

통화 코드는 ISO 4217 표준(https://en.wikipedia.org/wiki/ISO_4217)에 따른 통화 유형의 문자열 인코딩입니다(예: 'USD', 'EUR', 'JPY'). 자세한 내용은 https://support.google.com/analytics/answer/9796179를 참고하세요.
timeZone

string

숙박 시설의 현재 시간대입니다. hour 및 minute와 같은 시간 기반 측정기준을 해석하는 데 사용됩니다. IANA 시간대 데이터베이스(https://www.iana.org/time-zones)의 문자열로 형식이 지정됩니다(예: 'America/New_York' 또는 'Asia/Tokyo').
emptyReason

string

빈 이유를 지정하면 보고서가 비어 있습니다.
subjectToThresholding

boolean

subjectToThresholding이 true이면 이 보고서에 기준점이 적용되며, 최소 집계 기준점을 충족하는 데이터만 반환됩니다. 요청에 기준점 기준점이 적용되고 보고서에 데이터가 없을 수 있으며, 이는 모든 데이터가 기준점을 초과할 때 발생합니다. 자세한 내용은 데이터 기준점과 인구통계 및 관심분야 정보를 참고하세요.

SchemaRestrictionResponse

이 보고서를 만들 때 현재 적용된 스키마 제한사항입니다. 자세한 내용은 액세스 및 데이터 제한 관리를 참고하세요.

JSON 표현 
{
  "activeMetricRestrictions": [
    {
      object (ActiveMetricRestriction)
    }
  ]
}
입력란
activeMetricRestrictions[]

object (ActiveMetricRestriction)

보고서 생성 시 시행 중인 모든 제한사항입니다. 예를 들어 purchaseRevenue의 제한사항 유형은 항상 REVENUE_DATA입니다. 하지만 이 활성 응답 제한은 사용자의 커스텀 역할이 REVENUE_DATA에 대한 액세스를 허용하지 않는 경우에만 채워집니다.

ActiveMetricRestriction

보고서 생성 시 엄격하게 제한된 측정항목입니다.

JSON 표현 
{
  "restrictedMetricTypes": [
    enum (RestrictedMetricType)
  ],
  "metricName": string
}
입력란
restrictedMetricTypes[]

enum (RestrictedMetricType)

이 측정항목이 제한되는 이유입니다.
metricName

string

제한된 측정항목의 이름입니다.

RestrictedMetricType

특정 GA4 속성에서 보지 못할 수 있는 데이터 카테고리입니다.

열거형
RESTRICTED_METRIC_TYPE_UNSPECIFIED 알 수 없는 유형.
COST_DATA 비용 측정항목(예: adCost)
REVENUE_DATA 수익 측정항목(예: purchaseRevenue)