GetAccountsInfo Service Operation

 

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

Request | Response

Error Codes

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

Request Body

The GetAccountsInfoRequest 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 TypeRequired
CustomerIdThe identifier of the customer who owns the accounts to get. If not set, the user’s credentials are used to determine the customer.longNo
OnlyParentAccountsDetermines whether to return only the accounts that belong to the customer or to also return the accounts that the customer manages for other customers. To return all accounts (those that belong to the customer and those that the customer manages), set this element to false; otherwise, set to true to return account information for only the specified customer. The default is false.booleanNo

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">GetAccountsInfo</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>
    <GetAccountsInfoRequest xmlns="https://bingads.microsoft.com/Customer/v11">
      <CustomerId i:nil="false"></CustomerId>
      <OnlyParentAccounts></OnlyParentAccounts>
    </GetAccountsInfoRequest>
  </s:Body>
</s:Envelope>

Response Body

ElementDescriptionData Type
AccountsInfoAn array of AccountInfo objects that identifies the list of accounts that the customer owns.

To get the account data for an account in the list, access the Id element of the AccountInfo object and use it to call GetAccount.

Note that there can be a delay of up to five minutes from the time that you add an account until the GetAccountsInfo returns the account in the response.
AccountInfo 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>
    <GetAccountsInfoResponse xmlns="https://bingads.microsoft.com/Customer/v11">
      <AccountsInfo xmlns:e11="https://bingads.microsoft.com/Customer/v11/Entities" p5:nil="false" xmlns:p5="http://www.w3.org/2001/XMLSchema-instance">
        <e11:AccountInfo>
          <e11:Id></e11:Id>
          <e11:Name p5:nil="false"></e11:Name>
          <e11:Number p5:nil="false"></e11:Number>
          <e11:AccountLifeCycleStatus></e11:AccountLifeCycleStatus>
          <e11:PauseReason p5:nil="false"></e11:PauseReason>
        </e11:AccountInfo>
      </AccountsInfo>
    </GetAccountsInfoResponse>
  </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: