google_ads_service.proto 65 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482
  1. // Copyright 2022 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.v10.services;
  16. import "google/ads/googleads/v10/common/metrics.proto";
  17. import "google/ads/googleads/v10/common/segments.proto";
  18. import "google/ads/googleads/v10/enums/response_content_type.proto";
  19. import "google/ads/googleads/v10/enums/summary_row_setting.proto";
  20. import "google/ads/googleads/v10/resources/accessible_bidding_strategy.proto";
  21. import "google/ads/googleads/v10/resources/account_budget.proto";
  22. import "google/ads/googleads/v10/resources/account_budget_proposal.proto";
  23. import "google/ads/googleads/v10/resources/account_link.proto";
  24. import "google/ads/googleads/v10/resources/ad_group.proto";
  25. import "google/ads/googleads/v10/resources/ad_group_ad.proto";
  26. import "google/ads/googleads/v10/resources/ad_group_ad_asset_combination_view.proto";
  27. import "google/ads/googleads/v10/resources/ad_group_ad_asset_view.proto";
  28. import "google/ads/googleads/v10/resources/ad_group_ad_label.proto";
  29. import "google/ads/googleads/v10/resources/ad_group_asset.proto";
  30. import "google/ads/googleads/v10/resources/ad_group_audience_view.proto";
  31. import "google/ads/googleads/v10/resources/ad_group_bid_modifier.proto";
  32. import "google/ads/googleads/v10/resources/ad_group_criterion.proto";
  33. import "google/ads/googleads/v10/resources/ad_group_criterion_customizer.proto";
  34. import "google/ads/googleads/v10/resources/ad_group_criterion_label.proto";
  35. import "google/ads/googleads/v10/resources/ad_group_criterion_simulation.proto";
  36. import "google/ads/googleads/v10/resources/ad_group_customizer.proto";
  37. import "google/ads/googleads/v10/resources/ad_group_extension_setting.proto";
  38. import "google/ads/googleads/v10/resources/ad_group_feed.proto";
  39. import "google/ads/googleads/v10/resources/ad_group_label.proto";
  40. import "google/ads/googleads/v10/resources/ad_group_simulation.proto";
  41. import "google/ads/googleads/v10/resources/ad_parameter.proto";
  42. import "google/ads/googleads/v10/resources/ad_schedule_view.proto";
  43. import "google/ads/googleads/v10/resources/age_range_view.proto";
  44. import "google/ads/googleads/v10/resources/asset.proto";
  45. import "google/ads/googleads/v10/resources/asset_field_type_view.proto";
  46. import "google/ads/googleads/v10/resources/asset_group.proto";
  47. import "google/ads/googleads/v10/resources/asset_group_asset.proto";
  48. import "google/ads/googleads/v10/resources/asset_group_listing_group_filter.proto";
  49. import "google/ads/googleads/v10/resources/asset_group_product_group_view.proto";
  50. import "google/ads/googleads/v10/resources/asset_group_signal.proto";
  51. import "google/ads/googleads/v10/resources/asset_set.proto";
  52. import "google/ads/googleads/v10/resources/asset_set_asset.proto";
  53. import "google/ads/googleads/v10/resources/audience.proto";
  54. import "google/ads/googleads/v10/resources/batch_job.proto";
  55. import "google/ads/googleads/v10/resources/bidding_data_exclusion.proto";
  56. import "google/ads/googleads/v10/resources/bidding_seasonality_adjustment.proto";
  57. import "google/ads/googleads/v10/resources/bidding_strategy.proto";
  58. import "google/ads/googleads/v10/resources/bidding_strategy_simulation.proto";
  59. import "google/ads/googleads/v10/resources/billing_setup.proto";
  60. import "google/ads/googleads/v10/resources/call_view.proto";
  61. import "google/ads/googleads/v10/resources/campaign.proto";
  62. import "google/ads/googleads/v10/resources/campaign_asset.proto";
  63. import "google/ads/googleads/v10/resources/campaign_asset_set.proto";
  64. import "google/ads/googleads/v10/resources/campaign_audience_view.proto";
  65. import "google/ads/googleads/v10/resources/campaign_bid_modifier.proto";
  66. import "google/ads/googleads/v10/resources/campaign_budget.proto";
  67. import "google/ads/googleads/v10/resources/campaign_conversion_goal.proto";
  68. import "google/ads/googleads/v10/resources/campaign_criterion.proto";
  69. import "google/ads/googleads/v10/resources/campaign_criterion_simulation.proto";
  70. import "google/ads/googleads/v10/resources/campaign_customizer.proto";
  71. import "google/ads/googleads/v10/resources/campaign_draft.proto";
  72. import "google/ads/googleads/v10/resources/campaign_experiment.proto";
  73. import "google/ads/googleads/v10/resources/campaign_extension_setting.proto";
  74. import "google/ads/googleads/v10/resources/campaign_feed.proto";
  75. import "google/ads/googleads/v10/resources/campaign_group.proto";
  76. import "google/ads/googleads/v10/resources/campaign_label.proto";
  77. import "google/ads/googleads/v10/resources/campaign_shared_set.proto";
  78. import "google/ads/googleads/v10/resources/campaign_simulation.proto";
  79. import "google/ads/googleads/v10/resources/carrier_constant.proto";
  80. import "google/ads/googleads/v10/resources/change_event.proto";
  81. import "google/ads/googleads/v10/resources/change_status.proto";
  82. import "google/ads/googleads/v10/resources/click_view.proto";
  83. import "google/ads/googleads/v10/resources/combined_audience.proto";
  84. import "google/ads/googleads/v10/resources/conversion_action.proto";
  85. import "google/ads/googleads/v10/resources/conversion_custom_variable.proto";
  86. import "google/ads/googleads/v10/resources/conversion_goal_campaign_config.proto";
  87. import "google/ads/googleads/v10/resources/conversion_value_rule.proto";
  88. import "google/ads/googleads/v10/resources/conversion_value_rule_set.proto";
  89. import "google/ads/googleads/v10/resources/currency_constant.proto";
  90. import "google/ads/googleads/v10/resources/custom_audience.proto";
  91. import "google/ads/googleads/v10/resources/custom_conversion_goal.proto";
  92. import "google/ads/googleads/v10/resources/custom_interest.proto";
  93. import "google/ads/googleads/v10/resources/customer.proto";
  94. import "google/ads/googleads/v10/resources/customer_asset.proto";
  95. import "google/ads/googleads/v10/resources/customer_client.proto";
  96. import "google/ads/googleads/v10/resources/customer_client_link.proto";
  97. import "google/ads/googleads/v10/resources/customer_conversion_goal.proto";
  98. import "google/ads/googleads/v10/resources/customer_customizer.proto";
  99. import "google/ads/googleads/v10/resources/customer_extension_setting.proto";
  100. import "google/ads/googleads/v10/resources/customer_feed.proto";
  101. import "google/ads/googleads/v10/resources/customer_label.proto";
  102. import "google/ads/googleads/v10/resources/customer_manager_link.proto";
  103. import "google/ads/googleads/v10/resources/customer_negative_criterion.proto";
  104. import "google/ads/googleads/v10/resources/customer_user_access.proto";
  105. import "google/ads/googleads/v10/resources/customer_user_access_invitation.proto";
  106. import "google/ads/googleads/v10/resources/customizer_attribute.proto";
  107. import "google/ads/googleads/v10/resources/detail_placement_view.proto";
  108. import "google/ads/googleads/v10/resources/detailed_demographic.proto";
  109. import "google/ads/googleads/v10/resources/display_keyword_view.proto";
  110. import "google/ads/googleads/v10/resources/distance_view.proto";
  111. import "google/ads/googleads/v10/resources/domain_category.proto";
  112. import "google/ads/googleads/v10/resources/dynamic_search_ads_search_term_view.proto";
  113. import "google/ads/googleads/v10/resources/expanded_landing_page_view.proto";
  114. import "google/ads/googleads/v10/resources/experiment.proto";
  115. import "google/ads/googleads/v10/resources/experiment_arm.proto";
  116. import "google/ads/googleads/v10/resources/extension_feed_item.proto";
  117. import "google/ads/googleads/v10/resources/feed.proto";
  118. import "google/ads/googleads/v10/resources/feed_item.proto";
  119. import "google/ads/googleads/v10/resources/feed_item_set.proto";
  120. import "google/ads/googleads/v10/resources/feed_item_set_link.proto";
  121. import "google/ads/googleads/v10/resources/feed_item_target.proto";
  122. import "google/ads/googleads/v10/resources/feed_mapping.proto";
  123. import "google/ads/googleads/v10/resources/feed_placeholder_view.proto";
  124. import "google/ads/googleads/v10/resources/gender_view.proto";
  125. import "google/ads/googleads/v10/resources/geo_target_constant.proto";
  126. import "google/ads/googleads/v10/resources/geographic_view.proto";
  127. import "google/ads/googleads/v10/resources/group_placement_view.proto";
  128. import "google/ads/googleads/v10/resources/hotel_group_view.proto";
  129. import "google/ads/googleads/v10/resources/hotel_performance_view.proto";
  130. import "google/ads/googleads/v10/resources/hotel_reconciliation.proto";
  131. import "google/ads/googleads/v10/resources/income_range_view.proto";
  132. import "google/ads/googleads/v10/resources/keyword_plan.proto";
  133. import "google/ads/googleads/v10/resources/keyword_plan_ad_group.proto";
  134. import "google/ads/googleads/v10/resources/keyword_plan_ad_group_keyword.proto";
  135. import "google/ads/googleads/v10/resources/keyword_plan_campaign.proto";
  136. import "google/ads/googleads/v10/resources/keyword_plan_campaign_keyword.proto";
  137. import "google/ads/googleads/v10/resources/keyword_theme_constant.proto";
  138. import "google/ads/googleads/v10/resources/keyword_view.proto";
  139. import "google/ads/googleads/v10/resources/label.proto";
  140. import "google/ads/googleads/v10/resources/landing_page_view.proto";
  141. import "google/ads/googleads/v10/resources/language_constant.proto";
  142. import "google/ads/googleads/v10/resources/lead_form_submission_data.proto";
  143. import "google/ads/googleads/v10/resources/life_event.proto";
  144. import "google/ads/googleads/v10/resources/location_view.proto";
  145. import "google/ads/googleads/v10/resources/managed_placement_view.proto";
  146. import "google/ads/googleads/v10/resources/media_file.proto";
  147. import "google/ads/googleads/v10/resources/mobile_app_category_constant.proto";
  148. import "google/ads/googleads/v10/resources/mobile_device_constant.proto";
  149. import "google/ads/googleads/v10/resources/offline_user_data_job.proto";
  150. import "google/ads/googleads/v10/resources/operating_system_version_constant.proto";
  151. import "google/ads/googleads/v10/resources/paid_organic_search_term_view.proto";
  152. import "google/ads/googleads/v10/resources/parental_status_view.proto";
  153. import "google/ads/googleads/v10/resources/product_bidding_category_constant.proto";
  154. import "google/ads/googleads/v10/resources/product_group_view.proto";
  155. import "google/ads/googleads/v10/resources/recommendation.proto";
  156. import "google/ads/googleads/v10/resources/remarketing_action.proto";
  157. import "google/ads/googleads/v10/resources/search_term_view.proto";
  158. import "google/ads/googleads/v10/resources/shared_criterion.proto";
  159. import "google/ads/googleads/v10/resources/shared_set.proto";
  160. import "google/ads/googleads/v10/resources/shopping_performance_view.proto";
  161. import "google/ads/googleads/v10/resources/smart_campaign_search_term_view.proto";
  162. import "google/ads/googleads/v10/resources/smart_campaign_setting.proto";
  163. import "google/ads/googleads/v10/resources/third_party_app_analytics_link.proto";
  164. import "google/ads/googleads/v10/resources/topic_constant.proto";
  165. import "google/ads/googleads/v10/resources/topic_view.proto";
  166. import "google/ads/googleads/v10/resources/user_interest.proto";
  167. import "google/ads/googleads/v10/resources/user_list.proto";
  168. import "google/ads/googleads/v10/resources/user_location_view.proto";
  169. import "google/ads/googleads/v10/resources/video.proto";
  170. import "google/ads/googleads/v10/resources/webpage_view.proto";
  171. import "google/ads/googleads/v10/services/ad_group_ad_label_service.proto";
  172. import "google/ads/googleads/v10/services/ad_group_ad_service.proto";
  173. import "google/ads/googleads/v10/services/ad_group_asset_service.proto";
  174. import "google/ads/googleads/v10/services/ad_group_bid_modifier_service.proto";
  175. import "google/ads/googleads/v10/services/ad_group_criterion_customizer_service.proto";
  176. import "google/ads/googleads/v10/services/ad_group_criterion_label_service.proto";
  177. import "google/ads/googleads/v10/services/ad_group_criterion_service.proto";
  178. import "google/ads/googleads/v10/services/ad_group_customizer_service.proto";
  179. import "google/ads/googleads/v10/services/ad_group_extension_setting_service.proto";
  180. import "google/ads/googleads/v10/services/ad_group_feed_service.proto";
  181. import "google/ads/googleads/v10/services/ad_group_label_service.proto";
  182. import "google/ads/googleads/v10/services/ad_group_service.proto";
  183. import "google/ads/googleads/v10/services/ad_parameter_service.proto";
  184. import "google/ads/googleads/v10/services/ad_service.proto";
  185. import "google/ads/googleads/v10/services/asset_group_asset_service.proto";
  186. import "google/ads/googleads/v10/services/asset_group_listing_group_filter_service.proto";
  187. import "google/ads/googleads/v10/services/asset_group_service.proto";
  188. import "google/ads/googleads/v10/services/asset_group_signal_service.proto";
  189. import "google/ads/googleads/v10/services/asset_service.proto";
  190. import "google/ads/googleads/v10/services/asset_set_asset_service.proto";
  191. import "google/ads/googleads/v10/services/asset_set_service.proto";
  192. import "google/ads/googleads/v10/services/audience_service.proto";
  193. import "google/ads/googleads/v10/services/bidding_data_exclusion_service.proto";
  194. import "google/ads/googleads/v10/services/bidding_seasonality_adjustment_service.proto";
  195. import "google/ads/googleads/v10/services/bidding_strategy_service.proto";
  196. import "google/ads/googleads/v10/services/campaign_asset_service.proto";
  197. import "google/ads/googleads/v10/services/campaign_asset_set_service.proto";
  198. import "google/ads/googleads/v10/services/campaign_bid_modifier_service.proto";
  199. import "google/ads/googleads/v10/services/campaign_budget_service.proto";
  200. import "google/ads/googleads/v10/services/campaign_conversion_goal_service.proto";
  201. import "google/ads/googleads/v10/services/campaign_criterion_service.proto";
  202. import "google/ads/googleads/v10/services/campaign_customizer_service.proto";
  203. import "google/ads/googleads/v10/services/campaign_draft_service.proto";
  204. import "google/ads/googleads/v10/services/campaign_experiment_service.proto";
  205. import "google/ads/googleads/v10/services/campaign_extension_setting_service.proto";
  206. import "google/ads/googleads/v10/services/campaign_feed_service.proto";
  207. import "google/ads/googleads/v10/services/campaign_group_service.proto";
  208. import "google/ads/googleads/v10/services/campaign_label_service.proto";
  209. import "google/ads/googleads/v10/services/campaign_service.proto";
  210. import "google/ads/googleads/v10/services/campaign_shared_set_service.proto";
  211. import "google/ads/googleads/v10/services/conversion_action_service.proto";
  212. import "google/ads/googleads/v10/services/conversion_custom_variable_service.proto";
  213. import "google/ads/googleads/v10/services/conversion_goal_campaign_config_service.proto";
  214. import "google/ads/googleads/v10/services/conversion_value_rule_service.proto";
  215. import "google/ads/googleads/v10/services/conversion_value_rule_set_service.proto";
  216. import "google/ads/googleads/v10/services/custom_conversion_goal_service.proto";
  217. import "google/ads/googleads/v10/services/customer_asset_service.proto";
  218. import "google/ads/googleads/v10/services/customer_conversion_goal_service.proto";
  219. import "google/ads/googleads/v10/services/customer_customizer_service.proto";
  220. import "google/ads/googleads/v10/services/customer_extension_setting_service.proto";
  221. import "google/ads/googleads/v10/services/customer_feed_service.proto";
  222. import "google/ads/googleads/v10/services/customer_label_service.proto";
  223. import "google/ads/googleads/v10/services/customer_negative_criterion_service.proto";
  224. import "google/ads/googleads/v10/services/customer_service.proto";
  225. import "google/ads/googleads/v10/services/customizer_attribute_service.proto";
  226. import "google/ads/googleads/v10/services/experiment_arm_service.proto";
  227. import "google/ads/googleads/v10/services/experiment_service.proto";
  228. import "google/ads/googleads/v10/services/extension_feed_item_service.proto";
  229. import "google/ads/googleads/v10/services/feed_item_service.proto";
  230. import "google/ads/googleads/v10/services/feed_item_set_link_service.proto";
  231. import "google/ads/googleads/v10/services/feed_item_set_service.proto";
  232. import "google/ads/googleads/v10/services/feed_item_target_service.proto";
  233. import "google/ads/googleads/v10/services/feed_mapping_service.proto";
  234. import "google/ads/googleads/v10/services/feed_service.proto";
  235. import "google/ads/googleads/v10/services/keyword_plan_ad_group_keyword_service.proto";
  236. import "google/ads/googleads/v10/services/keyword_plan_ad_group_service.proto";
  237. import "google/ads/googleads/v10/services/keyword_plan_campaign_keyword_service.proto";
  238. import "google/ads/googleads/v10/services/keyword_plan_campaign_service.proto";
  239. import "google/ads/googleads/v10/services/keyword_plan_service.proto";
  240. import "google/ads/googleads/v10/services/label_service.proto";
  241. import "google/ads/googleads/v10/services/media_file_service.proto";
  242. import "google/ads/googleads/v10/services/remarketing_action_service.proto";
  243. import "google/ads/googleads/v10/services/shared_criterion_service.proto";
  244. import "google/ads/googleads/v10/services/shared_set_service.proto";
  245. import "google/ads/googleads/v10/services/smart_campaign_setting_service.proto";
  246. import "google/ads/googleads/v10/services/user_list_service.proto";
  247. import "google/api/annotations.proto";
  248. import "google/api/client.proto";
  249. import "google/api/field_behavior.proto";
  250. import "google/protobuf/field_mask.proto";
  251. import "google/rpc/status.proto";
  252. option csharp_namespace = "Google.Ads.GoogleAds.V10.Services";
  253. option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v10/services;services";
  254. option java_multiple_files = true;
  255. option java_outer_classname = "GoogleAdsServiceProto";
  256. option java_package = "com.google.ads.googleads.v10.services";
  257. option objc_class_prefix = "GAA";
  258. option php_namespace = "Google\\Ads\\GoogleAds\\V10\\Services";
  259. option ruby_package = "Google::Ads::GoogleAds::V10::Services";
  260. // Proto file describing the GoogleAdsService.
  261. // Service to fetch data and metrics across resources.
  262. service GoogleAdsService {
  263. option (google.api.default_host) = "googleads.googleapis.com";
  264. option (google.api.oauth_scopes) = "https://www.googleapis.com/auth/adwords";
  265. // Returns all rows that match the search query.
  266. //
  267. // List of thrown errors:
  268. // [AuthenticationError]()
  269. // [AuthorizationError]()
  270. // [ChangeEventError]()
  271. // [ChangeStatusError]()
  272. // [ClickViewError]()
  273. // [HeaderError]()
  274. // [InternalError]()
  275. // [QueryError]()
  276. // [QuotaError]()
  277. // [RequestError]()
  278. rpc Search(SearchGoogleAdsRequest) returns (SearchGoogleAdsResponse) {
  279. option (google.api.http) = {
  280. post: "/v10/customers/{customer_id=*}/googleAds:search"
  281. body: "*"
  282. };
  283. option (google.api.method_signature) = "customer_id,query";
  284. }
  285. // Returns all rows that match the search stream query.
  286. //
  287. // List of thrown errors:
  288. // [AuthenticationError]()
  289. // [AuthorizationError]()
  290. // [ChangeEventError]()
  291. // [ChangeStatusError]()
  292. // [ClickViewError]()
  293. // [HeaderError]()
  294. // [InternalError]()
  295. // [QueryError]()
  296. // [QuotaError]()
  297. // [RequestError]()
  298. rpc SearchStream(SearchGoogleAdsStreamRequest) returns (stream SearchGoogleAdsStreamResponse) {
  299. option (google.api.http) = {
  300. post: "/v10/customers/{customer_id=*}/googleAds:searchStream"
  301. body: "*"
  302. };
  303. option (google.api.method_signature) = "customer_id,query";
  304. }
  305. // Creates, updates, or removes resources. This method supports atomic
  306. // transactions with multiple types of resources. For example, you can
  307. // atomically create a campaign and a campaign budget, or perform up to
  308. // thousands of mutates atomically.
  309. //
  310. // This method is essentially a wrapper around a series of mutate methods. The
  311. // only features it offers over calling those methods directly are:
  312. //
  313. // - Atomic transactions
  314. // - Temp resource names (described below)
  315. // - Somewhat reduced latency over making a series of mutate calls
  316. //
  317. // Note: Only resources that support atomic transactions are included, so this
  318. // method can't replace all calls to individual services.
  319. //
  320. // ## Atomic Transaction Benefits
  321. //
  322. // Atomicity makes error handling much easier. If you're making a series of
  323. // changes and one fails, it can leave your account in an inconsistent state.
  324. // With atomicity, you either reach the desired state directly, or the request
  325. // fails and you can retry.
  326. //
  327. // ## Temp Resource Names
  328. //
  329. // Temp resource names are a special type of resource name used to create a
  330. // resource and reference that resource in the same request. For example, if a
  331. // campaign budget is created with `resource_name` equal to
  332. // `customers/123/campaignBudgets/-1`, that resource name can be reused in
  333. // the `Campaign.budget` field in the same request. That way, the two
  334. // resources are created and linked atomically.
  335. //
  336. // To create a temp resource name, put a negative number in the part of the
  337. // name that the server would normally allocate.
  338. //
  339. // Note:
  340. //
  341. // - Resources must be created with a temp name before the name can be reused.
  342. // For example, the previous CampaignBudget+Campaign example would fail if
  343. // the mutate order was reversed.
  344. // - Temp names are not remembered across requests.
  345. // - There's no limit to the number of temp names in a request.
  346. // - Each temp name must use a unique negative number, even if the resource
  347. // types differ.
  348. //
  349. // ## Latency
  350. //
  351. // It's important to group mutates by resource type or the request may time
  352. // out and fail. Latency is roughly equal to a series of calls to individual
  353. // mutate methods, where each change in resource type is a new call. For
  354. // example, mutating 10 campaigns then 10 ad groups is like 2 calls, while
  355. // mutating 1 campaign, 1 ad group, 1 campaign, 1 ad group is like 4 calls.
  356. //
  357. // List of thrown errors:
  358. // [AdCustomizerError]()
  359. // [AdError]()
  360. // [AdGroupAdError]()
  361. // [AdGroupCriterionError]()
  362. // [AdGroupError]()
  363. // [AssetError]()
  364. // [AuthenticationError]()
  365. // [AuthorizationError]()
  366. // [BiddingError]()
  367. // [CampaignBudgetError]()
  368. // [CampaignCriterionError]()
  369. // [CampaignError]()
  370. // [CampaignExperimentError]()
  371. // [CampaignSharedSetError]()
  372. // [CollectionSizeError]()
  373. // [ContextError]()
  374. // [ConversionActionError]()
  375. // [CriterionError]()
  376. // [CustomerFeedError]()
  377. // [DatabaseError]()
  378. // [DateError]()
  379. // [DateRangeError]()
  380. // [DistinctError]()
  381. // [ExtensionFeedItemError]()
  382. // [ExtensionSettingError]()
  383. // [FeedAttributeReferenceError]()
  384. // [FeedError]()
  385. // [FeedItemError]()
  386. // [FeedItemSetError]()
  387. // [FieldError]()
  388. // [FieldMaskError]()
  389. // [FunctionParsingError]()
  390. // [HeaderError]()
  391. // [ImageError]()
  392. // [InternalError]()
  393. // [KeywordPlanAdGroupKeywordError]()
  394. // [KeywordPlanCampaignError]()
  395. // [KeywordPlanError]()
  396. // [LabelError]()
  397. // [ListOperationError]()
  398. // [MediaUploadError]()
  399. // [MutateError]()
  400. // [NewResourceCreationError]()
  401. // [NullError]()
  402. // [OperationAccessDeniedError]()
  403. // [PolicyFindingError]()
  404. // [PolicyViolationError]()
  405. // [QuotaError]()
  406. // [RangeError]()
  407. // [RequestError]()
  408. // [ResourceCountLimitExceededError]()
  409. // [SettingError]()
  410. // [SharedSetError]()
  411. // [SizeLimitError]()
  412. // [StringFormatError]()
  413. // [StringLengthError]()
  414. // [UrlFieldError]()
  415. // [UserListError]()
  416. // [YoutubeVideoRegistrationError]()
  417. rpc Mutate(MutateGoogleAdsRequest) returns (MutateGoogleAdsResponse) {
  418. option (google.api.http) = {
  419. post: "/v10/customers/{customer_id=*}/googleAds:mutate"
  420. body: "*"
  421. };
  422. option (google.api.method_signature) = "customer_id,mutate_operations";
  423. }
  424. }
  425. // Request message for [GoogleAdsService.Search][google.ads.googleads.v10.services.GoogleAdsService.Search].
  426. message SearchGoogleAdsRequest {
  427. // Required. The ID of the customer being queried.
  428. string customer_id = 1 [(google.api.field_behavior) = REQUIRED];
  429. // Required. The query string.
  430. string query = 2 [(google.api.field_behavior) = REQUIRED];
  431. // Token of the page to retrieve. If not specified, the first
  432. // page of results will be returned. Use the value obtained from
  433. // `next_page_token` in the previous response in order to request
  434. // the next page of results.
  435. string page_token = 3;
  436. // Number of elements to retrieve in a single page.
  437. // When too large a page is requested, the server may decide to
  438. // further limit the number of returned resources.
  439. int32 page_size = 4;
  440. // If true, the request is validated but not executed.
  441. bool validate_only = 5;
  442. // If true, the total number of results that match the query ignoring the
  443. // LIMIT clause will be included in the response.
  444. // Default is false.
  445. bool return_total_results_count = 7;
  446. // Determines whether a summary row will be returned. By default, summary row
  447. // is not returned. If requested, the summary row will be sent in a response
  448. // by itself after all other query results are returned.
  449. google.ads.googleads.v10.enums.SummaryRowSettingEnum.SummaryRowSetting summary_row_setting = 8;
  450. }
  451. // Response message for [GoogleAdsService.Search][google.ads.googleads.v10.services.GoogleAdsService.Search].
  452. message SearchGoogleAdsResponse {
  453. // The list of rows that matched the query.
  454. repeated GoogleAdsRow results = 1;
  455. // Pagination token used to retrieve the next page of results.
  456. // Pass the content of this string as the `page_token` attribute of
  457. // the next request. `next_page_token` is not returned for the last
  458. // page.
  459. string next_page_token = 2;
  460. // Total number of results that match the query ignoring the LIMIT
  461. // clause.
  462. int64 total_results_count = 3;
  463. // FieldMask that represents what fields were requested by the user.
  464. google.protobuf.FieldMask field_mask = 5;
  465. // Summary row that contains summary of metrics in results.
  466. // Summary of metrics means aggregation of metrics across all results,
  467. // here aggregation could be sum, average, rate, etc.
  468. GoogleAdsRow summary_row = 6;
  469. }
  470. // Request message for [GoogleAdsService.SearchStream][google.ads.googleads.v10.services.GoogleAdsService.SearchStream].
  471. message SearchGoogleAdsStreamRequest {
  472. // Required. The ID of the customer being queried.
  473. string customer_id = 1 [(google.api.field_behavior) = REQUIRED];
  474. // Required. The query string.
  475. string query = 2 [(google.api.field_behavior) = REQUIRED];
  476. // Determines whether a summary row will be returned. By default, summary row
  477. // is not returned. If requested, the summary row will be sent in a response
  478. // by itself after all other query results are returned.
  479. google.ads.googleads.v10.enums.SummaryRowSettingEnum.SummaryRowSetting summary_row_setting = 3;
  480. }
  481. // Response message for [GoogleAdsService.SearchStream][google.ads.googleads.v10.services.GoogleAdsService.SearchStream].
  482. message SearchGoogleAdsStreamResponse {
  483. // The list of rows that matched the query.
  484. repeated GoogleAdsRow results = 1;
  485. // FieldMask that represents what fields were requested by the user.
  486. google.protobuf.FieldMask field_mask = 2;
  487. // Summary row that contains summary of metrics in results.
  488. // Summary of metrics means aggregation of metrics across all results,
  489. // here aggregation could be sum, average, rate, etc.
  490. GoogleAdsRow summary_row = 3;
  491. // The unique id of the request that is used for debugging purposes.
  492. string request_id = 4;
  493. }
  494. // A returned row from the query.
  495. message GoogleAdsRow {
  496. // The account budget in the query.
  497. google.ads.googleads.v10.resources.AccountBudget account_budget = 42;
  498. // The account budget proposal referenced in the query.
  499. google.ads.googleads.v10.resources.AccountBudgetProposal account_budget_proposal = 43;
  500. // The AccountLink referenced in the query.
  501. google.ads.googleads.v10.resources.AccountLink account_link = 143;
  502. // The ad group referenced in the query.
  503. google.ads.googleads.v10.resources.AdGroup ad_group = 3;
  504. // The ad referenced in the query.
  505. google.ads.googleads.v10.resources.AdGroupAd ad_group_ad = 16;
  506. // The ad group ad asset combination view in the query.
  507. google.ads.googleads.v10.resources.AdGroupAdAssetCombinationView ad_group_ad_asset_combination_view = 193;
  508. // The ad group ad asset view in the query.
  509. google.ads.googleads.v10.resources.AdGroupAdAssetView ad_group_ad_asset_view = 131;
  510. // The ad group ad label referenced in the query.
  511. google.ads.googleads.v10.resources.AdGroupAdLabel ad_group_ad_label = 120;
  512. // The ad group asset referenced in the query.
  513. google.ads.googleads.v10.resources.AdGroupAsset ad_group_asset = 154;
  514. // The ad group audience view referenced in the query.
  515. google.ads.googleads.v10.resources.AdGroupAudienceView ad_group_audience_view = 57;
  516. // The bid modifier referenced in the query.
  517. google.ads.googleads.v10.resources.AdGroupBidModifier ad_group_bid_modifier = 24;
  518. // The criterion referenced in the query.
  519. google.ads.googleads.v10.resources.AdGroupCriterion ad_group_criterion = 17;
  520. // The ad group criterion customizer referenced in the query.
  521. google.ads.googleads.v10.resources.AdGroupCriterionCustomizer ad_group_criterion_customizer = 187;
  522. // The ad group criterion label referenced in the query.
  523. google.ads.googleads.v10.resources.AdGroupCriterionLabel ad_group_criterion_label = 121;
  524. // The ad group criterion simulation referenced in the query.
  525. google.ads.googleads.v10.resources.AdGroupCriterionSimulation ad_group_criterion_simulation = 110;
  526. // The ad group customizer referenced in the query.
  527. google.ads.googleads.v10.resources.AdGroupCustomizer ad_group_customizer = 185;
  528. // The ad group extension setting referenced in the query.
  529. google.ads.googleads.v10.resources.AdGroupExtensionSetting ad_group_extension_setting = 112;
  530. // The ad group feed referenced in the query.
  531. google.ads.googleads.v10.resources.AdGroupFeed ad_group_feed = 67;
  532. // The ad group label referenced in the query.
  533. google.ads.googleads.v10.resources.AdGroupLabel ad_group_label = 115;
  534. // The ad group simulation referenced in the query.
  535. google.ads.googleads.v10.resources.AdGroupSimulation ad_group_simulation = 107;
  536. // The ad parameter referenced in the query.
  537. google.ads.googleads.v10.resources.AdParameter ad_parameter = 130;
  538. // The age range view referenced in the query.
  539. google.ads.googleads.v10.resources.AgeRangeView age_range_view = 48;
  540. // The ad schedule view referenced in the query.
  541. google.ads.googleads.v10.resources.AdScheduleView ad_schedule_view = 89;
  542. // The domain category referenced in the query.
  543. google.ads.googleads.v10.resources.DomainCategory domain_category = 91;
  544. // The asset referenced in the query.
  545. google.ads.googleads.v10.resources.Asset asset = 105;
  546. // The asset field type view referenced in the query.
  547. google.ads.googleads.v10.resources.AssetFieldTypeView asset_field_type_view = 168;
  548. // The asset group asset referenced in the query.
  549. google.ads.googleads.v10.resources.AssetGroupAsset asset_group_asset = 173;
  550. // The asset group signal referenced in the query.
  551. google.ads.googleads.v10.resources.AssetGroupSignal asset_group_signal = 191;
  552. // The asset group listing group filter referenced in the query.
  553. google.ads.googleads.v10.resources.AssetGroupListingGroupFilter asset_group_listing_group_filter = 182;
  554. // The asset group product group view referenced in the query.
  555. google.ads.googleads.v10.resources.AssetGroupProductGroupView asset_group_product_group_view = 189;
  556. // The asset group referenced in the query.
  557. google.ads.googleads.v10.resources.AssetGroup asset_group = 172;
  558. // The asset set asset referenced in the query.
  559. google.ads.googleads.v10.resources.AssetSetAsset asset_set_asset = 180;
  560. // The asset set referenced in the query.
  561. google.ads.googleads.v10.resources.AssetSet asset_set = 179;
  562. // The batch job referenced in the query.
  563. google.ads.googleads.v10.resources.BatchJob batch_job = 139;
  564. // The bidding data exclusion referenced in the query.
  565. google.ads.googleads.v10.resources.BiddingDataExclusion bidding_data_exclusion = 159;
  566. // The bidding seasonality adjustment referenced in the query.
  567. google.ads.googleads.v10.resources.BiddingSeasonalityAdjustment bidding_seasonality_adjustment = 160;
  568. // The bidding strategy referenced in the query.
  569. google.ads.googleads.v10.resources.BiddingStrategy bidding_strategy = 18;
  570. // The bidding strategy simulation referenced in the query.
  571. google.ads.googleads.v10.resources.BiddingStrategySimulation bidding_strategy_simulation = 158;
  572. // The billing setup referenced in the query.
  573. google.ads.googleads.v10.resources.BillingSetup billing_setup = 41;
  574. // The call view referenced in the query.
  575. google.ads.googleads.v10.resources.CallView call_view = 152;
  576. // The campaign budget referenced in the query.
  577. google.ads.googleads.v10.resources.CampaignBudget campaign_budget = 19;
  578. // The campaign referenced in the query.
  579. google.ads.googleads.v10.resources.Campaign campaign = 2;
  580. // The campaign asset referenced in the query.
  581. google.ads.googleads.v10.resources.CampaignAsset campaign_asset = 142;
  582. // The campaign asset set referenced in the query.
  583. google.ads.googleads.v10.resources.CampaignAssetSet campaign_asset_set = 181;
  584. // The campaign audience view referenced in the query.
  585. google.ads.googleads.v10.resources.CampaignAudienceView campaign_audience_view = 69;
  586. // The campaign bid modifier referenced in the query.
  587. google.ads.googleads.v10.resources.CampaignBidModifier campaign_bid_modifier = 26;
  588. // The CampaignConversionGoal referenced in the query.
  589. google.ads.googleads.v10.resources.CampaignConversionGoal campaign_conversion_goal = 175;
  590. // The campaign criterion referenced in the query.
  591. google.ads.googleads.v10.resources.CampaignCriterion campaign_criterion = 20;
  592. // The campaign criterion simulation referenced in the query.
  593. google.ads.googleads.v10.resources.CampaignCriterionSimulation campaign_criterion_simulation = 111;
  594. // The campaign customizer referenced in the query.
  595. google.ads.googleads.v10.resources.CampaignCustomizer campaign_customizer = 186;
  596. // The campaign draft referenced in the query.
  597. google.ads.googleads.v10.resources.CampaignDraft campaign_draft = 49;
  598. // The campaign experiment referenced in the query.
  599. google.ads.googleads.v10.resources.CampaignExperiment campaign_experiment = 84;
  600. // The campaign extension setting referenced in the query.
  601. google.ads.googleads.v10.resources.CampaignExtensionSetting campaign_extension_setting = 113;
  602. // The campaign feed referenced in the query.
  603. google.ads.googleads.v10.resources.CampaignFeed campaign_feed = 63;
  604. // Campaign Group referenced in AWQL query.
  605. google.ads.googleads.v10.resources.CampaignGroup campaign_group = 25;
  606. // The campaign label referenced in the query.
  607. google.ads.googleads.v10.resources.CampaignLabel campaign_label = 108;
  608. // Campaign Shared Set referenced in AWQL query.
  609. google.ads.googleads.v10.resources.CampaignSharedSet campaign_shared_set = 30;
  610. // The campaign simulation referenced in the query.
  611. google.ads.googleads.v10.resources.CampaignSimulation campaign_simulation = 157;
  612. // The carrier constant referenced in the query.
  613. google.ads.googleads.v10.resources.CarrierConstant carrier_constant = 66;
  614. // The ChangeEvent referenced in the query.
  615. google.ads.googleads.v10.resources.ChangeEvent change_event = 145;
  616. // The ChangeStatus referenced in the query.
  617. google.ads.googleads.v10.resources.ChangeStatus change_status = 37;
  618. // The CombinedAudience referenced in the query.
  619. google.ads.googleads.v10.resources.CombinedAudience combined_audience = 148;
  620. // The Audience referenced in the query.
  621. google.ads.googleads.v10.resources.Audience audience = 190;
  622. // The conversion action referenced in the query.
  623. google.ads.googleads.v10.resources.ConversionAction conversion_action = 103;
  624. // The conversion custom variable referenced in the query.
  625. google.ads.googleads.v10.resources.ConversionCustomVariable conversion_custom_variable = 153;
  626. // The ConversionGoalCampaignConfig referenced in the query.
  627. google.ads.googleads.v10.resources.ConversionGoalCampaignConfig conversion_goal_campaign_config = 177;
  628. // The conversion value rule referenced in the query.
  629. google.ads.googleads.v10.resources.ConversionValueRule conversion_value_rule = 164;
  630. // The conversion value rule set referenced in the query.
  631. google.ads.googleads.v10.resources.ConversionValueRuleSet conversion_value_rule_set = 165;
  632. // The ClickView referenced in the query.
  633. google.ads.googleads.v10.resources.ClickView click_view = 122;
  634. // The currency constant referenced in the query.
  635. google.ads.googleads.v10.resources.CurrencyConstant currency_constant = 134;
  636. // The CustomAudience referenced in the query.
  637. google.ads.googleads.v10.resources.CustomAudience custom_audience = 147;
  638. // The CustomConversionGoal referenced in the query.
  639. google.ads.googleads.v10.resources.CustomConversionGoal custom_conversion_goal = 176;
  640. // The CustomInterest referenced in the query.
  641. google.ads.googleads.v10.resources.CustomInterest custom_interest = 104;
  642. // The customer referenced in the query.
  643. google.ads.googleads.v10.resources.Customer customer = 1;
  644. // The customer asset referenced in the query.
  645. google.ads.googleads.v10.resources.CustomerAsset customer_asset = 155;
  646. // The accessible bidding strategy referenced in the query.
  647. google.ads.googleads.v10.resources.AccessibleBiddingStrategy accessible_bidding_strategy = 169;
  648. // The customer customizer referenced in the query.
  649. google.ads.googleads.v10.resources.CustomerCustomizer customer_customizer = 184;
  650. // The CustomerManagerLink referenced in the query.
  651. google.ads.googleads.v10.resources.CustomerManagerLink customer_manager_link = 61;
  652. // The CustomerClientLink referenced in the query.
  653. google.ads.googleads.v10.resources.CustomerClientLink customer_client_link = 62;
  654. // The CustomerClient referenced in the query.
  655. google.ads.googleads.v10.resources.CustomerClient customer_client = 70;
  656. // The CustomerConversionGoal referenced in the query.
  657. google.ads.googleads.v10.resources.CustomerConversionGoal customer_conversion_goal = 174;
  658. // The customer extension setting referenced in the query.
  659. google.ads.googleads.v10.resources.CustomerExtensionSetting customer_extension_setting = 114;
  660. // The customer feed referenced in the query.
  661. google.ads.googleads.v10.resources.CustomerFeed customer_feed = 64;
  662. // The customer label referenced in the query.
  663. google.ads.googleads.v10.resources.CustomerLabel customer_label = 124;
  664. // The customer negative criterion referenced in the query.
  665. google.ads.googleads.v10.resources.CustomerNegativeCriterion customer_negative_criterion = 88;
  666. // The CustomerUserAccess referenced in the query.
  667. google.ads.googleads.v10.resources.CustomerUserAccess customer_user_access = 146;
  668. // The CustomerUserAccessInvitation referenced in the query.
  669. google.ads.googleads.v10.resources.CustomerUserAccessInvitation customer_user_access_invitation = 150;
  670. // The customizer attribute referenced in the query.
  671. google.ads.googleads.v10.resources.CustomizerAttribute customizer_attribute = 178;
  672. // The detail placement view referenced in the query.
  673. google.ads.googleads.v10.resources.DetailPlacementView detail_placement_view = 118;
  674. // The detailed demographic referenced in the query.
  675. google.ads.googleads.v10.resources.DetailedDemographic detailed_demographic = 166;
  676. // The display keyword view referenced in the query.
  677. google.ads.googleads.v10.resources.DisplayKeywordView display_keyword_view = 47;
  678. // The distance view referenced in the query.
  679. google.ads.googleads.v10.resources.DistanceView distance_view = 132;
  680. // The dynamic search ads search term view referenced in the query.
  681. google.ads.googleads.v10.resources.DynamicSearchAdsSearchTermView dynamic_search_ads_search_term_view = 106;
  682. // The expanded landing page view referenced in the query.
  683. google.ads.googleads.v10.resources.ExpandedLandingPageView expanded_landing_page_view = 128;
  684. // The extension feed item referenced in the query.
  685. google.ads.googleads.v10.resources.ExtensionFeedItem extension_feed_item = 85;
  686. // The feed referenced in the query.
  687. google.ads.googleads.v10.resources.Feed feed = 46;
  688. // The feed item referenced in the query.
  689. google.ads.googleads.v10.resources.FeedItem feed_item = 50;
  690. // The feed item set referenced in the query.
  691. google.ads.googleads.v10.resources.FeedItemSet feed_item_set = 149;
  692. // The feed item set link referenced in the query.
  693. google.ads.googleads.v10.resources.FeedItemSetLink feed_item_set_link = 151;
  694. // The feed item target referenced in the query.
  695. google.ads.googleads.v10.resources.FeedItemTarget feed_item_target = 116;
  696. // The feed mapping referenced in the query.
  697. google.ads.googleads.v10.resources.FeedMapping feed_mapping = 58;
  698. // The feed placeholder view referenced in the query.
  699. google.ads.googleads.v10.resources.FeedPlaceholderView feed_placeholder_view = 97;
  700. // The gender view referenced in the query.
  701. google.ads.googleads.v10.resources.GenderView gender_view = 40;
  702. // The geo target constant referenced in the query.
  703. google.ads.googleads.v10.resources.GeoTargetConstant geo_target_constant = 23;
  704. // The geographic view referenced in the query.
  705. google.ads.googleads.v10.resources.GeographicView geographic_view = 125;
  706. // The group placement view referenced in the query.
  707. google.ads.googleads.v10.resources.GroupPlacementView group_placement_view = 119;
  708. // The hotel group view referenced in the query.
  709. google.ads.googleads.v10.resources.HotelGroupView hotel_group_view = 51;
  710. // The hotel performance view referenced in the query.
  711. google.ads.googleads.v10.resources.HotelPerformanceView hotel_performance_view = 71;
  712. // The hotel reconciliation referenced in the query.
  713. google.ads.googleads.v10.resources.HotelReconciliation hotel_reconciliation = 188;
  714. // The income range view referenced in the query.
  715. google.ads.googleads.v10.resources.IncomeRangeView income_range_view = 138;
  716. // The keyword view referenced in the query.
  717. google.ads.googleads.v10.resources.KeywordView keyword_view = 21;
  718. // The keyword plan referenced in the query.
  719. google.ads.googleads.v10.resources.KeywordPlan keyword_plan = 32;
  720. // The keyword plan campaign referenced in the query.
  721. google.ads.googleads.v10.resources.KeywordPlanCampaign keyword_plan_campaign = 33;
  722. // The keyword plan campaign keyword referenced in the query.
  723. google.ads.googleads.v10.resources.KeywordPlanCampaignKeyword keyword_plan_campaign_keyword = 140;
  724. // The keyword plan ad group referenced in the query.
  725. google.ads.googleads.v10.resources.KeywordPlanAdGroup keyword_plan_ad_group = 35;
  726. // The keyword plan ad group referenced in the query.
  727. google.ads.googleads.v10.resources.KeywordPlanAdGroupKeyword keyword_plan_ad_group_keyword = 141;
  728. // The keyword theme constant referenced in the query.
  729. google.ads.googleads.v10.resources.KeywordThemeConstant keyword_theme_constant = 163;
  730. // The label referenced in the query.
  731. google.ads.googleads.v10.resources.Label label = 52;
  732. // The landing page view referenced in the query.
  733. google.ads.googleads.v10.resources.LandingPageView landing_page_view = 126;
  734. // The language constant referenced in the query.
  735. google.ads.googleads.v10.resources.LanguageConstant language_constant = 55;
  736. // The location view referenced in the query.
  737. google.ads.googleads.v10.resources.LocationView location_view = 123;
  738. // The managed placement view referenced in the query.
  739. google.ads.googleads.v10.resources.ManagedPlacementView managed_placement_view = 53;
  740. // The media file referenced in the query.
  741. google.ads.googleads.v10.resources.MediaFile media_file = 90;
  742. // The mobile app category constant referenced in the query.
  743. google.ads.googleads.v10.resources.MobileAppCategoryConstant mobile_app_category_constant = 87;
  744. // The mobile device constant referenced in the query.
  745. google.ads.googleads.v10.resources.MobileDeviceConstant mobile_device_constant = 98;
  746. // The offline user data job referenced in the query.
  747. google.ads.googleads.v10.resources.OfflineUserDataJob offline_user_data_job = 137;
  748. // The operating system version constant referenced in the query.
  749. google.ads.googleads.v10.resources.OperatingSystemVersionConstant operating_system_version_constant = 86;
  750. // The paid organic search term view referenced in the query.
  751. google.ads.googleads.v10.resources.PaidOrganicSearchTermView paid_organic_search_term_view = 129;
  752. // The parental status view referenced in the query.
  753. google.ads.googleads.v10.resources.ParentalStatusView parental_status_view = 45;
  754. // The Product Bidding Category referenced in the query.
  755. google.ads.googleads.v10.resources.ProductBiddingCategoryConstant product_bidding_category_constant = 109;
  756. // The product group view referenced in the query.
  757. google.ads.googleads.v10.resources.ProductGroupView product_group_view = 54;
  758. // The recommendation referenced in the query.
  759. google.ads.googleads.v10.resources.Recommendation recommendation = 22;
  760. // The search term view referenced in the query.
  761. google.ads.googleads.v10.resources.SearchTermView search_term_view = 68;
  762. // The shared set referenced in the query.
  763. google.ads.googleads.v10.resources.SharedCriterion shared_criterion = 29;
  764. // The shared set referenced in the query.
  765. google.ads.googleads.v10.resources.SharedSet shared_set = 27;
  766. // The Smart campaign setting referenced in the query.
  767. google.ads.googleads.v10.resources.SmartCampaignSetting smart_campaign_setting = 167;
  768. // The shopping performance view referenced in the query.
  769. google.ads.googleads.v10.resources.ShoppingPerformanceView shopping_performance_view = 117;
  770. // The Smart campaign search term view referenced in the query.
  771. google.ads.googleads.v10.resources.SmartCampaignSearchTermView smart_campaign_search_term_view = 170;
  772. // The AccountLink referenced in the query.
  773. google.ads.googleads.v10.resources.ThirdPartyAppAnalyticsLink third_party_app_analytics_link = 144;
  774. // The topic view referenced in the query.
  775. google.ads.googleads.v10.resources.TopicView topic_view = 44;
  776. // The experiment referenced in the query.
  777. google.ads.googleads.v10.resources.Experiment experiment = 133;
  778. // The experiment arm referenced in the query.
  779. google.ads.googleads.v10.resources.ExperimentArm experiment_arm = 183;
  780. // The user interest referenced in the query.
  781. google.ads.googleads.v10.resources.UserInterest user_interest = 59;
  782. // The life event referenced in the query.
  783. google.ads.googleads.v10.resources.LifeEvent life_event = 161;
  784. // The user list referenced in the query.
  785. google.ads.googleads.v10.resources.UserList user_list = 38;
  786. // The user location view referenced in the query.
  787. google.ads.googleads.v10.resources.UserLocationView user_location_view = 135;
  788. // The remarketing action referenced in the query.
  789. google.ads.googleads.v10.resources.RemarketingAction remarketing_action = 60;
  790. // The topic constant referenced in the query.
  791. google.ads.googleads.v10.resources.TopicConstant topic_constant = 31;
  792. // The video referenced in the query.
  793. google.ads.googleads.v10.resources.Video video = 39;
  794. // The webpage view referenced in the query.
  795. google.ads.googleads.v10.resources.WebpageView webpage_view = 162;
  796. // The lead form user submission referenced in the query.
  797. google.ads.googleads.v10.resources.LeadFormSubmissionData lead_form_submission_data = 192;
  798. // The metrics.
  799. google.ads.googleads.v10.common.Metrics metrics = 4;
  800. // The segments.
  801. google.ads.googleads.v10.common.Segments segments = 102;
  802. }
  803. // Request message for [GoogleAdsService.Mutate][google.ads.googleads.v10.services.GoogleAdsService.Mutate].
  804. message MutateGoogleAdsRequest {
  805. // Required. The ID of the customer whose resources are being modified.
  806. string customer_id = 1 [(google.api.field_behavior) = REQUIRED];
  807. // Required. The list of operations to perform on individual resources.
  808. repeated MutateOperation mutate_operations = 2 [(google.api.field_behavior) = REQUIRED];
  809. // If true, successful operations will be carried out and invalid
  810. // operations will return errors. If false, all operations will be carried
  811. // out in one transaction if and only if they are all valid.
  812. // Default is false.
  813. bool partial_failure = 3;
  814. // If true, the request is validated but not executed. Only errors are
  815. // returned, not results.
  816. bool validate_only = 4;
  817. // The response content type setting. Determines whether the mutable resource
  818. // or just the resource name should be returned post mutation. The mutable
  819. // resource will only be returned if the resource has the appropriate response
  820. // field. E.g. MutateCampaignResult.campaign.
  821. google.ads.googleads.v10.enums.ResponseContentTypeEnum.ResponseContentType response_content_type = 5;
  822. }
  823. // Response message for [GoogleAdsService.Mutate][google.ads.googleads.v10.services.GoogleAdsService.Mutate].
  824. message MutateGoogleAdsResponse {
  825. // Errors that pertain to operation failures in the partial failure mode.
  826. // Returned only when partial_failure = true and all errors occur inside the
  827. // operations. If any errors occur outside the operations (e.g., auth errors),
  828. // we return an RPC level error.
  829. google.rpc.Status partial_failure_error = 3;
  830. // All responses for the mutate.
  831. repeated MutateOperationResponse mutate_operation_responses = 1;
  832. }
  833. // A single operation (create, update, remove) on a resource.
  834. message MutateOperation {
  835. // The mutate operation.
  836. oneof operation {
  837. // An ad group ad label mutate operation.
  838. AdGroupAdLabelOperation ad_group_ad_label_operation = 17;
  839. // An ad group ad mutate operation.
  840. AdGroupAdOperation ad_group_ad_operation = 1;
  841. // An ad group asset mutate operation.
  842. AdGroupAssetOperation ad_group_asset_operation = 56;
  843. // An ad group bid modifier mutate operation.
  844. AdGroupBidModifierOperation ad_group_bid_modifier_operation = 2;
  845. // An ad group criterion customizer mutate operation.
  846. AdGroupCriterionCustomizerOperation ad_group_criterion_customizer_operation = 77;
  847. // An ad group criterion label mutate operation.
  848. AdGroupCriterionLabelOperation ad_group_criterion_label_operation = 18;
  849. // An ad group criterion mutate operation.
  850. AdGroupCriterionOperation ad_group_criterion_operation = 3;
  851. // An ad group customizer mutate operation.
  852. AdGroupCustomizerOperation ad_group_customizer_operation = 75;
  853. // An ad group extension setting mutate operation.
  854. AdGroupExtensionSettingOperation ad_group_extension_setting_operation = 19;
  855. // An ad group feed mutate operation.
  856. AdGroupFeedOperation ad_group_feed_operation = 20;
  857. // An ad group label mutate operation.
  858. AdGroupLabelOperation ad_group_label_operation = 21;
  859. // An ad group mutate operation.
  860. AdGroupOperation ad_group_operation = 5;
  861. // An ad mutate operation.
  862. AdOperation ad_operation = 49;
  863. // An ad parameter mutate operation.
  864. AdParameterOperation ad_parameter_operation = 22;
  865. // An asset mutate operation.
  866. AssetOperation asset_operation = 23;
  867. // An asset group asset mutate operation.
  868. AssetGroupAssetOperation asset_group_asset_operation = 65;
  869. // An asset group listing group filter mutate operation.
  870. AssetGroupListingGroupFilterOperation asset_group_listing_group_filter_operation = 78;
  871. // An asset group signal mutate operation.
  872. AssetGroupSignalOperation asset_group_signal_operation = 80;
  873. // An asset group mutate operation.
  874. AssetGroupOperation asset_group_operation = 62;
  875. // An asset set asset mutate operation.
  876. AssetSetAssetOperation asset_set_asset_operation = 71;
  877. // An asset set mutate operation.
  878. AssetSetOperation asset_set_operation = 72;
  879. // An audience mutate operation.
  880. AudienceOperation audience_operation = 81;
  881. // A bidding data exclusion mutate operation.
  882. BiddingDataExclusionOperation bidding_data_exclusion_operation = 58;
  883. // A bidding seasonality adjustment mutate operation.
  884. BiddingSeasonalityAdjustmentOperation bidding_seasonality_adjustment_operation = 59;
  885. // A bidding strategy mutate operation.
  886. BiddingStrategyOperation bidding_strategy_operation = 6;
  887. // A campaign asset mutate operation.
  888. CampaignAssetOperation campaign_asset_operation = 52;
  889. // A campaign asset mutate operation.
  890. CampaignAssetSetOperation campaign_asset_set_operation = 73;
  891. // A campaign bid modifier mutate operation.
  892. CampaignBidModifierOperation campaign_bid_modifier_operation = 7;
  893. // A campaign budget mutate operation.
  894. CampaignBudgetOperation campaign_budget_operation = 8;
  895. // A campaign conversion goal mutate operation.
  896. CampaignConversionGoalOperation campaign_conversion_goal_operation = 67;
  897. // A campaign criterion mutate operation.
  898. CampaignCriterionOperation campaign_criterion_operation = 13;
  899. // An campaign customizer mutate operation.
  900. CampaignCustomizerOperation campaign_customizer_operation = 76;
  901. // A campaign draft mutate operation.
  902. CampaignDraftOperation campaign_draft_operation = 24;
  903. // A campaign experiment mutate operation.
  904. CampaignExperimentOperation campaign_experiment_operation = 25;
  905. // A campaign extension setting mutate operation.
  906. CampaignExtensionSettingOperation campaign_extension_setting_operation = 26;
  907. // A campaign feed mutate operation.
  908. CampaignFeedOperation campaign_feed_operation = 27;
  909. // A campaign group mutate operation.
  910. CampaignGroupOperation campaign_group_operation = 9;
  911. // A campaign label mutate operation.
  912. CampaignLabelOperation campaign_label_operation = 28;
  913. // A campaign mutate operation.
  914. CampaignOperation campaign_operation = 10;
  915. // A campaign shared set mutate operation.
  916. CampaignSharedSetOperation campaign_shared_set_operation = 11;
  917. // A conversion action mutate operation.
  918. ConversionActionOperation conversion_action_operation = 12;
  919. // A conversion custom variable mutate operation.
  920. ConversionCustomVariableOperation conversion_custom_variable_operation = 55;
  921. // A conversion goal campaign config mutate operation.
  922. ConversionGoalCampaignConfigOperation conversion_goal_campaign_config_operation = 69;
  923. // A conversion value rule mutate operation.
  924. ConversionValueRuleOperation conversion_value_rule_operation = 63;
  925. // A conversion value rule set mutate operation.
  926. ConversionValueRuleSetOperation conversion_value_rule_set_operation = 64;
  927. // A custom conversion goal mutate operation.
  928. CustomConversionGoalOperation custom_conversion_goal_operation = 68;
  929. // A customer asset mutate operation.
  930. CustomerAssetOperation customer_asset_operation = 57;
  931. // A customer conversion goal mutate operation.
  932. CustomerConversionGoalOperation customer_conversion_goal_operation = 66;
  933. // An customer customizer mutate operation.
  934. CustomerCustomizerOperation customer_customizer_operation = 79;
  935. // A customer extension setting mutate operation.
  936. CustomerExtensionSettingOperation customer_extension_setting_operation = 30;
  937. // A customer feed mutate operation.
  938. CustomerFeedOperation customer_feed_operation = 31;
  939. // A customer label mutate operation.
  940. CustomerLabelOperation customer_label_operation = 32;
  941. // A customer negative criterion mutate operation.
  942. CustomerNegativeCriterionOperation customer_negative_criterion_operation = 34;
  943. // A customer mutate operation.
  944. CustomerOperation customer_operation = 35;
  945. // An customizer attribute mutate operation.
  946. CustomizerAttributeOperation customizer_attribute_operation = 70;
  947. // An experiment mutate operation.
  948. ExperimentOperation experiment_operation = 82;
  949. // An experiment arm mutate operation.
  950. ExperimentArmOperation experiment_arm_operation = 83;
  951. // An extension feed item mutate operation.
  952. ExtensionFeedItemOperation extension_feed_item_operation = 36;
  953. // A feed item mutate operation.
  954. FeedItemOperation feed_item_operation = 37;
  955. // A feed item set mutate operation.
  956. FeedItemSetOperation feed_item_set_operation = 53;
  957. // A feed item set link mutate operation.
  958. FeedItemSetLinkOperation feed_item_set_link_operation = 54;
  959. // A feed item target mutate operation.
  960. FeedItemTargetOperation feed_item_target_operation = 38;
  961. // A feed mapping mutate operation.
  962. FeedMappingOperation feed_mapping_operation = 39;
  963. // A feed mutate operation.
  964. FeedOperation feed_operation = 40;
  965. // A keyword plan ad group operation.
  966. KeywordPlanAdGroupOperation keyword_plan_ad_group_operation = 44;
  967. // A keyword plan ad group keyword operation.
  968. KeywordPlanAdGroupKeywordOperation keyword_plan_ad_group_keyword_operation = 50;
  969. // A keyword plan campaign keyword operation.
  970. KeywordPlanCampaignKeywordOperation keyword_plan_campaign_keyword_operation = 51;
  971. // A keyword plan campaign operation.
  972. KeywordPlanCampaignOperation keyword_plan_campaign_operation = 45;
  973. // A keyword plan operation.
  974. KeywordPlanOperation keyword_plan_operation = 48;
  975. // A label mutate operation.
  976. LabelOperation label_operation = 41;
  977. // A media file mutate operation.
  978. MediaFileOperation media_file_operation = 42;
  979. // A remarketing action mutate operation.
  980. RemarketingActionOperation remarketing_action_operation = 43;
  981. // A shared criterion mutate operation.
  982. SharedCriterionOperation shared_criterion_operation = 14;
  983. // A shared set mutate operation.
  984. SharedSetOperation shared_set_operation = 15;
  985. // A Smart campaign setting mutate operation.
  986. SmartCampaignSettingOperation smart_campaign_setting_operation = 61;
  987. // A user list mutate operation.
  988. UserListOperation user_list_operation = 16;
  989. }
  990. }
  991. // Response message for the resource mutate.
  992. message MutateOperationResponse {
  993. // The mutate response.
  994. oneof response {
  995. // The result for the ad group ad label mutate.
  996. MutateAdGroupAdLabelResult ad_group_ad_label_result = 17;
  997. // The result for the ad group ad mutate.
  998. MutateAdGroupAdResult ad_group_ad_result = 1;
  999. // The result for the ad group asset mutate.
  1000. MutateAdGroupAssetResult ad_group_asset_result = 56;
  1001. // The result for the ad group bid modifier mutate.
  1002. MutateAdGroupBidModifierResult ad_group_bid_modifier_result = 2;
  1003. // The result for the ad group criterion customizer mutate.
  1004. MutateAdGroupCriterionCustomizerResult ad_group_criterion_customizer_result = 77;
  1005. // The result for the ad group criterion label mutate.
  1006. MutateAdGroupCriterionLabelResult ad_group_criterion_label_result = 18;
  1007. // The result for the ad group criterion mutate.
  1008. MutateAdGroupCriterionResult ad_group_criterion_result = 3;
  1009. // The result for the ad group customizer mutate.
  1010. MutateAdGroupCustomizerResult ad_group_customizer_result = 75;
  1011. // The result for the ad group extension setting mutate.
  1012. MutateAdGroupExtensionSettingResult ad_group_extension_setting_result = 19;
  1013. // The result for the ad group feed mutate.
  1014. MutateAdGroupFeedResult ad_group_feed_result = 20;
  1015. // The result for the ad group label mutate.
  1016. MutateAdGroupLabelResult ad_group_label_result = 21;
  1017. // The result for the ad group mutate.
  1018. MutateAdGroupResult ad_group_result = 5;
  1019. // The result for the ad parameter mutate.
  1020. MutateAdParameterResult ad_parameter_result = 22;
  1021. // The result for the ad mutate.
  1022. MutateAdResult ad_result = 49;
  1023. // The result for the asset mutate.
  1024. MutateAssetResult asset_result = 23;
  1025. // The result for the asset group asset mutate.
  1026. MutateAssetGroupAssetResult asset_group_asset_result = 65;
  1027. // The result for the asset group listing group filter mutate.
  1028. MutateAssetGroupListingGroupFilterResult asset_group_listing_group_filter_result = 78;
  1029. // The result for the asset group signal mutate.
  1030. MutateAssetGroupSignalResult asset_group_signal_result = 79;
  1031. // The result for the asset group mutate.
  1032. MutateAssetGroupResult asset_group_result = 62;
  1033. // The result for the asset set asset mutate.
  1034. MutateAssetSetAssetResult asset_set_asset_result = 71;
  1035. // The result for the asset set mutate.
  1036. MutateAssetSetResult asset_set_result = 72;
  1037. // The result for the audience mutate.
  1038. MutateAudienceResult audience_result = 80;
  1039. // The result for the bidding data exclusion mutate.
  1040. MutateBiddingDataExclusionsResult bidding_data_exclusion_result = 58;
  1041. // The result for the bidding seasonality adjustment mutate.
  1042. MutateBiddingSeasonalityAdjustmentsResult bidding_seasonality_adjustment_result = 59;
  1043. // The result for the bidding strategy mutate.
  1044. MutateBiddingStrategyResult bidding_strategy_result = 6;
  1045. // The result for the campaign asset mutate.
  1046. MutateCampaignAssetResult campaign_asset_result = 52;
  1047. // The result for the campaign asset set mutate.
  1048. MutateCampaignAssetSetResult campaign_asset_set_result = 73;
  1049. // The result for the campaign bid modifier mutate.
  1050. MutateCampaignBidModifierResult campaign_bid_modifier_result = 7;
  1051. // The result for the campaign budget mutate.
  1052. MutateCampaignBudgetResult campaign_budget_result = 8;
  1053. // The result for the campaign conversion goal mutate.
  1054. MutateCampaignConversionGoalResult campaign_conversion_goal_result = 67;
  1055. // The result for the campaign criterion mutate.
  1056. MutateCampaignCriterionResult campaign_criterion_result = 13;
  1057. // The result for the campaign customizer mutate.
  1058. MutateCampaignCustomizerResult campaign_customizer_result = 76;
  1059. // The result for the campaign draft mutate.
  1060. MutateCampaignDraftResult campaign_draft_result = 24;
  1061. // The result for the campaign experiment mutate.
  1062. MutateCampaignExperimentResult campaign_experiment_result = 25;
  1063. // The result for the campaign extension setting mutate.
  1064. MutateCampaignExtensionSettingResult campaign_extension_setting_result = 26;
  1065. // The result for the campaign feed mutate.
  1066. MutateCampaignFeedResult campaign_feed_result = 27;
  1067. // The result for the campaign group mutate.
  1068. MutateCampaignGroupResult campaign_group_result = 9;
  1069. // The result for the campaign label mutate.
  1070. MutateCampaignLabelResult campaign_label_result = 28;
  1071. // The result for the campaign mutate.
  1072. MutateCampaignResult campaign_result = 10;
  1073. // The result for the campaign shared set mutate.
  1074. MutateCampaignSharedSetResult campaign_shared_set_result = 11;
  1075. // The result for the conversion action mutate.
  1076. MutateConversionActionResult conversion_action_result = 12;
  1077. // The result for the conversion custom variable mutate.
  1078. MutateConversionCustomVariableResult conversion_custom_variable_result = 55;
  1079. // The result for the conversion goal campaign config mutate.
  1080. MutateConversionGoalCampaignConfigResult conversion_goal_campaign_config_result = 69;
  1081. // The result for the conversion value rule mutate.
  1082. MutateConversionValueRuleResult conversion_value_rule_result = 63;
  1083. // The result for the conversion value rule set mutate.
  1084. MutateConversionValueRuleSetResult conversion_value_rule_set_result = 64;
  1085. // The result for the custom conversion goal mutate.
  1086. MutateCustomConversionGoalResult custom_conversion_goal_result = 68;
  1087. // The result for the customer asset mutate.
  1088. MutateCustomerAssetResult customer_asset_result = 57;
  1089. // The result for the customer conversion goal mutate.
  1090. MutateCustomerConversionGoalResult customer_conversion_goal_result = 66;
  1091. // The result for the customer customizer mutate.
  1092. MutateCustomerCustomizerResult customer_customizer_result = 74;
  1093. // The result for the customer extension setting mutate.
  1094. MutateCustomerExtensionSettingResult customer_extension_setting_result = 30;
  1095. // The result for the customer feed mutate.
  1096. MutateCustomerFeedResult customer_feed_result = 31;
  1097. // The result for the customer label mutate.
  1098. MutateCustomerLabelResult customer_label_result = 32;
  1099. // The result for the customer negative criterion mutate.
  1100. MutateCustomerNegativeCriteriaResult customer_negative_criterion_result = 34;
  1101. // The result for the customer mutate.
  1102. MutateCustomerResult customer_result = 35;
  1103. // The result for the customizer attribute mutate.
  1104. MutateCustomizerAttributeResult customizer_attribute_result = 70;
  1105. // The result for the extension feed item mutate.
  1106. MutateExtensionFeedItemResult extension_feed_item_result = 36;
  1107. // The result for the feed item mutate.
  1108. MutateFeedItemResult feed_item_result = 37;
  1109. // The result for the feed item set mutate.
  1110. MutateFeedItemSetResult feed_item_set_result = 53;
  1111. // The result for the feed item set link mutate.
  1112. MutateFeedItemSetLinkResult feed_item_set_link_result = 54;
  1113. // The result for the feed item target mutate.
  1114. MutateFeedItemTargetResult feed_item_target_result = 38;
  1115. // The result for the feed mapping mutate.
  1116. MutateFeedMappingResult feed_mapping_result = 39;
  1117. // The result for the feed mutate.
  1118. MutateFeedResult feed_result = 40;
  1119. // The result for the keyword plan ad group mutate.
  1120. MutateKeywordPlanAdGroupResult keyword_plan_ad_group_result = 44;
  1121. // The result for the keyword plan campaign mutate.
  1122. MutateKeywordPlanCampaignResult keyword_plan_campaign_result = 45;
  1123. // The result for the keyword plan ad group keyword mutate.
  1124. MutateKeywordPlanAdGroupKeywordResult keyword_plan_ad_group_keyword_result = 50;
  1125. // The result for the keyword plan campaign keyword mutate.
  1126. MutateKeywordPlanCampaignKeywordResult keyword_plan_campaign_keyword_result = 51;
  1127. // The result for the keyword plan mutate.
  1128. MutateKeywordPlansResult keyword_plan_result = 48;
  1129. // The result for the label mutate.
  1130. MutateLabelResult label_result = 41;
  1131. // The result for the media file mutate.
  1132. MutateMediaFileResult media_file_result = 42;
  1133. // The result for the remarketing action mutate.
  1134. MutateRemarketingActionResult remarketing_action_result = 43;
  1135. // The result for the shared criterion mutate.
  1136. MutateSharedCriterionResult shared_criterion_result = 14;
  1137. // The result for the shared set mutate.
  1138. MutateSharedSetResult shared_set_result = 15;
  1139. // The result for the Smart campaign setting mutate.
  1140. MutateSmartCampaignSettingResult smart_campaign_setting_result = 61;
  1141. // The result for the user list mutate.
  1142. MutateUserListResult user_list_result = 16;
  1143. }
  1144. }