Partager via

Opération du service FindAccountsOrCustomersInfo - Gestion des clients

  • Article

Obtient une liste des comptes et des clients qui correspondent aux critères de filtre spécifiés.

Éléments de demande

L’objet FindAccountsOrCustomersInfoRequest 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
Filtre Critères à utiliser pour filtrer la liste des comptes et des clients. Vous pouvez spécifier un nom de compte, un numéro de compte ou un nom de client.

La valeur de filtre peut contenir un nom ou un nombre partiel ou complet. L’opération inclut le compte ou le client dans le résultat si le nom ou le numéro commence par la valeur de filtre spécifiée.

L’opération effectue une comparaison qui ne respecte pas la casse lorsqu’elle compare votre valeur de filtre au nom ou au numéro. Par exemple, si vous spécifiez « t » comme valeur de filtre, la liste inclut les comptes et les clients dont le nom commence par « t » ou « T ».

L’opération filtre d’abord les comptes qui correspondent aux critères de filtre. Si le nombre de comptes qui correspondent aux critères de filtre est inférieur à la valeur TopN spécifiée, l’opération recherche les clients dont le nom correspond aux critères de filtre.

Définir cet élément sur une chaîne vide revient à appeler GetAccountsInfo , puis à appeler GetCustomersInfo.		 chaîne
ReturnAdditionalFields Liste des propriétés supplémentaires que vous souhaitez inclure dans chaque compte retourné. Les valeurs de champ supplémentaires vous permettent d’obtenir les dernières fonctionnalités à l’aide de la version actuelle de l’API Gestion des clients, et dans la version suivante, les éléments correspondants seront inclus par défaut.

Cet élément de requête est facultatif.		 AccountAdditionalField
TopN Entier positif différent de zéro qui spécifie le nombre de comptes à retourner dans le résultat. Vous devez spécifier une valeur comprise entre 1 et 5 000. 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 FindAccountsOrCustomersInfoResponse 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
AccountInfoWithCustomerData Liste des objets AccountInfoWithCustomerData des comptes et clients qui correspondent aux critères de filtre spécifiés.

Les objets contiennent des informations qui identifient le compte et le client. Pour obtenir les détails complets d’un compte dans la liste, accédez à l’élément AccountId de l’objet AccountInfoWithCustomerData et utilisez-le pour appeler l’opération GetAccount .

Pour obtenir les détails complets d’un client dans la liste, accédez à l’élément CustomerId de l’objet AccountInfoWithCustomerData et utilisez-le pour appeler GetCustomer.		 Tableau AccountInfoWithCustomerData

