Opération de service DeleteUser - Gestion des clients

Article
12/21/2023

Supprime un objet user.

Remarque

Seul un utilisateur disposant d’informations d’identification Super Administration peut supprimer des utilisateurs. Pour plus d’informations, consultez le guide technique rôles d’utilisateur .

Étant donné que l’opération de suppression nécessite l’horodatage de l’opération d’écriture utilisateur la plus récente, vous devez d’abord appeler l’opération GetUser . L’opération GetUser retourne les données de l’utilisateur, qui incluent l’horodatage. L’appel de suppression échoue si vous utilisez un ancien horodatage, par exemple, les données utilisateur sont mises à jour par votre application ou une autre application après avoir obtenu l’horodatage.

Vous ne pouvez pas supprimer un utilisateur qui est l’utilisateur principal d’un compte. Avant de pouvoir supprimer un utilisateur principal, définissez l’élément PrimaryUserId de chaque compte sur un utilisateur différent.

Éléments de demande

L’objet DeleteUserRequest définit le corps et les éléments d’en-tête de la demande d’opération de service. Les éléments doivent être dans le même ordre que celui indiqué dans la requête SOAP.

Remarque

Sauf indication contraire ci-dessous, tous les éléments de requête sont requis.

Éléments du corps de la requête

Élément	Description	Type de données
Timestamp	Valeur d’horodatage utilisée par l’opération pour rapprocher la mise à jour. Vous devez appeler GetUser pour obtenir la valeur d’horodatage. L’opération de suppression échoue si l’objet utilisateur a une valeur d’horodatage qui diffère de celle que vous transmettez.	base64Binary
Userid	Identificateur de l’utilisateur à supprimer.	Long

Éléments d’en-tête de requête

Élément	Description	Type de données
AuthenticationToken	Jeton d’accès OAuth qui représente les informations d’identification d’un utilisateur disposant d’autorisations sur les comptes Microsoft Advertising. Pour plus d’informations, consultez Authentification avec OAuth.	chaîne
DeveloperToken	Jeton de développeur utilisé pour accéder à l’API Bing Ads. Pour plus d’informations, consultez Obtenir un jeton de développeur.	chaîne
Password	Cet élément est réservé à un usage interne et sera supprimé d’une version ultérieure de l’API. Vous devez utiliser l’élément AuthenticationToken pour définir les informations d’identification de l’utilisateur.	chaîne
UserName	Cet élément est réservé à un usage interne et sera supprimé d’une version ultérieure de l’API. Vous devez utiliser l’élément AuthenticationToken pour définir les informations d’identification de l’utilisateur.	chaîne

Éléments Response

L’objet DeleteUserResponse définit les éléments body et header de la réponse de l’opération de service. Les éléments sont retournés dans le même ordre que celui indiqué dans la réponse SOAP.

Response Body, éléments

Il n’y a aucun élément dans le corps de la réponse de l’opération.

Éléments d’en-tête de réponse

Élément	Description	Type de données
TrackingId	Identificateur de l’entrée de journal qui contient les détails de l’appel d’API.	chaîne

Requête SOAP

Ce modèle a été généré par un outil pour afficher l’ordre des éléments body et header pour la requête SOAP. Pour connaître les types pris en charge que vous pouvez utiliser avec cette opération de service, consultez la référence Éléments du corps de la demande ci-dessus.

<s:Envelope xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
  <s:Header xmlns="https://bingads.microsoft.com/Customer/v13">
    <Action mustUnderstand="1">DeleteUser</Action>
    <AuthenticationToken i:nil="false">ValueHere</AuthenticationToken>
    <DeveloperToken i:nil="false">ValueHere</DeveloperToken>
  </s:Header>
  <s:Body>
    <DeleteUserRequest xmlns="https://bingads.microsoft.com/Customer/v13">
      <UserId>ValueHere</UserId>
      <TimeStamp i:nil="false">ValueHere</TimeStamp>
    </DeleteUserRequest>
  </s:Body>
</s:Envelope>

Soap de réponse

Ce modèle a été généré par un outil pour afficher l’ordre des éléments de corps et d’en-tête pour la réponse SOAP.

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
  <s:Header xmlns="https://bingads.microsoft.com/Customer/v13">
    <TrackingId d3p1:nil="false" xmlns:d3p1="http://www.w3.org/2001/XMLSchema-instance">ValueHere</TrackingId>
  </s:Header>
  <s:Body>
    <DeleteUserResponse xmlns="https://bingads.microsoft.com/Customer/v13" />
  </s:Body>
</s:Envelope>

Syntaxe du code

L’exemple de syntaxe peut être utilisé avec les Kits de développement logiciel (SDK) Bing Ads. Pour plus d’exemples, consultez Exemples de code de l’API Bing Ads .

public async Task<DeleteUserResponse> DeleteUserAsync(
	long userId,
	base64Binary timeStamp)
{
	var request = new DeleteUserRequest
	{
		UserId = userId,
		TimeStamp = timeStamp
	};

	return (await CustomerManagementService.CallAsync((s, r) => s.DeleteUserAsync(r), request));
}

static DeleteUserResponse deleteUser(
	java.lang.Long userId,
	byte[] timeStamp) throws RemoteException, Exception
{
	DeleteUserRequest request = new DeleteUserRequest();

	request.setUserId(userId);
	request.setTimeStamp(timeStamp);

	return CustomerManagementService.getService().deleteUser(request);
}

static function DeleteUser(
	$userId,
	$timeStamp)
{

	$GLOBALS['Proxy'] = $GLOBALS['CustomerManagementProxy'];

	$request = new DeleteUserRequest();

	$request->UserId = $userId;
	$request->TimeStamp = $timeStamp;

	return $GLOBALS['CustomerManagementProxy']->GetService()->DeleteUser($request);
}

response=customermanagement_service.DeleteUser(
	UserId=UserId,
	TimeStamp=TimeStamp)

Configuration requise

Service : CustomerManagementService.svc v13
Noms: https://bingads.microsoft.com/Customer/v13

Partager via