本教學課程會逐步介紹存取 Analytics Reporting API v4 的必要步驟。
1. 啟用 API
如要開始使用 Analytics Reporting API v4,您必須先使用設定工具,這項工具會逐步引導您在 Google API 控制台中建立專案、啟用 API,並建立憑證。
建立憑證
- 開啟「服務帳戶」頁面。如果出現系統提示,請選取您要使用的專案。
- 按一下 [ 建立服務帳戶],然後輸入服務帳戶的名稱和說明。您可以使用預設的服務帳戶 ID,也可以自行選擇其他不重複的名稱。完成後,請按一下 [建立]。
- 系統會隨即顯示「服務帳戶權限」部分,不過您不一定要設定這些權限。請按一下 [繼續]。
- 在「將這個服務帳戶的存取權授予使用者」畫面中,向下捲動至「建立金鑰」部分。按一下 [ 建立金鑰]。
- 在隨即顯示的側邊面板中選取金鑰格式;建議您選擇 [JSON]。
- 按一下 [建立],接著,系統就會為您產生一對新的公開/私密金鑰,並下載至您的電腦中;這是金鑰的唯一副本,如要瞭解安全儲存的方式,請參閱管理服務帳戶金鑰。
- 在 [已將私密金鑰儲存至您的電腦中] 對話方塊中按一下 [關閉],然後再按一下 [完成],即可返回您的服務帳戶表格。
在 Google Analytics (分析) 帳戶中新增服務帳戶
新建立的服務帳戶電子郵件地址看起來會像這樣:
quickstart@PROJECT-ID.iam.gserviceaccount.com
請使用這個電子郵件地址,在您要透過 API 存取的 Google Analytics (分析) 資料檢視中新增使用者。本教學課程僅需要「檢視及分析」權限。
2. 安裝用戶端程式庫
建議您使用 pip 與 venv 來安裝 Python 套件: sudo -s apt-get install python3-venv python3 -m venv analytics-quickstart source analytics-quickstart/bin/activate pip install --upgrade google-api-python-client pip install -- oauth2client
3. 設定範例
您必須建立名為 HelloAnalytics.py
的單一檔案,其中包含指定的程式碼範例。
- 將下列原始碼複製或下載至
HelloAnalytics.py
。 - 將先前下載的
client_secrets.json
移至與程式碼範例相同的目錄。 - 將
KEY_FILE_LOCATION
的值替換為下載的client_secrets.json
的適當路徑。 - 取代
VIEW_ID
的值。您可以使用帳戶總管來找出資料檢視 ID。
"""Hello Analytics Reporting API V4.""" from apiclient.discovery import build from oauth2client.service_account import ServiceAccountCredentials SCOPES = ['https://www.googleapis.com/auth/analytics.readonly'] KEY_FILE_LOCATION = '<REPLACE_WITH_JSON_FILE>' VIEW_ID = '<REPLACE_WITH_VIEW_ID>' def initialize_analyticsreporting(): """Initializes an Analytics Reporting API V4 service object. Returns: An authorized Analytics Reporting API V4 service object. """ credentials = ServiceAccountCredentials.from_json_keyfile_name( KEY_FILE_LOCATION, SCOPES) # Build the service object. analytics = build('analyticsreporting', 'v4', credentials=credentials) return analytics def get_report(analytics): """Queries the Analytics Reporting API V4. Args: analytics: An authorized Analytics Reporting API V4 service object. Returns: The Analytics Reporting API V4 response. """ return analytics.reports().batchGet( body={ 'reportRequests': [ { 'viewId': VIEW_ID, 'dateRanges': [{'startDate': '7daysAgo', 'endDate': 'today'}], 'metrics': [{'expression': 'ga:sessions'}], 'dimensions': [{'name': 'ga:country'}] }] } ).execute() def print_response(response): """Parses and prints the Analytics Reporting API V4 response. Args: response: An Analytics Reporting API V4 response. """ for report in response.get('reports', []): columnHeader = report.get('columnHeader', {}) dimensionHeaders = columnHeader.get('dimensions', []) metricHeaders = columnHeader.get('metricHeader', {}).get('metricHeaderEntries', []) for row in report.get('data', {}).get('rows', []): dimensions = row.get('dimensions', []) dateRangeValues = row.get('metrics', []) for header, dimension in zip(dimensionHeaders, dimensions): print(header + ': ', dimension) for i, values in enumerate(dateRangeValues): print('Date range:', str(i)) for metricHeader, value in zip(metricHeaders, values.get('values')): print(metricHeader.get('name') + ':', value) def main(): analytics = initialize_analyticsreporting() response = get_report(analytics) print_response(response) if __name__ == '__main__': main()
4. 執行範例
使用以下方式執行範例:
python HelloAnalytics.py
完成上述步驟後,樣本就會針對指定的資料檢視輸出過去七天的工作階段數。
疑難排解
AttributeError:「Module_six_moves_urllib_parse」物件沒有「urlparse」屬性
Mac OSX 可能會發生這項錯誤,此時系統會在安裝 pip 的之前載入「six」模組 (此程式庫的依附元件) 的預設安裝元件。如要修正這個問題,請將 pip 的安裝位置新增至 PYTHONPATH
系統環境變數:
使用下列指令判斷 管線的安裝位置:
直立線顯示六個 | grep "Location:: |截 -d " " -f2
在
~/.bashrc
檔案中新增下列程式碼,將<pip_install_path>
替換為上述決定的值:匯出 PYTHONPATH=$PYTHONPATH:<pip_install_path>
使用下列指令,在任何開啟的終端機視窗中重新載入
~/.bashrc
檔案:來源 ~/.bashrc