• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1// Copyright 2023 Google LLC
2//
3// Licensed under the Apache License, Version 2.0 (the "License");
4// you may not use this file except in compliance with the License.
5// You may obtain a copy of the License at
6//
7//     http://www.apache.org/licenses/LICENSE-2.0
8//
9// Unless required by applicable law or agreed to in writing, software
10// distributed under the License is distributed on an "AS IS" BASIS,
11// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12// See the License for the specific language governing permissions and
13// limitations under the License.
14
15syntax = "proto3";
16
17package google.ads.googleads.v16.resources;
18
19import "google/ads/googleads/v16/common/bidding.proto";
20import "google/ads/googleads/v16/common/custom_parameter.proto";
21import "google/ads/googleads/v16/common/frequency_cap.proto";
22import "google/ads/googleads/v16/common/real_time_bidding_setting.proto";
23import "google/ads/googleads/v16/common/targeting_setting.proto";
24import "google/ads/googleads/v16/enums/ad_serving_optimization_status.proto";
25import "google/ads/googleads/v16/enums/advertising_channel_sub_type.proto";
26import "google/ads/googleads/v16/enums/advertising_channel_type.proto";
27import "google/ads/googleads/v16/enums/app_campaign_app_store.proto";
28import "google/ads/googleads/v16/enums/app_campaign_bidding_strategy_goal_type.proto";
29import "google/ads/googleads/v16/enums/asset_automation_status.proto";
30import "google/ads/googleads/v16/enums/asset_automation_type.proto";
31import "google/ads/googleads/v16/enums/asset_field_type.proto";
32import "google/ads/googleads/v16/enums/asset_set_type.proto";
33import "google/ads/googleads/v16/enums/bidding_strategy_system_status.proto";
34import "google/ads/googleads/v16/enums/bidding_strategy_type.proto";
35import "google/ads/googleads/v16/enums/brand_safety_suitability.proto";
36import "google/ads/googleads/v16/enums/campaign_experiment_type.proto";
37import "google/ads/googleads/v16/enums/campaign_primary_status.proto";
38import "google/ads/googleads/v16/enums/campaign_primary_status_reason.proto";
39import "google/ads/googleads/v16/enums/campaign_serving_status.proto";
40import "google/ads/googleads/v16/enums/campaign_status.proto";
41import "google/ads/googleads/v16/enums/listing_type.proto";
42import "google/ads/googleads/v16/enums/location_source_type.proto";
43import "google/ads/googleads/v16/enums/negative_geo_target_type.proto";
44import "google/ads/googleads/v16/enums/optimization_goal_type.proto";
45import "google/ads/googleads/v16/enums/payment_mode.proto";
46import "google/ads/googleads/v16/enums/performance_max_upgrade_status.proto";
47import "google/ads/googleads/v16/enums/positive_geo_target_type.proto";
48import "google/ads/googleads/v16/enums/vanity_pharma_display_url_mode.proto";
49import "google/ads/googleads/v16/enums/vanity_pharma_text.proto";
50import "google/api/field_behavior.proto";
51import "google/api/resource.proto";
52
53option csharp_namespace = "Google.Ads.GoogleAds.V16.Resources";
54option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v16/resources;resources";
55option java_multiple_files = true;
56option java_outer_classname = "CampaignProto";
57option java_package = "com.google.ads.googleads.v16.resources";
58option objc_class_prefix = "GAA";
59option php_namespace = "Google\\Ads\\GoogleAds\\V16\\Resources";
60option ruby_package = "Google::Ads::GoogleAds::V16::Resources";
61
62// Proto file describing the Campaign resource.
63
64// A campaign.
65message Campaign {
66  option (google.api.resource) = {
67    type: "googleads.googleapis.com/Campaign"
68    pattern: "customers/{customer_id}/campaigns/{campaign_id}"
69  };
70
71  // Information about a campaign being upgraded to Performance Max.
72  message PerformanceMaxUpgrade {
73    // Output only. Indicates which Performance Max campaign the campaign is
74    // upgraded to.
75    string performance_max_campaign = 1 [
76      (google.api.field_behavior) = OUTPUT_ONLY,
77      (google.api.resource_reference) = {
78        type: "googleads.googleapis.com/Campaign"
79      }
80    ];
81
82    // Output only. Indicates legacy campaign upgraded to Performance Max.
83    string pre_upgrade_campaign = 2 [
84      (google.api.field_behavior) = OUTPUT_ONLY,
85      (google.api.resource_reference) = {
86        type: "googleads.googleapis.com/Campaign"
87      }
88    ];
89
90    // Output only. The upgrade status of a campaign requested to be upgraded to
91    // Performance Max.
92    google.ads.googleads.v16.enums.PerformanceMaxUpgradeStatusEnum
93        .PerformanceMaxUpgradeStatus status = 3
94        [(google.api.field_behavior) = OUTPUT_ONLY];
95  }
96
97  // The network settings for the campaign.
98  message NetworkSettings {
99    // Whether ads will be served with google.com search results.
100    optional bool target_google_search = 5;
101
102    // Whether ads will be served on partner sites in the Google Search Network
103    // (requires `target_google_search` to also be `true`).
104    optional bool target_search_network = 6;
105
106    // Whether ads will be served on specified placements in the Google Display
107    // Network. Placements are specified using the Placement criterion.
108    optional bool target_content_network = 7;
109
110    // Whether ads will be served on the Google Partner Network.
111    // This is available only to some select Google partner accounts.
112    optional bool target_partner_search_network = 8;
113
114    // Whether ads will be served on YouTube.
115    optional bool target_youtube = 9;
116
117    // Whether ads will be served on the Google TV network.
118    optional bool target_google_tv_network = 10;
119  }
120
121  // Campaign-level settings for hotel ads.
122  message HotelSettingInfo {
123    // Immutable. The linked Hotel Center account.
124    optional int64 hotel_center_id = 2
125        [(google.api.field_behavior) = IMMUTABLE];
126  }
127
128  // The setting for controlling Dynamic Search Ads (DSA).
129  message DynamicSearchAdsSetting {
130    // Required. The Internet domain name that this setting represents, for
131    // example, "google.com" or "www.google.com".
132    string domain_name = 6 [(google.api.field_behavior) = REQUIRED];
133
134    // Required. The language code specifying the language of the domain, for
135    // example, "en".
136    string language_code = 7 [(google.api.field_behavior) = REQUIRED];
137
138    // Whether the campaign uses advertiser supplied URLs exclusively.
139    optional bool use_supplied_urls_only = 8;
140
141    // The list of page feeds associated with the campaign.
142    repeated string feeds = 9 [(google.api.resource_reference) = {
143      type: "googleads.googleapis.com/Feed"
144    }];
145  }
146
147  // The setting for Shopping campaigns. Defines the universe of products that
148  // can be advertised by the campaign, and how this campaign interacts with
149  // other Shopping campaigns.
150  message ShoppingSetting {
151    // ID of the Merchant Center account.
152    // This field is required for create operations. This field is immutable for
153    // Shopping campaigns.
154    optional int64 merchant_id = 5;
155
156    // Feed label of products to include in the campaign.
157    // Only one of feed_label or sales_country can be set.
158    // If used instead of sales_country, the feed_label field accepts country
159    // codes in the same format for example: 'XX'.
160    // Otherwise can be any string used for feed label in Google Merchant
161    // Center.
162    string feed_label = 10;
163
164    // Priority of the campaign. Campaigns with numerically higher priorities
165    // take precedence over those with lower priorities.
166    // This field is required for Shopping campaigns, with values between 0 and
167    // 2, inclusive.
168    // This field is optional for Smart Shopping campaigns, but must be equal to
169    // 3 if set.
170    optional int32 campaign_priority = 7;
171
172    // Whether to include local products.
173    optional bool enable_local = 8;
174
175    // Immutable. Whether to target Vehicle Listing inventory. This field is
176    // supported only in Smart Shopping Campaigns. For setting Vehicle Listing
177    // inventory in Performance Max campaigns, use `listing_type` instead.
178    bool use_vehicle_inventory = 9 [(google.api.field_behavior) = IMMUTABLE];
179
180    // Immutable. The ads account IDs of advertising partners cooperating within
181    // the campaign.
182    repeated int64 advertising_partner_ids = 11
183        [(google.api.field_behavior) = IMMUTABLE];
184
185    // Disable the optional product feed. This field is currently supported
186    // only for Demand Gen campaigns. See
187    // https://support.google.com/google-ads/answer/13721750 to learn more about
188    // this feature.
189    optional bool disable_product_feed = 12;
190  }
191
192  // Campaign-level settings for tracking information.
193  message TrackingSetting {
194    // Output only. The url used for dynamic tracking.
195    optional string tracking_url = 2
196        [(google.api.field_behavior) = OUTPUT_ONLY];
197  }
198
199  // Represents a collection of settings related to ads geotargeting.
200  message GeoTargetTypeSetting {
201    // The setting used for positive geotargeting in this particular campaign.
202    google.ads.googleads.v16.enums.PositiveGeoTargetTypeEnum
203        .PositiveGeoTargetType positive_geo_target_type = 1;
204
205    // The setting used for negative geotargeting in this particular campaign.
206    google.ads.googleads.v16.enums.NegativeGeoTargetTypeEnum
207        .NegativeGeoTargetType negative_geo_target_type = 2;
208  }
209
210  // Campaign setting for local campaigns.
211  message LocalCampaignSetting {
212    // The location source type for this local campaign.
213    google.ads.googleads.v16.enums.LocationSourceTypeEnum.LocationSourceType
214        location_source_type = 1;
215  }
216
217  // Campaign-level settings for App Campaigns.
218  message AppCampaignSetting {
219    // Represents the goal which the bidding strategy of this app campaign
220    // should optimize towards.
221    google.ads.googleads.v16.enums.AppCampaignBiddingStrategyGoalTypeEnum
222        .AppCampaignBiddingStrategyGoalType bidding_strategy_goal_type = 1;
223
224    // Immutable. A string that uniquely identifies a mobile application.
225    optional string app_id = 4 [(google.api.field_behavior) = IMMUTABLE];
226
227    // Immutable. The application store that distributes this specific app.
228    google.ads.googleads.v16.enums.AppCampaignAppStoreEnum.AppCampaignAppStore
229        app_store = 3 [(google.api.field_behavior) = IMMUTABLE];
230  }
231
232  // Describes how unbranded pharma ads will be displayed.
233  message VanityPharma {
234    // The display mode for vanity pharma URLs.
235    google.ads.googleads.v16.enums.VanityPharmaDisplayUrlModeEnum
236        .VanityPharmaDisplayUrlMode vanity_pharma_display_url_mode = 1;
237
238    // The text that will be displayed in display URL of the text ad when
239    // website description is the selected display mode for vanity pharma URLs.
240    google.ads.googleads.v16.enums.VanityPharmaTextEnum.VanityPharmaText
241        vanity_pharma_text = 2;
242  }
243
244  // Selective optimization setting for this campaign, which includes a set of
245  // conversion actions to optimize this campaign towards.
246  // This feature only applies to app campaigns that use MULTI_CHANNEL as
247  // AdvertisingChannelType and APP_CAMPAIGN or APP_CAMPAIGN_FOR_ENGAGEMENT as
248  // AdvertisingChannelSubType.
249  message SelectiveOptimization {
250    // The selected set of conversion actions for optimizing this campaign.
251    repeated string conversion_actions = 2 [(google.api.resource_reference) = {
252      type: "googleads.googleapis.com/ConversionAction"
253    }];
254  }
255
256  // Optimization goal setting for this campaign, which includes a set of
257  // optimization goal types.
258  message OptimizationGoalSetting {
259    // The list of optimization goal types.
260    repeated google.ads.googleads.v16.enums.OptimizationGoalTypeEnum
261        .OptimizationGoalType optimization_goal_types = 1;
262  }
263
264  // Settings for the audience targeting.
265  message AudienceSetting {
266    // Immutable. If true, this campaign uses an Audience resource for audience
267    // targeting. If false, this campaign may use audience segment criteria
268    // instead.
269    optional bool use_audience_grouped = 1
270        [(google.api.field_behavior) = IMMUTABLE];
271  }
272
273  // Settings for LocalServicesCampaign subresource.
274  message LocalServicesCampaignSettings {
275    // Categorical level bids associated with MANUAL_CPA bidding strategy.
276    repeated CategoryBid category_bids = 1;
277  }
278
279  // Category bids in LocalServicesReportingCampaignSettings.
280  message CategoryBid {
281    // Category for which the bid will be associated with. For example,
282    // xcat:service_area_business_plumber.
283    optional string category_id = 1;
284
285    // Manual CPA bid for the category. Bid must be greater than the
286    // reserve price associated for that category. Value is in micros
287    // and in the advertiser's currency.
288    optional int64 manual_cpa_bid_micros = 2;
289  }
290
291  // Settings for Travel campaign.
292  message TravelCampaignSettings {
293    // Immutable. The Travel account ID associated with the Travel campaign.
294    optional int64 travel_account_id = 1
295        [(google.api.field_behavior) = IMMUTABLE];
296  }
297
298  // Settings for Discovery campaign.
299  message DiscoveryCampaignSettings {
300    // Immutable. Specifies whether this campaign uses upgraded targeting
301    // options. When this field is set to `true`, you can use location and
302    // language targeting at the ad group level as opposed to the standard
303    // campaign-level targeting. This field defaults to `false`, and can only be
304    // set when creating a campaign.
305    optional bool upgraded_targeting = 1
306        [(google.api.field_behavior) = IMMUTABLE];
307  }
308
309  // Asset automation setting contains pair of AssetAutomationType and the
310  // asset automation opt-in/out status
311  message AssetAutomationSetting {
312    // The asset automation type advertiser would like to opt-in/out.
313    optional google.ads.googleads.v16.enums.AssetAutomationTypeEnum
314        .AssetAutomationType asset_automation_type = 1;
315
316    // The opt-in/out status of asset automation type.
317    optional google.ads.googleads.v16.enums.AssetAutomationStatusEnum
318        .AssetAutomationStatus asset_automation_status = 2;
319  }
320
321  // Immutable. The resource name of the campaign.
322  // Campaign resource names have the form:
323  //
324  // `customers/{customer_id}/campaigns/{campaign_id}`
325  string resource_name = 1 [
326    (google.api.field_behavior) = IMMUTABLE,
327    (google.api.resource_reference) = {
328      type: "googleads.googleapis.com/Campaign"
329    }
330  ];
331
332  // Output only. The ID of the campaign.
333  optional int64 id = 59 [(google.api.field_behavior) = OUTPUT_ONLY];
334
335  // The name of the campaign.
336  //
337  // This field is required and should not be empty when creating new
338  // campaigns.
339  //
340  // It must not contain any null (code point 0x0), NL line feed
341  // (code point 0xA) or carriage return (code point 0xD) characters.
342  optional string name = 58;
343
344  // Output only. The primary status of the campaign.
345  //
346  // Provides insight into why a campaign is not serving or not serving
347  // optimally. Modification to the campaign and its related entities might take
348  // a while to be reflected in this status.
349  google.ads.googleads.v16.enums.CampaignPrimaryStatusEnum.CampaignPrimaryStatus
350      primary_status = 81 [(google.api.field_behavior) = OUTPUT_ONLY];
351
352  // Output only. The primary status reasons of the campaign.
353  //
354  // Provides insight into why a campaign is not serving or not serving
355  // optimally. These reasons are aggregated to determine an overall
356  // CampaignPrimaryStatus.
357  repeated google.ads.googleads.v16.enums.CampaignPrimaryStatusReasonEnum
358      .CampaignPrimaryStatusReason primary_status_reasons = 82
359      [(google.api.field_behavior) = OUTPUT_ONLY];
360
361  // The status of the campaign.
362  //
363  // When a new campaign is added, the status defaults to ENABLED.
364  google.ads.googleads.v16.enums.CampaignStatusEnum.CampaignStatus status = 5;
365
366  // Output only. The ad serving status of the campaign.
367  google.ads.googleads.v16.enums.CampaignServingStatusEnum.CampaignServingStatus
368      serving_status = 21 [(google.api.field_behavior) = OUTPUT_ONLY];
369
370  // Output only. The system status of the campaign's bidding strategy.
371  google.ads.googleads.v16.enums.BiddingStrategySystemStatusEnum
372      .BiddingStrategySystemStatus bidding_strategy_system_status = 78
373      [(google.api.field_behavior) = OUTPUT_ONLY];
374
375  // The ad serving optimization status of the campaign.
376  google.ads.googleads.v16.enums.AdServingOptimizationStatusEnum
377      .AdServingOptimizationStatus ad_serving_optimization_status = 8;
378
379  // Immutable. The primary serving target for ads within the campaign.
380  // The targeting options can be refined in `network_settings`.
381  //
382  // This field is required and should not be empty when creating new
383  // campaigns.
384  //
385  // Can be set only when creating campaigns.
386  // After the campaign is created, the field can not be changed.
387  google.ads.googleads.v16.enums.AdvertisingChannelTypeEnum
388      .AdvertisingChannelType advertising_channel_type = 9
389      [(google.api.field_behavior) = IMMUTABLE];
390
391  // Immutable. Optional refinement to `advertising_channel_type`.
392  // Must be a valid sub-type of the parent channel type.
393  //
394  // Can be set only when creating campaigns.
395  // After campaign is created, the field can not be changed.
396  google.ads.googleads.v16.enums.AdvertisingChannelSubTypeEnum
397      .AdvertisingChannelSubType advertising_channel_sub_type = 10
398      [(google.api.field_behavior) = IMMUTABLE];
399
400  // The URL template for constructing a tracking URL.
401  optional string tracking_url_template = 60;
402
403  // The list of mappings used to substitute custom parameter tags in a
404  // `tracking_url_template`, `final_urls`, or `mobile_final_urls`.
405  repeated google.ads.googleads.v16.common.CustomParameter
406      url_custom_parameters = 12;
407
408  // The Local Services Campaign related settings.
409  LocalServicesCampaignSettings local_services_campaign_settings = 75;
410
411  // Settings for Travel campaign.
412  TravelCampaignSettings travel_campaign_settings = 85;
413
414  // Settings for Discovery campaign.
415  DiscoveryCampaignSettings discovery_campaign_settings = 87;
416
417  // Settings for Real-Time Bidding, a feature only available for campaigns
418  // targeting the Ad Exchange network.
419  google.ads.googleads.v16.common.RealTimeBiddingSetting
420      real_time_bidding_setting = 39;
421
422  // The network settings for the campaign.
423  NetworkSettings network_settings = 14;
424
425  // Immutable. The hotel setting for the campaign.
426  HotelSettingInfo hotel_setting = 32 [(google.api.field_behavior) = IMMUTABLE];
427
428  // The setting for controlling Dynamic Search Ads (DSA).
429  DynamicSearchAdsSetting dynamic_search_ads_setting = 33;
430
431  // The setting for controlling Shopping campaigns.
432  ShoppingSetting shopping_setting = 36;
433
434  // Setting for targeting related features.
435  google.ads.googleads.v16.common.TargetingSetting targeting_setting = 43;
436
437  // Immutable. Setting for audience related features.
438  optional AudienceSetting audience_setting = 73
439      [(google.api.field_behavior) = IMMUTABLE];
440
441  // The setting for ads geotargeting.
442  GeoTargetTypeSetting geo_target_type_setting = 47;
443
444  // The setting for local campaign.
445  LocalCampaignSetting local_campaign_setting = 50;
446
447  // The setting related to App Campaign.
448  AppCampaignSetting app_campaign_setting = 51;
449
450  // Output only. The resource names of labels attached to this campaign.
451  repeated string labels = 61 [
452    (google.api.field_behavior) = OUTPUT_ONLY,
453    (google.api.resource_reference) = {
454      type: "googleads.googleapis.com/CampaignLabel"
455    }
456  ];
457
458  // Output only. The type of campaign: normal, draft, or experiment.
459  google.ads.googleads.v16.enums.CampaignExperimentTypeEnum
460      .CampaignExperimentType experiment_type = 17
461      [(google.api.field_behavior) = OUTPUT_ONLY];
462
463  // Output only. The resource name of the base campaign of a draft or
464  // experiment campaign. For base campaigns, this is equal to `resource_name`.
465  //
466  // This field is read-only.
467  optional string base_campaign = 56 [
468    (google.api.field_behavior) = OUTPUT_ONLY,
469    (google.api.resource_reference) = {
470      type: "googleads.googleapis.com/Campaign"
471    }
472  ];
473
474  // The budget of the campaign.
475  optional string campaign_budget = 62 [(google.api.resource_reference) = {
476    type: "googleads.googleapis.com/CampaignBudget"
477  }];
478
479  // Output only. The type of bidding strategy.
480  //
481  // A bidding strategy can be created by setting either the bidding scheme to
482  // create a standard bidding strategy or the `bidding_strategy` field to
483  // create a portfolio bidding strategy.
484  //
485  // This field is read-only.
486  google.ads.googleads.v16.enums.BiddingStrategyTypeEnum.BiddingStrategyType
487      bidding_strategy_type = 22 [(google.api.field_behavior) = OUTPUT_ONLY];
488
489  // Output only. Resource name of AccessibleBiddingStrategy, a read-only view
490  // of the unrestricted attributes of the attached portfolio bidding strategy
491  // identified by 'bidding_strategy'. Empty, if the campaign does not use a
492  // portfolio strategy. Unrestricted strategy attributes are available to all
493  // customers with whom the strategy is shared and are read from the
494  // AccessibleBiddingStrategy resource. In contrast, restricted attributes are
495  // only available to the owner customer of the strategy and their managers.
496  // Restricted attributes can only be read from the BiddingStrategy resource.
497  string accessible_bidding_strategy = 71 [
498    (google.api.field_behavior) = OUTPUT_ONLY,
499    (google.api.resource_reference) = {
500      type: "googleads.googleapis.com/AccessibleBiddingStrategy"
501    }
502  ];
503
504  // The date when campaign started in serving customer's timezone in YYYY-MM-DD
505  // format.
506  optional string start_date = 63;
507
508  // The campaign group this campaign belongs to.
509  optional string campaign_group = 76 [(google.api.resource_reference) = {
510    type: "googleads.googleapis.com/CampaignGroup"
511  }];
512
513  // The last day of the campaign in serving customer's timezone in YYYY-MM-DD
514  // format. On create, defaults to 2037-12-30, which means the campaign will
515  // run indefinitely. To set an existing campaign to run indefinitely, set this
516  // field to 2037-12-30.
517  optional string end_date = 64;
518
519  // Suffix used to append query parameters to landing pages that are served
520  // with parallel tracking.
521  optional string final_url_suffix = 65;
522
523  // A list that limits how often each user will see this campaign's ads.
524  repeated google.ads.googleads.v16.common.FrequencyCapEntry frequency_caps =
525      40;
526
527  // Output only. Brand Safety setting at the individual campaign level. Allows
528  // for selecting an inventory type to show your ads on content that is the
529  // right fit for your brand. See
530  // https://support.google.com/google-ads/answer/7515513.
531  google.ads.googleads.v16.enums.BrandSafetySuitabilityEnum
532      .BrandSafetySuitability video_brand_safety_suitability = 42
533      [(google.api.field_behavior) = OUTPUT_ONLY];
534
535  // Describes how unbranded pharma ads will be displayed.
536  VanityPharma vanity_pharma = 44;
537
538  // Selective optimization setting for this campaign, which includes a set of
539  // conversion actions to optimize this campaign towards.
540  // This feature only applies to app campaigns that use MULTI_CHANNEL as
541  // AdvertisingChannelType and APP_CAMPAIGN or APP_CAMPAIGN_FOR_ENGAGEMENT as
542  // AdvertisingChannelSubType.
543  SelectiveOptimization selective_optimization = 45;
544
545  // Optimization goal setting for this campaign, which includes a set of
546  // optimization goal types.
547  OptimizationGoalSetting optimization_goal_setting = 54;
548
549  // Output only. Campaign-level settings for tracking information.
550  TrackingSetting tracking_setting = 46
551      [(google.api.field_behavior) = OUTPUT_ONLY];
552
553  // Payment mode for the campaign.
554  google.ads.googleads.v16.enums.PaymentModeEnum.PaymentMode payment_mode = 52;
555
556  // Output only. Optimization score of the campaign.
557  //
558  // Optimization score is an estimate of how well a campaign is set to perform.
559  // It ranges from 0% (0.0) to 100% (1.0), with 100% indicating that the
560  // campaign is performing at full potential. This field is null for unscored
561  // campaigns.
562  //
563  // See "About optimization score" at
564  // https://support.google.com/google-ads/answer/9061546.
565  //
566  // This field is read-only.
567  optional double optimization_score = 66
568      [(google.api.field_behavior) = OUTPUT_ONLY];
569
570  // The asset field types that should be excluded from this campaign. Asset
571  // links with these field types will not be inherited by this campaign from
572  // the upper level.
573  repeated google.ads.googleads.v16.enums.AssetFieldTypeEnum.AssetFieldType
574      excluded_parent_asset_field_types = 69;
575
576  // The asset set types that should be excluded from this campaign. Asset set
577  // links with these types will not be inherited by this campaign from
578  // the upper level.
579  // Location group types (GMB_DYNAMIC_LOCATION_GROUP,
580  // CHAIN_DYNAMIC_LOCATION_GROUP, and STATIC_LOCATION_GROUP) are child types of
581  // LOCATION_SYNC. Therefore, if LOCATION_SYNC is set for this field, all
582  // location group asset sets are not allowed to be linked to this campaign,
583  // and all Location Extension (LE) and Affiliate Location Extensions (ALE)
584  // will not be served under this campaign.
585  // Only LOCATION_SYNC is currently supported.
586  repeated google.ads.googleads.v16.enums.AssetSetTypeEnum.AssetSetType
587      excluded_parent_asset_set_types = 80;
588
589  // Represents opting out of URL expansion to more targeted URLs. If opted out
590  // (true), only the final URLs in the asset group or URLs specified in the
591  // advertiser's Google Merchant Center or business data feeds are targeted.
592  // If opted in (false), the entire domain will be targeted. This field can
593  // only be set for Performance Max campaigns, where the default value is
594  // false.
595  optional bool url_expansion_opt_out = 72;
596
597  // Output only. Information about campaigns being upgraded to Performance Max.
598  PerformanceMaxUpgrade performance_max_upgrade = 77
599      [(google.api.field_behavior) = OUTPUT_ONLY];
600
601  // Immutable. The set of hotel properties for Performance Max for travel goals
602  // campaigns.
603  optional string hotel_property_asset_set = 83 [
604    (google.api.field_behavior) = IMMUTABLE,
605    (google.api.resource_reference) = {
606      type: "googleads.googleapis.com/AssetSet"
607    }
608  ];
609
610  // Immutable. Listing type of ads served for this campaign.
611  // Field is restricted for usage with Performance Max campaigns.
612  optional google.ads.googleads.v16.enums.ListingTypeEnum.ListingType
613      listing_type = 86 [(google.api.field_behavior) = IMMUTABLE];
614
615  // Contains the opt-in/out status of each AssetAutomationType.
616  // See documentation of each asset automation type enum for default
617  // opt in/out behavior.
618  repeated AssetAutomationSetting asset_automation_settings = 88;
619
620  // The bidding strategy for the campaign.
621  //
622  // Must be either portfolio (created through BiddingStrategy service) or
623  // standard, that is embedded into the campaign.
624  oneof campaign_bidding_strategy {
625    // Portfolio bidding strategy used by campaign.
626    string bidding_strategy = 67 [(google.api.resource_reference) = {
627      type: "googleads.googleapis.com/BiddingStrategy"
628    }];
629
630    // Commission is an automatic bidding strategy in which the advertiser pays
631    // a certain portion of the conversion value.
632    google.ads.googleads.v16.common.Commission commission = 49;
633
634    // Standard Manual CPA bidding strategy.
635    // Manual bidding strategy that allows advertiser to set the bid per
636    // advertiser-specified action. Supported only for Local Services campaigns.
637    google.ads.googleads.v16.common.ManualCpa manual_cpa = 74;
638
639    // Standard Manual CPC bidding strategy.
640    // Manual click-based bidding where user pays per click.
641    google.ads.googleads.v16.common.ManualCpc manual_cpc = 24;
642
643    // Standard Manual CPM bidding strategy.
644    // Manual impression-based bidding where user pays per thousand
645    // impressions.
646    google.ads.googleads.v16.common.ManualCpm manual_cpm = 25;
647
648    // A bidding strategy that pays a configurable amount per video view.
649    google.ads.googleads.v16.common.ManualCpv manual_cpv = 37;
650
651    // Standard Maximize Conversions bidding strategy that automatically
652    // maximizes number of conversions while spending your budget.
653    google.ads.googleads.v16.common.MaximizeConversions maximize_conversions =
654        30;
655
656    // Standard Maximize Conversion Value bidding strategy that automatically
657    // sets bids to maximize revenue while spending your budget.
658    google.ads.googleads.v16.common.MaximizeConversionValue
659        maximize_conversion_value = 31;
660
661    // Standard Target CPA bidding strategy that automatically sets bids to
662    // help get as many conversions as possible at the target
663    // cost-per-acquisition (CPA) you set.
664    google.ads.googleads.v16.common.TargetCpa target_cpa = 26;
665
666    // Target Impression Share bidding strategy. An automated bidding strategy
667    // that sets bids to achieve a chosen percentage of impressions.
668    google.ads.googleads.v16.common.TargetImpressionShare
669        target_impression_share = 48;
670
671    // Standard Target ROAS bidding strategy that automatically maximizes
672    // revenue while averaging a specific target return on ad spend (ROAS).
673    google.ads.googleads.v16.common.TargetRoas target_roas = 29;
674
675    // Standard Target Spend bidding strategy that automatically sets your bids
676    // to help get as many clicks as possible within your budget.
677    google.ads.googleads.v16.common.TargetSpend target_spend = 27;
678
679    // Standard Percent Cpc bidding strategy where bids are a fraction of the
680    // advertised price for some good or service.
681    google.ads.googleads.v16.common.PercentCpc percent_cpc = 34;
682
683    // A bidding strategy that automatically optimizes cost per thousand
684    // impressions.
685    google.ads.googleads.v16.common.TargetCpm target_cpm = 41;
686  }
687}
688