AdGroup

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}

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.

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.

optimized_targeting_enabled

bool

True if optimized targeting is enabled. Optimized Targeting is the replacement for Audience Expansion.

exclude_demographic_expansion

bool

When this value is true, demographics will be excluded from the types of targeting which are expanded when optimized_targeting_enabled is true. When optimized_targeting_enabled is false, this field is ignored. Default is false.

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.

targeting_setting

TargetingSetting

Setting for targeting related features.

audience_setting

AudienceSetting

Immutable. Setting for audience related features.

effective_target_cpa_source

BiddingSource

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

effective_target_roas_source

BiddingSource

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

labels[]

string

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

excluded_parent_asset_field_types[]

AssetFieldType

The asset field types that should be excluded from this ad group. Asset links with these field types will not be inherited by this ad group from the upper levels.

excluded_parent_asset_set_types[]

AssetSetType

The asset set types that should be excluded from this ad group. Asset set links with these types will not be inherited by this ad group from the upper levels. Location group types (GMB_DYNAMIC_LOCATION_GROUP, CHAIN_DYNAMIC_LOCATION_GROUP, and STATIC_LOCATION_GROUP) are child types of LOCATION_SYNC. Therefore, if LOCATION_SYNC is set for this field, all location group asset sets are not allowed to be linked to this ad group, and all Location Extension (LE) and Affiliate Location Extensions (ALE) will not be served under this ad group. Only LOCATION_SYNC is currently supported.

primary_status

AdGroupPrimaryStatus

Output only. Provides aggregated view into why an ad group is not serving or not serving optimally.

primary_status_reasons[]

AdGroupPrimaryStatusReason

Output only. Provides reasons for why an ad group is not serving or not serving optimally.

id

int64

Output only. The ID of the ad group.

name

string

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.

base_ad_group

string

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

string

The URL template for constructing a tracking URL.

campaign

string

Immutable. The campaign to which the ad group belongs.

cpc_bid_micros

int64

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

effective_cpc_bid_micros

int64

Output only. Value will be same as that of the CPC (cost-per-click) bid value when the bidding strategy is one of manual cpc, enhanced cpc, page one promoted or target outrank share, otherwise the value will be null.

cpm_bid_micros

int64

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

target_cpa_micros

int64

The target CPA (cost-per-acquisition). If the ad group's campaign bidding strategy is TargetCpa or MaximizeConversions (with its target_cpa field set), then this field overrides the target CPA specified in the campaign's bidding strategy. Otherwise, this value is ignored.

cpv_bid_micros

int64

The CPV (cost-per-view) bid.

target_cpm_micros

int64

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

target_roas

double

The target ROAS (return-on-ad-spend) override. If the ad group's campaign bidding strategy is TargetRoas or MaximizeConversionValue (with its target_roas field set), then this field overrides the target ROAS specified in the campaign's bidding strategy. Otherwise, this value is ignored.

percent_cpc_bid_micros

int64

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

fixed_cpm_micros

int64

The fixed amount in micros that the advertiser pays for every thousand impressions of the ad.

target_cpv_micros

int64

Average amount in micros that the advertiser is willing to pay for every ad view.

final_url_suffix

string

URL template for appending params to Final URL.

effective_target_cpa_micros

int64

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

effective_target_roas

double

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