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

Google Ads API v8 - Reference

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.

AssetInteractionTarget

An AssetInteractionTarget segment.

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.

BudgetSimulationPoint

Projected metrics for a specific budget amount.

BudgetSimulationPointList

A container for simulation points for simulations of type BUDGET.

BusinessNameFilter

Represents a business name filter on locations in a FeedItemSet.

CallAdInfo

A call ad.

CallFeedItem

Represents a Call extension.

CalloutAsset

A Callout asset.

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.

ConceptGroup

The concept group for the keyword concept.

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 tracking_url_template, final_urls, or mobile_final_urls.

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).

HistoricalMetricsOptions

Historical metrics options.

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.

HotelCheckInDateRangeInfo

Criterion for a check-in date range.

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)

ItemAttribute

Item attributes of the transaction.

Keyword

A Keyword criterion segment.

KeywordAnnotations

The Annotations for the Keyword plan keywords.

KeywordConcept

The concept for the keyword.

KeywordInfo

A keyword criterion.

KeywordPlanAggregateMetricResults

The aggregated historical metrics for keyword plan keywords.

KeywordPlanAggregateMetrics

The aggregate metrics specification of the request.

KeywordPlanDeviceSearches

The total searches for the device type during the specified time period.

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.

KeywordThemeInfo

A Smart Campaign keyword theme.

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.

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.

PromotionAsset

A Promotion asset.

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.

SitelinkAsset

A Sitelink asset.

SitelinkFeedItem

Represents a sitelink extension.

SmartCampaignAdInfo

A Smart campaign ad.

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.

StructuredSnippetAsset

A Structured Snippet asset.

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).

TargetImpressionShareSimulationPoint

Projected metrics for a specific target impression share value.

TargetImpressionShareSimulationPointList

A container for simulation points for simulations of type TARGET_IMPRESSION_SHARE.

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

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.

WebpageSampleInfo

List of sample urls that match the website target

YearMonth

Year month.

YearMonthRange

The year month range inclusive of the start and end months. Eg: A year month range to represent Jan 2020 would be: (Jan 2020, Jan 2020).

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.

ConversionCustomVariableStatus

Possible statuses of a conversion custom variable.

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.

ConversionValueRulePrimaryDimension

Identifies the primary dimension for conversion value rule stats.

ConversionValueRuleSetStatus

Possible statuses of a conversion value rule set.

ConversionValueRuleStatus

Possible statuses of a conversion value rule.

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.

KeywordPlanAggregateMetricType

Aggregate fields.

KeywordPlanCompetitionLevel

Competition level of a keyword.

KeywordPlanConceptGroupType

Enumerates keyword plan concept group types.

KeywordPlanForecastInterval

Forecast intervals.

KeywordPlanKeywordAnnotation

Enumerates keyword plan annotations that can be requested.

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.

ResourceLimitType

Resource limit type.

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.

SeasonalityEventScope

The possible scopes of a Seasonality Event.

SeasonalityEventStatus

The possible statuses of a Seasonality Event.

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, click conversion, and conversion adjustment 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.

ValueRuleDeviceType

Possible device types used in conversion value rule.

ValueRuleGeoLocationMatchType

Possible geographic location matching types.

ValueRuleOperation

Possible operations of the action of a conversion value rule.

ValueRuleSetAttachmentType

Possible level where a value rule set is attached.

ValueRuleSetDimension

Possible dimensions of a conversion value rule set.

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.

ConversionCustomVariableError

Enum describing possible conversion custom variable errors.

ConversionUploadError

Enum describing possible conversion upload errors.

ConversionValueRuleError

Enum describing possible conversion value rule errors.

ConversionValueRuleSetError

Enum describing possible conversion value rule set 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.

RegionCodeError

Enum describing possible region code errors.

RequestError

Enum describing possible request errors.

ResourceAccessDeniedError

Enum describing possible resource access denied errors.

ResourceCountDetails

Error details returned when an resource count limit was exceeded.

ResourceCountLimitExceededError

Enum describing possible resource count limit exceeded errors.

SettingError

Enum describing possible setting errors.

SharedCriterionError

Enum describing possible shared criterion errors.

SharedSetError

Enum describing possible shared set errors.

SizeLimitError

Enum describing possible size limit errors.

StringFormatError

Enum describing possible string format errors.

StringLengthError

Enum describing possible string length errors.

ThirdPartyAppAnalyticsLinkError

Enum describing possible third party app analytics link errors.

TimeZoneError

Enum describing possible currency code errors.

UrlFieldError

Enum describing possible url field errors.

UserDataError

Enum describing possible request errors.

UserListError

Enum describing possible user list errors.

YoutubeVideoRegistrationError

Enum describing YouTube video registration errors.

misc

AccountBudgetProposalOperation

A single operation to propose the creation of a new account-level budget or edit/end/remove an existing one.

AccountLinkOperation

A single update on an account link.

AdGroupAdLabelOperation

A single operation (create, remove) on an ad group ad label.

AdGroupAdOperation

A single operation (create, update, remove) on an ad group ad.

AdGroupAssetOperation

A single operation (create, update, remove) on an ad group asset.

AdGroupBidModifierOperation

A single operation (create, remove, update) on an ad group bid modifier.

AdGroupCriterionLabelOperation

A single operation (create, remove) on an ad group criterion label.

AdGroupCriterionOperation

A single operation (create, remove, update) on an ad group criterion.

AdGroupExtensionSettingOperation

A single operation (create, update, remove) on an ad group extension setting.

AdGroupFeedOperation

A single operation (create, update, remove) on an ad group feed.

AdGroupLabelOperation

A single operation (create, remove) on an ad group label.

AdGroupOperation

A single operation (create, update, remove) on an ad group.

AdOperation

A single update operation on an ad.

AdParameterOperation

A single operation (create, update, remove) on ad parameter.

AddBatchJobOperationsRequest

Request message for BatchJobService.AddBatchJobOperations.

AddBatchJobOperationsResponse

Response message for BatchJobService.AddBatchJobOperations.

AddOfflineUserDataJobOperationsRequest

Request message for OfflineUserDataJobService.AddOfflineUserDataJobOperations.

AddOfflineUserDataJobOperationsResponse

Response message for OfflineUserDataJobService.AddOfflineUserDataJobOperations.

ApplyRecommendationOperation

Information about the operation to apply a recommendation and any parameters to customize it.

ApplyRecommendationOperation.CallExtensionParameters

Parameters to use when applying call extension recommendation.

ApplyRecommendationOperation.CalloutExtensionParameters

Parameters to use when applying callout extension recommendation.

ApplyRecommendationOperation.CampaignBudgetParameters

Parameters to use when applying a campaign budget recommendation.

ApplyRecommendationOperation.KeywordParameters

Parameters to use when applying keyword recommendation.

ApplyRecommendationOperation.MoveUnusedBudgetParameters

Parameters to use when applying move unused budget recommendation.

ApplyRecommendationOperation.ResponsiveSearchAdParameters

Parameters to use when applying a responsive search ad recommendation.

ApplyRecommendationOperation.SitelinkExtensionParameters

Parameters to use when applying sitelink extension recommendation.

ApplyRecommendationOperation.TargetCpaOptInParameters

Parameters to use when applying Target CPA recommendation.

ApplyRecommendationOperation.TargetRoasOptInParameters

Parameters to use when applying a Target ROAS opt-in recommendation.

ApplyRecommendationOperation.TextAdParameters

Parameters to use when applying a text ad recommendation.

ApplyRecommendationRequest

Request message for RecommendationService.ApplyRecommendation.

ApplyRecommendationResponse

Response message for RecommendationService.ApplyRecommendation.

ApplyRecommendationResult

The result of applying a recommendation.

AssetOperation

A single operation to create an asset. Supported asset types are YoutubeVideoAsset, MediaBundleAsset, ImageAsset, and LeadFormAsset. TextAsset should be created with Ad inline.

BatchJobOperation

A single operation on a batch job.

BatchJobResult

An individual batch job result.

BiddingDataExclusionOperation

A single operation (create, remove, update) on a data exclusion.

BiddingSeasonalityAdjustmentOperation

A single operation (create, remove, update) on a seasonality adjustment.

BiddingStrategyOperation

A single operation (create, update, remove) on a bidding strategy.

BillingSetupOperation

A single operation on a billing setup, which describes the cancellation of an existing billing setup.

CallConversion

A call conversion.

CallConversionResult

Identifying information for a successfully processed CallConversionUpload.

CampaignAssetOperation

