Package google.ads.googleads.v0.enums

Index

AccessReasonEnum

Indicates the way the entity such as user list is related to a user.

AccessReason

Enum describing possible access reasons.

Enums
UNSPECIFIED Not specified.
UNKNOWN Used for return value only. Represents value unknown in this version.
OWNED The entity is owned by the user.
SHARED The entity is shared to the user.
LICENSED The entity is licensed to the user.
SUBSCRIBED The user subscribed to the entity.
AFFILIATED The entity is accessible to the user.

AccountBudgetProposalStatusEnum

Message describing AccountBudgetProposal statuses.

AccountBudgetProposalStatus

The possible statuses of an AccountBudgetProposal.

Enums
UNSPECIFIED Not specified.
UNKNOWN Used for return value only. Represents value unknown in this version.
PENDING The proposal is pending approval.
APPROVED_HELD The proposal has been approved but the corresponding billing setup has not. This can occur for proposals that set up the first budget when signing up for billing or when performing a change of bill-to operation.
APPROVED The proposal has been approved.
CANCELLED The proposal has been cancelled by the user.
REJECTED The proposal has been rejected by the user, e.g. by rejecting an acceptance email.

AccountBudgetProposalTypeEnum

Message describing AccountBudgetProposal types.

AccountBudgetProposalType

The possible types of an AccountBudgetProposal.

Enums
UNSPECIFIED Not specified.
UNKNOWN Used for return value only. Represents value unknown in this version.
CREATE Identifies a request to create a new budget.
UPDATE Identifies a request to edit an existing budget.
END Identifies a request to end a budget that has already started.
REMOVE Identifies a request to remove a budget that hasn't started yet.

AccountBudgetStatusEnum

Message describing AccountBudget statuses.

AccountBudgetStatus

The possible statuses of an AccountBudget.

Enums
UNSPECIFIED Not specified.
UNKNOWN Used for return value only. Represents value unknown in this version.
PENDING The account budget is pending approval.
APPROVED The account budget has been approved.
CANCELLED The account budget has been cancelled by the user.

AdCustomizerPlaceholderFieldEnum

Values for Ad Customizer placeholder fields.

AdCustomizerPlaceholderField

Possible values for Ad Customizers placeholder fields.

Enums
UNSPECIFIED Not specified.
UNKNOWN Used for return value only. Represents value unknown in this version.
INTEGER Data Type: INT64. Integer value to be inserted.
PRICE Data Type: STRING. Price value to be inserted.
DATE Data Type: DATE_TIME. Date value to be inserted.
STRING Data Type: STRING. String value to be inserted.

AdGroupAdRotationModeEnum

Container for enum describing possible ad rotation modes of ads within an ad group.

AdGroupAdRotationMode

The possible ad rotation modes of an ad group.

Enums
UNSPECIFIED The ad rotation mode has not been specified.
UNKNOWN

The received value is not known in this version.

This is a response-only value.

OPTIMIZE Optimize ad group ads based on clicks or conversions.
ROTATE_FOREVER Rotate evenly forever.

AdGroupAdStatusEnum

Container for enum describing possible statuses of an AdGroupAd.

AdGroupAdStatus

The possible statuses of an AdGroupAd.

Enums
UNSPECIFIED No value has been specified.
UNKNOWN

The received value is not known in this version.

This is a response-only value.

ENABLED The ad group ad is enabled.
PAUSED The ad group ad is paused.
REMOVED The ad group ad is removed.

AdGroupCriterionStatusEnum

Message describing AdGroupCriterion statuses.

AdGroupCriterionStatus

The possible statuses of an AdGroupCriterion.

Enums
UNSPECIFIED No value has been specified.
UNKNOWN

The received value is not known in this version.

This is a response-only value.

ENABLED The ad group criterion is enabled.
PAUSED The ad group criterion is paused.
REMOVED The ad group criterion is removed.

AdGroupStatusEnum

Container for enum describing possible statuses of an ad group.

AdGroupStatus

The possible statuses of an ad group.

Enums
UNSPECIFIED The status has not been specified.
UNKNOWN

The received value is not known in this version.

This is a response-only value.

ENABLED The ad group is enabled.
PAUSED The ad group is paused.
REMOVED The ad group is removed.

AdGroupTypeEnum

Defines types of an ad group, specific to a particular campaign channel type. This type drives validations that restrict which entities can be added to the ad group.

AdGroupType

Enum listing the possible types of an ad group.

Enums
UNSPECIFIED The type has not been specified.
UNKNOWN

The received value is not known in this version.

This is a response-only value.

SEARCH_STANDARD The default ad group type for Search campaigns.
DISPLAY_STANDARD The default ad group type for Display campaigns.
SHOPPING_PRODUCT_ADS The ad group type for Shopping campaigns serving standard product ads.
HOTEL_ADS The default ad group type for Hotel campaigns.
SHOPPING_SMART_ADS The type for ad groups in Smart Shopping campaigns.
VIDEO_BUMPER Short unskippable in-stream video ads.
VIDEO_TRUE_VIEW_IN_STREAM TrueView (skippable) in-stream video ads.
VIDEO_TRUE_VIEW_IN_DISPLAY TrueView in-display video ads.
VIDEO_NON_SKIPPABLE_IN_STREAM Unskippable in-stream video ads.
VIDEO_OUTSTREAM Outstream video ads.

AdNetworkTypeEnum

Container for enumeration of Google Ads network types.

AdNetworkType

Enumerates Google Ads network types.

Enums
UNSPECIFIED Not specified.
UNKNOWN The value is unknown in this version.
SEARCH Google search.
SEARCH_PARTNERS Search partners.
CONTENT Display Network.
YOUTUBE_WATCH YouTube Videos
MIXED Cross-network.

AdServingOptimizationStatusEnum

Possible ad serving statuses of a campaign.

AdServingOptimizationStatus

Enum describing possible serving statuses.

Enums
UNSPECIFIED No value has been specified.
UNKNOWN

The received value is not known in this version.

This is a response-only value.

OPTIMIZE Ad serving is optimized based on CTR for the campaign.
CONVERSION_OPTIMIZE Ad serving is optimized based on CTR * Conversion for the campaign. If the campaign is not in the conversion optimizer bidding strategy, it will default to OPTIMIZED.
ROTATE Ads are rotated evenly for 90 days, then optimized for clicks.
ROTATE_INDEFINITELY Show lower performing ads more evenly with higher performing ads, and do not optimize.
UNAVAILABLE Ad serving optimization status is not available.

AdTypeEnum

Container for enum describing possible types of an ad.

AdType

The possible types of an ad.

Enums
UNSPECIFIED No value has been specified.
UNKNOWN

The received value is not known in this version.

This is a response-only value.

TEXT_AD The ad is a text ad.
EXPANDED_TEXT_AD The ad is an expanded text ad.
DYNAMIC_SEARCH_AD The ad is a dynamic search ad.
RESPONSIVE_DISPLAY_AD The ad is a responsive display ad.
CALL_ONLY_AD The ad is a call only ad.
EXPANDED_DYNAMIC_SEARCH_AD The ad is an expanded dynamic search ad.
HOTEL_AD The ad is a hotel ad.
SHOPPING_SMART_AD The ad is a Smart Shopping ad.
SHOPPING_PRODUCT_AD The ad is a standard Shopping ad.
VIDEO_AD The ad is a video ad.
GMAIL_AD This ad is a Gmail ad.
IMAGE_AD This ad is an Image ad.

AdvertisingChannelSubTypeEnum

An immutable specialization of an Advertising Channel.

AdvertisingChannelSubType

Enum describing the different channel subtypes.

Enums
UNSPECIFIED Not specified.
UNKNOWN Used as a return value only. Represents value unknown in this version.
SEARCH_MOBILE_APP Mobile app campaigns for Search.
DISPLAY_MOBILE_APP Mobile app campaigns for Display.
SEARCH_EXPRESS AdWords express campaigns for search.
DISPLAY_EXPRESS AdWords Express campaigns for display.
SHOPPING_SMART_ADS Smart Shopping campaigns.
DISPLAY_GMAIL_AD Gmail Ad campaigns.
DISPLAY_SMART_CAMPAIGN Smart display campaigns.
VIDEO_OUTSTREAM Video Outstream campaigns.

AdvertisingChannelTypeEnum

The channel type a campaign may target to serve on.

AdvertisingChannelType

Enum describing the various advertising channel types.

Enums
UNSPECIFIED Not specified.
UNKNOWN Used for return value only. Represents value unknown in this version.
SEARCH Search Network. Includes display bundled, and Search+ campaigns.
DISPLAY Google Display Network only.
SHOPPING Shopping campaigns serve on the shopping property and on google.com search results.
HOTEL Hotel Ads campaigns.
VIDEO Video campaigns.

AffiliateLocationFeedRelationshipTypeEnum

Container for enum describing possible values for a relationship type for an affiliate location feed.

AffiliateLocationFeedRelationshipType

Possible values for a relationship type for an affiliate location feed.

Enums
UNSPECIFIED Not specified.
UNKNOWN Used for return value only. Represents value unknown in this version.
GENERAL_RETAILER General retailer relationship.

AgeRangeTypeEnum

Container for enum describing the type of demographic age ranges.

AgeRangeType

The type of demographic age ranges (e.g. between 18 and 24 years old).

Enums
UNSPECIFIED Not specified.
UNKNOWN Used for return value only. Represents value unknown in this version.
AGE_RANGE_18_24 Between 18 and 24 years old.
AGE_RANGE_25_34 Between 25 and 34 years old.
AGE_RANGE_35_44 Between 35 and 44 years old.
AGE_RANGE_45_54 Between 45 and 54 years old.
AGE_RANGE_55_64 Between 55 and 64 years old.
AGE_RANGE_65_UP 65 years old and beyond.
AGE_RANGE_UNDETERMINED Undetermined age range.

AppPlaceholderFieldEnum

Values for App placeholder fields.

AppPlaceholderField

Possible values for App placeholder fields.

Enums
UNSPECIFIED Not specified.
UNKNOWN Used for return value only. Represents value unknown in this version.
STORE Data Type: INT64. The application store that the target application belongs to. Valid values are: 1 = Apple iTunes Store; 2 = Google Play Store.
ID Data Type: STRING. The store-specific ID for the target application.
URL Data Type: STRING. The destination URL of the in-app link.
FINAL_URLS Data Type: URL_LIST. Final URLs for the in-app link when using Upgraded URLs.
FINAL_MOBILE_URLS Data Type: URL_LIST. Final Mobile URLs for the in-app link when using Upgraded URLs.
TRACKING_URL Data Type: URL. Tracking template for the in-app link when using Upgraded URLs.
FINAL_URL_SUFFIX Data Type: STRING. Final URL suffix for the in-app link when using parallel tracking.

AttributionModelEnum

Container for enum representing the attribution model that describes how to distribute credit for a particular conversion across potentially many prior interactions.

AttributionModel

The attribution model that describes how to distribute credit for a particular conversion across potentially many prior interactions.