É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">FindAccountsOrCustomersInfo</Action>
    <AuthenticationToken i:nil="false">ValueHere</AuthenticationToken>
    <DeveloperToken i:nil="false">ValueHere</DeveloperToken>
  </s:Header>
  <s:Body>
    <FindAccountsOrCustomersInfoRequest xmlns="https://bingads.microsoft.com/Customer/v13">
      <Filter i:nil="false">ValueHere</Filter>
      <TopN>ValueHere</TopN>
      <ReturnAdditionalFields i:nil="false">ValueHere</ReturnAdditionalFields>
    </FindAccountsOrCustomersInfoRequest>
  </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>
    <FindAccountsOrCustomersInfoResponse xmlns="https://bingads.microsoft.com/Customer/v13">
      <AccountInfoWithCustomerData xmlns:e485="https://bingads.microsoft.com/Customer/v13/Entities" d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">
        <e485:AccountInfoWithCustomerData>
          <e485:CustomerId d4p1:nil="false">ValueHere</e485:CustomerId>
          <e485:CustomerName d4p1:nil="false">ValueHere</e485:CustomerName>
          <e485:AccountId>ValueHere</e485:AccountId>
          <e485:AccountName d4p1:nil="false">ValueHere</e485:AccountName>
          <e485:AccountNumber d4p1:nil="false">ValueHere</e485:AccountNumber>
          <e485:AccountLifeCycleStatus>ValueHere</e485:AccountLifeCycleStatus>
          <e485:PauseReason d4p1:nil="false">ValueHere</e485:PauseReason>
          <e485:AccountMode d4p1:nil="false">ValueHere</e485:AccountMode>
        </e485:AccountInfoWithCustomerData>
      </AccountInfoWithCustomerData>
    </FindAccountsOrCustomersInfoResponse>
  </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<FindAccountsOrCustomersInfoResponse> FindAccountsOrCustomersInfoAsync(
	string filter,
	int topN,
	AccountAdditionalField? returnAdditionalFields)
{
	var request = new FindAccountsOrCustomersInfoRequest
	{
		Filter = filter,
		TopN = topN,
		ReturnAdditionalFields = returnAdditionalFields
	};

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

static FindAccountsOrCustomersInfoResponse findAccountsOrCustomersInfo(
	java.lang.String filter,
	int topN,
	ArrayList<AccountAdditionalField> returnAdditionalFields) throws RemoteException, Exception
{
	FindAccountsOrCustomersInfoRequest request = new FindAccountsOrCustomersInfoRequest();

	request.setFilter(filter);
	request.setTopN(topN);
	request.setReturnAdditionalFields(returnAdditionalFields);

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

static function FindAccountsOrCustomersInfo(
	$filter,
	$topN,
	$returnAdditionalFields)
{

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

	$request = new FindAccountsOrCustomersInfoRequest();

	$request->Filter = $filter;
	$request->TopN = $topN;
	$request->ReturnAdditionalFields = $returnAdditionalFields;

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

response=customermanagement_service.FindAccountsOrCustomersInfo(
	Filter=Filter,
	TopN=TopN,
	ReturnAdditionalFields=ReturnAdditionalFields)

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/AccountsOrCustomersInfo/Find

Éléments de demande

L’objet FindAccountsOrCustomersInfoRequest 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
Filtre Critères à utiliser pour filtrer la liste des comptes et des clients. Vous pouvez spécifier un nom de compte, un numéro de compte ou un nom de client.

La valeur de filtre peut contenir un nom ou un nombre partiel ou complet. L’opération inclut le compte ou le client dans le résultat si le nom ou le numéro commence par la valeur de filtre spécifiée.

L’opération effectue une comparaison qui ne respecte pas la casse lorsqu’elle compare votre valeur de filtre au nom ou au numéro. Par exemple, si vous spécifiez « t » comme valeur de filtre, la liste inclut les comptes et les clients dont le nom commence par « t » ou « T ».

L’opération filtre d’abord les comptes qui correspondent aux critères de filtre. Si le nombre de comptes qui correspondent aux critères de filtre est inférieur à la valeur TopN spécifiée, l’opération recherche les clients dont le nom correspond aux critères de filtre.

Définir cet élément sur une chaîne vide revient à appeler GetAccountsInfo , puis à appeler GetCustomersInfo.		 chaîne
ReturnAdditionalFields Liste des propriétés supplémentaires que vous souhaitez inclure dans chaque compte retourné. Les valeurs de champ supplémentaires vous permettent d’obtenir les dernières fonctionnalités à l’aide de la version actuelle de l’API Gestion des clients, et dans la version suivante, les éléments correspondants seront inclus par défaut.

Cet élément de requête est facultatif.		 AccountAdditionalField
TopN Entier positif différent de zéro qui spécifie le nombre de comptes à retourner dans le résultat. Vous devez spécifier une valeur comprise entre 1 et 5 000. 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 FindAccountsOrCustomersInfoResponse 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
AccountInfoWithCustomerData Liste des objets AccountInfoWithCustomerData des comptes et clients qui correspondent aux critères de filtre spécifiés.

Les objets contiennent des informations qui identifient le compte et le client. Pour obtenir les détails complets d’un compte dans la liste, accédez à l’élément AccountId de l’objet AccountInfoWithCustomerData et utilisez-le pour appeler l’opération GetAccount .

Pour obtenir les détails complets d’un client dans la liste, accédez à l’élément CustomerId de l’objet AccountInfoWithCustomerData et utilisez-le pour appeler GetCustomer.		 Tableau AccountInfoWithCustomerData

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

{
  "Filter": "ValueHere",
  "TopN": IntValueHere,
  "ReturnAdditionalFields": "ValueHere"
}

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.

{
  "AccountInfoWithCustomerData": [
    {
      "AccountId": "LongValueHere",
      "AccountLifeCycleStatus": "ValueHere",
      "AccountMode": "ValueHere",
      "AccountName": "ValueHere",
      "AccountNumber": "ValueHere",
      "CustomerId": "LongValueHere",
      "CustomerName": "ValueHere",
      "PauseReason": "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<FindAccountsOrCustomersInfoResponse> FindAccountsOrCustomersInfoAsync(
	string filter,
	int topN,
	AccountAdditionalField? returnAdditionalFields)
{
	var request = new FindAccountsOrCustomersInfoRequest
	{
		Filter = filter,
		TopN = topN,
		ReturnAdditionalFields = returnAdditionalFields
	};

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

static FindAccountsOrCustomersInfoResponse findAccountsOrCustomersInfo(
	java.lang.String filter,
	int topN,
	ArrayList<AccountAdditionalField> returnAdditionalFields) throws RemoteException, Exception
{
	FindAccountsOrCustomersInfoRequest request = new FindAccountsOrCustomersInfoRequest();

	request.setFilter(filter);
	request.setTopN(topN);
	request.setReturnAdditionalFields(returnAdditionalFields);

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

static function FindAccountsOrCustomersInfo(
	$filter,
	$topN,
	$returnAdditionalFields)
{

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

	$request = new FindAccountsOrCustomersInfoRequest();

	$request->Filter = $filter;
	$request->TopN = $topN;
	$request->ReturnAdditionalFields = $returnAdditionalFields;

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

response=customermanagement_service.FindAccountsOrCustomersInfo(
	Filter=Filter,
	TopN=TopN,
	ReturnAdditionalFields=ReturnAdditionalFields)