Edit

Share via

GetAccountPilotFeatures Service Operation - Customer Management

  • Article

Gets a list of the feature pilot IDs that are enabled for an ad account.

Account level pilot flags remain in effect for the account, even if the account is transferred to a different customer that is not enabled for the pilot. For more information about account ownership transfers, please contact your account manager.

If the pilot ID is not documented in the GetAccountPilotFeatures reference documentation below, the feature is either a customer level pilot feature or the feature is already generally available for all accounts.

Note

Most pilot IDs can only be set at the customer (manager account) level. Customer level pilot IDs are documented under response reference documentation of the GetCustomerPilotFeatures operation. Only call the GetCustomerPilotFeatures operation to get customer level feature pilot IDs.

Please note GetCustomerPilotFeatures might also return account level pilot IDs for internal use; however, for account level pilots you should ignore the results of GetCustomerPilotFeatures.

Request Elements

The GetAccountPilotFeaturesRequest 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
AccountId The identifier of the account used to get a list of feature pilot IDs. long

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 GetAccountPilotFeaturesResponse 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
FeaturePilotFlags A list of integers that identify the feature pilots that are enabled for the ad account.

For more information about pilot participation please contact your account manager.		 int 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">GetAccountPilotFeatures</Action>
    <AuthenticationToken i:nil="false">ValueHere</AuthenticationToken>
    <DeveloperToken i:nil="false">ValueHere</DeveloperToken>
  </s:Header>
  <s:Body>
    <GetAccountPilotFeaturesRequest xmlns="https://bingads.microsoft.com/Customer/v13">
      <AccountId>ValueHere</AccountId>
    </GetAccountPilotFeaturesRequest>
  </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>
    <GetAccountPilotFeaturesResponse xmlns="https://bingads.microsoft.com/Customer/v13">
      <FeaturePilotFlags d4p1:nil="false" xmlns:a1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">
        <a1:int>ValueHere</a1:int>
      </FeaturePilotFlags>
    </GetAccountPilotFeaturesResponse>
  </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<GetAccountPilotFeaturesResponse> GetAccountPilotFeaturesAsync(
	long accountId)
{
	var request = new GetAccountPilotFeaturesRequest
	{
		AccountId = accountId
	};

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

static GetAccountPilotFeaturesResponse getAccountPilotFeatures(
	java.lang.Long accountId) throws RemoteException, Exception
{
	GetAccountPilotFeaturesRequest request = new GetAccountPilotFeaturesRequest();

	request.setAccountId(accountId);

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

static function GetAccountPilotFeatures(
	$accountId)
{

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

	$request = new GetAccountPilotFeaturesRequest();

	$request->AccountId = $accountId;

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

response=customermanagement_service.GetAccountPilotFeatures(
	AccountId=AccountId)

Requirements

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

Request Url

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

Request Elements

The GetAccountPilotFeaturesRequest 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
AccountId The identifier of the account used to get a list of feature pilot IDs. long

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 GetAccountPilotFeaturesResponse 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
FeaturePilotFlags A list of integers that identify the feature pilots that are enabled for the ad account.

For more information about pilot participation please contact your account manager.		 int 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.

{
  "AccountId": "LongValueHere"
}

Response JSON

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

{
  "FeaturePilotFlags": [
    IntValueHere
  ]
}

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<GetAccountPilotFeaturesResponse> GetAccountPilotFeaturesAsync(
	long accountId)
{
	var request = new GetAccountPilotFeaturesRequest
	{
		AccountId = accountId
	};

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

static GetAccountPilotFeaturesResponse getAccountPilotFeatures(
	java.lang.Long accountId) throws RemoteException, Exception
{
	GetAccountPilotFeaturesRequest request = new GetAccountPilotFeaturesRequest();

	request.setAccountId(accountId);

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

static function GetAccountPilotFeatures(
	$accountId)
{

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

	$request = new GetAccountPilotFeaturesRequest();

	$request->AccountId = $accountId;

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

response=customermanagement_service.GetAccountPilotFeatures(
	AccountId=AccountId)