Enums
UNSPECIFIED Not specified.
UNKNOWN Used for return value only. Represents value unknown in this version.
EXTERNAL Uses external attribution.
GOOGLE_ADS_LAST_CLICK Attributes all credit for a conversion to its last click.
GOOGLE_SEARCH_ATTRIBUTION_FIRST_CLICK Attributes all credit for a conversion to its first click using Google Search attribution.
GOOGLE_SEARCH_ATTRIBUTION_LINEAR Attributes credit for a conversion equally across all of its clicks using Google Search attribution.
GOOGLE_SEARCH_ATTRIBUTION_TIME_DECAY Attributes exponentially more credit for a conversion to its more recent clicks using Google Search attribution (half-life is 1 week).
GOOGLE_SEARCH_ATTRIBUTION_POSITION_BASED Attributes 40% of the credit for a conversion to its first and last clicks. Remaining 20% is evenly distributed across all other clicks. This uses Google Search attribution.
GOOGLE_SEARCH_ATTRIBUTION_DATA_DRIVEN Flexible model that uses machine learning to determine the appropriate distribution of credit among clicks using Google Search attribution.

BidModifierSourceEnum

Container for enum describing possible bid modifier sources.

BidModifierSource

Enum describing possible bid modifier sources.

Enums
UNSPECIFIED Not specified.
UNKNOWN Used for return value only. Represents value unknown in this version.
CAMPAIGN The bid modifier is specified at the campaign level, on the campaign level criterion.
AD_GROUP The bid modifier is specified (overridden) at the ad group level.

BiddingSourceEnum

Container for enum describing possible bidding sources.

BiddingSource

Enum describing possible bidding sources.

Enums
UNSPECIFIED Not specified.
UNKNOWN Used for return value only. Represents value unknown in this version.
ADGROUP Bidding entity is defined on the ad group.
CRITERION Bidding entity is defined on the ad group criterion.
CAMPAIGN_BIDDING_STRATEGY Effective bidding entity is inherited from campaign bidding strategy.

BiddingStrategyTypeEnum

Container for enum describing possible bidding strategy types.

BiddingStrategyType

Enum describing possible bidding strategy types.

Enums
UNSPECIFIED Not specified.
UNKNOWN Used for return value only. Represents value unknown in this version.
ENHANCED_CPC Enhanced CPC is a bidding strategy that raises bids for clicks that seem more likely to lead to a conversion and lowers them for clicks where they seem less likely.
MANUAL_CPC Manual click based bidding where user pays per click.
MANUAL_CPM Manual impression based bidding where user pays per thousand impressions.
MANUAL_CPV A bidding strategy that pays a configurable amount per video view.
MAXIMIZE_CONVERSIONS A bidding strategy that automatically maximizes number of conversions given a daily budget.
MAXIMIZE_CONVERSION_VALUE An automated bidding strategy that automatically sets bids to maximize revenue while spending your budget.
PAGE_ONE_PROMOTED Page-One Promoted bidding scheme, which sets max cpc bids to target impressions on page one or page one promoted slots on google.com.
PERCENT_CPC Percent Cpc is bidding strategy where bids are a fraction of the advertised price for some good or service.
TARGET_CPA Target CPA is an automated bid strategy that sets bids to help get as many conversions as possible at the target cost-per-acquisition (CPA) you set.
TARGET_OUTRANK_SHARE Target Outrank Share is an automated bidding strategy that sets bids based on the target fraction of auctions where the advertiser should outrank a specific competitor.
TARGET_ROAS Target ROAS is an automated bidding strategy that helps you maximize revenue while averaging a specific target Return On Average Spend (ROAS).
TARGET_SPEND Target Spend is an automated bid strategy that sets your bids to help get as many clicks as possible within your budget.

BillingSetupStatusEnum

Message describing BillingSetup statuses.

BillingSetupStatus

The possible statuses of a BillingSetup.

Enums
UNSPECIFIED Not specified.
UNKNOWN Used for return value only. Represents value unknown in this version.
PENDING The billing setup is pending approval.
APPROVED_HELD The billing setup has been approved but the corresponding first budget has not. This can only occur for billing setups configured for monthly invoicing.
APPROVED The billing setup has been approved.
CANCELLED The billing setup was cancelled by the user prior to approval.

BudgetDeliveryMethodEnum

Message describing Budget delivery methods. A delivery method determines the rate at which the Budget is spent.

BudgetDeliveryMethod

Possible delivery methods of a Budget.

Enums
UNSPECIFIED Not specified.
UNKNOWN Used for return value only. Represents value unknown in this version.
STANDARD The budget server will throttle serving evenly across the entire time period.
ACCELERATED The budget server will not throttle serving, and ads will serve as fast as possible.

BudgetStatusEnum

Message describing a Budget status

BudgetStatus

Possible statuses of a Budget.

Enums
UNSPECIFIED Not specified.
UNKNOWN Used for return value only. Represents value unknown in this version.
ENABLED Budget is enabled.
REMOVED Budget is removed.

CallConversionReportingStateEnum

Container for enum describing possible data types for call conversion reporting state.

CallConversionReportingState

Possible data types for a call conversion action state.

Enums
UNSPECIFIED Not specified.
UNKNOWN Used for return value only. Represents value unknown in this version.
DISABLED Call conversion action is disabled.
USE_ACCOUNT_LEVEL_CALL_CONVERSION_ACTION Call conversion action will use call conversion type set at the account level.
USE_RESOURCE_LEVEL_CALL_CONVERSION_ACTION Call conversion action will use call conversion type set at the resource (call only ads/call extensions) level.

CallPlaceholderFieldEnum

Values for Call placeholder fields.

CallPlaceholderField

Possible values for Call placeholder fields.

Enums
UNSPECIFIED Not specified.
UNKNOWN Used for return value only. Represents value unknown in this version.
PHONE_NUMBER Data Type: STRING. The advertiser's phone number to append to the ad.
COUNTRY_CODE Data Type: STRING. Uppercase two-letter country code of the advertiser's phone number.
TRACKED Data Type: BOOLEAN. Indicates whether call tracking is enabled. Default: true.
CONVERSION_TYPE_ID Data Type: INT64. The ID of an AdCallMetricsConversion object. This object contains the phoneCallDurationfield which is the minimum duration (in seconds) of a call to be considered a conversion.
CONVERSION_REPORTING_STATE Data Type: STRING. Indicates whether this call extension uses its own call conversion setting or follows the account level setting. Valid values are: USE_ACCOUNT_LEVEL_CALL_CONVERSION_ACTION and USE_RESOURCE_LEVEL_CALL_CONVERSION_ACTION.

CalloutPlaceholderFieldEnum

Values for Callout placeholder fields.

CalloutPlaceholderField

Possible values for Callout placeholder fields.

Enums
UNSPECIFIED Not specified.
UNKNOWN Used for return value only. Represents value unknown in this version.
CALLOUT_TEXT Data Type: STRING. Callout text.

CampaignGroupStatusEnum

Message describing CampaignGroup statuses.

CampaignGroupStatus

Possible statuses of a CampaignGroup.

Enums
UNSPECIFIED Not specified.
UNKNOWN Used for return value only. Represents value unknown in this version.
ENABLED Campaign group is currently serving ads depending on budget information.
REMOVED Campaign group has been removed.

CampaignServingStatusEnum

Message describing Campaign serving statuses.

CampaignServingStatus

Possible serving statuses of a campaign.

Enums
UNSPECIFIED No value has been specified.
UNKNOWN

The received value is not known in this version.

This is a response-only value.

SERVING Serving.
NONE None.
ENDED Ended.
PENDING Pending.
SUSPENDED Suspended.

CampaignSharedSetStatusEnum

Container for enum describing types of campaign shared set statuses.

CampaignSharedSetStatus

Enum listing the possible campaign shared set statuses.

Enums
UNSPECIFIED Not specified.
UNKNOWN Used for return value only. Represents value unknown in this version.
ENABLED The campaign shared set is enabled.
REMOVED The campaign shared set is removed and can no longer be used.

CampaignStatusEnum

Container for enum describing possible statuses of a campaign.

CampaignStatus

Possible statuses of a campaign.

Enums
UNSPECIFIED Not specified.
UNKNOWN Used for return value only. Represents value unknown in this version.
ENABLED Campaign is currently serving ads depending on budget information.
PAUSED Campaign has been paused by the user.
REMOVED Campaign has been removed.

ChangeStatusOperationEnum

Container for enum describing operations for the ChangeStatus resource.

ChangeStatusOperation

Status of the changed resource

Enums
UNSPECIFIED No value has been specified.
UNKNOWN Used for return value only. Represents an unclassified resource unknown in this version.
ADDED The resource was created.
CHANGED The resource was modified.
REMOVED The resource was removed.

ChangeStatusResourceTypeEnum

Container for enum describing supported resource types for the ChangeStatus resource.

ChangeStatusResourceType

Enum listing the resource types support by the ChangeStatus resource.

Enums
UNSPECIFIED No value has been specified.
UNKNOWN Used for return value only. Represents an unclassified resource unknown in this version.
AD_GROUP An AdGroup resource change.
AD_GROUP_AD An AdGroupAd resource change.
AD_GROUP_CRITERION An AdGroupCriterion resource change.
CAMPAIGN A Campaign resource change.
CAMPAIGN_CRITERION A CampaignCriterion resource change.

ContentLabelTypeEnum

Container for enum describing content label types in ContentLabel.

ContentLabelType

Enum listing the content label types supported by ContentLabel criterion.

Enums
UNSPECIFIED Not specified.
UNKNOWN Used for return value only. Represents value unknown in this version.
SEXUALLY_SUGGESTIVE Sexually suggestive content.
BELOW_THE_FOLD Below the fold placement.
PARKED_DOMAIN Parked domain.
GAME Game.
JUVENILE Juvenile, gross & bizarre content.
PROFANITY Profanity & rough language.
TRAGEDY Death & tragedy.
VIDEO Video.
VIDEO_RATING_DV_G Content rating: G.
VIDEO_RATING_DV_PG Content rating: PG.
VIDEO_RATING_DV_T Content rating: T.
VIDEO_RATING_DV_MA Content rating: MA.
VIDEO_NOT_YET_RATED Content rating: not yet rated.
EMBEDDED_VIDEO Embedded video.
LIVE_STREAMING_VIDEO Live streaming video.

ConversionActionCategoryEnum

Container for enum describing the category of conversions that are associated with a ConversionAction.

ConversionActionCategory

The category of conversions that are associated with a ConversionAction.

Enums
UNSPECIFIED Not specified.
UNKNOWN Used for return value only. Represents value unknown in this version.
DEFAULT Default category.
PAGE_VIEW User visiting a page.
PURCHASE Purchase, sales, or "order placed" event.
SIGNUP Signup user action.
LEAD Lead-generating action.
DOWNLOAD Software download action (as for an app).

ConversionActionCountingTypeEnum

Container for enum describing the conversion deduplication mode for conversion optimizer.

ConversionActionCountingType

Indicates how conversions for this action will be counted. For more information, see https://support.google.com/google-ads/answer/3438531.

Enums
UNSPECIFIED Not specified.
UNKNOWN Used for return value only. Represents value unknown in this version.
ONE_PER_CLICK Count only one conversion per click.
MANY_PER_CLICK Count all conversions per click.

