GetCustomersInfo Service Operation - Customer Management

Gets a list of objects that contain customer identification information, for example the name and identifier of the customer.

The list that this operation returns is based on the customers that the user that you specify in the UserName header element of the request, has access to. If the user is a member of the reseller's user group, the list will contain all customers that the reseller has signed up or a subset of customers if the user is limited to a subset of customers by a user role.

Request Elements

The GetCustomersInfoRequest 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.

Request Body Elements

Element Description Data Type
CustomerNameFilter A partial or full name of the customers that you want to get. The operation includes the customer in the result if the customer's name begins with the specified filter name. If you do not want to filter by customer name, set this element to an empty string.

The operation performs a case-insensitive comparison when it compares your name filter value to the customer names. For example, if you specify "t" as the filter value, the list will include customers whose names begin with "t" or "T".
string
TopN A nonzero positive integer that specifies the number of customers to return in the result. int

Request Header Elements

Element Description Data Type
AuthenticationToken The OAuth access token that represents a Microsoft Account user who has permissions to Bing Ads accounts. string
DeveloperToken The developer token used to access the Bing Ads API. string
Password The Bing Ads managed user's sign-in password. string
UserName The Bing Ads managed user's sign-in name. You must not set this element to a Microsoft account or email address. string

Important

The UserName and Password header elements are deprecated. In future versions of the API, Bing Ads will transition exclusively to Microsoft Account (email address) authentication. For more information, see Authentication with OAuth. UserName and Password are still required for Bing Ads managed credentials, but they are not applicable for Microsoft account authentication. To authenticate a Microsoft account, use the AuthenticationToken] header instead of UserName and Password.

Response Elements

The GetCustomersInfoResponse 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
CustomersInfo An array of CustomerInfo objects that identifies the list of customers that meet the filter criteria.

To get the customer data for a customer in the list, access the Id element of the CustomerInfo object and use it to call GetCustomer.
CustomerInfo 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

The following template shows the order of the body and header elements for the SOAP request.

<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/v12">
    <Action mustUnderstand="1">GetCustomersInfo</Action>
    <ApplicationToken i:nil="false">ValueHere</ApplicationToken>
    <AuthenticationToken i:nil="false">ValueHere</AuthenticationToken>
    <DeveloperToken i:nil="false">ValueHere</DeveloperToken>
    <Password i:nil="false">ValueHere</Password>
    <UserName i:nil="false">ValueHere</UserName>
  </s:Header>
  <s:Body>
    <GetCustomersInfoRequest xmlns="https://bingads.microsoft.com/Customer/v12">
      <CustomerNameFilter i:nil="false">ValueHere</CustomerNameFilter>
      <TopN>ValueHere</TopN>
    </GetCustomersInfoRequest>
  </s:Body>
</s:Envelope>

Response SOAP

The following template shows 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/v12">
    <TrackingId d3p1:nil="false" xmlns:d3p1="http://www.w3.org/2001/XMLSchema-instance">ValueHere</TrackingId>
  </s:Header>
  <s:Body>
    <GetCustomersInfoResponse xmlns="https://bingads.microsoft.com/Customer/v12">
      <CustomersInfo xmlns:e875="https://bingads.microsoft.com/Customer/v12/Entities" d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">
        <e875:CustomerInfo>
          <e875:Id d4p1:nil="false">ValueHere</e875:Id>
          <e875:Name d4p1:nil="false">ValueHere</e875:Name>
        </e875:CustomerInfo>
      </CustomersInfo>
    </GetCustomersInfoResponse>
  </s:Body>
</s:Envelope>

Code Syntax

The example syntax can be used with Bing Ads SDKs. See Bing Ads Code Examples for more examples.

public async Task<GetCustomersInfoResponse> GetCustomersInfoAsync(
    string customerNameFilter,
    int topN)
{
    var request = new GetCustomersInfoRequest
    {
        CustomerNameFilter = customerNameFilter,
        TopN = topN
    };

    return (await CustomerManagementService.CallAsync((s, r) => s.GetCustomersInfoAsync(r), request));
}
static GetCustomersInfoResponse getCustomersInfo(
    java.lang.String customerNameFilter,
    int topN) throws RemoteException, Exception
{
    GetCustomersInfoRequest request = new GetCustomersInfoRequest();

    request.setCustomerNameFilter(customerNameFilter);
    request.setTopN(topN);

    return CustomerManagementService.getService().getCustomersInfo(request);
}
static function GetCustomersInfo(
    $customerNameFilter,
    $topN)
{

    $GLOBALS['Proxy'] = $GLOBALS['CustomerManagementProxy'];

    $request = new GetCustomersInfoRequest();

    $request->CustomerNameFilter = $customerNameFilter;
    $request->TopN = $topN;

    return $GLOBALS['CustomerManagementProxy']->GetService()->GetCustomersInfo($request);
}
response=customermanagement_service.GetCustomersInfo(
    CustomerNameFilter=CustomerNameFilter,
    TopN=TopN)

Requirements

Service: CustomerManagementService.svc v12
Namespace: https://bingads.microsoft.com/Customer/v12