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는 양수여야 합니다.

API는 limit만큼의 측정기준 값이 없는 경우 요청된 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의 수와 DimensionHeaders의 순서는 행에 있는 측정기준과 일치합니다.
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