campaign.proto 18 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419
  1. // Copyright 2021 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. syntax = "proto3";
  15. package google.ads.googleads.v6.resources;
  16. import "google/ads/googleads/v6/common/bidding.proto";
  17. import "google/ads/googleads/v6/common/custom_parameter.proto";
  18. import "google/ads/googleads/v6/common/frequency_cap.proto";
  19. import "google/ads/googleads/v6/common/real_time_bidding_setting.proto";
  20. import "google/ads/googleads/v6/common/targeting_setting.proto";
  21. import "google/ads/googleads/v6/enums/ad_serving_optimization_status.proto";
  22. import "google/ads/googleads/v6/enums/advertising_channel_sub_type.proto";
  23. import "google/ads/googleads/v6/enums/advertising_channel_type.proto";
  24. import "google/ads/googleads/v6/enums/app_campaign_app_store.proto";
  25. import "google/ads/googleads/v6/enums/app_campaign_bidding_strategy_goal_type.proto";
  26. import "google/ads/googleads/v6/enums/bidding_strategy_type.proto";
  27. import "google/ads/googleads/v6/enums/brand_safety_suitability.proto";
  28. import "google/ads/googleads/v6/enums/campaign_experiment_type.proto";
  29. import "google/ads/googleads/v6/enums/campaign_serving_status.proto";
  30. import "google/ads/googleads/v6/enums/campaign_status.proto";
  31. import "google/ads/googleads/v6/enums/location_source_type.proto";
  32. import "google/ads/googleads/v6/enums/negative_geo_target_type.proto";
  33. import "google/ads/googleads/v6/enums/optimization_goal_type.proto";
  34. import "google/ads/googleads/v6/enums/payment_mode.proto";
  35. import "google/ads/googleads/v6/enums/positive_geo_target_type.proto";
  36. import "google/ads/googleads/v6/enums/vanity_pharma_display_url_mode.proto";
  37. import "google/ads/googleads/v6/enums/vanity_pharma_text.proto";
  38. import "google/api/field_behavior.proto";
  39. import "google/api/resource.proto";
  40. import "google/api/annotations.proto";
  41. option csharp_namespace = "Google.Ads.GoogleAds.V6.Resources";
  42. option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v6/resources;resources";
  43. option java_multiple_files = true;
  44. option java_outer_classname = "CampaignProto";
  45. option java_package = "com.google.ads.googleads.v6.resources";
  46. option objc_class_prefix = "GAA";
  47. option php_namespace = "Google\\Ads\\GoogleAds\\V6\\Resources";
  48. option ruby_package = "Google::Ads::GoogleAds::V6::Resources";
  49. // Proto file describing the Campaign resource.
  50. // A campaign.
  51. message Campaign {
  52. option (google.api.resource) = {
  53. type: "googleads.googleapis.com/Campaign"
  54. pattern: "customers/{customer_id}/campaigns/{campaign_id}"
  55. };
  56. // The network settings for the campaign.
  57. message NetworkSettings {
  58. // Whether ads will be served with google.com search results.
  59. optional bool target_google_search = 5;
  60. // Whether ads will be served on partner sites in the Google Search Network
  61. // (requires `target_google_search` to also be `true`).
  62. optional bool target_search_network = 6;
  63. // Whether ads will be served on specified placements in the Google Display
  64. // Network. Placements are specified using the Placement criterion.
  65. optional bool target_content_network = 7;
  66. // Whether ads will be served on the Google Partner Network.
  67. // This is available only to some select Google partner accounts.
  68. optional bool target_partner_search_network = 8;
  69. }
  70. // Campaign-level settings for hotel ads.
  71. message HotelSettingInfo {
  72. // Immutable. The linked Hotel Center account.
  73. optional int64 hotel_center_id = 2 [(google.api.field_behavior) = IMMUTABLE];
  74. }
  75. // The setting for controlling Dynamic Search Ads (DSA).
  76. message DynamicSearchAdsSetting {
  77. // Required. The Internet domain name that this setting represents, e.g., "google.com"
  78. // or "www.google.com".
  79. string domain_name = 6 [(google.api.field_behavior) = REQUIRED];
  80. // Required. The language code specifying the language of the domain, e.g., "en".
  81. string language_code = 7 [(google.api.field_behavior) = REQUIRED];
  82. // Whether the campaign uses advertiser supplied URLs exclusively.
  83. optional bool use_supplied_urls_only = 8;
  84. // The list of page feeds associated with the campaign.
  85. repeated string feeds = 9 [(google.api.resource_reference) = {
  86. type: "googleads.googleapis.com/Feed"
  87. }];
  88. }
  89. // Campaign setting for local campaigns.
  90. message LocalCampaignSetting {
  91. // The location source type for this local campaign.
  92. google.ads.googleads.v6.enums.LocationSourceTypeEnum.LocationSourceType location_source_type = 1;
  93. }
  94. // Selective optimization setting for this campaign, which includes a set of
  95. // conversion actions to optimize this campaign towards.
  96. message SelectiveOptimization {
  97. // The selected set of conversion actions for optimizing this campaign.
  98. repeated string conversion_actions = 2 [(google.api.resource_reference) = {
  99. type: "googleads.googleapis.com/ConversionAction"
  100. }];
  101. }
  102. // The setting for Shopping campaigns. Defines the universe of products that
  103. // can be advertised by the campaign, and how this campaign interacts with
  104. // other Shopping campaigns.
  105. message ShoppingSetting {
  106. // Immutable. ID of the Merchant Center account.
  107. // This field is required for create operations. This field is immutable for
  108. // Shopping campaigns.
  109. optional int64 merchant_id = 5 [(google.api.field_behavior) = IMMUTABLE];
  110. // Immutable. Sales country of products to include in the campaign.
  111. // This field is required for Shopping campaigns. This field is immutable.
  112. // This field is optional for non-Shopping campaigns, but it must be equal
  113. // to 'ZZ' if set.
  114. optional string sales_country = 6 [(google.api.field_behavior) = IMMUTABLE];
  115. // Priority of the campaign. Campaigns with numerically higher priorities
  116. // take precedence over those with lower priorities.
  117. // This field is required for Shopping campaigns, with values between 0 and
  118. // 2, inclusive.
  119. // This field is optional for Smart Shopping campaigns, but must be equal to
  120. // 3 if set.
  121. optional int32 campaign_priority = 7;
  122. // Whether to include local products.
  123. optional bool enable_local = 8;
  124. }
  125. // Campaign-level settings for App Campaigns.
  126. message AppCampaignSetting {
  127. // Represents the goal which the bidding strategy of this app campaign
  128. // should optimize towards.
  129. google.ads.googleads.v6.enums.AppCampaignBiddingStrategyGoalTypeEnum.AppCampaignBiddingStrategyGoalType bidding_strategy_goal_type = 1;
  130. // Immutable. A string that uniquely identifies a mobile application.
  131. optional string app_id = 4 [(google.api.field_behavior) = IMMUTABLE];
  132. // Immutable. The application store that distributes this specific app.
  133. google.ads.googleads.v6.enums.AppCampaignAppStoreEnum.AppCampaignAppStore app_store = 3 [(google.api.field_behavior) = IMMUTABLE];
  134. }
  135. // Campaign-level settings for tracking information.
  136. message TrackingSetting {
  137. // Output only. The url used for dynamic tracking.
  138. optional string tracking_url = 2 [(google.api.field_behavior) = OUTPUT_ONLY];
  139. }
  140. // Optimization goal setting for this campaign, which includes a set of
  141. // optimization goal types.
  142. message OptimizationGoalSetting {
  143. // The list of optimization goal types.
  144. repeated google.ads.googleads.v6.enums.OptimizationGoalTypeEnum.OptimizationGoalType optimization_goal_types = 1;
  145. }
  146. // Represents a collection of settings related to ads geotargeting.
  147. message GeoTargetTypeSetting {
  148. // The setting used for positive geotargeting in this particular campaign.
  149. google.ads.googleads.v6.enums.PositiveGeoTargetTypeEnum.PositiveGeoTargetType positive_geo_target_type = 1;
  150. // The setting used for negative geotargeting in this particular campaign.
  151. google.ads.googleads.v6.enums.NegativeGeoTargetTypeEnum.NegativeGeoTargetType negative_geo_target_type = 2;
  152. }
  153. // Describes how unbranded pharma ads will be displayed.
  154. message VanityPharma {
  155. // The display mode for vanity pharma URLs.
  156. google.ads.googleads.v6.enums.VanityPharmaDisplayUrlModeEnum.VanityPharmaDisplayUrlMode vanity_pharma_display_url_mode = 1;
  157. // The text that will be displayed in display URL of the text ad when
  158. // website description is the selected display mode for vanity pharma URLs.
  159. google.ads.googleads.v6.enums.VanityPharmaTextEnum.VanityPharmaText vanity_pharma_text = 2;
  160. }
  161. // Immutable. The resource name of the campaign.
  162. // Campaign resource names have the form:
  163. //
  164. // `customers/{customer_id}/campaigns/{campaign_id}`
  165. string resource_name = 1 [
  166. (google.api.field_behavior) = IMMUTABLE,
  167. (google.api.resource_reference) = {
  168. type: "googleads.googleapis.com/Campaign"
  169. }
  170. ];
  171. // Output only. The ID of the campaign.
  172. optional int64 id = 59 [(google.api.field_behavior) = OUTPUT_ONLY];
  173. // The name of the campaign.
  174. //
  175. // This field is required and should not be empty when creating new
  176. // campaigns.
  177. //
  178. // It must not contain any null (code point 0x0), NL line feed
  179. // (code point 0xA) or carriage return (code point 0xD) characters.
  180. optional string name = 58;
  181. // The status of the campaign.
  182. //
  183. // When a new campaign is added, the status defaults to ENABLED.
  184. google.ads.googleads.v6.enums.CampaignStatusEnum.CampaignStatus status = 5;
  185. // Output only. The ad serving status of the campaign.
  186. google.ads.googleads.v6.enums.CampaignServingStatusEnum.CampaignServingStatus serving_status = 21 [(google.api.field_behavior) = OUTPUT_ONLY];
  187. // The ad serving optimization status of the campaign.
  188. google.ads.googleads.v6.enums.AdServingOptimizationStatusEnum.AdServingOptimizationStatus ad_serving_optimization_status = 8;
  189. // Immutable. The primary serving target for ads within the campaign.
  190. // The targeting options can be refined in `network_settings`.
  191. //
  192. // This field is required and should not be empty when creating new
  193. // campaigns.
  194. //
  195. // Can be set only when creating campaigns.
  196. // After the campaign is created, the field can not be changed.
  197. google.ads.googleads.v6.enums.AdvertisingChannelTypeEnum.AdvertisingChannelType advertising_channel_type = 9 [(google.api.field_behavior) = IMMUTABLE];
  198. // Immutable. Optional refinement to `advertising_channel_type`.
  199. // Must be a valid sub-type of the parent channel type.
  200. //
  201. // Can be set only when creating campaigns.
  202. // After campaign is created, the field can not be changed.
  203. google.ads.googleads.v6.enums.AdvertisingChannelSubTypeEnum.AdvertisingChannelSubType advertising_channel_sub_type = 10 [(google.api.field_behavior) = IMMUTABLE];
  204. // The URL template for constructing a tracking URL.
  205. optional string tracking_url_template = 60;
  206. // The list of mappings used to substitute custom parameter tags in a
  207. // `tracking_url_template`, `final_urls`, or `mobile_final_urls`.
  208. repeated google.ads.googleads.v6.common.CustomParameter url_custom_parameters = 12;
  209. // Settings for Real-Time Bidding, a feature only available for campaigns
  210. // targeting the Ad Exchange network.
  211. google.ads.googleads.v6.common.RealTimeBiddingSetting real_time_bidding_setting = 39;
  212. // The network settings for the campaign.
  213. NetworkSettings network_settings = 14;
  214. // Immutable. The hotel setting for the campaign.
  215. HotelSettingInfo hotel_setting = 32 [(google.api.field_behavior) = IMMUTABLE];
  216. // The setting for controlling Dynamic Search Ads (DSA).
  217. DynamicSearchAdsSetting dynamic_search_ads_setting = 33;
  218. // The setting for controlling Shopping campaigns.
  219. ShoppingSetting shopping_setting = 36;
  220. // Setting for targeting related features.
  221. google.ads.googleads.v6.common.TargetingSetting targeting_setting = 43;
  222. // The setting for ads geotargeting.
  223. GeoTargetTypeSetting geo_target_type_setting = 47;
  224. // The setting for local campaign.
  225. LocalCampaignSetting local_campaign_setting = 50;
  226. // The setting related to App Campaign.
  227. AppCampaignSetting app_campaign_setting = 51;
  228. // Output only. The resource names of labels attached to this campaign.
  229. repeated string labels = 61 [
  230. (google.api.field_behavior) = OUTPUT_ONLY,
  231. (google.api.resource_reference) = {
  232. type: "googleads.googleapis.com/CampaignLabel"
  233. }
  234. ];
  235. // Output only. The type of campaign: normal, draft, or experiment.
  236. google.ads.googleads.v6.enums.CampaignExperimentTypeEnum.CampaignExperimentType experiment_type = 17 [(google.api.field_behavior) = OUTPUT_ONLY];
  237. // Output only. The resource name of the base campaign of a draft or experiment campaign.
  238. // For base campaigns, this is equal to `resource_name`.
  239. //
  240. // This field is read-only.
  241. optional string base_campaign = 56 [
  242. (google.api.field_behavior) = OUTPUT_ONLY,
  243. (google.api.resource_reference) = {
  244. type: "googleads.googleapis.com/Campaign"
  245. }
  246. ];
  247. // The budget of the campaign.
  248. optional string campaign_budget = 62 [(google.api.resource_reference) = {
  249. type: "googleads.googleapis.com/CampaignBudget"
  250. }];
  251. // Output only. The type of bidding strategy.
  252. //
  253. // A bidding strategy can be created by setting either the bidding scheme to
  254. // create a standard bidding strategy or the `bidding_strategy` field to
  255. // create a portfolio bidding strategy.
  256. //
  257. // This field is read-only.
  258. google.ads.googleads.v6.enums.BiddingStrategyTypeEnum.BiddingStrategyType bidding_strategy_type = 22 [(google.api.field_behavior) = OUTPUT_ONLY];
  259. // The date when campaign started.
  260. optional string start_date = 63;
  261. // The last day of the campaign.
  262. optional string end_date = 64;
  263. // Suffix used to append query parameters to landing pages that are served
  264. // with parallel tracking.
  265. optional string final_url_suffix = 65;
  266. // A list that limits how often each user will see this campaign's ads.
  267. repeated google.ads.googleads.v6.common.FrequencyCapEntry frequency_caps = 40;
  268. // Output only. 3-Tier Brand Safety setting for the campaign.
  269. google.ads.googleads.v6.enums.BrandSafetySuitabilityEnum.BrandSafetySuitability video_brand_safety_suitability = 42 [(google.api.field_behavior) = OUTPUT_ONLY];
  270. // Describes how unbranded pharma ads will be displayed.
  271. VanityPharma vanity_pharma = 44;
  272. // Selective optimization setting for this campaign, which includes a set of
  273. // conversion actions to optimize this campaign towards.
  274. SelectiveOptimization selective_optimization = 45;
  275. // Optimization goal setting for this campaign, which includes a set of
  276. // optimization goal types.
  277. OptimizationGoalSetting optimization_goal_setting = 54;
  278. // Output only. Campaign-level settings for tracking information.
  279. TrackingSetting tracking_setting = 46 [(google.api.field_behavior) = OUTPUT_ONLY];
  280. // Payment mode for the campaign.
  281. google.ads.googleads.v6.enums.PaymentModeEnum.PaymentMode payment_mode = 52;
  282. // Output only. Optimization score of the campaign.
  283. //
  284. // Optimization score is an estimate of how well a campaign is set to perform.
  285. // It ranges from 0% (0.0) to 100% (1.0), with 100% indicating that the
  286. // campaign is performing at full potential. This field is null for unscored
  287. // campaigns.
  288. //
  289. // See "About optimization score" at
  290. // https://support.google.com/google-ads/answer/9061546.
  291. //
  292. // This field is read-only.
  293. optional double optimization_score = 66 [(google.api.field_behavior) = OUTPUT_ONLY];
  294. // The bidding strategy for the campaign.
  295. //
  296. // Must be either portfolio (created via BiddingStrategy service) or
  297. // standard, that is embedded into the campaign.
  298. oneof campaign_bidding_strategy {
  299. // Portfolio bidding strategy used by campaign.
  300. string bidding_strategy = 67 [(google.api.resource_reference) = {
  301. type: "googleads.googleapis.com/BiddingStrategy"
  302. }];
  303. // Commission is an automatic bidding strategy in which the advertiser pays
  304. // a certain portion of the conversion value.
  305. google.ads.googleads.v6.common.Commission commission = 49;
  306. // Standard Manual CPC bidding strategy.
  307. // Manual click-based bidding where user pays per click.
  308. google.ads.googleads.v6.common.ManualCpc manual_cpc = 24;
  309. // Standard Manual CPM bidding strategy.
  310. // Manual impression-based bidding where user pays per thousand
  311. // impressions.
  312. google.ads.googleads.v6.common.ManualCpm manual_cpm = 25;
  313. // Output only. A bidding strategy that pays a configurable amount per video view.
  314. google.ads.googleads.v6.common.ManualCpv manual_cpv = 37 [(google.api.field_behavior) = OUTPUT_ONLY];
  315. // Standard Maximize Conversions bidding strategy that automatically
  316. // maximizes number of conversions while spending your budget.
  317. google.ads.googleads.v6.common.MaximizeConversions maximize_conversions = 30;
  318. // Standard Maximize Conversion Value bidding strategy that automatically
  319. // sets bids to maximize revenue while spending your budget.
  320. google.ads.googleads.v6.common.MaximizeConversionValue maximize_conversion_value = 31;
  321. // Standard Target CPA bidding strategy that automatically sets bids to
  322. // help get as many conversions as possible at the target
  323. // cost-per-acquisition (CPA) you set.
  324. google.ads.googleads.v6.common.TargetCpa target_cpa = 26;
  325. // Target Impression Share bidding strategy. An automated bidding strategy
  326. // that sets bids to achieve a desired percentage of impressions.
  327. google.ads.googleads.v6.common.TargetImpressionShare target_impression_share = 48;
  328. // Standard Target ROAS bidding strategy that automatically maximizes
  329. // revenue while averaging a specific target return on ad spend (ROAS).
  330. google.ads.googleads.v6.common.TargetRoas target_roas = 29;
  331. // Standard Target Spend bidding strategy that automatically sets your bids
  332. // to help get as many clicks as possible within your budget.
  333. google.ads.googleads.v6.common.TargetSpend target_spend = 27;
  334. // Standard Percent Cpc bidding strategy where bids are a fraction of the
  335. // advertised price for some good or service.
  336. google.ads.googleads.v6.common.PercentCpc percent_cpc = 34;
  337. // A bidding strategy that automatically optimizes cost per thousand
  338. // impressions.
  339. google.ads.googleads.v6.common.TargetCpm target_cpm = 41;
  340. }
  341. }