Was this page helpful?
Your feedback about this content is important. Let us know what you think.
Additional feedback?
1500 characters remaining
AdGroup

AdGroup Data Object

System_CLiX_note Note

Version 10 of the Campaign Management service is in preview. The service and documentation are subject to change prior to general availability.

Defines an ad group.

<xs:complexType name="AdGroup">
  <xs:sequence>
    <xs:element name="AdDistribution" type="tns:AdDistribution" nillable="true" minOccurs="0"/>
    <xs:element name="AdRotation" type="tns:AdRotation" nillable="true" minOccurs="0"/>
    <xs:element name="BiddingModel" type="tns:BiddingModel" nillable="true" minOccurs="0"/>
    <xs:element name="ContentMatchBid" type="tns:Bid" nillable="true" minOccurs="0"/>
    <xs:element name="EndDate" type="tns:Date" nillable="true" minOccurs="0"/>
    <xs:element name="ForwardCompatibilityMap" type="q15:ArrayOfKeyValuePairOfstringstring" nillable="true" minOccurs="0" xmlns:q15="http://schemas.datacontract.org/2004/07/System.Collections.Generic"/>
    <xs:element name="Id" type="xs:long" nillable="true" minOccurs="0"/>
    <xs:element name="Language" type="xs:string" nillable="true" minOccurs="0"/>
    <xs:element name="Name" type="xs:string" nillable="true" minOccurs="0"/>
    <xs:element name="NativeBidAdjustment" type="xs:int" nillable="true" minOccurs="0"/>
    <xs:element name="Network" type="tns:Network" nillable="true" minOccurs="0"/>
    <xs:element name="PricingModel" type="tns:PricingModel" nillable="true" minOccurs="0"/>
    <xs:element name="SearchBid" type="tns:Bid" nillable="true" minOccurs="0"/>
    <xs:element name="Settings" type="tns:ArrayOfSetting" nillable="true" minOccurs="0"/>
    <xs:element name="StartDate" type="tns:Date" nillable="true" minOccurs="0"/>
    <xs:element name="Status" type="tns:AdGroupStatus" nillable="true" minOccurs="0"/>
    <xs:element name="TrackingUrlTemplate" type="xs:string" nillable="true" minOccurs="0"/>
    <xs:element name="UrlCustomParameters" type="q16:CustomParameters" nillable="true" minOccurs="0" xmlns:q16="http://schemas.datacontract.org/2004/07/Microsoft.AdCenter.Advertiser.CampaignManagement.Api.DataContracts.V10"/>
  </xs:sequence>
</xs:complexType>

Elements

Element

Description

Data Type

Add

Update

AdDistribution

Determines whether the ads within this ad group will be displayed on the content distribution channel, search distribution channel, or both.

You may include multiple values as flags. How you specify multiple flags depends on the programming language that you use. For example, C# treats these values as flag values and Java treats them as an array of strings. The SOAP should include a string that contains a space-delimited list of values for example, <AdDistribution>Search Content</AdDistribution>.

AdDistribution

Required

Optional

AdRotation

Determines the ad rotation type.

System_CLiX_noteNote

Ad rotation is applicable for text and mobile ads, but not product ads.

AdRotation

Optional

Optional

BiddingModel

Determines whether the ad group bids on keyword matches or site placement matches. The default is Keyword.

If you specify the keyword bidding model, you can set AdDistribution to both Content and Search. If you specify the site placement model, you must set AdDistribution only to Content.

BiddingModel

Optional

Read-only

ContentMatchBid

The bid to use when the keywords that the service extracts from the content page and the ad group’s keywords match by using an exact match comparison. An exact match results when all of the words in the keyword exactly match the user's query.

Specifying a content match bid at the keyword level overrides the ad group’s content match bid value.

You can set a content match bid if the AdDistribution element contains Content.

Bid

Optional

Optional

EndDate

The date that the ads in the ad group will expire. If you do not specify an end date, the ads will not expire.

System_CLiX_noteNote

The end date can be extended to make an ad group's ads eligible for delivery, even after the ad group expires.

The end date is inclusive. For example, if you set EndDate to 3/10/2010, the ads in the ad group will expire at 11:59 PM on 3/10/2010. The time is based on the time zone that you specify at the campaign level.

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

