Partager via

Opération du service SendUserInvitation - Gestion des clients

  • Article

Envoie une invitation par e-mail pour qu’un utilisateur s’inscrive à Microsoft Advertising. L’invitation limite l’accès au compte et les autorisations.

Remarque

Seul un utilisateur disposant d’informations d’identification Super Administration ou Standard peut envoyer des invitations utilisateur. Un utilisateur Standard ne peut pas inviter un Super Administration. Pour plus d’informations, consultez le guide technique rôles d’utilisateur.

Importante

Lorsque l’invitation est envoyée, vous pouvez choisir de limiter l’accès utilisateur à un sous-ensemble de comptes d’annonceur qui se trouvent directement sous votre client. Si une hiérarchie d’agence est configurée (maintenant ou à l’avenir) sous le client où l’utilisateur est invité, et si vous ne limitez pas l’accès à des comptes spécifiques, l’utilisateur a accès à tous les comptes de la hiérarchie.

Il est possible que plusieurs invitations en attente soient envoyées à la même adresse e-mail, qui n’ont pas encore expiré. Il est également possible que ces invitations aient spécifié différents rôles d’utilisateur, par exemple si vous avez envoyé une invitation avec un rôle d’utilisateur incorrect, puis envoyé une deuxième invitation avec le rôle d’utilisateur approprié. Le destinataire peut accepter les invitations et s’inscrire avec des informations d’identification différentes de l’adresse e-mail de l’invitation. Les utilisateurs de Microsoft Advertising peuvent accepter des invitations à plusieurs clients avec les mêmes informations d’identification. Pour plus d’informations, consultez le guide technique des informations d’identification multi-utilisateur .

Vous pouvez rechercher les invitations en attente par ID d’invitation et déterminer si l’invitation a été acceptée ou a expiré. L’opération SearchUserInvitations retourne toutes les invitations en attente, qu’elles aient expiré ou non. Les invitations acceptées ne sont pas incluses dans la réponse SearchUserInvitations .

Une fois l’invitation acceptée, vous pouvez appeler GetUsersInfo et GetUser pour accéder aux détails de l’utilisateur Microsoft Advertising. Toutefois, étant donné qu’un destinataire peut accepter l’invitation et s’inscrire avec des informations d’identification différentes de l’adresse e-mail de l’invitation, vous ne pouvez pas déterminer avec certitude le mappage d’un UserInvitation à un objet User Ou UserInfo . Avec l’ID utilisateur retourné par GetUsersInfo ou GetUser, vous pouvez appeler DeleteUser pour supprimer l’utilisateur si nécessaire. L’API Bing Ads ne prend pas en charge les opérations de suppression des invitations utilisateur en attente. Une fois que vous avez invité un utilisateur, la seule façon d’annuler l’invitation est de passer par l’application web Microsoft Advertising. Vous trouverez les invitations en attente et acceptées dans la section Utilisateurs de Comptes & Facturation.

Éléments de demande

L’objet SendUserInvitationRequest définit les éléments body et header 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
UserInvitation Invitation de l’utilisateur à envoyer. UserInvitation

É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
Mot de passe 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 SendUserInvitationResponse 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

Élément Description Type de données
UserInvitationId Identificateur généré par le système pour l’invitation de l’utilisateur qui a été envoyée. long

