google-ads-api-types 0.21.0

package/dist/google/ads/googleads/v21/resources/campaign.d.ts

@@ -0,0 +1,854 @@
+import { BinaryReader, BinaryWriter } from "@bufbuild/protobuf/wire";
+import { Commission, FixedCpm, ManualCpa, ManualCpc, ManualCpm, ManualCpv, MaximizeConversions, MaximizeConversionValue, PercentCpc, TargetCpa, TargetCpm, TargetCpv, TargetImpressionShare, TargetRoas, TargetSpend } from "../common/bidding.js";
+import { CustomParameter } from "../common/custom_parameter.js";
+import { FrequencyCapEntry } from "../common/frequency_cap.js";
+import { RealTimeBiddingSetting } from "../common/real_time_bidding_setting.js";
+import { TargetingSetting } from "../common/targeting_setting.js";
+import { CampaignThirdPartyIntegrationPartners } from "../common/third_party_integration_partners.js";
+import { AdGroupTypeEnum_AdGroupType } from "../enums/ad_group_type.js";
+import { AdServingOptimizationStatusEnum_AdServingOptimizationStatus } from "../enums/ad_serving_optimization_status.js";
+import { AdvertisingChannelSubTypeEnum_AdvertisingChannelSubType } from "../enums/advertising_channel_sub_type.js";
+import { AdvertisingChannelTypeEnum_AdvertisingChannelType } from "../enums/advertising_channel_type.js";
+import { AppCampaignAppStoreEnum_AppCampaignAppStore } from "../enums/app_campaign_app_store.js";
+import { AppCampaignBiddingStrategyGoalTypeEnum_AppCampaignBiddingStrategyGoalType } from "../enums/app_campaign_bidding_strategy_goal_type.js";
+import { AssetAutomationStatusEnum_AssetAutomationStatus } from "../enums/asset_automation_status.js";
+import { AssetAutomationTypeEnum_AssetAutomationType } from "../enums/asset_automation_type.js";
+import { AssetFieldTypeEnum_AssetFieldType } from "../enums/asset_field_type.js";
+import { AssetSetTypeEnum_AssetSetType } from "../enums/asset_set_type.js";
+import { BiddingStrategySystemStatusEnum_BiddingStrategySystemStatus } from "../enums/bidding_strategy_system_status.js";
+import { BiddingStrategyTypeEnum_BiddingStrategyType } from "../enums/bidding_strategy_type.js";
+import { BrandSafetySuitabilityEnum_BrandSafetySuitability } from "../enums/brand_safety_suitability.js";
+import { CampaignExperimentTypeEnum_CampaignExperimentType } from "../enums/campaign_experiment_type.js";
+import { CampaignKeywordMatchTypeEnum_CampaignKeywordMatchType } from "../enums/campaign_keyword_match_type.js";
+import { CampaignPrimaryStatusEnum_CampaignPrimaryStatus } from "../enums/campaign_primary_status.js";
+import { CampaignPrimaryStatusReasonEnum_CampaignPrimaryStatusReason } from "../enums/campaign_primary_status_reason.js";
+import { CampaignServingStatusEnum_CampaignServingStatus } from "../enums/campaign_serving_status.js";
+import { CampaignStatusEnum_CampaignStatus } from "../enums/campaign_status.js";
+import { EuPoliticalAdvertisingStatusEnum_EuPoliticalAdvertisingStatus } from "../enums/eu_political_advertising_status.js";
+import { ListingTypeEnum_ListingType } from "../enums/listing_type.js";
+import { LocationSourceTypeEnum_LocationSourceType } from "../enums/location_source_type.js";
+import { NegativeGeoTargetTypeEnum_NegativeGeoTargetType } from "../enums/negative_geo_target_type.js";
+import { NonSkippableMaxDurationEnum_NonSkippableMaxDuration } from "../enums/non_skippable_max_duration.js";
+import { NonSkippableMinDurationEnum_NonSkippableMinDuration } from "../enums/non_skippable_min_duration.js";
+import { OptimizationGoalTypeEnum_OptimizationGoalType } from "../enums/optimization_goal_type.js";
+import { PaymentModeEnum_PaymentMode } from "../enums/payment_mode.js";
+import { PerformanceMaxUpgradeStatusEnum_PerformanceMaxUpgradeStatus } from "../enums/performance_max_upgrade_status.js";
+import { PositiveGeoTargetTypeEnum_PositiveGeoTargetType } from "../enums/positive_geo_target_type.js";
+import { VanityPharmaDisplayUrlModeEnum_VanityPharmaDisplayUrlMode } from "../enums/vanity_pharma_display_url_mode.js";
+import { VanityPharmaTextEnum_VanityPharmaText } from "../enums/vanity_pharma_text.js";
+import { VideoAdFormatRestrictionEnum_VideoAdFormatRestriction } from "../enums/video_ad_format_restriction.js";
+import { VideoAdSequenceInteractionTypeEnum_VideoAdSequenceInteractionType } from "../enums/video_ad_sequence_interaction_type.js";
+import { VideoAdSequenceMinimumDurationEnum_VideoAdSequenceMinimumDuration } from "../enums/video_ad_sequence_minimum_duration.js";
+export declare const protobufPackage = "google.ads.googleads.v21.resources";
+/** A campaign. */
+export interface Campaign {
+    /**
+     * Immutable. The resource name of the campaign.
+     * Campaign resource names have the form:
+     *
+     * `customers/{customer_id}/campaigns/{campaign_id}`
+     */
+    resourceName: string;
+    /** Output only. The ID of the campaign. */
+    id?: number | undefined;
+    /**
+     * The name of the campaign.
+     *
+     * This field is required and should not be empty when creating new
+     * campaigns.
+     *
+     * It must not contain any null (code point 0x0), NL line feed
+     * (code point 0xA) or carriage return (code point 0xD) characters.
+     */
+    name?: string | undefined;
+    /**
+     * Output only. The primary status of the campaign.
+     *
+     * Provides insight into why a campaign is not serving or not serving
+     * optimally. Modification to the campaign and its related entities might take
+     * a while to be reflected in this status.
+     */
+    primaryStatus: CampaignPrimaryStatusEnum_CampaignPrimaryStatus;
+    /**
+     * Output only. The primary status reasons of the campaign.
+     *
+     * Provides insight into why a campaign is not serving or not serving
+     * optimally. These reasons are aggregated to determine an overall
+     * CampaignPrimaryStatus.
+     */
+    primaryStatusReasons: CampaignPrimaryStatusReasonEnum_CampaignPrimaryStatusReason[];
+    /**
+     * The status of the campaign.
+     *
+     * When a new campaign is added, the status defaults to ENABLED.
+     */
+    status: CampaignStatusEnum_CampaignStatus;
+    /** Output only. The ad serving status of the campaign. */
+    servingStatus: CampaignServingStatusEnum_CampaignServingStatus;
+    /** Output only. The system status of the campaign's bidding strategy. */
+    biddingStrategySystemStatus: BiddingStrategySystemStatusEnum_BiddingStrategySystemStatus;
+    /** The ad serving optimization status of the campaign. */
+    adServingOptimizationStatus: AdServingOptimizationStatusEnum_AdServingOptimizationStatus;
+    /**
+     * Immutable. The primary serving target for ads within the campaign.
+     * The targeting options can be refined in `network_settings`.
+     *
+     * This field is required and should not be empty when creating new
+     * campaigns.
+     *
+     * Can be set only when creating campaigns.
+     * After the campaign is created, the field can not be changed.
+     */
+    advertisingChannelType: AdvertisingChannelTypeEnum_AdvertisingChannelType;
+    /**
+     * Immutable. Optional refinement to `advertising_channel_type`.
+     * Must be a valid sub-type of the parent channel type.
+     *
+     * Can be set only when creating campaigns.
+     * After campaign is created, the field can not be changed.
+     */
+    advertisingChannelSubType: AdvertisingChannelSubTypeEnum_AdvertisingChannelSubType;
+    /** The URL template for constructing a tracking URL. */
+    trackingUrlTemplate?: string | undefined;
+    /**
+     * The list of mappings used to substitute custom parameter tags in a
+     * `tracking_url_template`, `final_urls`, or `mobile_final_urls`.
+     */
+    urlCustomParameters: CustomParameter[];
+    /** The Local Services Campaign related settings. */
+    localServicesCampaignSettings?: Campaign_LocalServicesCampaignSettings | undefined;
+    /** Settings for Travel campaign. */
+    travelCampaignSettings?: Campaign_TravelCampaignSettings | undefined;
+    /** Settings for Demand Gen campaign. */
+    demandGenCampaignSettings?: Campaign_DemandGenCampaignSettings | undefined;
+    /** Settings for Video campaign. */
+    videoCampaignSettings?: Campaign_VideoCampaignSettings | undefined;
+    /** Settings for Performance Max campaign. */
+    pmaxCampaignSettings?: Campaign_PmaxCampaignSettings | undefined;
+    /**
+     * Settings for Real-Time Bidding, a feature only available for campaigns
+     * targeting the Ad Exchange network.
+     */
+    realTimeBiddingSetting?: RealTimeBiddingSetting | undefined;
+    /** The network settings for the campaign. */
+    networkSettings?: Campaign_NetworkSettings | undefined;
+    /** Immutable. The hotel setting for the campaign. */
+    hotelSetting?: Campaign_HotelSettingInfo | undefined;
+    /** The setting for controlling Dynamic Search Ads (DSA). */
+    dynamicSearchAdsSetting?: Campaign_DynamicSearchAdsSetting | undefined;
+    /** The setting for controlling Shopping campaigns. */
+    shoppingSetting?: Campaign_ShoppingSetting | undefined;
+    /** Setting for targeting related features. */
+    targetingSetting?: TargetingSetting | undefined;
+    /** Immutable. Setting for audience related features. */
+    audienceSetting?: Campaign_AudienceSetting | undefined;
+    /** The setting for ads geotargeting. */
+    geoTargetTypeSetting?: Campaign_GeoTargetTypeSetting | undefined;
+    /** The setting for local campaign. */
+    localCampaignSetting?: Campaign_LocalCampaignSetting | undefined;
+    /** The setting related to App Campaign. */
+    appCampaignSetting?: Campaign_AppCampaignSetting | undefined;
+    /** Output only. The resource names of labels attached to this campaign. */
+    labels: string[];
+    /** Output only. The type of campaign: normal, draft, or experiment. */
+    experimentType: CampaignExperimentTypeEnum_CampaignExperimentType;
+    /**
+     * Output only. The resource name of the base campaign of a draft or
+     * experiment campaign. For base campaigns, this is equal to `resource_name`.
+     *
+     * This field is read-only.
+     */
+    baseCampaign?: string | undefined;
+    /** The resource name of the campaign budget of the campaign. */
+    campaignBudget?: string | undefined;
+    /**
+     * Output only. The type of bidding strategy.
+     *
+     * A bidding strategy can be created by setting either the bidding scheme to
+     * create a standard bidding strategy or the `bidding_strategy` field to
+     * create a portfolio bidding strategy.
+     *
+     * This field is read-only.
+     */
+    biddingStrategyType: BiddingStrategyTypeEnum_BiddingStrategyType;
+    /**
+     * Output only. Resource name of AccessibleBiddingStrategy, a read-only view
+     * of the unrestricted attributes of the attached portfolio bidding strategy
+     * identified by 'bidding_strategy'. Empty, if the campaign does not use a
+     * portfolio strategy. Unrestricted strategy attributes are available to all
+     * customers with whom the strategy is shared and are read from the
+     * AccessibleBiddingStrategy resource. In contrast, restricted attributes are
+     * only available to the owner customer of the strategy and their managers.
+     * Restricted attributes can only be read from the BiddingStrategy resource.
+     */
+    accessibleBiddingStrategy: string;
+    /**
+     * The date when campaign started in serving customer's timezone in YYYY-MM-DD
+     * format.
+     */
+    startDate?: string | undefined;
+    /** The resource name of the campaign group that this campaign belongs to. */
+    campaignGroup?: string | undefined;
+    /**
+     * The last day of the campaign in serving customer's timezone in YYYY-MM-DD
+     * format. On create, defaults to 2037-12-30, which means the campaign will
+     * run indefinitely. To set an existing campaign to run indefinitely, set this
+     * field to 2037-12-30.
+     */
+    endDate?: string | undefined;
+    /**
+     * Suffix used to append query parameters to landing pages that are served
+     * with parallel tracking.
+     */
+    finalUrlSuffix?: string | undefined;
+    /** A list that limits how often each user will see this campaign's ads. */
+    frequencyCaps: FrequencyCapEntry[];
+    /**
+     * Brand Safety setting at the individual campaign level. Allows for selecting
+     * an inventory type to show your ads on content that is the right fit for
+     * your brand. See https://support.google.com/google-ads/answer/7515513.
+     */
+    videoBrandSafetySuitability: BrandSafetySuitabilityEnum_BrandSafetySuitability;
+    /** Describes how unbranded pharma ads will be displayed. */
+    vanityPharma?: Campaign_VanityPharma | undefined;
+    /**
+     * Selective optimization setting for this campaign, which includes a set of
+     * conversion actions to optimize this campaign towards.
+     * This feature only applies to app campaigns that use MULTI_CHANNEL as
+     * AdvertisingChannelType and APP_CAMPAIGN or APP_CAMPAIGN_FOR_ENGAGEMENT as
+     * AdvertisingChannelSubType.
+     */
+    selectiveOptimization?: Campaign_SelectiveOptimization | undefined;
+    /**
+     * Optimization goal setting for this campaign, which includes a set of
+     * optimization goal types.
+     */
+    optimizationGoalSetting?: Campaign_OptimizationGoalSetting | undefined;
+    /** Output only. Campaign-level settings for tracking information. */
+    trackingSetting?: Campaign_TrackingSetting | undefined;
+    /** Payment mode for the campaign. */
+    paymentMode: PaymentModeEnum_PaymentMode;
+    /**
+     * Output only. Optimization score of the campaign.
+     *
+     * Optimization score is an estimate of how well a campaign is set to perform.
+     * It ranges from 0% (0.0) to 100% (1.0), with 100% indicating that the
+     * campaign is performing at full potential. This field is null for unscored
+     * campaigns.
+     *
+     * See "About optimization score" at
+     * https://support.google.com/google-ads/answer/9061546.
+     *
+     * This field is read-only.
+     */
+    optimizationScore?: number | undefined;
+    /**
+     * The asset field types that should be excluded from this campaign. Asset
+     * links with these field types will not be inherited by this campaign from
+     * the upper level.
+     */
+    excludedParentAssetFieldTypes: AssetFieldTypeEnum_AssetFieldType[];
+    /**
+     * The asset set types that should be excluded from this campaign. Asset set
+     * links with these types will not be inherited by this campaign from
+     * the upper level.
+     * Location group types (GMB_DYNAMIC_LOCATION_GROUP,
+     * CHAIN_DYNAMIC_LOCATION_GROUP, and STATIC_LOCATION_GROUP) are child types of
+     * LOCATION_SYNC. Therefore, if LOCATION_SYNC is set for this field, all
+     * location group asset sets are not allowed to be linked to this campaign,
+     * and all Location Extension (LE) and Affiliate Location Extensions (ALE)
+     * will not be served under this campaign.
+     * Only LOCATION_SYNC is currently supported.
+     */
+    excludedParentAssetSetTypes: AssetSetTypeEnum_AssetSetType[];
+    /**
+     * Represents opting out of URL expansion to more targeted URLs. If opted out
+     * (true), only the final URLs in the asset group or URLs specified in the
+     * advertiser's Google Merchant Center or business data feeds are targeted.
+     * If opted in (false), the entire domain will be targeted. This field can
+     * only be set for Performance Max campaigns, where the default value is
+     * false.
+     */
+    urlExpansionOptOut?: boolean | undefined;
+    /** Output only. Information about campaigns being upgraded to Performance Max. */
+    performanceMaxUpgrade?: Campaign_PerformanceMaxUpgrade | undefined;
+    /**
+     * Immutable. The resource name for a set of hotel properties for Performance
+     * Max for travel goals campaigns.
+     */
+    hotelPropertyAssetSet?: string | undefined;
+    /**
+     * Immutable. Listing type of ads served for this campaign.
+     * Field is restricted for usage with Performance Max campaigns.
+     */
+    listingType?: ListingTypeEnum_ListingType | undefined;
+    /**
+     * Contains the opt-in/out status of each AssetAutomationType.
+     * See documentation of each asset automation type enum for default
+     * opt in/out behavior.
+     */
+    assetAutomationSettings: Campaign_AssetAutomationSetting[];
+    /**
+     * Keyword match type of Campaign. Set to BROAD to set broad matching for all
+     * keywords in a campaign.
+     */
+    keywordMatchType: CampaignKeywordMatchTypeEnum_CampaignKeywordMatchType;
+    /**
+     * Immutable. Whether Brand Guidelines are enabled for this Campaign.
+     * Only applicable to Performance Max campaigns. If enabled, business name
+     * and logo assets must be linked as CampaignAssets instead of
+     * AssetGroupAssets.
+     *
+     * Writable only at campaign creation. Set to true to enable Brand
+     * Guidelines when creating a new Performance Max campaign.
+     *
+     * Immutable after creation. This field cannot be modified using standard
+     * update operations after the campaign has been created.
+     *
+     * For existing campaigns: To enable Brand Guidelines on a campaign after it
+     * has been created, use the CampaignService.EnablePMaxBrandGuidelines method,
+     * which is a separate operation. It is not possible to disable Brand
+     * Guidelines for an existing campaign.
+     *
+     * Incompatible with Travel Goals: This feature is not supported for
+     * Performance Max campaigns with Travel Goals. Attempting to set this field
+     * to true for a Travel Goals campaign will result in an error.
+     */
+    brandGuidelinesEnabled?: boolean | undefined;
+    /**
+     * These settings control how your brand appears in automatically generated
+     * assets and formats within this campaign. Note: These settings can only be
+     * used for Performance Max campaigns that have Brand Guidelines enabled.
+     */
+    brandGuidelines?: Campaign_BrandGuidelines | undefined;
+    /** Third-Party integration partners. */
+    thirdPartyIntegrationPartners?: CampaignThirdPartyIntegrationPartners | undefined;
+    /** Settings for AI Max in search campaigns. */
+    aiMaxSetting?: Campaign_AiMaxSetting | undefined;
+    /**
+     * The advertiser should self-declare whether this campaign contains
+     * political advertising content targeted towards the European Union.
+     */
+    containsEuPoliticalAdvertising: EuPoliticalAdvertisingStatusEnum_EuPoliticalAdvertisingStatus;
+    /** The resource name of the portfolio bidding strategy used by the campaign. */
+    biddingStrategy?: string | undefined;
+    /**
+     * Commission is an automatic bidding strategy in which the advertiser pays
+     * a certain portion of the conversion value.
+     */
+    commission?: Commission | undefined;
+    /**
+     * Standard Manual CPA bidding strategy.
+     * Manual bidding strategy that allows advertiser to set the bid per
+     * advertiser-specified action. Supported only for Local Services campaigns.
+     */
+    manualCpa?: ManualCpa | undefined;
+    /**
+     * Standard Manual CPC bidding strategy.
+     * Manual click-based bidding where user pays per click.
+     */
+    manualCpc?: ManualCpc | undefined;
+    /**
+     * Standard Manual CPM bidding strategy.
+     * Manual impression-based bidding where user pays per thousand
+     * impressions.
+     */
+    manualCpm?: ManualCpm | undefined;
+    /** A bidding strategy that pays a configurable amount per video view. */
+    manualCpv?: ManualCpv | undefined;
+    /**
+     * Standard Maximize Conversions bidding strategy that automatically
+     * maximizes number of conversions while spending your budget.
+     */
+    maximizeConversions?: MaximizeConversions | undefined;
+    /**
+     * Standard Maximize Conversion Value bidding strategy that automatically
+     * sets bids to maximize revenue while spending your budget.
+     */
+    maximizeConversionValue?: MaximizeConversionValue | undefined;
+    /**
+     * Standard Target CPA bidding strategy that automatically sets bids to
+     * help get as many conversions as possible at the target
+     * cost-per-acquisition (CPA) you set.
+     */
+    targetCpa?: TargetCpa | undefined;
+    /**
+     * Target Impression Share bidding strategy. An automated bidding strategy
+     * that sets bids to achieve a chosen percentage of impressions.
+     */
+    targetImpressionShare?: TargetImpressionShare | undefined;
+    /**
+     * Standard Target ROAS bidding strategy that automatically maximizes
+     * revenue while averaging a specific target return on ad spend (ROAS).
+     */
+    targetRoas?: TargetRoas | undefined;
+    /**
+     * Standard Target Spend bidding strategy that automatically sets your bids
+     * to help get as many clicks as possible within your budget.
+     */
+    targetSpend?: TargetSpend | undefined;
+    /**
+     * Standard Percent Cpc bidding strategy where bids are a fraction of the
+     * advertised price for some good or service.
+     */
+    percentCpc?: PercentCpc | undefined;
+    /**
+     * A bidding strategy that automatically optimizes cost per thousand
+     * impressions.
+     */
+    targetCpm?: TargetCpm | undefined;
+    /** A manual bidding strategy with a fixed CPM. */
+    fixedCpm?: FixedCpm | undefined;
+    /**
+     * An automated bidding strategy that sets bids to optimize performance
+     * given the target CPV you set.
+     */
+    targetCpv?: TargetCpv | undefined;
+}
+/** Information about a campaign being upgraded to Performance Max. */
+export interface Campaign_PerformanceMaxUpgrade {
+    /**
+     * Output only. The resource name of the Performance Max campaign the
+     * campaign is upgraded to.
+     */
+    performanceMaxCampaign: string;
+    /**
+     * Output only. The resource name of the legacy campaign upgraded to
+     * Performance Max.
+     */
+    preUpgradeCampaign: string;
+    /**
+     * Output only. The upgrade status of a campaign requested to be upgraded to
+     * Performance Max.
+     */
+    status: PerformanceMaxUpgradeStatusEnum_PerformanceMaxUpgradeStatus;
+}
+/** The network settings for the campaign. */
+export interface Campaign_NetworkSettings {
+    /** Whether ads will be served with google.com search results. */
+    targetGoogleSearch?: boolean | undefined;
+    /**
+     * Whether ads will be served on partner sites in the Google Search Network
+     * (requires `target_google_search` to also be `true`).
+     */
+    targetSearchNetwork?: boolean | undefined;
+    /**
+     * Whether ads will be served on specified placements in the Google Display
+     * Network. Placements are specified using the Placement criterion.
+     */
+    targetContentNetwork?: boolean | undefined;
+    /**
+     * Whether ads will be served on the Google Partner Network.
+     * This is available only to some select Google partner accounts.
+     */
+    targetPartnerSearchNetwork?: boolean | undefined;
+    /** Whether ads will be served on YouTube. */
+    targetYoutube?: boolean | undefined;
+    /** Whether ads will be served on the Google TV network. */
+    targetGoogleTvNetwork?: boolean | undefined;
+}
+/** Campaign-level settings for hotel ads. */
+export interface Campaign_HotelSettingInfo {
+    /** Immutable. The linked Hotel Center account. */
+    hotelCenterId?: number | undefined;
+}
+/** The setting for controlling Dynamic Search Ads (DSA). */
+export interface Campaign_DynamicSearchAdsSetting {
+    /**
+     * Required. The Internet domain name that this setting represents, for
+     * example, "google.com" or "www.google.com".
+     */
+    domainName: string;
+    /**
+     * Required. The language code specifying the language of the domain, for
+     * example, "en".
+     */
+    languageCode: string;
+    /** Whether the campaign uses advertiser supplied URLs exclusively. */
+    useSuppliedUrlsOnly?: boolean | undefined;
+}
+/**
+ * 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 Campaign_ShoppingSetting {
+    /**
+     * ID of the Merchant Center account.
+     * This field is required for create operations. This field is immutable for
+     * Shopping campaigns.
+     */
+    merchantId?: number | undefined;
+    /**
+     * Feed label of products to include in the campaign.
+     * Only one of feed_label or sales_country can be set.
+     * If used instead of sales_country, the feed_label field accepts country
+     * codes in the same format for example: 'XX'.
+     * Otherwise can be any string used for feed label in Google Merchant
+     * Center.
+     */
+    feedLabel: string;
+    /**
+     * Priority of the campaign. Campaigns with numerically higher priorities
+     * take precedence over those with lower priorities.
+     * This field is required for Shopping campaigns, with values between 0 and
+     * 2, inclusive.
+     * This field is optional for Smart Shopping campaigns, but must be equal to
+     * 3 if set.
+     */
+    campaignPriority?: number | undefined;
+    /** Whether to include local products. */
+    enableLocal?: boolean | undefined;
+    /**
+     * Immutable. Whether to target Vehicle Listing inventory. This field is
+     * supported only in Smart Shopping Campaigns. For setting Vehicle Listing
+     * inventory in Performance Max campaigns, use `listing_type` instead.
+     */
+    useVehicleInventory: boolean;
+    /**
+     * The list of Google Ads accounts IDs of advertising partners cooperating
+     * within the campaign.
+     * This feature is currently available only for accounts having an
+     * advertising partner link.
+     * This feature is currently supported only for Performance Max, Shopping,
+     * Search and Demand Gen campaign types.
+     */
+    advertisingPartnerIds: number[];
+    /**
+     * Disable the optional product feed. This field is currently supported
+     * only for Demand Gen campaigns. See
+     * https://support.google.com/google-ads/answer/13721750 to learn more about
+     * this feature.
+     */
+    disableProductFeed?: boolean | undefined;
+}
+/** Campaign-level settings for tracking information. */
+export interface Campaign_TrackingSetting {
+    /** Output only. The url used for dynamic tracking. */
+    trackingUrl?: string | undefined;
+}
+/** Represents a collection of settings related to ads geotargeting. */
+export interface Campaign_GeoTargetTypeSetting {
+    /** The setting used for positive geotargeting in this particular campaign. */
+    positiveGeoTargetType: PositiveGeoTargetTypeEnum_PositiveGeoTargetType;
+    /** The setting used for negative geotargeting in this particular campaign. */
+    negativeGeoTargetType: NegativeGeoTargetTypeEnum_NegativeGeoTargetType;
+}
+/** Campaign setting for local campaigns. */
+export interface Campaign_LocalCampaignSetting {
+    /** The location source type for this local campaign. */
+    locationSourceType: LocationSourceTypeEnum_LocationSourceType;
+}
+/** Campaign-level settings for App Campaigns. */
+export interface Campaign_AppCampaignSetting {
+    /**
+     * Represents the goal which the bidding strategy of this app campaign
+     * should optimize towards.
+     */
+    biddingStrategyGoalType: AppCampaignBiddingStrategyGoalTypeEnum_AppCampaignBiddingStrategyGoalType;
+    /** Immutable. A string that uniquely identifies a mobile application. */
+    appId?: string | undefined;
+    /** Immutable. The application store that distributes this specific app. */
+    appStore: AppCampaignAppStoreEnum_AppCampaignAppStore;
+}
+/** Describes how unbranded pharma ads will be displayed. */
+export interface Campaign_VanityPharma {
+    /** The display mode for vanity pharma URLs. */
+    vanityPharmaDisplayUrlMode: VanityPharmaDisplayUrlModeEnum_VanityPharmaDisplayUrlMode;
+    /**
+     * The text that will be displayed in display URL of the text ad when
+     * website description is the selected display mode for vanity pharma URLs.
+     */
+    vanityPharmaText: VanityPharmaTextEnum_VanityPharmaText;
+}
+/**
+ * Selective optimization setting for this campaign, which includes a set of
+ * conversion actions to optimize this campaign towards.
+ * This feature only applies to app campaigns that use MULTI_CHANNEL as
+ * AdvertisingChannelType and APP_CAMPAIGN or APP_CAMPAIGN_FOR_ENGAGEMENT as
+ * AdvertisingChannelSubType.
+ */
+export interface Campaign_SelectiveOptimization {
+    /**
+     * The selected set of resource names for conversion actions for optimizing
+     * this campaign.
+     */
+    conversionActions: string[];
+}
+/**
+ * Optimization goal setting for this campaign, which includes a set of
+ * optimization goal types.
+ */
+export interface Campaign_OptimizationGoalSetting {
+    /** The list of optimization goal types. */
+    optimizationGoalTypes: OptimizationGoalTypeEnum_OptimizationGoalType[];
+}
+/** Settings for the audience targeting. */
+export interface Campaign_AudienceSetting {
+    /**
+     * Immutable. If true, this campaign uses an Audience resource for audience
+     * targeting. If false, this campaign may use audience segment criteria
+     * instead.
+     */
+    useAudienceGrouped?: boolean | undefined;
+}
+/** Settings for LocalServicesCampaign subresource. */
+export interface Campaign_LocalServicesCampaignSettings {
+    /** Categorical level bids associated with MANUAL_CPA bidding strategy. */
+    categoryBids: Campaign_CategoryBid[];
+}
+/** Category bids in LocalServicesReportingCampaignSettings. */
+export interface Campaign_CategoryBid {
+    /**
+     * Category for which the bid will be associated with. For example,
+     * xcat:service_area_business_plumber.
+     */
+    categoryId?: string | undefined;
+    /**
+     * Manual CPA bid for the category. Bid must be greater than the
+     * reserve price associated for that category. Value is in micros
+     * and in the advertiser's currency.
+     */
+    manualCpaBidMicros?: number | undefined;
+    /**
+     * Target CPA bid for the category. Value is in micros and in the
+     * advertiser's currency.
+     */
+    targetCpaBidMicros?: number | undefined;
+}
+/** Settings for Travel campaign. */
+export interface Campaign_TravelCampaignSettings {
+    /** Immutable. The Travel account ID associated with the Travel campaign. */
+    travelAccountId?: number | undefined;
+}
+/** Settings for Demand Gen campaign. */
+export interface Campaign_DemandGenCampaignSettings {
+    /**
+     * Immutable. Specifies whether this campaign uses upgraded targeting
+     * options. When this field is set to `true`, you can use location and
+     * language targeting at the ad group level as opposed to the standard
+     * campaign-level targeting. This field defaults to `true`, and can only be
+     * set when creating a campaign.
+     */
+    upgradedTargeting?: boolean | undefined;
+}
+/** Settings for Video campaign. */
+export interface Campaign_VideoCampaignSettings {
+    /** Container for video ads sequencing definition. */
+    videoAdSequence?: Campaign_VideoCampaignSettings_VideoAdSequence | undefined;
+    /** Inventory control for video responsive ads in reach campaigns. */
+    videoAdInventoryControl?: Campaign_VideoCampaignSettings_VideoAdInventoryControl | undefined;
+    /**
+     * Format-restricting control enabling usage of video responsive ads in
+     * format defined Video campaigns (for example, non-skippable).
+     */
+    videoAdFormatControl?: Campaign_VideoCampaignSettings_VideoAdFormatControl | undefined;
+}
+/**
+ * For campaigns using video responsive ads inventory controls determine on
+ * which inventories the ads can be shown. This only applies for campaigns
+ * with the bidding strategies TARGET_CPM and FIXED_CPM.
+ */
+export interface Campaign_VideoCampaignSettings_VideoAdInventoryControl {
+    /** Determine if video responsive ads can be used for in-stream video ads. */
+    allowInStream?: boolean | undefined;
+    /** Determine if video responsive ads can be used for in-feed video ads. */
+    allowInFeed?: boolean | undefined;
+    /** Determine if video responsive ads can be used as shorts format. */
+    allowShorts?: boolean | undefined;
+    /**
+     * Determine if video responsive ads can be used for non-skippable
+     * in-stream ads. This is only available for campaigns that allow mixing
+     * of non-skippable with other formats (Video reach campaign with Target
+     * Frequency bidding strategy goal).
+     */
+    allowNonSkippableInStream?: boolean | undefined;
+}
+/**
+ * Format-restricting control enabling usage of video responsive ads in
+ * format defined Video campaigns (for example, non-skippable).
+ */
+export interface Campaign_VideoCampaignSettings_VideoAdFormatControl {
+    /** All contained responsive ads are expected to respect this restriction. */
+    formatRestriction: VideoAdFormatRestrictionEnum_VideoAdFormatRestriction;
+    /** Restrictions for non-skippable format. */
+    nonSkippableInStreamRestrictions?: Campaign_VideoCampaignSettings_NonSkippableInStreamRestrictions | undefined;
+}
+/** Restrictions for non-skippable format. */
+export interface Campaign_VideoCampaignSettings_NonSkippableInStreamRestrictions {
+    /** The minimum allowed duration for non-skippable ads. */
+    minDuration: NonSkippableMinDurationEnum_NonSkippableMinDuration;
+    /** The maximum allowed duration for non-skippable ads. */
+    maxDuration: NonSkippableMaxDurationEnum_NonSkippableMaxDuration;
+}
+/** Container for video ads sequencing definition. */
+export interface Campaign_VideoCampaignSettings_VideoAdSequence {
+    /** The list of sequence steps and data associated with them. */
+    steps: Campaign_VideoCampaignSettings_VideoAdSequenceStep[];
+    /**
+     * Users are eligible to repeat sequence after this period. Defaults to
+     * WEEK if not specified.
+     */
+    minimumDuration: VideoAdSequenceMinimumDurationEnum_VideoAdSequenceMinimumDuration;
+}
+/** Information about a step within a video sequence. */
+export interface Campaign_VideoCampaignSettings_VideoAdSequenceStep {
+    /** The ID of this sequence step. */
+    videoAdSequenceStepId: number;
+    /**
+     * The ID of the Asset for this step. The asset must be type
+     * YOUTUBE_VIDEO.
+     */
+    assetId: number;
+    /** The ad group type for this step (denoting the video format). */
+    adGroupType: AdGroupTypeEnum_AdGroupType;
+    /**
+     * The ID of the previous step. This field is required for all
+     * steps except the first one. It must point to a step that appears in the
+     * step definition list before this step.
+     */
+    previousStepId: number;
+    /**
+     * Type of interaction *on the previous step* required in order for the
+     * user to advance to this step. As with the previous step ID, it's
+     * required for every step except for the first one.
+     */
+    previousStepInteractionType: VideoAdSequenceInteractionTypeEnum_VideoAdSequenceInteractionType;
+}
+/** Settings for Performance Max campaigns. */
+export interface Campaign_PmaxCampaignSettings {
+    /** Overrides of brand targeting for various ad types. */
+    brandTargetingOverrides?: Campaign_PmaxCampaignSettings_BrandTargetingOverrides | undefined;
+}
+/** Overrides of brand targeting for various ad types. */
+export interface Campaign_PmaxCampaignSettings_BrandTargetingOverrides {
+    /** If true, brand exclusions are ignored for Shopping ads. */
+    ignoreExclusionsForShoppingAds?: boolean | undefined;
+}
+/**
+ * Asset automation setting contains pair of AssetAutomationType and the
+ * asset automation opt-in/out status
+ */
+export interface Campaign_AssetAutomationSetting {
+    /** The asset automation type advertiser would like to opt-in/out. */
+    assetAutomationType?: AssetAutomationTypeEnum_AssetAutomationType | undefined;
+    /** The opt-in/out status of asset automation type. */
+    assetAutomationStatus?: AssetAutomationStatusEnum_AssetAutomationStatus | undefined;
+}
+/**
+ * Settings that control the visual appearance of your brand in a campaign's
+ * automatically generated assets and formats. Only applicable to Performance
+ * Max campaigns.
+ */
+export interface Campaign_BrandGuidelines {
+    /**
+     * The main brand color, entered as a hex code (e.g., #00ff00). You must
+     * provide the main_color if you provide an accent_color.
+     */
+    mainColor: string;
+    /**
+     * The accent brand color, entered as a hex code (e.g., #00ff00). You must
+     * provide the accent_color if you provide a main_color.
+     */
+    accentColor: string;
+    /**
+     * The brand's font family. Must be one of the following Google Fonts (case
+     * sensitive): Open Sans, Roboto, Montserrat, Poppins, Lato, Oswald,
+     * Playfair Display, Roboto Slab.
+     */
+    predefinedFontFamily: string;
+}
+/** Settings for AI Max in search campaigns. */
+export interface Campaign_AiMaxSetting {
+    /**
+     * Controls whether or not AI Max features are serve for this campaign.
+     *
+     * Individual AI Max features are enabled or disabled by their respective
+     * settings. But if enable_ai_max is set to false or cleared, then no AI
+     * Max features will serve for this campaign, regardless of the other
+     * settings.
+     *
+     * Search Term Matching is enabled by default when AI Max is enabled, and
+     * can be disabled at the ad group level.
+     */
+    enableAiMax?: boolean | undefined;
+    /**
+     * Output only. Indicates whether a search campaign has adopted AI Max
+     * before, and is required to have AI Max enabled to adopt campaign-level
+     * text asset automation and brand list targeting in all API versions.
+     */
+    bundlingRequired?: Campaign_AiMaxSetting_AiMaxBundlingRequired | undefined;
+}
+/**
+ * Enum describing whether AI Max must be enabled to serve and update
+ * text asset automation and brand list features newly bundled with AI Max.
+ */
+export declare enum Campaign_AiMaxSetting_AiMaxBundlingRequired {
+    /** UNSPECIFIED - Not specified. */
+    UNSPECIFIED = 0,
+    /** UNKNOWN - Used for return value only. Represents value unknown in this version. */
+    UNKNOWN = 1,
+    /**
+     * NOT_REQUIRED - Search campaign is using text asset automation or brand
+     * list targeting, and AI Max is not required to be enabled to serve these
+     * features.
+     */
+    NOT_REQUIRED = 2,
+    /**
+     * REQUIRED - AI Max is required to be enabled for this search campaign to serve
+     * existing text asset automation and brand list targeting, or to add new
+     * text asset automation and brand list targeting settings.
+     */
+    REQUIRED = 3,
+    UNRECOGNIZED = -1
+}
+export declare function campaign_AiMaxSetting_AiMaxBundlingRequiredFromJSON(object: any): Campaign_AiMaxSetting_AiMaxBundlingRequired;
+export declare function campaign_AiMaxSetting_AiMaxBundlingRequiredToJSON(object: Campaign_AiMaxSetting_AiMaxBundlingRequired): string;
+export declare const Campaign: MessageFns<Campaign>;
+export declare const Campaign_PerformanceMaxUpgrade: MessageFns<Campaign_PerformanceMaxUpgrade>;
+export declare const Campaign_NetworkSettings: MessageFns<Campaign_NetworkSettings>;
+export declare const Campaign_HotelSettingInfo: MessageFns<Campaign_HotelSettingInfo>;
+export declare const Campaign_DynamicSearchAdsSetting: MessageFns<Campaign_DynamicSearchAdsSetting>;
+export declare const Campaign_ShoppingSetting: MessageFns<Campaign_ShoppingSetting>;
+export declare const Campaign_TrackingSetting: MessageFns<Campaign_TrackingSetting>;
+export declare const Campaign_GeoTargetTypeSetting: MessageFns<Campaign_GeoTargetTypeSetting>;
+export declare const Campaign_LocalCampaignSetting: MessageFns<Campaign_LocalCampaignSetting>;
+export declare const Campaign_AppCampaignSetting: MessageFns<Campaign_AppCampaignSetting>;
+export declare const Campaign_VanityPharma: MessageFns<Campaign_VanityPharma>;
+export declare const Campaign_SelectiveOptimization: MessageFns<Campaign_SelectiveOptimization>;
+export declare const Campaign_OptimizationGoalSetting: MessageFns<Campaign_OptimizationGoalSetting>;
+export declare const Campaign_AudienceSetting: MessageFns<Campaign_AudienceSetting>;
+export declare const Campaign_LocalServicesCampaignSettings: MessageFns<Campaign_LocalServicesCampaignSettings>;
+export declare const Campaign_CategoryBid: MessageFns<Campaign_CategoryBid>;
+export declare const Campaign_TravelCampaignSettings: MessageFns<Campaign_TravelCampaignSettings>;
+export declare const Campaign_DemandGenCampaignSettings: MessageFns<Campaign_DemandGenCampaignSettings>;
+export declare const Campaign_VideoCampaignSettings: MessageFns<Campaign_VideoCampaignSettings>;
+export declare const Campaign_VideoCampaignSettings_VideoAdInventoryControl: MessageFns<Campaign_VideoCampaignSettings_VideoAdInventoryControl>;
+export declare const Campaign_VideoCampaignSettings_VideoAdFormatControl: MessageFns<Campaign_VideoCampaignSettings_VideoAdFormatControl>;
+export declare const Campaign_VideoCampaignSettings_NonSkippableInStreamRestrictions: MessageFns<Campaign_VideoCampaignSettings_NonSkippableInStreamRestrictions>;
+export declare const Campaign_VideoCampaignSettings_VideoAdSequence: MessageFns<Campaign_VideoCampaignSettings_VideoAdSequence>;
+export declare const Campaign_VideoCampaignSettings_VideoAdSequenceStep: MessageFns<Campaign_VideoCampaignSettings_VideoAdSequenceStep>;
+export declare const Campaign_PmaxCampaignSettings: MessageFns<Campaign_PmaxCampaignSettings>;
+export declare const Campaign_PmaxCampaignSettings_BrandTargetingOverrides: MessageFns<Campaign_PmaxCampaignSettings_BrandTargetingOverrides>;
+export declare const Campaign_AssetAutomationSetting: MessageFns<Campaign_AssetAutomationSetting>;
+export declare const Campaign_BrandGuidelines: MessageFns<Campaign_BrandGuidelines>;
+export declare const Campaign_AiMaxSetting: MessageFns<Campaign_AiMaxSetting>;
+type Builtin = Date | Function | Uint8Array | string | number | boolean | undefined;
+export type DeepPartial<T> = T extends Builtin ? T : T extends globalThis.Array<infer U> ? globalThis.Array<DeepPartial<U>> : T extends ReadonlyArray<infer U> ? ReadonlyArray<DeepPartial<U>> : T extends {} ? {
+    [K in keyof T]?: DeepPartial<T[K]>;
+} : Partial<T>;
+type KeysOfUnion<T> = T extends T ? keyof T : never;
+export type Exact<P, I extends P> = P extends Builtin ? P : P & {
+    [K in keyof P]: Exact<P[K], I[K]>;
+} & {
+    [K in Exclude<keyof I, KeysOfUnion<P>>]: never;
+};
+export interface MessageFns<T> {
+    encode(message: T, writer?: BinaryWriter): BinaryWriter;
+    decode(input: BinaryReader | Uint8Array, length?: number): T;
+    fromJSON(object: any): T;
+    toJSON(message: T): unknown;
+    create<I extends Exact<DeepPartial<T>, I>>(base?: I): T;
+    fromPartial<I extends Exact<DeepPartial<T>, I>>(object: I): T;
+}
+export {};