보고서 작업 기본 사항

보고서 작업을 사용하면 장기 실행 비동기 요청을 시작하여 Google 애널리틱스 이벤트 데이터의 맞춤 보고서

이 요청에서 생성된 보고서 작업 리소스는 Google 애널리틱스에 읽기 액세스 권한이 있는 모든 사용자가 만든 맞춤 보고서 속성

맞춤설정된 보고서는 준비 후 72시간 동안 사용할 수 있습니다. 이후 보고서 작업 리소스와 콘텐츠가 자동으로 삭제됩니다

보고서 작업 만들기

Google 애널리틱스 Data API v1은 비동기식 접근 방식을 사용하여 보고서 작업 만들기 먼저 reportTasks.create 드림 메서드가 필요합니다. 그런 다음 reportTasks.query 드림 메서드는 생성된 맞춤 보고서를 검색하는 데 사용됩니다.

또한 reportTasks.get 드림 특정 보고서 작업에 대한 구성 메타데이터를 검색하고 reportTasks.list 속성의 모든 보고서 작업을 나열합니다.

신고 항목 선택

Data API v1의 모든 메서드에는 Google 애널리틱스 속성 식별자 는 properties/GA_PROPERTY_ID. 예:

  POST  https://analyticsdata.googleapis.com/v1alpha/properties/GA_PROPERTY_ID/reportTasks

보고서는 Google 애널리틱스 이벤트를 기반으로 생성됩니다. 지정된 Google 애널리틱스 속성에서 수집된 데이터입니다.

Data API 클라이언트 라이브러리 중 하나를 사용하는 경우 요청 URL 경로를 수동으로 조작할 필요가 없습니다. 대부분의 API 클라이언트는 다음과 같은 property 매개변수를 제공합니다. properties/GA_PROPERTY_ID 형식의 문자열입니다. 빠른 시작 가이드의 예를 참고하세요. 몇 가지 방법을 소개합니다

보고서 작업 생성 요청

보고서 작업을 만들려면 reportTasks.create 드림 메서드를 ReportTask 객체를 요청할 수 있습니다 다음 매개변수가 필요합니다.

• reportDefinition 드림 맞춤 보고서의 정의를 설명하는 입력란이 있습니다. 이 매개변수의 핵심 보고 방법에서 사용하는 보고서 정의와 유사합니다.

보고서 할 일 생성 요청의 예:

POST https://analyticsdata.googleapis.com/v1alpha/properties/1234567/reportTasks
{
  "reportDefinition": {
    "dateRanges": [{ "startDate": "2024-05-01"", "endDate": "2024-05-15" }],
    "dimensions": [{ "name": "country" }],
    "metrics": [{ "name": "activeUsers" }]
  }
}

reportTasks.create 메서드의 응답에는 Report(보고서)가 포함됩니다. name 필드의 할 일 이름 (예: properties/1234567/reportTasks/123)를 사용하며, 이는 다음에서 사용할 수 있습니다. 후속 쿼리를 사용하여 보고서 작업의 상태를 가져오고 확인할 수 있습니다.

{
  "response": {
    "@type": "type.googleapis.com/google.analytics.data.v1alpha.ReportTask",
    "name": "properties/1234567/reportTasks/123",
    "reportDefinition": {
      "dimensions": [
        {
          "name": "country"
        }
      ],
      "metrics": [
        {
          "name": "activeUsers"
        }
      ],
      "dateRanges": [
        {
          "startDate": "2024-05-01",
          "endDate": "2024-05-15"
        }
      ]
    },
    "reportMetadata": {
      "state": "CREATING",
      "beginCreatingTime": "2024-05-16T00:00:01.133612336Z"
    }
  }
}

보고서 태스크 준비 상태 가져오기

보고서가 생성된 후 보고서가 생성되기까지 몇 분 정도 reportTasks.create 드림 있습니다. 보고서 작업의 준비 상태는 다음 메서드를 호출하여 가져올 수 있습니다. reportTasks.get 드림 메서드를 사용하여 축소하도�� 요청합니다.

보고서 작업 이름 사용 (예: properties/1234567/reportTasks/123) reportTasks.create 응답에서 수신된 응답에서 할 일 신고

예:

GET https://analyticsdata.googleapis.com/v1alpha/properties/1234567/reportTasks/123

보고서 작업에 대한 준비 상태는 state 드림 응답 필드입니다. 보고서 생성이 완료되면 보고서 할 일의 상태가 CREATING에서 ACTIVE로 변경됩니다.

reportMetadata 필드에는 생성된 보고서에 대한 행 수와 청구되는 할당량 토큰의 양을 나타냅니다.

{
  "reportDefinition": {
    "dimensions": [
      {
        "name": "country"
      }
    ],
    "metrics": [
      {
        "name": "activeUsers"
      }
    ],
    "dateRanges": [
      {
        "startDate": "2024-05-01",
        "endDate": "2024-05-15"
      }
    ]
  },
  "reportMetadata": {
    "state": "ACTIVE",
    "beginCreatingTime": "2024-05-16T00:00:01.133612336Z",
    "creationQuotaTokensCharged": 6,
    "taskRowCount": 167,
    "errorMessage": "",
    "totalRowCount": 167
  }
}

모든 보고서 작업의 상태를 가져오려면 reportTasks.list 드림 메서드를 사용하여 축소하도록 요청합니다.

생성된 보고서 가져오기

먼저 reportTasks.create 드림 메서드가 생성되면 reportTasks.query 메서드를 사용하고 보고서 작업 이름을 (예: properties/1234567/reportTasks/123)

POST https://analyticsdata.googleapis.com/v1alpha/properties/1234567/reportTasks/123:query

보고서 작업이 준비되면 생성된 보고서가 포함된 응답이 반환됩니다.

{
  "dimensionHeaders": [
    {
      "name": "country"
    }
  ],
  "metricHeaders": [
    {
      "name": "activeUsers",
      "type": "TYPE_INTEGER"
    }
  ],
  "rows": [

...

  ],
  "rowCount": 167,
  "metadata": {
    "currencyCode": "USD",
    "timeZone": "America/Los_Angeles"
  }
}