이 가이드에서는 애플리케이션이 Real Time Reporting API에 대한 요청을 승인하는 방법을 설명합니다.
요청 승인
사용자가 Google 애널리틱스 웹사이트에서 계정 정보를 보려면 먼저 Google 계정에 로그인해야 합니다. 마찬가지로 사용자가 애플리케이션에 처음 액세스하면 데이터에 액세스할 수 있도록 애플리케이션을 승인해야 합니다.
애플리케이션에서 애널리틱스 API로 전송하는 모든 요청에는 승인 토큰이 포함되어야 합니다. Google은 이 토큰을 사용하여 애플리케이션을 식별합니다.
승인 프로토콜 정보
요청을 승인하려면 애플리케이션에서 OAuth 2.0을 사용해야 합니다. 다른 승인 프로토콜은 지원되지 않습니다. 애플리케이션에서 Google 계정으로 로그인을 사용하는 경우, 승인의 일부 절차는 자동으로 처리됩니다.
OAuth 2.0을 사용하여 요청 승인하기
Analytics API에 대한 모든 요청은 인증된 사용자의 승인을 받아야 합니다.
OAuth 2.0의 세부적인 승인 절차('흐름')는 제작 중인 애플리케이션 종류에 따라 약간씩 다릅니다. 다음의 일반적인 과정은 모든 애플리케이션 유형에 적용됩니다.
- 애플리케이션을 만들 때 Google API 콘솔을 사용하여 애플리케이션을 등록합니다. 이렇게 하면 Google에서 클라이언트 ID 및 클라이언트 보안 비밀과 같이 나중에 필요한 정보를 제공합니다.
- Google API 콘솔에서 Analytics API를 활성화합니다. API 콘솔의 목록에 이 API가 없다면 이 단계를 건너뜁니다.
- 애플리케이션에서 사용자 데이터에 액세스해야 하는 경우 Google에 특정 액세스 범위를 요청합니다.
- Google에서 사용자에게 애플리케이션이 일부 데이터를 요청하도록 승인할 것인지 물어보는 동의 화면을 표시합니다.
- 사용자가 승인하면 Google에서 애플리케이션에 제한 시간이 있는 액세스 토큰을 제공합니다.
- 애플리케이션에서 액세스 토큰을 첨부하여 사용자 데이터를 요청합니다.
- Google에서 요청과 토큰이 유효하다고 판단하면 요청된 데이터를 반환합니다.
일부 흐름에는 새로운 액세스 토큰을 얻기 위해 갱신 토큰을 사용하는 등의 추가 단계가 포함됩니다. 다양한 유형의 애플리케이션에 적용되는 흐름을 자세히 알아보려면 Google의 OAuth 2.0 문서를 참조하세요.
다음은 Analytics API의 OAuth 2.0 범위 정보입니다.
| 범위 | 의미 |
|---|---|
https://www.googleapis.com/auth/analytics.readonly |
애널리틱스 API에 대한 읽기 전용 액세스 권한입니다. |
OAuth 2.0을 사용하여 액세스를 요청하려면 애플리케이션에 범위 정보와 함께 애플리케이션 등록 시 Google에서 제공하는 정보(예: 클라이언트 ID, 클라이언트 보안 비밀)가 필요합니다.
팁: Google API 클라이언트 라이브러리가 사용자를 대신하여 일부 승인 과정을 처리할 수 있습니다. 이러한 라이브러리는 다양한 프로그래밍 언어로 제공됩니다. 자세한 내용은 라이브러리 및 샘플 페이지를 참조하세요.
일반적인 OAuth 2.0 흐름
다음은 특정 OAuth 2.0 흐름에 대한 일반적인 사용 사례입니다.
웹 서버
이 흐름은 사용자의 Google 애널리틱스 데이터에 대한 자동, 오프라인 또는 예약된 액세스에 적합합니다.
예:
- 최신 Google 애널리틱스 데이터로 사용자 대시보드 자동 업데이트
클라이언트 측
이 흐름은 사용자가 브라우저 내에서 Google 애널리틱스 데이터에 액세스하기 위해 애플리케이션과 직접 상호작용하는 애플리케이션에 이상적입니다. 서버 측 기능은 필요하지 않지만 자동화, 오프라인 또는 예약 보고가 비실용적입니다.
예:
- 애널리틱스 검색어 탐색기와 같은 브라우저 기반 보고 도구
설치된 애플리케이션
이 흐름은 패키지로 배포되고 사용자가 설치한 애플리케이션을 위한 것입니다. 이 흐름을 완료하려면 애플리케이션 또는 사용자가 브라우저에 액세스할 수 있어야 합니다.
예:
- PC 또는 Mac의 데스크톱 위젯
- 콘텐츠 관리 시스템용 플러그인 — 웹 서버 또는 클라이언트 측에 비해 이 흐름의 이점은 애플리케이션에 단일 API 콘솔 프로젝트를 사용할 수 있다는 것입니다. 이렇게 하면 통합 보고서가 제공되며 사용자가 더 간편하게 설치할 수 있습니다.
서비스 계정
서비스 계정은 자체 계정의 Google 애널리틱스 데이터에 대한 자동, 오프라인 또는 예약 액세스에 유용합니다. 예를 들어 나만의 Google 애널리틱스 데이터로 실시간 대시보드를 만들어 다른 사용자와 공유할 수 있습니다.
Analytics API 사용을 시작하려면 먼저 설정 도구를 사용해야 합니다. 설정 도구는 Google API 콘솔에서 프로젝트를 만들고, API를 사용 설정하고, 사용자 인증 정보를 만드는 방법을 안내합니다.
새 서비스 계정을 설정하려면 다음 안내를 따르세요.
- 사용자 인증 정보 만들기 > 서비스 계정 키를 클릭합니다.
- 서비스 계정의 공개/비공개 키를 표준 P12 파일로 다운로드할지 또는 Google API 클라이언트 라이브러리에서 로드할 수 있는 JSON 파일로 다운로드할지 선택합니다.
새로운 공개 키/비공개 키 쌍이 생성되고 기기에 다운로드됩니다. 생성된 파일은 이 키의 유일한 사본입니다. 이를 안전하게 저장해야 합니다.
문제 해결
다음과 같은 경우 인증에 실패합니다.
access_token가 만료되었거나 API에 잘못된 범위를 사용하는 경우401상태 코드가 표시됩니다.승인된 사용자가 보기 (프로필)에 액세스할 수 없는 경우
403상태 코드가 표시됩니다. 올바른 사용자로 승인되었고 해당 사용자가 내가 선택한 보기 (프로필)를 가지고 있는지 확인합니다.
OAuth 2.0 플레이그라운드
이 도구를 사용하면 웹 인터페이스를 통해 전체 인증 흐름을 진행할 수 있습니다. 또한 이 도구는 승인된 쿼리를 만드는 데 필요한 모든 HTTP 요청 헤더를 표시합니다. 애플리케이션에서 작동하는 데 필요한 승인을 얻을 수 없는 경우 OAuth 2.0 Playground를 통해 작동되도록 해야 합니다. 그런 다음 플레이그라운드의 HTTP 헤더 및 요청을 애플리케이션에서 Google 애널리틱스로 전송하는 항목과 비교할 수 있습니다. 이 방법으로 요청의 형식이 올바른지 쉽게 확인할 수 있습니다.
잘못된 권한 부여
갱신 토큰을 사용하려고 하면 다음과 같은 경우 invalid_grant 오류가 반환됩니다.
- 서버 시계가 네트워크 시간 프로토콜(NTP)과 동기화되지 않았습니다.
- 갱신 토큰 한도를 초과했습니다.
애플리케이션에서 단일 Google 애널리틱스 계정에 액세스하기 위해 갱신 토큰을 여러 개 요청할 수 있습니다.
예를 들어 사용자가 여러 시스템에 애플리케이션을 설치하고 동일한 Google 애널리틱스 계정에 액세스하려는 경우 각 시스템에 별도의 토큰이 필요합니다. 갱신 토큰 수가 한도를 초과하면 이전 토큰은 무효화됩니다. 애플리케이션이 무효화된 새로고침 토큰을 사용하려고 하면 invalid_grant 오류 응답이 반환됩니다.
OAuth 2.0 클라이언트와 Google 애널리틱스 계정의 고유한 쌍당 한도는 갱신 토큰 25개입니다. 애플리케이션이 동일한 클라이언트/계정 쌍에 대해 갱신 토큰을 계속 요청하는 경우 26번째 토큰이 발급되고 나면 이전에 발급된 첫 번째 갱신 토큰이 무효화됩니다. 27번째 요청 갱신 토큰은 이전에 두 번째로 발급된 토큰을 무효화하는 식입니다.