BiddableAdGroupCriterion Data Object - Campaign Management

Defines a biddable criterion that you want applied to the specified ad group.

Syntax

<xs:complexType name="BiddableAdGroupCriterion" xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:complexContent mixed="false">
    <xs:extension base="tns:AdGroupCriterion">
      <xs:sequence>
        <xs:element minOccurs="0" name="CriterionBid" nillable="true" type="tns:CriterionBid" />
        <xs:element minOccurs="0" name="DestinationUrl" nillable="true" type="xs:string" />
        <xs:element minOccurs="0" name="EditorialStatus" nillable="true" type="tns:AdGroupCriterionEditorialStatus" />
        <xs:element minOccurs="0" name="FinalAppUrls" nillable="true" type="q75:ArrayOfAppUrl" xmlns:q75="http://schemas.datacontract.org/2004/07/Microsoft.AdCenter.Advertiser.CampaignManagement.Api.DataContracts.V11" />
        <xs:element minOccurs="0" name="FinalMobileUrls" nillable="true" type="q76:ArrayOfstring" xmlns:q76="http://schemas.microsoft.com/2003/10/Serialization/Arrays" />
        <xs:element minOccurs="0" name="FinalUrls" nillable="true" type="q77:ArrayOfstring" xmlns:q77="http://schemas.microsoft.com/2003/10/Serialization/Arrays" />
        <xs:element minOccurs="0" name="TrackingUrlTemplate" nillable="true" type="xs:string" />
        <xs:element minOccurs="0" name="UrlCustomParameters" nillable="true" type="q78:CustomParameters" xmlns:q78="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
CriterionBid The bid to use in the auction.

Add: Requirements vary depending on the type of Criterion that is inherited from the AdGroupCriterion object. The bid is optional and will be set to the default of 0 if not included for AgeCriterion, DayTimeCriterion, DeviceCriterion, GenderCriterion, LocationCriterion, RadiusCriterion, AudienceCriterion, and Webpage criterions. The bid is not applicable for LocationIntentCriterion (The service will not return any error and the bid will be ignored even if you include it). When you add a ProductPartition with the ApplyProductPartitionActions operation the bid is required unless the product partition type is Subdivision, in which case the bid is not allowed.
Update: Requirements vary depending on the type of Criterion that is inherited from the AdGroupCriterion object. The bid is required for AgeCriterion, DayTimeCriterion, DeviceCriterion, GenderCriterion, LocationCriterion, and RadiusCriterion. The bid is not applicable for LocationIntentCriterion (The service will not return any error and the bid will be ignored even if you include it). For AudienceCriterion and Webpage criterions the bid is optional, and if no value is specified on update, this Bing Ads setting is not changed. When you update a ProductPartition with the ApplyProductPartitionActions operation the bid is optional, and if no value is specified on update, this Bing Ads setting is not changed.
CriterionBid
DestinationUrl The URL of the webpage that the user is taken to when they click the ad.

This element is only used if the Criterion property that is inherited from the AdGroupCriterion object is a ProductPartition criterion. For details see ProductPartition Usage below.
string
EditorialStatus Reserved for future use. AdGroupCriterionEditorialStatus
FinalAppUrls Reserved for future use. AppUrl array
FinalMobileUrls Reserved for future use. string array
FinalUrls Reserved for future use. string array
TrackingUrlTemplate Tracking templates are where you can specify URL tracking parameters that are used in tandem with your final URL or landing page.

We recommend that you add the tracking template at the account level and then it will be applied to all URLs for lower level entities such as campaigns, ad groups, and ads. To learn more, see the Bing Ads help articles URL Tracking with Upgraded URLs.

This element is only used if the Criterion property that is inherited from the AdGroupCriterion object is either a ProductPartition or Webpage criterion. For details see ProductPartition Usage and Webpage Usage below.
string
UrlCustomParameters Your custom collection of key and value parameters for URL tracking.

