Register for one of our Google Ads API Migration Workshops (October 5, 2021 - October 14, 2021)

AdGroupCriterion

An ad group criterion.

Fields

resource_name

string

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

customers/{customer_id}/adGroupCriteria/{ad_group_id}~{criterion_id}

display_name

string

Output only. The display name of the criterion.

This field is ignored for mutates.

status

AdGroupCriterionStatus

The status of the criterion.

This is the status of the ad group criterion entity, set by the client. Note: UI reports may incorporate additional information that affects whether a criterion is eligible to run. In some cases a criterion that's REMOVED in the API can still show as enabled in the UI. For example, campaigns by default show to users of all age ranges unless excluded. The UI will show each age range as "enabled", since they're eligible to see the ads; but AdGroupCriterion.status will show "removed", since no positive criterion was added.

quality_info

QualityInfo

Output only. Information regarding the quality of the criterion.

type

CriterionType

Output only. The type of the criterion.

system_serving_status

CriterionSystemServingStatus

Output only. Serving status of the criterion.

approval_status

AdGroupCriterionApprovalStatus

Output only. Approval status of the criterion.

disapproval_reasons[]

string

Output only. List of disapproval reasons of the criterion.

The different reasons for disapproving a criterion can be found here: https://support.google.com/adspolicy/answer/6008942

This field is read-only.

labels[]

string

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

effective_cpc_bid_source

BiddingSource

Output only. Source of the effective CPC bid.

effective_cpm_bid_source

BiddingSource

Output only. Source of the effective CPM bid.

effective_cpv_bid_source

BiddingSource

Output only. Source of the effective CPV bid.

effective_percent_cpc_bid_source

BiddingSource

Output only. Source of the effective Percent CPC bid.

position_estimates

PositionEstimates

Output only. Estimates for criterion bids at various positions.

final_urls[]

string

The list of possible final URLs after all cross-domain redirects for the ad.

final_mobile_urls[]

string

The list of possible final mobile URLs after all cross-domain redirects.

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.

criterion_id

int64

Output only. The ID of the criterion.

This field is ignored for mutates.

ad_group

string

Immutable. The ad group to which the criterion belongs.

negative

bool

Immutable. Whether to target (false) or exclude (true) the criterion.

This field is immutable. To switch a criterion from positive to negative, remove then re-add it.

bid_modifier

double

The modifier for the bid when the criterion matches. The modifier must be in the range: 0.1 - 10.0. Most targetable criteria types support modifiers.

cpc_bid_micros

int64

The CPC (cost-per-click) bid.

cpm_bid_micros

int64

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

cpv_bid_micros

int64

The CPV (cost-per-view) bid.

percent_cpc_bid_micros

int64

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

effective_cpc_bid_micros

int64

Output only. The effective CPC (cost-per-click) bid.

effective_cpm_bid_micros

int64

Output only. The effective CPM (cost-per-thousand viewable impressions) bid.

effective_cpv_bid_micros

int64

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

effective_percent_cpc_bid_micros

int64

Output only. The effective Percent CPC bid amount.

final_url_suffix

string

URL template for appending params to final URL.

tracking_url_template

string

The URL template for constructing a tracking URL.

criterion

Union field criterion. The ad group criterion.

criterion. The ad group criterion.

Exactly one must be set. criterion can be only one of the following:

criterion can be only one of the following:

keyword

KeywordInfo

Immutable. Keyword.

placement

PlacementInfo

Immutable. Placement.

mobile_app_category

MobileAppCategoryInfo

Immutable. Mobile app category.

mobile_application

MobileApplicationInfo

Immutable. Mobile application.

listing_group

ListingGroupInfo

Immutable. Listing group.

age_range

AgeRangeInfo

Immutable. Age range.

gender

GenderInfo

Immutable. Gender.

income_range

IncomeRangeInfo

Immutable. Income range.

parental_status

ParentalStatusInfo

Immutable. Parental status.

user_list

UserListInfo

Immutable. User List.

youtube_video

YouTubeVideoInfo

Immutable. YouTube Video.

youtube_channel

YouTubeChannelInfo

Immutable. YouTube Channel.

topic

TopicInfo

Immutable. Topic.

user_interest

UserInterestInfo

Immutable. User Interest.

webpage

WebpageInfo

Immutable. Webpage

app_payment_model

AppPaymentModelInfo

Immutable. App Payment Model.

custom_affinity

CustomAffinityInfo

Immutable. Custom Affinity.

custom_intent

CustomIntentInfo

Immutable. Custom Intent.

custom_audience

CustomAudienceInfo

Immutable. Custom Audience.

combined_audience

CombinedAudienceInfo

Immutable. Combined Audience.