A single operation (create, update, remove) on a campaign asset.

CampaignBidModifierOperation

A single operation (create, remove, update) on a campaign bid modifier.

CampaignBudgetOperation

A single operation (create, update, remove) on a campaign budget.

CampaignCriterionOperation

A single operation (create, update, remove) on a campaign criterion.

CampaignDraftOperation

A single operation (create, update, remove) on a campaign draft.

CampaignDuration

The duration of a planned campaign.

CampaignExperimentOperation

A single update operation on a campaign experiment.

CampaignExtensionSettingOperation

A single operation (create, update, remove) on a campaign extension setting.

CampaignFeedOperation

A single operation (create, update, remove) on a campaign feed.

CampaignLabelOperation

A single operation (create, remove) on a campaign-label relationship.

CampaignOperation

A single operation (create, update, remove) on a campaign.

CampaignSharedSetOperation

A single operation (create, remove) on an campaign shared set.

CartData

Contains additional information about cart data.

CartData.Item

Contains data of the items purchased.

ClickConversion

A click conversion.

ClickConversionResult

Identifying information for a successfully processed ClickConversion.

ConversionActionOperation

A single operation (create, update, remove) on a conversion action.

ConversionAdjustment

A conversion adjustment.

ConversionAdjustmentResult

Information identifying a successfully processed ConversionAdjustment.

ConversionCustomVariableOperation

A single operation (create, update) on a conversion custom variable.

ConversionValueRuleOperation

A single operation (create, update, remove) on a conversion value rule.

ConversionValueRuleSetOperation

A single operation (create, update, remove) on a conversion value rule set.

CreateAccountLinkRequest

Request message for AccountLinkService.CreateAccountLink.

CreateAccountLinkResponse

Response message for AccountLinkService.CreateAccountLink.

CreateCampaignExperimentMetadata

Message used as metadata returned in Long Running Operations for CreateCampaignExperimentRequest

CreateCampaignExperimentRequest

Request message for CampaignExperimentService.CreateCampaignExperiment.

CreateCustomerClientRequest

Request message for CustomerService.CreateCustomerClient.

CreateCustomerClientResponse

Response message for CreateCustomerClient mutate.

CreateOfflineUserDataJobRequest

Request message for OfflineUserDataJobService.CreateOfflineUserDataJob.

CreateOfflineUserDataJobResponse

Response message for OfflineUserDataJobService.CreateOfflineUserDataJob.

CustomAudienceOperation

A single operation (create, update) on a custom audience.

CustomInterestOperation

A single operation (create, update) on a custom interest.

CustomVariable

A custom variable.

CustomerAssetOperation

A single operation (create, update, remove) on a customer asset.

CustomerClientLinkOperation

A single operation (create, update) on a CustomerClientLink.

CustomerExtensionSettingOperation

A single operation (create, update, remove) on a customer extension setting.

CustomerFeedOperation

A single operation (create, update, remove) on a customer feed.

CustomerLabelOperation

A single operation (create, remove) on a customer-label relationship.

CustomerManagerLinkOperation

Updates the status of a CustomerManagerLink. The following actions are possible: 1. Update operation with status ACTIVE accepts a pending invitation. 2. Update operation with status REFUSED declines a pending invitation. 3. Update operation with status INACTIVE terminates link to manager.

CustomerNegativeCriterionOperation

A single operation (create or remove) on a customer level negative criterion.

CustomerOperation

A single update on a customer.

CustomerUserAccessInvitationOperation

A single operation (create or remove) on customer user access invitation.

CustomerUserAccessOperation

A single operation (update, remove) on customer user access.

DismissRecommendationRequest

Request message for RecommendationService.DismissRecommendation.

DismissRecommendationRequest.DismissRecommendationOperation

Operation to dismiss a single recommendation identified by resource_name.

DismissRecommendationResponse

Response message for RecommendationService.DismissRecommendation.

DismissRecommendationResponse.DismissRecommendationResult

The result of dismissing a recommendation.

EffectiveFrequencyBreakdown

A breakdown of the number of unique people reached at a given effective frequency.

EffectiveFrequencyLimit

Effective frequency limit.

EndCampaignExperimentRequest

Request message for CampaignExperimentService.EndCampaignExperiment.

ExtensionFeedItemOperation

A single operation (create, update, remove) on an extension feed item.

ExternalAttributionData

Contains additional information about externally attributed conversions.

FeedItemOperation

A single operation (create, update, remove) on an feed item.

FeedItemSetLinkOperation

A single operation (create, update, remove) on a feed item set link.

FeedItemSetOperation

A single operation (create, remove) on an feed item set.

FeedItemTargetOperation

A single operation (create, remove) on an feed item target.

FeedMappingOperation

A single operation (create, remove) on a feed mapping.

FeedOperation

A single operation (create, update, remove) on an feed.

Forecast

Forecasted traffic metrics for the planned products and targeting.

ForecastMetrics

Forecast metrics.

FrequencyCap

A rule specifying the maximum number of times an ad can be shown to a user over a particular time period.

GclidDateTimePair

Uniquely identifies a conversion that was reported without an order ID specified.

GenerateForecastCurveRequest

Request message for KeywordPlanService.GenerateForecastCurve.

GenerateForecastCurveResponse

Response message for KeywordPlanService.GenerateForecastCurve.

GenerateForecastMetricsRequest

Request message for KeywordPlanService.GenerateForecastMetrics.

GenerateForecastMetricsResponse

Response message for KeywordPlanService.GenerateForecastMetrics.

GenerateForecastTimeSeriesRequest

Request message for KeywordPlanService.GenerateForecastTimeSeries.

GenerateForecastTimeSeriesResponse

Response message for KeywordPlanService.GenerateForecastTimeSeries.

GenerateHistoricalMetricsRequest

Request message for KeywordPlanService.GenerateHistoricalMetrics.

GenerateHistoricalMetricsResponse

Response message for KeywordPlanService.GenerateHistoricalMetrics.

GenerateKeywordIdeaResponse

Response message for KeywordPlanIdeaService.GenerateKeywordIdeas.

GenerateKeywordIdeaResult

The result of generating keyword ideas.

GenerateKeywordIdeasRequest

Request message for KeywordPlanIdeaService.GenerateKeywordIdeas.

GenerateProductMixIdeasRequest

Request message for ReachPlanService.GenerateProductMixIdeas.

GenerateProductMixIdeasResponse

The suggested product mix.

GenerateReachForecastRequest

Request message for ReachPlanService.GenerateReachForecast.

GenerateReachForecastResponse

Response message containing the generated reach curve.

GeoTargetConstantSuggestion

A geo target constant suggestion.

GetAccessibleBiddingStrategyRequest

Request message for AccessibleBiddingStrategyService.GetAccessibleBiddingStrategy.

GetAccountBudgetProposalRequest

Request message for AccountBudgetProposalService.GetAccountBudgetProposal.

GetAccountBudgetRequest

Request message for AccountBudgetService.GetAccountBudget.

GetAccountLinkRequest

Request message for AccountLinkService.GetAccountLink.

GetAdGroupAdAssetViewRequest

Request message for AdGroupAdAssetViewService.GetAdGroupAdAssetView.

GetAdGroupAdLabelRequest

Request message for AdGroupAdLabelService.GetAdGroupAdLabel.

GetAdGroupAdRequest

Request message for AdGroupAdService.GetAdGroupAd.

GetAdGroupAssetRequest

Request message for AdGroupAssetService.GetAdGroupAsset.

GetAdGroupAudienceViewRequest

Request message for AdGroupAudienceViewService.GetAdGroupAudienceView.

GetAdGroupBidModifierRequest

Request message for AdGroupBidModifierService.GetAdGroupBidModifier.

GetAdGroupCriterionLabelRequest

Request message for AdGroupCriterionLabelService.GetAdGroupCriterionLabel.

GetAdGroupCriterionRequest

Request message for AdGroupCriterionService.GetAdGroupCriterion.

GetAdGroupCriterionSimulationRequest

Request message for AdGroupCriterionSimulationService.GetAdGroupCriterionSimulation.

GetAdGroupExtensionSettingRequest

Request message for AdGroupExtensionSettingService.GetAdGroupExtensionSetting.

GetAdGroupFeedRequest

Request message for AdGroupFeedService.GetAdGroupFeed.

GetAdGroupLabelRequest

Request message for AdGroupLabelService.GetAdGroupLabel.

GetAdGroupRequest

Request message for AdGroupService.GetAdGroup.

GetAdGroupSimulationRequest

