Module googapis::google::ads::googleads::v8::resources[][src]

Modules

Nested message and enum types in AccessibleBiddingStrategy.

Nested message and enum types in AccountBudget.

Nested message and enum types in AccountBudgetProposal.

Nested message and enum types in AccountLink.

Nested message and enum types in Ad.

Nested message and enum types in AdGroupBidModifier.

Nested message and enum types in AdGroupCriterion.

Nested message and enum types in AdGroupCriterionSimulation.

Nested message and enum types in AdGroupSimulation.

Nested message and enum types in Asset.

Nested message and enum types in AttributeFieldMapping.

Nested message and enum types in BatchJob.

Nested message and enum types in BiddingStrategy.

Nested message and enum types in BiddingStrategySimulation.

Nested message and enum types in BillingSetup.

Nested message and enum types in Campaign.

Nested message and enum types in CampaignBidModifier.

Nested message and enum types in CampaignCriterion.

Nested message and enum types in CampaignCriterionSimulation.

Nested message and enum types in CampaignSimulation.

Nested message and enum types in ChangeEvent.

Nested message and enum types in ConversionAction.

Nested message and enum types in ConversionValueRule.

Nested message and enum types in CustomAudienceMember.

Nested message and enum types in CustomerNegativeCriterion.

Nested message and enum types in ExtensionFeedItem.

Nested message and enum types in Feed.

Nested message and enum types in FeedAttributeOperation.

Nested message and enum types in FeedItemSet.

Nested message and enum types in FeedItemTarget.

Nested message and enum types in FeedMapping.

Nested message and enum types in Invoice.

Nested message and enum types in KeywordPlanForecastPeriod.

Nested message and enum types in MediaFile.

Nested message and enum types in OfflineUserDataJob.

Nested message and enum types in Recommendation.

Nested message and enum types in SharedCriterion.

Nested message and enum types in SmartCampaignSetting.

Nested message and enum types in UserList.

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 (e.g. spending limit), these differences are juxtaposed via ‘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.

Contains policy information for an ad group ad asset.

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

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.

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

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}”. E.g. “{param1:$17}”

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

An age range view.

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.

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

Contains policy information for an asset.

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

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.

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.

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.

A campaign criterion.

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

A campaign draft.

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

A campaign extension setting.

A campaign feed.

Represents a relationship between a campaign and a label.

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

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.

A conversion action.

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

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.

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.

A customer.

A link between a customer and an asset.

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.

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.

Represents customer-manager link relationship.

A negative criterion for exclusions at the customer level.

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

Represent an invitation to a new user on this customer 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.

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.

A group placement view.

A hotel group view.

A hotel performance view.

An income range view.

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.

A life event: a particular interest-based vertical to be targeted to reach users when they are in the midst of important life milestones.

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.

A data sharing connection, proposed or in use, between a Google Ads Customer and a Merchant Center account.

A mobile application category constant.

A mobile device constant.

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 OfflineUserDataJobService.GetOfflineUserDataJob.

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 Product Bidding Category.

A product group view.

A recommendation.

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