ShoppingSetting Data Object - Campaign Management

Defines the campaign level settings to leverage your Microsoft Merchant Center store.

You can include a shopping setting with both Shopping campaigns and feed-based Audience campaigns i.e., those campaigns that leverage a Microsoft Merchant Center store ID.

Supported shopping settings vary by campaign type.

  • Audience campaigns only support the StoreId element.
  • Shopping campaigns support all shopping settings.


<xs:complexType name="ShoppingSetting" xmlns:xs="">
  <xs:complexContent mixed="false">
    <xs:extension base="tns:Setting">
        <xs:element minOccurs="0" name="LocalInventoryAdsEnabled" nillable="true" type="xs:boolean" />
        <xs:element minOccurs="0" name="Priority" nillable="true" type="xs:int" />
        <xs:element minOccurs="0" name="SalesCountryCode" nillable="true" type="xs:string" />
        <xs:element minOccurs="0" name="StoreId" nillable="true" type="xs:long" />


The ShoppingSetting object has the following elements: LocalInventoryAdsEnabled, Priority, SalesCountryCode, StoreId.

Element Description Data Type
LocalInventoryAdsEnabled Determines whether local inventory ads are enabled for the Microsoft Merchant Center store.

Not everyone has this feature yet. If you don't, don't worry. It's coming soon.

Set this property to true if you want to enable local inventory ads, and otherwise set it to false.

Add: Optional. If you do not specify this element or leave it empty, the default value of false will be set and local inventory ads will not be enabled.
Update: Optional. If no value is set for the update, this setting is not changed.
Priority Helps determine which Microsoft Shopping campaign serves ads, in the event that two or more campaigns use the product catalog feed from the same Microsoft Merchant Center store.

A higher priority value denotes a higher priority. The supported values for most shopping campaigns are 0, 1, and 2. For smart shopping campaigns (campaign SubType set to ShoppingSmartAds), you must set the priority to 3.

In the Microsoft Advertising web application, the default priority selected is "Low" which is the equivalent of '0'.

Add: Required
Update: Optional
SalesCountryCode The country code for the Microsoft Merchant Center store.

The Microsoft Merchant Center store catalog will be filtered to only include products for the specified country.

To get the list of supported country codes use the GetBSCCountries operation. For example, supported country codes include "AU" (Australia), "AT" (Austria), "BE" (Belgium), "CA" (Canada), "CH" (Switzerland), "DE" (Germany), "ES" (Spain), "FR" (France), "GB" (United Kingdom), "IN" (India), "IT" (Italy), "NL" (Netherlands), "SE" (Sweden), and "US" (United States).

Add: Required
Update: Read-only
StoreId The unique identifier for the Microsoft Merchant Center store that contains a product catalog feed that you want to use for the campaign.

Once you choose a store for a campaign, you can't change it. If at some point you want to use a different store, you would need to create a new shopping campaign with a new shopping setting.

With Shopping Campaigns for Brands a single campaign can target all your retailer partners, and there's no need to create individual campaigns for each retailer. We recommend that you set this to the ID of your manager account's global store (store SubType set to GlobalStore). By initially targeting all linked stores via the campaign shopping setting, you can then add up to 10 campaign negative StoreCriterion to exclude specific retailers as needed.

To get the store ID, call the GetBMCStoresByCustomerId operation. The Id element of each BMCStore represents a store ID.

Add: Required
Update: Read-only

The ShoppingSetting object has Inherited Elements.

Inherited Elements

Inherited Elements from Setting

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

Element Description Data Type
Type The type of the setting. This value is Shopping when you retrieve a shopping setting. For more information about setting types, see the Setting Data Object Remarks.

Add: Read-only
Update: Read-only


Service: CampaignManagementService.svc v13