Request message for AdGroupSimulationService.GetAdGroupSimulation.

GetAdParameterRequest

Request message for AdParameterService.GetAdParameter

GetAdRequest

Request message for AdService.GetAd.

GetAdScheduleViewRequest

Request message for AdScheduleViewService.GetAdScheduleView.

GetAgeRangeViewRequest

Request message for AgeRangeViewService.GetAgeRangeView.

GetAssetFieldTypeViewRequest

Request message for AssetFieldTypeViewService.GetAssetFieldTypeView.

GetAssetRequest

Request message for AssetService.GetAsset

GetBatchJobRequest

Request message for BatchJobService.GetBatchJob.

GetBiddingDataExclusionRequest

Request message for BiddingDataExclusionService.GetBiddingDataExclusion.

GetBiddingSeasonalityAdjustmentRequest

Request message for BiddingSeasonalityAdjustmentService.GetBiddingSeasonalityAdjustment.

GetBiddingStrategyRequest

Request message for BiddingStrategyService.GetBiddingStrategy.

GetBiddingStrategySimulationRequest

Request message for BiddingStrategySimulationService.GetBiddingStrategySimulation.

GetBillingSetupRequest

Request message for BillingSetupService.GetBillingSetup.

GetCampaignAssetRequest

Request message for CampaignAssetService.GetCampaignAsset.

GetCampaignAudienceViewRequest

Request message for CampaignAudienceViewService.GetCampaignAudienceView.

GetCampaignBidModifierRequest

Request message for CampaignBidModifierService.GetCampaignBidModifier.

GetCampaignBudgetRequest

Request message for CampaignBudgetService.GetCampaignBudget.

GetCampaignCriterionRequest

Request message for CampaignCriterionService.GetCampaignCriterion.

GetCampaignCriterionSimulationRequest

Request message for CampaignCriterionSimulationService.GetCampaignCriterionSimulation.

GetCampaignDraftRequest

Request message for CampaignDraftService.GetCampaignDraft.

GetCampaignExperimentRequest

Request message for CampaignExperimentService.GetCampaignExperiment.

GetCampaignExtensionSettingRequest

Request message for CampaignExtensionSettingService.GetCampaignExtensionSetting.

GetCampaignFeedRequest

Request message for CampaignFeedService.GetCampaignFeed.

GetCampaignLabelRequest

Request message for CampaignLabelService.GetCampaignLabel.

GetCampaignRequest

Request message for CampaignService.GetCampaign.

GetCampaignSharedSetRequest

Request message for CampaignSharedSetService.GetCampaignSharedSet.

GetCampaignSimulationRequest

Request message for CampaignSimulationService.GetCampaignSimulation.

GetCarrierConstantRequest

Request message for CarrierConstantService.GetCarrierConstant.

GetChangeStatusRequest

Request message for 'ChangeStatusService.GetChangeStatus'.

GetClickViewRequest

Request message for ClickViewService.GetClickView.

GetCombinedAudienceRequest

Request message for CombinedAudienceService.GetCombinedAudience.

GetConversionActionRequest

Request message for ConversionActionService.GetConversionAction.

GetConversionCustomVariableRequest

Request message for ConversionCustomVariableService.GetConversionCustomVariable.

GetConversionValueRuleRequest

Request message for ConversionValueRuleService.GetConversionValueRule.

GetConversionValueRuleSetRequest

Request message for ConversionValueRuleSetService.GetConversionValueRuleSet.

GetCurrencyConstantRequest

Request message for CurrencyConstantService.GetCurrencyConstant.

GetCustomAudienceRequest

Request message for CustomAudienceService.GetCustomAudience.

GetCustomInterestRequest

Request message for CustomInterestService.GetCustomInterest.

GetCustomerAssetRequest

Request message for CustomerAssetService.GetCustomerAsset.

GetCustomerClientLinkRequest

Request message for CustomerClientLinkService.GetCustomerClientLink.

GetCustomerClientRequest

Request message for CustomerClientService.GetCustomerClient.

GetCustomerExtensionSettingRequest

Request message for CustomerExtensionSettingService.GetCustomerExtensionSetting.

GetCustomerFeedRequest

Request message for CustomerFeedService.GetCustomerFeed.

GetCustomerLabelRequest

Request message for CustomerLabelService.GetCustomerLabel.

GetCustomerManagerLinkRequest

Request message for CustomerManagerLinkService.GetCustomerManagerLink.

GetCustomerNegativeCriterionRequest

Request message for CustomerNegativeCriterionService.GetCustomerNegativeCriterion.

GetCustomerRequest

Request message for CustomerService.GetCustomer.

GetCustomerUserAccessInvitationRequest

Request message for [CustomerUserAccessInvitation.GetCustomerUserAccessInvitation][]

GetCustomerUserAccessRequest

Request message for CustomerUserAccessService.GetCustomerUserAccess.

GetDetailPlacementViewRequest

Request message for DetailPlacementViewService.GetDetailPlacementView.

GetDetailedDemographicRequest

Request message for DetailedDemographicService.GetDetailedDemographic.

GetDisplayKeywordViewRequest

Request message for DisplayKeywordViewService.GetDisplayKeywordView.

GetDistanceViewRequest

Request message for DistanceViewService.GetDistanceView.

GetDomainCategoryRequest

Request message for DomainCategoryService.GetDomainCategory.

GetDynamicSearchAdsSearchTermViewRequest

Request message for DynamicSearchAdsSearchTermViewService.GetDynamicSearchAdsSearchTermView.

GetExpandedLandingPageViewRequest

Request message for ExpandedLandingPageViewService.GetExpandedLandingPageView.

GetExtensionFeedItemRequest

Request message for ExtensionFeedItemService.GetExtensionFeedItem.

GetFeedItemRequest

Request message for FeedItemService.GetFeedItem.

GetFeedItemSetLinkRequest

Request message for [FeedItemSetLinkService.GetFeedItemSetLinks][].

GetFeedItemSetRequest

Request message for FeedItemSetService.GetFeedItemSet.

GetFeedItemTargetRequest

Request message for FeedItemTargetService.GetFeedItemTarget.

GetFeedMappingRequest

Request message for FeedMappingService.GetFeedMapping.

GetFeedPlaceholderViewRequest

Request message for FeedPlaceholderViewService.GetFeedPlaceholderView.

GetFeedRequest

Request message for FeedService.GetFeed.

GetGenderViewRequest

Request message for GenderViewService.GetGenderView.

GetGeoTargetConstantRequest

Request message for GeoTargetConstantService.GetGeoTargetConstant.

GetGeographicViewRequest

Request message for GeographicViewService.GetGeographicView.

GetGoogleAdsFieldRequest

Request message for GoogleAdsFieldService.GetGoogleAdsField.

GetGroupPlacementViewRequest

Request message for GroupPlacementViewService.GetGroupPlacementView.

GetHotelGroupViewRequest

Request message for HotelGroupViewService.GetHotelGroupView.

GetHotelPerformanceViewRequest

Request message for HotelPerformanceViewService.GetHotelPerformanceView.

GetIncomeRangeViewRequest

Request message for IncomeRangeViewService.GetIncomeRangeView.

GetKeywordPlanAdGroupKeywordRequest

Request message for KeywordPlanAdGroupKeywordService.GetKeywordPlanAdGroupKeyword.

GetKeywordPlanAdGroupRequest

Request message for KeywordPlanAdGroupService.GetKeywordPlanAdGroup.

GetKeywordPlanCampaignKeywordRequest

Request message for KeywordPlanCampaignKeywordService.GetKeywordPlanCampaignKeyword.

GetKeywordPlanCampaignRequest

Request message for KeywordPlanCampaignService.GetKeywordPlanCampaign.

GetKeywordPlanRequest

Request message for KeywordPlanService.GetKeywordPlan.

GetKeywordThemeConstantRequest

Request message for KeywordThemeConstantService.GetKeywordThemeConstant.

GetKeywordViewRequest

Request message for KeywordViewService.GetKeywordView.

GetLabelRequest

Request message for LabelService.GetLabel.

GetLandingPageViewRequest

Request message for LandingPageViewService.GetLandingPageView.

GetLanguageConstantRequest

Request message for LanguageConstantService.GetLanguageConstant.

GetLifeEventRequest

Request message for LifeEventService.GetLifeEvent.

GetLocationViewRequest

Request message for LocationViewService.GetLocationView.

GetManagedPlacementViewRequest

Request message for ManagedPlacementViewService.GetManagedPlacementView.

