User Deletion API - 概要

このドキュメントでは、Google アナリティクス User Deletion API の概要を説明します。

はじめに

Google アナリティクスの User Deletion API を使用すると、特定のユーザー ID に関連付けられたデータの削除を処理できます。このツールは、データの安全保護対策に役立つツールの 1 つです。

概要

Google アナリティクスの User Deletion API を使用すると、特定のユーザー ID のデータをプロジェクトまたはウェブ プロパティから削除できます。ユーザー削除リクエストは、Firebase プロジェクトか Google アナリティクスのプロパティを使用して行います。

データの削除をリクエストする

特定のユーザーのデータ削除をリクエストするには、upsert メソッドを使用します。upsert メソッドでは、ユーザー削除リクエスト リソースが唯一のパラメータとして扱われます。データ削除リクエストは、webPropertyId で指定される Google アナリティクスのウェブ プロパティか、firebaseProjectId で指定される Firebase アプリケーションに適用することができます。データを削除するユーザーを指定するには、id.userId 内の ID の 1 つを設定します。ID の種類は、id.type の中で指定する必要があります。サポートされているユーザー ID の種類は次のとおりです。

  • APP_INSTANCE_ID: Firebase アプリケーション インスタンス IDfirebaseProjectId フィールドが設定されている場合のみ使用可能)。
  • CLIENT_ID: Google アナリティクス クライアント IDwebPropertyId フィールドが設定されている場合のみ使用可能)。
  • USER_ID: Google アナリティクス ユーザー IDwebPropertyId フィールドが設定されている場合のみ使用可能)。

ユーザー ID とクライアント ID の機能について詳しくは、アナリティクス ヘルプセンターをご覧ください。

データの削除

upsert メソッドでは、deletionRequestTime フィールドが設定されたユーザー削除リクエスト リソースが返されます。deletionRequestTime フィールドは、Google アナリティクスが削除リクエストを受信した時間をマークします。

upsert メソッドを呼び出すには、https://www.googleapis.com/auth/analytics.user.deletion OAuth 2.0 スコープが必要です。