Yahoo! Search Marketing

AdGroup

The AdGroup object represents an ad group. An ad group is a collection of related ads and keywords and is associated with a campaign. Values set at the ad group level override corresponding values set at the campaign level and apply to all ads and keywords in the ad group.

Before you attempt to set the sponsoredSearchON, advancedMatchON, and contentMatchON elements or provide values for the sponsoredSearchMaxBid and contentMatchMaxBid elements, read Setting Tactics and Setting Bids.

Elements

Restrictions *
Element Data Type Description Add Full-Up Part-Up
accountID string The account ID the ad group is associated with. RO RO RO
adAutoOptimization
  ON
boolean If true, auto optimization is enabled. Auto optimization (also called A/B testing) compares two or more ads to determine which ad performs the best based on the content of the ad. Ads are compared using a metric, for example, the number of clicks. The ad with the highest number of clicks (and hence, the best ad content) is served. Req Req Opt
advancedMatch
  ON
boolean If true, Sponsored Search (advanced match type) is enabled. If you enable advancedMatchON you must also enable sponsoredSearchON. Opt Req Opt
campaignID long The campaign ID the ad group is associated with. Req Req Opt
contentMatch
  BidStatus
BidStatus The status of the maximum bid for Content Match® (contentMatchMaxBid). RO RO RO
contentMatch
  MaxBid
double The maximum bid for Content Match®. Opt Opt Opt
contentMatch
  MaxBidTimestamp
dateTime The date the maximum bid for Content Match® is set. RO RO RO
contentMatch
  MinBid
double The minimum bid for Content Match®. RO RO RO
contentMatch
  ON
boolean If true, Content Match® is enabled and you must provide a value for contentMatchMaxBid. Req Req Opt
createTimestamp dateTime The date the ad group was created. RO RO RO
deleteTimestamp dateTime The date the ad group was deleted. RO RO RO
ID long The ad group ID. RO Req Req
lastUpdateTimestamp dateTime The date the ad group was last updated. RO RO RO
name string The name of the ad group. The ad group name must be unique within a campaign. Req Req Opt
sponsoredSearch
  MaxBid
double The maximum bid for Sponsored Search. Opt Opt Opt
sponsoredSearch
  MaxBidTimestamp
dateTime The date the maximum bid for Sponsored Search was set. RO RO RO
sponsoredSearch
  ON
boolean If true, Sponsored Search (standard match type) is enabled and you must provide a value for sponsoredSearchMaxBid. Opt Req Opt
status AdGroupStatus The ad group status. You can set the status to On or Off, but not Deleted. Req Req Opt
watchON boolean If true, the ad group can be monitored through the web application. Opt Req Opt
     * See Restrictions for more information.