GetMediaFileRequest

Request message for MediaFileService.GetMediaFile

GetMerchantCenterLinkRequest

Request message for MerchantCenterLinkService.GetMerchantCenterLink.

GetMobileAppCategoryConstantRequest

Request message for MobileAppCategoryConstantService.GetMobileAppCategoryConstant.

GetMobileDeviceConstantRequest

Request message for MobileDeviceConstantService.GetMobileDeviceConstant.

GetOfflineUserDataJobRequest

Request message for OfflineUserDataJobService.GetOfflineUserDataJob.

GetOperatingSystemVersionConstantRequest

Request message for OperatingSystemVersionConstantService.GetOperatingSystemVersionConstant.

GetPaidOrganicSearchTermViewRequest

Request message for PaidOrganicSearchTermViewService.GetPaidOrganicSearchTermView.

GetParentalStatusViewRequest

Request message for ParentalStatusViewService.GetParentalStatusView.

GetProductBiddingCategoryConstantRequest

Request message for ProductBiddingCategoryConstantService.GetProductBiddingCategoryConstant.

GetProductGroupViewRequest

Request message for ProductGroupViewService.GetProductGroupView.

GetRecommendationRequest

Request message for RecommendationService.GetRecommendation.

GetRemarketingActionRequest

Request message for RemarketingActionService.GetRemarketingAction.

GetSearchTermViewRequest

Request message for SearchTermViewService.GetSearchTermView.

GetSharedCriterionRequest

Request message for SharedCriterionService.GetSharedCriterion.

GetSharedSetRequest

Request message for SharedSetService.GetSharedSet.

GetShoppingPerformanceViewRequest

Request message for ShoppingPerformanceViewService.GetShoppingPerformanceView.

GetSmartCampaignSearchTermViewRequest

Request message for SmartCampaignSearchTermViewService.GetSmartCampaignSearchTermView.

GetSmartCampaignSettingRequest

Request message for SmartCampaignSettingService.GetSmartCampaignSetting.

GetThirdPartyAppAnalyticsLinkRequest

Request message for ThirdPartyAppAnalyticsLinkService.GetThirdPartyAppAnalyticsLink.

GetTopicConstantRequest

Request message for TopicConstantService.GetTopicConstant.

GetTopicViewRequest

Request message for TopicViewService.GetTopicView.

GetUserInterestRequest

Request message for UserInterestService.GetUserInterest.

GetUserListRequest

Request message for UserListService.GetUserList.

GetUserLocationViewRequest

Request message for UserLocationViewService.GetUserLocationView.

GetVideoRequest

Request message for VideoService.GetVideo.

GetWebpageViewRequest

Request message for WebpageViewService.GetWebpageView.

GoogleAdsRow

A returned row from the query.

GraduateCampaignExperimentRequest

Request message for CampaignExperimentService.GraduateCampaignExperiment.

GraduateCampaignExperimentResponse

Response message for campaign experiment graduate.

KeywordAndUrlSeed

Keyword And Url Seed

KeywordPlanAdGroupForecast

An ad group forecast.

KeywordPlanAdGroupKeywordOperation

A single operation (create, update, remove) on a Keyword Plan ad group keyword.

KeywordPlanAdGroupOperation

A single operation (create, update, remove) on a Keyword Plan ad group.

KeywordPlanCampaignForecast

A campaign forecast.

KeywordPlanCampaignForecastCurve

The forecast curve for the campaign.

KeywordPlanCampaignKeywordOperation

A single operation (create, update, remove) on a Keyword Plan campaign keyword.

KeywordPlanCampaignOperation

A single operation (create, update, remove) on a Keyword Plan campaign.

KeywordPlanKeywordForecast

A keyword forecast.

KeywordPlanKeywordHistoricalMetrics

A keyword historical metrics.

KeywordPlanMaxCpcBidForecast

The forecast of the campaign at a specific bid.

KeywordPlanMaxCpcBidForecastCurve

The max cpc bid forecast curve.

KeywordPlanOperation

A single operation (create, update, remove) on a keyword plan.

KeywordPlanWeeklyForecast

The forecast of the campaign for the week starting start_date.

KeywordPlanWeeklyTimeSeriesForecast

The weekly time series forecast for the keyword plan campaign.

KeywordSeed

Keyword Seed

LabelOperation

A single operation (create, remove, update) on a label.

ListAccessibleCustomersRequest

Request message for CustomerService.ListAccessibleCustomers.

ListAccessibleCustomersResponse

Response message for CustomerService.ListAccessibleCustomers.

ListBatchJobResultsRequest

Request message for BatchJobService.ListBatchJobResults.

ListBatchJobResultsResponse

Response message for BatchJobService.ListBatchJobResults.

ListCampaignDraftAsyncErrorsRequest

Request message for CampaignDraftService.ListCampaignDraftAsyncErrors.

ListCampaignDraftAsyncErrorsResponse

Response message for CampaignDraftService.ListCampaignDraftAsyncErrors.

ListCampaignExperimentAsyncErrorsRequest

Request message for CampaignExperimentService.ListCampaignExperimentAsyncErrors.

ListCampaignExperimentAsyncErrorsResponse

Response message for CampaignExperimentService.ListCampaignExperimentAsyncErrors.

ListInvoicesRequest

Request message for fetching the invoices of a given billing setup that were issued during a given month.

ListInvoicesResponse

Response message for InvoiceService.ListInvoices.

ListMerchantCenterLinksRequest

Request message for MerchantCenterLinkService.ListMerchantCenterLinks.

ListMerchantCenterLinksResponse

Response message for MerchantCenterLinkService.ListMerchantCenterLinks.

ListPaymentsAccountsRequest

Request message for fetching all accessible payments accounts.

ListPaymentsAccountsResponse

Response message for PaymentsAccountService.ListPaymentsAccounts.

ListPlannableLocationsRequest

Request message for ReachPlanService.ListPlannableLocations.

ListPlannableLocationsResponse

The list of plannable locations.

ListPlannableProductsRequest

Request to list available products in a given location.

ListPlannableProductsResponse

A response with all available products.

MediaFileOperation

A single operation to create media file.

MerchantCenterLinkOperation

A single update on a Merchant Center link.

MoveManagerLinkRequest

Request message for CustomerManagerLinkService.MoveManagerLink.

MoveManagerLinkResponse

Response message for a CustomerManagerLink moveManagerLink.

MutateAccountBudgetProposalRequest

Request message for AccountBudgetProposalService.MutateAccountBudgetProposal.

MutateAccountBudgetProposalResponse

Response message for account-level budget mutate operations.

MutateAccountBudgetProposalResult

The result for the account budget proposal mutate.

MutateAccountLinkRequest

Request message for AccountLinkService.MutateAccountLink.

MutateAccountLinkResponse

Response message for account link mutate.

MutateAccountLinkResult

The result for the account link mutate.

MutateAdGroupAdLabelResult

The result for an ad group ad label mutate.

MutateAdGroupAdLabelsRequest

Request message for AdGroupAdLabelService.MutateAdGroupAdLabels.

MutateAdGroupAdLabelsResponse

Response message for an ad group ad labels mutate.

MutateAdGroupAdResult

The result for the ad mutate.

MutateAdGroupAdsRequest

Request message for AdGroupAdService.MutateAdGroupAds.

MutateAdGroupAdsResponse

Response message for an ad group ad mutate.

MutateAdGroupAssetResult

The result for the ad group asset mutate.

MutateAdGroupAssetsRequest

Request message for AdGroupAssetService.MutateAdGroupAssets.

MutateAdGroupAssetsResponse

Response message for an ad group asset mutate.

MutateAdGroupBidModifierResult

The result for the criterion mutate.

MutateAdGroupBidModifiersRequest

Request message for AdGroupBidModifierService.MutateAdGroupBidModifiers.

MutateAdGroupBidModifiersResponse

Response message for ad group bid modifiers mutate.

MutateAdGroupCriteriaRequest

Request message for AdGroupCriterionService.MutateAdGroupCriteria.

MutateAdGroupCriteriaResponse

Response message for an ad group criterion mutate.

MutateAdGroupCriterionLabelResult

The result for an ad group criterion label mutate.

MutateAdGroupCriterionLabelsRequest

Request message for AdGroupCriterionLabelService.MutateAdGroupCriterionLabels.

MutateAdGroupCriterionLabelsResponse

Response message for an ad group criterion labels mutate.

MutateAdGroupCriterionResult

The result for the criterion mutate.

MutateAdGroupExtensionSettingResult

