GetCustomersInfo Service Operation

 

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 | Response

Error Codes

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

Request Body

The GetCustomersInfoRequest object defines the elements of the request’s body. The elements must be in the same order as shown in the SOAP Request SOAP.

ElementDescriptionData Type
ApplicationScopeA value that determines whether to return results for advertising customers or publishing customers. If you do not specify the scope, the list may include both types of customers.ApplicationType
CustomerNameFilterA 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 name filter, the list will include customers whose names begin with “t” or “T”.
string
TopNA nonzero positive integer that specifies the number of customers to return in the result.int

Request Headers

Set the required header elements for each service request. New customers are required to sign up for Bing Ads with a Microsoft Account, and to manage those accounts you must use OAuth. Existing users with legacy Bing Ads credentials may continue to specify the UserName and Password header elements. In future versions of the API, Bing Ads will transition exclusively to Microsoft Account authentication. For more information, see Getting Started With the Bing Ads API.

OAuth Authentication

These request headers are required for Authentication with OAuth.

ElementDescriptionData Type
AuthenticationTokenThe OAuth access token that represents a Microsoft Account user who has permissions to Bing Ads accounts.string
DeveloperTokenThe developer token used to access the Bing Ads API.string

Password Authentication

These request headers are required for legacy username and password authentication.

ElementDescriptionData Type
DeveloperTokenThe developer token used to access the Bing Ads API.string
PasswordThe Bing Ads user's sign-in password.string
UserNameThe Bing Ads user's sign-in user name. You must not set this element to a Microsoft account or email address. To authenticate a Microsoft account, use the AuthenticationToken header instead of UserName and Password.string

Request SOAP

The following example shows the complete request envelope.

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

Response Body

ElementDescriptionData Type
CustomersInfoAn 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

ElementDescriptionData Type
TrackingIdThe identifier of the log entry that contains the details of the API call.string

Response SOAP

The following example shows the complete response envelope.

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
  <s:Header xmlns="https://bingads.microsoft.com/Customer/v11">
    <TrackingId p4:nil="false" xmlns:p4="http://www.w3.org/2001/XMLSchema-instance"></TrackingId>
  </s:Header>
  <s:Body>
    <GetCustomersInfoResponse xmlns="https://bingads.microsoft.com/Customer/v11">
      <CustomersInfo xmlns:e15="https://bingads.microsoft.com/Customer/v11/Entities" p5:nil="false" xmlns:p5="http://www.w3.org/2001/XMLSchema-instance">
        <e15:CustomerInfo>
          <e15:Id p5:nil="false"></e15:Id>
          <e15:Name p5:nil="false"></e15:Name>
        </e15:CustomerInfo>
      </CustomersInfo>
    </GetCustomersInfoResponse>
  </s:Body>
</s:Envelope>

If the service operation fails, it throws a FaultException, which contains one or more of the Bing Ads API error data objects. For information about the fault detail objects, see Customer Management Error Data Objects and Handling Service Errors and Exceptions.The following are example error codes that the error objects can include when using this service operation. For all documented error codes, please see Bing Ads Operation Error Codes.

Error Code
InvalidCredentials
Show: