Method: properties.submitUserDeletion

Envoie une demande de suppression d'un utilisateur pour une propriété.

Requête HTTP

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

L'URL utilise la syntaxe de transcodage gRPC.

Paramètres de chemin d'accès

Paramètres
name

string

Obligatoire. Nom de la propriété pour laquelle envoyer la demande de suppression de l'utilisateur.

Corps de la requête

Le corps de la requête contient des données présentant la structure suivante :

Représentation 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.
}
Champs
Champ d'union user. L'utilisateur pour lequel envoyer une demande de suppression user ne peut être que l'un des suivants :
userId

string

ID utilisateur Google Analytics user ID.
clientId

string

ID client Google Analytics .
appInstanceId

string

ID d'instance d'application Firebase.
userProvidedData

string

Données fournies par l'utilisateur. Peut contenir une adresse e-mail ou un numéro de téléphone.

Les adresses e-mail doivent être normalisées comme suit :

  • lowercase
  • supprimer les points avant @ pour les adresses gmail.com/googlemail.com
  • supprimer tous les espaces

Les numéros de téléphone doivent être normalisés comme suit :

  • supprimer tous les caractères qui ne sont pas des chiffres
  • ajouter le préfixe +

Corps de la réponse

Message de réponse pour l'appel RPC properties.submitUserDeletion.

Si la requête aboutit, le corps de la réponse contient des données qui ont la structure suivante :

Représentation JSON 
{
  "deletionRequestTime": string
}
Champs
deletionRequestTime

string (Timestamp format)

Indique le moment à partir duquel toutes les données des visiteurs doivent être supprimées. Il correspond à l'heure à laquelle la demande de suppression a été reçue.

Utilise la norme RFC 3339, où la sortie générée utilise toujours le format UTC (indiqué par "Z" pour le temps universel coordonné) avec des secondes fractionnaires de 0, 3, 6 ou 9 chiffres décimaux. Des décalages horaires autres que "Z" (UTC) sont également acceptés. Exemples : "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".

Niveaux d'accès des autorisations

Requiert le champ d'application OAuth suivant :

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