The result for the ad group extension setting mutate.

MutateAdGroupExtensionSettingsRequest

Request message for AdGroupExtensionSettingService.MutateAdGroupExtensionSettings.

MutateAdGroupExtensionSettingsResponse

Response message for an ad group extension setting mutate.

MutateAdGroupFeedResult

The result for the ad group feed mutate.

MutateAdGroupFeedsRequest

Request message for AdGroupFeedService.MutateAdGroupFeeds.

MutateAdGroupFeedsResponse

Response message for an ad group feed mutate.

MutateAdGroupLabelResult

The result for an ad group label mutate.

MutateAdGroupLabelsRequest

Request message for AdGroupLabelService.MutateAdGroupLabels.

MutateAdGroupLabelsResponse

Response message for an ad group labels mutate.

MutateAdGroupResult

The result for the ad group mutate.

MutateAdGroupsRequest

Request message for AdGroupService.MutateAdGroups.

MutateAdGroupsResponse

Response message for an ad group mutate.

MutateAdParameterResult

The result for the ad parameter mutate.

MutateAdParametersRequest

Request message for AdParameterService.MutateAdParameters

MutateAdParametersResponse

Response message for an ad parameter mutate.

MutateAdResult

The result for the ad mutate.

MutateAdsRequest

Request message for AdService.MutateAds.

MutateAdsResponse

Response message for an ad mutate.

MutateAssetResult

The result for the asset mutate.

MutateAssetsRequest

Request message for AssetService.MutateAssets

MutateAssetsResponse

Response message for an asset mutate.

MutateBatchJobRequest

Request message for BatchJobService.MutateBatchJob.

MutateBatchJobResponse

Response message for BatchJobService.MutateBatchJob.

MutateBatchJobResult

The result for the batch job mutate.

MutateBiddingDataExclusionsRequest

Request message for BiddingDataExclusionService.MutateBiddingDataExclusions.

MutateBiddingDataExclusionsResponse

Response message for data exlusions mutate.

MutateBiddingDataExclusionsResult

The result for the data exclusion mutate.

MutateBiddingSeasonalityAdjustmentsRequest

Request message for BiddingSeasonalityAdjustmentService.MutateBiddingSeasonalityAdjustments.

MutateBiddingSeasonalityAdjustmentsResponse

Response message for seasonality adjustments mutate.

MutateBiddingSeasonalityAdjustmentsResult

The result for the seasonality adjustment mutate.

MutateBiddingStrategiesRequest

Request message for BiddingStrategyService.MutateBiddingStrategies.

MutateBiddingStrategiesResponse

Response message for bidding strategy mutate.

MutateBiddingStrategyResult

The result for the bidding strategy mutate.

MutateBillingSetupRequest

Request message for billing setup mutate operations.

MutateBillingSetupResponse

Response message for a billing setup operation.

MutateBillingSetupResult

Result for a single billing setup mutate.

MutateCampaignAssetResult

The result for the campaign asset mutate.

MutateCampaignAssetsRequest

Request message for CampaignAssetService.MutateCampaignAssets.

MutateCampaignAssetsResponse

Response message for a campaign asset mutate.

MutateCampaignBidModifierResult

The result for the criterion mutate.

MutateCampaignBidModifiersRequest

Request message for CampaignBidModifierService.MutateCampaignBidModifiers.

MutateCampaignBidModifiersResponse

Response message for campaign bid modifiers mutate.

MutateCampaignBudgetResult

The result for the campaign budget mutate.

MutateCampaignBudgetsRequest

Request message for CampaignBudgetService.MutateCampaignBudgets.

MutateCampaignBudgetsResponse

Response message for campaign budget mutate.

MutateCampaignCriteriaRequest

Request message for CampaignCriterionService.MutateCampaignCriteria.

MutateCampaignCriteriaResponse

Response message for campaign criterion mutate.

MutateCampaignCriterionResult

The result for the criterion mutate.

MutateCampaignDraftResult

The result for the campaign draft mutate.

MutateCampaignDraftsRequest

Request message for CampaignDraftService.MutateCampaignDrafts.

MutateCampaignDraftsResponse

Response message for campaign draft mutate.

MutateCampaignExperimentResult

The result for the campaign experiment mutate.

MutateCampaignExperimentsRequest

Request message for CampaignExperimentService.MutateCampaignExperiments.

MutateCampaignExperimentsResponse

Response message for campaign experiment mutate.

MutateCampaignExtensionSettingResult

The result for the campaign extension setting mutate.

MutateCampaignExtensionSettingsRequest

Request message for CampaignExtensionSettingService.MutateCampaignExtensionSettings.

MutateCampaignExtensionSettingsResponse

Response message for a campaign extension setting mutate.

MutateCampaignFeedResult

The result for the campaign feed mutate.

MutateCampaignFeedsRequest

Request message for CampaignFeedService.MutateCampaignFeeds.

MutateCampaignFeedsResponse

Response message for a campaign feed mutate.

MutateCampaignLabelResult

The result for a campaign label mutate.

MutateCampaignLabelsRequest

Request message for CampaignLabelService.MutateCampaignLabels.

MutateCampaignLabelsResponse

Response message for a campaign labels mutate.

MutateCampaignResult

The result for the campaign mutate.

MutateCampaignSharedSetResult

The result for the campaign shared set mutate.

MutateCampaignSharedSetsRequest

Request message for CampaignSharedSetService.MutateCampaignSharedSets.

MutateCampaignSharedSetsResponse

Response message for a campaign shared set mutate.

MutateCampaignsRequest

Request message for CampaignService.MutateCampaigns.

MutateCampaignsResponse

Response message for campaign mutate.

MutateConversionActionResult

The result for the conversion action mutate.

MutateConversionActionsRequest

Request message for ConversionActionService.MutateConversionActions.

MutateConversionActionsResponse

Response message for ConversionActionService.MutateConversionActions.

MutateConversionCustomVariableResult

The result for the conversion custom variable mutate.

MutateConversionCustomVariablesRequest

Request message for ConversionCustomVariableService.MutateConversionCustomVariables.

MutateConversionCustomVariablesResponse

Response message for ConversionCustomVariableService.MutateConversionCustomVariables.

MutateConversionValueRuleResult

The result for the conversion value rule mutate.

MutateConversionValueRuleSetResult

The result for the conversion value rule set mutate.

MutateConversionValueRuleSetsRequest

Request message for ConversionValueRuleSetService.MutateConversionValueRuleSets.

MutateConversionValueRuleSetsResponse

Response message for ConversionValueRuleSetService.MutateConversionValueRuleSets.

MutateConversionValueRulesRequest

Request message for ConversionValueRuleService.MutateConversionValueRules.

MutateConversionValueRulesResponse

Response message for ConversionValueRuleService.MutateConversionValueRules.

MutateCustomAudienceResult

The result for the custom audience mutate.

MutateCustomAudiencesRequest

Request message for CustomAudienceService.MutateCustomAudiences.

MutateCustomAudiencesResponse

Response message for custom audience mutate.

MutateCustomInterestResult

The result for the custom interest mutate.

MutateCustomInterestsRequest

Request message for CustomInterestService.MutateCustomInterests.

MutateCustomInterestsResponse

Response message for custom interest mutate.

MutateCustomerAssetResult

The result for the customer asset mutate.

MutateCustomerAssetsRequest

Request message for CustomerAssetService.MutateCustomerAssets.

MutateCustomerAssetsResponse

Response message for a customer asset mutate.

MutateCustomerClientLinkRequest

Request message for CustomerClientLinkService.MutateCustomerClientLink.

MutateCustomerClientLinkResponse

Response message for a CustomerClientLink mutate.

MutateCustomerClientLinkResult

The result for a single customer client link mutate.

MutateCustomerExtensionSettingResult

The result for the customer extension setting mutate.

MutateCustomerExtensionSettingsRequest

Request message for CustomerExtensionSettingService.MutateCustomerExtensionSettings.

MutateCustomerExtensionSettingsResponse

Response message for a customer extension setting mutate.

MutateCustomerFeedResult

The result for the customer feed mutate.

MutateCustomerFeedsRequest

Request message for CustomerFeedService.MutateCustomerFeeds.

MutateCustomerFeedsResponse

Response message for a customer feed mutate.

MutateCustomerLabelResult

The result for a customer label mutate.

MutateCustomerLabelsRequest

Request message for CustomerLabelService.MutateCustomerLabels.

MutateCustomerLabelsResponse

Response message for a customer labels mutate.

