FindAccountsOrCustomersInfo

FindAccountsOrCustomersInfo Service Operation

 

Gets a list of the accounts and customers that match the specified filter criteria.

Request | Response

Error Codes

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

FindAccountsOrCustomersInfoRequest Message

Request Body

The FindAccountsOrCustomersInfoRequest 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 advertiser accounts or publisher accounts. If you do not specify the scope, the list may include both types of accounts.ApplicationType
FilterThe criteria to use to filter the list of accounts and customers. You can specify either an account name, account number, or customer name.

The filter value can contain a partial or full name or number. The operation includes the account or customer in the result if the name or number begins with the specified filter value.

The operation performs a case-insensitive comparison when it compares your filter value to the name or number. For example, if you specify “t” as the filter value, the list will include accounts and customers whose names begin with “t” or “T”.

The operation filters first for accounts that match the filter criteria. If the number of accounts that match the filter criteria is less than the specified TopN value, the operation searches for customers whose name matches the filter criteria.

Setting this element to an empty string is the same as calling the GetAccountsInfo followed by calling the GetCustomersInfo.
string
TopNA nonzero positive integer that specifies the number of accounts to return in the result. You must specify a value from 1 through 5,000.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 Managing User Authentication with OAuth.

ElementDescriptionData Type
AuthenticationTokenThe OAuth access token used to manage Bing Ads accounts linked to a Microsoft Account.string
DeveloperTokenThe client application's developer access token.string

Password Authentication

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

ElementDescriptionData Type
DeveloperTokenThe client application's developer access token.string
PasswordThe Bing Ads user's sign-in password.string
UserNameThe Bing Ads user's sign-in user name. You may not set this element to a Microsoft account or email address.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/v9">
    <Action mustUnderstand="1">FindAccountsOrCustomersInfo</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>
    <FindAccountsOrCustomersInfoRequest xmlns="https://bingads.microsoft.com/Customer/v9">
      <Filter i:nil="false"></Filter>
      <TopN></TopN>
      <ApplicationScope i:nil="false"></ApplicationScope>
    </FindAccountsOrCustomersInfoRequest>
  </s:Body>
</s:Envelope>

FindAccountsOrCustomersInfoResponse Message

Response Body

ElementDescriptionData Type
AccountInfoWithCustomerDataA list of AccountInfoWithCustomerData objects of the accounts and customers that match the specified filter criteria.

The objects contain information that identifies the account and customer. To get the complete details of an account in the list, access the AccountId element of the AccountInfoWithCustomerData object and use it to call GetAccount operation.

To get the complete details of a customer in the list, access the CustomerId element of the AccountInfoWithCustomerData object and use it to call GetCustomer.
AccountInfoWithCustomerData 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/v9">
    <TrackingId p4:nil="false" xmlns:p4="http://www.w3.org/2001/XMLSchema-instance"></TrackingId>
  </s:Header>
  <s:Body>
    <FindAccountsOrCustomersInfoResponse xmlns="https://bingads.microsoft.com/Customer/v9">
      <AccountInfoWithCustomerData xmlns:e6="https://bingads.microsoft.com/Customer/v9/Entities" p5:nil="false" xmlns:p5="http://www.w3.org/2001/XMLSchema-instance">
        <e6:AccountInfoWithCustomerData>
          <e6:CustomerId p5:nil="false"></e6:CustomerId>
          <e6:CustomerName p5:nil="false"></e6:CustomerName>
          <e6:AccountId></e6:AccountId>
          <e6:AccountName p5:nil="false"></e6:AccountName>
          <e6:AccountNumber p5:nil="false"></e6:AccountNumber>
          <e6:AccountLifeCycleStatus></e6:AccountLifeCycleStatus>
          <e6:PauseReason p5:nil="false"></e6:PauseReason>
        </e6:AccountInfoWithCustomerData>
      </AccountInfoWithCustomerData>
    </FindAccountsOrCustomersInfoResponse>
  </s:Body>
</s:Envelope>

Error Codes

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

Community Additions

ADD
Show:
© 2016 Microsoft