Opération de service SearchCustomers - Gestion des clients
Recherche les clients qui correspondent aux critères de la demande.
Éléments de demande
L’objet SearchCustomersRequest 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 |
|---|---|---|
| DateRange | Détermine la plage de dates de création minimale et maximale du client. Cet élément de requête est facultatif. |
DateRange |
| Commande | Détermine l’ordre des résultats par la propriété spécifiée d’un client. 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. Pour cette opération de service, les valeurs suivantes sont prises en charge dans l’élément Field d’un objet OrderBy : Id : la commande est déterminée par l’élément Id du client retourné. Name : la commande est déterminée par l’élément Name du client retourné. Number : la commande est déterminée par l’élément Number du client retourné. |
Tableau OrderBy |
| PageInfo | Détermine l’index et la taille des résultats par page. | Pagination |
| Prédicats | Détermine les conditions auxquelles toutes doivent être remplies pour retourner des clients. Vous devez inclure entre un et 10 prédicats. Pour filtrer en fonction de la plage de dates créée, vous pouvez inclure deux prédicats avec la valeur Field définie sur CreatedDate. Sinon, vous ne pouvez utiliser chaque champ de prédicat qu’une seule fois. 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 |
É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 SearchCustomersResponse 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 |
|---|---|---|
| Clients | Liste des clients qui répondent aux critères de la demande. | Tableau de clients |
É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">SearchCustomers</Action>
<AuthenticationToken i:nil="false">ValueHere</AuthenticationToken>
<DeveloperToken i:nil="false">ValueHere</DeveloperToken>
</s:Header>
<s:Body>
<SearchCustomersRequest xmlns="https://bingads.microsoft.com/Customer/v13">
<Predicates xmlns:e255="https://bingads.microsoft.com/Customer/v13/Entities" i:nil="false">
<e255:Predicate>
<e255:Field i:nil="false">ValueHere</e255:Field>
<e255:Operator>ValueHere</e255:Operator>
<e255:Value i:nil="false">ValueHere</e255:Value>
</e255:Predicate>
</Predicates>
<DateRange xmlns:e256="https://bingads.microsoft.com/Customer/v13/Entities" i:nil="false">
<e256:MinDate i:nil="false">ValueHere</e256:MinDate>
<e256:MaxDate i:nil="false">ValueHere</e256:MaxDate>
</DateRange>
<Ordering xmlns:e257="https://bingads.microsoft.com/Customer/v13/Entities" i:nil="false">
<e257:OrderBy>
<e257:Field>ValueHere</e257:Field>
<e257:Order>ValueHere</e257:Order>
</e257:OrderBy>
</Ordering>
<PageInfo xmlns:e258="https://bingads.microsoft.com/Customer/v13/Entities" i:nil="false">
<e258:Index>ValueHere</e258:Index>
<e258:Size>ValueHere</e258:Size>
</PageInfo>
</SearchCustomersRequest>
</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>
<SearchCustomersResponse xmlns="https://bingads.microsoft.com/Customer/v13">
<Customers xmlns:e259="https://bingads.microsoft.com/Customer/v13/Entities" d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">
<e259:Customer>
<e259:CustomerFinancialStatus d4p1:nil="false">ValueHere</e259:CustomerFinancialStatus>
<e259:Id d4p1:nil="false">ValueHere</e259:Id>
<e259:Industry d4p1:nil="false">ValueHere</e259:Industry>
<e259:LastModifiedByUserId d4p1:nil="false">ValueHere</e259:LastModifiedByUserId>
<e259:LastModifiedTime d4p1:nil="false">ValueHere</e259:LastModifiedTime>
<e259:MarketCountry d4p1:nil="false">ValueHere</e259:MarketCountry>
<e259:ForwardCompatibilityMap xmlns:e260="http://schemas.datacontract.org/2004/07/System.Collections.Generic" d4p1:nil="false">
<e260:KeyValuePairOfstringstring>
<e260:key d4p1:nil="false">ValueHere</e260:key>
<e260:value d4p1:nil="false">ValueHere</e260:value>
</e260:KeyValuePairOfstringstring>
</e259:ForwardCompatibilityMap>
<e259:MarketLanguage d4p1:nil="false">ValueHere</e259:MarketLanguage>
<e259:Name d4p1:nil="false">ValueHere</e259:Name>
<e259:ServiceLevel d4p1:nil="false">ValueHere</e259:ServiceLevel>
<e259:CustomerLifeCycleStatus d4p1:nil="false">ValueHere</e259:CustomerLifeCycleStatus>
<e259:TimeStamp d4p1:nil="false">ValueHere</e259:TimeStamp>
<e259:Number d4p1:nil="false">ValueHere</e259:Number>
<e259:CustomerAddress d4p1:nil="false">
<e259:City d4p1:nil="false">ValueHere</e259:City>
<e259:CountryCode d4p1:nil="false">ValueHere</e259:CountryCode>
<e259:Id d4p1:nil="false">ValueHere</e259:Id>
<e259:Line1 d4p1:nil="false">ValueHere</e259:Line1>
<e259:Line2 d4p1:nil="false">ValueHere</e259:Line2>
<e259:Line3 d4p1:nil="false">ValueHere</e259:Line3>
<e259:Line4 d4p1:nil="false">ValueHere</e259:Line4>
<e259:PostalCode d4p1:nil="false">ValueHere</e259:PostalCode>
<e259:StateOrProvince d4p1:nil="false">ValueHere</e259:StateOrProvince>
<e259:TimeStamp d4p1:nil="false">ValueHere</e259:TimeStamp>
<e259:BusinessName d4p1:nil="false">ValueHere</e259:BusinessName>
</e259:CustomerAddress>
</e259:Customer>
</Customers>
</SearchCustomersResponse>
</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<SearchCustomersResponse> SearchCustomersAsync(
IList<Predicate> predicates,
DateRange dateRange,
IList<OrderBy> ordering,
Paging pageInfo)
{
var request = new SearchCustomersRequest
{
Predicates = predicates,
DateRange = dateRange,
Ordering = ordering,
PageInfo = pageInfo
};
return (await CustomerManagementService.CallAsync((s, r) => s.SearchCustomersAsync(r), request));
}
static SearchCustomersResponse searchCustomers(
ArrayOfPredicate predicates,
DateRange dateRange,
ArrayOfOrderBy ordering,
Paging pageInfo) throws RemoteException, Exception
{
SearchCustomersRequest request = new SearchCustomersRequest();
request.setPredicates(predicates);
request.setDateRange(dateRange);
request.setOrdering(ordering);
request.setPageInfo(pageInfo);
return CustomerManagementService.getService().searchCustomers(request);
}
static function SearchCustomers(
$predicates,
$dateRange,
$ordering,
$pageInfo)
{
$GLOBALS['Proxy'] = $GLOBALS['CustomerManagementProxy'];
$request = new SearchCustomersRequest();
$request->Predicates = $predicates;
$request->DateRange = $dateRange;
$request->Ordering = $ordering;
$request->PageInfo = $pageInfo;
return $GLOBALS['CustomerManagementProxy']->GetService()->SearchCustomers($request);
}
response=customermanagement_service.SearchCustomers(
Predicates=Predicates,
DateRange=DateRange,
Ordering=Ordering,
PageInfo=PageInfo)
Configuration requise
Service : CustomerManagementService.svc v13
Noms: https://bingads.microsoft.com/Customer/v13