To set no end date when adding an ad group, set the EndDate element to null.

Date

Optional

Optional

ForwardCompatibilityMap

The list of key and value strings for forward compatibility. This element can be used to avoid otherwise breaking changes when new elements are added in future releases.

System_CLiX_noteNote

Forward compatibility changes will be noted here in future releases. There are currently no forward compatibility changes for the AdGroup object.

KeyValuePairOfstringstring array

Read-only

Read-only

Id

The system generated identifier of the ad group.

long

Read-only

Required

Language

The language of the ads and keywords in the ad group. For possible values, see the Language column within Ad Languages.

string

Required

Read-only

Name

The name of the ad group. The name must be unique among all active ad groups within the campaign. The name can contain a maximum of 128 characters.

string

Required

Optional

NativeBidAdjustment

System_CLiX_noteNote

Available for Native Ads pilot participants. The pilot ID is 190 and can be retrieved using the GetCustomerPilotFeatures operation.

The percent amount by which to adjust your bid for native ads above or below the base ad group or keyword bid.

Supported values are negative one hundred (-100) through positive nine hundred (900). Setting the bid adjustment to -100 percent will prevent native ads from showing for this ad group.

Set this element to zero (0) if you want to use the base ad group or keyword bid instead of specifying any bid adjustment for native ads.

If this element is null you will inherit the NativeBidAdjustment setting of the ad group's Campaign.

When you update an ad group object using the UpdateAdGroups operation, this element will only be set by setting the UpdateNativeBidAdjustment element of the request to true, and otherwise this element will be ignored.

int

Optional

Optional

Network

The search networks where you want your ads to display. The default is OwnedAndOperatedAndSyndicatedSearch.

You must set Network to null if AdDistribution is set to Content.

If you select one of the syndicated search options, you can call the SetNegativeSitesToAdGroups operation to prevent the ads from displaying on specific syndicated search websites.

System_CLiX_noteNote

Product ads will only serve in syndicated search networks for pilot participants. If you are not in pilot, then for product ads your effective network is OwnedAndOperatedOnly, regardless of your ad group's network setting. Your network setting is valid for other ads such as text and mobile ads.

Network

Optional

Optional

PricingModel

You can specify a pricing model based on cost per click (CPC) or cost per 1000 impressions (CPM).

For CPC, each time the user clicks your ad, the service charges your account a maximum of your bid value plus the incremental bid value if you specify targeting. The actual charge is based on the auction results and may be less than your bid value.

If you specify CPC and enable conversion tracking for the campaign, you can calculate your costs per conversion. This helps you to determine the return on investment for your campaign.

For CPM, the AdDistribution element must be set to Content distribution only, and your account is charged after the service displays your ad 1,000 times. The charge is based on the sum of your winning bids divided by 1,000.

System_CLiX_noteNote

Available for members of the CPM pilot program.

PricingModel

Required

Read-only

SearchBid

The default bid to use when the user’s query and the ad group’s keywords match by using either a broad, exact, or phrase match comparison.

Specifying a broad, exact, or phrase match bid at the keyword level overrides the ad group’s search bid value for the corresponding match type.

For more information, see Match Type and Bid Values.

You can set a search bid if the AdDistribution element contains Search.

Bid

Optional

Optional

Settings

Reserved for future use.

Setting array

Optional

Optional

StartDate

The date that the ads in the ad group can begin serving; otherwise, the service can begin serving the ads in the ad group the day that the ad group becomes active.

System_CLiX_noteNote

The start date cannot be updated after the ad group is submitted

The start date is inclusive. For example, if you set StartDate to 3/5/2010, the ads in the ad group will start at 12:00 AM on 3/5/2010. The time is based on the time zone that you specify at the campaign level.

Date

Optional

Optional

Status

The status of the ad group.

AdGroupStatus

Optional

Optional

TrackingTemplate

The landing page URL tracking template.

string

Optional

Optional

UrlCustomParameters

The collection of key and value custom parameters for URL tracking.

CustomParameters

Optional

Optional

Requirements

CampaignManagementService.svc v10

Namespace: https://bingads.microsoft.com/CampaignManagement/v10

Community Additions

ADD
Show:
© 2015 Microsoft