AdGroupCriterion
An ad group criterion.
Table Specific Information
Select
Google Ads does not allow every column to be selected in a single query as some data will conflict if selected together. Therefore, when issuing a query that selects all columns, only the default metrics, segments, and attributes will be returned. In general, these defaults are the same fields that are exposed through the Ads console.
To use the nondefault fields, explicitly select them in your query.
Filters can also be used in the WHERE clause. The supported operators are the =, !=, >, >=, <, <=, LIKE, NOT LIKE, IN, and NOT IN operators. All filters must be joined by the AND keyword as OR is not supported by the Ads API.
Columns
| Name | Type | Behavior | Description |
| AdGroupCriterionAdGroup | String | ATTRIBUTE | Immutable. The ad group to which the criterion belongs. |
| AdGroupCriterionAgeRangeType | String | ATTRIBUTE | Type of the age range.
The allowed values are AGE_RANGE_18_24, AGE_RANGE_25_34, AGE_RANGE_35_44, AGE_RANGE_45_54, AGE_RANGE_55_64, AGE_RANGE_65_UP, AGE_RANGE_UNDETERMINED, UNKNOWN, UNSPECIFIED. |
| AdGroupCriterionAppPaymentModelType | String | ATTRIBUTE | Type of the app payment model.
The allowed values are PAID, UNKNOWN, UNSPECIFIED. |
| AdGroupCriterionApprovalStatus | String | ATTRIBUTE | Output only. Approval status of the criterion.
The allowed values are APPROVED, DISAPPROVED, PENDING_REVIEW, UNDER_REVIEW, UNKNOWN, UNSPECIFIED. |
| AdGroupCriterionAudienceAudience | String | ATTRIBUTE | The Audience resource name. |
| AdGroupCriterionBidModifier | Double | ATTRIBUTE | 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. |
| AdGroupCriterionCombinedAudienceCombinedAudience | String | ATTRIBUTE | The CombinedAudience resource name. |
| AdGroupCriterionCpcBidMicros | Long | ATTRIBUTE | The CPC (cost-per-click) bid. |
| AdGroupCriterionCpmBidMicros | Long | ATTRIBUTE | The CPM (cost-per-thousand viewable impressions) bid. |
| AdGroupCriterionCpvBidMicros | Long | ATTRIBUTE | The CPV (cost-per-view) bid. |
| AdGroupCriterionCriterionId | Long | ATTRIBUTE | Output only. The ID of the criterion. This field is ignored for mutates. |
| AdGroupCriterionCustomAffinityCustomAffinity | String | ATTRIBUTE | The CustomInterest resource name. |
| AdGroupCriterionCustomAudienceCustomAudience | String | ATTRIBUTE | The CustomAudience resource name. |
| AdGroupCriterionCustomIntentCustomIntent | String | ATTRIBUTE | The CustomInterest resource name. |
| AdGroupCriterionDisapprovalReasons | String | ATTRIBUTE | 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. |
| AdGroupCriterionDisplayName | String | ATTRIBUTE | Output only. The display name of the criterion. This field is ignored for mutates. |
| AdGroupCriterionEffectiveCpcBidMicros | Long | ATTRIBUTE | Output only. The effective CPC (cost-per-click) bid. |
| AdGroupCriterionEffectiveCpcBidSource | String | ATTRIBUTE | Output only. Source of the effective CPC bid.
The allowed values are AD_GROUP, AD_GROUP_CRITERION, CAMPAIGN_BIDDING_STRATEGY, UNKNOWN, UNSPECIFIED. |
| AdGroupCriterionEffectiveCpmBidMicros | Long | ATTRIBUTE | Output only. The effective CPM (cost-per-thousand viewable impressions) bid. |
| AdGroupCriterionEffectiveCpmBidSource | String | ATTRIBUTE | Output only. Source of the effective CPM bid.
The allowed values are AD_GROUP, AD_GROUP_CRITERION, CAMPAIGN_BIDDING_STRATEGY, UNKNOWN, UNSPECIFIED. |
| AdGroupCriterionEffectiveCpvBidMicros | Long | ATTRIBUTE | Output only. The effective CPV (cost-per-view) bid. |
| AdGroupCriterionEffectiveCpvBidSource | String | ATTRIBUTE | Output only. Source of the effective CPV bid.
The allowed values are AD_GROUP, AD_GROUP_CRITERION, CAMPAIGN_BIDDING_STRATEGY, UNKNOWN, UNSPECIFIED. |
| AdGroupCriterionEffectivePercentCpcBidMicros | Long | ATTRIBUTE | Output only. The effective Percent CPC bid amount. |
| AdGroupCriterionEffectivePercentCpcBidSource | String | ATTRIBUTE | Output only. Source of the effective Percent CPC bid.
The allowed values are AD_GROUP, AD_GROUP_CRITERION, CAMPAIGN_BIDDING_STRATEGY, UNKNOWN, UNSPECIFIED. |
| AdGroupCriterionFinalMobileUrls | String | ATTRIBUTE | The list of possible final mobile URLs after all cross-domain redirects. |
| AdGroupCriterionFinalUrlSuffix | String | ATTRIBUTE | URL template for appending params to final URL. |
| AdGroupCriterionFinalUrls | String | ATTRIBUTE | The list of possible final URLs after all cross-domain redirects for the ad. |
| AdGroupCriterionGenderType | String | ATTRIBUTE | Type of the gender.
The allowed values are FEMALE, MALE, UNDETERMINED, UNKNOWN, UNSPECIFIED. |
| AdGroupCriterionIncomeRangeType | String | ATTRIBUTE | Type of the income range.
The allowed values are INCOME_RANGE_0_50, INCOME_RANGE_50_60, INCOME_RANGE_60_70, INCOME_RANGE_70_80, INCOME_RANGE_80_90, INCOME_RANGE_90_UP, INCOME_RANGE_UNDETERMINED, UNKNOWN, UNSPECIFIED. |
| AdGroupCriterionKeywordMatchType | String | ATTRIBUTE | The match type of the keyword.
The allowed values are BROAD, EXACT, PHRASE, UNKNOWN, UNSPECIFIED. |
| AdGroupCriterionKeywordText | String | ATTRIBUTE | The text of the keyword (at most 80 characters and 10 words). |
| AdGroupCriterionLabels | String | ATTRIBUTE | Output only. The resource names of labels attached to this ad group criterion. |
| AdGroupCriterionLanguageLanguageConstant | String | ATTRIBUTE | The language constant resource name. |
| AdGroupCriterionListingGroupCaseValueActivityCountryValue | String | ATTRIBUTE | String value of the activity country. The Geo Target Constant resource name. |
| AdGroupCriterionListingGroupCaseValueActivityIdValue | String | ATTRIBUTE | String value of the activity ID. |
| AdGroupCriterionListingGroupCaseValueActivityRatingValue | Long | ATTRIBUTE | Long value of the activity rating. |
| AdGroupCriterionListingGroupCaseValueHotelCityCityCriterion | String | ATTRIBUTE | The Geo Target Constant resource name. |
| AdGroupCriterionListingGroupCaseValueHotelClassValue | Long | ATTRIBUTE | Long value of the hotel class. |
| AdGroupCriterionListingGroupCaseValueHotelCountryRegionCountryRegionCriterion | String | ATTRIBUTE | The Geo Target Constant resource name. |
| AdGroupCriterionListingGroupCaseValueHotelIdValue | String | ATTRIBUTE | String value of the hotel ID. |
| AdGroupCriterionListingGroupCaseValueHotelStateStateCriterion | String | ATTRIBUTE | The Geo Target Constant resource name. |
| AdGroupCriterionListingGroupCaseValueProductBrandValue | String | ATTRIBUTE | String value of the product brand. |
| AdGroupCriterionListingGroupCaseValueProductCategoryCategoryId | Long | ATTRIBUTE | ID of the product category. This ID is equivalent to the google_product_category ID as described in this article: https://support.google.com/merchants/answer/6324436 |
| AdGroupCriterionListingGroupCaseValueProductCategoryLevel | String | ATTRIBUTE | Level of the product category.
The allowed values are LEVEL1, LEVEL2, LEVEL3, LEVEL4, LEVEL5, UNKNOWN, UNSPECIFIED. |
| AdGroupCriterionListingGroupCaseValueProductChannelChannel | String | ATTRIBUTE | Value of the locality.
The allowed values are LOCAL, ONLINE, UNKNOWN, UNSPECIFIED. |
| AdGroupCriterionListingGroupCaseValueProductChannelExclusivityChannelExclusivity | String | ATTRIBUTE | Value of the availability.
The allowed values are MULTI_CHANNEL, SINGLE_CHANNEL, UNKNOWN, UNSPECIFIED. |
| AdGroupCriterionListingGroupCaseValueProductConditionCondition | String | ATTRIBUTE | Value of the condition.
The allowed values are NEW, REFURBISHED, UNKNOWN, UNSPECIFIED, USED. |
| AdGroupCriterionListingGroupCaseValueProductCustomAttributeIndex | String | ATTRIBUTE | Indicates the index of the custom attribute.
The allowed values are INDEX0, INDEX1, INDEX2, INDEX3, INDEX4, UNKNOWN, UNSPECIFIED. |
| AdGroupCriterionListingGroupCaseValueProductCustomAttributeValue | String | ATTRIBUTE | String value of the product custom attribute. |
| AdGroupCriterionListingGroupCaseValueProductItemIdValue | String | ATTRIBUTE | Value of the id. |
| AdGroupCriterionListingGroupCaseValueProductTypeLevel | String | ATTRIBUTE | Level of the type.
The allowed values are LEVEL1, LEVEL2, LEVEL3, LEVEL4, LEVEL5, UNKNOWN, UNSPECIFIED. |
| AdGroupCriterionListingGroupCaseValueProductTypeValue | String | ATTRIBUTE | Value of the type. |
| AdGroupCriterionListingGroupParentAdGroupCriterion | String | ATTRIBUTE | Resource name of ad group criterion which is the parent listing group subdivision. Null for the root group. |
| AdGroupCriterionListingGroupPath | String | ATTRIBUTE | The path of dimensions defining this listing group. |
| AdGroupCriterionListingGroupType | String | ATTRIBUTE | Type of the listing group.
The allowed values are SUBDIVISION, UNIT, UNKNOWN, UNSPECIFIED. |
| AdGroupCriterionLocationGeoTargetConstant | String | ATTRIBUTE | The geo target constant resource name. |
| AdGroupCriterionMobileAppCategoryMobileAppCategoryConstant | String | ATTRIBUTE | The mobile app category constant resource name. |
| AdGroupCriterionMobileApplicationAppId | String | ATTRIBUTE | A string that uniquely identifies a mobile application to Google Ads API. The format of this string is '{platform}-{platform_native_id}', where platform is '1' for iOS apps and '2' for Android apps, and where platform_native_id is the mobile application identifier native to the corresponding platform. For iOS, this native identifier is the 9 digit string that appears at the end of an App Store URL (for example, '476943146' for 'Flood-It! 2' whose App Store link is 'http://itunes.apple.com/us/app/flood-it!-2/id476943146'). For Android, this native identifier is the application's package name (for example, 'com.labpixies.colordrips' for 'Color Drips' given Google Play link 'https://play.google.com/store/apps/details?id=com.labpixies.colordrips'). A well formed app id for Google Ads API would thus be '1-476943146' for iOS and '2-com.labpixies.colordrips' for Android. This field is required and must be set in CREATE operations. |
| AdGroupCriterionMobileApplicationName | String | ATTRIBUTE | Name of this mobile application. |
| AdGroupCriterionNegative | Bool | ATTRIBUTE | 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. |
| AdGroupCriterionParentalStatusType | String | ATTRIBUTE | Type of the parental status.
The allowed values are NOT_A_PARENT, PARENT, UNDETERMINED, UNKNOWN, UNSPECIFIED. |
| AdGroupCriterionPercentCpcBidMicros | Long | ATTRIBUTE | 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]. |
| AdGroupCriterionPlacementUrl | String | ATTRIBUTE | URL of the placement. For example, 'http://www.domain.com'. |
| AdGroupCriterionPositionEstimatesEstimatedAddClicksAtFirstPositionCpc | Long | ATTRIBUTE | Output only. Estimate of how many clicks per week you might get by changing your keyword bid to the value in first_position_cpc_micros. |
| AdGroupCriterionPositionEstimatesEstimatedAddCostAtFirstPositionCpc | Long | ATTRIBUTE | Output only. Estimate of how your cost per week might change when changing your keyword bid to the value in first_position_cpc_micros. |
| AdGroupCriterionPositionEstimatesFirstPageCpcMicros | Long | ATTRIBUTE | Output only. The estimate of the CPC bid required for ad to be shown on first page of search results. |
| AdGroupCriterionPositionEstimatesFirstPositionCpcMicros | Long | ATTRIBUTE | Output only. The estimate of the CPC bid required for ad to be displayed in first position, at the top of the first page of search results. |
| AdGroupCriterionPositionEstimatesTopOfPageCpcMicros | Long | ATTRIBUTE | Output only. The estimate of the CPC bid required for ad to be displayed at the top of the first page of search results. |
| AdGroupCriterionQualityInfoCreativeQualityScore | String | ATTRIBUTE | Output only. The performance of the ad compared to other advertisers.
The allowed values are ABOVE_AVERAGE, AVERAGE, BELOW_AVERAGE, UNKNOWN, UNSPECIFIED. |
| AdGroupCriterionQualityInfoPostClickQualityScore | String | ATTRIBUTE | Output only. The quality score of the landing page.
The allowed values are ABOVE_AVERAGE, AVERAGE, BELOW_AVERAGE, UNKNOWN, UNSPECIFIED. |
| AdGroupCriterionQualityInfoQualityScore | Int | ATTRIBUTE | Output only. The quality score. This field may not be populated if Google does not have enough information to determine a value. |
| AdGroupCriterionQualityInfoSearchPredictedCtr | String | ATTRIBUTE | Output only. The click-through rate compared to that of other advertisers.
The allowed values are ABOVE_AVERAGE, AVERAGE, BELOW_AVERAGE, UNKNOWN, UNSPECIFIED. |
| AdGroupCriterionResourceName | String | ATTRIBUTE | 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} |
| AdGroupCriterionStatus | String | ATTRIBUTE | 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.
The allowed values are ENABLED, PAUSED, REMOVED, UNKNOWN, UNSPECIFIED. |
| AdGroupCriterionSystemServingStatus | String | ATTRIBUTE | Output only. Serving status of the criterion.
The allowed values are ELIGIBLE, RARELY_SERVED, UNKNOWN, UNSPECIFIED. |
| AdGroupCriterionTopicPath | String | ATTRIBUTE | The category to target or exclude. Each subsequent element in the array describes a more specific sub-category. For example, 'Pets & Animals', 'Pets', 'Dogs' represents the 'Pets & Animals/Pets/Dogs' category. |
| AdGroupCriterionTopicTopicConstant | String | ATTRIBUTE | The Topic Constant resource name. |
| AdGroupCriterionTrackingUrlTemplate | String | ATTRIBUTE | The URL template for constructing a tracking URL. |
| AdGroupCriterionType | String | ATTRIBUTE | Output only. The type of the criterion.
The allowed values are AD_SCHEDULE, AGE_RANGE, APP_PAYMENT_MODEL, AUDIENCE, BRAND, BRAND_LIST, CARRIER, COMBINED_AUDIENCE, CONTENT_LABEL, CUSTOM_AFFINITY, CUSTOM_AUDIENCE, CUSTOM_INTENT, DEVICE, GENDER, INCOME_RANGE, IP_BLOCK, KEYWORD, KEYWORD_THEME, LANGUAGE, LISTING_GROUP, LISTING_SCOPE, LOCAL_SERVICE_ID, LOCATION, LOCATION_GROUP, MOBILE_APPLICATION, MOBILE_APP_CATEGORY, MOBILE_DEVICE, NEGATIVE_KEYWORD_LIST, OPERATING_SYSTEM_VERSION, PARENTAL_STATUS, PLACEMENT, PROXIMITY, SEARCH_THEME, TOPIC, UNKNOWN, UNSPECIFIED, USER_INTEREST, USER_LIST, WEBPAGE, YOUTUBE_CHANNEL, YOUTUBE_VIDEO. |
| AdGroupCriterionUrlCustomParameters | String | ATTRIBUTE | The list of mappings used to substitute custom parameter tags in a tracking_url_template, final_urls, or mobile_final_urls. |
| AdGroupCriterionUserInterestUserInterestCategory | String | ATTRIBUTE | The UserInterest resource name. |
| AdGroupCriterionUserListUserList | String | ATTRIBUTE | The User List resource name. |
| AdGroupCriterionWebpageConditions | String | ATTRIBUTE | Conditions, or logical expressions, for webpage targeting. The list of webpage targeting conditions are and-ed together when evaluated for targeting. An empty list of conditions indicates all pages of the campaign's website are targeted. This field is required for CREATE operations and is prohibited on UPDATE operations. |
| AdGroupCriterionWebpageCoveragePercentage | Double | ATTRIBUTE | Website criteria coverage percentage. This is the computed percentage of website coverage based on the website target, negative website target and negative keywords in the ad group and campaign. For instance, when coverage returns as 1, it indicates it has 100% coverage. This field is read-only. |
| AdGroupCriterionWebpageCriterionName | String | ATTRIBUTE | The name of the criterion that is defined by this parameter. The name value will be used for identifying, sorting and filtering criteria with this type of parameters. This field is required for CREATE operations and is prohibited on UPDATE operations. |
| AdGroupCriterionWebpageSampleSampleUrls | String | ATTRIBUTE | Webpage sample urls |
| AdGroupCriterionYoutubeChannelChannelId | String | ATTRIBUTE | The YouTube uploader channel id or the channel code of a YouTube channel. |
| AdGroupCriterionYoutubeVideoVideoId | String | ATTRIBUTE | YouTube video id as it appears on the YouTube watch page. |
| CustomerId | Long | ATTRIBUTE | Output only. The ID of the customer. |
Pseudo-Columns
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
| Name | Type | Description |
| ManagerId | Long | Id of the manager account on behalf of which you are requesting customer data. |