Partager via

Opération du service GetCustomersInfo - Gestion des clients

  • Article

Obtient les identificateurs et les noms des clients qui sont accessibles à l’utilisateur authentifié actuel.

Les résultats sont filtrés par nom de client.

Éléments de demande

L’objet GetCustomersInfoRequest 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
CustomerNameFilter Nom partiel ou complet des clients que vous souhaitez obtenir. L’opération inclut le client dans le résultat si le nom du client commence par le nom de filtre spécifié.

Cet élément de requête est facultatif. Si vous ne souhaitez pas filtrer par nom de client, définissez cet élément sur une chaîne vide.

L’opération effectue une comparaison qui ne respecte pas la casse lorsqu’elle compare la valeur de votre filtre de nom aux noms des clients. Par exemple, si vous spécifiez « t » comme valeur de filtre, la liste inclut les clients dont le nom commence par « t » ou « T ».		 chaîne
TopN Entier positif différent de zéro qui spécifie le nombre de clients à retourner dans le résultat. int

É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 GetCustomersInfoResponse 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
CustomersInfo Liste des informations sur les clients qui correspondent aux critères de la demande. Tableau CustomerInfo

É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">GetCustomersInfo</Action>
    <AuthenticationToken i:nil="false">ValueHere</AuthenticationToken>
    <DeveloperToken i:nil="false">ValueHere</DeveloperToken>
  </s:Header>
  <s:Body>
    <GetCustomersInfoRequest xmlns="https://bingads.microsoft.com/Customer/v13">
      <CustomerNameFilter i:nil="false">ValueHere</CustomerNameFilter>
      <TopN>ValueHere</TopN>
    </GetCustomersInfoRequest>
  </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>
    <GetCustomersInfoResponse xmlns="https://bingads.microsoft.com/Customer/v13">
      <CustomersInfo xmlns:e501="https://bingads.microsoft.com/Customer/v13/Entities" d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">
        <e501:CustomerInfo>
          <e501:Id d4p1:nil="false">ValueHere</e501:Id>
          <e501:Name d4p1:nil="false">ValueHere</e501:Name>
        </e501:CustomerInfo>
      </CustomersInfo>
    </GetCustomersInfoResponse>
  </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<GetCustomersInfoResponse> GetCustomersInfoAsync(
	string customerNameFilter,
	int topN)
{
	var request = new GetCustomersInfoRequest
	{
		CustomerNameFilter = customerNameFilter,
		TopN = topN
	};

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

static GetCustomersInfoResponse getCustomersInfo(
	java.lang.String customerNameFilter,
	int topN) throws RemoteException, Exception
{
	GetCustomersInfoRequest request = new GetCustomersInfoRequest();

	request.setCustomerNameFilter(customerNameFilter);
	request.setTopN(topN);

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

static function GetCustomersInfo(
	$customerNameFilter,
	$topN)
{

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

	$request = new GetCustomersInfoRequest();

	$request->CustomerNameFilter = $customerNameFilter;
	$request->TopN = $topN;

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

response=customermanagement_service.GetCustomersInfo(
	CustomerNameFilter=CustomerNameFilter,
	TopN=TopN)

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/CustomersInfo/Query

Éléments de demande

L’objet GetCustomersInfoRequest définit le corps et les éléments d’en-tête 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
CustomerNameFilter Nom partiel ou complet des clients que vous souhaitez obtenir. L’opération inclut le client dans le résultat si le nom du client commence par le nom de filtre spécifié.

Cet élément de requête est facultatif. Si vous ne souhaitez pas filtrer par nom de client, définissez cet élément sur une chaîne vide.

L’opération effectue une comparaison qui ne respecte pas la casse lorsqu’elle compare la valeur de votre filtre de nom aux noms des clients. Par exemple, si vous spécifiez « t » comme valeur de filtre, la liste inclut les clients dont le nom commence par « t » ou « T ».		 chaîne
TopN Entier positif différent de zéro qui spécifie le nombre de clients à retourner dans le résultat. int

É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 GetCustomersInfoResponse 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
CustomersInfo Liste des informations sur les clients qui correspondent aux critères de la demande. Tableau CustomerInfo

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

{
  "CustomerNameFilter": "ValueHere",
  "TopN": 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.

{
  "CustomersInfo": [
    {
      "Id": "LongValueHere",
      "Name": "ValueHere"
    }
  ]
}

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<GetCustomersInfoResponse> GetCustomersInfoAsync(
	string customerNameFilter,
	int topN)
{
	var request = new GetCustomersInfoRequest
	{
		CustomerNameFilter = customerNameFilter,
		TopN = topN
	};

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

static GetCustomersInfoResponse getCustomersInfo(
	java.lang.String customerNameFilter,
	int topN) throws RemoteException, Exception
{
	GetCustomersInfoRequest request = new GetCustomersInfoRequest();

	request.setCustomerNameFilter(customerNameFilter);
	request.setTopN(topN);

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

static function GetCustomersInfo(
	$customerNameFilter,
	$topN)
{

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

	$request = new GetCustomersInfoRequest();

	$request->CustomerNameFilter = $customerNameFilter;
	$request->TopN = $topN;

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

response=customermanagement_service.GetCustomersInfo(
	CustomerNameFilter=CustomerNameFilter,
	TopN=TopN)