This element is only used if the Criterion property that is inherited from the AdGroupCriterion object is either a ProductPartition or Webpage criterion. For details see ProductPartition Usage and Webpage Usage below.
CustomParameters

The BiddableAdGroupCriterion object has Inherited Elements.

Inherited Elements

Inherited Elements from AdGroupCriterion

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

Element Description Data Type
AdGroupId The identifier of the ad group to apply the criterion to.

Add: Required
Update: Required
long
Criterion The criterion to apply to the ad group. The criterion helps determine whether ads in the ad group are served.

For a list of available criterion types, see AdGroupCriterionType.

Add: Optional
Update: Optional. If no value is specified on update, this Bing Ads setting is not changed.
Criterion
Id The unique Bing Ads identifier for the ad group criterion.

Add: Read-only
Update: Required
long
Status A status value that determines whether the criterion applies for the ad group.

For most biddable ad group criterions the only supported status value is Active. For exceptions, see Webpage Usage below.

Add: Read-only
Update: Read-only
AdGroupCriterionStatus
Type The type of the ad group criterion. This value is BiddableAdGroupCriterion when you retrieve a biddable ad group criterion. For more information about ad group criterion types, see the AdGroupCriterion Data Object Remarks.

Add: Read-only
Update: Read-only
string

Remarks

ProductPartition Usage

If the Criterion property that is inherited from the AdGroupCriterion object is a ProductPartition criterion, please note the following usage of BiddableAdGroupCriterion properties.

DestinationUrl

If you are currently using Destination URLs, you must eventually replace them with Tracking Templates. For more information, see URL Tracking with Upgraded URLs.

The URL can contain dynamic parameters such as {MatchType}. For a list of supported parameters, see the Bing Ads help article What tracking or URL parameters can I use?.

The URL can contain a maximum of 1,024 characters. If the URL does not specify a protocol, the system uses the HTTP protocol when a user clicks the ad. If the URL specifies the HTTP protocol when you add an ad, the service will remove the http:// protocol string (the HTTP protocol string does not count against the 1,024 character limit); however, the service will not remove an HTTPS protocol string (https://) from the URL.

On update, to remove the destination URL, set it to an empty string (""). If you leave the element null it will not be updated.

The destination URL is used if specified; otherwise, the destination URL is determined by the corresponding value of the 'Link' that you specified for the product offer in your Bing Merchant Center catalog.

Add: Optional
Update: Optional. If no value is specified on update, this Bing Ads setting is not changed.

TrackingUrlTemplate

The tracking templates can be used in tandem with the URL specified in the 'Link' field for the product offer that you submitted via the Content API. By combining the feed URL with the tracking template, the landing page URL is assembled where a user is directed after clicking the ad. When you use the TrackingUrlTemplate element to update the URL parameters instead of updating them in the feed URL, the feed URL doesn't need to go through editorial review and your ads will continue to serve uninterrupted. For example if your product offer URL in the catalog feed is http://contoso.com/, you could specify the following tracking template: {lpurl}?matchtype={matchtype}&device={device}.

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 for example 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. If no value is specified on update, this Bing Ads setting is not changed.

UrlCustomParameters

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

Webpage Usage

If the Criterion property that is inherited from the AdGroupCriterion object is a Webpage criterion, please note the following usage of BiddableAdGroupCriterion properties.

Status

Add: Optional. You can set the status to Active or Paused. You cannot set the status to Deleted.
Update: Optional. If no value is specified on update, this Bing Ads setting is not changed.

TrackingUrlTemplate

For Webpage criterion the tracking templates can be used in tandem with the landing page URL that is generated dynamically from the domain that you specified for your Dynamic Search Ads campaign. By combining the domain with the tracking template, the landing page URL is assembled where a user is directed after clicking the ad. Here is an example tracking template: {lpurl}?matchtype={matchtype}&device={device}.

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 for example 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. If no value is specified on update, this Bing Ads setting is not changed.

UrlCustomParameters

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. If no value is specified on update, this Bing Ads setting is not changed. .

Requirements

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