User Deletion API - 概要

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

はじめに

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

概要

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

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

特定のユーザーのデータ削除をリクエストするには、upsert メソッドを使用します。upsert メソッドは、ユーザー削除リクエスト リソースを唯一のパラメータとして受け取ります。データ削除リクエストは、Google アナリティクスのウェブ プロパティ（webPropertyId フィールドで指定）または GA4 プロパティ（propertyId フィールドで指定）に適用できます。id.userId フィールド内の識別子のいずれかを設定することで、データを削除するユーザーを指定できます。ID のタイプは id.type フィールド内で指定する必要があります。サポートされているユーザー ID の種類は次のとおりです。

  • CLIENT_ID: Google アナリティクス クライアント ID（webPropertyIdwebPropertyId または propertyIdwebPropertyId フィールドが設定されている場合にのみ使用可能）。
  • USER_ID: Google アナリティクス ユーザー ID（webPropertyId webPropertyIdまたは propertyIdwebPropertyId フィールドが設定されている場合にのみ使用可能）。
  • APP_INSTANCE_ID: Firebase アプリケーション インスタンス ID（firebaseProjectIdfirebaseProjectId または firebaseProjectId フィールドが設定されている場合にのみ使用可能）。

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

データの削除

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

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