PriceAdExtension Data Object - Campaign Management

Defines an ad extension that includes between 3 and 8 price table rows.

Note

Available in the United States, United Kingdom, Canada, France, Germany, and Australia on PC and mobile devices.

You can associate a price ad extension with the account or with campaigns and ad groups in the account. Each entity (account, campaign, or ad group) can be associated with up to 20 price ad extensions.

Syntax

<xs:complexType name="PriceAdExtension" xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:complexContent mixed="false">
    <xs:extension base="tns:AdExtension">
      <xs:sequence>
        <xs:element name="Language" nillable="true" type="xs:string" />
        <xs:element name="PriceExtensionType" type="tns:PriceExtensionType" />
        <xs:element name="TableRows" nillable="true" type="tns:ArrayOfPriceTableRow" />
        <xs:element minOccurs="0" name="TrackingUrlTemplate" nillable="true" type="xs:string" />
        <xs:element minOccurs="0" name="UrlCustomParameters" nillable="true" type="q59:CustomParameters" xmlns:q59="http://schemas.datacontract.org/2004/07/Microsoft.AdCenter.Advertiser.CampaignManagement.Api.DataContracts.V11" />
      </xs:sequence>
    </xs:extension>
  </xs:complexContent>
</xs:complexType>

Elements

Element Description Data Type
Language The language for the ad copy of your price ad extension.

For possible values, see Ad Languages.

Add: Required
Update: Optional
string
PriceExtensionType The type of the price ad extension.

Possible values include: Brands, Events, Locations, Neighborhoods, ProductCategories, ProductTiers, ServiceCategories, Services, ServiceTiers, and Unknown.

Add: Required
Update: Read-only
PriceExtensionType
TableRows The price table rows.

You must have between 3 and 8 price table rows. The order you create them in is the expected order in the ad but the order is not guaranteed.

Add: Required
Update: Optional
PriceTableRow array
TrackingUrlTemplate The tracking template to use as a default for all landing page URLs.

The following validation rules apply to tracking templates. For more details about supported templates and parameters, see the Bing Ads help article What tracking or URL parameters can I use?
- Tracking templates defined for lower level entities e.g. ads override those set for higher level entities e.g. campaign. For more information, see Entity Hierarchy and Limits.
- The length of the tracking template is limited to 2,048 characters. The HTTP or HTTPS protocol string does count towards the 2,048 character limit.
- The tracking template must be a well-formed URL beginning with one of the following: http://, https://, {lpurl}, or {unescapedlpurl}.
- Bing Ads does not validate whether custom parameters exist. If you use custom parameters in your tracking template and they do not exist, then the landing page URL will include the key and value placeholders of your custom parameters without substitution. For example, if your tracking template is http://tracker.example.com/?season={_season}&promocode={_promocode}&u={lpurl} and neither {_season} or {_promocode} are defined at the campaign, ad group, criterion, keyword, or ad level, then the landing page URL will be the same.

Add: Optional
Update: Optional
string
UrlCustomParameters Your custom collection of key and value parameters for URL tracking.

You may include up to 3 individual CustomParameter objects within the CustomParameters object. Each CustomParameter contains a Key and Value element.

On update, set the UrlCustomParameters element to null or empty to retain any existing custom parameters. To remove all custom parameters, set the Parameters element of the CustomParameters object to null or empty. To remove a subset of custom parameters, specify the custom parameters that you want to keep in the Parameters element of the CustomParameters object.

Add: Optional
Update: Optional
CustomParameters

The PriceAdExtension object has Inherited Elements.

Inherited Elements

Inherited Elements from AdExtension

The PriceAdExtension object derives from the AdExtension object, and inherits the following elements. The descriptions below are specific to PriceAdExtension, and might not apply to other objects that inherit the same elements from the AdExtension object.

Element Description Data Type
DevicePreference Reserved for future use. long
ForwardCompatibilityMap The list of key and value strings for forward compatibility to avoid otherwise breaking changes when new elements are added in the current API version.

There are currently no forward compatibility changes for the AdExtension object.

Add: Read-only
Update: Read-only
KeyValuePairOfstringstring array
Id The unique Bing Ads identifier of the ad extension.

Add: Read-only and Required
Update: Read-only
long
Scheduling Determines the calendar day and time ranges when the ad extension is eligible to be shown in ads.

Add: Optional
Update: Optional. If you set this element null, any existing scheduling set for the ad extension will remain unchanged. If you set this to any non-null Schedule object, you are effectively replacing existing scheduling settings for the ad extension. To remove all scheduling set this element to an empty Schedule object.
Schedule
Status The status of the ad extension. The value will always be Active because the Campaign Management service does not return deleted ad extensions.

Add: Read-only
Update: Read-only
AdExtensionStatus
Type The type of the ad extension. This value is PriceAdExtension when you retrieve a price ad extension.

Add: Read-only
Update: Read-only

For more information about ad extension types, see the Ad Extension Data Object Remarks.
string
Version The number of times the contents of the ad extension has been updated. The version is set to 1 when you add the extension and is incremented each time it's revised.

Add: Read-only
Update: Read-only
int

Requirements

Service: CampaignManagementService.svc v11
Namespace: https://bingads.microsoft.com/CampaignManagement/v11