Opération du service SearchAccounts - Gestion des clients

Article
11/14/2024

Recherche les comptes qui correspondent aux critères de la demande.

Par exemple, vous pouvez rechercher des comptes auxquels l’utilisateur actuellement authentifié peut accéder.

Conseil

Pour obtenir une vue d’ensemble avec des exemples, consultez le Guide des autorisations utilisateur et hierchy de compte.

Éléments de demande

L’objet SearchAccountsRequest 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
Classement	Détermine l’ordre des résultats par la propriété spécifiée d’un compte. Cet élément de requête est facultatif. Vous pouvez spécifier jusqu’à un élément OrderBy dans le tableau. Les éléments supplémentaires ne sont pas pris en charge et seront ignorés par le service. Si vous définissez l’élément Field de l’objet OrderBy sur « Id », « Name » ou « Number », les comptes retournés sont classés par identificateurs de compte, noms ou nombres en conséquence. Cet élément de requête est facultatif.	Tableau OrderBy
PageInfo	Détermine l’index et la taille des résultats par page.	Pagination
Prédicats	Détermine les conditions pour lesquelles toutes doivent être remplies pour retourner des comptes. Vous devez inclure exactement un prédicat. Si le prédicat Field est défini sur « AccountLifeCycleStatus », vous devez spécifier un prédicat supplémentaire avec field défini sur une autre valeur telle que UserId. Pour plus d’informations sur chaque valeur de champ de prédicat prise en charge, consultez Remarques sur le prédicat.	Tableau de prédicats
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

É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 SearchAccountsResponse 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
Comptes	Liste des comptes qui répondent aux critères de la demande.	Tableau AdvertiserAccount

