Edit

Share via

BiddableCampaignCriterion Data Object - Campaign Management

  • Article

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

<xs:complexType name="BiddableCampaignCriterion" xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:complexContent mixed="false">
    <xs:extension base="tns:CampaignCriterion">
      <xs:sequence>
        <xs:element minOccurs="0" name="CriterionBid" nillable="true" type="tns:CriterionBid" />
        <xs:element minOccurs="0" name="CriterionCashback" nillable="true" type="tns:CriterionCashback">
          <xs:annotation>
            <xs:appinfo>
              <DefaultValue EmitDefaultValue="false" xmlns="http://schemas.microsoft.com/2003/10/Serialization/" />
            </xs:appinfo>
          </xs:annotation>
        </xs:element>
      </xs:sequence>
    </xs:extension>
  </xs:complexContent>
</xs:complexType>

Elements

The BiddableCampaignCriterion object has the following elements: CriterionBid, CriterionCashback.

Element Description Data Type
CriterionBid The bid to use in the auction.

If the inherited Criterion is a ProductScope criterion, then you can use a FixedBid. For all other biddable campaign criterions use the BidMultiplier. If you do not use the correct object type, then your requested bid will be ignored: If the bid is required, the operation will fail; If the bid is optional, the default bid will be used.

Add: Requirements vary depending on the inherited Criterion type. The bid is optional and will be set to the default of 0 if not included for AgeCriterion, DayTimeCriterion, DeviceCriterion, GenderCriterion, LocationCriterion, ProfileCriterion, and RadiusCriterion. The bid is not applicable for LocationIntentCriterion and ProductScope (The service will not return any error and the bid will be ignored even if you include it).
Update: Requirements vary depending on the inherited Criterion type. The bid is required for AgeCriterion, DayTimeCriterion, DeviceCriterion, GenderCriterion, LocationCriterion, ProfileCriterion, and RadiusCriterion. The bid is not applicable for LocationIntentCriterion and ProductScope (The service will not return any error and the bid will be ignored even if you include it).		 CriterionBid
CriterionCashback Defines the CriterionCashback data object. CriterionCashback

The BiddableCampaignCriterion object has Inherited Elements.

Inherited Elements

Inherited Elements from CampaignCriterion

The BiddableCampaignCriterion object derives from the CampaignCriterion object, and inherits the following elements: CampaignId, Criterion, ForwardCompatibilityMap, Id, Status, Type. The descriptions below are specific to BiddableCampaignCriterion, and might not apply to other objects that inherit the same elements from the CampaignCriterion object.

Element Description Data Type
CampaignId The identifier of the campaign to apply the criterion to.

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

For a list of available criterion types, see CampaignCriterionType.

Add: Required
Update: Optional. If no value is set for the update, this setting is not changed.		 Criterion
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. KeyValuePairOfstringstring array
Id The unique Microsoft Advertising identifier for the campaign criterion.

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

Currently the only supported status for biddable campaign criterions is Active.

Add: Read-only
Update: Read-only		 CampaignCriterionStatus
Type The type of the campaign criterion. This value is BiddableCampaignCriterion when you retrieve a biddable campaign criterion. For more information about campaign criterion types, see the CampaignCriterion Data Object Remarks.

Add: Read-only
Update: Read-only		 string

Requirements

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