從 Google Analytics User Deletion API 遷移

舊版 Google Analytics User Deletion API 即將停用。Google Analytics Admin API 提供替代的 SubmitUserDeletion 方法,可要求刪除特定使用者的資料。

我需要遷移嗎?

如果您的程式碼呼叫舊版使用者刪除 API 的 upsert 方法,請遷移程式碼,以便繼續使用使用者刪除功能。

遷移步驟

請按照下列步驟開始使用新的 SubmitUserDeletion 方法。

啟用 Google Analytics Admin API

按一下「啟用 Google Analytics Admin API」按鈕,選取或建立新的 Google Cloud 專案,並自動啟用 Google Analytics Admin API。

啟用 Google Analytics Admin API

尋找並取代對舊版 User Deletion API 的呼叫

將對舊版 User Deletion API 舊版 upsert 方法的所有呼叫,替換為對 Google Analytics Admin API 新版 SubmitUserDeletion 方法的呼叫。

以下是向舊版 User Deletion API 提出的要求範例:upsert

REST

  POST https://analytics.googleapis.com/analytics/v3/userDeletion/userDeletionRequests:upsert
  {
    "propertyId": "1234567",
    "id": {
      "type": "USER_ID",
      "userId": "user123"
    }
  }

Google Analytics Admin API 的對等 SubmitUserDeletion 請求範例:

REST

  POST https://analyticsadmin.googleapis.com/v1alpha/properties/1234567:submitUserDeletion
  {
    "userId": "user123"
  }

更新要求的 OAuth 範圍

新版 SubmitUserDeletion Google Analytics Admin API 使用範圍 https://www.googleapis.com/auth/analytics.edit

這與舊版 User Deletion API 不同,舊版 API 使用 https://www.googleapis.com/auth/analytics.user.deletion 範圍。

您應更新所有使用 https://www.googleapis.com/auth/analytics.user.deletion 的程式碼或存取權杖要求指令,改為要求 https://www.googleapis.com/auth/analytics.edit

如果您使用用戶端程式庫,程式庫應會自動要求必要的範圍。

停用舊版 API

更新程式碼以使用 SubmitUserDeletion 方法後,即可在 Google Cloud 專案中停用舊版 API。

開啟下列連結,在 Google Cloud 控制台中開啟舊版通用 Analytics API 端點。選取 Cloud 專案,然後按一下「停用 API」按鈕。