MutateCustomerManagerLinkRequest

Request message for CustomerManagerLinkService.MutateCustomerManagerLink.

MutateCustomerManagerLinkResponse

Response message for a CustomerManagerLink mutate.

MutateCustomerManagerLinkResult

The result for the customer manager link mutate.

MutateCustomerNegativeCriteriaRequest

Request message for CustomerNegativeCriterionService.MutateCustomerNegativeCriteria.

MutateCustomerNegativeCriteriaResponse

Response message for customer negative criterion mutate.

MutateCustomerNegativeCriteriaResult

The result for the criterion mutate.

MutateCustomerRequest

Request message for CustomerService.MutateCustomer.

MutateCustomerResponse

Response message for customer mutate.

MutateCustomerResult

The result for the customer mutate.

MutateCustomerUserAccessInvitationRequest

Request message for [CustomerUserAccessInvitation.MutateCustomerUserAccessInvitation][]

MutateCustomerUserAccessInvitationResponse

Response message for access invitation mutate.

MutateCustomerUserAccessInvitationResult

The result for the access invitation mutate.

MutateCustomerUserAccessRequest

Mutate Request for CustomerUserAccessService.MutateCustomerUserAccess.

MutateCustomerUserAccessResponse

Response message for customer user access mutate.

MutateCustomerUserAccessResult

The result for the customer user access mutate.

MutateExtensionFeedItemResult

The result for the extension feed item mutate.

MutateExtensionFeedItemsRequest

Request message for ExtensionFeedItemService.MutateExtensionFeedItems.

MutateExtensionFeedItemsResponse

Response message for an extension feed item mutate.

MutateFeedItemResult

The result for the feed item mutate.

MutateFeedItemSetLinkResult

The result for the feed item set link mutate.

MutateFeedItemSetLinksRequest

Request message for FeedItemSetLinkService.MutateFeedItemSetLinks.

MutateFeedItemSetLinksResponse

Response message for a feed item set link mutate.

MutateFeedItemSetResult

The result for the feed item set mutate.

MutateFeedItemSetsRequest

Request message for FeedItemSetService.MutateFeedItemSets.

MutateFeedItemSetsResponse

Response message for an feed item set mutate.

MutateFeedItemTargetResult

The result for the feed item target mutate.

MutateFeedItemTargetsRequest

Request message for FeedItemTargetService.MutateFeedItemTargets.

MutateFeedItemTargetsResponse

Response message for an feed item target mutate.

MutateFeedItemsRequest

Request message for FeedItemService.MutateFeedItems.

MutateFeedItemsResponse

Response message for an feed item mutate.

MutateFeedMappingResult

The result for the feed mapping mutate.

MutateFeedMappingsRequest

Request message for FeedMappingService.MutateFeedMappings.

MutateFeedMappingsResponse

Response message for a feed mapping mutate.

MutateFeedResult

The result for the feed mutate.

MutateFeedsRequest

Request message for FeedService.MutateFeeds.

MutateFeedsResponse

Response message for an feed mutate.

MutateGoogleAdsRequest

Request message for GoogleAdsService.Mutate.

MutateGoogleAdsResponse

Response message for GoogleAdsService.Mutate.

MutateKeywordPlanAdGroupKeywordResult

The result for the Keyword Plan ad group keyword mutate.

MutateKeywordPlanAdGroupKeywordsRequest

Request message for KeywordPlanAdGroupKeywordService.MutateKeywordPlanAdGroupKeywords.

MutateKeywordPlanAdGroupKeywordsResponse

Response message for a Keyword Plan ad group keyword mutate.

MutateKeywordPlanAdGroupResult

The result for the Keyword Plan ad group mutate.

MutateKeywordPlanAdGroupsRequest

Request message for KeywordPlanAdGroupService.MutateKeywordPlanAdGroups.

MutateKeywordPlanAdGroupsResponse

Response message for a Keyword Plan ad group mutate.

MutateKeywordPlanCampaignKeywordResult

The result for the Keyword Plan campaign keyword mutate.

MutateKeywordPlanCampaignKeywordsRequest

Request message for KeywordPlanCampaignKeywordService.MutateKeywordPlanCampaignKeywords.

MutateKeywordPlanCampaignKeywordsResponse

Response message for a Keyword Plan campaign keyword mutate.

MutateKeywordPlanCampaignResult

The result for the Keyword Plan campaign mutate.

MutateKeywordPlanCampaignsRequest

Request message for KeywordPlanCampaignService.MutateKeywordPlanCampaigns.

MutateKeywordPlanCampaignsResponse

Response message for a Keyword Plan campaign mutate.

MutateKeywordPlansRequest

Request message for KeywordPlanService.MutateKeywordPlans.

MutateKeywordPlansResponse

Response message for a keyword plan mutate.

MutateKeywordPlansResult

The result for the keyword plan mutate.

MutateLabelResult

The result for a label mutate.

MutateLabelsRequest

Request message for LabelService.MutateLabels.

MutateLabelsResponse

Response message for a labels mutate.

MutateMediaFileResult

The result for the media file mutate.

MutateMediaFilesRequest

Request message for MediaFileService.MutateMediaFiles

MutateMediaFilesResponse

Response message for a media file mutate.

MutateMerchantCenterLinkRequest

Request message for MerchantCenterLinkService.MutateMerchantCenterLink.

MutateMerchantCenterLinkResponse

Response message for Merchant Center link mutate.

MutateMerchantCenterLinkResult

The result for the Merchant Center link mutate.

MutateOperation

A single operation (create, update, remove) on a resource.

MutateOperationResponse

Response message for the resource mutate.

MutateRemarketingActionResult

The result for the remarketing action mutate.

MutateRemarketingActionsRequest

Request message for RemarketingActionService.MutateRemarketingActions.

MutateRemarketingActionsResponse

Response message for remarketing action mutate.

MutateSharedCriteriaRequest

Request message for SharedCriterionService.MutateSharedCriteria.

MutateSharedCriteriaResponse

Response message for a shared criterion mutate.

MutateSharedCriterionResult

The result for the shared criterion mutate.

MutateSharedSetResult

The result for the shared set mutate.

MutateSharedSetsRequest

Request message for SharedSetService.MutateSharedSets.

MutateSharedSetsResponse

Response message for a shared set mutate.

MutateSmartCampaignSettingResult

The result for the Smart campaign setting mutate.

MutateSmartCampaignSettingsRequest

Request message for [SmartCampaignSettingService.MutateSmartCampaignSetting][].

MutateSmartCampaignSettingsResponse

Response message for campaign mutate.

MutateUserListResult

The result for the user list mutate.

MutateUserListsRequest

Request message for UserListService.MutateUserLists.

MutateUserListsResponse

Response message for user list mutate.

OfflineUserDataJobOperation

Operation to be made for the AddOfflineUserDataJobOperationsRequest.

OnTargetAudienceMetrics

Audience metrics for the planned products. These metrics consider the following targeting dimensions:

  • Location
  • PlannableAgeRange
  • Gender
PlannableLocation

A plannable location: a country, a DMA, a metro region, a tv region, a province.

PlannableTargeting

The targeting for which traffic metrics will be reported.

PlannedProduct

A product being planned for reach.

PlannedProductForecast

Forecasted traffic metrics for a planned product.

PlannedProductReachForecast

The forecasted allocation and traffic metrics for a specific product at a point on the reach curve.

Preferences

Set of preferences about the planned mix.

ProductAllocation

An allocation of a part of the budget on a given product.

ProductMetadata

The metadata associated with an available plannable product.

PromoteCampaignDraftRequest

Request message for CampaignDraftService.PromoteCampaignDraft.

PromoteCampaignExperimentRequest

Request message for CampaignExperimentService.PromoteCampaignExperiment.

ReachCurve

The reach curve for the planned products.

ReachForecast

A point on reach curve.

RegenerateShareableLinkIdRequest

Request message for ThirdPartyAppAnalyticsLinkService.RegenerateShareableLinkId.

RegenerateShareableLinkIdResponse

Response message for ThirdPartyAppAnalyticsLinkService.RegenerateShareableLinkId.

RemarketingActionOperation

A single operation (create, update) on a remarketing action.

RestatementValue

Contains information needed to restate a conversion's value.

RunBatchJobRequest

Request message for BatchJobService.RunBatchJob.

RunOfflineUserDataJobRequest

Request message for OfflineUserDataJobService.RunOfflineUserDataJob.

SearchGoogleAdsFieldsRequest

Request message for GoogleAdsFieldService.SearchGoogleAdsFields.

