SearchCustomers Service Operation - Customer Management
Searches for customers that match the request criteria.
Request Elements
The SearchCustomersRequest object defines the body and header elements of the service operation request. The elements must be in the same order as shown in the Request SOAP.
Note
Unless otherwise noted below, all request elements are required.
Request Body Elements
| Element | Description | Data Type |
|---|---|---|
| DateRange | Determines the minimum and maximum customer creation date range. This request element is optional. |
DateRange |
| Ordering | Determines the order of results by the specified property of a customer. This request element is optional. You can specify up to one OrderBy element in the array. Additional elements are not supported and will be ignored by the service. For this service operation, the following values are supported in the Field element of a OrderBy object: Id - The order is determined by the Id element of the returned Customer. Name - The order is determined by the Name element of the returned Customer. Number - The order is determined by the Number element of the returned Customer. |
OrderBy array |
| PageInfo | Determines the index and size of results per page. | Paging |
| Predicates | Determines the conditions that all must be met to return customers. You must include between one and 10 predicates. To filter by the created date range, you can include two predicates with the Field value set to CreatedDate, and otherwise may only use each predicate field once. For details about each supported predicate Field value see Predicate Remarks. |
Predicate array |
Request Header Elements
| Element | Description | Data Type |
|---|---|---|
| AuthenticationToken | The OAuth access token that represents the credentials of a user who has permissions to Microsoft Advertising accounts. For more information see Authentication with OAuth. |
string |
| DeveloperToken | The developer token used to access the Bing Ads API. For more information see Get a Developer Token. |
string |
| Password | This element is reserved for internal use and will be removed from a future version of the API. You must use the AuthenticationToken element to set user credentials. | string |
| UserName | This element is reserved for internal use and will be removed from a future version of the API. You must use the AuthenticationToken element to set user credentials. | string |
Response Elements
The SearchCustomersResponse object defines the body and header elements of the service operation response. The elements are returned in the same order as shown in the Response SOAP.
Response Body Elements
| Element | Description | Data Type |
|---|---|---|
| Customers | A list of customers that meet the request criteria. | Customer array |
Response Header Elements
| Element | Description | Data Type |
|---|---|---|
| TrackingId | The identifier of the log entry that contains the details of the API call. | string |
Request SOAP
This template was generated by a tool to show the order of the body and header elements for the SOAP request. For supported types that you can use with this service operation, see the Request Body Elements reference above.
<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:e541="https://bingads.microsoft.com/Customer/v13/Entities" i:nil="false">
<e541:Predicate>
<e541:Field i:nil="false">ValueHere</e541:Field>
<e541:Operator>ValueHere</e541:Operator>
<e541:Value i:nil="false">ValueHere</e541:Value>
</e541:Predicate>
</Predicates>
<DateRange xmlns:e542="https://bingads.microsoft.com/Customer/v13/Entities" i:nil="false">
<e542:MinDate i:nil="false">ValueHere</e542:MinDate>
<e542:MaxDate i:nil="false">ValueHere</e542:MaxDate>
</DateRange>
<Ordering xmlns:e543="https://bingads.microsoft.com/Customer/v13/Entities" i:nil="false">
<e543:OrderBy>
<e543:Field>ValueHere</e543:Field>
<e543:Order>ValueHere</e543:Order>
</e543:OrderBy>
</Ordering>
<PageInfo xmlns:e544="https://bingads.microsoft.com/Customer/v13/Entities" i:nil="false">
<e544:Index>ValueHere</e544:Index>
<e544:Size>ValueHere</e544:Size>
</PageInfo>
</SearchCustomersRequest>
</s:Body>
</s:Envelope>
Response SOAP
This template was generated by a tool to show the order of the body and header elements for the SOAP response.
<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:e545="https://bingads.microsoft.com/Customer/v13/Entities" d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">
<e545:Customer>
<e545:CustomerFinancialStatus d4p1:nil="false">ValueHere</e545:CustomerFinancialStatus>
<e545:Id d4p1:nil="false">ValueHere</e545:Id>
<e545:Industry d4p1:nil="false">ValueHere</e545:Industry>
<e545:LastModifiedByUserId d4p1:nil="false">ValueHere</e545:LastModifiedByUserId>
<e545:LastModifiedTime d4p1:nil="false">ValueHere</e545:LastModifiedTime>
<e545:MarketCountry d4p1:nil="false">ValueHere</e545:MarketCountry>
<e545:ForwardCompatibilityMap xmlns:e546="http://schemas.datacontract.org/2004/07/System.Collections.Generic" d4p1:nil="false">
<e546:KeyValuePairOfstringstring>
<e546:key d4p1:nil="false">ValueHere</e546:key>
<e546:value d4p1:nil="false">ValueHere</e546:value>
</e546:KeyValuePairOfstringstring>
</e545:ForwardCompatibilityMap>
<e545:MarketLanguage d4p1:nil="false">ValueHere</e545:MarketLanguage>
<e545:Name d4p1:nil="false">ValueHere</e545:Name>
<e545:ServiceLevel d4p1:nil="false">ValueHere</e545:ServiceLevel>
<e545:CustomerLifeCycleStatus d4p1:nil="false">ValueHere</e545:CustomerLifeCycleStatus>
<e545:TimeStamp d4p1:nil="false">ValueHere</e545:TimeStamp>
<e545:Number d4p1:nil="false">ValueHere</e545:Number>
<e545:CustomerAddress d4p1:nil="false">
<e545:City d4p1:nil="false">ValueHere</e545:City>
<e545:CountryCode d4p1:nil="false">ValueHere</e545:CountryCode>
<e545:Id d4p1:nil="false">ValueHere</e545:Id>
<e545:Line1 d4p1:nil="false">ValueHere</e545:Line1>
<e545:Line2 d4p1:nil="false">ValueHere</e545:Line2>
<e545:Line3 d4p1:nil="false">ValueHere</e545:Line3>
<e545:Line4 d4p1:nil="false">ValueHere</e545:Line4>
<e545:PostalCode d4p1:nil="false">ValueHere</e545:PostalCode>
<e545:StateOrProvince d4p1:nil="false">ValueHere</e545:StateOrProvince>
<e545:TimeStamp d4p1:nil="false">ValueHere</e545:TimeStamp>
<e545:BusinessName d4p1:nil="false">ValueHere</e545:BusinessName>
</e545:CustomerAddress>
</e545:Customer>
</Customers>
</SearchCustomersResponse>
</s:Body>
</s:Envelope>
Code Syntax
The example syntax can be used with Bing Ads SDKs. See Bing Ads API Code Examples for more examples.
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)
Requirements
Service: CustomerManagementService.svc v13
Namespace: https://bingads.microsoft.com/Customer/v13
Request Url
https://clientcenter.api.bingads.microsoft.com/CustomerManagement/v13/Customers/Search
Request Elements
The SearchCustomersRequest object defines the body and header elements of the service operation request.
Note
Unless otherwise noted below, all request elements are required.
Request Body Elements
| Element | Description | Data Type |
|---|---|---|
| DateRange | Determines the minimum and maximum customer creation date range. This request element is optional. |
DateRange |
| Ordering | Determines the order of results by the specified property of a customer. This request element is optional. You can specify up to one OrderBy element in the array. Additional elements are not supported and will be ignored by the service. For this service operation, the following values are supported in the Field element of a OrderBy object: Id - The order is determined by the Id element of the returned Customer. Name - The order is determined by the Name element of the returned Customer. Number - The order is determined by the Number element of the returned Customer. |
OrderBy array |
| PageInfo | Determines the index and size of results per page. | Paging |
| Predicates | Determines the conditions that all must be met to return customers. You must include between one and 10 predicates. To filter by the created date range, you can include two predicates with the Field value set to CreatedDate, and otherwise may only use each predicate field once. For details about each supported predicate Field value see Predicate Remarks. |
Predicate array |
Request Header Elements
| Element | Description | Data Type |
|---|---|---|
| Authorization | The OAuth access token that represents the credentials of a user who has permissions to Microsoft Advertising accounts. Please ensure that the token is prefixed with "Bearer ", this is necessary for proper authentication. For more information see Authentication with OAuth. |
string |
| DeveloperToken | The developer token used to access the Bing Ads API. For more information see Get a Developer Token. |
string |
| Password | This element is reserved for internal use and will be removed from a future version of the API. You must use the AuthenticationToken element to set user credentials. | string |
| UserName | This element is reserved for internal use and will be removed from a future version of the API. You must use the AuthenticationToken element to set user credentials. | string |
Response Elements
The SearchCustomersResponse object defines the body and header elements of the service operation response. The elements are returned in the same order as shown in the Response JSON.
Response Body Elements
| Element | Description | Data Type |
|---|---|---|
| Customers | A list of customers that meet the request criteria. | Customer array |
Response Header Elements
| Element | Description | Data Type |
|---|---|---|
| TrackingId | The identifier of the log entry that contains the details of the API call. | string |
Request JSON
This template was generated by a tool to show the body and header elements for the JSON request. For supported types that you can use with this service operation, see the Request Body Elements reference above.
{
"Predicates": [
{
"Field": "ValueHere",
"Operator": "ValueHere",
"Value": "ValueHere"
}
],
"DateRange": {
"MaxDate": "ValueHere",
"MinDate": "ValueHere"
},
"Ordering": [
{
"Field": "ValueHere",
"Order": "ValueHere"
}
],
"PageInfo": {
"Index": IntValueHere,
"Size": IntValueHere
}
}
Response JSON
This template was generated by a tool to show the body and header elements for the JSON response.
{
"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"
}
]
}
Code Syntax
To call REST API through SDKs, you need to upgrade SDK to a certain version and configure the system parameters.The example syntax can be used with Bing Ads SDKs. See Bing Ads API Code Examples for more examples.
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)