Google Analytics Data API(GA4) 연동하기 - 2. Quickstart

Google Analytics Data API(GA4) 연동하기 - 2. Quickstart

본 가이드는 Google Analytics Quickstart를 참고하여 작성하였습니다.

 

GA API 연동하기

STEP 1. Enable the API

Google Analytics를 사용하기 위해서 일종의 로그인이 필요합니다. 가이드는 Service Account 방식을 권장하는데, 아래 파란색 버튼('Enable the Google Analytics Data API v1')을 클릭하면 이후 단계를 순서대로 진행하게 됩니다. 참고로 아래 Google Analytics 가이드에 'credentials.json'이 다운로드된다고 적혀있으나 실제 파일명은 프로젝트명+자동생성문자 조합의 JSON 파일이 다운로드됨을 확인할 수 있습니다. 파일명이 길거나 외우기 어려우므로 credentials.json 또는 ga-api-key.json 등으로 변경하면 됩니다. 그리고 Service Account 키를 사용하는 것은 Putty같은 터미널에서 GA 프로젝트 서버에 직접 접근이 가능하도록 Private Key를 사용하는 것과 같습니다. 따라서 해당 키를 통해 로컬 --> GA 프로젝트 서버 또는 서버 --> GA 프로젝트 서버에 접근이 가능하게 됩니다.

프로젝트 생성 후 API 허용하기

새 프로젝트명 입력

참고로 프로젝트 생성을 위해 GCP(Google Cloud Platform)에 계정이 있어야 하고, 결제정보도 입력되어 있어야 합니다.

PRIVATE KEY JSON 파일 다운로드

---

STEP2. Add service account to the Google Analytics 4 property

다음은 'GA에 USER 추가하기'입니다. 1) credentials.json 파일에 있는 client_email을 복사한 다음 2) GA 사이트에 접속하여 Admin(왼쪽 하단 나사버튼) > Property > Property Access Management 메뉴에서 추가하면 됩니다. STEP1이 내가 생성한 프로젝트의 서버에 대한 접근권한키를 받은거라면, STEP2는 GA에 대한 보기권한 추가에 해당합니다.

PRIVATE CREDENTIALS JSON 파일 확인

GA 프로퍼티 client_email 추가하기

 

STEP3. Configure authentication

가이드에서 제안하는 쉬운 방법(An easy way to provide service account credentials)은 로컬(또는 서버)에 credentials 경로를 환경변수로 추가하는 방식입니다.

방법1. export GOOGLE_APPLICATION_CREDENTIALS

환경변수에 CREDENTIALS JSON 파일경로 추가

그러나 위 방법은 테스트시에만 권장하고 실제 운영시에는 별도의 환경파일(node.js를 예로 들면 .env)로 관리하는 것을 추천합니다.

방법2. dotenv 사용

테스트소스는 GA 리포트 샘플예제를 사용하였습니다. 

샘플소스와 다른 점은 .env를 사용해서 환경변수관리를 소스내에서 처리한다는 점입니다. 

node.js 테스트소스 구조

위 이미지에 보시면 keys 경로에 기존에 받은 JSON파일이 있고, .env파일이 있는 것을 확인할 수 있습니다.

.env 파일 내용은 다음과 같습니다.

# GOOGLE_AUTH
GOOGLE_APPLICATION_CREDENTIALS="./keys/GA-Data-Api.json"

그리고 github 또는 gitlab에 소스를 공유할 경우, json파일이 공개소스에 올라가지 않도록 .gitignore에 추가해야 합니다. 해당키로 다른 사람이 사용할 경우 GCP사용료가 발생할 수 있기 때문입니다.

 

Property ID 등록

PROPERTY ID 복사

소스에 Property ID 추가하기

실행 (2021/07/01~오늘 도시별 Active User 추가)

실행결과

 

오류상황

GA4 업그레이드 이전버전(UA = Universal Analytics) 데이터 호출시 아래와 같은 오류가 발생합니다. 구글가이드에 따르면 현재 사용주인 GA가 UA인 경우 Data API 대신 Reporting API V4를 사용하여야 합니다.

UA Property ID를 실행시 오류 발생

 

실행소스는 Github에 있습니다.