ConversionActionStatusEnum

Container for enum describing possible statuses of a conversion action.

ConversionActionStatus

Possible statuses of a conversion action.

Enums
UNSPECIFIED Not specified.
UNKNOWN Used for return value only. Represents value unknown in this version.
ENABLED Conversions will be recorded.
REMOVED Conversions will not be recorded.
HIDDEN Conversions will not be recorded and the conversion action will not appear in the UI.

ConversionActionTypeEnum

Container for enum describing possible types of a conversion action.

ConversionActionType

Possible types of a conversion action.

Enums
UNSPECIFIED Not specified.
UNKNOWN Used for return value only. Represents value unknown in this version.
AD_CALL Conversions that occur when a user clicks on an ad's call extension.
CLICK_TO_CALL Conversions that occur when a user on a mobile device clicks a phone number.
GOOGLE_PLAY_DOWNLOAD Conversions that occur when a user downloads a mobile app from the Google Play Store.
GOOGLE_PLAY_IN_APP_PURCHASE Conversions that occur when a user makes a purchase in an app through Android billing.
UPLOAD_CALLS Call conversions that are tracked by the advertiser and uploaded.
UPLOAD_CLICKS Conversions that are tracked by the advertiser and uploaded with attributed clicks.
WEBPAGE Conversions that occur on a webpage.
WEBSITE_CALL Conversions that occur when a user calls a dynamically-generated phone number from an advertiser's website.

CriterionCategoryChannelAvailabilityModeEnum

Describes channel availability mode for a criterion availability - whether the availability is meant to include all advertising channels, or a particular channel with all its channel subtypes, or a channel with a certain subset of channel subtypes.

CriterionCategoryChannelAvailabilityMode

Enum containing the possible CriterionCategoryChannelAvailabilityMode.

Enums
UNSPECIFIED Not specified.
UNKNOWN Used for return value only. Represents value unknown in this version.
ALL_CHANNELS The category is available to campaigns of all channel types and subtypes.
CHANNEL_TYPE_AND_ALL_SUBTYPES The category is available to campaigns of a specific channel type, including all subtypes under it.
CHANNEL_TYPE_AND_SUBSET_SUBTYPES The category is available to campaigns of a specific channel type and subtype(s).

CriterionCategoryLocaleAvailabilityModeEnum

Describes locale availabilty mode for a criterion availability - whether it's available globally, or a particular country with all languages, or a particular language with all countries, or a country-language pair.

CriterionCategoryLocaleAvailabilityMode

Enum containing the possible CriterionCategoryLocaleAvailabilityMode.

Enums
UNSPECIFIED Not specified.
UNKNOWN Used for return value only. Represents value unknown in this version.
ALL_LOCALES The category is available to campaigns of all locales.
COUNTRY_AND_ALL_LANGUAGES The category is available to campaigns within a list of countries, regardless of language.
LANGUAGE_AND_ALL_COUNTRIES The category is available to campaigns within a list of languages, regardless of country.
COUNTRY_AND_LANGUAGE The category is available to campaigns within a list of country, language pairs.

CriterionTypeEnum

The possible types of a criterion.

CriterionType

Enum describing possible criterion types.

Enums
UNSPECIFIED Not specified.
UNKNOWN Used for return value only. Represents value unknown in this version.
KEYWORD Keyword. e.g. 'mars cruise'.
PLACEMENT Placement, aka Website. e.g. 'www.flowers4sale.com'
DEVICE Devices to target.
LOCATION Locations to target.
LISTING_GROUP Listing groups to target.
AD_SCHEDULE Ad Schedule.
AGE_RANGE Age range.
GENDER Gender.
INCOME_RANGE Income Range.
PARENTAL_STATUS Parental status.
YOUTUBE_VIDEO YouTube Video.
YOUTUBE_CHANNEL YouTube Channel.
USER_LIST User list.
PROXIMITY Proximity.
TOPIC A topic target on the display network (e.g. "Pets & Animals").
LISTING_SCOPE Listing scope to target.
LANGUAGE Language.
IP_BLOCK IpBlock.
CONTENT_LABEL Content Label for category exclusion.
CARRIER Carrier.
USER_INTEREST A category the user is interested in.

CustomPlaceholderFieldEnum

Values for Custom placeholder fields. For more information about dynamic remarketing feeds, see https://support.google.com/google-ads/answer/6053288.

CustomPlaceholderField

Possible values for Custom placeholder fields.

Enums
UNSPECIFIED Not specified.
UNKNOWN Used for return value only. Represents value unknown in this version.
ID Data Type: STRING. Required. Combination ID and ID2 must be unique per offer.
ID2 Data Type: STRING. Combination ID and ID2 must be unique per offer.
ITEM_TITLE Data Type: STRING. Required. Main headline with product name to be shown in dynamic ad.
ITEM_SUBTITLE Data Type: STRING. Optional text to be shown in the image ad.
ITEM_DESCRIPTION Data Type: STRING. Optional description of the product to be shown in the ad.
ITEM_ADDRESS Data Type: STRING. Full address of your offer or service, including postal code. This will be used to identify the closest product to the user when there are multiple offers in the feed that are relevant to the user.
PRICE Data Type: STRING. Price to be shown in the ad. Example: "100.00 USD"
FORMATTED_PRICE Data Type: STRING. Formatted price to be shown in the ad. Example: "Starting at $100.00 USD", "$80 - $100"
SALE_PRICE Data Type: STRING. Sale price to be shown in the ad. Example: "80.00 USD"
FORMATTED_SALE_PRICE Data Type: STRING. Formatted sale price to be shown in the ad. Example: "On sale for $80.00", "$60 - $80"
IMAGE_URL Data Type: URL. Image to be displayed in the ad. Highly recommended for image ads.
ITEM_CATEGORY Data Type: STRING. Used as a recommendation engine signal to serve items in the same category.
FINAL_URLS Data Type: URL_LIST. Final URLs for the ad when using Upgraded URLs. User will be redirected to these URLs when they click on an ad, or when they click on a specific product for ads that have multiple products.
FINAL_MOBILE_URLS Data Type: URL_LIST. Final mobile URLs for the ad when using Upgraded URLs.
TRACKING_URL Data Type: URL. Tracking template for the ad when using Upgraded URLs.
CONTEXTUAL_KEYWORDS Data Type: STRING_LIST. Keywords used for product retrieval.
SIMILAR_IDS Data Type: STRING_LIST. List of recommended IDs to show together with this item.
IOS_APP_STORE_ID Data Type: INT64. iOS app store ID.

CustomerMatchUploadKeyTypeEnum

Indicates what type of data are the user list's members matched from.

CustomerMatchUploadKeyType

Enum describing possible customer match upload key types.

Enums
UNSPECIFIED Not specified.
UNKNOWN Used for return value only. Represents value unknown in this version.
CONTACT_INFO Members are matched from customer info such as email address, phone number or physical address.
CRM_ID Members are matched from a user id generated and assigned by the advertiser.
MOBILE_ADVERTISING_ID Members are matched from mobile advertising ids.

DataDrivenModelStatusEnum

Container for enum indicating data driven model status.

DataDrivenModelStatus

Enumerates data driven model statuses.

Enums
UNSPECIFIED Not specified.
UNKNOWN Used for return value only. Represents value unknown in this version.
AVAILABLE The data driven model is available.
STALE The data driven model is stale. It hasn't been updated for at least 7 days. It is still being used, but will become expired if it does not get updated for 30 days.
EXPIRED The data driven model expired. It hasn't been updated for at least 30 days and cannot be used. Most commonly this is because there hasn't been the required number of events in a recent 30-day period.
NEVER_GENERATED The data driven model has never been generated. Most commonly this is because there has never been the required number of events in any 30-day period.

DayOfWeekEnum

Container for enumeration of days of the week, e.g., "Monday".

DayOfWeek

Enumerates days of the week, e.g., "Monday".

Enums
UNSPECIFIED Not specified.
UNKNOWN The value is unknown in this version.
MONDAY Monday.
TUESDAY Tuesday.
WEDNESDAY Wednesday.
THURSDAY Thursday.
FRIDAY Friday.
SATURDAY Saturday.
SUNDAY Sunday.

DeviceEnum

Container for enumeration of Google Ads devices available for targeting.

Device

Enumerates Google Ads devices available for targeting.

Enums
UNSPECIFIED Not specified.
UNKNOWN The value is unknown in this version.
MOBILE Mobile devices with full browsers.
TABLET Tablets with full browsers.
DESKTOP Computers.

DisplayAdFormatSettingEnum

Container for display ad format settings.

DisplayAdFormatSetting

Enumerates display ad format settings.

Enums
UNSPECIFIED Not specified.
UNKNOWN The value is unknown in this version.
ALL_FORMATS Text, image and native formats.
NON_NATIVE Text and image formats.
NATIVE Native format, i.e. the format rendering is controlled by the publisher and not by Google.

EducationPlaceholderFieldEnum

Values for Education placeholder fields. For more information about dynamic remarketing feeds, see https://support.google.com/google-ads/answer/6053288.

EducationPlaceholderField

Possible values for Education placeholder fields.

Enums
UNSPECIFIED Not specified.
UNKNOWN Used for return value only. Represents value unknown in this version.
PROGRAM_ID Data Type: STRING. Required. Combination of PROGRAM ID and LOCATION ID must be unique per offer.
LOCATION_ID Data Type: STRING. Combination of PROGRAM ID and LOCATION ID must be unique per offer.
PROGRAM_NAME Data Type: STRING. Required. Main headline with program name to be shown in dynamic ad.
AREA_OF_STUDY Data Type: STRING. Area of study that can be shown in dynamic ad.
PROGRAM_DESCRIPTION Data Type: STRING. Description of program that can be shown in dynamic ad.
SCHOOL_NAME Data Type: STRING. Name of school that can be shown in dynamic ad.
ADDRESS Data Type: STRING. Complete school address, including postal code.
THUMBNAIL_IMAGE_URL Data Type: URL. Image to be displayed in ads.
ALTERNATIVE_THUMBNAIL_IMAGE_URL Data Type: URL. Alternative hosted file of image to be used in the ad.
FINAL_URLS Data Type: URL_LIST. Required. Final URLs to be used in ad when using Upgraded URLs; the more specific the better (e.g. the individual URL of a specific program and its location).
FINAL_MOBILE_URLS Data Type: URL_LIST. Final mobile URLs for the ad when using Upgraded URLs.
TRACKING_URL Data Type: URL. Tracking template for the ad when using Upgraded URLs.
CONTEXTUAL_KEYWORDS Data Type: STRING_LIST. Keywords used for product retrieval.
SIMILAR_PROGRAM_IDS Data Type: STRING_LIST. List of recommended program IDs to show together with this item.
IOS_APP_STORE_ID Data Type: INT64. iOS app store ID.

FeedAttributeTypeEnum

Container for enum describing possible data types for a feed attribute.

FeedAttributeType

Possible data types for a feed attribute.

