ProductCondition Data Object - Campaign Management
Defines a condition that determines whether a product is selected from a customer's Microsoft Merchant Center catalog file.
You can use campaign level production conditions with Shopping campaigns, feed-based Audience campaigns, and Search campaigns with multimedia ads i.e., those campaigns that leverage a Microsoft Merchant Center store ID. (Note: Not everyone has Search campaigns with multimedia ads yet. If you don't, don't worry - it's coming soon!) Ad group level product conditions can only be used with Shopping campaigns. Asset group level product conditions can only be used with Performance Max campaigns. The product scope allows you to choose which items from your catalog to include in the campaign e.g., filter by brand or condition.
<xs:complexType name="ProductCondition" xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:sequence>
<xs:element minOccurs="0" name="Attribute" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="Operand" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="Operator" nillable="true" type="xs:string">
<xs:annotation>
<xs:appinfo>
<DefaultValue EmitDefaultValue="false" xmlns="http://schemas.microsoft.com/2003/10/Serialization/" />
</xs:appinfo>
</xs:annotation>
</xs:element>
</xs:sequence>
</xs:complexType>
Elements
The ProductCondition object has the following elements: Attribute, Operand, Operator.
| Element | Description | Data Type |
|---|---|---|
| Attribute | The condition's attribute value. An attribute's value must exactly match the value specified in the customer's Microsoft Merchant Center catalog file. The available Attribute and Operand values vary depending on the campaign type. For supported attribute and operand values, see Remarks below. Add or Apply: Required Update: Optional |
string |
| Operand | The condition's operand. The operands implicitly include the equal operator. For example, read Brand as Brand=. Add or Apply: Required Update: Optional |
string |
| Operator | The rule item operator. Add: Required Update: Required |
string |
Remarks
For supported Product Condition (operand) and Product Value (attribute) per campaign type, see the tables below.
Product Conditions for Feed-Based Audience Campaigns
Multiple product conditions can be specified for each feed-based Audience campaign. Each condition is met if the product's attribute value equals the operand's attribute value. For example, if the operand is set to Brand and the attribute is set to Contoso, the condition is met if the value of the product catalog's Brand attribute is equal to Contoso.
| Product Condition (Operand) | Product Value (Attribute) Description | Business Rules |
|---|---|---|
| Brand | The product's manufacturer, brand, or publisher. A maximum of 1,000 characters. |
The Brand operand may only be specified once per campaign product scope filter. |
| Condition | The condition of the product. If operand is set to Condition, the supported attribute values that you can specify are New, Used, and Refurbished. |
The Condition operand may only be specified once per campaign product scope filter. |
| ProductType1-5 Five product type operand values are available i.e. ProductType1, ProductType2, ProductType3, ProductType4, and ProductType5. |
A product type or category defined by the merchant. ProductType1 is the highest level product type, and ProductType5 is the lowest level or most granular product type. A maximum of 100 characters. |
Each of the product type operands may be used once per campaign product scope filter. If you set the operand to a product type from 1 through 5, they must be specified in ascending order. For example, the operand can be set to "ProductType2" with attribute "Pet Supplies", if a higher level product partition has operand "ProductType1" with attribute "Animals & Pet Supplies". |
| CustomLabel0-4 Five custom label operand values are available i.e. CustomLabel0, CustomLabel1, CustomLabel2, CustomLabel3, and CustomLabel4. |
A custom label defined by the merchant. Custom labels e.g. CustomLabel0 and CustomLabel4 are not validated based on any hierarchy. A maximum of 100 characters. |
Each of the CustomLabel operands may be used once per campaign product scope filter. |
Product Conditions for Shopping Campaigns
Multiple product conditions can be specified for each Microsoft Shopping campaign and ad group. Each condition is met if the product's attribute value equals the operand's attribute value. For example, if operand is set to Brand and attribute is set to Contoso, the condition is met if the value of the product catalog's Brand attribute is equal to Contoso.
In Shopping campaigns the product conditions can be set at campaign and ad group level. The following table describes Product Condition (operand) and Product Value (attribute) business rules for campaign ProductScope and ad group ProductPartition objects.
| Product Condition (Operand) | Product Value (Attribute) Description | Campaign Product Scope Rules | Ad Group Product Partition Rules |
|---|---|---|---|
| All | Must be null. | Not applicable. | For an ad group's product partitions, the root node must have operand set to "All" and attribute set to null or empty. |
| Brand | The product's manufacturer, brand, or publisher. A maximum of 1,000 characters. |
The Brand operand may only be specified once per campaign product scope filter. | The Brand operand may be used in multiple branches, but may only be specified once per branch. |
| CategoryL1-5 Five category operand values are available i.e. CategoryL1, CategoryL2, CategoryL3, CategoryL4, and CategoryL5. |
A product category defined by the Microsoft Merchant Center store. CategoryL0 is the highest level category, and CategoryL4 is the lowest level or most granular category. A maximum of 100 characters. |
Each of the CategoryL operands may be used once per campaign product scope filter. If you specify a product condition with operand set to a product category from 1 through 5, they must be specified in ascending order. For example, you can set the operand to "CategoryL2" with attribute "Pet Supplies", if a preceding product condition has the operand "CategoryL1" with attribute "Animals & Pet Supplies". |
Each of the CategoryL operands may be used in multiple branches, but may only be specified once per branch. For example one branch may contain CategoryL1 and CategoryL2, but may not contain another node with the CategoryL2 operand. If you set the operand to a product category from 1 through 5, they must be specified in ascending order. For example, the operand can be set to "CategoryL2" with attribute "Pet Supplies", if a higher level product partition has operand "CategoryL1" with attribute "Animals & Pet Supplies". The prior level product category operand doesn't need to be specified in the immediate parent partition. For example a CategoryL2 condition could be specified for a product partition if the parent of its parent specified a CategoryL1 condition. |
| Channel | The Local Inventory Ads (LIA) channel. Possible values include "Local Stores" and "Online". If the campaign has not opted into Local Inventory Ads, all offers are by default Online only (Channel=Online) and Single-channel (ChannelExclusivity=Single-channel). For more information, see the Local Inventory Ads help page. |
The Channel operand may only be specified once per campaign product scope filter. | The Channel operand may be used in multiple branches, but may only be specified once per branch. |
| ChannelExclusivity | The Local Inventory Ads (LIA) channel exclusivity. Possible values include "Single-channel" and "Multi-channel". If the campaign has not opted into Local Inventory Ads, all offers are by default Online only (Channel=Online) and Single-channel (ChannelExclusivity=Single-channel). For more information, see the Local Inventory Ads help page. |
The ChannelExclusivity operand may only be specified once per campaign product scope filter. | The ChannelExclusivity operand may be used in multiple branches, but may only be specified once per branch. |
| Condition | The condition of the product. If operand is set to Condition, the supported attribute values that you can specify are New, Used, and Refurbished. |
The Condition operand may only be specified once per campaign product scope filter. | The Condition operand may be used in multiple branches, but may only be specified once per branch. |
| CustomLabel0-4 Five custom label operand values are available i.e. CustomLabel0, CustomLabel1, CustomLabel2, CustomLabel3, and CustomLabel4. |
A custom label defined by the merchant. Custom labels e.g. CustomLabel0 and CustomLabel4 are not validated based on any hierarchy. A maximum of 100 characters. This operand is not applicable with Sponsored Products. |
Each of the CustomLabel operands may be used once per campaign product scope filter. | Each of the CustomLabel operands may be used in multiple branches, but may only be specified once per branch. For example one branch may contain CustomLabel0 and CustomLabel1, but may not contain another node with the CustomLabel1 operand. |
| GTIN | The Global Trade Item Number defined by the merchant. The GTIN field has a limit of 50 characters, with each GTIN value having up to 14 digits. This operand is only applicable with Sponsored Products. |
The GTIN operand may only be specified once per campaign product scope filter. | The GTIN operand may be used in multiple branches, but may only be specified once per branch. |
| Id | The product identifier defined by the merchant. A maximum of 1,000 characters. |
The Id operand may only be specified once per campaign product scope filter. | The Id operand may be used in multiple branches, but may only be specified once per branch. |
| MPN | The Global Trade Item Number defined by the merchant. A maximum of 70 characters. This operand is only applicable with Sponsored Products. |
The MPN operand may only be specified once per campaign product scope filter. | The MPN operand may be used in multiple branches, but may only be specified once per branch. |
| ProductType1-5 Five product type operand values are available i.e. ProductType1, ProductType2, ProductType3, ProductType4, and ProductType5. |
A product type or category defined by the merchant. ProductType1 is the highest level product type, and ProductType5 is the lowest level or most granular product type. A maximum of 100 characters. This operand is not applicable with Sponsored Products. |
Each of the product type operands may be used once per campaign product scope filter. If you specify a product condition with operand set to a product type from 1 through 5, they must be specified in ascending order. For example, you can set the operand to "ProductType2" with attribute "Pet Supplies", if a preceding product condition has the operand "ProductType1" with attribute "Animals & Pet Supplies". |
Each of the ProductType operands may be used in multiple branches, but may only be specified once per branch. For example one branch may contain ProductType1 and ProductType2, but may not contain another node with the ProductType2 operand. If you set the operand to a product type from 1 through 5, they must be specified in ascending order. For example, the operand can be set to "ProductType2" with attribute "Pet Supplies", if a higher level product partition has operand "ProductType1" with attribute "Animals & Pet Supplies". The prior level product type operand doesn't need to be specified in the immediate parent partition. For example a ProductType2 condition could be specified for a product partition if the parent of its parent specified a ProductType1 condition. |
Product Conditions for Search Campaigns
Note
Not everyone has this feature yet. If you don't, don't worry - it's coming soon!
Multiple product conditions can be specified for each Microsoft Search campaign with multimedia ads. Each condition is met if the product's attribute value equals the operand's attribute value. For example, if operand is set to Brand and attribute is set to Contoso, the condition is met if the value of the product catalog's Brand attribute is equal to Contoso.
In Search campaigns the product conditions can be set at campaign level. The following table describes Product Condition (operand) and Product Value (attribute) business rules for campaign ProductScope objects.
| Product Condition (Operand) | Product Value (Attribute) Description | Campaign Product Scope Rules |
|---|---|---|
| Brand | The product's manufacturer, brand, or publisher. A maximum of 1,000 characters. |
The Brand operand may only be specified once per campaign product scope filter. |
| CategoryL1 One category operand value is available i.e. CategoryL1. |
A product category defined by the Microsoft Merchant Center store. A maximum of 100 characters. |
Each of the CategoryL operands may be used once per campaign product scope filter. |
| Channel | The Local Inventory Ads (LIA) channel. Possible values include "Local Stores" and "Online". If the campaign has not opted into Local Inventory Ads, all offers are by default Online only (Channel=Online) and Single-channel (ChannelExclusivity=Single-channel). For more information, see the Local Inventory Ads help page. |
The Channel operand may only be specified once per campaign product scope filter. |
| ChannelExclusivity | The Local Inventory Ads (LIA) channel exclusivity. Possible values include "Single-channel" and "Multi-channel". If the campaign has not opted into Local Inventory Ads, all offers are by default Online only (Channel=Online) and Single-channel (ChannelExclusivity=Single-channel). For more information, see the Local Inventory Ads help page. |
The ChannelExclusivity operand may only be specified once per campaign product scope filter. |
| Condition | The condition of the product. If operand is set to Condition, the supported attribute values that you can specify are New, Used, and Refurbished. |
The Condition operand may only be specified once per campaign product scope filter. |
| CustomLabel0-4 Five custom label operand values are available i.e. CustomLabel0, CustomLabel1, CustomLabel2, CustomLabel3, and CustomLabel4. |
A custom label defined by the merchant. Custom labels e.g. CustomLabel0 and CustomLabel4 are not validated based on any hierarchy. A maximum of 100 characters. This operand is not applicable with Sponsored Products. |
Each of the CustomLabel operands may be used once per campaign product scope filter. |
| Id | The product identifier defined by the merchant. A maximum of 1,000 characters. |
The Id operand may only be specified once per campaign product scope filter. |
| ProductType1 One product type operand values is available i.e. ProductType1. |
A product type or category defined by the merchant. ProductType1 is the highest level product type. A maximum of 100 characters. This operand is not applicable with Sponsored Products. |
Each of the product type operands may be used once per campaign product scope filter. |
Product Conditions for Performance Max Campaigns
Multiple product conditions can be specified for each Microsoft Performance Max asset group. Each condition is met if the product's attribute value equals the operand's attribute value. For example, if operand is set to Brand and attribute is set to Contoso, the condition is met if the value of the product catalog's Brand attribute is equal to Contoso.
In Performance Max campaigns the product conditions can be set only at asset group level. The following table describes Product Condition (operand) and Product Value (attribute) business rules for asset group AssetGroupListingGroup objects.
| Product Condition (Operand) | Product Value (Attribute) Description | Asset Group Product Partition Rules |
|---|---|---|
| All | Must be null. | For an asset group's product partitions, the root node must have operand set to All and attribute set to null or empty. |
| Brand | The product's manufacturer, brand, or publisher. A maximum of 1,000 characters. |
For an asset group's product partitions, the root node must have operand set to All and attribute set to null or empty. |
| CategoryL1-5 Five category operand values are available i.e. CategoryL1, CategoryL2, CategoryL3, CategoryL4, and CategoryL5. |
A product category defined by the Microsoft Merchant Center store. CategoryL0 is the highest level category, and CategoryL4 is the lowest level or most granular category. A maximum of 100 characters. |
Each of the CategoryL operands may be used in multiple branches. Each of the CategoryL operands may be used in multiple branches but may only be specified once per branch. For example, one branch may contain CategoryL1 and CategoryL2, but may not contain another node with the CategoryL2 operand. If you set the operand to a product category from 1 through 5, they must be specified in ascending order. For example, the operand can be set to CategoryL2 with the attribute Pet Supplies, if a higher-level product partition has operand CategoryL1 with attribute Animals & Pet Supplies. The prior level product category operand doesn't need to be specified in the immediate parent partition. For example, a CategoryL2 condition could be specified for a product partition if the parent of its parent specified a CategoryL1 condition. |
| Channel | The Local Inventory Ads (LIA) channel. Possible values include "Local Stores" and "Online". If the campaign has not opted into Local Inventory Ads, all offers are by default Online only (Channel=Online) and Single-channel (ChannelExclusivity=Single-channel). For more information, see the Local Inventory Ads help page. |
The Channel operand may be used in multiple branches, but may only be specified once per branch. |
| ChannelExclusivity | The Local Inventory Ads (LIA) channel exclusivity. Possible values include "Single-channel" and "Multi-channel". If the campaign has not opted into Local Inventory Ads, all offers are by default Online only (Channel=Online) and Single-channel (ChannelExclusivity=Single-channel). For more information, see the Local Inventory Ads help page. |
The ChannelExclusivity operand may be used in multiple branches, but may only be specified once per branch. |
| Condition | The condition of the product. If operand is set to Condition, the supported attribute values that you can specify are New, Used, and Refurbished. |
The Condition operand may be used in multiple branches, but may only be specified once per branch. |
| CustomLabel0-4 Five custom label operand values are available i.e. CustomLabel0, CustomLabel1, CustomLabel2, CustomLabel3, and CustomLabel4. |
A custom label defined by the merchant. Custom labels e.g. CustomLabel0 and CustomLabel4 are not validated based on any hierarchy. A maximum of 100 characters. |
Each of the CustomLabel operands may be used in multiple branches, but may only be specified once per branch. For example, one branch may contain CustomLabel0 and CustomLabel1, but may not contain another node with the CustomLabel1 operand. |
| Id | The product identifier defined by the merchant. A maximum of 1,000 characters. |
The Id operand may be used in multiple branches, but may only be specified once per branch. |
| ProductType1-5 Five product type operand values are available i.e. ProductType1, ProductType2, ProductType3, ProductType4, and ProductType5. |
A product type or category defined by the merchant. ProductType1 is the highest level product type, and ProductType5 is the lowest level or most granular product type. A maximum of 100 characters. |
Each of the ProductType operands may be used in multiple branches, but may only be specified once per branch. For example one branch may contain ProductType1 and ProductType2, but may not contain another node with the ProductType2 operand. If you set the operand to a product type from 1 through 5, they must be specified in ascending order. For example, the operand can be set to ProductType2 with attribute Pet Supplies, if a higher-level product partition has operand ProductType1 with attribute Animals & Pet Supplies. The prior level product type operand doesn't need to be specified in the immediate parent partition. For example, a ProductType2 condition could be specified for a product partition if the parent of its parent specified a ProductType1 condition. |
Requirements
Service: CampaignManagementService.svc v13
Namespace: https://bingads.microsoft.com/CampaignManagement/v13