Modules§

Structs§

  • Represents a view of BiddingStrategies owned by and shared with the customer.
  • 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 (for example, spending limit), these differences are juxtaposed through ‘proposed_’, ‘approved_’, and possibly ‘adjusted_’ fields.
  • An account-level budget proposal.
  • Represents the data sharing connection between a Google Ads account and another account
  • An ad.
  • An ad group.
  • An ad group ad.
  • A view on the usage of ad group ad asset combination. Now we only support AdGroupAdAssetCombinationView for Responsive Search Ads, with more ad types planned for the future.
  • Contains policy information for an ad group ad asset.
  • A link between an AdGroupAd and an Asset. Currently we only support AdGroupAdAssetView for AppAds and Responsive Search Ads.
  • A relationship between an ad group ad and a label.
  • Contains policy information for an ad.
  • A link between an ad group and an asset.
  • AdGroupAssetSet is the linkage between an ad group and an asset set. Creating an AdGroupAssetSet links an asset set with an ad group.
  • 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.
  • Represents an ad group bid modifier.
  • An ad group criterion.
  • A customizer value for the associated CustomizerAttribute at the AdGroupCriterion level.
  • A relationship between an ad group criterion and a label.
  • 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.
  • A customizer value for the associated CustomizerAttribute at the AdGroup level.
  • An ad group extension setting.
  • An ad group feed.
  • A relationship between an ad group and a label.
  • An ad group simulation. Supported combinations of advertising channel type, simulation type and simulation modification method is detailed below respectively.
  • 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}”. For example, “{param1:$17}”
  • An ad schedule view summarizes the performance of campaigns by AdSchedule criteria.
  • The identifier for the Advertising Partner Google Ads account.
  • An age range view.
  • An Android privacy shared key view for Google ad group key.
  • An Android privacy shared key view for Google campaign key.
  • An Android privacy shared key view for Google network type key.
  • 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.
  • Contains policy information for an asset under AssetFieldType context.
  • An asset field type view. This view reports non-overcounted metrics for each asset field type when the asset is used as extension.
  • An asset group. AssetGroupAsset is used to link an asset to the asset group. AssetGroupSignal is used to associate a signal to an asset group.
  • AssetGroupAsset is the link between an asset and an asset group. Adding an AssetGroupAsset links an asset with an asset group.
  • Asset group asset combination data
  • AssetGroupListingGroupFilter represents a listing group filter tree node in an asset group.
  • An asset group product group view.
  • AssetGroupSignal represents a signal in an asset group. The existence of a signal tells the performance max campaign who’s most likely to convert. Performance Max uses the signal to look for new people with similar or stronger intent to find conversions across Search, Display, Video, and more.
  • A view on the usage of ad group ad asset combination.
  • Contains policy information for an asset.
  • An asset set representing a collection of assets. Use AssetSetAsset to link an asset to the asset set.
  • AssetSetAsset is the link between an asset and an asset set. Adding an AssetSetAsset links an asset with an asset set.
  • An asset set type view. This view reports non-overcounted metrics for each asset set type. Child asset set types are not included in this report. Their stats are aggregated under the parent asset set type.
  • Maps from feed attribute id to a placeholder or criterion field id.
  • Audience is an effective targeting option that lets you intersect different segment attributes, such as detailed demographics and affinities, to create audiences that represent sections of your target segments.
  • A proto holding information specific to local services background check.
  • 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.
  • Represents a bidding data exclusion.
  • Represents a bidding seasonality adjustment.
  • A bidding strategy.
  • A bidding strategy simulation. Supported combinations of simulation type and simulation modification method are detailed below respectively.
  • A billing setup, which associates a payments account and an advertiser. A billing setup is specific to one advertiser.
  • Call reporting setting for a customer. Only mutable in an update operation.
  • A call view that includes data for call tracking of call-only ads or call extensions.
  • A campaign.
  • A link between a Campaign and an Asset.
  • CampaignAssetSet is the linkage between a campaign and an asset set. Adding a CampaignAssetSet links an asset set with a campaign.
  • 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.
  • Represents a bid-modifiable only criterion at the campaign level.
  • A campaign budget.
  • The biddability setting for the specified campaign only for all conversion actions with a matching category and origin.
  • A campaign criterion.
  • A customizer value for the associated CustomizerAttribute at the Campaign level.
  • A campaign draft.
  • A campaign extension setting.
  • A campaign feed.
  • A campaign group.
  • Represents a relationship between a campaign and a label.
  • Campaign level customer lifecycle goal settings.
  • A Campaign search term view. Historical data is available starting March 2023.
  • CampaignSharedSets are used for managing the shared sets associated with a campaign.
  • A campaign simulation. Supported combinations of advertising channel type, simulation type and simulation modification method is detailed below respectively.
  • A carrier criterion that can be used in campaign targeting.
  • Describes the granular change of returned resources of certain resource types. Changes made through the UI or API in the past 30 days are included. Previous and new values of the changed fields are shown. ChangeEvent could have up to 3 minutes delay to reflect a new change.
  • Describes the status of returned resource. ChangeStatus could have up to 3 minutes delay to reflect a new change.
  • 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.
  • Describe a resource for combined audiences which includes different audiences.
  • Fields containing consumer contact details.
  • A conversion action.
  • A conversion custom variable See “About custom variables for conversions” at https://support.google.com/google-ads/answer/9964350
  • Conversion goal settings for a Campaign.
  • A collection of customer-wide settings related to Google Ads Conversion Tracking.
  • A conversion value rule
  • A conversion value rule set
  • A currency constant.
  • A custom audience. This is a list of users by interest.
  • 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.
  • Custom conversion goal that can make arbitrary conversion actions biddable.
  • A custom interest. This is a list of users by interest.
  • 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.
  • Fields in the submitted custom question
  • A customer.
  • The customer acquisition goal settings for the campaign.
  • Customer Agreement Setting for a customer.
  • A link between a customer and an asset.
  • CustomerAssetSet is the linkage between a customer and an asset set. Adding a CustomerAssetSet links an asset set with a customer.
  • 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.
  • Represents customer client link relationship.
  • Biddability control for conversion actions with a matching category and origin.
  • A customizer value for the associated CustomizerAttribute at the Customer level.
  • A customer extension setting.
  • A customer feed.
  • 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.
  • Account level customer lifecycle goal settings.
  • Represents customer-manager link relationship.
  • A negative criterion for exclusions at the customer level.
  • A Customer search term view. Historical data is available starting March 2023.
  • A CustomerSkAdNetworkConversionValueSchema.
  • Represents the permission of a single user onto a single customer.
  • Represent an invitation to a new user on this customer account.
  • A customizer attribute. Use CustomerCustomizer, CampaignCustomizer, AdGroupCustomizer, or AdGroupCriterionCustomizer to associate a customizer attribute and set its value at the customer, campaign, ad group, or ad group criterion level, respectively.
  • The identifier for Data Partner account.
  • The identifier for Data Partner account.
  • A view with metrics aggregated by ad group and URL or YouTube video.
  • A detailed demographic: a particular interest-based vertical to be targeted to reach users based on long-term life facts.
  • A display keyword view.
  • A distance view with metrics aggregated by the user’s distance from an advertiser’s location extensions. Each DistanceBucket includes all impressions that fall within its distance and a single impression will contribute to the metrics for all DistanceBuckets that include the user’s distance.
  • A category generated automatically by crawling a domain. If a campaign uses the DynamicSearchAdsSetting, then domain categories will be generated for the domain. The categories can be targeted using WebpageConditionInfo. See: https://support.google.com/google-ads/answer/2471185
  • A dynamic search ads search term view.
  • A landing page view with metrics aggregated at the expanded final URL level.
  • A Google ads experiment for users to experiment changes on multiple campaigns, compare the performance, and apply the effective changes.
  • A Google ads experiment for users to experiment changes on multiple campaigns, compare the performance, and apply the effective changes.
  • An extension feed item.
  • A feed.
  • FeedAttributes define the types of data expected to be present in a Feed. A single FeedAttribute specifies the expected type of the FeedItemAttributes with the same FeedAttributeId. Optionally, a FeedAttribute can be marked as being part of a FeedItem’s unique key.
  • Operation to be performed on a feed attribute list in a mutate.
  • A feed item.
  • A feed item attribute value.
  • Policy, validation, and quality approval info for a feed item for the specified placeholder type.
  • Represents a set of feed items. The set can be used and shared among certain feed item features. For instance, the set can be referenced within the matching functions of CustomerFeed, CampaignFeed, and AdGroupFeed.
  • Represents a link between a FeedItem and a FeedItemSet.
  • A feed item target.
  • Stores a validation error and the set of offending feed attributes which together are responsible for causing a feed item validation error.
  • A feed mapping.
  • A feed placeholder view.
  • A gender view.
  • A geo target constant.
  • A geographic view.
  • A field or resource (artifact) used by GoogleAdsService.
  • The identifier for Google Ads account.
  • The identifier for Google Ads account.
  • Insurance status at geo + vertical level.
  • License status at geo + vertical level.
  • A group placement view.
  • The identifier for Hotel account.
  • A hotel group view.
  • A hotel performance view.
  • A hotel reconciliation. It contains conversion information from Hotel bookings to reconcile with advertiser records. These rows may be updated or canceled before billing through Bulk Uploads.
  • An income range view.
  • A proto holding information specific to a local services insurance.
  • An invoice. All invoice information is snapshotted to match the PDF invoice. For invoices older than the launch of InvoiceService, the snapshotted information may not match the PDF invoice.
  • A Keyword Planner plan. Max number of saved keyword plans: 10000. It’s possible to remove plans if limit is reached.
  • A Keyword Planner ad group. Max number of keyword plan ad groups per plan: 200.
  • A Keyword Plan ad group keyword. Max number of keyword plan keywords per plan: 10000.
  • A Keyword Plan campaign. Max number of keyword plan campaigns per plan allowed: 1.
  • A Keyword Plan Campaign keyword. Only negative keywords are supported for Campaign Keyword.
  • The forecasting period associated with the keyword plan.
  • A geo target.
  • A Smart Campaign keyword theme constant.
  • A keyword view.
  • A label.
  • A landing page view with metrics aggregated at the unexpanded final URL level.
  • A language.
  • Data from lead form submissions.
  • Fields in the submitted lead form.
  • A proto holding information specific to a local services license.
  • A life event: a particular interest-based vertical to be targeted to reach users when they are in the midst of important life milestones.
  • Listing dimensions for the asset group listing group filter.
  • The path defining of dimensions defining a listing group filter.
  • Data from Local Services Lead. Contains details of Lead which is generated when user calls, messages or books service from advertiser. More info: https://ads.google.com/local-services-ads
  • Data from Local Services Lead Conversation. Contains details of Lead Conversation which is generated when user calls, messages or books service from advertiser. These are appended to a Lead. More info: https://ads.google.com/local-services-ads
  • Settings for Local Services customer.
  • A local services verification resource.
  • A location view summarizes the performance of campaigns by Location criteria.
  • A managed placement view.
  • Encapsulates an Audio.
  • Represents a ZIP archive media the content of which contains HTML5 assets.
  • A media file.
  • Encapsulates an Image.
  • Encapsulates a Video.
  • The identifier for Google Merchant Center account
  • The identifier for Merchant Center Account.
  • Represents details of text message in case of email, message or SMS.
  • A mobile application category constant.
  • A mobile device constant.
  • Represents a note added to a lead by the advertiser. Advertisers can edit notes, which will reset edit time and change description.
  • Alert for offline conversion client summary.
  • Possible errors for offline conversion client summary.
  • Historical upload summary, grouped by upload date or job.
  • Offline conversion upload client summary.
  • A job containing offline user data of store visitors, or user list members that will be processed asynchronously. The uploaded data isn’t readable and the processing results of the job can only be read using GoogleAdsService.Search/SearchStream.
  • Metadata of offline user data job.
  • A mobile operating system version or a range of versions, depending on operator_type. List of available mobile platforms at https://developers.google.com/google-ads/api/reference/data/codes-formats#mobile-platforms
  • A paid organic search term view providing a view of search stats across ads and organic listings aggregated by search term at the ad group level.
  • A parental status view.
  • A payments account, which can be used to set up billing for an Ads customer.
  • A per store view. This view provides per store impression reach and local action conversion stats for advertisers.
  • Represents details of a phone call conversation.
  • A Product Category.
  • A product group view.
  • Represents the data sharing connection between a Google Ads customer and another product.
  • Represents an invitation for data sharing connection between a Google Ads account and another account.
  • Qualifying Questions for Lead Form.
  • A recommendation.
  • Recommendation Subscription resource
  • A remarketing action. A snippet of JavaScript code that will collect the product id and the type of page people visited (product page, shopping cart page, purchase page, general site visit) on an advertiser’s website.
  • Remarketing setting for a customer.
  • A search term view with metrics aggregated by search term at the ad group level.
  • A criterion belonging to a shared set.
  • SharedSets are used for sharing criterion exclusions across multiple campaigns.
  • Shopping performance view. Provides Shopping campaign statistics aggregated at several product dimension levels. Product dimension values from Merchant Center such as brand, category, custom attributes, product condition and product type will reflect the state of each dimension as of the date and time when the corresponding event was recorded.
  • A Smart campaign search term view.
  • Settings for configuring Smart campaigns.
  • A data sharing connection, allowing the import of third party app analytics into a Google Ads Customer.
  • The identifiers of a Third Party App Analytics Link.
  • 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”).
  • A topic view.
  • A travel activity group view.
  • A travel activity performance view.
  • A user interest: a particular interest-based vertical to be targeted.
  • A user list. This is a list of users a customer may target.
  • A user location view.
  • A video.
  • A webpage view.