SearchGoogleAdsFieldsResponse

Response message for GoogleAdsFieldService.SearchGoogleAdsFields.

SearchGoogleAdsRequest

Request message for GoogleAdsService.Search.

SearchGoogleAdsResponse

Response message for GoogleAdsService.Search.

SearchGoogleAdsStreamRequest

Request message for GoogleAdsService.SearchStream.

SearchGoogleAdsStreamResponse

Response message for GoogleAdsService.SearchStream.

SharedCriterionOperation

A single operation (create, remove) on an shared criterion.

SharedSetOperation

A single operation (create, update, remove) on an shared set.

SiteSeed

Site Seed

SmartCampaignSettingOperation

A single operation to update Smart campaign settings for a campaign.

SmartCampaignSuggestionInfo

Information needed to get suggestion for Smart Campaign. More information provided will help the system to derive better suggestions.

SmartCampaignSuggestionInfo.BusinessContext

A context that describes a business.

SmartCampaignSuggestionInfo.LocationList

A list of locations.

SuggestGeoTargetConstantsRequest

Request message for GeoTargetConstantService.SuggestGeoTargetConstants.

SuggestGeoTargetConstantsRequest.GeoTargets

A list of geo target constant resource names.

SuggestGeoTargetConstantsRequest.LocationNames

A list of location names.

SuggestGeoTargetConstantsResponse

Response message for GeoTargetConstantService.SuggestGeoTargetConstants.

SuggestKeywordThemeConstantsRequest

Request message for KeywordThemeConstantService.SuggestKeywordThemeConstants.

SuggestKeywordThemeConstantsResponse

Response message for KeywordThemeConstantService.SuggestKeywordThemeConstants.

SuggestSmartCampaignAdRequest

Request message for SmartCampaignSuggestService.SuggestSmartCampaignAd.

SuggestSmartCampaignAdResponse

Response message for SmartCampaignSuggestService.SuggestSmartCampaignAd.

SuggestSmartCampaignBudgetOptionsRequest

Request message for [SmartCampaignSuggestService.SuggestSmartCampaignBudgets][].

SuggestSmartCampaignBudgetOptionsResponse

Response message for [SmartCampaignSuggestService.SuggestSmartCampaignBudgets][]. Depending on whether the system could suggest the options, either all of the options or none of them might be returned.

SuggestSmartCampaignBudgetOptionsResponse.BudgetOption

Smart Campaign budget option.

SuggestSmartCampaignBudgetOptionsResponse.Metrics

Performance metrics for a given budget option.

Targeting

The targeting for which traffic metrics will be reported.

UploadCallConversionsRequest

Request message for ConversionUploadService.UploadCallConversions.

UploadCallConversionsResponse

Response message for ConversionUploadService.UploadCallConversions.

UploadClickConversionsRequest

Request message for ConversionUploadService.UploadClickConversions.

UploadClickConversionsResponse

Response message for ConversionUploadService.UploadClickConversions.

UploadConversionAdjustmentsRequest

Request message for ConversionAdjustmentUploadService.UploadConversionAdjustments.

UploadConversionAdjustmentsResponse

Response message for ConversionAdjustmentUploadService.UploadConversionAdjustments.

UploadUserDataRequest

Request message for UserDataService.UploadUserData

UploadUserDataResponse

Response message for UserDataService.UploadUserData

UrlSeed

Url Seed

UserDataOperation

Operation to be made for the UploadUserDataRequest.

UserListOperation

A single operation (create, update) on a user list.

resources

AccessibleBiddingStrategy

Represents a view of BiddingStrategies owned by and shared with the customer.

In contrast to BiddingStrategy, this resource includes strategies owned by managers of the customer and shared with this customer - in addition to strategies owned by this customer. This resource does not provide metrics and only exposes a limited subset of the BiddingStrategy attributes.

AccessibleBiddingStrategy.MaximizeConversionValue

An automated bidding strategy to help get the most conversion value for your campaigns while spending your budget.

AccessibleBiddingStrategy.MaximizeConversions

An automated bidding strategy to help get the most conversions for your campaigns while spending your budget.

AccessibleBiddingStrategy.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.

AccessibleBiddingStrategy.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).

AccessibleBiddingStrategy.TargetRoas

An automated bidding strategy that helps you maximize revenue while averaging a specific target return on ad spend (ROAS).

AccessibleBiddingStrategy.TargetSpend

An automated bid strategy that sets your bids to help get as many clicks as possible within your budget.

AccountBudget

An account-level budget. It contains information about the budget itself, as well as the most recently approved changes to the budget and proposed changes that are pending approval. The proposed changes that are pending approval, if any, are found in 'pending_proposal'. Effective details about the budget are found in fields prefixed 'approved_', 'adjusted_' and those without a prefix. Since some effective details may differ from what the user had originally requested (e.g. spending limit), these differences are juxtaposed via 'proposed_', 'approved_', and possibly 'adjusted_' fields.

This resource is mutated using AccountBudgetProposal and cannot be mutated directly. A budget may have at most one pending proposal at any given time. It is read through pending_proposal.

Once approved, a budget may be subject to adjustments, such as credit adjustments. Adjustments create differences between the 'approved' and 'adjusted' fields, which would otherwise be identical.

AccountBudget.PendingAccountBudgetProposal

A pending proposal associated with the enclosing account-level budget, if applicable.

AccountBudgetProposal

An account-level budget proposal.

All fields prefixed with 'proposed' may not necessarily be applied directly. For example, proposed spending limits may be adjusted before their application. This is true if the 'proposed' field has an 'approved' counterpart, e.g. spending limits.

Please note that the proposal type (proposal_type) changes which fields are required and which must remain empty.

AccountLink

Represents the data sharing connection between a Google Ads account and another account

Ad

An ad.

AdGroup

An ad group.

AdGroupAd

An ad group ad.

AdGroupAdAssetPolicySummary

Contains policy information for an ad group ad asset.

AdGroupAdAssetView

A link between an AdGroupAd and an Asset. Currently we only support AdGroupAdAssetView for AppAds.

AdGroupAdLabel

A relationship between an ad group ad and a label.

AdGroupAdPolicySummary

Contains policy information for an ad.

AdGroupAsset

A link between an ad group and an asset.

AdGroupAudienceView

An ad group audience view. Includes performance data from interests and remarketing lists for Display Network and YouTube Network ads, and remarketing lists for search ads (RLSA), aggregated at the audience level.

AdGroupBidModifier

Represents an ad group bid modifier.

AdGroupCriterion

An ad group criterion.

AdGroupCriterion.PositionEstimates

Estimates for criterion bids at various positions.

AdGroupCriterion.QualityInfo

A container for ad group criterion quality information.

AdGroupCriterionLabel

A relationship between an ad group criterion and a label.

AdGroupCriterionSimulation

An ad group criterion simulation. Supported combinations of advertising channel type, criterion type, simulation type, and simulation modification method are detailed below respectively. Hotel AdGroupCriterion simulation operations starting in V5.

  1. DISPLAY - KEYWORD - CPC_BID - UNIFORM
  2. SEARCH - KEYWORD - CPC_BID - UNIFORM
  3. SHOPPING - LISTING_GROUP - CPC_BID - UNIFORM
  4. HOTEL - LISTING_GROUP - CPC_BID - UNIFORM
  5. HOTEL - LISTING_GROUP - PERCENT_CPC_BID - UNIFORM
AdGroupExtensionSetting

An ad group extension setting.

AdGroupFeed

An ad group feed.

AdGroupLabel

A relationship between an ad group and a label.

AdGroupSimulation

An ad group simulation. Supported combinations of advertising channel type, simulation type and simulation modification method is detailed below respectively.

  1. SEARCH - CPC_BID - DEFAULT
  2. SEARCH - CPC_BID - UNIFORM
  3. SEARCH - TARGET_CPA - UNIFORM
  4. SEARCH - TARGET_ROAS - UNIFORM
  5. DISPLAY - CPC_BID - DEFAULT
  6. DISPLAY - CPC_BID - UNIFORM
  7. DISPLAY - TARGET_CPA - UNIFORM
  8. VIDEO - CPV_BID - DEFAULT
  9. VIDEO - CPV_BID - UNIFORM
AdParameter

An ad parameter that is used to update numeric values (such as prices or inventory levels) in any text line of an ad (including URLs). There can be a maximum of two AdParameters per ad group criterion. (One with parameter_index = 1 and one with parameter_index = 2.) In the ad the parameters are referenced by a placeholder of the form "{param#:value}". E.g. "{param1:$17}"

