Opération du service GetUsersInfo - Gestion des clients

Article
12/21/2023

Obtient une liste d’objets qui contient des informations d’identification de l’utilisateur, par exemple le nom d’utilisateur et l’identificateur de l’utilisateur.

Éléments de demande

L’objet GetUsersInfoRequest 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
Customerid	Identificateur du client auquel les utilisateurs appartiennent.	Long
StatusFilter	Valeur status que l’opération utilise pour filtrer la liste des utilisateurs qu’elle retourne. L’opération retourne uniquement les utilisateurs avec le status spécifié.	UserLifeCycleStatus

É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 GetUsersInfoResponse 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
UsersInfo	Liste d’objets UserInfo qui identifie la liste des utilisateurs qui répondent aux critères de filtre. Pour obtenir les données utilisateur d’un utilisateur dans la liste, accédez à l’élément Id de l’objet UserInfo et utilisez-le pour appeler GetUser.	Tableau UserInfo

É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">GetUsersInfo</Action>
    <AuthenticationToken i:nil="false">ValueHere</AuthenticationToken>
    <DeveloperToken i:nil="false">ValueHere</DeveloperToken>
  </s:Header>
  <s:Body>
    <GetUsersInfoRequest xmlns="https://bingads.microsoft.com/Customer/v13">
      <CustomerId>ValueHere</CustomerId>
      <StatusFilter i:nil="false">ValueHere</StatusFilter>
    </GetUsersInfoRequest>
  </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>
    <GetUsersInfoResponse xmlns="https://bingads.microsoft.com/Customer/v13">
      <UsersInfo xmlns:e242="https://bingads.microsoft.com/Customer/v13/Entities" d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">
        <e242:UserInfo>
          <e242:Id>ValueHere</e242:Id>
          <e242:UserName d4p1:nil="false">ValueHere</e242:UserName>
        </e242:UserInfo>
      </UsersInfo>
    </GetUsersInfoResponse>
  </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<GetUsersInfoResponse> GetUsersInfoAsync(
	long customerId,
	UserLifeCycleStatus? statusFilter)
{
	var request = new GetUsersInfoRequest
	{
		CustomerId = customerId,
		StatusFilter = statusFilter
	};

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

static GetUsersInfoResponse getUsersInfo(
	java.lang.Long customerId,
	UserLifeCycleStatus statusFilter) throws RemoteException, Exception
{
	GetUsersInfoRequest request = new GetUsersInfoRequest();

	request.setCustomerId(customerId);
	request.setStatusFilter(statusFilter);

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

static function GetUsersInfo(
	$customerId,
	$statusFilter)
{

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

	$request = new GetUsersInfoRequest();

	$request->CustomerId = $customerId;
	$request->StatusFilter = $statusFilter;

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

response=customermanagement_service.GetUsersInfo(
	CustomerId=CustomerId,
	StatusFilter=StatusFilter)

Configuration requise

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

Partager via