É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">SearchAccounts</Action>
    <AuthenticationToken i:nil="false">ValueHere</AuthenticationToken>
    <DeveloperToken i:nil="false">ValueHere</DeveloperToken>
  </s:Header>
  <s:Body>
    <SearchAccountsRequest xmlns="https://bingads.microsoft.com/Customer/v13">
      <Predicates xmlns:e517="https://bingads.microsoft.com/Customer/v13/Entities" i:nil="false">
        <e517:Predicate>
          <e517:Field i:nil="false">ValueHere</e517:Field>
          <e517:Operator>ValueHere</e517:Operator>
          <e517:Value i:nil="false">ValueHere</e517:Value>
        </e517:Predicate>
      </Predicates>
      <Ordering xmlns:e518="https://bingads.microsoft.com/Customer/v13/Entities" i:nil="false">
        <e518:OrderBy>
          <e518:Field>ValueHere</e518:Field>
          <e518:Order>ValueHere</e518:Order>
        </e518:OrderBy>
      </Ordering>
      <PageInfo xmlns:e519="https://bingads.microsoft.com/Customer/v13/Entities" i:nil="false">
        <e519:Index>ValueHere</e519:Index>
        <e519:Size>ValueHere</e519:Size>
      </PageInfo>
      <ReturnAdditionalFields i:nil="false">ValueHere</ReturnAdditionalFields>
    </SearchAccountsRequest>
  </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>
    <SearchAccountsResponse xmlns="https://bingads.microsoft.com/Customer/v13">
      <Accounts xmlns:e520="https://bingads.microsoft.com/Customer/v13/Entities" d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">
        <e520:AdvertiserAccount>
          <e520:BillToCustomerId d4p1:nil="false">ValueHere</e520:BillToCustomerId>
          <e520:CurrencyCode d4p1:nil="false">ValueHere</e520:CurrencyCode>
          <e520:AccountFinancialStatus d4p1:nil="false">ValueHere</e520:AccountFinancialStatus>
          <e520:Id d4p1:nil="false">ValueHere</e520:Id>
          <e520:Language d4p1:nil="false">ValueHere</e520:Language>
          <e520:LastModifiedByUserId d4p1:nil="false">ValueHere</e520:LastModifiedByUserId>
          <e520:LastModifiedTime d4p1:nil="false">ValueHere</e520:LastModifiedTime>
          <e520:Name d4p1:nil="false">ValueHere</e520:Name>
          <e520:Number d4p1:nil="false">ValueHere</e520:Number>
          <e520:ParentCustomerId>ValueHere</e520:ParentCustomerId>
          <e520:PaymentMethodId d4p1:nil="false">ValueHere</e520:PaymentMethodId>
          <e520:PaymentMethodType d4p1:nil="false">ValueHere</e520:PaymentMethodType>
          <e520:PrimaryUserId d4p1:nil="false">ValueHere</e520:PrimaryUserId>
          <e520:AccountLifeCycleStatus d4p1:nil="false">ValueHere</e520:AccountLifeCycleStatus>
          <e520:TimeStamp d4p1:nil="false">ValueHere</e520:TimeStamp>
          <e520:TimeZone d4p1:nil="false">ValueHere</e520:TimeZone>
          <e520:PauseReason d4p1:nil="false">ValueHere</e520:PauseReason>
          <e520:ForwardCompatibilityMap xmlns:e521="http://schemas.datacontract.org/2004/07/System.Collections.Generic" d4p1:nil="false">
            <e521:KeyValuePairOfstringstring>
              <e521:key d4p1:nil="false">ValueHere</e521:key>
              <e521:value d4p1:nil="false">ValueHere</e521:value>
            </e521:KeyValuePairOfstringstring>
          </e520:ForwardCompatibilityMap>
          <e520:LinkedAgencies d4p1:nil="false">
            <e520:CustomerInfo>
              <e520:Id d4p1:nil="false">ValueHere</e520:Id>
              <e520:Name d4p1:nil="false">ValueHere</e520:Name>
            </e520:CustomerInfo>
          </e520:LinkedAgencies>
          <e520:SalesHouseCustomerId d4p1:nil="false">ValueHere</e520:SalesHouseCustomerId>
          <e520:TaxInformation xmlns:e522="http://schemas.datacontract.org/2004/07/System.Collections.Generic" d4p1:nil="false">
            <e522:KeyValuePairOfstringstring>
              <e522:key d4p1:nil="false">ValueHere</e522:key>
              <e522:value d4p1:nil="false">ValueHere</e522:value>
            </e522:KeyValuePairOfstringstring>
          </e520:TaxInformation>
          <e520:BackUpPaymentInstrumentId d4p1:nil="false">ValueHere</e520:BackUpPaymentInstrumentId>
          <e520:BillingThresholdAmount d4p1:nil="false">ValueHere</e520:BillingThresholdAmount>
          <e520:BusinessAddress d4p1:nil="false">
            <e520:City d4p1:nil="false">ValueHere</e520:City>
            <e520:CountryCode d4p1:nil="false">ValueHere</e520:CountryCode>
            <e520:Id d4p1:nil="false">ValueHere</e520:Id>
            <e520:Line1 d4p1:nil="false">ValueHere</e520:Line1>
            <e520:Line2 d4p1:nil="false">ValueHere</e520:Line2>
            <e520:Line3 d4p1:nil="false">ValueHere</e520:Line3>
            <e520:Line4 d4p1:nil="false">ValueHere</e520:Line4>
            <e520:PostalCode d4p1:nil="false">ValueHere</e520:PostalCode>
            <e520:StateOrProvince d4p1:nil="false">ValueHere</e520:StateOrProvince>
            <e520:TimeStamp d4p1:nil="false">ValueHere</e520:TimeStamp>
            <e520:BusinessName d4p1:nil="false">ValueHere</e520:BusinessName>
          </e520:BusinessAddress>
          <e520:AutoTagType d4p1:nil="false">ValueHere</e520:AutoTagType>
          <e520:SoldToPaymentInstrumentId d4p1:nil="false">ValueHere</e520:SoldToPaymentInstrumentId>
          <e520:TaxCertificate d4p1:nil="false">
            <e520:TaxCertificateBlobContainerName d4p1:nil="false">ValueHere</e520:TaxCertificateBlobContainerName>
            <e520:TaxCertificates xmlns:e523="http://schemas.datacontract.org/2004/07/System.Collections.Generic" d4p1:nil="false">
              <e523:KeyValuePairOfstringbase64Binary>
                <e523:key d4p1:nil="false">ValueHere</e523:key>
                <e523:value d4p1:nil="false">ValueHere</e523:value>
              </e523:KeyValuePairOfstringbase64Binary>
            </e520:TaxCertificates>
            <e520:Status d4p1:nil="false">ValueHere</e520:Status>
          </e520:TaxCertificate>
          <e520:AccountMode d4p1:nil="false">ValueHere</e520:AccountMode>
        </e520:AdvertiserAccount>
      </Accounts>
    </SearchAccountsResponse>
  </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<SearchAccountsResponse> SearchAccountsAsync(
	IList<Predicate> predicates,
	IList<OrderBy> ordering,
	Paging pageInfo,
	AccountAdditionalField? returnAdditionalFields)
{
	var request = new SearchAccountsRequest
	{
		Predicates = predicates,
		Ordering = ordering,
		PageInfo = pageInfo,
		ReturnAdditionalFields = returnAdditionalFields
	};

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

static SearchAccountsResponse searchAccounts(
	ArrayOfPredicate predicates,
	ArrayOfOrderBy ordering,
	Paging pageInfo,
	ArrayList<AccountAdditionalField> returnAdditionalFields) throws RemoteException, Exception
{
	SearchAccountsRequest request = new SearchAccountsRequest();

	request.setPredicates(predicates);
	request.setOrdering(ordering);
	request.setPageInfo(pageInfo);
	request.setReturnAdditionalFields(returnAdditionalFields);

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

static function SearchAccounts(
	$predicates,
	$ordering,
	$pageInfo,
	$returnAdditionalFields)
{

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

	$request = new SearchAccountsRequest();

	$request->Predicates = $predicates;
	$request->Ordering = $ordering;
	$request->PageInfo = $pageInfo;
	$request->ReturnAdditionalFields = $returnAdditionalFields;

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

response=customermanagement_service.SearchAccounts(
	Predicates=Predicates,
	Ordering=Ordering,
	PageInfo=PageInfo,
	ReturnAdditionalFields=ReturnAdditionalFields)

Configuration requise

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

https://clientcenter.api.bingads.microsoft.com/CustomerManagement/v13/Accounts/Search

https://clientcenter.api.sandbox.bingads.microsoft.com/CustomerManagement/v13/Accounts/Search

Éléments de demande

L’objet SearchAccountsRequest 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
Classement	Détermine l’ordre des résultats par la propriété spécifiée d’un compte. Cet élément de requête est facultatif. Vous pouvez spécifier jusqu’à un élément OrderBy dans le tableau. Les éléments supplémentaires ne sont pas pris en charge et seront ignorés par le service. Si vous définissez l’élément Field de l’objet OrderBy sur « Id », « Name » ou « Number », les comptes retournés sont classés par identificateurs de compte, noms ou nombres en conséquence. Cet élément de requête est facultatif.	Tableau OrderBy
PageInfo	Détermine l’index et la taille des résultats par page.	Pagination
Prédicats	Détermine les conditions pour lesquelles toutes doivent être remplies pour retourner des comptes. Vous devez inclure exactement un prédicat. Si le prédicat Field est défini sur « AccountLifeCycleStatus », vous devez spécifier un prédicat supplémentaire avec field défini sur une autre valeur telle que UserId. Pour plus d’informations sur chaque valeur de champ de prédicat prise en charge, consultez Remarques sur le prédicat.	Tableau de prédicats
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

É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

Response Body, éléments

Élément	Description	Type de données
Comptes	Liste des comptes qui répondent aux critères de la demande.	Tableau AdvertiserAccount

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

{
  "Predicates": [
    {
      "Field": "ValueHere",
      "Operator": "ValueHere",
      "Value": "ValueHere"
    }
  ],
  "Ordering": [
    {
      "Field": "ValueHere",
      "Order": "ValueHere"
    }
  ],
  "PageInfo": {
    "Index": IntValueHere,
    "Size": 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.

{
  "Accounts": [
    {
      "AccountFinancialStatus": "ValueHere",
      "AccountLifeCycleStatus": "ValueHere",
      "AccountMode": "ValueHere",
      "AutoTagType": "ValueHere",
      "BackUpPaymentInstrumentId": "LongValueHere",
      "BillingThresholdAmount": DecimalValueHere,
      "BillToCustomerId": "LongValueHere",
      "BusinessAddress": {
        "BusinessName": "ValueHere",
        "City": "ValueHere",
        "CountryCode": "ValueHere",
        "Id": "LongValueHere",
        "Line1": "ValueHere",
        "Line2": "ValueHere",
        "Line3": "ValueHere",
        "Line4": "ValueHere",
        "PostalCode": "ValueHere",
        "StateOrProvince": "ValueHere",
        "TimeStamp": "ValueHere"
      },
      "CurrencyCode": "ValueHere",
      "ForwardCompatibilityMap": [
        {
          "key": "ValueHere",
          "value": "ValueHere"
        }
      ],
      "Id": "LongValueHere",
      "Language": "ValueHere",
      "LastModifiedByUserId": "LongValueHere",
      "LastModifiedTime": "ValueHere",
      "LinkedAgencies": [
        {
          "Id": "LongValueHere",
          "Name": "ValueHere"
        }
      ],
      "Name": "ValueHere",
      "Number": "ValueHere",
      "ParentCustomerId": "LongValueHere",
      "PauseReason": "ValueHere",
      "PaymentMethodId": "LongValueHere",
      "PaymentMethodType": "ValueHere",
      "PrimaryUserId": "LongValueHere",
      "SalesHouseCustomerId": "LongValueHere",
      "SoldToPaymentInstrumentId": "LongValueHere",
      "TaxCertificate": {
        "Status": "ValueHere",
        "TaxCertificateBlobContainerName": "ValueHere",
        "TaxCertificates": [
          {
            "key": "ValueHere",
            "value": "ValueHere"
          }
        ]
      },
      "TaxInformation": [
        {
          "key": "ValueHere",
          "value": "ValueHere"
        }
      ],
      "TimeStamp": "ValueHere",
      "TimeZone": "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<SearchAccountsResponse> SearchAccountsAsync(
	IList<Predicate> predicates,
	IList<OrderBy> ordering,
	Paging pageInfo,
	AccountAdditionalField? returnAdditionalFields)
{
	var request = new SearchAccountsRequest
	{
		Predicates = predicates,
		Ordering = ordering,
		PageInfo = pageInfo,
		ReturnAdditionalFields = returnAdditionalFields
	};

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

static SearchAccountsResponse searchAccounts(
	ArrayOfPredicate predicates,
	ArrayOfOrderBy ordering,
	Paging pageInfo,
	ArrayList<AccountAdditionalField> returnAdditionalFields) throws RemoteException, Exception
{
	SearchAccountsRequest request = new SearchAccountsRequest();

	request.setPredicates(predicates);
	request.setOrdering(ordering);
	request.setPageInfo(pageInfo);
	request.setReturnAdditionalFields(returnAdditionalFields);

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

static function SearchAccounts(
	$predicates,
	$ordering,
	$pageInfo,
	$returnAdditionalFields)
{

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

	$request = new SearchAccountsRequest();

	$request->Predicates = $predicates;
	$request->Ordering = $ordering;
	$request->PageInfo = $pageInfo;
	$request->ReturnAdditionalFields = $returnAdditionalFields;

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

response=customermanagement_service.SearchAccounts(
	Predicates=Predicates,
	Ordering=Ordering,
	PageInfo=PageInfo,
	ReturnAdditionalFields=ReturnAdditionalFields)

Partager via

Opération du service SearchAccounts - Gestion des clients

Éléments de demande

Éléments du corps de la requête

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

Éléments Response

Response Body, éléments

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

Requête SOAP

Soap de réponse

Syntaxe du code

Configuration requise

URL de la demande

Éléments de demande

Éléments du corps de la requête

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

Éléments Response

Response Body, éléments

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

Requête JSON

JSON de réponse

Syntaxe du code

Commentaires

Ressources supplémentaires