type AdGroup (v201506)

Service

AdGroupService MutateJobService

Dependencies

AdGroupOperation AdGroupPage AdGroupReturnValue

▼

AdGroup

Represents an ad group.

Namespace

https://adwords.google.com/api/adwords/cm/v201506

Fields

id
campaignId
campaignName
name
status
settings
experimentData
labels
forwardCompatibilityMap
biddingStrategyConfiguration
contentBidCriterionTypeGroup
trackingUrlTemplate
urlCustomParameters

Field	Type	Description
id Filterable ReadOnly Required Selectable	`xsd:long`	ID of this ad group. This field can be selected using the value "Id". This field can be filtered on. This field is read only and will be ignored when sent to the API for the following Operators: ADD. This field is required and should not be `null` when it is contained within Operators : SET.
campaignId Filterable Required Selectable	`xsd:long`	ID of the campaign with which this ad group is associated. This field can be selected using the value "CampaignId". This field can be filtered on. This field is required and should not be `null` when it is contained within Operators : ADD.
campaignName Filterable ReadOnly Selectable	`xsd:string`	Name of the campaign with which this ad group is associated. This field can be selected using the value "CampaignName". This field can be filtered on. This field is read only and will be ignored when sent to the API.
name Filterable MatchesRegex Selectable	`xsd:string`	Name of this ad group (at most 255 UTF-8 full-width characters). This field is required and should not be `null` for ADD operations from v201309 version. This field can be selected using the value "Name". This field can be filtered on. AdGroup names must not contain any null (code point 0x0), NL line feed (code point 0xA) or carriage return (code point 0xD) characters. This is checked by the regular expression '[^\x00\x0A\x0D]*'.
status Filterable Selectable	`AdGroup.Status`	Status of this ad group. This field can be selected using the value "Status". This field can be filtered on. Enumerations `UNKNOWN` Used for return value only. An enumeration could not be processed, typically due to incompatibility with your WSDL version. `ENABLED` Active. `PAUSED` Paused. `REMOVED` Removed.
settings Selectable	`Setting[]` `ExplorerAutoOptimizerSetting` `TargetingSetting`	List of settings for the AdGroup. This field can be selected using the value "Settings".
experimentData	`AdGroupExperimentData`	Data from a campaign bidding strategy experiment, returned by get() only if the experimentId is supplied.
labels Filterable ReadOnly Selectable	`Label[]` `TextLabel`	Labels that are attached to the AdGroup. To associate an existing Label to an existing AdGroup, use AdGroupService.mutateLabel with ADD operator. To remove an associated Label from the AdGroup, use AdGroupService.mutateLabel with REMOVE operator. To filter on Labels, use one of Predicate.Operator.CONTAINS_ALL, Predicate.Operator.CONTAINS_ANY, Predicate.Operator.CONTAINS_NONE operators with a list of Label ids. This field can be selected using the value "Labels". This field can be filtered on. This field is read only and will be ignored when sent to the API for the following Operators: REMOVE and SET.
forwardCompatibilityMap	`String_StringMapEntry[]`	This Map provides a place to put new features and settings in older versions of the AdWords API in the rare instance we need to introduce a new feature in an older version. It is presently unused. Do not set a value.
biddingStrategyConfiguration	`BiddingStrategyConfiguration`	Bidding configuration for this ad group. To set the bids on the ad groups use BiddingStrategyConfiguration.bids. Multiple bids can be set on ad group at the same time. Only the bids that apply to the effective bidding strategy will be used. Effective bidding strategy is considered to be the directly attached strategy or inherited campaign level strategy when there’s no directly attached strategy.
contentBidCriterionTypeGroup Filterable Selectable	`CriterionTypeGroup`	Allows advertisers to specify a criteria dimension on which to place absolute bids. This is only applicable for campaigns that target only the content network and not search. This field can be selected using the value "ContentBidCriterionTypeGroup". This field can be filtered on. Enumerations `KEYWORD` Criteria for targeting keywords. e.g. 'mars cruise' KEYWORD may be used as a content bid dimension. Keywords are always a targeting dimension, so may not be set as a target "ALL" dimension with `TargetRestriction`. `USER_INTEREST_AND_LIST` Criteria for targeting lists of users. Lists may represent users with particular interests, or they may represent users who have interacted with an advertiser's site in particular ways. `VERTICAL` Criteria for targeting similar categories of placements, e.g. 'category::Animals>Pets' Used only for content network targeting. `GENDER` Criteria for targeting gender. `AGE_RANGE` Criteria for targeting age ranges. `PLACEMENT` Criteria for targeting placements. aka Website. e.g. 'www.flowers4sale.com' This group also includes mobile applications and mobile app categories. `NONE` Special criteria type group used to reset the existing value. `UNKNOWN` Used for return value only. An enumeration could not be processed, typically due to incompatibility with your WSDL version.
trackingUrlTemplate Filterable Selectable	`xsd:string`	URL template for constructing a tracking URL. On update, empty string ("") indicates to clear the field. This field can be selected using the value "TrackingUrlTemplate". This field can be filtered on.
urlCustomParameters Selectable	`CustomParameters`	A list of mappings to be used for substituting URL custom parameter tags in the trackingUrlTemplate, finalUrls, and/or finalMobileUrls. This field can be selected using the value "UrlCustomParameters".

Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 3.0 License, and code samples are licensed under the Apache 2.0 License. For details, see our Site Policies.

Last updated June 29, 2015.

Send feedback about...

This page

Documentation feedback

AdWords API

Product feedback