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

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

移行が必要な理由

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

移行手順

新しい SubmitUserDeletion メソッドを使用する手順は次のとおりです。

Google Analytics Admin API を有効にする

次の [Google Analytics Admin API を有効にする] ボタンをクリックして、プロジェクトを選択または作成し、 Google Analytics Admin API を 自動的に有効にします。

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

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 を無効にする] ボタンをクリックします。