É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">SendUserInvitation</Action>
    <AuthenticationToken i:nil="false">ValueHere</AuthenticationToken>
    <DeveloperToken i:nil="false">ValueHere</DeveloperToken>
  </s:Header>
  <s:Body>
    <SendUserInvitationRequest xmlns="https://bingads.microsoft.com/Customer/v13">
      <UserInvitation xmlns:e557="https://bingads.microsoft.com/Customer/v13/Entities" i:nil="false">
        <e557:Id>ValueHere</e557:Id>
        <e557:FirstName i:nil="false">ValueHere</e557:FirstName>
        <e557:LastName i:nil="false">ValueHere</e557:LastName>
        <e557:Email i:nil="false">ValueHere</e557:Email>
        <e557:CustomerId>ValueHere</e557:CustomerId>
        <e557:RoleId>ValueHere</e557:RoleId>
        <e557:AccountIds i:nil="false" xmlns:a1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <a1:long>ValueHere</a1:long>
        </e557:AccountIds>
        <e557:ExpirationDate>ValueHere</e557:ExpirationDate>
        <e557:Lcid>ValueHere</e557:Lcid>
      </UserInvitation>
    </SendUserInvitationRequest>
  </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>
    <SendUserInvitationResponse xmlns="https://bingads.microsoft.com/Customer/v13">
      <UserInvitationId>ValueHere</UserInvitationId>
    </SendUserInvitationResponse>
  </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<SendUserInvitationResponse> SendUserInvitationAsync(
	UserInvitation userInvitation)
{
	var request = new SendUserInvitationRequest
	{
		UserInvitation = userInvitation
	};

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

static SendUserInvitationResponse sendUserInvitation(
	UserInvitation userInvitation) throws RemoteException, Exception
{
	SendUserInvitationRequest request = new SendUserInvitationRequest();

	request.setUserInvitation(userInvitation);

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

static function SendUserInvitation(
	$userInvitation)
{

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

	$request = new SendUserInvitationRequest();

	$request->UserInvitation = $userInvitation;

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

response=customermanagement_service.SendUserInvitation(
	UserInvitation=UserInvitation)

Configuration requise

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

URL de la demande

https://clientcenter.api.bingads.microsoft.com/CustomerManagement/v13/UserInvitation/Send

Éléments de demande

L’objet SendUserInvitationRequest définit les éléments body et header de la demande d’opération de service.

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
UserInvitation Invitation de l’utilisateur à envoyer. UserInvitation

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

Élément Description Type de données
Autorisation Jeton d’accès OAuth qui représente les informations d’identification d’un utilisateur disposant d’autorisations sur les comptes Microsoft Advertising. Vérifiez que le jeton est précédé de « Porteur », ce qui est nécessaire pour une authentification appropriée.

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
Mot de passe 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 SendUserInvitationResponse 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 le json de réponse.

Response Body, éléments

Élément Description Type de données
UserInvitationId Identificateur généré par le système pour l’invitation de l’utilisateur qui a été envoyée. long

É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 JSON

Ce modèle a été généré par un outil pour afficher le corps et les éléments d’en-tête de la requête JSON. 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.

{
  "UserInvitation": {
    "AccountIds": [
      "LongValueHere"
    ],
    "CustomerId": "LongValueHere",
    "Email": "ValueHere",
    "ExpirationDate": "ValueHere",
    "FirstName": "ValueHere",
    "Id": "LongValueHere",
    "LastName": "ValueHere",
    "Lcid": "ValueHere",
    "RoleId": IntValueHere
  }
}

JSON de réponse

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

{
  "UserInvitationId": "LongValueHere"
}

Syntaxe du code

Pour appeler l’API REST via des kits SDK, vous devez mettre à niveau le KIT de développement logiciel (SDK) vers une certaine version et configurer les paramètres système. 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<SendUserInvitationResponse> SendUserInvitationAsync(
	UserInvitation userInvitation)
{
	var request = new SendUserInvitationRequest
	{
		UserInvitation = userInvitation
	};

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

static SendUserInvitationResponse sendUserInvitation(
	UserInvitation userInvitation) throws RemoteException, Exception
{
	SendUserInvitationRequest request = new SendUserInvitationRequest();

	request.setUserInvitation(userInvitation);

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

static function SendUserInvitation(
	$userInvitation)
{

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

	$request = new SendUserInvitationRequest();

	$request->UserInvitation = $userInvitation;

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

response=customermanagement_service.SendUserInvitation(
	UserInvitation=UserInvitation)