API 快速入門導覽課程:使用指令列

本頁將說明如何透過指令列開始使用 Google Analytics Data API v1。

步驟 1:啟用 API

按一下這個按鈕來建立新的 Cloud Platform 專案,自動啟用 Google Analytics Data API v1,並建立本教學課程所需的 OAuth2 憑證:

啟用 Google Analytics Data API v1

系統會自動將您重新導向至 OAuth2 憑證設定對話方塊。當系統詢問「您要打電話來在哪裡?」時,選擇「電腦」

在出現的對話方塊中,按一下「Download CLIENT CONFIGURATION」,並將 credentials.json 檔案儲存到工作目錄。

或者,您也可以按照這些步驟,在現有專案中手動建立 OAuth2 憑證。

步驟 2:安裝並初始化 Cloud SDK

您需要在開發機器上安裝 gcloud 指令列工具。

步驟 3:發出 API 呼叫

您現在可以使用 Google Analytics Data API 查詢 Google Analytics (分析) 4 資源。

選取檢舉實體

在本教學課程中,我們將使用環境變數 GA4_PROPERTY_ID 儲存要在 API 要求中使用的屬性 ID。

在指令列中輸入以下內容,設定 GA4_PROPERTY_ID 變數:

export GA4_PROPERTY_ID=[YOUR-GA4-PROPERTY-ID]

將 [YOUR-GA4-PROPERTY-ID] 替換成您的 Google Analytics (分析) 4 資源 ID。例如:

export GA4_PROPERTY_ID=1234567890

建立要求 JSON

以下 request.json 檔案示範如何建立簡易報表。

使用下列文字建立 JSON 要求檔案,並將檔案以 request.json 純文字檔案儲存在工作目錄中:

request.json

{
  "dateRanges": [{ "startDate": "2020-09-01", "endDate": "2020-09-15" }],
  "dimensions": [{ "name": "country" }],
  "metrics": [{ "name": "activeUsers" }]
}

驗證

如要取得此範例中的使用者憑證,請執行下列指令,並使用在步驟 1 下載的憑證 JSON 檔案路徑:

gcloud auth application-default login \
    --scopes=https://www.googleapis.com/auth/analytics.readonly \
    --client-id-file=[PATH/TO/credentials.json]

OAuth 使用者同意對話方塊會在新的瀏覽器視窗中開啟。

傳送要求

使用 curlrequest.json 中的主體內容,將要求傳送至 Google Analytics Data API。在指令列中輸入以下內容:

  curl -X POST \
  -H "Authorization: Bearer "$(gcloud auth application-default print-access-token) \
  -H "Content-Type: application/json; charset=utf-8" \
  https://analyticsdata.googleapis.com/v1beta/properties/$GA4_PROPERTY_ID:runReport -d @request.json

curl 指令使用 gcloud auth application-default print-access-token 指令取得驗證權杖。

請注意,如要將檔案名稱傳送給 curl,請使用 -d 選項 (針對「資料」) 並在檔案名稱前面加上 @ 符號。這個檔案的所在目錄應與您執行 curl 指令的所在目錄相同。

恭喜!您已將第一個要求傳送至 Google Analytics (分析) Data API。