Method: properties.submitUserDeletion

プロパティのユーザー削除リクエストを送信します。

HTTP リクエスト

POST https://analyticsadmin.googleapis.com/v1alpha/{name=properties/*}:submitUserDeletion

この URL は gRPC Transcoding 構文を使用します。

パスパラメータ

パラメータ
name

string

必須。ユーザー削除を送信するプロパティの名前。

リクエストの本文

リクエストの本文には、次の構造のデータが含まれます。

JSON 表現 
{

  // Union field user can be only one of the following:
  "userId": string,
  "clientId": string,
  "appInstanceId": string,
  "userProvidedData": string
  // End of list of possible types for union field user.
}
フィールド
共用体フィールド user。user の削除リクエストを送信できるユーザーは、次のいずれかのみです。
userId

string

Google アナリティクスのユーザー ID。
clientId

string

Google アナリティクスのクライアント ID。
appInstanceId

string

Firebase アプリケーション インスタンス ID。
userProvidedData

string

ユーザー提供データ。メールアドレスまたは電話番号のいずれか 1 つを含めることができます。

メールアドレスは次のように正規化する必要があります。

  • 小文字
  • gmail.com/googlemail.com のアドレスの @ より前のピリオドを削除
  • すべてのスペースを削除

電話番号は次のように正規化する必要があります。

  • 数字以外のすべての文字を削除
  • + 接頭辞を追加

レスポンスの本文

properties.submitUserDeletion RPC のレスポンス メッセージ。

成功した場合、レスポンスの本文には次の構造のデータが含まれます。

JSON 表現 
{
  "deletionRequestTime": string
}
フィールド
deletionRequestTime

string (Timestamp format)

この時点より前のすべての訪問者データを削除する時点を指定します。これは、削除リクエストを受信した時刻に設定されます。

RFC 3339 を使用します。生成された出力は常に Z 正規化され、小数点以下は 0、3、6、または 9 桁になります。「Z」以外のオフセットも使用できます。例: "2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z"、"2014-10-02T15:01:23+05:30"。

認可スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/analytics.edit