Partager via

Opération de service FindAccounts - Gestion des clients

  • Article

Obtient une liste des comptes appartenant au client spécifié qui correspondent aux critères de filtre spécifiés.

Éléments de demande

L’objet FindAccountsRequest 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
AccountFilter Critères à utiliser pour filtrer la liste des comptes. Vous pouvez spécifier un nom de compte ou un numéro de compte. Si votre valeur de filtre est au format Xnnnnn, où nnnnn est une série de chiffres, l’opération filtre par numéro de compte.

La valeur de filtre peut contenir un nom de compte partiel ou complet ou le numéro des comptes que vous souhaitez obtenir. L’opération inclut le compte dans le résultat si le nom ou le numéro du compte 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 du compte. Par exemple, si vous spécifiez « t » comme valeur de filtre, la liste inclut les comptes dont le nom commence par « t » ou « T ».

Définir cet élément sur une chaîne vide est identique à l’appel de GetAccountsInfo.		 chaîne
CustomerId Identificateur du client dont vous souhaitez obtenir les comptes.

Si la valeur est null, l’opération recherche une correspondance entre tous les comptes des clients que l’utilisateur gère et possède.		 long
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 FindAccountsResponse 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
AccountsInfo Liste des objets AccountInfo des comptes qui correspondent aux critères de filtre spécifiés.

Pour obtenir les détails complets d’un compte dans la liste, accédez à l’élément Id de l’objet AccountInfo et utilisez-le pour appeler GetAccount.		 Tableau AccountInfo

É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">FindAccounts</Action>
    <AuthenticationToken i:nil="false">ValueHere</AuthenticationToken>
    <DeveloperToken i:nil="false">ValueHere</DeveloperToken>
  </s:Header>
  <s:Body>
    <FindAccountsRequest xmlns="https://bingads.microsoft.com/Customer/v13">
      <CustomerId i:nil="false">ValueHere</CustomerId>
      <AccountFilter i:nil="false">ValueHere</AccountFilter>
      <TopN>ValueHere</TopN>
    </FindAccountsRequest>
  </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>
    <FindAccountsResponse xmlns="https://bingads.microsoft.com/Customer/v13">
      <AccountsInfo xmlns:e475="https://bingads.microsoft.com/Customer/v13/Entities" d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">
        <e475:AccountInfo>
          <e475:Id>ValueHere</e475:Id>
          <e475:Name d4p1:nil="false">ValueHere</e475:Name>
          <e475:Number d4p1:nil="false">ValueHere</e475:Number>
          <e475:AccountLifeCycleStatus>ValueHere</e475:AccountLifeCycleStatus>
          <e475:PauseReason d4p1:nil="false">ValueHere</e475:PauseReason>
        </e475:AccountInfo>
      </AccountsInfo>
    </FindAccountsResponse>
  </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<FindAccountsResponse> FindAccountsAsync(
	long? customerId,
	string accountFilter,
	int topN)
{
	var request = new FindAccountsRequest
	{
		CustomerId = customerId,
		AccountFilter = accountFilter,
		TopN = topN
	};

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

static FindAccountsResponse findAccounts(
	java.lang.Long customerId,
	java.lang.String accountFilter,
	int topN) throws RemoteException, Exception
{
	FindAccountsRequest request = new FindAccountsRequest();

	request.setCustomerId(customerId);
	request.setAccountFilter(accountFilter);
	request.setTopN(topN);

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

static function FindAccounts(
	$customerId,
	$accountFilter,
	$topN)
{

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

	$request = new FindAccountsRequest();

	$request->CustomerId = $customerId;
	$request->AccountFilter = $accountFilter;
	$request->TopN = $topN;

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

response=customermanagement_service.FindAccounts(
	CustomerId=CustomerId,
	AccountFilter=AccountFilter,
	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/Accounts/Find

Éléments de demande

L’objet FindAccountsRequest 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
AccountFilter Critères à utiliser pour filtrer la liste des comptes. Vous pouvez spécifier un nom de compte ou un numéro de compte. Si votre valeur de filtre est au format Xnnnnn, où nnnnn est une série de chiffres, l’opération filtre par numéro de compte.

La valeur de filtre peut contenir un nom de compte partiel ou complet ou le numéro des comptes que vous souhaitez obtenir. L’opération inclut le compte dans le résultat si le nom ou le numéro du compte 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 du compte. Par exemple, si vous spécifiez « t » comme valeur de filtre, la liste inclut les comptes dont le nom commence par « t » ou « T ».

Définir cet élément sur une chaîne vide est identique à l’appel de GetAccountsInfo.		 chaîne
CustomerId Identificateur du client dont vous souhaitez obtenir les comptes.

Si la valeur est null, l’opération recherche une correspondance entre tous les comptes des clients que l’utilisateur gère et possède.		 long
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 FindAccountsResponse 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
AccountsInfo Liste des objets AccountInfo des comptes qui correspondent aux critères de filtre spécifiés.

Pour obtenir les détails complets d’un compte dans la liste, accédez à l’élément Id de l’objet AccountInfo et utilisez-le pour appeler GetAccount.		 Tableau AccountInfo

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

{
  "CustomerId": "LongValueHere",
  "AccountFilter": "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.

{
  "AccountsInfo": [
    {
      "AccountLifeCycleStatus": "ValueHere",
      "Id": "LongValueHere",
      "Name": "ValueHere",
      "Number": "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<FindAccountsResponse> FindAccountsAsync(
	long? customerId,
	string accountFilter,
	int topN)
{
	var request = new FindAccountsRequest
	{
		CustomerId = customerId,
		AccountFilter = accountFilter,
		TopN = topN
	};

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

static FindAccountsResponse findAccounts(
	java.lang.Long customerId,
	java.lang.String accountFilter,
	int topN) throws RemoteException, Exception
{
	FindAccountsRequest request = new FindAccountsRequest();

	request.setCustomerId(customerId);
	request.setAccountFilter(accountFilter);
	request.setTopN(topN);

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

static function FindAccounts(
	$customerId,
	$accountFilter,
	$topN)
{

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

	$request = new FindAccountsRequest();

	$request->CustomerId = $customerId;
	$request->AccountFilter = $accountFilter;
	$request->TopN = $topN;

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

response=customermanagement_service.FindAccounts(
	CustomerId=CustomerId,
	AccountFilter=AccountFilter,
	TopN=TopN)