AdScheduleView

An ad schedule view summarizes the performance of campaigns by AdSchedule criteria.

AgeRangeView

An age range view.

Asset

Asset is a part of an ad which can be shared across multiple ads. It can be an image (ImageAsset), a video (YoutubeVideoAsset), etc. Assets are immutable and cannot be removed. To stop an asset from serving, remove the asset from the entity that is using it.

AssetFieldTypeView

An asset field type view. This view reports non-overcounted metrics for each asset field type when the asset is used as extension.

AssetPolicySummary

Contains policy information for an asset.

AttributeFieldMapping

Maps from feed attribute id to a placeholder or criterion field id.

BatchJob

A list of mutates being processed asynchronously. The mutates are uploaded by the user. The mutates themselves aren't readable and the results of the job can only be read using BatchJobService.ListBatchJobResults.

BatchJob.BatchJobMetadata

Additional information about the batch job. This message is also used as metadata returned in batch job Long Running Operations.

BiddingDataExclusion

Represents a bidding data exclusion.

See "About data exclusions" at https://support.google.com/google-ads/answer/10370710.

BiddingSeasonalityAdjustment

Represents a bidding seasonality adjustment.

See "About seasonality adjustments" at https://support.google.com/google-ads/answer/10369906.

BiddingStrategy

A bidding strategy.

BiddingStrategySimulation

A bidding strategy simulation. Supported combinations of simulation type and simulation modification method are detailed below respectively.

  1. TARGET_CPA - UNIFORM
  2. TARGET_ROAS - UNIFORM
BillingSetup

A billing setup, which associates a payments account and an advertiser. A billing setup is specific to one advertiser.

BillingSetup.PaymentsAccountInfo

Container of payments account information for this billing.

CallReportingSetting

Call reporting setting for a customer.

CallView

A call view that includes data for call tracking of call-only ads or call extensions.

Campaign

A campaign.

Campaign.AppCampaignSetting

Campaign-level settings for App Campaigns.

Campaign.DynamicSearchAdsSetting

The setting for controlling Dynamic Search Ads (DSA).

Campaign.GeoTargetTypeSetting

Represents a collection of settings related to ads geotargeting.

Campaign.HotelSettingInfo

Campaign-level settings for hotel ads.

Campaign.LocalCampaignSetting

Campaign setting for local campaigns.

Campaign.NetworkSettings

The network settings for the campaign.

Campaign.OptimizationGoalSetting

Optimization goal setting for this campaign, which includes a set of optimization goal types.

Campaign.SelectiveOptimization

Selective optimization setting for this campaign, which includes a set of conversion actions to optimize this campaign towards.

Campaign.ShoppingSetting

The setting for Shopping campaigns. Defines the universe of products that can be advertised by the campaign, and how this campaign interacts with other Shopping campaigns.

Campaign.TrackingSetting

Campaign-level settings for tracking information.

Campaign.VanityPharma

Describes how unbranded pharma ads will be displayed.

CampaignAsset

A link between a Campaign and an Asset.

CampaignAudienceView

A campaign audience view. Includes performance data from interests and remarketing lists for Display Network and YouTube Network ads, and remarketing lists for search ads (RLSA), aggregated by campaign and audience criterion. This view only includes audiences attached at the campaign level.

CampaignBidModifier

Represents a bid-modifiable only criterion at the campaign level.

CampaignBudget

A campaign budget.

CampaignCriterion

A campaign criterion.

CampaignCriterionSimulation

A campaign criterion simulation. Supported combinations of advertising channel type, criterion ids, simulation type and simulation modification method is detailed below respectively.

  1. SEARCH - 30000,30001,30002 - BID_MODIFIER - UNIFORM
  2. SHOPPING - 30000,30001,30002 - BID_MODIFIER - UNIFORM
  3. DISPLAY - 30001 - BID_MODIFIER - UNIFORM
CampaignDraft

A campaign draft.

CampaignExperiment

An A/B experiment that compares the performance of the base campaign (the control) and a variation of that campaign (the experiment).

CampaignExtensionSetting

A campaign extension setting.

CampaignFeed

A campaign feed.

CampaignLabel

Represents a relationship between a campaign and a label.

CampaignSharedSet

CampaignSharedSets are used for managing the shared sets associated with a campaign.

CampaignSimulation

A campaign simulation. Supported combinations of advertising channel type, simulation type and simulation modification method is detailed below respectively.

SEARCH - CPC_BID - UNIFORM SEARCH - CPC_BID - SCALING SEARCH - TARGET_CPA - UNIFORM SEARCH - TARGET_CPA - SCALING SEARCH - TARGET_ROAS - UNIFORM SEARCH - TARGET_IMPRESSION_SHARE - UNIFORM SEARCH - BUDGET - UNIFORM SHOPPING - BUDGET - UNIFORM SHOPPING - TARGET_ROAS - UNIFORM MULTIPLE - TARGET_CPA - UNIFORM OWNED_AND_OPERATED - TARGET_CPA - DEFAULT DISPLAY - TARGET_CPA - UNIFORM

CarrierConstant

A carrier criterion that can be used in campaign targeting.

ChangeEvent

Describes the granular change of returned resource of certain resource types. Changes made through UI, API and new versions of Editor by external users (including external users, and internal users that can be shown externally) in the past 30 days will be shown. The change shows the old values of the changed fields before the change and the new values right after the change. ChangeEvent could have up to 3 minutes delay to reflect a new change.

ChangeEvent.ChangedResource

A wrapper proto presenting all supported resources. Only the resource of the change_resource_type will be set.

ChangeStatus

Describes the status of returned resource. ChangeStatus could have up to 3 minutes delay to reflect a new change.

ClickView

A click view with metrics aggregated at each click level, including both valid and invalid clicks. For non-Search campaigns, metrics.clicks represents the number of valid and invalid interactions. Queries including ClickView must have a filter limiting the results to one day and can be requested for dates back to 90 days before the time of the request.

CombinedAudience

Describe a resource for combined audiences which includes different audiences.

ConversionAction

A conversion action.

ConversionAction.AttributionModelSettings

Settings related to this conversion action's attribution model.

ConversionAction.FirebaseSettings

Settings related to a Firebase conversion action.

ConversionAction.ThirdPartyAppAnalyticsSettings

Settings related to a third party app analytics conversion action.

ConversionAction.ValueSettings

Settings related to the value for conversion events associated with this conversion action.

ConversionCustomVariable

A conversion custom variable See "About custom variables for conversions" at https://support.google.com/google-ads/answer/9964350

ConversionTrackingSetting

A collection of customer-wide settings related to Google Ads Conversion Tracking.

ConversionValueRule

A conversion value rule

ConversionValueRule.ValueRuleAction

Action applied when rule is applied.

ConversionValueRule.ValueRuleAudienceCondition

Condition on Audience dimension.

ConversionValueRule.ValueRuleDeviceCondition

Condition on Device dimension.

ConversionValueRule.ValueRuleGeoLocationCondition

Condition on Geo dimension.

ConversionValueRuleSet

A conversion value rule set

CurrencyConstant

A currency constant.

CustomAudience

A custom audience. This is a list of users by interest.

CustomAudienceMember

A member of custom audience. A member can be a KEYWORD, URL, PLACE_CATEGORY or APP. It can only be created or removed but not changed.

CustomInterest

A custom interest. This is a list of users by interest.

CustomInterestMember

A member of custom interest audience. A member can be a keyword or url. It is immutable, that is, it can only be created or removed but not changed.

Customer

A customer.

CustomerAsset

A link between a customer and an asset.

CustomerClient

A link between the given customer and a client customer. CustomerClients only exist for manager customers. All direct and indirect client customers are included, as well as the manager itself.

CustomerClientLink

Represents customer client link relationship.

CustomerExtensionSetting

A customer extension setting.

CustomerFeed

A customer feed.

CustomerLabel

Represents a relationship between a customer and a label. This customer may not have access to all the labels attached to it. Additional CustomerLabels may be returned by increasing permissions with login-customer-id.

CustomerManagerLink

Represents customer-manager link relationship.

CustomerNegativeCriterion

A negative criterion for exclusions at the customer level.

CustomerUserAccess

Represents the permission of a single user onto a single customer.

CustomerUserAccessInvitation

Represent an invitation to a new user on this customer account.

DataPartnerLinkIdentifier

The identifier for Data Partner account.

DetailPlacementView

A view with metrics aggregated by ad group and URL or YouTube video.