Opération du service SearchAccounts - Gestion des clients
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 |
|---|---|---|
| Commande | 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 |
| 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 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:e243="https://bingads.microsoft.com/Customer/v13/Entities" i:nil="false">
<e243:Predicate>
<e243:Field i:nil="false">ValueHere</e243:Field>
<e243:Operator>ValueHere</e243:Operator>
<e243:Value i:nil="false">ValueHere</e243:Value>
</e243:Predicate>
</Predicates>
<Ordering xmlns:e244="https://bingads.microsoft.com/Customer/v13/Entities" i:nil="false">
<e244:OrderBy>
<e244:Field>ValueHere</e244:Field>
<e244:Order>ValueHere</e244:Order>
</e244:OrderBy>
</Ordering>
<PageInfo xmlns:e245="https://bingads.microsoft.com/Customer/v13/Entities" i:nil="false">
<e245:Index>ValueHere</e245:Index>
<e245:Size>ValueHere</e245: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:e246="https://bingads.microsoft.com/Customer/v13/Entities" d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">
<e246:AdvertiserAccount>
<e246:BillToCustomerId d4p1:nil="false">ValueHere</e246:BillToCustomerId>
<e246:CurrencyCode d4p1:nil="false">ValueHere</e246:CurrencyCode>
<e246:AccountFinancialStatus d4p1:nil="false">ValueHere</e246:AccountFinancialStatus>
<e246:Id d4p1:nil="false">ValueHere</e246:Id>
<e246:Language d4p1:nil="false">ValueHere</e246:Language>
<e246:LastModifiedByUserId d4p1:nil="false">ValueHere</e246:LastModifiedByUserId>
<e246:LastModifiedTime d4p1:nil="false">ValueHere</e246:LastModifiedTime>
<e246:Name d4p1:nil="false">ValueHere</e246:Name>
<e246:Number d4p1:nil="false">ValueHere</e246:Number>
<e246:ParentCustomerId>ValueHere</e246:ParentCustomerId>
<e246:PaymentMethodId d4p1:nil="false">ValueHere</e246:PaymentMethodId>
<e246:PaymentMethodType d4p1:nil="false">ValueHere</e246:PaymentMethodType>
<e246:PrimaryUserId d4p1:nil="false">ValueHere</e246:PrimaryUserId>
<e246:AccountLifeCycleStatus d4p1:nil="false">ValueHere</e246:AccountLifeCycleStatus>
<e246:TimeStamp d4p1:nil="false">ValueHere</e246:TimeStamp>
<e246:TimeZone d4p1:nil="false">ValueHere</e246:TimeZone>
<e246:PauseReason d4p1:nil="false">ValueHere</e246:PauseReason>
<e246:ForwardCompatibilityMap xmlns:e247="http://schemas.datacontract.org/2004/07/System.Collections.Generic" d4p1:nil="false">
<e247:KeyValuePairOfstringstring>
<e247:key d4p1:nil="false">ValueHere</e247:key>
<e247:value d4p1:nil="false">ValueHere</e247:value>
</e247:KeyValuePairOfstringstring>
</e246:ForwardCompatibilityMap>
<e246:LinkedAgencies d4p1:nil="false">
<e246:CustomerInfo>
<e246:Id d4p1:nil="false">ValueHere</e246:Id>
<e246:Name d4p1:nil="false">ValueHere</e246:Name>
</e246:CustomerInfo>
</e246:LinkedAgencies>
<e246:SalesHouseCustomerId d4p1:nil="false">ValueHere</e246:SalesHouseCustomerId>
<e246:TaxInformation xmlns:e248="http://schemas.datacontract.org/2004/07/System.Collections.Generic" d4p1:nil="false">
<e248:KeyValuePairOfstringstring>
<e248:key d4p1:nil="false">ValueHere</e248:key>
<e248:value d4p1:nil="false">ValueHere</e248:value>
</e248:KeyValuePairOfstringstring>
</e246:TaxInformation>
<e246:BackUpPaymentInstrumentId d4p1:nil="false">ValueHere</e246:BackUpPaymentInstrumentId>
<e246:BillingThresholdAmount d4p1:nil="false">ValueHere</e246:BillingThresholdAmount>
<e246:BusinessAddress d4p1:nil="false">
<e246:City d4p1:nil="false">ValueHere</e246:City>
<e246:CountryCode d4p1:nil="false">ValueHere</e246:CountryCode>
<e246:Id d4p1:nil="false">ValueHere</e246:Id>
<e246:Line1 d4p1:nil="false">ValueHere</e246:Line1>
<e246:Line2 d4p1:nil="false">ValueHere</e246:Line2>
<e246:Line3 d4p1:nil="false">ValueHere</e246:Line3>
<e246:Line4 d4p1:nil="false">ValueHere</e246:Line4>
<e246:PostalCode d4p1:nil="false">ValueHere</e246:PostalCode>
<e246:StateOrProvince d4p1:nil="false">ValueHere</e246:StateOrProvince>
<e246:TimeStamp d4p1:nil="false">ValueHere</e246:TimeStamp>
<e246:BusinessName d4p1:nil="false">ValueHere</e246:BusinessName>
</e246:BusinessAddress>
<e246:AutoTagType d4p1:nil="false">ValueHere</e246:AutoTagType>
<e246:SoldToPaymentInstrumentId d4p1:nil="false">ValueHere</e246:SoldToPaymentInstrumentId>
<e246:TaxCertificate d4p1:nil="false">
<e246:TaxCertificateBlobContainerName d4p1:nil="false">ValueHere</e246:TaxCertificateBlobContainerName>
<e246:TaxCertificates xmlns:e249="http://schemas.datacontract.org/2004/07/System.Collections.Generic" d4p1:nil="false">
<e249:KeyValuePairOfstringbase64Binary>
<e249:key d4p1:nil="false">ValueHere</e249:key>
<e249:value d4p1:nil="false">ValueHere</e249:value>
</e249:KeyValuePairOfstringbase64Binary>
</e246:TaxCertificates>
<e246:Status d4p1:nil="false">ValueHere</e246:Status>
</e246:TaxCertificate>
<e246:AccountMode d4p1:nil="false">ValueHere</e246:AccountMode>
</e246: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
Noms: https://bingads.microsoft.com/Customer/v13