Operazione del servizio SearchCustomers - Gestione dei clienti
Cerca i clienti che corrispondono ai criteri di richiesta.
Elementi della richiesta
L'oggetto SearchCustomersRequest definisce gli elementi corpo e intestazione della richiesta di operazione del servizio. Gli elementi devono essere nello stesso ordine indicato nella richiesta SOAP.
Nota
Se non diversamente indicato di seguito, sono necessari tutti gli elementi della richiesta.
Elementi del corpo della richiesta
Elemento | Descrizione | Tipo di dati |
---|---|---|
DateRange | Determina l'intervallo minimo e massimo di date di creazione del cliente. Questo elemento della richiesta è facoltativo. |
DateRange |
Ordinare | Determina l'ordine dei risultati in base alla proprietà specificata di un cliente. Questo elemento della richiesta è facoltativo. È possibile specificare fino a un elemento OrderBy nella matrice. Gli elementi aggiuntivi non sono supportati e verranno ignorati dal servizio. Per questa operazione di servizio, nell'elemento Field di un oggetto OrderBy sono supportati i valori seguenti: Id : l'ordine è determinato dall'elemento Id del cliente restituito. Name : l'ordine è determinato dall'elemento Name dell'oggetto Customer restituito. Number : l'ordine è determinato dall'elemento Number dell'oggetto Customer restituito. |
Matrice OrderBy |
Pageinfo | Determina l'indice e le dimensioni dei risultati per pagina. | Paging |
Predicati | Determina le condizioni che devono essere soddisfatte per restituire i clienti. È necessario includere tra uno e 10 predicati. Per filtrare in base all'intervallo di date creato, è possibile includere due predicati con il valore Field impostato su CreatedDate e in caso contrario è possibile usare ogni campo predicato una sola volta. Per informazioni dettagliate su ogni valore del campo predicato supportato, vedere Osservazioni predicato. |
Matrice predicato |
Elementi dell'intestazione della richiesta
Elemento | Descrizione | Tipo di dati |
---|---|---|
AuthenticationToken | Token di accesso OAuth che rappresenta le credenziali di un utente che dispone delle autorizzazioni per gli account Microsoft Advertising. Per altre informazioni, vedere Autenticazione con OAuth. |
Stringa |
DeveloperToken | Token di sviluppo usato per accedere all'API Bing Ads. Per altre informazioni, vedere Ottenere un token per sviluppatori. |
Stringa |
Password | Questo elemento è riservato per l'uso interno e verrà rimosso da una versione futura dell'API. È necessario usare l'elemento AuthenticationToken per impostare le credenziali utente. | Stringa |
UserName | Questo elemento è riservato per l'uso interno e verrà rimosso da una versione futura dell'API. È necessario usare l'elemento AuthenticationToken per impostare le credenziali utente. | Stringa |
Elementi di risposta
L'oggetto SearchCustomersResponse definisce il corpo e gli elementi dell'intestazione della risposta dell'operazione del servizio. Gli elementi vengono restituiti nello stesso ordine illustrato nella soap di risposta.
Elementi del corpo della risposta
Elemento | Descrizione | Tipo di dati |
---|---|---|
Clienti | Elenco di clienti che soddisfano i criteri di richiesta. | Matrice di clienti |
Elementi dell'intestazione della risposta
Elemento | Descrizione | Tipo di dati |
---|---|---|
TrackingId | Identificatore della voce di log che contiene i dettagli della chiamata API. | Stringa |
Richiedi SOAP
Questo modello è stato generato da uno strumento per visualizzare l'ordine degli elementi corpo e intestazione per la richiesta SOAP. Per i tipi supportati che è possibile usare con questa operazione del servizio, vedere il riferimento Request Body Elements sopra riportato.
<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 della risposta
Questo modello è stato generato da uno strumento per visualizzare l'ordine degli elementi del corpo e dell'intestazione per la risposta 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>
Sintassi del codice
La sintassi di esempio può essere usata con gli SDK di Bing Ads. Per altri esempi, vedere Esempi di codice DELL'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)
Requisiti
Servizio: CustomerManagementService.svc v13
Namespace: https://bingads.microsoft.com/Customer/v13