Enums
UNSPECIFIED Not specified.
UNKNOWN Used for return value only. Represents value unknown in this version.
INT64 Int64.
DOUBLE Double.
STRING String.
BOOLEAN Boolean.
URL Url.
DATE_TIME Datetime.
INT64_LIST Int64 list.
DOUBLE_LIST Double (8 bytes) list.
STRING_LIST String list.
BOOLEAN_LIST Boolean list.
URL_LIST Url list.
DATE_TIME_LIST Datetime list.
PRICE Price.

FeedItemStatusEnum

Container for enum describing possible statuses of a feed item.

FeedItemStatus

Possible statuses of a feed item.

Enums
UNSPECIFIED Not specified.
UNKNOWN Used for return value only. Represents value unknown in this version.
ENABLED Feed item is enabled.
REMOVED Feed item has been removed.

FeedLinkStatusEnum

Container for an enum describing possible statuses of a feed link.

FeedLinkStatus

Possible statuses of a feed link.

Enums
UNSPECIFIED Not specified.
UNKNOWN Used for return value only. Represents value unknown in this version.
ENABLED Feed link is enabled.
REMOVED Feed link has been removed.

FeedMappingCriterionTypeEnum

Container for enum describing possible criterion types for a feed mapping.

FeedMappingCriterionType

Possible placeholder types for a feed mapping.

Enums
UNSPECIFIED Not specified.
UNKNOWN Used for return value only. Represents value unknown in this version.
CAMPAIGN_LOCATION_TARGETS Allows campaign targeting at locations within a location feed.
DSA_PAGE_FEED Allows url targeting for your dynamic search ads within a page feed.

FeedMappingStatusEnum

Container for enum describing possible statuses of a feed mapping.

FeedMappingStatus

Possible statuses of a feed mapping.

Enums
UNSPECIFIED Not specified.
UNKNOWN Used for return value only. Represents value unknown in this version.
ENABLED Feed mapping is enabled.
REMOVED Feed mapping has been removed.

FeedOriginEnum

Container for enum describing possible values for a feed origin.

FeedOrigin

Possible values for a feed origin.

Enums
UNSPECIFIED Not specified.
UNKNOWN Used for return value only. Represents value unknown in this version.
USER The FeedAttributes for this Feed are managed by the user. Users can add FeedAttributes to this Feed.
GOOGLE The FeedAttributes for an GOOGLE Feed are created by Google. A feed of this type is maintained by Google and will have the correct attributes for the placeholder type of the feed.

FeedStatusEnum

Container for enum describing possible statuses of a feed.

FeedStatus

Possible statuses of a feed.

Enums
UNSPECIFIED Not specified.
UNKNOWN Used for return value only. Represents value unknown in this version.
ENABLED Feed is enabled.
REMOVED Feed has been removed.

FlightPlaceholderFieldEnum

Values for Flight placeholder fields. For more information about dynamic remarketing feeds, see https://support.google.com/google-ads/answer/6053288.

FlightPlaceholderField

Possible values for Flight placeholder fields.

Enums
UNSPECIFIED Not specified.
UNKNOWN Used for return value only. Represents value unknown in this version.
DESTINATION_ID Data Type: STRING. Required. Destination id. Example: PAR, LON. For feed items that only have destination id, destination id must be a unique key. For feed items that have both destination id and origin id, then the combination must be a unique key.
ORIGIN_ID Data Type: STRING. Origin id. Example: PAR, LON. Optional. Combination of destination id and origin id must be unique per offer.
FLIGHT_DESCRIPTION Data Type: STRING. Required. Main headline with product name to be shown in dynamic ad.
ORIGIN_NAME Data Type: STRING. Shorter names are recommended.
DESTINATION_NAME Data Type: STRING. Shorter names are recommended.
FLIGHT_PRICE Data Type: STRING. Price to be shown in the ad. Example: "100.00 USD"
FORMATTED_PRICE Data Type: STRING. Formatted price to be shown in the ad. Example: "Starting at $100.00 USD", "$80 - $100"
FLIGHT_SALE_PRICE Data Type: STRING. Sale price to be shown in the ad. Example: "80.00 USD"
FORMATTED_SALE_PRICE Data Type: STRING. Formatted sale price to be shown in the ad. Example: "On sale for $80.00", "$60 - $80"
IMAGE_URL Data Type: URL. Image to be displayed in the ad.
FINAL_URLS Data Type: URL_LIST. Required. Final URLs for the ad when using Upgraded URLs. User will be redirected to these URLs when they click on an ad, or when they click on a specific flight for ads that show multiple flights.
FINAL_MOBILE_URLS Data Type: URL_LIST. Final mobile URLs for the ad when using Upgraded URLs.
TRACKING_URL Data Type: URL. Tracking template for the ad when using Upgraded URLs.
SIMILAR_DESTINATION_IDS Data Type: STRING_LIST. List of recommended destination IDs to show together with this item.
IOS_APP_STORE_ID Data Type: INT64. iOS app store ID.

FrequencyCapEventTypeEnum

Container for enum describing the type of event that the cap applies to.

FrequencyCapEventType

The type of event that the cap applies to (e.g. impression).

Enums
UNSPECIFIED Not specified.
UNKNOWN Used for return value only. Represents value unknown in this version.
IMPRESSION The cap applies on ad impressions.
VIDEO_VIEW The cap applies on video ad views.

FrequencyCapLevelEnum

Container for enum describing the level on which the cap is to be applied.

FrequencyCapLevel

The level on which the cap is to be applied (e.g ad group ad, ad group). Cap is applied to all the resources of this level.

Enums
UNSPECIFIED Not specified.
UNKNOWN Used for return value only. Represents value unknown in this version.
AD_GROUP_AD The cap is applied at the ad group ad level.
AD_GROUP The cap is applied at the ad group level.
CAMPAIGN The cap is applied at the campaign level.

FrequencyCapTimeUnitEnum

Container for enum describing the unit of time the cap is defined at.

FrequencyCapTimeUnit

Unit of time the cap is defined at (e.g. day, week).

Enums
UNSPECIFIED Not specified.
UNKNOWN Used for return value only. Represents value unknown in this version.
DAY The cap would define limit per one day.
WEEK The cap would define limit per one week.
MONTH The cap would define limit per one month.

GenderTypeEnum

Container for enum describing the type of demographic genders.

GenderType

The type of demographic genders (e.g. female).

Enums
UNSPECIFIED Not specified.
UNKNOWN Used for return value only. Represents value unknown in this version.
MALE Male.
FEMALE Female.
UNDETERMINED Undetermined gender.

GeoTargetConstantStatusEnum

Container for describing the status of a geo target constant.

GeoTargetConstantStatus

The possible statuses of a geo target constant.

Enums
UNSPECIFIED No value has been specified.
UNKNOWN

The received value is not known in this version.

This is a response-only value.

ENABLED The geo target constant is valid.
REMOVAL_PLANNED The geo target constant is obsolete and will be removed.

GeoTargetingRestrictionEnum

Message describing feed item geo targeting restriction.

GeoTargetingRestriction

A restriction used to determine if the request context's geo should be matched.

Enums
UNSPECIFIED Not specified.
UNKNOWN Used for return value only. Represents value unknown in this version.
LOCATION_OF_PRESENCE Indicates that request context should match the physical location of the user.

GoogleAdsFieldCategoryEnum

Container for enum that determines if the described artifact is a resource or a field, and if it is a field, when it segments search queries.

GoogleAdsFieldCategory

The category of the artifact.

Enums
UNSPECIFIED Unspecified
UNKNOWN Unknown
RESOURCE The described artifact is a resource.
ATTRIBUTE The described artifact is a field and is an attribute of a resource. Including a resource attribute field in a query may segment the query if the resource to which it is attributed segments the resource found in the FROM clause.
SEGMENT The described artifact is a field and always segments search queries.
METRIC The described artifact is a field and is a metric. It never segments search queries.

GoogleAdsFieldDataTypeEnum

Container holding the various data types.

GoogleAdsFieldDataType

These are the various types a GoogleAdsService artifact may take on.

Enums
UNSPECIFIED Unspecified
UNKNOWN Unknown
BOOLEAN

Maps to google.protobuf.BoolValue

Applicable operators: =, !=

DATE

Maps to google.protobuf.StringValue. It can be compared using the set of operators specific to dates however.

Applicable operators: =, <, >, <=, >=, BETWEEN, DURING, and IN

DOUBLE

Maps to google.protobuf.DoubleValue

Applicable operators: =, !=, <, >, IN, NOT IN

ENUM

Maps to an enum. It's specific definition can be found at type_url.

Applicable operators: =, !=, IN, NOT IN

FLOAT

Maps to google.protobuf.FloatValue

Applicable operators: =, !=, <, >, IN, NOT IN

INT32

Maps to google.protobuf.Int32Value

Applicable operators: =, !=, <, >, <=, >=, BETWEEN, IN, NOT IN

INT64

Maps to google.protobuf.Int64Value

Applicable operators: =, !=, <, >, <=, >=, BETWEEN, IN, NOT IN

MESSAGE

Maps to a protocol buffer message type. The data type's details can be found in type_url.

No operators work with MESSAGE fields.

RESOURCE_NAME

Maps to google.protobuf.StringValue. Represents the resource name (unique id) of a resource or one of its foreign keys.

No operators work with RESOURCE_NAME fields.

STRING

Maps to google.protobuf.StringValue.

Applicable operators: =, !=, LIKE, NOT LIKE, IN, NOT IN

HotelDateSelectionTypeEnum

Container for enum describing possible hotel date selection types

HotelDateSelectionType

Enum describing possible hotel date selection types.

Enums
UNSPECIFIED Not specified.
UNKNOWN Used for return value only. Represents value unknown in this version.
DEFAULT_SELECTION Dates selected by default.
USER_SELECTED Dates selected by the user.

HotelPlaceholderFieldEnum

Values for Hotel placeholder fields. For more information about dynamic remarketing feeds, see https://support.google.com/google-ads/answer/6053288.

HotelPlaceholderField

Possible values for Hotel placeholder fields.

Enums
UNSPECIFIED Not specified.
UNKNOWN Used for return value only. Represents value unknown in this version.
PROPERTY_ID Data Type: STRING. Required. Unique ID.
PROPERTY_NAME Data Type: STRING. Required. Main headline with property name to be shown in dynamic ad.
DESTINATION_NAME Data Type: STRING. Name of destination to be shown in dynamic ad.
DESCRIPTION Data Type: STRING. Description of destination to be shown in dynamic ad.
ADDRESS Data Type: STRING. Complete property address, including postal code.
PRICE Data Type: STRING. Price to be shown in the ad. Example: "100.00 USD"
FORMATTED_PRICE Data Type: STRING. Formatted price to be shown in the ad. Example: "Starting at $100.00 USD", "$80 - $100"
SALE_PRICE Data Type: STRING. Sale price to be shown in the ad. Example: "80.00 USD"
FORMATTED_SALE_PRICE Data Type: STRING. Formatted sale price to be shown in the ad. Example: "On sale for $80.00", "$60 - $80"
IMAGE_URL Data Type: URL. Image to be displayed in the ad.
CATEGORY Data Type: STRING. Category of property used to group like items together for recommendation engine.
STAR_RATING Data Type: INT64. Star rating (1 to 5) used to group like items together for recommendation engine.
CONTEXTUAL_KEYWORDS Data Type: STRING_LIST. Keywords used for product retrieval.
FINAL_URLS Data Type: URL_LIST. Required. Final URLs for the ad when using Upgraded URLs. User will be redirected to these URLs when they click on an ad, or when they click on a specific flight for ads that show multiple flights.
FINAL_MOBILE_URLS Data Type: URL_LIST. Final mobile URLs for the ad when using Upgraded URLs.
TRACKING_URL Data Type: URL. Tracking template for the ad when using Upgraded URLs.
SIMILAR_PROPERTY_IDS Data Type: STRING_LIST. List of recommended property IDs to show together with this item.
IOS_APP_STORE_ID Data Type: INT64. iOS app store ID.

