CampaignCriterion
A campaign 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 |
| CampaignCriterionAdScheduleDayOfWeek | String | ATTRIBUTE | Day of the week the schedule applies to. This field is required for CREATE operations and is prohibited on UPDATE operations.
The allowed values are FRIDAY, MONDAY, SATURDAY, SUNDAY, THURSDAY, TUESDAY, UNKNOWN, UNSPECIFIED, WEDNESDAY. |
| CampaignCriterionAdScheduleEndHour | Int | ATTRIBUTE | Ending hour in 24 hour time; 24 signifies end of the day. This field must be between 0 and 24, inclusive. This field is required for CREATE operations and is prohibited on UPDATE operations. |
| CampaignCriterionAdScheduleEndMinute | String | ATTRIBUTE | Minutes after the end hour at which this schedule ends. The schedule is exclusive of the end minute. This field is required for CREATE operations and is prohibited on UPDATE operations.
The allowed values are FIFTEEN, FORTY_FIVE, THIRTY, UNKNOWN, UNSPECIFIED, ZERO. |
| CampaignCriterionAdScheduleStartHour | Int | ATTRIBUTE | Starting hour in 24 hour time. This field must be between 0 and 23, inclusive. This field is required for CREATE operations and is prohibited on UPDATE operations. |
| CampaignCriterionAdScheduleStartMinute | String | ATTRIBUTE | Minutes after the start hour at which this schedule starts. This field is required for CREATE operations and is prohibited on UPDATE operations.
The allowed values are FIFTEEN, FORTY_FIVE, THIRTY, UNKNOWN, UNSPECIFIED, ZERO. |
| CampaignCriterionAgeRangeType | 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. |
| CampaignCriterionBidModifier | String | ATTRIBUTE | The modifier for the bids when the criterion matches. The modifier must be in the range: 0.1 - 10.0. Most targetable criteria types support modifiers. Use 0 to opt out of a Device type. |
| CampaignCriterionBrandListSharedSet | String | ATTRIBUTE | Shared set resource name of the brand list. |
| CampaignCriterionCampaign | String | ATTRIBUTE | Immutable. The campaign to which the criterion belongs. |
| CampaignCriterionCarrierCarrierConstant | String | ATTRIBUTE | The Carrier constant resource name. |
| CampaignCriterionCombinedAudienceCombinedAudience | String | ATTRIBUTE | The CombinedAudience resource name. |
| CampaignCriterionContentLabelType | String | ATTRIBUTE | Content label type, required for CREATE operations.
The allowed values are BELOW_THE_FOLD, BRAND_SUITABILITY_CONTENT_FOR_FAMILIES, BRAND_SUITABILITY_GAMES_FIGHTING, BRAND_SUITABILITY_GAMES_MATURE, BRAND_SUITABILITY_HEALTH_SENSITIVE, BRAND_SUITABILITY_HEALTH_SOURCE_UNDETERMINED, BRAND_SUITABILITY_NEWS_RECENT, BRAND_SUITABILITY_NEWS_SENSITIVE, BRAND_SUITABILITY_NEWS_SOURCE_NOT_FEATURED, BRAND_SUITABILITY_POLITICS, BRAND_SUITABILITY_RELIGION, EMBEDDED_VIDEO, JUVENILE, LIVE_STREAMING_VIDEO, PARKED_DOMAIN, PROFANITY, SEXUALLY_SUGGESTIVE, SOCIAL_ISSUES, TRAGEDY, UNKNOWN, UNSPECIFIED, VIDEO, VIDEO_NOT_YET_RATED, VIDEO_RATING_DV_G, VIDEO_RATING_DV_MA, VIDEO_RATING_DV_PG, VIDEO_RATING_DV_T. |
| CampaignCriterionCriterionId | Long | ATTRIBUTE | Output only. The ID of the criterion. This field is ignored during mutate. |
| CampaignCriterionCustomAffinityCustomAffinity | String | ATTRIBUTE | The CustomInterest resource name. |
| CampaignCriterionCustomAudienceCustomAudience | String | ATTRIBUTE | The CustomAudience resource name. |
| CampaignCriterionDeviceType | String | ATTRIBUTE | Type of the device.
The allowed values are CONNECTED_TV, DESKTOP, MOBILE, OTHER, TABLET, UNKNOWN, UNSPECIFIED. |
| CampaignCriterionDisplayName | String | ATTRIBUTE | Output only. The display name of the criterion. This field is ignored for mutates. |
| CampaignCriterionGenderType | String | ATTRIBUTE | Type of the gender.
The allowed values are FEMALE, MALE, UNDETERMINED, UNKNOWN, UNSPECIFIED. |
| CampaignCriterionIncomeRangeType | 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. |
| CampaignCriterionIpBlockIpAddress | String | ATTRIBUTE | The IP address of this IP block. |
| CampaignCriterionKeywordMatchType | String | ATTRIBUTE | The match type of the keyword.
The allowed values are BROAD, EXACT, PHRASE, UNKNOWN, UNSPECIFIED. |
| CampaignCriterionKeywordText | String | ATTRIBUTE | The text of the keyword (at most 80 characters and 10 words). |
| CampaignCriterionKeywordThemeFreeFormKeywordTheme | String | ATTRIBUTE | Free-form text to be matched to a Smart Campaign keyword theme constant on a best-effort basis. |
| CampaignCriterionKeywordThemeKeywordThemeConstant | String | ATTRIBUTE | The resource name of a Smart Campaign keyword theme constant. keywordThemeConstants/{keyword_theme_id}~{sub_keyword_theme_id} |
| CampaignCriterionLanguageLanguageConstant | String | ATTRIBUTE | The language constant resource name. |
| CampaignCriterionListingScopeDimensions | String | ATTRIBUTE | Scope of the campaign criterion. |
| CampaignCriterionLocalServiceIdServiceId | String | ATTRIBUTE | The criterion resource name. |
| CampaignCriterionLocationGeoTargetConstant | String | ATTRIBUTE | The geo target constant resource name. |
| CampaignCriterionLocationGroup | String | ATTRIBUTE | Immutable. Location Group |
| CampaignCriterionLocationGroupEnableCustomerLevelLocationAssetSet | Bool | ATTRIBUTE | Denotes that the latest customer level asset set is used for targeting. Used with radius and radius_units. Cannot be used with feed, geo target constants or feed item sets. When using asset sets, either this field or location_group_asset_sets should be specified. Both cannot be used at the same time. This can only be set in CREATE operations. |
| CampaignCriterionLocationGroupFeed | String | ATTRIBUTE | Feed specifying locations for targeting. Cannot be set with AssetSet fields. This is required and must be set in CREATE operations. |
| CampaignCriterionMobileAppCategoryMobileAppCategoryConstant | String | ATTRIBUTE | The mobile app category constant resource name. |
| CampaignCriterionMobileApplicationAppId | 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. |
| CampaignCriterionMobileApplicationName | String | ATTRIBUTE | Name of this mobile application. |
| CampaignCriterionMobileDeviceMobileDeviceConstant | String | ATTRIBUTE | The mobile device constant resource name. |
| CampaignCriterionNegative | Bool | ATTRIBUTE | Immutable. Whether to target (false) or exclude (true) the criterion. |
| CampaignCriterionOperatingSystemVersionOperatingSystemVersionConstant | String | ATTRIBUTE | The operating system version constant resource name. |
| CampaignCriterionParentalStatusType | String | ATTRIBUTE | Type of the parental status.
The allowed values are NOT_A_PARENT, PARENT, UNDETERMINED, UNKNOWN, UNSPECIFIED. |
| CampaignCriterionPlacementUrl | String | ATTRIBUTE | URL of the placement. For example, 'http://www.domain.com'. |
| CampaignCriterionProximityAddressCityName | String | ATTRIBUTE | Name of the city. |
| CampaignCriterionProximityAddressCountryCode | String | ATTRIBUTE | Country code. |
| CampaignCriterionProximityAddressPostalCode | String | ATTRIBUTE | Postal code. |
| CampaignCriterionProximityAddressProvinceCode | String | ATTRIBUTE | Province or state code. |
| CampaignCriterionProximityAddressProvinceName | String | ATTRIBUTE | Province or state name. |
| CampaignCriterionProximityAddressStreetAddress | String | ATTRIBUTE | Street address line 1. |
| CampaignCriterionProximityGeoPointLatitudeInMicroDegrees | Int | ATTRIBUTE | Micro degrees for the latitude. |
| CampaignCriterionProximityGeoPointLongitudeInMicroDegrees | Int | ATTRIBUTE | Micro degrees for the longitude. |
| CampaignCriterionProximityRadius | Double | ATTRIBUTE | The radius of the proximity. |
| CampaignCriterionProximityRadiusUnits | String | ATTRIBUTE | The unit of measurement of the radius. Default is KILOMETERS.
The allowed values are KILOMETERS, MILES, UNKNOWN, UNSPECIFIED. |
| CampaignCriterionResourceName | String | ATTRIBUTE | Immutable. The resource name of the campaign criterion. Campaign criterion resource names have the form: customers/{customer_id}/campaignCriteria/{campaign_id}~{criterion_id} |
| CampaignCriterionStatus | String | ATTRIBUTE | The status of the criterion.
The allowed values are ENABLED, PAUSED, REMOVED, UNKNOWN, UNSPECIFIED. |
| CampaignCriterionTopicPath | 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. |
| CampaignCriterionTopicTopicConstant | String | ATTRIBUTE | The Topic Constant resource name. |
| CampaignCriterionType | 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, LIFE_EVENT, 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. |
| CampaignCriterionUserInterestUserInterestCategory | String | ATTRIBUTE | The UserInterest resource name. |
| CampaignCriterionUserListUserList | String | ATTRIBUTE | The User List resource name. |
| CampaignCriterionWebpageConditions | 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. |
| CampaignCriterionWebpageCoveragePercentage | 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. |
| CampaignCriterionWebpageCriterionName | 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. |
| CampaignCriterionWebpageSampleSampleUrls | String | ATTRIBUTE | Webpage sample urls |
| CampaignCriterionYoutubeChannelChannelId | String | ATTRIBUTE | The YouTube uploader channel id or the channel code of a YouTube channel. |
| CampaignCriterionYoutubeVideoVideoId | 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. |