googleapis
Version:
Google APIs Client Library for Node.js
702 lines • 254 kB
TypeScript
import { OAuth2Client, JWT, Compute, UserRefreshClient, BaseExternalAccountClient, GaxiosResponseWithHTTP2, 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);
}
/**
* 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.
*/
export interface Schema$GoogleAdsSearchads360V0Common__AdScheduleInfo {
/**
* Day of the week the schedule applies to. This field is required for CREATE operations and is prohibited on UPDATE operations.
*/
dayOfWeek?: string | null;
/**
* Ending hour in 24 hour time; 24 signifies end of the day. This field must be between 0 and 24, inclusive. This field is required for CREATE operations and is prohibited on UPDATE operations.
*/
endHour?: number | null;
/**
* Minutes after the end hour at which this schedule ends. The schedule is exclusive of the end minute. This field is required for CREATE operations and is prohibited on UPDATE operations.
*/
endMinute?: string | null;
/**
* Starting hour in 24 hour time. This field must be between 0 and 23, inclusive. This field is required for CREATE operations and is prohibited on UPDATE operations.
*/
startHour?: number | null;
/**
* Minutes after the start hour at which this schedule starts. This field is required for CREATE operations and is prohibited on UPDATE operations.
*/
startMinute?: string | null;
}
/**
* A text asset used inside an ad.
*/
export interface Schema$GoogleAdsSearchads360V0Common__AdTextAsset {
/**
* Asset text.
*/
text?: string | null;
}
/**
* An age range criterion.
*/
export interface Schema$GoogleAdsSearchads360V0Common__AgeRangeInfo {
/**
* Type of the age range.
*/
type?: string | null;
}
/**
* An AssetInteractionTarget segment.
*/
export interface Schema$GoogleAdsSearchads360V0Common__AssetInteractionTarget {
/**
* The asset resource name.
*/
asset?: string | null;
/**
* Only used with CustomerAsset, CampaignAsset and AdGroupAsset metrics. Indicates whether the interaction metrics occurred on the asset itself or a different asset or ad unit.
*/
interactionOnThisAsset?: boolean | null;
}
/**
* Contains the usage information of the asset.
*/
export interface Schema$GoogleAdsSearchads360V0Common__AssetUsage {
/**
* Resource name of the asset.
*/
asset?: string | null;
/**
* The served field type of the asset.
*/
servedAssetFieldType?: string | null;
}
/**
* An audience criterion.
*/
export interface Schema$GoogleAdsSearchads360V0Common__AudienceInfo {
/**
* The Audience resource name.
*/
audience?: string | null;
}
/**
* Business Profile location data synced from the linked Business Profile account.
*/
export interface Schema$GoogleAdsSearchads360V0Common__BusinessProfileLocation {
/**
* Advertiser specified label for the location on the Business Profile account. This is synced from the Business Profile account.
*/
labels?: string[] | null;
/**
* Listing ID of this Business Profile location. This is synced from the linked Business Profile account.
*/
listingId?: string | null;
/**
* Business Profile store code of this location. This is synced from the Business Profile account.
*/
storeCode?: string | null;
}
/**
* A call to action asset.
*/
export interface Schema$GoogleAdsSearchads360V0Common__CallToActionAsset {
/**
* Call to action.
*/
callToAction?: 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 URL for deep linking into an app for the given operating system.
*/
export interface Schema$GoogleAdsSearchads360V0Common__FinalAppUrl {
/**
* The operating system targeted by this URL. Required.
*/
osType?: string | null;
/**
* The app deep link URL. Deep links specify a location in an app that corresponds to the content you'd like to show, and should be of the form {scheme\}://{host_path\} The scheme identifies which app to open. For your app, you can use a custom scheme that starts with the app's name. The host and path specify the unique location in the app where your content exists. Example: "exampleapp://productid_1234". Required.
*/
url?: string | null;
}
/**
* 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;
}
/**
* An Image asset.
*/
export interface Schema$GoogleAdsSearchads360V0Common__ImageAsset {
/**
* File size of the image asset in bytes.
*/
fileSize?: string | null;
/**
* Metadata for this image at its original size.
*/
fullSize?: Schema$GoogleAdsSearchads360V0Common__ImageDimension;
/**
* MIME type of the image asset.
*/
mimeType?: string | null;
}
/**
* Metadata for an image at a certain size, either original or resized.
*/
export interface Schema$GoogleAdsSearchads360V0Common__ImageDimension {
/**
* Height of the image.
*/
heightPixels?: string | null;
/**
* A URL that returns the image with this height and width.
*/
url?: string | null;
/**
* Width of the image.
*/
widthPixels?: 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 {
/**
* Search absolute top impression share is the percentage of your Search ad impressions that are shown in the most prominent Search position.
*/
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;
/**
* Average cart size is the average number of products in each order attributed to your ads. How it works: You report conversions with cart data for completed purchases on your website. Average cart size is the total number of products sold divided by the total number of orders you received. Example: You received 2 orders, the first included 3 products and the second included 2. The average cart size is 2.5 products = (3+2)/2. This metric is only available if you report conversions with cart data.
*/
averageCartSize?: 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. This metric is a monetary value and returned in the customer's currency by default. See the metrics_currency parameter at https://developers.google.com/search-ads/reporting/query/query-structure#parameters_clause
*/
averageCpc?: number | null;
/**
* Average cost-per-thousand impressions (CPM). This metric is a monetary value and returned in the customer's currency by default. See the metrics_currency parameter at https://developers.google.com/search-ads/reporting/query/query-structure#parameters_clause
*/
averageCpm?: number | null;
/**
* The average number of times a unique user saw your ad during the requested time period. This metric cannot be aggregated, and can only be requested for date ranges of 92 days or less. This metric is available for following campaign types - Display, Video, Discovery and App.
*/
averageImpressionFrequencyPerUser?: number | null;
/**
* Average order value is the average revenue you made per order attributed to your ads. How it works: You report conversions with cart data for completed purchases on your website. Average order value is the total revenue from your orders divided by the total number of orders. Example: You received 3 orders which made $10, $15 and $20 worth of revenue. The average order value is $15 = ($10 + $15 + $20)/3. This metric is only available if you report conversions with cart data.
*/
averageOrderValueMicros?: string | null;
/**
* The average quality score.
*/
averageQualityScore?: 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;
/**
* Client account cross-sell cost of goods sold (COGS) is the total cost of products sold as a result of advertising a different product. How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with before the purchase has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the order the customer places is a sold product. If these products don't match then this is considered cross-sell. Cross-sell cost of goods sold is the total cost of the products sold that weren't advertised. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt. The hat has a cost of goods sold value of $3, the shirt has a cost of goods sold value of $5. The cross-sell cost of goods sold for this order is $5. This metric is only available if you report conversions with cart data. This metric is a monetary value and returned in the customer's currency by default. See the metrics_currency parameter at https://developers.google.com/search-ads/reporting/query/query-structure#parameters_clause
*/
clientAccountCrossSellCostOfGoodsSoldMicros?: string | null;
/**
* Client account cross-sell gross profit is the profit you made from products sold as a result of advertising a different product, minus cost of goods sold (COGS). How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with before the purchase has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the purchase is a sold product. If these products don't match then this is considered cross-sell. Cross-sell gross profit is the revenue you made from cross-sell attributed to your ads minus the cost of the goods sold. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt. The shirt is priced $20 and has a cost of goods sold value of $5. The cross-sell gross profit of this order is $15 = $20 - $5. This metric is only available if you report conversions with cart data. This metric is a monetary value and returned in the customer's currency by default. See the metrics_currency parameter at https://developers.google.com/search-ads/reporting/query/query-structure#parameters_clause
*/
clientAccountCrossSellGrossProfitMicros?: string | null;
/**
* Client account cross-sell revenue is the total amount you made from products sold as a result of advertising a different product. How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with before the purchase has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the order the customer places is a sold product. If these products don't match then this is considered cross-sell. Cross-sell revenue is the total value you made from cross-sell attributed to your ads. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt. The hat is priced $10 and the shirt is priced $20. The cross-sell revenue of this order is $20. This metric is only available if you report conversions with cart data. This metric is a monetary value and returned in the customer's currency by default. See the metrics_currency parameter at https://developers.google.com/search-ads/reporting/query/query-structure#parameters_clause
*/
clientAccountCrossSellRevenueMicros?: string | null;
/**
* Client account cross-sell units sold is the total number of products sold as a result of advertising a different product. How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with before the purchase has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the order the customer places is a sold product. If these products don't match then this is considered cross-sell. Cross-sell units sold is the total number of cross-sold products from all orders attributed to your ads. Example: Someone clicked on a Shopping ad for a hat then bought the same hat, a shirt and a jacket. The cross-sell units sold in this order is 2. This metric is only available if you report conversions with cart data.
*/
clientAccountCrossSellUnitsSold?: number | null;
/**
* Client account lead cost of goods sold (COGS) is the total cost of products sold as a result of advertising the same product. How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the order the customer places is a sold product. If the advertised and sold products match, then the cost of these goods is counted under lead cost of goods sold. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt. The hat has a cost of goods sold value of $3, the shirt has a cost of goods sold value of $5. The lead cost of goods sold for this order is $3. This metric is only available if you report conversions with cart data. This metric is a monetary value and returned in the customer's currency by default. See the metrics_currency parameter at https://developers.google.com/search-ads/reporting/query/query-structure#parameters_clause
*/
clientAccountLeadCostOfGoodsSoldMicros?: string | null;
/**
* Client account lead gross profit is the profit you made from products sold as a result of advertising the same product, minus cost of goods sold (COGS). How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with before the purchase has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the order the customer places is a sold product. If the advertised and sold products match, then the revenue you made from these sales minus the cost of goods sold is your lead gross profit. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt. The hat is priced $10 and has a cost of goods sold value of $3. The lead gross profit of this order is $7 = $10 - $3. This metric is only available if you report conversions with cart data. This metric is a monetary value and returned in the customer's currency by default. See the metrics_currency parameter at https://developers.google.com/search-ads/reporting/query/query-structure#parameters_clause
*/
clientAccountLeadGrossProfitMicros?: string | null;
/**
* Client account lead revenue is the total amount you made from products sold as a result of advertising the same product. How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with before the purchase has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the order the customer places is a sold product. If the advertised and sold products match, then the total value you made from the sales of these products is shown under lead revenue. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt. The hat is priced $10 and the shirt is priced $20. The lead revenue of this order is $10. This metric is only available if you report conversions with cart data. This metric is a monetary value and returned in the customer's currency by default. See the metrics_currency parameter at https://developers.google.com/search-ads/reporting/query/query-structure#parameters_clause
*/
clientAccountLeadRevenueMicros?: string | null;
/**
* Client account lead units sold is the total number of products sold as a result of advertising the same product. How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with before the purchase has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the order the customer places is a sold product. If the advertised and sold products match, then the total number of these products sold is shown under lead units sold. Example: Someone clicked on a Shopping ad for a hat then bought the same hat, a shirt and a jacket. The lead units sold in this order is 1. This metric is only available if you report conversions with cart data.
*/
clientAccountLeadUnitsSold?: 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 conversion custom metrics.
*/
conversionCustomMetrics?: Schema$GoogleAdsSearchads360V0Common__Value[];
/**
* 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. This metric is a monetary value and returned in the customer's currency by default. See the metrics_currency parameter at https://developers.google.com/search-ads/reporting/query/query-structure#parameters_clause
*/
costMicros?: string | null;
/**
* Cost of goods sold (COGS) is the total cost of the products you sold in orders attributed to your ads. How it works: You can add a cost of goods sold value to every product in Merchant Center. If you report conversions with cart data, the products you sold are matched with their cost of goods sold value and this can be used to calculate the gross profit you made on each order. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt. The hat has a cost of goods sold value of $3, the shirt has a cost of goods sold value of $5. The cost of goods sold for this order is $8 = $3 + $5. This metric is only available if you report conversions with cart data.
*/
costOfGoodsSoldMicros?: 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 number of cross-device conversions by conversion date. Details for the by_conversion_date columns are available at https://support.google.com/sa360/answer/9250611.
*/
crossDeviceConversionsByConversionDate?: number | null;
/**
* The sum of the value of cross-device conversions.
*/
crossDeviceConversionsValue?: number | null;
/**
* The sum of cross-device conversions value by conversion date. Details for the by_conversion_date columns are available at https://support.google.com/sa360/answer/9250611.
*/
crossDeviceConversionsValueByConversionDate?: number | null;
/**
* Cross-sell cost of goods sold (COGS) is the total cost of products sold as a result of advertising a different product. How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with before the purchase has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the order the customer places is a sold product. If these products don't match then this is considered cross-sell. Cross-sell cost of goods sold is the total cost of the products sold that weren't advertised. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt. The hat has a cost of goods sold value of $3, the shirt has a cost of goods sold value of $5. The cross-sell cost of goods sold for this order is $5. This metric is only available if you report conversions with cart data. This metric is a monetary value and returned in the customer's currency by default. See the metrics_currency parameter at https://developers.google.com/search-ads/reporting/query/query-structure#parameters_clause
*/
crossSellCostOfGoodsSoldMicros?: string | null;
/**
* Cross-sell gross profit is the profit you made from products sold as a result of advertising a different product, minus cost of goods sold (COGS). How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with before the purchase has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the purchase is a sold product. If these products don't match then this is considered cross-sell. Cross-sell gross profit is the revenue you made from cross-sell attributed to your ads minus the cost of the goods sold. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt. The shirt is priced $20 and has a cost of goods sold value of $5. The cross-sell gross profit of this order is $15 = $20 - $5. This metric is only available if you report conversions with cart data. This metric is a monetary value and returned in the customer's currency by default. See the metrics_currency parameter at https://developers.google.com/search-ads/reporting/query/query-structure#parameters_clause
*/
crossSellGrossProfitMicros?: string | null;
/**
* Cross-sell revenue is the total amount you made from products sold as a result of advertising a different product. How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with before the purchase has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the order the customer places is a sold product. If these products don't match then this is considered cross-sell. Cross-sell revenue is the total value you made from cross-sell attributed to your ads. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt. The hat is priced $10 and the shirt is priced $20. The cross-sell revenue of this order is $20. This metric is only available if you report conversions with cart data. This metric is a monetary value and returned in the customer's currency by default. See the metrics_currency parameter at https://developers.google.com/search-ads/reporting/query/query-structure#parameters_clause
*/
crossSellRevenueMicros?: string | null;
/**
* Cross-sell units sold is the total number of products sold as a result of advertising a different product. How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with before the purchase has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the order the customer places is a sold product. If these products don't match then this is considered cross-sell. Cross-sell units sold is the total number of cross-sold products from all orders attributed to your ads. Example: Someone clicked on a Shopping ad for a hat then bought the same hat, a shirt and a jacket. The cross-sell units sold in this order is 2. This metric is only available if you report conversions with cart data.
*/
crossSellUnitsSold?: 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 percentage of clicks that have been filtered out of your total number of clicks (filtered + non-filtered clicks) due to being general invalid clicks. These are clicks Google considers illegitimate that are detected through routine means of filtration (that is, known invalid data-center traffic, bots and spiders or other crawlers, irregular patterns, etc). You're not charged for them, and they don't affect your account statistics. See the help page at https://support.google.com/campaignmanager/answer/6076504 for details.
*/
generalInvalidClickRate?: number | null;
/**
* Number of general invalid clicks. These are a subset of your invalid clicks that are detected through routine means of filtration (such as known invalid data-center traffic, bots and spiders or other crawlers, irregular patterns, etc.). You're not charged for them, and they don't affect your account statistics. See the help page at https://support.google.com/campaignmanager/answer/6076504 for details.
*/
generalInvalidClicks?: string | null;
/**
* Gross profit margin is the percentage gross profit you made from orders attributed to your ads, after taking out the cost of goods sold (COGS). How it works: You report conversions with cart data for completed purchases on your website. Gross profit margin is the gross profit you made divided by your total revenue and multiplied by 100%. Gross profit margin calculations only include products that have a cost of goods sold value in Merchant Center. Example: Someone bought a hat and a shirt in an order on your website. The hat is priced $10 and has a cost of goods sold value of $3. The shirt is priced $20 but has no cost of goods sold value. Gross profit margin for this order will only take into account the hat because it has a cost of goods sold value, so it's 70% = ($10 - $3)/$10 x 100%. This metric is only available if you report conversions with cart data.
*/
grossProfitMargin?: number | null;
/**
* Gross profit is the profit you made from orders attributed to your ads minus the cost of goods sold (COGS). How it works: Gross profit is the revenue you made from sales attributed to your ads minus cost of goods sold. Gross profit calculations only include products that have a cost of goods sold value in Merchant Center. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt in an order from your website. The hat is priced $10 and the shirt is priced $20. The hat has a cost of goods sold value of $3, but the shirt has no cost of goods sold value. Gross profit for this order will only take into account the hat, so it's $7 = $10 - $3. This metric is only available if you report conversions with cart data.
*/
grossProfitMicros?: string | 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;
/**
* Lead cost of goods sold (COGS) is the total cost of products sold as a result of advertising the same product. How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the order the customer places is a sold product. If the advertised and sold products match, then the cost of these goods is counted under lead cost of goods sold. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt. The hat has a cost of goods sold value of $3, the shirt has a cost of goods sold value of $5. The lead cost of goods sold for this order is $3. This metric is only available if you report conversions with cart data. This metric is a monetary value and returned in the customer's currency by default. See the metrics_currency parameter at https://developers.google.com/search-ads/reporting/query/query-structure#parameters_clause
*/
leadCostOfGoodsSoldMicros?: string | null;
/**
* Lead gross profit is the profit you made from products sold as a result of advertising the same product, minus cost of goods sold (COGS). How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with before the purchase has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the order the customer places is a sold product. If the advertised and sold products match, then the revenue you made from these sales minus the cost of goods sold is your lead gross profit. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt. The hat is priced $10 and has a cost of goods sold value of $3. The lead gross profit of this order is $7 = $10 - $3. This metric is only available if you report conversions with cart data. This metric is a monetary value and returned in the customer's currency by default. See the metrics_currency parameter at https://developers.google.com/search-ads/reporting/query/query-structure#parameters_clause
*/
leadGrossProfitMicros?: string | null;
/**
* Lead revenue is the total amount you made from products sold as a result of advertising the same product. How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with before the purchase has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the order the customer places is a sold product. If the advertised and sold products match, then the total value you made from the sales of these products is shown under lead revenue. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt. The hat is priced $10 and the shirt is priced $20. The lead revenue of this order is $10. This metric is only available if you report conversions with cart data. This metric is a monetary value and returned in the customer's currency by default. See the metrics_currency parameter at https://developers.google.com/search-ads/reporting/query/query-structure#parameters_clause
*/
leadRevenueMicros?: string | null;
/**
* Lead units sold is the total number of products sold as a result of advertising the same product. How it works: You report conversions with cart data for completed purchases on