Operação de Serviço SearchCustomers - Gestão de Clientes
Procura clientes que correspondam aos critérios do pedido.
Elementos do Pedido
O objeto SearchCustomersRequest define os elementos do corpo e do cabeçalho do pedido de operação do serviço. Os elementos têm de estar na mesma ordem mostrada no Pedido SOAP.
Nota
Salvo indicação em contrário abaixo, todos os elementos do pedido são necessários.
Elementos do Corpo do Pedido
| Elemento | Descrição | Tipo de Dados |
|---|---|---|
| DateRange | Determina o intervalo de datas de criação mínimo e máximo do cliente. Este elemento de pedido é opcional. |
DateRange |
| Encomenda | Determina a ordem dos resultados pela propriedade especificada de um cliente. Este elemento de pedido é opcional. Pode especificar até um elemento OrderBy na matriz. Os elementos adicionais não são suportados e serão ignorados pelo serviço. Para esta operação de serviço, os seguintes valores são suportados no elemento Campo de um objeto OrderBy : ID – a encomenda é determinada pelo elemento ID do Cliente devolvido. Nome – a encomenda é determinada pelo elemento Nome do Cliente devolvido. Número – a encomenda é determinada pelo elemento Número do Cliente devolvido. |
Matriz OrderBy |
| PageInfo | Determina o índice e o tamanho dos resultados por página. | Paginação |
| Predicados | Determina as condições que todos têm de ser cumpridas para devolver clientes. Tem de incluir entre um e 10 predicados. Para filtrar pelo intervalo de datas criado, pode incluir dois predicados com o valor Campo definido como CreatedDate e, caso contrário, só pode utilizar cada campo de predicado uma vez. Para obter detalhes sobre cada valor de Campo predicado suportado, veja Predicado Observações. |
Predicado de matriz |
Elementos do Cabeçalho do Pedido
| Elemento | Descrição | Tipo de Dados |
|---|---|---|
| AuthenticationToken | O token de acesso OAuth que representa as credenciais de um utilizador que tem permissões para contas do Microsoft Advertising. Para obter mais informações, veja Authentication with OAuth (Autenticação com OAuth). |
cadeia |
| DeveloperToken | O token de programador utilizado para aceder à API de Anúncios do Bing. Para obter mais informações, veja Obter um Token de Programador. |
cadeia |
| Palavra-passe | Este elemento está reservado para utilização interna e será removido de uma versão futura da API. Tem de utilizar o elemento AuthenticationToken para definir credenciais de utilizador. | cadeia |
| Nome de Utilizador | Este elemento está reservado para utilização interna e será removido de uma versão futura da API. Tem de utilizar o elemento AuthenticationToken para definir credenciais de utilizador. | cadeia |
Elementos de Resposta
O objeto SearchCustomersResponse define os elementos do corpo e do cabeçalho da resposta da operação do serviço. Os elementos são devolvidos pela mesma ordem mostrada no SOAP de Resposta.
Elementos do Corpo da Resposta
| Elemento | Descrição | Tipo de Dados |
|---|---|---|
| Clientes | Uma lista de clientes que cumprem os critérios do pedido. | Matriz do cliente |
Elementos do Cabeçalho de Resposta
| Elemento | Descrição | Tipo de Dados |
|---|---|---|
| TrackingId | O identificador da entrada de registo que contém os detalhes da chamada à API. | cadeia |
Pedir SOAP
Este modelo foi gerado por uma ferramenta para mostrar a ordem dos elementos do corpo e do cabeçalho do pedido SOAP. Para tipos suportados que pode utilizar com esta operação de serviço, veja a referência Request Body Elements (Elementos do Corpo do Pedido ) acima.
<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:e77="https://bingads.microsoft.com/Customer/v13/Entities" i:nil="false">
<e77:Predicate>
<e77:Field i:nil="false">ValueHere</e77:Field>
<e77:Operator>ValueHere</e77:Operator>
<e77:Value i:nil="false">ValueHere</e77:Value>
</e77:Predicate>
</Predicates>
<DateRange xmlns:e78="https://bingads.microsoft.com/Customer/v13/Entities" i:nil="false">
<e78:MinDate i:nil="false">ValueHere</e78:MinDate>
<e78:MaxDate i:nil="false">ValueHere</e78:MaxDate>
</DateRange>
<Ordering xmlns:e79="https://bingads.microsoft.com/Customer/v13/Entities" i:nil="false">
<e79:OrderBy>
<e79:Field>ValueHere</e79:Field>
<e79:Order>ValueHere</e79:Order>
</e79:OrderBy>
</Ordering>
<PageInfo xmlns:e80="https://bingads.microsoft.com/Customer/v13/Entities" i:nil="false">
<e80:Index>ValueHere</e80:Index>
<e80:Size>ValueHere</e80:Size>
</PageInfo>
</SearchCustomersRequest>
</s:Body>
</s:Envelope>
Soap de Resposta
Este modelo foi gerado por uma ferramenta para mostrar a ordem dos elementos do corpo e do cabeçalho para a resposta 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:e81="https://bingads.microsoft.com/Customer/v13/Entities" d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">
<e81:Customer>
<e81:CustomerFinancialStatus d4p1:nil="false">ValueHere</e81:CustomerFinancialStatus>
<e81:Id d4p1:nil="false">ValueHere</e81:Id>
<e81:Industry d4p1:nil="false">ValueHere</e81:Industry>
<e81:LastModifiedByUserId d4p1:nil="false">ValueHere</e81:LastModifiedByUserId>
<e81:LastModifiedTime d4p1:nil="false">ValueHere</e81:LastModifiedTime>
<e81:MarketCountry d4p1:nil="false">ValueHere</e81:MarketCountry>
<e81:ForwardCompatibilityMap xmlns:e82="http://schemas.datacontract.org/2004/07/System.Collections.Generic" d4p1:nil="false">
<e82:KeyValuePairOfstringstring>
<e82:key d4p1:nil="false">ValueHere</e82:key>
<e82:value d4p1:nil="false">ValueHere</e82:value>
</e82:KeyValuePairOfstringstring>
</e81:ForwardCompatibilityMap>
<e81:MarketLanguage d4p1:nil="false">ValueHere</e81:MarketLanguage>
<e81:Name d4p1:nil="false">ValueHere</e81:Name>
<e81:ServiceLevel d4p1:nil="false">ValueHere</e81:ServiceLevel>
<e81:CustomerLifeCycleStatus d4p1:nil="false">ValueHere</e81:CustomerLifeCycleStatus>
<e81:TimeStamp d4p1:nil="false">ValueHere</e81:TimeStamp>
<e81:Number d4p1:nil="false">ValueHere</e81:Number>
<e81:CustomerAddress d4p1:nil="false">
<e81:City d4p1:nil="false">ValueHere</e81:City>
<e81:CountryCode d4p1:nil="false">ValueHere</e81:CountryCode>
<e81:Id d4p1:nil="false">ValueHere</e81:Id>
<e81:Line1 d4p1:nil="false">ValueHere</e81:Line1>
<e81:Line2 d4p1:nil="false">ValueHere</e81:Line2>
<e81:Line3 d4p1:nil="false">ValueHere</e81:Line3>
<e81:Line4 d4p1:nil="false">ValueHere</e81:Line4>
<e81:PostalCode d4p1:nil="false">ValueHere</e81:PostalCode>
<e81:StateOrProvince d4p1:nil="false">ValueHere</e81:StateOrProvince>
<e81:TimeStamp d4p1:nil="false">ValueHere</e81:TimeStamp>
<e81:BusinessName d4p1:nil="false">ValueHere</e81:BusinessName>
</e81:CustomerAddress>
</e81:Customer>
</Customers>
</SearchCustomersResponse>
</s:Body>
</s:Envelope>
Sintaxe de Código
A sintaxe de exemplo pode ser utilizada com os SDKs de Anúncios do Bing. Veja Exemplos de Código da API de Anúncios do Bing para obter mais exemplos.
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)
Requisitos
Serviço: CustomerManagementService.svc v13
Espaço de nomes: https://bingads.microsoft.com/Customer/v13
URL do Pedido
https://clientcenter.api.bingads.microsoft.com/CustomerManagement/v13/Customers/Search
Elementos do Pedido
O objeto SearchCustomersRequest define os elementos do corpo e do cabeçalho do pedido de operação do serviço.
Nota
Salvo indicação em contrário abaixo, todos os elementos do pedido são necessários.
Elementos do Corpo do Pedido
| Elemento | Descrição | Tipo de Dados |
|---|---|---|
| DateRange | Determina o intervalo de datas de criação mínimo e máximo do cliente. Este elemento de pedido é opcional. |
DateRange |
| Encomenda | Determina a ordem dos resultados pela propriedade especificada de um cliente. Este elemento de pedido é opcional. Pode especificar até um elemento OrderBy na matriz. Os elementos adicionais não são suportados e serão ignorados pelo serviço. Para esta operação de serviço, os seguintes valores são suportados no elemento Campo de um objeto OrderBy : ID – a encomenda é determinada pelo elemento ID do Cliente devolvido. Nome – a encomenda é determinada pelo elemento Nome do Cliente devolvido. Número – a encomenda é determinada pelo elemento Número do Cliente devolvido. |
Matriz OrderBy |
| PageInfo | Determina o índice e o tamanho dos resultados por página. | Paginação |
| Predicados | Determina as condições que todos têm de ser cumpridas para devolver clientes. Tem de incluir entre um e 10 predicados. Para filtrar pelo intervalo de datas criado, pode incluir dois predicados com o valor Campo definido como CreatedDate e, caso contrário, só pode utilizar cada campo de predicado uma vez. Para obter detalhes sobre cada valor de Campo predicado suportado, veja Predicado Observações. |
Predicado de matriz |
Elementos do Cabeçalho do Pedido
| Elemento | Descrição | Tipo de Dados |
|---|---|---|
| Autorização | O token de acesso OAuth que representa as credenciais de um utilizador que tem permissões para contas do Microsoft Advertising. Certifique-se de que o token tem o prefixo "Portador", que é necessário para uma autenticação adequada. Para obter mais informações, veja Authentication with OAuth (Autenticação com OAuth). |
cadeia |
| DeveloperToken | O token de programador utilizado para aceder à API de Anúncios do Bing. Para obter mais informações, veja Obter um Token de Programador. |
cadeia |
| Palavra-passe | Este elemento está reservado para utilização interna e será removido de uma versão futura da API. Tem de utilizar o elemento AuthenticationToken para definir credenciais de utilizador. | cadeia |
| Nome de Utilizador | Este elemento está reservado para utilização interna e será removido de uma versão futura da API. Tem de utilizar o elemento AuthenticationToken para definir credenciais de utilizador. | cadeia |
Elementos de Resposta
O objeto SearchCustomersResponse define os elementos do corpo e do cabeçalho da resposta da operação do serviço. Os elementos são devolvidos pela mesma ordem mostrada no JSON de Resposta.
Elementos do Corpo da Resposta
| Elemento | Descrição | Tipo de Dados |
|---|---|---|
| Clientes | Uma lista de clientes que cumprem os critérios do pedido. | Matriz do cliente |
Elementos do Cabeçalho de Resposta
| Elemento | Descrição | Tipo de Dados |
|---|---|---|
| TrackingId | O identificador da entrada de registo que contém os detalhes da chamada à API. | cadeia |
Pedir JSON
Este modelo foi gerado por uma ferramenta para mostrar os elementos do corpo e do cabeçalho do pedido JSON. Para tipos suportados que pode utilizar com esta operação de serviço, veja a referência Request Body Elements (Elementos do Corpo do Pedido ) acima.
{
"Predicates": [
{
"Field": "ValueHere",
"Operator": "ValueHere",
"Value": "ValueHere"
}
],
"DateRange": {
"MaxDate": "ValueHere",
"MinDate": "ValueHere"
},
"Ordering": [
{
"Field": "ValueHere",
"Order": "ValueHere"
}
],
"PageInfo": {
"Index": IntValueHere,
"Size": IntValueHere
}
}
JSON de Resposta
Este modelo foi gerado por uma ferramenta para mostrar os elementos do corpo e do cabeçalho da resposta JSON.
{
"Customers": [
{
"CustomerAddress": {
"BusinessName": "ValueHere",
"City": "ValueHere",
"CountryCode": "ValueHere",
"Id": "LongValueHere",
"Line1": "ValueHere",
"Line2": "ValueHere",
"Line3": "ValueHere",
"Line4": "ValueHere",
"PostalCode": "ValueHere",
"StateOrProvince": "ValueHere",
"TimeStamp": "ValueHere"
},
"CustomerFinancialStatus": "ValueHere",
"CustomerLifeCycleStatus": "ValueHere",
"ForwardCompatibilityMap": [
{
"key": "ValueHere",
"value": "ValueHere"
}
],
"Id": "LongValueHere",
"Industry": "ValueHere",
"LastModifiedByUserId": "LongValueHere",
"LastModifiedTime": "ValueHere",
"MarketCountry": "ValueHere",
"MarketLanguage": "ValueHere",
"Name": "ValueHere",
"Number": "ValueHere",
"ServiceLevel": "ValueHere",
"TimeStamp": "ValueHere"
}
]
}
Sintaxe de Código
Para chamar a API REST através de SDKs, tem de atualizar o SDK para uma determinada versão e configurar os parâmetros do sistema. A sintaxe de exemplo pode ser utilizada com os SDKs de Anúncios do Bing. Veja Exemplos de Código da API de Anúncios do Bing para obter mais exemplos.
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)