IncomeRangeTypeEnum

Container for enum describing the type of demographic income ranges.

IncomeRangeType

The type of demographic income ranges (e.g. between 0% to 50%).

Enums
UNSPECIFIED Not specified.
UNKNOWN Used for return value only. Represents value unknown in this version.
INCOME_RANGE_0_50 0%-50%.
INCOME_RANGE_50_60 50% to 60%.
INCOME_RANGE_60_70 60% to 70%.
INCOME_RANGE_70_80 70% to 80%.
INCOME_RANGE_80_90 80% to 90%.
INCOME_RANGE_90_UP Greater than 90%.
INCOME_RANGE_UNDETERMINED Undetermined income range.

InteractionTypeEnum

Container for enum describing possible interaction types.

InteractionType

Enum describing possible interaction types.

Enums
UNSPECIFIED Not specified.
UNKNOWN Used for return value only. Represents value unknown in this version.
CALLS Calls.

JobPlaceholderFieldEnum

Values for Job placeholder fields. For more information about dynamic remarketing feeds, see https://support.google.com/google-ads/answer/6053288.

JobPlaceholderField

Possible values for Job placeholder fields.

Enums
UNSPECIFIED Not specified.
UNKNOWN Used for return value only. Represents value unknown in this version.
JOB_ID Data Type: STRING. Required. If only JOB_ID is specified, then it must be unique. If both JOB_ID and LOCATION_ID are specified, then the pair must be unique. ID) pair must be unique.
LOCATION_ID Data Type: STRING. Combination of JOB_ID and LOCATION_ID must be unique per offer.
TITLE Data Type: STRING. Required. Main headline with job title to be shown in dynamic ad.
SUBTITLE Data Type: STRING. Job subtitle to be shown in dynamic ad.
DESCRIPTION Data Type: STRING. Description of job to be shown in dynamic ad.
IMAGE_URL Data Type: URL. Image to be displayed in the ad. Highly recommended for image ads.
CATEGORY Data Type: STRING. Category of property used to group like items together for recommendation engine.
CONTEXTUAL_KEYWORDS Data Type: STRING_LIST. Keywords used for product retrieval.
ADDRESS Data Type: STRING. Complete property address, including postal code.
SALARY Data Type: STRING. Salary or salary range of job to be shown in dynamic ad.
FINAL_URLS Data Type: URL_LIST. Required. Final URLs to be used in ad when using Upgraded URLs; the more specific the better (e.g. the individual URL of a specific job and its location).
FINAL_MOBILE_URLS Data Type: URL_LIST. Final mobile URLs for the ad when using Upgraded URLs.
TRACKING_URL Data Type: URL. Tracking template for the ad when using Upgraded URLs.
SIMILAR_JOB_IDS Data Type: STRING_LIST. List of recommended job IDs to show together with this item.
IOS_APP_STORE_ID Data Type: INT64. iOS app store ID.

KeywordMatchTypeEnum

Message describing Keyword match types.

KeywordMatchType

Possible Keyword match types.

Enums
UNSPECIFIED Not specified.
UNKNOWN Used for return value only. Represents value unknown in this version.
EXACT Exact match.
PHRASE Phrase match.
BROAD Broad match.

KeywordPlanCompetitionLevelEnum

Container for enumeration of keyword competition levels. The competition level indicates how competitive ad placement is for a keyword and is determined by the number of advertisers bidding on that keyword relative to all keywords across Google. The competition level can depend on the location and Search Network targeting options you've selected.

KeywordPlanCompetitionLevel

Competition level of a keyword.

Enums
UNSPECIFIED Not specified.
UNKNOWN The value is unknown in this version.
LOW Low competition.
MEDIUM Medium competition.
HIGH High competition.

KeywordPlanForecastIntervalEnum

Container for enumeration of forecast intervals.

KeywordPlanForecastInterval

Forecast intervals.

Enums
UNSPECIFIED Not specified.
UNKNOWN The value is unknown in this version.
NEXT_WEEK The next week date range for keyword plan. The next week is based on the default locale of the user's account and is mostly SUN-SAT or MON-SUN. This can be different from next-7 days.
NEXT_MONTH The next month date range for keyword plan.
NEXT_QUARTER The next quarter date range for keyword plan.

KeywordPlanNetworkEnum

Container for enumeration of keyword plan forecastable network types.

KeywordPlanNetwork

Enumerates keyword plan forecastable network types.

Enums
UNSPECIFIED Not specified.
UNKNOWN The value is unknown in this version.
GOOGLE_SEARCH_AND_PARTNERS Google Search + Search partners.

ListingCustomAttributeIndexEnum

Container for enum describing the index of the listing custom attribute.

ListingCustomAttributeIndex

The index of the listing custom attribute.

Enums
UNSPECIFIED Not specified.
UNKNOWN Used for return value only. Represents value unknown in this version.
CUSTOM_ATTRIBUTE_0 First listing custom attribute.
CUSTOM_ATTRIBUTE_1 Second listing custom attribute.
CUSTOM_ATTRIBUTE_2 Third listing custom attribute.
CUSTOM_ATTRIBUTE_3 Fourth listing custom attribute.
CUSTOM_ATTRIBUTE_4 Fifth listing custom attribute.

ListingGroupTypeEnum

Container for enum describing the type of the listing group.

ListingGroupType

The type of the listing group.

Enums
UNSPECIFIED Not specified.
UNKNOWN Used for return value only. Represents value unknown in this version.
SUBDIVISION Subdivision of products along some listing dimension. These nodes are not used by serving to target listing entries, but is purely to define the structure of the tree.
UNIT Listing group unit that defines a bid.

LocalPlaceholderFieldEnum

Values for Local placeholder fields. For more information about dynamic remarketing feeds, see https://support.google.com/google-ads/answer/6053288.

LocalPlaceholderField

Possible values for Local placeholder fields.

Enums
UNSPECIFIED Not specified.
UNKNOWN Used for return value only. Represents value unknown in this version.
DEAL_ID Data Type: STRING. Required. Unique ID.
DEAL_NAME Data Type: STRING. Required. Main headline with local deal title to be shown in dynamic ad.
SUBTITLE Data Type: STRING. Local deal subtitle to be shown in dynamic ad.
DESCRIPTION Data Type: STRING. Description of local deal to be shown in dynamic ad.
PRICE Data Type: STRING. Price to be shown in the ad. Highly recommended for dynamic ads. Example: "100.00 USD"
FORMATTED_PRICE Data Type: STRING. Formatted price to be shown in the ad. Example: "Starting at $100.00 USD", "$80 - $100"
SALE_PRICE Data Type: STRING. Sale price to be shown in the ad. Example: "80.00 USD"
FORMATTED_SALE_PRICE Data Type: STRING. Formatted sale price to be shown in the ad. Example: "On sale for $80.00", "$60 - $80"
IMAGE_URL Data Type: URL. Image to be displayed in the ad.
ADDRESS Data Type: STRING. Complete property address, including postal code.
CATEGORY Data Type: STRING. Category of local deal used to group like items together for recommendation engine.
CONTEXTUAL_KEYWORDS Data Type: STRING_LIST. Keywords used for product retrieval.
FINAL_URLS Data Type: URL_LIST. Required. Final URLs to be used in ad when using Upgraded URLs; the more specific the better (e.g. the individual URL of a specific local deal and its location).
FINAL_MOBILE_URLS Data Type: URL_LIST. Final mobile URLs for the ad when using Upgraded URLs.
TRACKING_URL Data Type: URL. Tracking template for the ad when using Upgraded URLs.
SIMILAR_DEAL_IDS Data Type: STRING_LIST. List of recommended local deal IDs to show together with this item.
IOS_APP_STORE_ID Data Type: INT64. iOS app store ID.

ManagerLinkStatusEnum

Container for enum describing possible status of a manager and client link.

ManagerLinkStatus

Possible statuses of a link.

Enums
UNSPECIFIED Not specified.
UNKNOWN Used for return value only. Represents value unknown in this version.
ACTIVE Indicates current in-effect relationship
INACTIVE Indicates terminated relationship
PENDING Indicates relationship has been requested by manager, but the client hasn't accepted yet.
REFUSED Relationship was requested by the manager, but the client has refused.
CANCELED Indicates relationship has been requested by manager, but manager canceled it.

MediaTypeEnum

Container for enum describing the types of media.

MediaType

The type of media.

Enums
UNSPECIFIED The media type has not been specified.
UNKNOWN

The received value is not known in this version.

This is a response-only value.

IMAGE Static image, used for image ad.
ICON Small image, used for map ad.
MEDIA_BUNDLE ZIP file, used in fields of template ads.
AUDIO Audio file.
VIDEO Video file.
DYNAMIC_IMAGE Animated image, such as animated GIF.

MessagePlaceholderFieldEnum

Values for Message placeholder fields.

MessagePlaceholderField

Possible values for Message placeholder fields.

Enums
UNSPECIFIED Not specified.
UNKNOWN Used for return value only. Represents value unknown in this version.
BUSINESS_NAME Data Type: STRING. The name of your business.
COUNTRY_CODE Data Type: STRING. Country code of phone number.
PHONE_NUMBER Data Type: STRING. A phone number that's capable of sending and receiving text messages.
MESSAGE_EXTENSION_TEXT Data Type: STRING. The text that will go in your click-to-message ad.
MESSAGE_TEXT Data Type: STRING. The message text automatically shows in people's messaging apps when they tap to send you a message.

MimeTypeEnum

Container for enum describing the mime types.

MimeType

The mime type

Enums
UNSPECIFIED The mime type has not been specified.
UNKNOWN

The received value is not known in this version.

This is a response-only value.

IMAGE_JPEG MIME type of image/jpeg.
IMAGE_GIF MIME type of image/gif.
IMAGE_PNG MIME type of image/png.
FLASH MIME type of application/x-shockwave-flash.
TEXT_HTML MIME type of text/html.
PDF MIME type of application/pdf.
MSWORD MIME type of application/msword.
MSEXCEL MIME type of application/vnd.ms-excel.
RTF MIME type of application/rtf.
AUDIO_WAV MIME type of audio/wav.
AUDIO_MP3 MIME type of audio/mp3.
HTML5_AD_ZIP MIME type of application/x-html5-ad-zip.

MinuteOfHourEnum

