googleapis
Version:
Google APIs Client Library for Node.js
1,125 lines • 135 kB
TypeScript
/// <reference types="node" />
import { OAuth2Client, JWT, Compute, UserRefreshClient, BaseExternalAccountClient, GaxiosPromise, GoogleConfigurable, MethodOptions, StreamMethodOptions, GlobalOptions, GoogleAuth, BodyResponseCallback, APIRequestContext } from 'googleapis-common';
import { Readable } from 'stream';
export declare namespace searchads360_v0 {
export interface Options extends GlobalOptions {
version: 'v0';
}
interface StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient | BaseExternalAccountClient | GoogleAuth;
/**
* V1 error format.
*/
'$.xgafv'?: string;
/**
* OAuth access token.
*/
access_token?: string;
/**
* Data format for response.
*/
alt?: string;
/**
* JSONP
*/
callback?: string;
/**
* Selector specifying which fields to include in a partial response.
*/
fields?: string;
/**
* API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
*/
key?: string;
/**
* OAuth 2.0 token for the current user.
*/
oauth_token?: string;
/**
* Returns response with indentations and line breaks.
*/
prettyPrint?: boolean;
/**
* Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
*/
quotaUser?: string;
/**
* Legacy upload protocol for media (e.g. "media", "multipart").
*/
uploadType?: string;
/**
* Upload protocol for media (e.g. "raw", "multipart").
*/
upload_protocol?: string;
}
/**
* Search Ads 360 Reporting API
*
* The Search Ads 360 API allows developers to automate downloading reports from Search Ads 360.
*
* @example
* ```js
* const {google} = require('googleapis');
* const searchads360 = google.searchads360('v0');
* ```
*/
export class Searchads360 {
context: APIRequestContext;
customers: Resource$Customers;
searchAds360Fields: Resource$Searchads360fields;
constructor(options: GlobalOptions, google?: GoogleConfigurable);
}
/**
* An age range criterion.
*/
export interface Schema$GoogleAdsSearchads360V0Common__AgeRangeInfo {
/**
* Type of the age range.
*/
type?: string | null;
}
/**
* A mapping that can be used by custom parameter tags in a `tracking_url_template`, `final_urls`, or `mobile_final_urls`.
*/
export interface Schema$GoogleAdsSearchads360V0Common__CustomParameter {
/**
* The key matching the parameter tag name.
*/
key?: string | null;
/**
* The value to be substituted.
*/
value?: string | null;
}
/**
* A device criterion.
*/
export interface Schema$GoogleAdsSearchads360V0Common__DeviceInfo {
/**
* Type of the device.
*/
type?: string | null;
}
/**
* 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. This bidding strategy is deprecated and cannot be created anymore. Use ManualCpc with enhanced_cpc_enabled set to true for equivalent functionality.
*/
export interface Schema$GoogleAdsSearchads360V0Common__EnhancedCpc {
}
/**
* 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.
*/
export interface Schema$GoogleAdsSearchads360V0Common__FrequencyCapEntry {
}
/**
* A gender criterion.
*/
export interface Schema$GoogleAdsSearchads360V0Common__GenderInfo {
/**
* Type of the gender.
*/
type?: string | null;
}
/**
* A Keyword criterion segment.
*/
export interface Schema$GoogleAdsSearchads360V0Common__Keyword {
/**
* The AdGroupCriterion resource name.
*/
adGroupCriterion?: string | null;
/**
* Keyword info.
*/
info?: Schema$GoogleAdsSearchads360V0Common__KeywordInfo;
}
/**
* A keyword criterion.
*/
export interface Schema$GoogleAdsSearchads360V0Common__KeywordInfo {
/**
* The match type of the keyword.
*/
matchType?: string | null;
/**
* The text of the keyword (at most 80 characters and 10 words).
*/
text?: string | null;
}
/**
* A language criterion.
*/
export interface Schema$GoogleAdsSearchads360V0Common__LanguageInfo {
/**
* The language constant resource name.
*/
languageConstant?: string | null;
}
/**
* A listing group criterion.
*/
export interface Schema$GoogleAdsSearchads360V0Common__ListingGroupInfo {
/**
* Type of the listing group.
*/
type?: string | null;
}
/**
* A radius around a list of locations specified through a feed.
*/
export interface Schema$GoogleAdsSearchads360V0Common__LocationGroupInfo {
/**
* FeedItemSets whose FeedItems are targeted. If multiple IDs are specified, then all items that appear in at least one set are targeted. This field cannot be used with geo_target_constants. This is optional and can only be set in CREATE operations.
*/
feedItemSets?: string[] | null;
/**
* Geo target constant(s) restricting the scope of the geographic area within the feed. Currently only one geo target constant is allowed.
*/
geoTargetConstants?: string[] | null;
/**
* Distance in units specifying the radius around targeted locations. This is required and must be set in CREATE operations.
*/
radius?: string | null;
/**
* Unit of the radius. Miles and meters are supported for geo target constants. Milli miles and meters are supported for feed item sets. This is required and must be set in CREATE operations.
*/
radiusUnits?: string | null;
}
/**
* A location criterion.
*/
export interface Schema$GoogleAdsSearchads360V0Common__LocationInfo {
/**
* The geo target constant resource name.
*/
geoTargetConstant?: string | null;
}
/**
* Manual bidding strategy that allows advertiser to set the bid per advertiser-specified action.
*/
export interface Schema$GoogleAdsSearchads360V0Common__ManualCpa {
}
/**
* Manual click-based bidding where user pays per click.
*/
export interface Schema$GoogleAdsSearchads360V0Common__ManualCpc {
/**
* Whether bids are to be enhanced based on conversion optimizer data.
*/
enhancedCpcEnabled?: boolean | null;
}
/**
* Manual impression-based bidding where user pays per thousand impressions.
*/
export interface Schema$GoogleAdsSearchads360V0Common__ManualCpm {
}
/**
* An automated bidding strategy to help get the most conversions for your campaigns while spending your budget.
*/
export interface Schema$GoogleAdsSearchads360V0Common__MaximizeConversions {
/**
* Maximum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy. Mutable for portfolio bidding strategies only.
*/
cpcBidCeilingMicros?: string | null;
/**
* Minimum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy. Mutable for portfolio bidding strategies only.
*/
cpcBidFloorMicros?: string | null;
/**
* The target cost-per-action (CPA) option. This is the average amount that you would like to spend per conversion action specified in micro units of the bidding strategy's currency. If set, the bid strategy will get as many conversions as possible at or below the target cost-per-action. If the target CPA is not set, the bid strategy will aim to achieve the lowest possible CPA given the budget.
*/
targetCpaMicros?: string | null;
}
/**
* An automated bidding strategy to help get the most conversion value for your campaigns while spending your budget.
*/
export interface Schema$GoogleAdsSearchads360V0Common__MaximizeConversionValue {
/**
* Maximum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy. Mutable for portfolio bidding strategies only.
*/
cpcBidCeilingMicros?: string | null;
/**
* Minimum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy. Mutable for portfolio bidding strategies only.
*/
cpcBidFloorMicros?: string | null;
/**
* The target return on ad spend (ROAS) option. If set, the bid strategy will maximize revenue while averaging the target return on ad spend. If the target ROAS is high, the bid strategy may not be able to spend the full budget. If the target ROAS is not set, the bid strategy will aim to achieve the highest possible ROAS for the budget.
*/
targetRoas?: number | null;
}
/**
* Metrics data.
*/
export interface Schema$GoogleAdsSearchads360V0Common__Metrics {
/**
* The percent of your ad impressions that are shown as the very first ad above the organic search results.
*/
absoluteTopImpressionPercentage?: number | null;
/**
* The total number of conversions. This includes all conversions regardless of the value of include_in_conversions_metric.
*/
allConversions?: number | null;
/**
* The total number of conversions. This includes all conversions regardless of the value of include_in_conversions_metric. When this column is selected with date, the values in date column means the conversion date. Details for the by_conversion_date columns are available at https://support.google.com/sa360/answer/9250611.
*/
allConversionsByConversionDate?: number | null;
/**
* The number of times people clicked the "Call" button to call a store during or after clicking an ad. This number doesn't include whether or not calls were connected, or the duration of any calls. This metric applies to feed items only.
*/
allConversionsFromClickToCall?: number | null;
/**
* The number of times people clicked a "Get directions" button to navigate to a store after clicking an ad. This metric applies to feed items only.
*/
allConversionsFromDirections?: number | null;
/**
* All conversions from interactions (as oppose to view through conversions) divided by the number of ad interactions.
*/
allConversionsFromInteractionsRate?: number | null;
/**
* The value of all conversions from interactions divided by the total number of interactions.
*/
allConversionsFromInteractionsValuePerInteraction?: number | null;
/**
* The number of times people clicked a link to view a store's menu after clicking an ad. This metric applies to feed items only.
*/
allConversionsFromMenu?: number | null;
/**
* The number of times people placed an order at a store after clicking an ad. This metric applies to feed items only.
*/
allConversionsFromOrder?: number | null;
/**
* The number of other conversions (for example, posting a review or saving a location for a store) that occurred after people clicked an ad. This metric applies to feed items only.
*/
allConversionsFromOtherEngagement?: number | null;
/**
* Estimated number of times people visited a store after clicking an ad. This metric applies to feed items only.
*/
allConversionsFromStoreVisit?: number | null;
/**
* The number of times that people were taken to a store's URL after clicking an ad. This metric applies to feed items only.
*/
allConversionsFromStoreWebsite?: number | null;
/**
* The value of all conversions.
*/
allConversionsValue?: number | null;
/**
* The value of all conversions. When this column is selected with date, the values in date column means the conversion date. Details for the by_conversion_date columns are available at https://support.google.com/sa360/answer/9250611.
*/
allConversionsValueByConversionDate?: number | null;
/**
* The value of all conversions divided by the total cost of ad interactions (such as clicks for text ads or views for video ads).
*/
allConversionsValuePerCost?: number | null;
/**
* The average amount you pay per interaction. This amount is the total cost of your ads divided by the total number of interactions.
*/
averageCost?: number | null;
/**
* The total cost of all clicks divided by the total number of clicks received.
*/
averageCpc?: number | null;
/**
* Average cost-per-thousand impressions (CPM).
*/
averageCpm?: number | null;
/**
* The number of clicks.
*/
clicks?: string | null;
/**
* The number of client account conversions. This only includes conversion actions which include_in_client_account_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions.
*/
clientAccountConversions?: number | null;
/**
* The value of client account conversions. This only includes conversion actions which include_in_client_account_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions.
*/
clientAccountConversionsValue?: number | null;
/**
* The total number of view-through conversions. These happen when a customer sees an image or rich media ad, then later completes a conversion on your site without interacting with (for example, clicking on) another ad.
*/
clientAccountViewThroughConversions?: string | null;
/**
* The estimated percent of times that your ad was eligible to show on the Display Network but didn't because your budget was too low. Note: Content budget lost impression share is reported in the range of 0 to 0.9. Any value above 0.9 is reported as 0.9001.
*/
contentBudgetLostImpressionShare?: number | null;
/**
* The impressions you've received on the Display Network divided by the estimated number of impressions you were eligible to receive. Note: Content impression share is reported in the range of 0.1 to 1. Any value below 0.1 is reported as 0.0999.
*/
contentImpressionShare?: number | null;
/**
* The estimated percentage of impressions on the Display Network that your ads didn't receive due to poor Ad Rank. Note: Content rank lost impression share is reported in the range of 0 to 0.9. Any value above 0.9 is reported as 0.9001.
*/
contentRankLostImpressionShare?: number | null;
/**
* The number of conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions.
*/
conversions?: number | null;
/**
* The sum of conversions by conversion date for biddable conversion types. Can be fractional due to attribution modeling. When this column is selected with date, the values in date column means the conversion date.
*/
conversionsByConversionDate?: number | null;
/**
* Average biddable conversions (from interaction) per conversion eligible interaction. Shows how often, on average, an ad interaction leads to a biddable conversion.
*/
conversionsFromInteractionsRate?: number | null;
/**
* The value of conversions from interactions divided by the number of ad interactions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions.
*/
conversionsFromInteractionsValuePerInteraction?: number | null;
/**
* The sum of conversion values for the conversions included in the "conversions" field. This metric is useful only if you entered a value for your conversion actions.
*/
conversionsValue?: number | null;
/**
* The sum of biddable conversions value by conversion date. When this column is selected with date, the values in date column means the conversion date.
*/
conversionsValueByConversionDate?: number | null;
/**
* The value of biddable conversion divided by the total cost of conversion eligible interactions.
*/
conversionsValuePerCost?: number | null;
/**
* The sum of your cost-per-click (CPC) and cost-per-thousand impressions (CPM) costs during this period.
*/
costMicros?: string | null;
/**
* The cost of ad interactions divided by all conversions.
*/
costPerAllConversions?: number | null;
/**
* Average conversion eligible cost per biddable conversion.
*/
costPerConversion?: number | null;
/**
* The cost of ad interactions divided by current model attributed conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions.
*/
costPerCurrentModelAttributedConversion?: number | null;
/**
* Conversions from when a customer clicks on an ad on one device, then converts on a different device or browser. Cross-device conversions are already included in all_conversions.
*/
crossDeviceConversions?: number | null;
/**
* The sum of the value of cross-device conversions.
*/
crossDeviceConversionsValue?: number | null;
/**
* The number of clicks your ad receives (Clicks) divided by the number of times your ad is shown (Impressions).
*/
ctr?: number | null;
/**
* The creative historical quality score.
*/
historicalCreativeQualityScore?: string | null;
/**
* The quality of historical landing page experience.
*/
historicalLandingPageQualityScore?: string | null;
/**
* The historical quality score.
*/
historicalQualityScore?: string | null;
/**
* The historical search predicted click through rate (CTR).
*/
historicalSearchPredictedCtr?: string | null;
/**
* Count of how often your ad has appeared on a search results page or website on the Google Network.
*/
impressions?: string | null;
/**
* The types of payable and free interactions.
*/
interactionEventTypes?: string[] | null;
/**
* How often people interact with your ad after it is shown to them. This is the number of interactions divided by the number of times your ad is shown.
*/
interactionRate?: number | null;
/**
* The number of interactions. An interaction is the main user action associated with an ad format-clicks for text and shopping ads, views for video ads, and so on.
*/
interactions?: string | null;
/**
* The percentage of clicks filtered out of your total number of clicks (filtered + non-filtered clicks) during the reporting period.
*/
invalidClickRate?: number | null;
/**
* Number of clicks Google considers illegitimate and doesn't charge you for.
*/
invalidClicks?: string | null;
/**
* The percentage of mobile clicks that go to a mobile-friendly page.
*/
mobileFriendlyClicksPercentage?: number | null;
/**
* The percentage of the customer's Shopping or Search ad impressions that are shown in the most prominent Shopping position. See https://support.google.com/sa360/answer/9566729 for details. Any value below 0.1 is reported as 0.0999.
*/
searchAbsoluteTopImpressionShare?: number | null;
/**
* The number estimating how often your ad wasn't the very first ad above the organic search results due to a low budget. Note: Search budget lost absolute top impression share is reported in the range of 0 to 0.9. Any value above 0.9 is reported as 0.9001.
*/
searchBudgetLostAbsoluteTopImpressionShare?: number | null;
/**
* The estimated percent of times that your ad was eligible to show on the Search Network but didn't because your budget was too low. Note: Search budget lost impression share is reported in the range of 0 to 0.9. Any value above 0.9 is reported as 0.9001.
*/
searchBudgetLostImpressionShare?: number | null;
/**
* The number estimating how often your ad didn't show anywhere above the organic search results due to a low budget. Note: Search budget lost top impression share is reported in the range of 0 to 0.9. Any value above 0.9 is reported as 0.9001.
*/
searchBudgetLostTopImpressionShare?: number | null;
/**
* The number of clicks you've received on the Search Network divided by the estimated number of clicks you were eligible to receive. Note: Search click share is reported in the range of 0.1 to 1. Any value below 0.1 is reported as 0.0999.
*/
searchClickShare?: number | null;
/**
* The impressions you've received divided by the estimated number of impressions you were eligible to receive on the Search Network for search terms that matched your keywords exactly (or were close variants of your keyword), regardless of your keyword match types. Note: Search exact match impression share is reported in the range of 0.1 to 1. Any value below 0.1 is reported as 0.0999.
*/
searchExactMatchImpressionShare?: number | null;
/**
* The impressions you've received on the Search Network divided by the estimated number of impressions you were eligible to receive. Note: Search impression share is reported in the range of 0.1 to 1. Any value below 0.1 is reported as 0.0999.
*/
searchImpressionShare?: number | null;
/**
* The number estimating how often your ad wasn't the very first ad above the organic search results due to poor Ad Rank. Note: Search rank lost absolute top impression share is reported in the range of 0 to 0.9. Any value above 0.9 is reported as 0.9001.
*/
searchRankLostAbsoluteTopImpressionShare?: number | null;
/**
* The estimated percentage of impressions on the Search Network that your ads didn't receive due to poor Ad Rank. Note: Search rank lost impression share is reported in the range of 0 to 0.9. Any value above 0.9 is reported as 0.9001.
*/
searchRankLostImpressionShare?: number | null;
/**
* The number estimating how often your ad didn't show anywhere above the organic search results due to poor Ad Rank. Note: Search rank lost top impression share is reported in the range of 0 to 0.9. Any value above 0.9 is reported as 0.9001.
*/
searchRankLostTopImpressionShare?: number | null;
/**
* The impressions you've received in the top location (anywhere above the organic search results) compared to the estimated number of impressions you were eligible to receive in the top location. Note: Search top impression share is reported in the range of 0.1 to 1. Any value below 0.1 is reported as 0.0999.
*/
searchTopImpressionShare?: number | null;
/**
* The percent of your ad impressions that are shown anywhere above the organic search results.
*/
topImpressionPercentage?: number | null;
/**
* The value of all conversions divided by the number of all conversions.
*/
valuePerAllConversions?: number | null;
/**
* The value of all conversions divided by the number of all conversions. When this column is selected with date, the values in date column means the conversion date. Details for the by_conversion_date columns are available at https://support.google.com/sa360/answer/9250611.
*/
valuePerAllConversionsByConversionDate?: number | null;
/**
* The value of biddable conversion divided by the number of biddable conversions. Shows how much, on average, each of the biddable conversions is worth.
*/
valuePerConversion?: number | null;
/**
* Biddable conversions value by conversion date divided by biddable conversions by conversion date. Shows how much, on average, each of the biddable conversions is worth (by conversion date). When this column is selected with date, the values in date column means the conversion date.
*/
valuePerConversionsByConversionDate?: number | null;
/**
* Clicks that Search Ads 360 has successfully recorded and forwarded to an advertiser's landing page.
*/
visits?: number | null;
}
/**
* An asset representing a mobile app.
*/
export interface Schema$GoogleAdsSearchads360V0Common__MobileAppAsset {
/**
* Required. A string that uniquely identifies a mobile application. It should just contain the platform native id, like "com.android.ebay" for Android or "12345689" for iOS.
*/
appId?: string | null;
/**
* Required. The application store that distributes this specific app.
*/
appStore?: string | null;
}
/**
* A bidding strategy where bids are a fraction of the advertised price for some good or service.
*/
export interface Schema$GoogleAdsSearchads360V0Common__PercentCpc {
/**
* Maximum bid limit that can be set by the bid strategy. This is an optional field entered by the advertiser and specified in local micros. Note: A zero value is interpreted in the same way as having bid_ceiling undefined.
*/
cpcBidCeilingMicros?: string | null;
/**
* Adjusts the bid for each auction upward or downward, depending on the likelihood of a conversion. Individual bids may exceed cpc_bid_ceiling_micros, but the average bid amount for a campaign should not.
*/
enhancedCpcEnabled?: boolean | null;
}
/**
* Settings for Real-Time Bidding, a feature only available for campaigns targeting the Ad Exchange network.
*/
export interface Schema$GoogleAdsSearchads360V0Common__RealTimeBiddingSetting {
/**
* Whether the campaign is opted in to real-time bidding.
*/
optIn?: boolean | null;
}
/**
* An expanded dynamic search ad.
*/
export interface Schema$GoogleAdsSearchads360V0Common__SearchAds360ExpandedDynamicSearchAdInfo {
/**
* The tracking id of the ad.
*/
adTrackingId?: string | null;
/**
* The first line of the ad's description.
*/
description1?: string | null;
/**
* The second line of the ad's description.
*/
description2?: string | null;
}
/**
* A Search Ads 360 expanded text ad.
*/
export interface Schema$GoogleAdsSearchads360V0Common__SearchAds360ExpandedTextAdInfo {
/**
* The tracking id of the ad.
*/
adTrackingId?: string | null;
/**
* The first line of the ad's description.
*/
description1?: string | null;
/**
* The second line of the ad's description.
*/
description2?: string | null;
/**
* The headline of the ad.
*/
headline?: string | null;
/**
* The second headline of the ad.
*/
headline2?: string | null;
/**
* The third headline of the ad.
*/
headline3?: string | null;
/**
* Text appended to the auto-generated visible URL with a delimiter.
*/
path1?: string | null;
/**
* Text appended to path1 with a delimiter.
*/
path2?: string | null;
}
/**
* A Search Ads 360 product ad.
*/
export interface Schema$GoogleAdsSearchads360V0Common__SearchAds360ProductAdInfo {
}
/**
* A Search Ads 360 responsive search ad.
*/
export interface Schema$GoogleAdsSearchads360V0Common__SearchAds360ResponsiveSearchAdInfo {
/**
* The tracking id of the ad.
*/
adTrackingId?: string | null;
/**
* Text appended to the auto-generated visible URL with a delimiter.
*/
path1?: string | null;
/**
* Text appended to path1 with a delimiter.
*/
path2?: string | null;
}
/**
* A Search Ads 360 text ad.
*/
export interface Schema$GoogleAdsSearchads360V0Common__SearchAds360TextAdInfo {
/**
* The tracking id of the ad.
*/
adTrackingId?: string | null;
/**
* The first line of the ad's description.
*/
description1?: string | null;
/**
* The second line of the ad's description.
*/
description2?: string | null;
/**
* The displayed mobile URL of the ad.
*/
displayMobileUrl?: string | null;
/**
* The displayed URL of the ad.
*/
displayUrl?: string | null;
/**
* The headline of the ad.
*/
headline?: string | null;
}
/**
* Segment only fields.
*/
export interface Schema$GoogleAdsSearchads360V0Common__Segments {
/**
* Ad network type.
*/
adNetworkType?: string | null;
/**
* Resource name of the conversion action.
*/
conversionAction?: string | null;
/**
* Conversion action category.
*/
conversionActionCategory?: string | null;
/**
* Conversion action name.
*/
conversionActionName?: string | null;
/**
* Date to which metrics apply. yyyy-MM-dd format, for example, 2018-04-17.
*/
date?: string | null;
/**
* Day of the week, for example, MONDAY.
*/
dayOfWeek?: string | null;
/**
* Device to which metrics apply.
*/
device?: string | null;
/**
* Keyword criterion.
*/
keyword?: Schema$GoogleAdsSearchads360V0Common__Keyword;
/**
* Month as represented by the date of the first day of a month. Formatted as yyyy-MM-dd.
*/
month?: string | null;
/**
* Quarter as represented by the date of the first day of a quarter. Uses the calendar year for quarters, for example, the second quarter of 2018 starts on 2018-04-01. Formatted as yyyy-MM-dd.
*/
quarter?: string | null;
/**
* Week as defined as Monday through Sunday, and represented by the date of Monday. Formatted as yyyy-MM-dd.
*/
week?: string | null;
/**
* Year, formatted as yyyy.
*/
year?: number | null;
}
/**
* An automated bid strategy that sets bids to help get as many conversions as possible at the target cost-per-acquisition (CPA) you set.
*/
export interface Schema$GoogleAdsSearchads360V0Common__TargetCpa {
/**
* Maximum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy. This should only be set for portfolio bid strategies.
*/
cpcBidCeilingMicros?: string | null;
/**
* Minimum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy. This should only be set for portfolio bid strategies.
*/
cpcBidFloorMicros?: string | null;
/**
* Average CPA target. This target should be greater than or equal to minimum billable unit based on the currency for the account.
*/
targetCpaMicros?: string | null;
}
/**
* Target CPM (cost per thousand impressions) is an automated bidding strategy that sets bids to optimize performance given the target CPM you set.
*/
export interface Schema$GoogleAdsSearchads360V0Common__TargetCpm {
}
/**
* 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).
*/
export interface Schema$GoogleAdsSearchads360V0Common__TargetImpressionShare {
/**
* The highest CPC bid the automated bidding system is permitted to specify. This is a required field entered by the advertiser that sets the ceiling and specified in local micros.
*/
cpcBidCeilingMicros?: string | null;
/**
* The targeted location on the search results page.
*/
location?: string | null;
/**
* The chosen fraction of ads to be shown in the targeted location in micros. For example, 1% equals 10,000.
*/
locationFractionMicros?: string | null;
}
/**
* 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
*/
export interface Schema$GoogleAdsSearchads360V0Common__TargetingSetting {
/**
* The per-targeting-dimension setting to restrict the reach of your campaign or ad group.
*/
targetRestrictions?: Schema$GoogleAdsSearchads360V0Common__TargetRestriction[];
}
/**
* An automated bidding strategy that sets bids based on the target fraction of auctions where the advertiser should outrank a specific competitor. This strategy is deprecated.
*/
export interface Schema$GoogleAdsSearchads360V0Common__TargetOutrankShare {
/**
* Maximum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy.
*/
cpcBidCeilingMicros?: string | null;
}
/**
* The list of per-targeting-dimension targeting settings.
*/
export interface Schema$GoogleAdsSearchads360V0Common__TargetRestriction {
/**
* Indicates whether to restrict your ads to show only for the criteria you have selected for this targeting_dimension, or to target all values for this targeting_dimension and show ads based on your targeting in other TargetingDimensions. A value of `true` means that these criteria will only apply bid modifiers, and not affect targeting. A value of `false` means that these criteria will restrict targeting as well as applying bid modifiers.
*/
bidOnly?: boolean | null;
/**
* The targeting dimension that these settings apply to.
*/
targetingDimension?: string | null;
}
/**
* An automated bidding strategy that helps you maximize revenue while averaging a specific target return on ad spend (ROAS).
*/
export interface Schema$GoogleAdsSearchads360V0Common__TargetRoas {
/**
* Maximum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy. This should only be set for portfolio bid strategies.
*/
cpcBidCeilingMicros?: string | null;
/**
* Minimum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy. This should only be set for portfolio bid strategies.
*/
cpcBidFloorMicros?: string | null;
/**
* Required. The chosen revenue (based on conversion data) per unit of spend. Value must be between 0.01 and 1000.0, inclusive.
*/
targetRoas?: number | null;
}
/**
* An automated bid strategy that sets your bids to help get as many clicks as possible within your budget.
*/
export interface Schema$GoogleAdsSearchads360V0Common__TargetSpend {
/**
* Maximum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy.
*/
cpcBidCeilingMicros?: string | null;
/**
* The spend target under which to maximize clicks. A TargetSpend bidder will attempt to spend the smaller of this value or the natural throttling spend amount. If not specified, the budget is used as the spend target. This field is deprecated and should no longer be used. See https://ads-developers.googleblog.com/2020/05/reminder-about-sunset-creation-of.html for details.
*/
targetSpendMicros?: string | null;
}
/**
* A type of label displaying text on a colored background.
*/
export interface Schema$GoogleAdsSearchads360V0Common__TextLabel {
/**
* Background color of the label in RGB format. This string must match the regular expression '^\#([a-fA-F0-9]{6\}|[a-fA-F0-9]{3\})$'. Note: The background color may not be visible for manager accounts.
*/
backgroundColor?: string | null;
/**
* A short description of the label. The length must be no more than 200 characters.
*/
description?: string | null;
}
/**
* A User List criterion. Represents a user list that is defined by the advertiser to be targeted.
*/
export interface Schema$GoogleAdsSearchads360V0Common__UserListInfo {
/**
* The User List resource name.
*/
userList?: string | null;
}
/**
* A generic data container.
*/
export interface Schema$GoogleAdsSearchads360V0Common__Value {
/**
* A boolean.
*/
booleanValue?: boolean | null;
/**
* A double.
*/
doubleValue?: number | null;
/**
* A float.
*/
floatValue?: number | null;
/**
* An int64.
*/
int64Value?: string | null;
/**
* A string.
*/
stringValue?: string | null;
}
/**
* Logical expression for targeting webpages of an advertiser's website.
*/
export interface Schema$GoogleAdsSearchads360V0Common__WebpageConditionInfo {
/**
* Argument of webpage targeting condition.
*/
argument?: string | null;
/**
* Operand of webpage targeting condition.
*/
operand?: string | null;
/**
* Operator of webpage targeting condition.
*/
operator?: string | null;
}
/**
* Represents a criterion for targeting webpages of an advertiser's website.
*/
export interface Schema$GoogleAdsSearchads360V0Common__WebpageInfo {
/**
* Conditions, or logical expressions, for webpage targeting. The list of webpage targeting conditions are and-ed together when evaluated for targeting. An empty list of conditions indicates all pages of the campaign's website are targeted. This field is required for CREATE operations and is prohibited on UPDATE operations.
*/
conditions?: Schema$GoogleAdsSearchads360V0Common__WebpageConditionInfo[];
/**
* Website criteria coverage percentage. This is the computed percentage of website coverage based on the website target, negative website target and negative keywords in the ad group and campaign. For instance, when coverage returns as 1, it indicates it has 100% coverage. This field is read-only.
*/
coveragePercentage?: number | null;
/**
* The name of the criterion that is defined by this parameter. The name value will be used for identifying, sorting and filtering criteria with this type of parameters. This field is required for CREATE operations and is prohibited on UPDATE operations.
*/
criterionName?: string | null;
}
/**
* A part of a field path.
*/
export interface Schema$GoogleAdsSearchads360V0Errors_ErrorLocation_FieldPathElement {
/**
* The name of a field or a oneof
*/
fieldName?: string | null;
/**
* If field_name is a repeated field, this is the element that failed
*/
index?: number | null;
}
/**
* The error reason represented by type and enum.
*/
export interface Schema$GoogleAdsSearchads360V0Errors__ErrorCode {
/**
* Indicates failure to properly authenticate user.
*/
authenticationError?: string | null;
/**
* An error encountered when trying to authorize a user.
*/
authorizationError?: string | null;
/**
* The reasons for the custom column error
*/
customColumnError?: string | null;
/**
* The reasons for the date error
*/
dateError?: string | null;
/**
* The reasons for the date range error
*/
dateRangeError?: string | null;
/**
* The reasons for the distinct error
*/
distinctError?: string | null;
/**
* The reasons for the header error.
*/
headerError?: string | null;
/**
* An unexpected server-side error.
*/
internalError?: string | null;
/**
* An error with the query
*/
queryError?: string | null;
/**
* An error with the amonut of quota remaining.
*/
quotaError?: string | null;
/**
* An error caused by the request
*/
requestError?: string | null;
/**
* The reasons for the size limit error
*/
sizeLimitError?: string | null;
}
/**
* Additional error details.
*/
export interface Schema$GoogleAdsSearchads360V0Errors__ErrorDetails {
/**
* Details on the quota error, including the scope (account or developer), the rate bucket name and the retry delay.
*/
quotaErrorDetails?: Schema$GoogleAdsSearchads360V0Errors__QuotaErrorDetails;
/**
* The error code that should have been returned, but wasn't. This is used when the error code is not published in the client specified version.
*/
unpublishedErrorCode?: string | null;
}
/**
* Describes the part of the request proto that caused the error.
*/
export interface Schema$GoogleAdsSearchads360V0Errors__ErrorLocation {
/**
* A field path that indicates which field was invalid in the request.
*/
fieldPathElements?: Schema$GoogleAdsSearchads360V0Errors_ErrorLocation_FieldPathElement[];
}
/**
* Additional quota error details when there is QuotaError.
*/
export interface Schema$GoogleAdsSearchads360V0Errors__QuotaErrorDetails {
/**
* The high level description of the quota bucket. Examples are "Get requests for standard access" or "Requests per account".
*/
rateName?: string | null;
/**
* The rate scope of the quota limit.
*/
rateScope?: string | null;
/**
* Backoff period that customers should wait before sending next request.
*/
retryDelay?: string | null;
}
/**
* SearchAds360-specific error.
*/
export interface Schema$GoogleAdsSearchads360V0Errors__SearchAds360Error {
/**
* Additional error details, which are returned by certain error codes. Most error codes do not include details.
*/
details?: Schema$GoogleAdsSearchads360V0Errors__ErrorDetails;
/**
* An enum value that indicates which error occurred.
*/
errorCode?: Schema$GoogleAdsSearchads360V0Errors__ErrorCode;
/**
* Describes the part of the request proto that caused the error.
*/
location?: Schema$GoogleAdsSearchads360V0Errors__ErrorLocation;
/**
* A human-readable description of the error.
*/
message?: string | null;
/**
* The value that triggered the error.
*/
trigger?: Schema$GoogleAdsSearchads360V0Common__Value;
}
/**
* Describes how a Search Ads 360 API call failed. It's returned inside google.rpc.Status.details when a call fails.
*/
export interface Schema$GoogleAdsSearchads360V0Errors__SearchAds360Failure {
/**
* The list of errors that occurred.
*/
errors?: Schema$GoogleAdsSearchads360V0Errors__SearchAds360Error[];
/**
* The unique ID of the request that is used for debugging purposes.
*/
requestId?: string | null;
}
/**
* A container for ad group criterion quality information.
*/
export interface Schema$GoogleAdsSearchads360V0Resources_AdGroupCriterion_QualityInfo {
/**
* Output only. The quality score. This field may not be populated if Google does not have enough information to determine a value.
*/
qualityScore?: number | null;
}
/**
* The setting for controlling Dynamic Search Ads (DSA).
*/
export interface Schema$GoogleAdsSearchads360V0Resources_Campaign_DynamicSearchAdsSetting {
/**
* Required. The Internet domain name that this setting represents, for example, "google.com" or "www.google.com".
*/
domainName?: string | null;
/**
* Required. The language code specifying the language of the domain, for example, "en".
*/
languageCode?: string | null;
/**
* Whether the campaign uses advertiser supplied URLs exclusively.
*/
useSuppliedUrlsOnly?: boolean | null;
}
/**
* Represents a collection of settings related to ads geotargeting.
*/
export interface Schema$GoogleAdsSearchads360V0Resources_Campaign_GeoTargetTypeSetting {
/**
* The setting used for negative geotargeting in this particular campaign.
*/
negativeGeoTargetType?: string | null;
/**
* The setting used for positive geotargeting in this particular campaign.
*/
positiveGeoTargetType?: string | null;
}
/**
* The network settings for the campaign.
*/
export interface Schema$GoogleAdsSearchads360V0Resources_Campaign_NetworkSettings {
/**
* Whether ads will be served on specified placements in the Google Display Network. Placements are specified using the Placement criterion.
*/
targetContentNetwork?: boolean | null;
/**
* Whether ads will be served with google.com search results.
*/
targetGoogleSearch?: boolean | null;
/**
* Whether ads will be served on the Google Partner Network. This is available only to some select Google partner accounts.
*/
targetPartnerSearchNetwork?: boolean | null;
/**
* Whether ads will be served on partner sites in the Google Search Network (requires `target_google_search` to also be `true`).
*/
targetSearchNetwork?: boolean | null;
}
/**
* Optimization goal setting for this campaign, which includes a set of optimization goal types.
*/
export interface Schema$GoogleAdsSearchads360V0Resources_Campaign_OptimizationGoalSetting {
/**
* The list of optimization goal types.
*/
optimizationGoalTypes?: string[] | null;
}
/**
* Selective optimization setting for this campaign, which includes a set of conversion actions to optimize this campaign towards.
*/
export interface Schema$GoogleAdsSearchads360V0Resources_Campaign_SelectiveOptimization {
/**
* The selected set of conversion actions for optimizing this campaign.
*/
conversionActions?: string[] | null;
}
/**
* 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.
*/
export interface Schema$GoogleAdsSearchads360V0Resources_Campaign_ShoppingSetting {
/**
* Priority of the campaign. Campaigns with numerically higher priorities take precedence over those with lower priorities. This field