CoOpSetting Data Object - Campaign Management

Article
03/20/2023

Defines the ad group level settings for feed-based Microsoft Shopping Campaigns.

Note

This object is reserved for internal use, and will be removed in a future API version.

Syntax

<xs:complexType name="CoOpSetting" xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:complexContent mixed="false">
    <xs:extension base="tns:Setting">
      <xs:sequence>
        <xs:element minOccurs="0" name="BidBoostValue" nillable="true" type="xs:double" />
        <xs:element minOccurs="0" name="BidMaxValue" nillable="true" type="xs:double" />
        <xs:element minOccurs="0" name="BidOption" nillable="true" type="tns:BidOption" />
      </xs:sequence>
    </xs:extension>
  </xs:complexContent>
</xs:complexType>

Elements

The CoOpSetting object has the following elements: BidBoostValue, BidMaxValue, BidOption.

Element	Description	Data Type
BidBoostValue	The default bid boost percentage that you'll see in the Microsoft Advertising web application for new product groups. This ad group level target setting is not used directly in the auction. The product group bids are used to boost your partner's bid. Add: Required if the BidOption is set to BidBoost, and otherwise you may not set this element. Update: Required if the BidOption is set to BidBoost, and otherwise you may not set this element.	double
BidMaxValue	The fixed bid maximum. Add: Required if the BidOption is set to BidBoost, and otherwise you may not set this element. Update: Optional if the BidOption is set to BidBoost, and otherwise you may not set this element.	double
BidOption	Determines whether or not to amplify your partner's bid. A bid value ad group allows you to bid on products that your merchandising partner doesn't target. If this element is set to BidValue, the auction will use use a FixedBid for product groups that have a CriterionBid. A bid boost allows you to amplify your partner's bid. If this element is set to BidBoost, the auction will use use a BidMultiplier for product groups that have a CriterionBid. You should only use BidBoost if your partner uses BidValue. Add: If this element is not set, the default bid option is BidValue. Update: Read-only. If you attempt to change the previous bid option an error will be returned.	BidOption

The CoOpSetting object has Inherited Elements.

Inherited Elements

Inherited Elements from Setting

The CoOpSetting object derives from the Setting object, and inherits the following elements: Type. The descriptions below are specific to CoOpSetting, 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 CoOp when you retrieve a CoOp setting. For more information about setting types, see the Setting Data Object Remarks. Add: Read-only Update: Read-only	string

Requirements

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

Share via