Container for enumeration of quarter-hours.

MinuteOfHour

Enumerates of quarter-hours. E.g. "FIFTEEN"

Enums
UNSPECIFIED Not specified.
UNKNOWN The value is unknown in this version.
ZERO Zero minutes past the hour.
FIFTEEN Fifteen minutes past the hour.
THIRTY Thirty minutes past the hour.
FORTY_FIVE Forty-five minutes past the hour.

MonthOfYearEnum

Container for enumeration of months of the year, e.g., "January".

MonthOfYear

Enumerates months of the year, e.g., "January".

Enums
UNSPECIFIED Not specified.
UNKNOWN The value is unknown in this version.
JANUARY January.
FEBRUARY February.
MARCH March.
APRIL April.
MAY May.
JUNE June.
JULY July.
AUGUST August.
SEPTEMBER September.
OCTOBER October.
NOVEMBER November.
DECEMBER December.

PageOnePromotedStrategyGoalEnum

Container for enum describing possible strategy goals: where impressions are desired to be shown on search result pages.

PageOnePromotedStrategyGoal

Enum describing possible strategy goals.

Enums
UNSPECIFIED Not specified.
UNKNOWN Used for return value only. Represents value unknown in this version.
FIRST_PAGE First page on google.com.
FIRST_PAGE_PROMOTED Top slots of the first page on google.com.

ParentalStatusTypeEnum

Container for enum describing the type of demographic parental statuses.

ParentalStatusType

The type of parental statuses (e.g. not a parent).

Enums
UNSPECIFIED Not specified.
UNKNOWN Used for return value only. Represents value unknown in this version.
PARENT Parent.
NOT_A_PARENT Not a parent.
UNDETERMINED Undetermined parental status.

PlaceholderTypeEnum

Container for enum describing possible placeholder types for a feed mapping.

PlaceholderType

Possible placeholder types for a feed mapping.

Enums
UNSPECIFIED Not specified.
UNKNOWN Used for return value only. Represents value unknown in this version.
CALL Call.
APP App.
LOCATION Location.
AFFILIATE_LOCATION Affiliate location.
CALLOUT Callout.
STRUCTURED_SNIPPET Structured snippet.
MESSAGE Message.
PRICE Price.
PROMOTION Promotion.
AD_CUSTOMIZER Ad customizer.
DYNAMIC_EDUCATION Dynamic education.
DYNAMIC_FLIGHT Dynamic flights.
DYNAMIC_CUSTOM Dynamic custom.
DYNAMIC_HOTEL Dynamic hotels.
DYNAMIC_REAL_ESTATE Dynamic real estate.
DYNAMIC_TRAVEL Dynamic travel.
DYNAMIC_LOCAL Dynamic local.
DYNAMIC_JOB Dynamic jobs.

PolicyApprovalStatusEnum

Container for enum describing possible policy approval statuses.

PolicyApprovalStatus

The possible policy approval statuses. When there are several approval statuses available the most severe one will be used. The order of severity is DISAPPROVED, AREA_OF_INTEREST_ONLY, APPROVED_LIMITED and APPROVED.

Enums
UNSPECIFIED No value has been specified.
UNKNOWN

The received value is not known in this version.

This is a response-only value.

DISAPPROVED Will not serve.
APPROVED_LIMITED Serves with restrictions.
APPROVED Serves without restrictions.
AREA_OF_INTEREST_ONLY Will not serve in targeted countries, but may serve for users who are searching for information about the targeted countries.

PolicyReviewStatusEnum

Container for enum describing possible policy review statuses.

PolicyReviewStatus

The possible policy review statuses.

Enums
UNSPECIFIED No value has been specified.
UNKNOWN

The received value is not known in this version.

This is a response-only value.

REVIEW_IN_PROGRESS Currently under review.
REVIEWED Primary review complete. Other reviews may be continuing.
UNDER_APPEAL The resource has been resubmitted for approval or its policy decision has been appealed.

PolicyTopicEntryTypeEnum

Container for enum describing possible policy topic entry types.

PolicyTopicEntryType

The possible policy topic entry types.

Enums
UNSPECIFIED No value has been specified.
UNKNOWN

The received value is not known in this version.

This is a response-only value.

PROHIBITED The resource will not be served.
LIMITED The resource will not be served under some circumstances.
DESCRIPTIVE May be of interest, but does not limit how the resource is served.
BROADENING Could increase coverage beyond normal.
AREA_OF_INTEREST_ONLY Constrained for all targeted countries, but may serve in other countries through area of interest.

PolicyTopicEvidenceDestinationMismatchUrlTypeEnum

Container for enum describing possible policy topic evidence destination mismatch url types.

PolicyTopicEvidenceDestinationMismatchUrlType

The possible policy topic evidence destination mismatch url types.

Enums
UNSPECIFIED No value has been specified.
UNKNOWN

The received value is not known in this version.

This is a response-only value.

DISPLAY_URL The display url.
FINAL_URL The final url.
FINAL_MOBILE_URL The final mobile url.
TRACKING_URL The tracking url template, with substituted desktop url.
MOBILE_TRACKING_URL The tracking url template, with substituted mobile url.

PreferredContentTypeEnum

Container for enumeration of preferred content criterion type.

PreferredContentType

Enumerates preferred content criterion type.

Enums
UNSPECIFIED Not specified.
UNKNOWN The value is unknown in this version.
YOUTUBE_TOP_CONTENT Represents top content on YouTube.

PricePlaceholderFieldEnum

Values for Price placeholder fields.

PricePlaceholderField

Possible values for Price placeholder fields.

Enums
UNSPECIFIED Not specified.
UNKNOWN Used for return value only. Represents value unknown in this version.
TYPE Data Type: STRING. The type of your price feed. Must match one of the predefined price feed type exactly.
PRICE_QUALIFIER Data Type: STRING. The qualifier of each price. Must match one of the predefined price qualifiers exactly.
TRACKING_TEMPLATE Data Type: URL. Tracking template for the price feed when using Upgraded URLs.
LANGUAGE Data Type: STRING. Language of the price feed. Must match one of the available available locale codes exactly.
FINAL_URL_SUFFIX Data Type: STRING. Final URL suffix for the price feed when using parallel tracking.
ITEM_1_HEADER Data Type: STRING. The header of item 1 of the table.
ITEM_1_DESCRIPTION Data Type: STRING. The description of item 1 of the table.
ITEM_1_PRICE Data Type: PRICE. The price (money with currency) of item 1 of the table, e.g., 30 USD. The currency must match one of the available currencies.
ITEM_1_UNIT Data Type: STRING. The price unit of item 1 of the table. Must match one of the predefined price units.
ITEM_1_FINAL_URLS Data Type: URL_LIST. The final URLs of item 1 of the table when using Upgraded URLs.
ITEM_1_FINAL_MOBILE_URLS Data Type: URL_LIST. The final mobile URLs of item 1 of the table when using Upgraded URLs.
ITEM_2_HEADER Data Type: STRING. The header of item 2 of the table.
ITEM_2_DESCRIPTION Data Type: STRING. The description of item 2 of the table.
ITEM_2_PRICE Data Type: PRICE. The price (money with currency) of item 2 of the table, e.g., 30 USD. The currency must match one of the available currencies.
ITEM_2_UNIT Data Type: STRING. The price unit of item 2 of the table. Must match one of the predefined price units.
ITEM_2_FINAL_URLS Data Type: URL_LIST. The final URLs of item 2 of the table when using Upgraded URLs.
ITEM_2_FINAL_MOBILE_URLS Data Type: URL_LIST. The final mobile URLs of item 2 of the table when using Upgraded URLs.
ITEM_3_HEADER Data Type: STRING. The header of item 3 of the table.
ITEM_3_DESCRIPTION Data Type: STRING. The description of item 3 of the table.
ITEM_3_PRICE Data Type: PRICE. The price (money with currency) of item 3 of the table, e.g., 30 USD. The currency must match one of the available currencies.
ITEM_3_UNIT Data Type: STRING. The price unit of item 3 of the table. Must match one of the predefined price units.
ITEM_3_FINAL_URLS Data Type: URL_LIST. The final URLs of item 3 of the table when using Upgraded URLs.
ITEM_3_FINAL_MOBILE_URLS Data Type: URL_LIST. The final mobile URLs of item 3 of the table when using Upgraded URLs.
ITEM_4_HEADER Data Type: STRING. The header of item 4 of the table.
ITEM_4_DESCRIPTION Data Type: STRING. The description of item 4 of the table.
ITEM_4_PRICE Data Type: PRICE. The price (money with currency) of item 4 of the table, e.g., 30 USD. The currency must match one of the available currencies.
ITEM_4_UNIT Data Type: STRING. The price unit of item 4 of the table. Must match one of the predefined price units.
ITEM_4_FINAL_URLS Data Type: URL_LIST. The final URLs of item 4 of the table when using Upgraded URLs.
ITEM_4_FINAL_MOBILE_URLS Data Type: URL_LIST. The final mobile URLs of item 4 of the table when using Upgraded URLs.
ITEM_5_HEADER Data Type: STRING. The header of item 5 of the table.
ITEM_5_DESCRIPTION Data Type: STRING. The description of item 5 of the table.
ITEM_5_PRICE Data Type: PRICE. The price (money with currency) of item 5 of the table, e.g., 30 USD. The currency must match one of the available currencies.
ITEM_5_UNIT Data Type: STRING. The price unit of item 5 of the table. Must match one of the predefined price units.
ITEM_5_FINAL_URLS Data Type: URL_LIST. The final URLs of item 5 of the table when using Upgraded URLs.
ITEM_5_FINAL_MOBILE_URLS Data Type: URL_LIST. The final mobile URLs of item 5 of the table when using Upgraded URLs.
ITEM_6_HEADER Data Type: STRING. The header of item 6 of the table.
ITEM_6_DESCRIPTION Data Type: STRING. The description of item 6 of the table.
ITEM_6_PRICE Data Type: PRICE. The price (money with currency) of item 6 of the table, e.g., 30 USD. The currency must match one of the available currencies.
ITEM_6_UNIT Data Type: STRING. The price unit of item 6 of the table. Must match one of the predefined price units.
ITEM_6_FINAL_URLS Data Type: URL_LIST. The final URLs of item 6 of the table when using Upgraded URLs.
ITEM_6_FINAL_MOBILE_URLS Data Type: URL_LIST. The final mobile URLs of item 6 of the table when using Upgraded URLs.
ITEM_7_HEADER Data Type: STRING. The header of item 7 of the table.
ITEM_7_DESCRIPTION Data Type: STRING. The description of item 7 of the table.
ITEM_7_PRICE Data Type: PRICE. The price (money with currency) of item 7 of the table, e.g., 30 USD. The currency must match one of the available currencies.
ITEM_7_UNIT Data Type: STRING. The price unit of item 7 of the table. Must match one of the predefined price units.
ITEM_7_FINAL_URLS Data Type: URL_LIST. The final URLs of item 7 of the table when using Upgraded URLs.
ITEM_7_FINAL_MOBILE_URLS Data Type: URL_LIST. The final mobile URLs of item 7 of the table when using Upgraded URLs.
ITEM_8_HEADER Data Type: STRING. The header of item 8 of the table.
ITEM_8_DESCRIPTION Data Type: STRING. The description of item 8 of the table.
ITEM_8_PRICE Data Type: PRICE. The price (money with currency) of item 8 of the table, e.g., 30 USD. The currency must match one of the available currencies.
ITEM_8_UNIT Data Type: STRING. The price unit of item 8 of the table. Must match one of the predefined price units.
ITEM_8_FINAL_URLS Data Type: URL_LIST. The final URLs of item 8 of the table when using Upgraded URLs.
ITEM_8_FINAL_MOBILE_URLS Data Type: URL_LIST. The final mobile URLs of item 8 of the table when using Upgraded URLs.

