Edit

Share via

GetCustomerPilotFeatures Service Operation - Customer Management

  • Article

Gets a list of the feature pilot IDs that are enabled for all ad accounts owned by a customer (manager account).

Note

A pilot flag might only be enabled for a subset of ad accounts under a customer. Use the GetAccountPilotFeatures operation to get ad account 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 GetCustomerPilotFeaturesRequest 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 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 GetCustomerPilotFeaturesResponse 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 all accounts owned by a customer (manager account).

For more information about pilot participation please contact your account manager.

For example the following values correspond to customer level feature pilots.

78 - Call Tracking

268 - Dynamic Search Ads

317 - Similar Remarketing Lists

351 - Local Inventory Ads

388 - Microsoft Audience Network

567 - Azure AD Work and School Accounts

574 - Include in Conversions

579 - Customer List Audience

600 - Dynamic Search Ads Text Part 2

616 - View-through conversions

618 - Combined List Audience

626 - Multi-Image Ad Extensions

635 - Custom Parameters Limit Increase Phase 3

636 - Final Url Suffix Phase 3

637 - Cookie-Based Experiments

684 - Shopping Campaigns for Brands

704 - Target ROAS Bid Strategy Type in UK/CA/AU/DE/FR

718 - Smart Shopping Campaigns

720 - Promotion Ad Extensions

721 - Target ROAS Bid Strategy Type in US

734 - Google Import As A Service

762 - Target Impression Share Bid Strategy Type

764 - Site Property Promotion Ad for Hotels

777 - Responsive Ads for Smart Shopping Campaigns

793 - Create Accounts on Behalf of Client

802 - Flyer Ad Extensions

Please note the list of pilot IDs might also include account level pilot IDs for internal use. You should ignore account level pilot IDs returned by this operation and use the GetAccountPilotFeatures operation instead.		 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">GetCustomerPilotFeatures</Action>
    <AuthenticationToken i:nil="false">ValueHere</AuthenticationToken>
    <DeveloperToken i:nil="false">ValueHere</DeveloperToken>
  </s:Header>
  <s:Body>
    <GetCustomerPilotFeaturesRequest xmlns="https://bingads.microsoft.com/Customer/v13">
      <CustomerId>ValueHere</CustomerId>
    </GetCustomerPilotFeaturesRequest>
  </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>
    <GetCustomerPilotFeaturesResponse 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>
    </GetCustomerPilotFeaturesResponse>
  </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<GetCustomerPilotFeaturesResponse> GetCustomerPilotFeaturesAsync(
	long customerId)
{
	var request = new GetCustomerPilotFeaturesRequest
	{
		CustomerId = customerId
	};

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

static GetCustomerPilotFeaturesResponse getCustomerPilotFeatures(
	java.lang.Long customerId) throws RemoteException, Exception
{
	GetCustomerPilotFeaturesRequest request = new GetCustomerPilotFeaturesRequest();

	request.setCustomerId(customerId);

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

static function GetCustomerPilotFeatures(
	$customerId)
{

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

	$request = new GetCustomerPilotFeaturesRequest();

	$request->CustomerId = $customerId;

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

response=customermanagement_service.GetCustomerPilotFeatures(
	CustomerId=CustomerId)

Requirements

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

Request Url

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

Request Elements

The GetCustomerPilotFeaturesRequest 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 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 GetCustomerPilotFeaturesResponse 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 all accounts owned by a customer (manager account).

For more information about pilot participation please contact your account manager.

For example the following values correspond to customer level feature pilots.

78 - Call Tracking

268 - Dynamic Search Ads

317 - Similar Remarketing Lists

351 - Local Inventory Ads

388 - Microsoft Audience Network

567 - Azure AD Work and School Accounts

574 - Include in Conversions

579 - Customer List Audience

600 - Dynamic Search Ads Text Part 2

616 - View-through conversions

618 - Combined List Audience

626 - Multi-Image Ad Extensions

635 - Custom Parameters Limit Increase Phase 3

636 - Final Url Suffix Phase 3

637 - Cookie-Based Experiments

684 - Shopping Campaigns for Brands

704 - Target ROAS Bid Strategy Type in UK/CA/AU/DE/FR

718 - Smart Shopping Campaigns

720 - Promotion Ad Extensions

721 - Target ROAS Bid Strategy Type in US

734 - Google Import As A Service

762 - Target Impression Share Bid Strategy Type

764 - Site Property Promotion Ad for Hotels

777 - Responsive Ads for Smart Shopping Campaigns

793 - Create Accounts on Behalf of Client

802 - Flyer Ad Extensions

Please note the list of pilot IDs might also include account level pilot IDs for internal use. You should ignore account level pilot IDs returned by this operation and use the GetAccountPilotFeatures operation instead.		 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.

{
  "CustomerId": "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<GetCustomerPilotFeaturesResponse> GetCustomerPilotFeaturesAsync(
	long customerId)
{
	var request = new GetCustomerPilotFeaturesRequest
	{
		CustomerId = customerId
	};

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

static GetCustomerPilotFeaturesResponse getCustomerPilotFeatures(
	java.lang.Long customerId) throws RemoteException, Exception
{
	GetCustomerPilotFeaturesRequest request = new GetCustomerPilotFeaturesRequest();

	request.setCustomerId(customerId);

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

static function GetCustomerPilotFeatures(
	$customerId)
{

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

	$request = new GetCustomerPilotFeaturesRequest();

	$request->CustomerId = $customerId;

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

response=customermanagement_service.GetCustomerPilotFeatures(
	CustomerId=CustomerId)