AdGroup Data Object (V5.1)

AdGroup Data Object (V5.1)

Collapse All

Language Filter

Windows Live

AdGroup Data Object (V5.1)

Represents a Microsoft adCenter ad group.

Elements

Business Rules

Element Rules

Syntax

<xs:complexType name="AdGroup">
    <xs:sequence>
        <xs:element minOccurs="0" name="AdDistribution" nillable="true" type="tns:AdDistribution"/>
        <xs:element minOccurs="0" name="ContentBid" nillable="true" type="xs:double"/>
        <xs:element minOccurs="0" name="EndDate" nillable="true" type="tns:Date"/>
        <xs:element minOccurs="0" name="Id" nillable="true" type="xs:int"/>
        <xs:element minOccurs="0" name="LanguageAndRegion" nillable="true" type="tns:LanguageAndRegion"/>
        <xs:element minOccurs="0" name="Name" nillable="true" type="xs:string"/>
        <xs:element minOccurs="0" name="NegativeKeywords" nillable="true" type="q7:ArrayOfstring" xmlns:q7="http://schemas.microsoft.com/2003/10/Serialization/Arrays"/>
        <xs:element minOccurs="0" name="PricingModel" nillable="true" type="tns:PricingModel"/>
        <xs:element minOccurs="0" name="SearchBid" nillable="true" type="xs:double"/>
        <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:complexType name="ArrayOfAdGroup">
    <xs:sequence>
        <xs:element minOccurs="0" maxOccurs="unbounded" name="AdGroup" nillable="true" type="tns:AdGroup"/>
    </xs:sequence>
</xs:complexType>

Elements

Element	Description	Data Type	Add	Update	Business Rules
`AdDistribution`	Specifies the ad distribution medium for the ad group.	AdDistribution	Required	Optional	AdDistribution Element
`ContentBid`	Not used. Reserved for future use.	`double`	Not used	Not used	None
`EndDate`	Specifies the end date of the ad group.	Date	Optional	Optional	EndDate Element
`Id`	Identifies the ad group.	`integer`	Read-only	Required; specifies the ad group to update.	None
`LanguageAndRegion`	Specifies the Live Search language and country/region where the ad group will be displayed.	LanguageAndRegion	Required	Read-only	None
`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
`PricingModel`	Not used. Reserved for future use.	PricingModel	Not used	Not used	None
`SearchBid`	Not used. Reserved for future use.	`double`	Not used	Not used	None
`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

Content Ads

To display Microsoft adCenter API Content Ads with the Microsoft adCenter API, your ad group must target the United States distribution region.

If you use the adCenter API Content Ads properties and your ad group doesn't target the United States distribution region, your service operation calls are returned successfully. However, no action is taken for the values of the content ads.

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

Element Rules

AdDistribution Element

If you remove the "Content" ad distribution type from an 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 property.

EndDate Element

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

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

NegativeKeywords Element

Negative keywords are keywords that, if they are included in a search, prevent a match with the ad group's keywords. For more information, see Negative Keywords.

This 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.

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.

StartDate Element

When adding an ad group, if no start date is specified, the current date on the server is used as the start date.

Status Element

The ad group status can be changed only by using either the CampaignManagement.PauseAdGroups or the CampaignManagement.ResumeAdGroups service operation.

Requirements

WSDL: CampaignManagement.svc in version 5.1.

Manage Your Profile | Legal | Contact Us | MSDN Flash Newsletter

Product Families

Resources

About Microsoft

Popular Places