GetAccountsInfo Service Operation - Customer Management

Gets the identifiers, names, and numbers of accounts that are accessible from the specified customer.

Request Elements

The GetAccountsInfoRequest 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
CustomerId	The identifier of the customer used to get the account information. This request element is optional. If not set, the user's credentials are used to determine the customer.	long
OnlyParentAccounts	Determines whether to return only the advertiser accounts that belong to the customer or to also return linked advertiser accounts under other customers. To limit the results to advertiser accounts directly under the specified customer, set this element to true, and otherwise leave it empty or set the property to false. The default value is false.	boolean

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 GetAccountsInfoResponse 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
AccountsInfo	The list of information about advertiser accounts that match the request criteria. Note that there can be a delay of up to five minutes from the time that you create an account until the account information is included in the response.	AccountInfo 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">GetAccountsInfo</Action>
    <AuthenticationToken i:nil="false">ValueHere</AuthenticationToken>
    <DeveloperToken i:nil="false">ValueHere</DeveloperToken>
  </s:Header>
  <s:Body>
    <GetAccountsInfoRequest xmlns="https://bingads.microsoft.com/Customer/v13">
      <CustomerId i:nil="false">ValueHere</CustomerId>
      <OnlyParentAccounts>ValueHere</OnlyParentAccounts>
    </GetAccountsInfoRequest>
  </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>
    <GetAccountsInfoResponse xmlns="https://bingads.microsoft.com/Customer/v13">
      <AccountsInfo xmlns:e495="https://bingads.microsoft.com/Customer/v13/Entities" d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">
        <e495:AccountInfo>
          <e495:Id>ValueHere</e495:Id>
          <e495:Name d4p1:nil="false">ValueHere</e495:Name>
          <e495:Number d4p1:nil="false">ValueHere</e495:Number>
          <e495:AccountLifeCycleStatus>ValueHere</e495:AccountLifeCycleStatus>
          <e495:PauseReason d4p1:nil="false">ValueHere</e495:PauseReason>
        </e495:AccountInfo>
      </AccountsInfo>
    </GetAccountsInfoResponse>
  </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<GetAccountsInfoResponse> GetAccountsInfoAsync(
	long? customerId,
	bool onlyParentAccounts)
{
	var request = new GetAccountsInfoRequest
	{
		CustomerId = customerId,
		OnlyParentAccounts = onlyParentAccounts
	};

	return (await CustomerManagementService.CallAsync((s, r) => s.GetAccountsInfoAsync(r), request));
}

static GetAccountsInfoResponse getAccountsInfo(
	java.lang.Long customerId,
	boolean onlyParentAccounts) throws RemoteException, Exception
{
	GetAccountsInfoRequest request = new GetAccountsInfoRequest();

	request.setCustomerId(customerId);
	request.setOnlyParentAccounts(onlyParentAccounts);

	return CustomerManagementService.getService().getAccountsInfo(request);
}

static function GetAccountsInfo(
	$customerId,
	$onlyParentAccounts)
{

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

	$request = new GetAccountsInfoRequest();

	$request->CustomerId = $customerId;
	$request->OnlyParentAccounts = $onlyParentAccounts;

	return $GLOBALS['CustomerManagementProxy']->GetService()->GetAccountsInfo($request);
}

response=customermanagement_service.GetAccountsInfo(
	CustomerId=CustomerId,
	OnlyParentAccounts=OnlyParentAccounts)

Requirements

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

Request Url

Production URL

https://clientcenter.api.bingads.microsoft.com/CustomerManagement/v13/AccountsInfo/Query

Sandbox URL

https://clientcenter.api.sandbox.bingads.microsoft.com/CustomerManagement/v13/AccountsInfo/Query

Request Elements

The GetAccountsInfoRequest 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
CustomerId	The identifier of the customer used to get the account information. This request element is optional. If not set, the user's credentials are used to determine the customer.	long
OnlyParentAccounts	Determines whether to return only the advertiser accounts that belong to the customer or to also return linked advertiser accounts under other customers. To limit the results to advertiser accounts directly under the specified customer, set this element to true, and otherwise leave it empty or set the property to false. The default value is false.	boolean

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 GetAccountsInfoResponse 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
AccountsInfo	The list of information about advertiser accounts that match the request criteria. Note that there can be a delay of up to five minutes from the time that you create an account until the account information is included in the response.	AccountInfo 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.

{
  "CustomerId": "LongValueHere",
  "OnlyParentAccounts": "ValueHere"
}

Response JSON

This template was generated by a tool to show the body and header elements for the JSON response.

{
  "AccountsInfo": [
    {
      "AccountLifeCycleStatus": "ValueHere",
      "Id": "LongValueHere",
      "Name": "ValueHere",
      "Number": "ValueHere",
      "PauseReason": "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<GetAccountsInfoResponse> GetAccountsInfoAsync(
	long? customerId,
	bool onlyParentAccounts)
{
	var request = new GetAccountsInfoRequest
	{
		CustomerId = customerId,
		OnlyParentAccounts = onlyParentAccounts
	};

	return (await CustomerManagementService.CallAsync((s, r) => s.GetAccountsInfoAsync(r), request));
}

static GetAccountsInfoResponse getAccountsInfo(
	java.lang.Long customerId,
	boolean onlyParentAccounts) throws RemoteException, Exception
{
	GetAccountsInfoRequest request = new GetAccountsInfoRequest();

	request.setCustomerId(customerId);
	request.setOnlyParentAccounts(onlyParentAccounts);

	return CustomerManagementService.getService().getAccountsInfo(request);
}

static function GetAccountsInfo(
	$customerId,
	$onlyParentAccounts)
{

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

	$request = new GetAccountsInfoRequest();

	$request->CustomerId = $customerId;
	$request->OnlyParentAccounts = $onlyParentAccounts;

	return $GLOBALS['CustomerManagementProxy']->GetService()->GetAccountsInfo($request);
}

response=customermanagement_service.GetAccountsInfo(
	CustomerId=CustomerId,
	OnlyParentAccounts=OnlyParentAccounts)