AdGroup Data Object

AdGroup Data Object

Switch on low bandwidth view

Collapse All

Language Filter

Microsoft Advertising APIs

AdGroup Data Object

Represents a Microsoft adCenter ad group.

Elements

Business Rules

Element Rules

Syntax

<xs:complexType name="ArrayOfAdGroup">
  <xs:sequence>
    <xs:element minOccurs="0" maxOccurs="unbounded" name="AdGroup" nillable="true" type="tns:AdGroup" />
  </xs:sequence>
</xs:complexType>
<xs:element name="ArrayOfAdGroup" nillable="true" type="tns:ArrayOfAdGroup" />

<xs:complexType name="AdGroup">
  <xs:sequence>
    <xs:element minOccurs="0" name="AdDistribution" nillable="true" type="tns:AdDistribution" />
    <xs:element minOccurs="0" name="BiddingModel" nillable="true" type="tns:BiddingModel" />
    <xs:element minOccurs="0" name="BroadMatchBid" nillable="true" type="tns:Bid" />
    <xs:element minOccurs="0" name="CashBackInfo" nillable="true" type="tns:CashBackInfo" />
    <xs:element minOccurs="0" name="ContentMatchBid" nillable="true" type="tns:Bid" />
    <xs:element minOccurs="0" name="EndDate" nillable="true" type="tns:Date" />
    <xs:element minOccurs="0" name="ExactMatchBid" nillable="true" type="tns:Bid" />
    <xs:element minOccurs="0" name="Id" nillable="true" type="xs:long" />
    <xs:element minOccurs="0" name="LanguageAndRegion" nillable="true" type="xs:string" />
    <xs:element minOccurs="0" name="Name" nillable="true" type="xs:string" />
    <xs:element xmlns:q20="http://schemas.microsoft.com/2003/10/Serialization/Arrays" minOccurs="0" name="NegativeKeywords" nillable="true" type="q20:ArrayOfstring" />
    <xs:element xmlns:q21="http://schemas.microsoft.com/2003/10/Serialization/Arrays" minOccurs="0" name="NegativeSiteUrls" nillable="true" type="q21:ArrayOfstring" />
    <xs:element minOccurs="0" name="PhraseMatchBid" nillable="true" type="tns:Bid" />
    <xs:element minOccurs="0" name="PricingModel" nillable="true" type="tns:PricingModel" />
    <xs:element minOccurs="0" name="StartDate" nillable="true" type="tns:Date" />
    <xs:element minOccurs="0" name="Status" nillable="true" type="tns:AdGroupStatus" />
  </xs:sequence>
</xs:complexType>
<xs:element name="AdGroup" nillable="true" type="tns:AdGroup" />

Elements

Element	Description	Data Type	Add	Update	Business Rules
`AdDistribution`	Specifies the ad distribution medium for the ad group.	AdDistribution	Required	Optional	AdDistribution Element
`BiddingModel`	Specifies the bidding model for the ad group.	BiddingModel	Required	Optional	None
`BroadMatchBid`	Specifies the amount of the broad match bid for the ad group.	Bid	Optional	Optional	Bid Amounts
`CashBackInfo`	Contains information about the Bing cashback rebate program for the ad group.	CashBackInfo	Optional	Optional	CashBackInfo Element
`ContentMatchBid`	Specifies the amount of the content match bid for the ad group.	Bid	Optional	Optional	ContentMatchBid Element Bid Amounts
`EndDate`	Specifies the end date of the ad group.	Date	Optional	Optional	EndDate Element
`ExactMatchBid`	Specifies the amount of the exact match bid for the ad group.	Bid	Optional	Optional	Bid Amounts
`Id`	Identifies the ad group.	`long`	Read-only	Required Specifies the ad group to update.	None
`LanguageAndRegion`	Specifies the language and country/region of the Bing websites where the ad group will be displayed.	`string`	Required	Read-only	For possible values, see Language and Region Values.
`Name`	Specifies the name of the ad group.	`string`	Required	Optional	None
`NegativeKeywords`	Specifies a set of negative keywords for the ad group.	`string` array	Optional	Optional	NegativeKeywords Element
`NegativeSiteUrls`	Specifies a set of negative site URLs for the ad group.	`string` array	Optional	Optional	NegativeSiteUrls
`PhraseMatchBid`	Specifies the amount of the phrase match bid for the ad group.	Bid	Optional	Optional	Bid Amounts
`PricingModel`	Specifies the pricing model for the ad group.	PricingModel	Required	Not used	PricingModel Element
`StartDate`	Specifies the start date of the ad group.	Date	Optional	Optional	StartDate Element
`Status`	Specifies the operational status of the ad group.	AdGroupStatus	Not used	Not used	Status Element

Business Rules

Bid Amounts

When adding a new ad group, you specify a zero bid amount by passing null for the bid object. In this case, passing zero for the Amount element of the Bid object results in an error.

When updating an existing ad group, you specify a zero bid amount by setting the Amount element of the Bid object to zero. Passing null for the bid object in this case causes the existing bid amount to not be changed.

You can specify up to two decimal places for the BroadMatchBid, ExactMatchBid, PhraseMatchBid, and ContentMatchBid elements.

For more information, see Bid Amounts.

Element Rules

AdDistribution Element

If you remove "Content" from the AdDistribution element of an existing ad group, adCenter preserves the ContentMatchBid value for all keywords in the ad group. If you later add the "Content" distribution type back to the same ad group, the keywords have the previous value for the ContentMatchBid element.

CashBackInfo Element

This API element can be used only by members of the cashback rebate program.

If the CashBackInfo element is null, the campaign is not enabled for the cashback rebate program. Otherwise, this element contains a CashBackInfo object that contains the cashback rebate program information.

For more information about the cashback rebate program, see Cashback Rebate Program.

ContentMatchBid Element

If you set a value for the ContentMatchBid element and your ad group doesn't target the United States distribution region, your service operation calls return successfully. However, the ContentMatchBid value is ignored. (To display content ads with the Microsoft adCenter API, your ad group must target the United States distribution region.)

Only search ad values are used by adCenter if your ad group doesn't target the United States distribution region.

EndDate Element

When updating an ad group, to set no end date for the ad group, set the EndDate element to a date equal to or later than January 2, 2050.

When an ad group is added and if no end date is specified, the ad group does not have an end date.

NegativeKeywords Element

The NegativeKeywords element must contain an empty array if no negative keywords are specified. Negative keywords can be specified only for a keyword that has a broad or phrase match type. For more information about negative keywords, see Negative Keywords.

The maximum length of a single string in this array is 100 characters. The maximum combined length for all strings in this array is 1,022 characters.

NegativeSiteUrls Element

The NegativeSiteUrls element contains the set of URLs that your content ads won't get displayed on. For example, if you add "http://www.contoso.com" to the set of negative site URLs, your content ads are never displayed on this site. Negative site URLs only apply to content ads.

PricingModel Element

The PricingModel element is used only when an ad group is created. This value cannot be changed after the ad group is created.

This element is required when an ad group is created.

StartDate Element

When adding an ad group, if the StartDate element is null, the current date on the server is used as the start date.

Status Element

The Status element is read-only. The ad group status can be changed only by using either the PauseAdGroups or the ResumeAdGroups service operation.

Requirements

WSDL: CampaignManagementService.svc in version 6.