Method: properties.reportTasks.query

신고 작업의 콘텐츠를 검색합니다. reportTasks.create를 요청한 후 보고서가 ACTIVE 상태가 되면 보고서 콘텐츠를 검색할 수 있습니다. 이 메서드는 보고서 작업의 상태가 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)

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

object (MetricHeader)

측정항목 열을 설명합니다. MetricHeader의 수와 MetricHeader의 순서가 행에 있는 측정항목과 일치합니다.
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,
  "samplingMetadatas": [
    {
      object (SamplingMetadata)
    }
  ],
  "schemaRestrictionResponse": {
    object (SchemaRestrictionResponse)
  },
  "currencyCode": string,
  "timeZone": string,
  "emptyReason": string,
  "subjectToThresholding": boolean
}
필드
dataLossFromOtherRow

boolean

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

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

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

자세한 내용은 (other) 행 및 데이터 샘플링에 대한 정보를 참고하세요.
samplingMetadatas[]

object (SamplingMetadata)

이 보고서 결과가 샘플링된 경우 이 보고서에 사용된 이벤트의 비율을 나타냅니다. 기간마다 하나의 samplingMetadatas가 채워집니다. 각 samplingMetadatas는 요청에 지정된 날짜 범위에 해당합니다.

그러나 결과가 샘플링되지 않으면 이 필드는 정의되지 않습니다.
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

특정 Google 애널리틱스 속성에서 보기가 제한될 수 있는 데이터 카테고리입니다.

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