AdGroup

An ad group.

Fields

resource_name

string

Immutable. The resource name of the ad group. Ad group resource names have the form:

customers/{customer_id}/adGroups/{ad_group_id}

id

Int64Value

Output only. The ID of the ad group.

name

StringValue

The name of the ad group.

This field is required and should not be empty when creating new ad groups.

It must contain fewer than 255 UTF-8 full-width characters.

It must not contain any null (code point 0x0), NL line feed (code point 0xA) or carriage return (code point 0xD) characters.

status

AdGroupStatus

The status of the ad group.

type

AdGroupType

Immutable. The type of the ad group.

ad_rotation_mode

AdGroupAdRotationMode

The ad rotation mode of the ad group.

base_ad_group

StringValue

Output only. For draft or experiment ad groups, this field is the resource name of the base ad group from which this ad group was created. If a draft or experiment ad group does not have a base ad group, then this field is null.

For base ad groups, this field equals the ad group resource name.

This field is read-only.

tracking_url_template

StringValue

The URL template for constructing a tracking URL.

url_custom_parameters[]

CustomParameter

The list of mappings used to substitute custom parameter tags in a tracking_url_template, final_urls, or mobile_final_urls.

campaign

StringValue

Immutable. The campaign to which the ad group belongs.

cpc_bid_micros

Int64Value

The maximum CPC (cost-per-click) bid.

cpm_bid_micros

Int64Value

The maximum CPM (cost-per-thousand viewable impressions) bid.

target_cpa_micros

Int64Value

The target CPA (cost-per-acquisition).

cpv_bid_micros

Int64Value

Output only. The CPV (cost-per-view) bid.

target_cpm_micros

Int64Value

Average amount in micros that the advertiser is willing to pay for every thousand times the ad is shown.

target_roas

DoubleValue

The target ROAS (return-on-ad-spend) override. If the ad group's campaign bidding strategy is a standard Target ROAS strategy, then this field overrides the target ROAS specified in the campaign's bidding strategy. Otherwise, this value is ignored.

percent_cpc_bid_micros

Int64Value

The percent cpc bid amount, expressed as a fraction of the advertised price for some good or service. The valid range for the fraction is [0,1) and the value stored here is 1,000,000 * [fraction].

explorer_auto_optimizer_setting

ExplorerAutoOptimizerSetting

Settings for the Display Campaign Optimizer, initially termed "Explorer".

display_custom_bid_dimension

TargetingDimension

Allows advertisers to specify a targeting dimension on which to place absolute bids. This is only applicable for campaigns that target only the display network and not search.

final_url_suffix

StringValue

URL template for appending params to Final URL.

targeting_setting

TargetingSetting

Setting for targeting related features.

effective_target_cpa_micros

Int64Value

Output only. The effective target CPA (cost-per-acquisition). This field is read-only.

effective_target_cpa_source

BiddingSource

Output only. Source of the effective target CPA. This field is read-only.

effective_target_roas

DoubleValue

Output only. The effective target ROAS (return-on-ad-spend). This field is read-only.

effective_target_roas_source

BiddingSource

Output only. Source of the effective target ROAS. This field is read-only.

labels[]

StringValue

Output only. The resource names of labels attached to this ad group.