Overview
common |
|
---|---|
AdAssetPolicySummary |
Contains policy information for an asset inside an ad. |
AdImageAsset |
An image asset used inside an ad. |
AdMediaBundleAsset |
A media bundle asset used inside an ad. |
AdScheduleInfo |
Represents an AdSchedule criterion. AdSchedule is specified as the day of the week and a time interval within which ads will be shown. No more than six AdSchedules can be added for the same day. |
AdTextAsset |
A text asset used inside an ad. |
AdVideoAsset |
A video asset used inside an ad. |
AddressInfo |
Address for proximity criterion. |
AffiliateLocationFeedItem |
Represents an affiliate location extension. |
AgeRangeInfo |
An age range criterion. |
AppAdInfo |
An app ad. |
AppEngagementAdInfo |
App engagement ads allow you to write text encouraging a specific action in the app, like checking in, making a purchase, or booking a flight. They allow you to send users to a specific part of your app where they can find what they're looking for easier and faster. |
AppFeedItem |
Represents an App extension. |
AppPaymentModelInfo |
An app payment model criterion. |
BasicUserListInfo |
User list targeting as a collection of conversions or remarketing actions. |
BidModifierSimulationPoint |
Projected metrics for a specific bid modifier amount. |
BidModifierSimulationPointList |
A container for simulation points for simulations of type BID_MODIFIER. |
BookOnGoogleAsset |
A Book on Google asset. Used to redirect user to book through Google. Book on Google will change the redirect url to book directly through Google. |
BudgetCampaignAssociationStatus |
A BudgetCampaignAssociationStatus segment. |
BusinessNameFilter |
Represents a business name filter on locations in a FeedItemSet. |
CallFeedItem |
Represents a Call extension. |
CallOnlyAdInfo |
A call-only ad. |
CalloutFeedItem |
Represents a callout extension. |
CarrierInfo |
Represents a Carrier Criterion. |
ClickLocation |
Location criteria associated with a click. |
CombinedAudienceInfo |
A combined audience criterion. |
CombinedRuleUserListInfo |
User lists defined by combining two rules, left operand and right operand. There are two operators: AND where left operand and right operand have to be true; AND_NOT where left operand is true but right operand is false. |
Commission |
Commission is an automatic bidding strategy in which the advertiser pays a certain portion of the conversion value. |
ContentLabelInfo |
Content Label for category exclusion. |
CpcBidSimulationPoint |
Projected metrics for a specific CPC bid amount. |
CpcBidSimulationPointList |
A container for simulation points for simulations of type CPC_BID. |
CpvBidSimulationPoint |
Projected metrics for a specific CPV bid amount. |
CpvBidSimulationPointList |
A container for simulation points for simulations of type CPV_BID. |
CriterionCategoryAvailability |
Information of category availability, per advertising channel. |
CriterionCategoryChannelAvailability |
Information of advertising channel type and subtypes a category is available in. |
CriterionCategoryLocaleAvailability |
Information about which locales a category is available in. |
CrmBasedUserListInfo |
UserList of CRM users provided by the advertiser. |
CustomAffinityInfo |
A custom affinity criterion. A criterion of this type is only targetable. |
CustomAudienceInfo |
A custom audience criterion. |
CustomIntentInfo |
A custom intent criterion. A criterion of this type is only targetable. |
CustomParameter |
A mapping that can be used by custom parameter tags in a |
CustomerMatchUserListMetadata |
Metadata for customer match user list. |
DateRange |
A date range. |
DateSpecificRuleUserListInfo |
Visitors of a page during specific dates. |
DeviceInfo |
A device criterion. |
DisplayCallToAction |
Data for display call to action. The call to action is a piece of the ad that prompts the user to do something. Like clicking a link or making a phone call. |
DisplayUploadAdInfo |
A generic type of display ad. The exact ad format is controlled by the display_upload_product_type field, which determines what kinds of data need to be included with the ad. |
DynamicAffiliateLocationSetFilter |
Represents a filter on affiliate locations in a FeedItemSet. Only applicable if the parent Feed of the FeedItemSet is an AFFILIATE_LOCATION feed. |
DynamicLocationSetFilter |
Represents a filter on locations in a feed item set. Only applicable if the parent Feed of the FeedItemSet is a LOCATION feed. |
EnhancedCpc |
An automated 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. |
ExpandedDynamicSearchAdInfo |
An expanded dynamic search ad. |
ExpandedTextAdInfo |
An expanded text ad. |
ExplorerAutoOptimizerSetting |
Settings for the Display Campaign Optimizer, initially named "Explorer". Learn more about automatic targeting. |
ExpressionRuleUserListInfo |
Visitors of a page. The page visit is defined by one boolean rule expression. |
FinalAppUrl |
A URL for deep linking into an app for the given operating system. |
FrequencyCapEntry |
A rule specifying the maximum number of times an ad (or some set of ads) can be shown to a user over a particular time period. |
FrequencyCapKey |
A group of fields used as keys for a frequency cap. There can be no more than one frequency cap with the same key. |
GenderInfo |
A gender criterion. |
GeoPointInfo |
Geo point for proximity criterion. |
GmailAdInfo |
A Gmail ad. |
GmailTeaser |
Gmail teaser data. The teaser is a small header that acts as an invitation to view the rest of the ad (the body). |
HotelAdInfo |
A hotel ad. |
HotelAdvanceBookingWindowInfo |
Criterion for number of days prior to the stay the booking is being made. |
HotelCalloutFeedItem |
Represents a hotel callout extension. |
HotelCheckInDayInfo |
Criterion for day of the week the booking is for. |
HotelCityInfo |
City the hotel is located in. |
HotelClassInfo |
Class of the hotel as a number of stars 1 to 5. |
HotelCountryRegionInfo |
Country or Region the hotel is located in. |
HotelDateSelectionTypeInfo |
Criterion for hotel date selection (default dates vs. user selected). |
HotelIdInfo |
Advertiser-specific hotel ID. |
HotelLengthOfStayInfo |
Criterion for length of hotel stay in nights. |
HotelStateInfo |
State the hotel is located in. |
ImageAdInfo |
An image ad. |
ImageAsset |
An Image asset. |
ImageDimension |
Metadata for an image at a certain size, either original or resized. |
ImageFeedItem |
Represents an advertiser provided image extension. |
IncomeRangeInfo |
An income range criterion. |
InteractionTypeInfo |
Criterion for Interaction Type. |
IpBlockInfo |
An IpBlock criterion used for IP exclusions. We allow: - IPv4 and IPv6 addresses - individual addresses (192.168.0.1) - masks for individual addresses (192.168.0.1/32) - masks for Class C networks (192.168.0.1/24) |
Keyword |
A Keyword criterion segment. |
KeywordInfo |
A keyword criterion. |
KeywordPlanHistoricalMetrics |
Historical metrics specific to the targeting options selected. Targeting options include geographies, network, etc. Refer to https://support.google.com/google-ads/answer/3022575 for more details. |
LanguageInfo |
A language criterion. |
LeadFormAsset |
A Lead Form asset. |
LeadFormDeliveryMethod |
A configuration of how leads are delivered to the advertiser. |
LeadFormField |
One input field instance within a form. |
LeadFormSingleChoiceAnswers |
Defines possible answers for a single choice question, usually presented as a single-choice drop-down list. |
LegacyAppInstallAdInfo |
A legacy app install ad that only can be used by a few select customers. |
LegacyResponsiveDisplayAdInfo |
A legacy responsive display ad. Ads of this type are labeled 'Responsive ads' in the Google Ads UI. |
ListingDimensionInfo |
Listing dimensions for listing group criterion. |
ListingGroupInfo |
A listing group criterion. |
ListingScopeInfo |
A listing scope criterion. |
LocalAdInfo |
A local ad. |
LocationFeedItem |
Represents a location extension. |
LocationGroupInfo |
A radius around a list of locations specified via a feed. |
LocationInfo |
A location criterion. |
LogicalUserListInfo |
Represents a user list that is a custom combination of user lists. |
LogicalUserListOperandInfo |
Operand of logical user list that consists of a user list. |
ManualCpc |
Manual click-based bidding where user pays per click. |
ManualCpm |
Manual impression-based bidding where user pays per thousand impressions. |
ManualCpv |
View based bidding where user pays per video view. |
MatchingFunction |
Matching function associated with a CustomerFeed, CampaignFeed, or AdGroupFeed. The matching function is used to filter the set of feed items selected. |
MaximizeConversionValue |
An automated bidding strategy to help get the most conversion value for your campaigns while spending your budget. |
MaximizeConversions |
An automated bidding strategy to help get the most conversions for your campaigns while spending your budget. |
MediaBundleAsset |
A MediaBundle asset. |
Metrics |
Metrics data. |
MobileAppCategoryInfo |
A mobile app category criterion. |
MobileApplicationInfo |
A mobile application criterion. |
MobileDeviceInfo |
A mobile device criterion. |
Money |
Represents a price in a particular currency. |
MonthlySearchVolume |
Monthly search volume. |
OfflineUserAddressInfo |
Address identifier of offline data. |
Operand |
An operand in a matching function. |
Operand.ConstantOperand |
A constant operand in a matching function. |
Operand.FeedAttributeOperand |
A feed attribute operand in a matching function. Used to represent a feed attribute in feed. |
Operand.FunctionOperand |
A function operand in a matching function. Used to represent nested functions. |
Operand.RequestContextOperand |
An operand in a function referring to a value in the request context. |
OperatingSystemVersionInfo |
Represents an operating system version to be targeted. |
ParentalStatusInfo |
A parental status criterion. |
PercentCpc |
A bidding strategy where bids are a fraction of the advertised price for some good or service. |
PercentCpcBidSimulationPoint |
Projected metrics for a specific percent CPC amount. Only Hotel advertising channel type supports this field. |
PercentCpcBidSimulationPointList |
A container for simulation points for simulations of type PERCENT_CPC_BID. |
PlacementInfo |
A placement criterion. This can be used to modify bids for sites when targeting the content network. |
PolicyTopicConstraint |
Describes the effect on serving that a policy topic entry will have. |
PolicyTopicConstraint.CountryConstraint |
Indicates that a resource's ability to serve in a particular country is constrained. |
PolicyTopicConstraint.CountryConstraintList |
A list of countries where a resource's serving is constrained. |
PolicyTopicConstraint.ResellerConstraint |
Indicates that a policy topic was constrained due to disapproval of the website for reseller purposes. |
PolicyTopicEntry |
Policy finding attached to a resource (e.g. alcohol policy associated with a site that sells alcohol). Each PolicyTopicEntry has a topic that indicates the specific ads policy the entry is about and a type to indicate the effect that the entry will have on serving. It may optionally have one or more evidences that indicate the reason for the finding. It may also optionally have one or more constraints that provide details about how serving may be restricted. |
PolicyTopicEvidence |
Additional information that explains a policy finding. |
PolicyTopicEvidence.DestinationMismatch |
Evidence of mismatches between the URLs of a resource. |
PolicyTopicEvidence.DestinationNotWorking |
Evidence details when the destination is returning an HTTP error code or isn't functional in all locations for commonly used devices. |
PolicyTopicEvidence.DestinationTextList |
A list of strings found in a destination page that caused a policy finding. |
PolicyTopicEvidence.TextList |
A list of fragments of text that violated a policy. |
PolicyTopicEvidence.WebsiteList |
A list of websites that caused a policy finding. Used for ONE_WEBSITE_PER_AD_GROUP policy topic, for example. In case there are more than five websites, only the top five (those that appear in resources the most) will be listed here. |
PolicyValidationParameter |
Parameter for controlling how policy exemption is done. Ignorable policy topics are only usable with expanded text ads and responsive search ads. All other ad types must use policy violation keys. |
PolicyViolationKey |
Key of the violation. The key is used for referring to a violation when filing an exemption request. |
PreferredContentInfo |
A preferred content criterion. |
PriceFeedItem |
Represents a Price extension. |
PriceOffer |
Represents one price offer in a price extension. |
ProductBiddingCategoryInfo |
Bidding category of a product offer. |
ProductBrandInfo |
Brand of the product. |
ProductChannelExclusivityInfo |
Availability of a product offer. |
ProductChannelInfo |
Locality of a product offer. |
ProductConditionInfo |
Condition of a product offer. |
ProductCustomAttributeInfo |
Custom attribute of a product offer. |
ProductImage |
Product image specific data. |
ProductItemIdInfo |
Item id of a product offer. |
ProductTypeInfo |
Type of a product offer. |
ProductVideo |
Product video specific data. |
PromotionFeedItem |
Represents a Promotion extension. |
ProximityInfo |
A Proximity criterion. The geo point and radius determine what geographical area is included. The address is a description of the geo point that does not affect ad serving. There are two ways to create a proximity. First, by setting an address and radius. The geo point will be automatically computed. Second, by setting a geo point and radius. The address is an optional label that won't be validated. |
RealTimeBiddingSetting |
Settings for Real-Time Bidding, a feature only available for campaigns targeting the Ad Exchange network. |
ResponsiveDisplayAdControlSpec |
Specification for various creative controls for a responsive display ad. |
ResponsiveDisplayAdInfo |
A responsive display ad. |
ResponsiveSearchAdInfo |
A responsive search ad. Responsive search ads let you create an ad that adapts to show more text, and more relevant messages, to your customers. Enter multiple headlines and descriptions when creating a responsive search ad, and over time, Google Ads will automatically test different combinations and learn which combinations perform best. By adapting your ad's content to more closely match potential customers' search terms, responsive search ads may improve your campaign's performance. More information at https://support.google.com/google-ads/answer/7684791 |
RuleBasedUserListInfo |
Representation of a userlist that is generated by a rule. |
Segments |
Segment only fields. |
ShoppingComparisonListingAdInfo |
A Shopping Comparison Listing ad. |
ShoppingProductAdInfo |
A standard Shopping ad. |
ShoppingSmartAdInfo |
A Smart Shopping ad. |
SimilarUserListInfo |
SimilarUserList is a list of users which are similar to users from another UserList. These lists are read-only and automatically created by Google. |
SitelinkFeedItem |
Represents a sitelink extension. |
StoreAttribute |
Store attributes of the transaction. |
StoreSalesMetadata |
Metadata for Store Sales Direct. |
StoreSalesThirdPartyMetadata |
Metadata for a third party Store Sales. This product is only for customers on the allow-list. Please contact your Google business development representative for details on the upload configuration. |
StructuredSnippetFeedItem |
Represents a structured snippet extension. |
TagSnippet |
The site tag and event snippet pair for a TrackingCodeType. |
TargetCpa |
An automated bid strategy that sets bids to help get as many conversions as possible at the target cost-per-acquisition (CPA) you set. |
TargetCpaSimulationPoint |
Projected metrics for a specific target CPA amount. |
TargetCpaSimulationPointList |
A container for simulation points for simulations of type TARGET_CPA. |
TargetCpm |
Target CPM (cost per thousand impressions) is an automated bidding strategy that sets bids to optimize performance given the target CPM you set. |
TargetImpressionShare |
An automated bidding strategy that sets bids so that a certain percentage of search ads are shown at the top of the first page (or other targeted location). |
TargetRestriction |
The list of per-targeting-dimension targeting settings. |
TargetRestrictionOperation |
Operation to be performed on a target restriction list in a mutate. |
TargetRestrictionOperation.Operator |
The operator. |
TargetRoas |
An automated bidding strategy that helps you maximize revenue while averaging a specific target return on ad spend (ROAS). |
TargetRoasSimulationPoint |
Projected metrics for a specific target ROAS amount. |
TargetRoasSimulationPointList |
A container for simulation points for simulations of type TARGET_ROAS. |
TargetSpend |
An automated bid strategy that sets your bids to help get as many clicks as possible within your budget. |
TargetingSetting |
Settings for the targeting-related features, at the campaign and ad group levels. For more details about the targeting setting, visit https://support.google.com/google-ads/answer/7365594 |
TextAdInfo |
A text ad. |
TextAsset |
A Text asset. |
TextLabel |
A type of label displaying text on a colored background. |
TextMessageFeedItem |
An extension that users can click on to send a text message to the advertiser. |
TopicInfo |
A topic criterion. Use topics to target or exclude placements in the Google Display Network based on the category into which the placement falls (for example, "Pets & Animals/Pets/Dogs"). |
TransactionAttribute |
Attribute of the store sales transaction. |
UnknownListingDimensionInfo |
Unknown listing dimension. |
UrlCollection |
Collection of urls that is tagged with a unique identifier. |
UserAttribute |
User attribute, can only be used with CUSTOMER_MATCH_WITH_ATTRIBUTES job type. |
UserData |
User data holding user identifiers and attributes. |
UserIdentifier |
Hashed user identifying information. |
UserInterestInfo |
Represents a particular interest-based topic to be targeted. |
UserListActionInfo |
Represents an action type used for building remarketing user lists. |
UserListDateRuleItemInfo |
A rule item composed of a date operation. |
UserListInfo |
A User List criterion. Represents a user list that is defined by the advertiser to be targeted. |
UserListLogicalRuleInfo |
A user list logical rule. A rule has a logical operator (and/or/not) and a list of user lists as operands. |
UserListNumberRuleItemInfo |
A rule item composed of a number operation. |
UserListRuleInfo |
A client defined rule based on custom parameters sent by web sites or uploaded by the advertiser. |
UserListRuleItemGroupInfo |
A group of rule items. |
UserListRuleItemInfo |
An atomic rule item. |
UserListStringRuleItemInfo |
A rule item composed of a string operation. |
Value |
A generic data container. |
VideoAdInfo |
A video ad. |
VideoBumperInStreamAdInfo |
Representation of video bumper in-stream ad format (very short in-stream non-skippable video ad). |
VideoNonSkippableInStreamAdInfo |
Representation of video non-skippable in-stream ad format (15 second in-stream non-skippable video ad). |
VideoOutstreamAdInfo |
Representation of video out-stream ad format (ad shown alongside a feed with automatic playback, without sound). |
VideoResponsiveAdInfo |
A video responsive ad. |
VideoTrueViewDiscoveryAdInfo |
Representation of video TrueView discovery ad format. |
VideoTrueViewInStreamAdInfo |
Representation of video TrueView in-stream ad format (ad shown during video playback, often at beginning, which displays a skip button a few seconds into the video). |
WebhookDelivery |
Google notifies the advertiser of leads by making HTTP calls to an endpoint they specify. The requests contain JSON matching a schema that Google publishes as part of form ads documentation. |
WebpageConditionInfo |
Logical expression for targeting webpages of an advertiser's website. |
WebpageInfo |
Represents a criterion for targeting webpages of an advertiser's website. |
YouTubeChannelInfo |
A YouTube Channel criterion. |
YouTubeVideoInfo |
A YouTube Video criterion. |
YoutubeVideoAsset |
A YouTube asset. |
enums |
|
AccessInvitationStatus |
Possible access invitation status of a user |
AccessReason |
Enum describing possible access reasons. |
AccessRole |
Possible access role of a user. |
AccountBudgetProposalStatus |
The possible statuses of an AccountBudgetProposal. |
AccountBudgetProposalType |
The possible types of an AccountBudgetProposal. |
AccountBudgetStatus |
The possible statuses of an AccountBudget. |
AccountLinkStatus |
Describes the possible statuses for a link between a Google Ads customer and another account. |
AdCustomizerPlaceholderField |
Possible values for Ad Customizers placeholder fields. |
AdDestinationType |
Enumerates Google Ads destination types |
AdGroupAdRotationMode |
The possible ad rotation modes of an ad group. |
AdGroupAdStatus |
The possible statuses of an AdGroupAd. |
AdGroupCriterionApprovalStatus |
Enumerates AdGroupCriterion approval statuses. |
AdGroupCriterionStatus |
The possible statuses of an AdGroupCriterion. |
AdGroupStatus |
The possible statuses of an ad group. |
AdGroupType |
Enum listing the possible types of an ad group. |
AdNetworkType |
Enumerates Google Ads network types. |
AdServingOptimizationStatus |
Enum describing possible serving statuses. |
AdStrength |
Enum listing the possible ad strengths. |
AdType |
The possible types of an ad. |
AdvertisingChannelSubType |
Enum describing the different channel subtypes. |
AdvertisingChannelType |
Enum describing the various advertising channel types. |
AffiliateLocationFeedRelationshipType |
Possible values for a relationship type for an affiliate location feed. |
AffiliateLocationPlaceholderField |
Possible values for Affiliate Location placeholder fields. |
AgeRangeType |
The type of demographic age ranges (e.g. between 18 and 24 years old). |
AppCampaignAppStore |
Enum describing app campaign app store. |
AppCampaignBiddingStrategyGoalType |
Goal type of App campaign BiddingStrategy. |
AppPaymentModelType |
Enum describing possible app payment models. |
AppPlaceholderField |
Possible values for App placeholder fields. |
AppStore |
App store type in an app extension. |
AppUrlOperatingSystemType |
Operating System |
AssetFieldType |
Enum describing the possible placements of an asset. |
AssetLinkStatus |
Enum describing statuses of an asset link. |
AssetPerformanceLabel |
Enum describing the possible performance labels of an asset, usually computed in the context of a linkage. |
AssetType |
Enum describing possible types of asset. |
AttributionModel |
The attribution model that describes how to distribute credit for a particular conversion across potentially many prior interactions. |
BatchJobStatus |
The batch job statuses. |
BidModifierSource |
Enum describing possible bid modifier sources. |
BiddingSource |
Indicates where a bid or target is defined. For example, an ad group criterion may define a cpc bid directly, or it can inherit its cpc bid from the ad group. |
BiddingStrategyStatus |
The possible statuses of a BiddingStrategy. |
BiddingStrategyType |
Enum describing possible bidding strategy types. |
BillingSetupStatus |
The possible statuses of a BillingSetup. |
BrandSafetySuitability |
3-Tier brand safety suitability control. |
BudgetCampaignAssociationStatus |
Possible statuses of the association between the Budget and the Campaign. |
BudgetDeliveryMethod |
Possible delivery methods of a Budget. |
BudgetPeriod |
Possible period of a Budget. |
BudgetStatus |
Possible statuses of a Budget. |
BudgetType |
Possible Budget types. |
CallConversionReportingState |
Possible data types for a call conversion action state. |
CallPlaceholderField |
Possible values for Call placeholder fields. |
CallTrackingDisplayLocation |
Possible call tracking display locations. |
CallType |
Possible types of property from where the call was made. |
CalloutPlaceholderField |
Possible values for Callout placeholder fields. |
CampaignCriterionStatus |
The possible statuses of a CampaignCriterion. |
CampaignDraftStatus |
Possible statuses of a campaign draft. |
CampaignExperimentStatus |
Possible statuses of a campaign experiment. |
CampaignExperimentTrafficSplitType |
Enum of strategies for splitting traffic between base and experiment campaigns in campaign experiment. |
CampaignExperimentType |
Indicates if this campaign is a normal campaign, a draft campaign, or an experiment campaign. |
CampaignServingStatus |
Possible serving statuses of a campaign. |
CampaignSharedSetStatus |
Enum listing the possible campaign shared set statuses. |
CampaignStatus |
Possible statuses of a campaign. |
ChangeClientType |
The source that the change_event resource was made through. |
ChangeEventResourceType |
Enum listing the resource types support by the ChangeEvent resource. |
ChangeStatusOperation |
Status of the changed resource |
ChangeStatusResourceType |
Enum listing the resource types support by the ChangeStatus resource. |
ClickType |
Enumerates Google Ads click types. |
CombinedAudienceStatus |
Enum containing possible combined audience status types. |
ContentLabelType |
Enum listing the content label types supported by ContentLabel criterion. |
ConversionActionCategory |
The category of conversions that are associated with a ConversionAction. |
ConversionActionCountingType |
Indicates how conversions for this action will be counted. For more information, see https://support.google.com/google-ads/answer/3438531. |
ConversionActionStatus |
Possible statuses of a conversion action. |
ConversionActionType |
Possible types of a conversion action. |
ConversionAdjustmentType |
The different actions advertisers can take to adjust the conversions that they already reported. Retractions negate a conversion. Restatements change the value of a conversion. |
ConversionAttributionEventType |
The event type of conversions that are attributed to. |
ConversionLagBucket |
Enum representing the number of days between impression and conversion. |
ConversionOrAdjustmentLagBucket |
Enum representing the number of days between the impression and the conversion or between the impression and adjustments to the conversion. |
CriterionCategoryChannelAvailabilityMode |
Enum containing the possible CriterionCategoryChannelAvailabilityMode. |
CriterionCategoryLocaleAvailabilityMode |
Enum containing the possible CriterionCategoryLocaleAvailabilityMode. |
CriterionSystemServingStatus |
Enumerates criterion system serving statuses. |
CriterionType |
Enum describing possible criterion types. |
CustomAudienceMemberType |
Enum containing possible custom audience member types. |
CustomAudienceStatus |
Enum containing possible custom audience statuses. |
CustomAudienceType |
Enum containing possible custom audience types. |
CustomInterestMemberType |
Enum containing possible custom interest member types. |
CustomInterestStatus |
Enum containing possible custom interest types. |
CustomInterestType |
Enum containing possible custom interest types. |
CustomPlaceholderField |
Possible values for Custom placeholder fields. |
CustomerMatchUploadKeyType |
Enum describing possible customer match upload key types. |
CustomerPayPerConversionEligibilityFailureReason |
Enum describing possible reasons a customer is not eligible to use PaymentMode.CONVERSIONS. |
DataDrivenModelStatus |
Enumerates data driven model statuses. |
DayOfWeek |
Enumerates days of the week, e.g., "Monday". |
Device |
Enumerates Google Ads devices available for targeting. |
DisplayAdFormatSetting |
Enumerates display ad format settings. |
DisplayUploadProductType |
Enumerates display upload product types. |
DistanceBucket |
The distance bucket for a user’s distance from an advertiser’s location extension. |
DsaPageFeedCriterionField |
Possible values for Dynamic Search Ad Page Feed criterion fields. |
EducationPlaceholderField |
Possible values for Education placeholder fields. |
ExtensionSettingDevice |
Possible device types for an extension setting. |
ExtensionType |
Possible data types for an extension in an extension setting. |
ExternalConversionSource |
The external conversion source that is associated with a ConversionAction. |
FeedAttributeType |
Possible data types for a feed attribute. |
FeedItemQualityApprovalStatus |
The possible quality evaluation approval statuses of a feed item. |
FeedItemQualityDisapprovalReason |
The possible quality evaluation disapproval reasons of a feed item. |
FeedItemSetStatus |
Possible statuses of a feed item set. |
FeedItemSetStringFilterType |
describe the possible types for a FeedItemSetStringFilter. |
FeedItemStatus |
Possible statuses of a feed item. |
FeedItemTargetDevice |
Possible data types for a feed item target device. |
FeedItemTargetStatus |
Possible statuses of a feed item target. |
FeedItemTargetType |
Possible type of a feed item target. |
FeedItemValidationStatus |
The possible validation statuses of a feed item. |
FeedLinkStatus |
Possible statuses of a feed link. |
FeedMappingCriterionType |
Possible placeholder types for a feed mapping. |
FeedMappingStatus |
Possible statuses of a feed mapping. |
FeedOrigin |
Possible values for a feed origin. |
FeedStatus |
Possible statuses of a feed. |
FlightPlaceholderField |
Possible values for Flight placeholder fields. |
FrequencyCapEventType |
The type of event that the cap applies to (e.g. impression). |
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. |
FrequencyCapTimeUnit |
Unit of time the cap is defined at (e.g. day, week). |
GenderType |
The type of demographic genders (e.g. female). |
GeoTargetConstantStatus |
The possible statuses of a geo target constant. |
GeoTargetingRestriction |
A restriction used to determine if the request context's geo should be matched. |
GeoTargetingType |
The possible geo targeting types. |
GoogleAdsFieldCategory |
The category of the artifact. |
GoogleAdsFieldDataType |
These are the various types a GoogleAdsService artifact may take on. |
GoogleVoiceCallStatus |
Possible statuses of a google voice call. |
HotelDateSelectionType |
Enum describing possible hotel date selection types. |
HotelPlaceholderField |
Possible values for Hotel placeholder fields. |
HotelPriceBucket |
Enum describing possible hotel price buckets. |
HotelRateType |
Enum describing possible hotel rate types. |
ImagePlaceholderField |
Possible values for Advertiser Provided Image placeholder fields. |
IncomeRangeType |
The type of demographic income ranges (e.g. between 0% to 50%). |
InteractionEventType |
Enum describing possible types of payable and free interactions. |
InteractionType |
Enum describing possible interaction types. |
InvoiceType |
The possible type of invoices. |
JobPlaceholderField |
Possible values for Job placeholder fields. |
KeywordMatchType |
Possible Keyword match types. |
KeywordPlanCompetitionLevel |
Competition level of a keyword. |
KeywordPlanForecastInterval |
Forecast intervals. |
KeywordPlanNetwork |
Enumerates keyword plan forecastable network types. |
LabelStatus |
Possible statuses of a label. |
LeadFormCallToActionType |
Enum describing the type of call-to-action phrases in a lead form. |
LeadFormDesiredIntent |
Enum describing the desired level of intent of generated leads. |
LeadFormFieldUserInputType |
Enum describing the input type of a lead form field. |
LeadFormPostSubmitCallToActionType |
Enum describing the type of post-submit call-to-action phrases for a lead form. |
LegacyAppInstallAdAppStore |
App store type in a legacy app install ad. |
LinkedAccountType |
Describes the possible link types between a Google Ads customer and another account. |
ListingGroupType |
The type of the listing group. |
LocalPlaceholderField |
Possible values for Local placeholder fields. |
LocationExtensionTargetingCriterionField |
Possible values for Location Extension Targeting criterion fields. |
LocationGroupRadiusUnits |
The unit of radius distance in location group (e.g. MILES) |
LocationPlaceholderField |
Possible values for Location placeholder fields. |
LocationSourceType |
The possible types of a location source. |
ManagerLinkStatus |
Possible statuses of a link. |
MatchingFunctionContextType |
Possible context types for an operand in a matching function. |
MatchingFunctionOperator |
Possible operators in a matching function. |
MediaType |
The type of media. |
MerchantCenterLinkStatus |
Describes the possible statuses for a link between a Google Ads customer and a Google Merchant Center account. |
MessagePlaceholderField |
Possible values for Message placeholder fields. |
MimeType |
The mime type |
MinuteOfHour |
Enumerates of quarter-hours. E.g. "FIFTEEN" |
MobileAppVendor |
The type of mobile app vendor |
MobileDeviceType |
The type of mobile device. |
MonthOfYear |
Enumerates months of the year, e.g., "January". |
NegativeGeoTargetType |
The possible negative geo target types. |
OfflineUserDataJobFailureReason |
The failure reason of an offline user data job. |
OfflineUserDataJobStatus |
The status of an offline user data job. |
OfflineUserDataJobType |
The type of an offline user data job. |
OperatingSystemVersionOperatorType |
The type of operating system version. |
OptimizationGoalType |
The type of optimization goal |
ParentalStatusType |
The type of parental statuses (e.g. not a parent). |
PaymentMode |
Enum describing possible payment modes. |
PlaceholderType |
Possible placeholder types for a feed mapping. |
PlacementType |
Possible placement types for a feed mapping. |
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. |
PolicyReviewStatus |
The possible policy review statuses. |
PolicyTopicEntryType |
The possible policy topic entry types. |
PolicyTopicEvidenceDestinationMismatchUrlType |
The possible policy topic evidence destination mismatch url types. |
PolicyTopicEvidenceDestinationNotWorkingDevice |
The possible policy topic evidence destination not working devices. |
PolicyTopicEvidenceDestinationNotWorkingDnsErrorType |
The possible policy topic evidence destination not working DNS error types. |
PositiveGeoTargetType |
The possible positive geo target types. |
PreferredContentType |
Enumerates preferred content criterion type. |
PriceExtensionPriceQualifier |
Enums of price extension price qualifier. |
PriceExtensionPriceUnit |
Price extension price unit. |
PriceExtensionType |
Price extension type. |
PricePlaceholderField |
Possible values for Price placeholder fields. |
ProductBiddingCategoryLevel |
Enum describing the level of the product bidding category. |
ProductBiddingCategoryStatus |
Enum describing the status of the product bidding category. |
ProductChannel |
Enum describing the locality of a product offer. |
ProductChannelExclusivity |
Enum describing the availability of a product offer. |
ProductCondition |
Enum describing the condition of a product offer. |
ProductCustomAttributeIndex |
The index of the product custom attribute. |
ProductTypeLevel |
Enum describing the level of the type of a product offer. |
PromotionExtensionDiscountModifier |
A promotion extension discount modifier. |
PromotionExtensionOccasion |
A promotion extension occasion. |
PromotionPlaceholderField |
Possible values for Promotion placeholder fields. |
ProximityRadiusUnits |
The unit of radius distance in proximity (e.g. MILES) |
QualityScoreBucket |
Enum listing the possible quality score buckets. |
ReachPlanAdLength |
Possible ad length values. |
ReachPlanAgeRange |
Possible plannable age range values. |
ReachPlanNetwork |
Possible plannable network values. |
RealEstatePlaceholderField |
Possible values for Real Estate placeholder fields. |
RecommendationType |
Types of recommendations. |
ResourceChangeOperation |
The operation on the changed resource in change_event resource. |
ResponseContentType |
Possible response content types. |
SearchEngineResultsPageType |
The type of the search engine results page. |
SearchTermMatchType |
Possible match types for a keyword triggering an ad, including variants. |
SearchTermTargetingStatus |
Indicates whether the search term is one of your targeted or excluded keywords. |
ServedAssetFieldType |
The possible asset field types. |
SharedSetStatus |
Enum listing the possible shared set statuses. |
SharedSetType |
Enum listing the possible shared set types. |
SimulationModificationMethod |
Enum describing the method by which a simulation modifies a field. |
SimulationType |
Enum describing the field a simulation modifies. |
SitelinkPlaceholderField |
Possible values for Sitelink placeholder fields. |
Slot |
Enumerates possible positions of the Ad. |
SpendingLimitType |
The possible spending limit types used by certain resources as an alternative to absolute money values in micros. |
StructuredSnippetPlaceholderField |
Possible values for Structured Snippet placeholder fields. |
SummaryRowSetting |
Enum describing return summary row settings. |
SystemManagedResourceSource |
Enum listing the possible system managed entity sources. |
TargetCpaOptInRecommendationGoal |
Goal of TargetCpaOptIn recommendation. |
TargetImpressionShareLocation |
Enum describing possible goals. |
TargetingDimension |
Enum describing possible targeting dimensions. |
TimeType |
The possible time types used by certain resources as an alternative to absolute timestamps. |
TrackingCodePageFormat |
The format of the web page where the tracking tag and snippet will be installed. |
TrackingCodeType |
The type of the generated tag snippets for tracking conversions. |
TravelPlaceholderField |
Possible values for Travel placeholder fields. |
UserIdentifierSource |
The type of user identifier source for offline Store Sales third party uploads. |
UserInterestTaxonomyType |
Enum containing the possible UserInterestTaxonomyTypes. |
UserListAccessStatus |
Enum containing possible user list access statuses. |
UserListClosingReason |
Enum describing possible user list closing reasons. |
UserListCombinedRuleOperator |
Enum describing possible user list combined rule operators. |
UserListCrmDataSourceType |
Enum describing possible user list crm data source type. |
UserListDateRuleItemOperator |
Enum describing possible user list date rule item operators. |
UserListLogicalRuleOperator |
Enum describing possible user list logical rule operators. |
UserListMembershipStatus |
Enum containing possible user list membership statuses. |
UserListNumberRuleItemOperator |
Enum describing possible user list number rule item operators. |
UserListPrepopulationStatus |
Enum describing possible user list prepopulation status. |
UserListRuleType |
Enum describing possible user list rule types. |
UserListSizeRange |
Enum containing possible user list size ranges. |
UserListStringRuleItemOperator |
Enum describing possible user list string rule item operators. |
UserListType |
Enum containing possible user list types. |
VanityPharmaDisplayUrlMode |
Enum describing possible display modes for vanity pharma URLs. |
VanityPharmaText |
Enum describing possible text. |
WebpageConditionOperand |
The webpage condition operand in webpage criterion. |
WebpageConditionOperator |
The webpage condition operator in webpage criterion. |
errors |
|
AccessInvitationError |
Enum describing possible AccessInvitation errors. |
AccountBudgetProposalError |
Enum describing possible account budget proposal errors. |
AccountLinkError |
Enum describing possible account link errors. |
AdCustomizerError |
Enum describing possible ad customizer errors. |
AdError |
Enum describing possible ad errors. |
AdGroupAdError |
Enum describing possible ad group ad errors. |
AdGroupBidModifierError |
Enum describing possible ad group bid modifier errors. |
AdGroupCriterionError |
Enum describing possible ad group criterion errors. |
AdGroupError |
Enum describing possible ad group errors. |
AdGroupFeedError |
Enum describing possible ad group feed errors. |
AdParameterError |
Enum describing possible ad parameter errors. |
AdSharingError |
Enum describing possible ad sharing errors. |
AdxError |
Enum describing possible adx errors. |
AssetError |
Enum describing possible asset errors. |
AssetLinkError |
Enum describing possible asset link errors. |
AuthenticationError |
Enum describing possible authentication errors. |
AuthorizationError |
Enum describing possible authorization errors. |
BatchJobError |
Enum describing possible request errors. |
BiddingError |
Enum describing possible bidding errors. |
BiddingStrategyError |
Enum describing possible bidding strategy errors. |
BillingSetupError |
Enum describing possible billing setup errors. |
CampaignBudgetError |
Enum describing possible campaign budget errors. |
CampaignCriterionError |
Enum describing possible campaign criterion errors. |
CampaignDraftError |
Enum describing possible campaign draft errors. |
CampaignError |
Enum describing possible campaign errors. |
CampaignExperimentError |
Enum describing possible campaign experiment errors. |
CampaignFeedError |
Enum describing possible campaign feed errors. |
CampaignSharedSetError |
Enum describing possible campaign shared set errors. |
ChangeEventError |
Enum describing possible change event errors. |
ChangeStatusError |
Enum describing possible change status errors. |
CollectionSizeError |
Enum describing possible collection size errors. |
ContextError |
Enum describing possible context errors. |
ConversionActionError |
Enum describing possible conversion action errors. |
ConversionAdjustmentUploadError |
Enum describing possible conversion adjustment upload errors. |
ConversionUploadError |
Enum describing possible conversion upload errors. |
CountryCodeError |
Enum describing country code errors. |
CriterionError |
Enum describing possible criterion errors. |
CurrencyCodeError |
Enum describing possible currency code errors. |
CustomAudienceError |
Enum describing possible custom audience errors. |
CustomInterestError |
Enum describing possible custom interest errors. |
CustomerClientLinkError |
Enum describing possible CustomerClientLink errors. |
CustomerError |
Set of errors that are related to requests dealing with Customer. |
CustomerFeedError |
Enum describing possible customer feed errors. |
CustomerManagerLinkError |
Enum describing possible CustomerManagerLink errors. |
CustomerUserAccessError |
Enum describing possible customer user access errors. |
DatabaseError |
Enum describing possible database errors. |
DateError |
Enum describing possible date errors. |
DateRangeError |
Enum describing possible date range errors. |
DistinctError |
Enum describing possible distinct errors. |
EnumError |
Enum describing possible enum errors. |
ErrorCode |
The error reason represented by type and enum. |
ErrorDetails |
Additional error details. |
ErrorLocation |
Describes the part of the request proto that caused the error. |
ErrorLocation.FieldPathElement |
A part of a field path. |
ExtensionFeedItemError |
Enum describing possible extension feed item errors. |
ExtensionSettingError |
Enum describing possible extension setting errors. |
FeedAttributeReferenceError |
Enum describing possible feed attribute reference errors. |
FeedError |
Enum describing possible feed errors. |
FeedItemError |
Enum describing possible feed item errors. |
FeedItemSetError |
Enum describing possible feed item set errors. |
FeedItemSetLinkError |
Enum describing possible feed item set link errors. |
FeedItemTargetError |
Enum describing possible feed item target errors. |
FeedItemValidationError |
The possible validation errors of a feed item. |
FeedMappingError |
Enum describing possible feed item errors. |
FieldError |
Enum describing possible field errors. |
FieldMaskError |
Enum describing possible field mask errors. |
FunctionError |
Enum describing possible function errors. |
FunctionParsingError |
Enum describing possible function parsing errors. |
GeoTargetConstantSuggestionError |
Enum describing possible geo target constant suggestion errors. |
GoogleAdsError |
GoogleAds-specific error. |
GoogleAdsFailure |
Describes how a GoogleAds API call failed. It's returned inside google.rpc.Status.details when a call fails. |
HeaderError |
Enum describing possible header errors. |
IdError |
Enum describing possible id errors. |
ImageError |
Enum describing possible image errors. |
InternalError |
Enum describing possible internal errors. |
InvoiceError |
Enum describing possible invoice errors. |
KeywordPlanAdGroupError |
Enum describing possible errors from applying a keyword plan ad group. |
KeywordPlanAdGroupKeywordError |
Enum describing possible errors from applying a keyword plan ad group keyword or keyword plan campaign keyword. |
KeywordPlanCampaignError |
Enum describing possible errors from applying a keyword plan campaign. |
KeywordPlanCampaignKeywordError |
Enum describing possible errors from applying a keyword plan campaign keyword. |
KeywordPlanError |
Enum describing possible errors from applying a keyword plan. |
KeywordPlanIdeaError |
Enum describing possible errors from KeywordPlanIdeaService. |
LabelError |
Enum describing possible label errors. |
LanguageCodeError |
Enum describing language code errors. |
ListOperationError |
Enum describing possible list operation errors. |
ManagerLinkError |
Enum describing possible ManagerLink errors. |
MediaBundleError |
Enum describing possible media bundle errors. |
MediaFileError |
Enum describing possible media file errors. |
MediaUploadError |
Enum describing possible media uploading errors. |
MultiplierError |
Enum describing possible multiplier errors. |
MutateError |
Enum describing possible mutate errors. |
NewResourceCreationError |
Enum describing possible new resource creation errors. |
NotAllowlistedError |
Enum describing possible not allowlisted errors. |
NotEmptyError |
Enum describing possible not empty errors. |
NullError |
Enum describing possible null errors. |
OfflineUserDataJobError |
Enum describing possible request errors. |
OperationAccessDeniedError |
Enum describing possible operation access denied errors. |
OperatorError |
Enum describing possible operator errors. |
PartialFailureError |
Enum describing possible partial failure errors. |
PaymentsAccountError |
Enum describing possible errors in payments account service. |
PolicyFindingDetails |
Error returned as part of a mutate response. This error indicates one or more policy findings in the fields of a resource. |
PolicyFindingError |
Enum describing possible policy finding errors. |
PolicyValidationParameterError |
Enum describing possible policy validation parameter errors. |
PolicyViolationDetails |
Error returned as part of a mutate response. This error indicates single policy violation by some text in one of the fields. |
PolicyViolationError |
Enum describing possible policy violation errors. |
QueryError |
Enum describing possible query errors. |
QuotaErrorDetails |
Additional quota error details when there is QuotaError. |
QuotaErrorDetails.QuotaRateScope |
Enum of possible scopes that quota buckets belong to. |
QuotaError |
Enum describing possible quota errors. |
RangeError |
Enum describing possible range errors. |
ReachPlanError |
Enum describing possible errors from ReachPlanService. |
RecommendationError |
Enum describing possible errors from applying a recommendation. |