ProductChannelEnum

Locality of a product offer.

ProductChannel

Enum describing the locality of a product offer.

Enums
UNSPECIFIED Not specified.
UNKNOWN Used for return value only. Represents value unknown in this version.
ONLINE The item is sold online.
LOCAL The item is sold in local stores.

ProductChannelExclusivityEnum

Availability of a product offer.

ProductChannelExclusivity

Enum describing the availability of a product offer.

Enums
UNSPECIFIED Not specified.
UNKNOWN Used for return value only. Represents value unknown in this version.
SINGLE_CHANNEL The item is sold through one channel only, either local stores or online as indicated by its ProductChannel.
MULTI_CHANNEL The item is matched to its online or local stores counterpart, indicating it is available for purchase in both ShoppingProductChannels.

ProductConditionEnum

Condition of a product offer.

ProductCondition

Enum describing the condition of a product offer.

Enums
UNSPECIFIED Not specified.
UNKNOWN Used for return value only. Represents value unknown in this version.
NEW The product condition is new.
REFURBISHED The product condition is refurbished.
USED The product condition is used.

ProductTypeLevelEnum

Level of the type of a product offer.

ProductTypeLevel

Enum describing the level of the type of a product offer.

Enums
UNSPECIFIED Not specified.
UNKNOWN Used for return value only. Represents value unknown in this version.
PRODUCT_TYPE_L1 Level 1.
PRODUCT_TYPE_L2 Level 2.
PRODUCT_TYPE_L3 Level 3.
PRODUCT_TYPE_L4 Level 4.
PRODUCT_TYPE_L5 Level 5.

PromotionPlaceholderFieldEnum

Values for Promotion placeholder fields.

PromotionPlaceholderField

Possible values for Promotion placeholder fields.

Enums
UNSPECIFIED Not specified.
UNKNOWN Used for return value only. Represents value unknown in this version.
PROMOTION_TARGET Data Type: STRING. The text that appears on the ad when the extension is shown.
DISCOUNT_MODIFIER Data Type: STRING. Allows you to add "up to" phrase to the promotion, in case you have variable promotion rates.
PERCENT_OFF Data Type: INT64. Takes a value in micros, where 1 million micros represents 1%, and is shown as a percentage when rendered.
MONEY_AMOUNT_OFF Data Type: PRICE. Requires a currency and an amount of money.
PROMOTION_CODE Data Type: STRING. A string that the user enters to get the discount.
ORDERS_OVER_AMOUNT Data Type: PRICE. A minimum spend before the user qualifies for the promotion.
PROMOTION_START Data Type: DATE. The start date of the promotion.
PROMOTION_END Data Type: DATE. The end date of the promotion.
OCCASION Data Type: STRING. Describes the associated event for the promotion using one of the PromotionExtensionOccasion enum values, for example NEW_YEARS.
FINAL_URLS Data Type: URL_LIST. Final URLs to be used in the ad when using Upgraded URLs.
FINAL_MOBILE_URLS Data Type: URL_LIST. Final mobile URLs for the ad when using Upgraded URLs.
TRACKING_URL Data Type: URL. Tracking template for the ad when using Upgraded URLs.
LANGUAGE Data Type: STRING. A string represented by a language code for the promotion.
FINAL_URL_SUFFIX Data Type: STRING. Final URL suffix for the ad when using parallel tracking.

ProximityRadiusUnitsEnum

Container for enum describing unit of radius in proximity.

ProximityRadiusUnits

The unit of radius distance in proximity (e.g. MILES)

Enums
UNSPECIFIED Not specified.
UNKNOWN Used for return value only. Represents value unknown in this version.
MILES Miles
KILOMETERS Kilometers

QualityScoreBucketEnum

The relative performance compared to other advertisers.

QualityScoreBucket

Enum listing the possible quality score buckets.

Enums
UNSPECIFIED Not specified.
UNKNOWN Used for return value only. Represents value unknown in this version.
BELOW_AVERAGE Quality of the creative is below average.
AVERAGE Quality of the creative is average.
ABOVE_AVERAGE Quality of the creative is above average.

RealEstatePlaceholderFieldEnum

Values for Real Estate placeholder fields. For more information about dynamic remarketing feeds, see https://support.google.com/google-ads/answer/6053288.

RealEstatePlaceholderField

Possible values for Real Estate placeholder fields.

Enums
UNSPECIFIED Not specified.
UNKNOWN Used for return value only. Represents value unknown in this version.
LISTING_ID Data Type: STRING. Unique ID.
LISTING_NAME Data Type: STRING. Main headline with listing name to be shown in dynamic ad.
CITY_NAME Data Type: STRING. City name to be shown in dynamic ad.
DESCRIPTION Data Type: STRING. Description of listing to be shown in dynamic ad.
ADDRESS Data Type: STRING. Complete listing address, including postal code.
PRICE Data Type: STRING. Price to be shown in the ad. Example: "100.00 USD"
FORMATTED_PRICE Data Type: STRING. Formatted price to be shown in the ad. Example: "Starting at $100.00 USD", "$80 - $100"
IMAGE_URL Data Type: URL. Image to be displayed in the ad.
PROPERTY_TYPE Data Type: STRING. Type of property (house, condo, apartment, etc.) used to group like items together for recommendation engine.
LISTING_TYPE Data Type: STRING. Type of listing (resale, rental, foreclosure, etc.) used to group like items together for recommendation engine.
CONTEXTUAL_KEYWORDS Data Type: STRING_LIST. Keywords used for product retrieval.
FINAL_URLS Data Type: URL_LIST. Final URLs to be used in ad when using Upgraded URLs; the more specific the better (e.g. the individual URL of a specific listing and its location).
FINAL_MOBILE_URLS Data Type: URL_LIST. Final mobile URLs for the ad when using Upgraded URLs.
TRACKING_URL Data Type: URL. Tracking template for the ad when using Upgraded URLs.
SIMILAR_LISTING_IDS Data Type: STRING_LIST. List of recommended listing IDs to show together with this item.
IOS_APP_STORE_ID Data Type: INT64. iOS app store ID.

RecommendationTypeEnum

Container for enum describing types of recommendations.

RecommendationType

Types of recommendations.

Enums
UNSPECIFIED Not specified.
UNKNOWN Used for return value only. Represents value unknown in this version.
CAMPAIGN_BUDGET Budget recommendation for budget constrained campaigns.
KEYWORD Keyword recommendation.
TEXT_AD Recommendation to add a new text ad.
TARGET_CPA_OPT_IN Recommendation to update a campaign to use a Target CPA bidding strategy.
MAXIMIZE_CONVERSIONS_OPT_IN Recommendation to update a campaign to use the Maximize Conversions bidding strategy.
ENHANCED_CPC_OPT_IN Recommendation to enable Enhanced Cost Per Click for a campaign.
SEARCH_PARTNERS_OPT_IN Recommendation to start showing your campaign's ads on Google Search Partners Websites.
MAXIMIZE_CLICKS_OPT_IN Recommendation to update a campaign to use a Maximize Clicks bidding strategy.
OPTIMIZE_AD_ROTATION Recommendation to start using the "Optimize" ad rotation setting for the given ad group.

SearchTermMatchTypeEnum

Container for enum describing match types for a keyword triggering an ad.

SearchTermMatchType

Possible match types for a keyword triggering an ad, including variants.

Enums
UNSPECIFIED Not specified.
UNKNOWN Used for return value only. Represents value unknown in this version.
BROAD Broad match.
EXACT Exact match.
PHRASE Phrase match.
NEAR_EXACT Exact match (close variant).
NEAR_PHRASE Phrase match (close variant).

SearchTermTargetingStatusEnum

Container for enum indicating whether a search term is one of your targeted or excluded keywords.

SearchTermTargetingStatus

Indicates whether the search term is one of your targeted or excluded keywords.

Enums
UNSPECIFIED Not specified.
UNKNOWN Used for return value only. Represents value unknown in this version.
ADDED Search term is added to targeted keywords.
EXCLUDED Search term matches a negative keyword.
ADDED_EXCLUDED Search term has been both added and excluded.
NONE Search term is neither targeted nor excluded.

SharedSetStatusEnum

Container for enum describing types of shared set statuses.

SharedSetStatus

Enum listing the possible shared set statuses.

Enums
UNSPECIFIED Not specified.
UNKNOWN Used for return value only. Represents value unknown in this version.
ENABLED The shared set is enabled.
REMOVED The shared set is removed and can no longer be used.

SharedSetTypeEnum

Container for enum describing types of shared sets.

SharedSetType

Enum listing the possible shared set types.

Enums
UNSPECIFIED Not specified.
UNKNOWN Used for return value only. Represents value unknown in this version.
NEGATIVE_KEYWORDS A set of keywords that can be excluded from targeting.
NEGATIVE_PLACEMENTS A set of placements that can be excluded from targeting.

SitelinkPlaceholderFieldEnum

Values for Sitelink placeholder fields.

SitelinkPlaceholderField

Possible values for Sitelink placeholder fields.

Enums
UNSPECIFIED Not specified.
UNKNOWN Used for return value only. Represents value unknown in this version.
TEXT Data Type: STRING. The link text for your sitelink.
LINE_1 Data Type: STRING. First line of the sitelink description.
LINE_2 Data Type: STRING. Second line of the sitelink description.
FINAL_URLS Data Type: URL_LIST. Final URLs for the sitelink when using Upgraded URLs.
FINAL_MOBILE_URLS Data Type: URL_LIST. Final Mobile URLs for the sitelink when using Upgraded URLs.
TRACKING_URL Data Type: URL. Tracking template for the sitelink when using Upgraded URLs.
FINAL_URL_SUFFIX Data Type: STRING. Final URL suffix for sitelink when using parallel tracking.

SlotEnum

Container for enumeration of possible positions of the Ad.

Slot

Enumerates possible positions of the Ad.

Enums
UNSPECIFIED Not specified.
UNKNOWN The value is unknown in this version.
SEARCH_SIDE Google search: Side.
SEARCH_TOP Google search: Top.
SEARCH_OTHER Google search: Other.
CONTENT Google Display Network.
SEARCH_PARTNER_TOP Search partners: Top.
SEARCH_PARTNER_OTHER Search partners: Other.
MIXED Cross-network.

SpendingLimitTypeEnum

Message describing spending limit types.

SpendingLimitType

The possible spending limit types used by certain resources as an alternative to absolute money values in micros.

