ユーザー削除用の Google Analytics Admin API に移行する

以前の Google アナリティクス User Deletion API（v3）は、ユニバーサル アナリティクスとともに提供を終了しました。Google アナリティクス Admin API（v1alpha）には、Google アナリティクスのプロパティのユーザーのデータ削除をリクエストするための代替の SubmitUserDeletion メソッドが用意されています。

移行が必要かどうか

コードで以前の User Deletion API（v3）の upsert メソッドが呼び出されている場合は、Google アナリティクス プロパティのユーザー削除を行うために、Google アナリティクス Admin API に移行する必要があります。

移行手順

新しい 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 アナリティクス 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 スコープを更新する

Google Analytics Admin API の新しい SubmitUserDeletion は、スコープ https://www.googleapis.com/auth/analytics.edit を使用します。

これは、https://www.googleapis.com/auth/analytics.user.deletion スコープを使用していた以前の User Deletion API とは異なります。

https://www.googleapis.com/auth/analytics.user.deletion を使用して https://www.googleapis.com/auth/analytics.edit をリクエストしているコードまたはアクセス トークン リクエスト コマンドはすべて更新する必要があります。

クライアント ライブラリを使用している場合は、必要なスコープが自動的にリクエストされます。

以前の API を無効にする

SubmitUserDeletion メソッドを使用するようにコードを更新したら、Google Cloud プロジェクトで以前の API を無効にできます。

次のリンクを開いて、Google Cloud コンソールで以前のユニバーサル アナリティクス API エンドポイントを開きます。Cloud プロジェクトを選択し、[API を無効にする] ボタンをクリックします。