佈建合作夥伴控管的帳戶 – API 開發人員指南

簡介

createAccountTree 是 Provisioning API 的一部分，可用來大規模建立新的 Google Analytics (分析) 帳戶。有別於 createAccountTicket，createAccountTree 不需要任何使用者互動即可完成帳戶建立程序，這項程序將完全自動化。如果您需要佈建可代表客戶管理的 Analytics (分析) 帳戶，並讓客戶自訂該資料的檢視，這項功能就非常實用。

這個 API 僅供控制使用者網站或網站資源的合作夥伴使用。如果使用者自行管理網站或網站資源，建議您改為建立由使用者控管的 Analytics (分析) 帳戶。

事前準備

所有 Google Analytics (分析) API 的存取方式都很類似。開始使用 Provisioning API 之前，請先完成下列事項：

  • 如需可與 API 搭配使用的程式設計語言特定用戶端程式庫的完整清單，請參閱用戶端程式庫頁面。
  • 請閱讀參考指南，瞭解 API 介面以及如何在沒有用戶端程式庫的情況下存取資料。

每個用戶端程式庫都會提供一個數據分析服務物件，用來存取 Provisioning API。一般來說，您必須完成下列步驟，才能建立服務物件：

  1. 在 Google API 控制台中註冊您的應用程式。
  2. 授權建立新的 Google Analytics (分析) 帳戶。
  3. 建立 Analytics (分析) 服務物件。

如果您尚未完成這些步驟，請停止並參閱 Hello Google Analytics API 教學課程。本教學課程將逐步介紹建立 Google Analytics (分析) API 應用程式的初始步驟。完成後，您會瞭解如何存取 Google Analytics (分析) API 來執行實際工作。

範本帳戶

您必須取得新的 Google Analytics (分析) 帳戶，才能使用這個 API。建立新帳戶時，帳戶會沿用範本帳戶的各項設定，包括《服務條款》接受者、機構組織和各種資料共用設定。如要進一步瞭解範本帳戶，包括所有沿用資料的清單，請參閱 createAccountTree 參考資料。

佈建帳戶

如要佈建新的 Google Analytics (分析) 帳戶，請向 createAccountTree API 端點提出要求。您會需要下列佈建詳細資料：

  • 帳戶欄位
    • 帳戶的 accountName。
  • 「網站資源」欄位
    • 屬性的 webpropertyName。
    • websiteUrl。此網址必須與這個 Analytics (分析) 帳戶的使用者屬性相關聯。
  • 檢視欄位
    • 檢視區塊的 profileName。
    • 檢視區塊的 timezone。

取得詳細資料後，請向 API 端點發出「已驗證」的呼叫：

POST https://www.googleapis.com/analytics/v3/provisioning/createAccountTree
{
    "accountName": "Analytics Account",
    "webpropertyName": "Default Property",
    "profileName": "Default View",
    "timezone": "America/Los_Angeles",
    "websiteUrl": "www.example-pet-store.com",
}

如果驗證成功，API 會傳回新建帳戶、網站資源和資料檢視的詳細資料：

{
    "account": {
        "id": "999999999",
        "name": "Analytics Account",
        "created": "2018-03-16T23:35:20.699Z",
        "updated": "2018-03-16T23:35:20.699Z",
        ...
    },
    "webproperty": {
        "id": "UA-999999999-1",
        "name": "Default Property",
        "websiteUrl": "www.example-pet-store.com",
        "created": "2018-03-16T23:35:20.699Z",
        "updated": "2018-03-16T23:35:20.699Z",
        ...
    },
    "profile": {
        "id": "999999999",
        "name": "Default View",
        "timezone": "America/Los_Angeles",
        "created": "2018-03-16T23:35:20.699Z",
        "updated": "2018-03-16T23:35:20.699Z",
        ...
    },
    ...
}

帳戶擁有權與管理

如此一來，透過 OAuth 授權回應的使用者帳戶就會擁有已建立的 Google Analytics (分析) 帳戶。因此，建議貴機構使用服務帳戶管理 Analytics (分析) 帳戶，不要使用個別使用者帳戶。

帳戶建立完成後，您可以使用 Management API 進行設定。以下是新建帳戶的常見工作：

客戶關係說明

與所有 Google API 一樣，申請授權時須先建立 Google Cloud 專案。如 OAuth 2.0 說明文件所述，這個帳戶可讓您管理 API 要求的憑證。不過，建立的 Google Analytics (分析) 帳戶與 Cloud 專案或其客戶帳戶之間並沒有直接關聯，而是與授權要求的使用者或服務帳戶相關聯。如果您需要設定 Analytics (分析) 帳戶的帳戶存取權，請使用 Management API。