Enums
UNSPECIFIED Not specified.
UNKNOWN Used for return value only. Represents value unknown in this version.
INFINITE Infinite, indicates unlimited spending power.

StructuredSnippetPlaceholderFieldEnum

Values for Structured Snippet placeholder fields.

StructuredSnippetPlaceholderField

Possible values for Structured Snippet placeholder fields.

Enums
UNSPECIFIED Not specified.
UNKNOWN Used for return value only. Represents value unknown in this version.
HEADER Data Type: STRING. The category of snippet of your products/services. Must match one of the predefined structured snippets headers exactly. See https://developers.google.com/adwords/api /docs/appendix/structured-snippet-headers
SNIPPETS Data Type: STRING_LIST. Text values that describe your products/services. All text must be family safe. Special or non-ASCII characters are not permitted. A snippet can be at most 25 characters.

TargetCpaOptInRecommendationGoalEnum

Container for enum describing goals for TargetCpaOptIn recommendation.

TargetCpaOptInRecommendationGoal

Goal of TargetCpaOptIn recommendation.

Enums
UNSPECIFIED Not specified.
UNKNOWN Used for return value only. Represents value unknown in this version.
SAME_COST Recommendation to set Target CPA to maintain the same cost.
SAME_CONVERSIONS Recommendation to set Target CPA to maintain the same conversions.
SAME_CPA Recommendation to set Target CPA to maintain the same CPA.
CLOSEST_CPA Recommendation to set Target CPA to a value that is as close as possible to, yet lower than, the actual CPA (computed for past 28 days).

TargetingDimensionEnum

The dimensions that can be targeted.

TargetingDimension

Enum describing possible targeting dimensions.

Enums
UNSPECIFIED Not specified.
UNKNOWN Used for return value only. Represents value unknown in this version.
KEYWORD Keyword criteria, e.g. 'mars cruise'. KEYWORD may be used as a custom bid dimension. Keywords are always a targeting dimension, so may not be set as a target "ALL" dimension with TargetRestriction.
AUDIENCE Audience criteria, which include user list, user interest, custom affinity, and custom in market.
TOPIC Topic criteria for targeting categories of content, e.g. 'category::Animals>Pets' Used for Display and Video targeting.
GENDER Criteria for targeting gender.
AGE_RANGE Criteria for targeting age ranges.
PLACEMENT Placement criteria, which include websites like 'www.flowers4sale.com', as well as mobile applications, mobile app categories, YouTube videos, and YouTube channels.
PARENTAL_STATUS Criteria for parental status targeting.
INCOME_RANGE Criteria for income range targeting.

TimeTypeEnum

Message describing time types.

TimeType

The possible time types used by certain resources as an alternative to absolute timestamps.

Enums
UNSPECIFIED Not specified.
UNKNOWN Used for return value only. Represents value unknown in this version.
NOW As soon as possible.
FOREVER An infinite point in the future.

TrackingCodePageFormatEnum

Container for enum describing the format of the web page where the tracking tag and snippet will be installed.

TrackingCodePageFormat

The format of the web page where the tracking tag and snippet will be installed.

Enums
UNSPECIFIED Not specified.
UNKNOWN Used for return value only. Represents value unknown in this version.
HTML Standard HTML page format.
AMP Google AMP page format.

TrackingCodeTypeEnum

Container for enum describing the type of the generated tag snippets for tracking conversions.

TrackingCodeType

The type of the generated tag snippets for tracking conversions.

Enums
UNSPECIFIED Not specified.
UNKNOWN Used for return value only. Represents value unknown in this version.
WEBPAGE The snippet that is fired as a result of a website page loading.
WEBPAGE_ONCLICK The snippet contains a JavaScript function which fires the tag. This function is typically called from an onClick handler added to a link or button element on the page.
CLICK_TO_CALL For embedding on a mobile webpage. The snippet contains a JavaScript function which fires the tag.

TravelPlaceholderFieldEnum

Values for Travel placeholder fields. For more information about dynamic remarketing feeds, see https://support.google.com/google-ads/answer/6053288.

TravelPlaceholderField

Possible values for Travel placeholder fields.

Enums
UNSPECIFIED Not specified.
UNKNOWN Used for return value only. Represents value unknown in this version.
DESTINATION_ID Data Type: STRING. Required. Destination id. Example: PAR, LON. For feed items that only have destination id, destination id must be a unique key. For feed items that have both destination id and origin id, then the combination must be a unique key.
ORIGIN_ID Data Type: STRING. Origin id. Example: PAR, LON. Combination of DESTINATION_ID and ORIGIN_ID must be unique per offer.
TITLE Data Type: STRING. Required. Main headline with name to be shown in dynamic ad.
DESTINATION_NAME Data Type: STRING. The destination name. Shorter names are recommended.
ORIGIN_NAME Data Type: STRING. Origin name. Shorter names are recommended.
PRICE Data Type: STRING. Price to be shown in the ad. Highly recommended for dynamic ads. Example: "100.00 USD"
FORMATTED_PRICE Data Type: STRING. Formatted price to be shown in the ad. Example: "Starting at $100.00 USD", "$80 - $100"
SALE_PRICE Data Type: STRING. Sale price to be shown in the ad. Example: "80.00 USD"
FORMATTED_SALE_PRICE Data Type: STRING. Formatted sale price to be shown in the ad. Example: "On sale for $80.00", "$60 - $80"
IMAGE_URL Data Type: URL. Image to be displayed in the ad.
CATEGORY Data Type: STRING. Category of travel offer used to group like items together for recommendation engine.
CONTEXTUAL_KEYWORDS Data Type: STRING_LIST. Keywords used for product retrieval.
DESTINATION_ADDRESS Data Type: STRING. Address of travel offer, including postal code.
FINAL_URL Data Type: URL_LIST. Required. Final URLs to be used in ad, when using Upgraded URLs; the more specific the better (e.g. the individual URL of a specific travel offer and its location).
FINAL_MOBILE_URLS Data Type: URL_LIST. Final mobile URLs for the ad when using Upgraded URLs.
TRACKING_URL Data Type: URL. Tracking template for the ad when using Upgraded URLs.
SIMILAR_DESTINATION_IDS Data Type: STRING_LIST. List of recommended destination IDs to show together with this item.
IOS_APP_STORE_ID Data Type: INT64. iOS app store ID.

UserInterestTaxonomyTypeEnum

Message describing a UserInterestTaxonomyType.

UserInterestTaxonomyType

Enum containing the possible UserInterestTaxonomyTypes.

Enums
UNSPECIFIED Not specified.
UNKNOWN Used for return value only. Represents value unknown in this version.
AFFINITY The affinity for this user interest.
IN_MARKET The market for this user interest.
MOBILE_APP_INSTALL_USER Users known to have installed applications in the specified categories.
VERTICAL_GEO The geographical location of the interest-based vertical.
NEW_SMART_PHONE_USER User interest criteria for new smart phone users.

UserListAccessStatusEnum

Indicates if this client still has access to the list.

UserListAccessStatus

Enum containing possible user list access statuses.

Enums
UNSPECIFIED Not specified.
UNKNOWN Used for return value only. Represents value unknown in this version.
ENABLED The access is enabled.
DISABLED The access is disabled.

UserListClosingReasonEnum

Indicates the reason why the userlist was closed. This enum is only used when a list is auto-closed by the system.

UserListClosingReason

Enum describing possible user list closing reasons.

Enums
UNSPECIFIED Not specified.
UNKNOWN Used for return value only. Represents value unknown in this version.
UNUSED The userlist was closed because of not being used for over one year.

UserListCrmDataSourceTypeEnum

Indicates source of Crm upload data.

UserListCrmDataSourceType

Enum describing possible user list crm data source type.

Enums
UNSPECIFIED Not specified.
UNKNOWN Used for return value only. Represents value unknown in this version.
FIRST_PARTY The uploaded data is first party data.
THIRD_PARTY_CREDIT_BUREAU The uploaded data is from a third party credit bureau.
THIRD_PARTY_VOTER_FILE The uploaded data is from a third party voter file.

UserListMembershipStatusEnum

Membership status of this user list. Indicates whether a user list is open or active. Only open user lists can accumulate more users and can be used for targeting.

UserListMembershipStatus

Enum containing possible user list membership statuses.

Enums
UNSPECIFIED Not specified.
UNKNOWN Used for return value only. Represents value unknown in this version.
OPEN Open status - List is accruing members and can be targeted to.
CLOSED Closed status - No new members being added. Cannot be used for targeting.

UserListSizeRangeEnum

Size range in terms of number of users of a UserList.

UserListSizeRange

Enum containing possible user list size ranges.

Enums
UNSPECIFIED Not specified.
UNKNOWN Used for return value only. Represents value unknown in this version.
LESS_THAN_FIVE_HUNDRED User list has less than 500 users.
LESS_THAN_ONE_THOUSAND User list has number of users in range of 500 to 1000.
ONE_THOUSAND_TO_TEN_THOUSAND User list has number of users in range of 1000 to 10000.
TEN_THOUSAND_TO_FIFTY_THOUSAND User list has number of users in range of 10000 to 50000.
FIFTY_THOUSAND_TO_ONE_HUNDRED_THOUSAND User list has number of users in range of 50000 to 100000.
ONE_HUNDRED_THOUSAND_TO_THREE_HUNDRED_THOUSAND User list has number of users in range of 100000 to 300000.
THREE_HUNDRED_THOUSAND_TO_FIVE_HUNDRED_THOUSAND User list has number of users in range of 300000 to 500000.
FIVE_HUNDRED_THOUSAND_TO_ONE_MILLION User list has number of users in range of 500000 to 1 million.
ONE_MILLION_TO_TWO_MILLION User list has number of users in range of 1 to 2 millions.
TWO_MILLION_TO_THREE_MILLION User list has number of users in range of 2 to 3 millions.
THREE_MILLION_TO_FIVE_MILLION User list has number of users in range of 3 to 5 millions.
FIVE_MILLION_TO_TEN_MILLION User list has number of users in range of 5 to 10 millions.
TEN_MILLION_TO_TWENTY_MILLION User list has number of users in range of 10 to 20 millions.
TWENTY_MILLION_TO_THIRTY_MILLION User list has number of users in range of 20 to 30 millions.
THIRTY_MILLION_TO_FIFTY_MILLION User list has number of users in range of 30 to 50 millions.
OVER_FIFTY_MILLION User list has over 50 million users.

UserListTypeEnum

The user list types.

UserListType

Enum containing possible user list types.

Enums
UNSPECIFIED Not specified.
UNKNOWN Used for return value only. Represents value unknown in this version.
REMARKETING UserList represented as a collection of conversion types.
LOGICAL UserList represented as a combination of other user lists/interests.
EXTERNAL_REMARKETING UserList created in the Google Ad Manager platform.
RULE_BASED UserList associated with a rule.
SIMILAR UserList with users similar to users of another UserList.
CRM_BASED UserList of first party CRM data provided by advertiser in the form of emails or other formats.

Send feedback about...

Google Ads API Beta
Google Ads API Beta
Need help? Visit our support page.