google-ads-googleads 0.6.0 → 0.7.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (223) hide show
  1. checksums.yaml +4 -4
  2. data/ChangeLog +4 -0
  3. data/google_ads_config.rb +9 -0
  4. data/lib/google/ads/google_ads/config.rb +2 -0
  5. data/lib/google/ads/google_ads/google_ads_client.rb +13 -1
  6. data/lib/google/ads/google_ads/path_lookup_util.rb +115 -0
  7. data/lib/google/ads/google_ads/proto_lookup_util.rb +237 -3
  8. data/lib/google/ads/google_ads/v0/common/ad_type_infos_pb.rb +37 -0
  9. data/lib/google/ads/google_ads/v0/common/criteria_pb.rb +34 -0
  10. data/lib/google/ads/google_ads/v0/common/criterion_category_availability_pb.rb +41 -0
  11. data/lib/google/ads/google_ads/v0/common/dates_pb.rb +24 -0
  12. data/lib/google/ads/google_ads/v0/common/explorer_auto_optimizer_setting_pb.rb +23 -0
  13. data/lib/google/ads/google_ads/v0/common/feed_common_pb.rb +24 -0
  14. data/lib/google/ads/google_ads/v0/common/frequency_cap_pb.rb +34 -0
  15. data/lib/google/ads/google_ads/v0/common/keyword_plan_common_pb.rb +25 -0
  16. data/lib/google/ads/google_ads/v0/common/matching_function_pb.rb +23 -0
  17. data/lib/google/ads/google_ads/v0/common/metrics_pb.rb +3 -0
  18. data/lib/google/ads/google_ads/v0/common/real_time_bidding_setting_pb.rb +23 -0
  19. data/lib/google/ads/google_ads/v0/common/user_lists_pb.rb +31 -0
  20. data/lib/google/ads/google_ads/v0/enums/access_reason_pb.rb +31 -0
  21. data/lib/google/ads/google_ads/v0/enums/ad_customizer_placeholder_field_pb.rb +30 -0
  22. data/lib/google/ads/google_ads/v0/enums/ad_type_pb.rb +3 -1
  23. data/lib/google/ads/google_ads/v0/enums/affiliate_location_feed_relationship_type_pb.rb +27 -0
  24. data/lib/google/ads/google_ads/v0/enums/app_placeholder_field_pb.rb +34 -0
  25. data/lib/google/ads/google_ads/v0/enums/call_placeholder_field_pb.rb +31 -0
  26. data/lib/google/ads/google_ads/v0/enums/callout_placeholder_field_pb.rb +27 -0
  27. data/lib/google/ads/google_ads/v0/enums/content_label_type_pb.rb +41 -0
  28. data/lib/google/ads/google_ads/v0/enums/criterion_category_channel_availability_mode_pb.rb +29 -0
  29. data/lib/google/ads/google_ads/v0/enums/criterion_category_locale_availability_mode_pb.rb +30 -0
  30. data/lib/google/ads/google_ads/v0/enums/criterion_type_pb.rb +7 -0
  31. data/lib/google/ads/google_ads/v0/enums/custom_placeholder_field_pb.rb +46 -0
  32. data/lib/google/ads/google_ads/v0/enums/customer_match_upload_key_type_pb.rb +29 -0
  33. data/lib/google/ads/google_ads/v0/enums/education_placeholder_field_pb.rb +43 -0
  34. data/lib/google/ads/google_ads/v0/enums/feed_attribute_type_pb.rb +39 -0
  35. data/lib/google/ads/google_ads/v0/enums/feed_item_status_pb.rb +28 -0
  36. data/lib/google/ads/google_ads/v0/enums/feed_link_status_pb.rb +28 -0
  37. data/lib/google/ads/google_ads/v0/enums/feed_mapping_criterion_type_pb.rb +28 -0
  38. data/lib/google/ads/google_ads/v0/enums/feed_mapping_status_pb.rb +28 -0
  39. data/lib/google/ads/google_ads/v0/enums/feed_origin_pb.rb +28 -0
  40. data/lib/google/ads/google_ads/v0/enums/feed_status_pb.rb +28 -0
  41. data/lib/google/ads/google_ads/v0/enums/flight_placeholder_field_pb.rb +43 -0
  42. data/lib/google/ads/google_ads/v0/enums/frequency_cap_event_type_pb.rb +28 -0
  43. data/lib/google/ads/google_ads/v0/enums/frequency_cap_level_pb.rb +29 -0
  44. data/lib/google/ads/google_ads/v0/enums/frequency_cap_time_unit_pb.rb +29 -0
  45. data/lib/google/ads/google_ads/v0/enums/geo_targeting_restriction_pb.rb +27 -0
  46. data/lib/google/ads/google_ads/v0/enums/hotel_placeholder_field_pb.rb +46 -0
  47. data/lib/google/ads/google_ads/v0/enums/job_placeholder_field_pb.rb +43 -0
  48. data/lib/google/ads/google_ads/v0/enums/keyword_plan_competition_level_pb.rb +29 -0
  49. data/lib/google/ads/google_ads/v0/enums/keyword_plan_forecast_interval_pb.rb +29 -0
  50. data/lib/google/ads/google_ads/v0/enums/keyword_plan_network_pb.rb +28 -0
  51. data/lib/google/ads/google_ads/v0/enums/local_placeholder_field_pb.rb +45 -0
  52. data/lib/google/ads/google_ads/v0/enums/message_placeholder_field_pb.rb +31 -0
  53. data/lib/google/ads/google_ads/v0/enums/placeholder_type_pb.rb +45 -0
  54. data/lib/google/ads/google_ads/v0/enums/preferred_content_type_pb.rb +27 -0
  55. data/lib/google/ads/google_ads/v0/enums/price_placeholder_field_pb.rb +79 -0
  56. data/lib/google/ads/google_ads/v0/enums/product_condition_pb.rb +0 -1
  57. data/lib/google/ads/google_ads/v0/enums/promotion_placeholder_field_pb.rb +40 -0
  58. data/lib/google/ads/google_ads/v0/enums/real_estate_placeholder_field_pb.rb +44 -0
  59. data/lib/google/ads/google_ads/v0/enums/search_term_match_type_pb.rb +31 -0
  60. data/lib/google/ads/google_ads/v0/enums/search_term_targeting_status_pb.rb +30 -0
  61. data/lib/google/ads/google_ads/v0/enums/sitelink_placeholder_field_pb.rb +33 -0
  62. data/lib/google/ads/google_ads/v0/enums/structured_snippet_placeholder_field_pb.rb +28 -0
  63. data/lib/google/ads/google_ads/v0/enums/targeting_dimension_pb.rb +34 -0
  64. data/lib/google/ads/google_ads/v0/enums/tracking_code_page_format_pb.rb +1 -0
  65. data/lib/google/ads/google_ads/v0/enums/travel_placeholder_field_pb.rb +46 -0
  66. data/lib/google/ads/google_ads/v0/enums/user_interest_taxonomy_type_pb.rb +31 -0
  67. data/lib/google/ads/google_ads/v0/enums/user_list_access_status_pb.rb +28 -0
  68. data/lib/google/ads/google_ads/v0/enums/user_list_closing_reason_pb.rb +27 -0
  69. data/lib/google/ads/google_ads/v0/enums/user_list_crm_data_source_type_pb.rb +29 -0
  70. data/lib/google/ads/google_ads/v0/enums/user_list_membership_status_pb.rb +28 -0
  71. data/lib/google/ads/google_ads/v0/enums/user_list_size_range_pb.rb +42 -0
  72. data/lib/google/ads/google_ads/v0/enums/user_list_type_pb.rb +32 -0
  73. data/lib/google/ads/google_ads/v0/errors/ad_group_feed_error_pb.rb +33 -0
  74. data/lib/google/ads/google_ads/v0/errors/authentication_error_pb.rb +1 -2
  75. data/lib/google/ads/google_ads/v0/errors/campaign_feed_error_pb.rb +32 -0
  76. data/lib/google/ads/google_ads/v0/errors/customer_error_pb.rb +1 -0
  77. data/lib/google/ads/google_ads/v0/errors/customer_feed_error_pb.rb +33 -0
  78. data/lib/google/ads/google_ads/v0/errors/date_error_pb.rb +2 -1
  79. data/lib/google/ads/google_ads/v0/errors/errors_pb.rb +26 -0
  80. data/lib/google/ads/google_ads/v0/errors/feed_error_pb.rb +45 -0
  81. data/lib/google/ads/google_ads/v0/errors/feed_item_error_pb.rb +35 -0
  82. data/lib/google/ads/google_ads/v0/errors/feed_mapping_error_pb.rb +42 -0
  83. data/lib/google/ads/google_ads/v0/errors/header_error_pb.rb +1 -0
  84. data/lib/google/ads/google_ads/v0/errors/keyword_plan_ad_group_error_pb.rb +28 -0
  85. data/lib/google/ads/google_ads/v0/errors/keyword_plan_campaign_error_pb.rb +31 -0
  86. data/lib/google/ads/google_ads/v0/errors/keyword_plan_error_pb.rb +40 -0
  87. data/lib/google/ads/google_ads/v0/errors/keyword_plan_idea_error_pb.rb +28 -0
  88. data/lib/google/ads/google_ads/v0/errors/keyword_plan_keyword_error_pb.rb +32 -0
  89. data/lib/google/ads/google_ads/v0/errors/keyword_plan_negative_keyword_error_pb.rb +26 -0
  90. data/lib/google/ads/google_ads/v0/errors/new_resource_creation_error_pb.rb +1 -1
  91. data/lib/google/ads/google_ads/v0/errors/operation_access_denied_error_pb.rb +1 -0
  92. data/lib/google/ads/google_ads/v0/errors/recommendation_error_pb.rb +5 -0
  93. data/lib/google/ads/google_ads/v0/errors/url_field_error_pb.rb +5 -0
  94. data/lib/google/ads/google_ads/v0/errors/user_list_error_pb.rb +49 -0
  95. data/lib/google/ads/google_ads/v0/resources/ad_group_bid_modifier_pb.rb +1 -0
  96. data/lib/google/ads/google_ads/v0/resources/ad_group_criterion_pb.rb +2 -0
  97. data/lib/google/ads/google_ads/v0/resources/ad_group_feed_pb.rb +31 -0
  98. data/lib/google/ads/google_ads/v0/resources/ad_group_pb.rb +5 -0
  99. data/lib/google/ads/google_ads/v0/resources/ad_pb.rb +3 -0
  100. data/lib/google/ads/google_ads/v0/resources/billing_setup_pb.rb +4 -0
  101. data/lib/google/ads/google_ads/v0/resources/campaign_audience_view_pb.rb +22 -0
  102. data/lib/google/ads/google_ads/v0/resources/campaign_budget_pb.rb +1 -0
  103. data/lib/google/ads/google_ads/v0/resources/campaign_criterion_pb.rb +7 -0
  104. data/lib/google/ads/google_ads/v0/resources/campaign_feed_pb.rb +31 -0
  105. data/lib/google/ads/google_ads/v0/resources/campaign_pb.rb +4 -0
  106. data/lib/google/ads/google_ads/v0/resources/carrier_constant_pb.rb +26 -0
  107. data/lib/google/ads/google_ads/v0/resources/customer_client_pb.rb +26 -0
  108. data/lib/google/ads/google_ads/v0/resources/customer_feed_pb.rb +30 -0
  109. data/lib/google/ads/google_ads/v0/resources/customer_pb.rb +1 -0
  110. data/lib/google/ads/google_ads/v0/resources/feed_item_pb.rb +48 -0
  111. data/lib/google/ads/google_ads/v0/resources/feed_mapping_pb.rb +74 -0
  112. data/lib/google/ads/google_ads/v0/resources/feed_pb.rb +75 -0
  113. data/lib/google/ads/google_ads/v0/resources/hotel_performance_view_pb.rb +22 -0
  114. data/lib/google/ads/google_ads/v0/resources/keyword_plan_ad_group_pb.rb +27 -0
  115. data/lib/google/ads/google_ads/v0/resources/keyword_plan_campaign_pb.rb +35 -0
  116. data/lib/google/ads/google_ads/v0/resources/keyword_plan_keyword_pb.rb +29 -0
  117. data/lib/google/ads/google_ads/v0/resources/keyword_plan_negative_keyword_pb.rb +28 -0
  118. data/lib/google/ads/google_ads/v0/resources/keyword_plan_pb.rb +35 -0
  119. data/lib/google/ads/google_ads/v0/resources/language_constant_pb.rb +26 -0
  120. data/lib/google/ads/google_ads/v0/resources/payments_account_pb.rb +28 -0
  121. data/lib/google/ads/google_ads/v0/resources/search_term_view_pb.rb +27 -0
  122. data/lib/google/ads/google_ads/v0/resources/user_interest_pb.rb +31 -0
  123. data/lib/google/ads/google_ads/v0/resources/user_list_pb.rb +51 -0
  124. data/lib/google/ads/google_ads/v0/services/ad_group_feed_service_client.rb +268 -0
  125. data/lib/google/ads/google_ads/v0/services/ad_group_feed_service_client_config.json +36 -0
  126. data/lib/google/ads/google_ads/v0/services/ad_group_feed_service_pb.rb +47 -0
  127. data/lib/google/ads/google_ads/v0/services/ad_group_feed_service_services_pb.rb +51 -0
  128. data/lib/google/ads/google_ads/v0/services/campaign_audience_view_service_client.rb +221 -0
  129. data/lib/google/ads/google_ads/v0/services/campaign_audience_view_service_client_config.json +31 -0
  130. data/lib/google/ads/google_ads/v0/services/campaign_audience_view_service_pb.rb +24 -0
  131. data/lib/google/ads/google_ads/v0/services/campaign_audience_view_service_services_pb.rb +48 -0
  132. data/lib/google/ads/google_ads/v0/services/campaign_feed_service_client.rb +268 -0
  133. data/lib/google/ads/google_ads/v0/services/campaign_feed_service_client_config.json +36 -0
  134. data/lib/google/ads/google_ads/v0/services/campaign_feed_service_pb.rb +47 -0
  135. data/lib/google/ads/google_ads/v0/services/campaign_feed_service_services_pb.rb +51 -0
  136. data/lib/google/ads/google_ads/v0/services/carrier_constant_service_client.rb +219 -0
  137. data/lib/google/ads/google_ads/v0/services/carrier_constant_service_client_config.json +31 -0
  138. data/lib/google/ads/google_ads/v0/services/carrier_constant_service_pb.rb +24 -0
  139. data/lib/google/ads/google_ads/v0/services/carrier_constant_service_services_pb.rb +48 -0
  140. data/lib/google/ads/google_ads/v0/services/customer_client_service_client.rb +221 -0
  141. data/lib/google/ads/google_ads/v0/services/customer_client_service_client_config.json +31 -0
  142. data/lib/google/ads/google_ads/v0/services/customer_client_service_pb.rb +24 -0
  143. data/lib/google/ads/google_ads/v0/services/customer_client_service_services_pb.rb +48 -0
  144. data/lib/google/ads/google_ads/v0/services/customer_feed_service_client.rb +268 -0
  145. data/lib/google/ads/google_ads/v0/services/customer_feed_service_client_config.json +36 -0
  146. data/lib/google/ads/google_ads/v0/services/customer_feed_service_pb.rb +47 -0
  147. data/lib/google/ads/google_ads/v0/services/customer_feed_service_services_pb.rb +51 -0
  148. data/lib/google/ads/google_ads/v0/services/customer_service_client.rb +93 -0
  149. data/lib/google/ads/google_ads/v0/services/customer_service_client_config.json +10 -0
  150. data/lib/google/ads/google_ads/v0/services/customer_service_pb.rb +28 -0
  151. data/lib/google/ads/google_ads/v0/services/customer_service_services_pb.rb +4 -0
  152. data/lib/google/ads/google_ads/v0/services/feed_item_service_client.rb +268 -0
  153. data/lib/google/ads/google_ads/v0/services/feed_item_service_client_config.json +36 -0
  154. data/lib/google/ads/google_ads/v0/services/feed_item_service_pb.rb +47 -0
  155. data/lib/google/ads/google_ads/v0/services/feed_item_service_services_pb.rb +51 -0
  156. data/lib/google/ads/google_ads/v0/services/feed_mapping_service_client.rb +268 -0
  157. data/lib/google/ads/google_ads/v0/services/feed_mapping_service_client_config.json +36 -0
  158. data/lib/google/ads/google_ads/v0/services/feed_mapping_service_pb.rb +44 -0
  159. data/lib/google/ads/google_ads/v0/services/feed_mapping_service_services_pb.rb +51 -0
  160. data/lib/google/ads/google_ads/v0/services/feed_service_client.rb +268 -0
  161. data/lib/google/ads/google_ads/v0/services/feed_service_client_config.json +36 -0
  162. data/lib/google/ads/google_ads/v0/services/feed_service_pb.rb +47 -0
  163. data/lib/google/ads/google_ads/v0/services/feed_service_services_pb.rb +51 -0
  164. data/lib/google/ads/google_ads/v0/services/geo_target_constant_service_client.rb +10 -1
  165. data/lib/google/ads/google_ads/v0/services/geo_target_constant_service_pb.rb +1 -0
  166. data/lib/google/ads/google_ads/v0/services/google_ads_service_client.rb +46 -0
  167. data/lib/google/ads/google_ads/v0/services/google_ads_service_client_config.json +5 -0
  168. data/lib/google/ads/google_ads/v0/services/google_ads_service_pb.rb +118 -0
  169. data/lib/google/ads/google_ads/v0/services/google_ads_service_services_pb.rb +2 -0
  170. data/lib/google/ads/google_ads/v0/services/hotel_performance_view_service_client.rb +219 -0
  171. data/lib/google/ads/google_ads/v0/services/hotel_performance_view_service_client_config.json +31 -0
  172. data/lib/google/ads/google_ads/v0/services/hotel_performance_view_service_pb.rb +24 -0
  173. data/lib/google/ads/google_ads/v0/services/hotel_performance_view_service_services_pb.rb +48 -0
  174. data/lib/google/ads/google_ads/v0/services/keyword_plan_ad_group_service_client.rb +268 -0
  175. data/lib/google/ads/google_ads/v0/services/keyword_plan_ad_group_service_client_config.json +36 -0
  176. data/lib/google/ads/google_ads/v0/services/keyword_plan_ad_group_service_pb.rb +47 -0
  177. data/lib/google/ads/google_ads/v0/services/keyword_plan_ad_group_service_services_pb.rb +51 -0
  178. data/lib/google/ads/google_ads/v0/services/keyword_plan_campaign_service_client.rb +268 -0
  179. data/lib/google/ads/google_ads/v0/services/keyword_plan_campaign_service_client_config.json +36 -0
  180. data/lib/google/ads/google_ads/v0/services/keyword_plan_campaign_service_pb.rb +47 -0
  181. data/lib/google/ads/google_ads/v0/services/keyword_plan_campaign_service_services_pb.rb +51 -0
  182. data/lib/google/ads/google_ads/v0/services/keyword_plan_idea_service_client.rb +252 -0
  183. data/lib/google/ads/google_ads/v0/services/keyword_plan_idea_service_client_config.json +31 -0
  184. data/lib/google/ads/google_ads/v0/services/keyword_plan_idea_service_pb.rb +56 -0
  185. data/lib/google/ads/google_ads/v0/services/keyword_plan_idea_service_services_pb.rb +48 -0
  186. data/lib/google/ads/google_ads/v0/services/keyword_plan_keyword_service_client.rb +268 -0
  187. data/lib/google/ads/google_ads/v0/services/keyword_plan_keyword_service_client_config.json +36 -0
  188. data/lib/google/ads/google_ads/v0/services/keyword_plan_keyword_service_pb.rb +47 -0
  189. data/lib/google/ads/google_ads/v0/services/keyword_plan_keyword_service_services_pb.rb +51 -0
  190. data/lib/google/ads/google_ads/v0/services/keyword_plan_negative_keyword_service_client.rb +269 -0
  191. data/lib/google/ads/google_ads/v0/services/keyword_plan_negative_keyword_service_client_config.json +36 -0
  192. data/lib/google/ads/google_ads/v0/services/keyword_plan_negative_keyword_service_pb.rb +47 -0
  193. data/lib/google/ads/google_ads/v0/services/keyword_plan_negative_keyword_service_services_pb.rb +51 -0
  194. data/lib/google/ads/google_ads/v0/services/keyword_plan_service_client.rb +339 -0
  195. data/lib/google/ads/google_ads/v0/services/keyword_plan_service_client_config.json +46 -0
  196. data/lib/google/ads/google_ads/v0/services/keyword_plan_service_pb.rb +95 -0
  197. data/lib/google/ads/google_ads/v0/services/keyword_plan_service_services_pb.rb +55 -0
  198. data/lib/google/ads/google_ads/v0/services/language_constant_service_client.rb +219 -0
  199. data/lib/google/ads/google_ads/v0/services/language_constant_service_client_config.json +31 -0
  200. data/lib/google/ads/google_ads/v0/services/language_constant_service_pb.rb +24 -0
  201. data/lib/google/ads/google_ads/v0/services/language_constant_service_services_pb.rb +48 -0
  202. data/lib/google/ads/google_ads/v0/services/payments_account_service_client.rb +209 -0
  203. data/lib/google/ads/google_ads/v0/services/payments_account_service_client_config.json +31 -0
  204. data/lib/google/ads/google_ads/v0/services/payments_account_service_pb.rb +28 -0
  205. data/lib/google/ads/google_ads/v0/services/payments_account_service_services_pb.rb +51 -0
  206. data/lib/google/ads/google_ads/v0/services/recommendation_service_client.rb +71 -1
  207. data/lib/google/ads/google_ads/v0/services/recommendation_service_client_config.json +5 -0
  208. data/lib/google/ads/google_ads/v0/services/recommendation_service_pb.rb +22 -4
  209. data/lib/google/ads/google_ads/v0/services/recommendation_service_services_pb.rb +2 -0
  210. data/lib/google/ads/google_ads/v0/services/search_term_view_service_client.rb +221 -0
  211. data/lib/google/ads/google_ads/v0/services/search_term_view_service_client_config.json +31 -0
  212. data/lib/google/ads/google_ads/v0/services/search_term_view_service_pb.rb +24 -0
  213. data/lib/google/ads/google_ads/v0/services/search_term_view_service_services_pb.rb +48 -0
  214. data/lib/google/ads/google_ads/v0/services/user_interest_service_client.rb +221 -0
  215. data/lib/google/ads/google_ads/v0/services/user_interest_service_client_config.json +31 -0
  216. data/lib/google/ads/google_ads/v0/services/user_interest_service_pb.rb +24 -0
  217. data/lib/google/ads/google_ads/v0/services/user_interest_service_services_pb.rb +48 -0
  218. data/lib/google/ads/google_ads/v0/services/user_list_service_client.rb +267 -0
  219. data/lib/google/ads/google_ads/v0/services/user_list_service_client_config.json +36 -0
  220. data/lib/google/ads/google_ads/v0/services/user_list_service_pb.rb +47 -0
  221. data/lib/google/ads/google_ads/v0/services/user_list_service_services_pb.rb +50 -0
  222. data/lib/google/ads/google_ads/version.rb +1 -1
  223. metadata +179 -4
@@ -0,0 +1,252 @@
1
+ # Copyright 2018 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
+ # https://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
+ #
15
+ # EDITING INSTRUCTIONS
16
+ # This file was generated from the file
17
+ # https://github.com/googleapis/googleapis/blob/master/google/ads/google_ads/v0/services/keyword_plan_idea_service.proto,
18
+ # and updates to that file get reflected here through a refresh process.
19
+ # For the short term, the refresh process will only be runnable by Google
20
+ # engineers.
21
+
22
+ require "json"
23
+ require "pathname"
24
+
25
+ require "google/gax"
26
+
27
+ require "google/ads/google_ads/v0/services/keyword_plan_idea_service_pb"
28
+ require "google/ads/google_ads/v0/services/credentials"
29
+
30
+ module Google
31
+ module Ads
32
+ module GoogleAds
33
+ module V0
34
+ module Services
35
+ # Service to generate keyword ideas.
36
+ #
37
+ # @!attribute [r] keyword_plan_idea_service_stub
38
+ # @return [Google::Ads::GoogleAds::V0::Services::KeywordPlanIdeaService::Stub]
39
+ class KeywordPlanIdeaServiceClient
40
+ attr_reader :keyword_plan_idea_service_stub
41
+
42
+ # The default address of the service.
43
+ SERVICE_ADDRESS = "googleads.googleapis.com".freeze
44
+
45
+ # The default port of the service.
46
+ DEFAULT_SERVICE_PORT = 443
47
+
48
+ # The default set of gRPC interceptors.
49
+ GRPC_INTERCEPTORS = []
50
+
51
+ DEFAULT_TIMEOUT = 30
52
+
53
+ # The scopes needed to make gRPC calls to all of the methods defined in
54
+ # this service.
55
+ ALL_SCOPES = [
56
+ ].freeze
57
+
58
+
59
+ # @param credentials [Google::Auth::Credentials, String, Hash, GRPC::Core::Channel, GRPC::Core::ChannelCredentials, Proc]
60
+ # Provides the means for authenticating requests made by the client. This parameter can
61
+ # be many types.
62
+ # A `Google::Auth::Credentials` uses a the properties of its represented keyfile for
63
+ # authenticating requests made by this client.
64
+ # A `String` will be treated as the path to the keyfile to be used for the construction of
65
+ # credentials for this client.
66
+ # A `Hash` will be treated as the contents of a keyfile to be used for the construction of
67
+ # credentials for this client.
68
+ # A `GRPC::Core::Channel` will be used to make calls through.
69
+ # A `GRPC::Core::ChannelCredentials` for the setting up the RPC client. The channel credentials
70
+ # should already be composed with a `GRPC::Core::CallCredentials` object.
71
+ # A `Proc` will be used as an updater_proc for the Grpc channel. The proc transforms the
72
+ # metadata for requests, generally, to give OAuth credentials.
73
+ # @param scopes [Array<String>]
74
+ # The OAuth scopes for this service. This parameter is ignored if
75
+ # an updater_proc is supplied.
76
+ # @param client_config [Hash]
77
+ # A Hash for call options for each method. See
78
+ # Google::Gax#construct_settings for the structure of
79
+ # this data. Falls back to the default config if not specified
80
+ # or the specified config is missing data points.
81
+ # @param timeout [Numeric]
82
+ # The default timeout, in seconds, for calls made through this client.
83
+ # @param metadata [Hash]
84
+ # Default metadata to be sent with each request. This can be overridden on a per call basis.
85
+ # @param exception_transformer [Proc]
86
+ # An optional proc that intercepts any exceptions raised during an API call to inject
87
+ # custom error handling.
88
+ def initialize \
89
+ credentials: nil,
90
+ scopes: ALL_SCOPES,
91
+ client_config: {},
92
+ timeout: DEFAULT_TIMEOUT,
93
+ metadata: nil,
94
+ exception_transformer: nil,
95
+ lib_name: nil,
96
+ lib_version: ""
97
+ # These require statements are intentionally placed here to initialize
98
+ # the gRPC module only when it's required.
99
+ # See https://github.com/googleapis/toolkit/issues/446
100
+ require "google/gax/grpc"
101
+ require "google/ads/google_ads/v0/services/keyword_plan_idea_service_services_pb"
102
+
103
+ credentials ||= Google::Ads::GoogleAds::V0::Services::Credentials.default
104
+
105
+ if credentials.is_a?(String) || credentials.is_a?(Hash)
106
+ updater_proc = Google::Ads::GoogleAds::V0::Services::Credentials.new(credentials).updater_proc
107
+ end
108
+ if credentials.is_a?(GRPC::Core::Channel)
109
+ channel = credentials
110
+ end
111
+ if credentials.is_a?(GRPC::Core::ChannelCredentials)
112
+ chan_creds = credentials
113
+ end
114
+ if credentials.is_a?(Proc)
115
+ updater_proc = credentials
116
+ end
117
+ if credentials.is_a?(Google::Auth::Credentials)
118
+ updater_proc = credentials.updater_proc
119
+ end
120
+
121
+ package_version = Gem.loaded_specs['google-ads-googleads'].version.version
122
+
123
+ google_api_client = "gl-ruby/#{RUBY_VERSION}"
124
+ google_api_client << " #{lib_name}/#{lib_version}" if lib_name
125
+ google_api_client << " gapic/#{package_version} gax/#{Google::Gax::VERSION}"
126
+ google_api_client << " grpc/#{GRPC::VERSION}"
127
+ google_api_client.freeze
128
+
129
+ headers = { :"x-goog-api-client" => google_api_client }
130
+ headers.merge!(metadata) unless metadata.nil?
131
+ client_config_file = Pathname.new(__dir__).join(
132
+ "keyword_plan_idea_service_client_config.json"
133
+ )
134
+ defaults = client_config_file.open do |f|
135
+ Google::Gax.construct_settings(
136
+ "google.ads.googleads.v0.services.KeywordPlanIdeaService",
137
+ JSON.parse(f.read),
138
+ client_config,
139
+ Google::Gax::Grpc::STATUS_CODE_NAMES,
140
+ timeout,
141
+ errors: Google::Gax::Grpc::API_ERRORS,
142
+ metadata: headers
143
+ )
144
+ end
145
+
146
+ # Allow overriding the service path/port in subclasses.
147
+ service_path = self.class::SERVICE_ADDRESS
148
+ port = self.class::DEFAULT_SERVICE_PORT
149
+ interceptors = self.class::GRPC_INTERCEPTORS
150
+ @keyword_plan_idea_service_stub = Google::Gax::Grpc.create_stub(
151
+ service_path,
152
+ port,
153
+ chan_creds: chan_creds,
154
+ channel: channel,
155
+ updater_proc: updater_proc,
156
+ scopes: scopes,
157
+ interceptors: interceptors,
158
+ &Google::Ads::GoogleAds::V0::Services::KeywordPlanIdeaService::Stub.method(:new)
159
+ )
160
+
161
+ @generate_keyword_ideas = Google::Gax.create_api_call(
162
+ @keyword_plan_idea_service_stub.method(:generate_keyword_ideas),
163
+ defaults["generate_keyword_ideas"],
164
+ exception_transformer: exception_transformer
165
+ )
166
+ end
167
+
168
+ # Service calls
169
+
170
+ # Returns a list of keyword ideas.
171
+ #
172
+ # @param customer_id [String]
173
+ # The ID of the customer with the recommendation.
174
+ # @param language [Google::Protobuf::StringValue | Hash]
175
+ # The resource name of the language to target.
176
+ # Required
177
+ # A hash of the same form as `Google::Protobuf::StringValue`
178
+ # can also be provided.
179
+ # @param geo_target_constants [Array<Google::Protobuf::StringValue | Hash>]
180
+ # The resource names of the location to target.
181
+ # Max 10
182
+ # A hash of the same form as `Google::Protobuf::StringValue`
183
+ # can also be provided.
184
+ # @param keyword_plan_network [Google::Ads::GoogleAds::V0::Enums::KeywordPlanNetworkEnum::KeywordPlanNetwork]
185
+ # Targeting network.
186
+ # @param keyword_and_url_seed [Google::Ads::GoogleAds::V0::Services::KeywordAndUrlSeed | Hash]
187
+ # A Keyword and a specific Url to generate ideas from
188
+ # e.g. cars, www.example.com/cars.
189
+ # A hash of the same form as `Google::Ads::GoogleAds::V0::Services::KeywordAndUrlSeed`
190
+ # can also be provided.
191
+ # @param keyword_seed [Google::Ads::GoogleAds::V0::Services::KeywordSeed | Hash]
192
+ # A Keyword or phrase to generate ideas from, e.g. cars.
193
+ # A hash of the same form as `Google::Ads::GoogleAds::V0::Services::KeywordSeed`
194
+ # can also be provided.
195
+ # @param url_seed [Google::Ads::GoogleAds::V0::Services::UrlSeed | Hash]
196
+ # A specific url to generate ideas from, e.g. www.example.com/cars.
197
+ # A hash of the same form as `Google::Ads::GoogleAds::V0::Services::UrlSeed`
198
+ # can also be provided.
199
+ # @param options [Google::Gax::CallOptions]
200
+ # Overrides the default settings for this call, e.g, timeout,
201
+ # retries, etc.
202
+ # @yield [result, operation] Access the result along with the RPC operation
203
+ # @yieldparam result [Google::Ads::GoogleAds::V0::Services::GenerateKeywordIdeaResponse]
204
+ # @yieldparam operation [GRPC::ActiveCall::Operation]
205
+ # @return [Google::Ads::GoogleAds::V0::Services::GenerateKeywordIdeaResponse]
206
+ # @raise [Google::Gax::GaxError] if the RPC is aborted.
207
+ # @example
208
+ # require "google/ads/google_ads"
209
+ #
210
+ # keyword_plan_idea_service_client = Google::Ads::GoogleAds::KeywordPlanIdea.new(version: :v0)
211
+ #
212
+ # # TODO: Initialize +customer_id+:
213
+ # customer_id = ''
214
+ #
215
+ # # TODO: Initialize +language+:
216
+ # language = {}
217
+ #
218
+ # # TODO: Initialize +geo_target_constants+:
219
+ # geo_target_constants = []
220
+ #
221
+ # # TODO: Initialize +keyword_plan_network+:
222
+ # keyword_plan_network = :UNSPECIFIED
223
+ # response = keyword_plan_idea_service_client.generate_keyword_ideas(customer_id, language, geo_target_constants, keyword_plan_network)
224
+
225
+ def generate_keyword_ideas \
226
+ customer_id,
227
+ language,
228
+ geo_target_constants,
229
+ keyword_plan_network,
230
+ keyword_and_url_seed: nil,
231
+ keyword_seed: nil,
232
+ url_seed: nil,
233
+ options: nil,
234
+ &block
235
+ req = {
236
+ customer_id: customer_id,
237
+ language: language,
238
+ geo_target_constants: geo_target_constants,
239
+ keyword_plan_network: keyword_plan_network,
240
+ keyword_and_url_seed: keyword_and_url_seed,
241
+ keyword_seed: keyword_seed,
242
+ url_seed: url_seed
243
+ }.delete_if { |_, v| v.nil? }
244
+ req = Google::Gax::to_proto(req, Google::Ads::GoogleAds::V0::Services::GenerateKeywordIdeasRequest)
245
+ @generate_keyword_ideas.call(req, options, &block)
246
+ end
247
+ end
248
+ end
249
+ end
250
+ end
251
+ end
252
+ end
@@ -0,0 +1,31 @@
1
+ {
2
+ "interfaces": {
3
+ "google.ads.googleads.v0.services.KeywordPlanIdeaService": {
4
+ "retry_codes": {
5
+ "idempotent": [
6
+ "DEADLINE_EXCEEDED",
7
+ "UNAVAILABLE"
8
+ ],
9
+ "non_idempotent": []
10
+ },
11
+ "retry_params": {
12
+ "default": {
13
+ "initial_retry_delay_millis": 100,
14
+ "retry_delay_multiplier": 1.3,
15
+ "max_retry_delay_millis": 60000,
16
+ "initial_rpc_timeout_millis": 20000,
17
+ "rpc_timeout_multiplier": 1.0,
18
+ "max_rpc_timeout_millis": 20000,
19
+ "total_timeout_millis": 600000
20
+ }
21
+ },
22
+ "methods": {
23
+ "GenerateKeywordIdeas": {
24
+ "timeout_millis": 600000,
25
+ "retry_codes_name": "non_idempotent",
26
+ "retry_params_name": "default"
27
+ }
28
+ }
29
+ }
30
+ }
31
+ }
@@ -0,0 +1,56 @@
1
+ # Generated by the protocol buffer compiler. DO NOT EDIT!
2
+ # source: google/ads/google_ads/v0/services/keyword_plan_idea_service.proto
3
+
4
+ require 'google/protobuf'
5
+
6
+ require 'google/ads/google_ads/v0/common/keyword_plan_common_pb'
7
+ require 'google/ads/google_ads/v0/enums/keyword_plan_network_pb'
8
+ require 'google/api/annotations_pb'
9
+ require 'google/protobuf/wrappers_pb'
10
+ Google::Protobuf::DescriptorPool.generated_pool.build do
11
+ add_message "google.ads.googleads.v0.services.GenerateKeywordIdeasRequest" do
12
+ optional :customer_id, :string, 1
13
+ optional :language, :message, 7, "google.protobuf.StringValue"
14
+ repeated :geo_target_constants, :message, 8, "google.protobuf.StringValue"
15
+ optional :keyword_plan_network, :enum, 9, "google.ads.googleads.v0.enums.KeywordPlanNetworkEnum.KeywordPlanNetwork"
16
+ oneof :seed do
17
+ optional :keyword_and_url_seed, :message, 2, "google.ads.googleads.v0.services.KeywordAndUrlSeed"
18
+ optional :keyword_seed, :message, 3, "google.ads.googleads.v0.services.KeywordSeed"
19
+ optional :url_seed, :message, 5, "google.ads.googleads.v0.services.UrlSeed"
20
+ end
21
+ end
22
+ add_message "google.ads.googleads.v0.services.KeywordAndUrlSeed" do
23
+ optional :url, :message, 1, "google.protobuf.StringValue"
24
+ repeated :keywords, :message, 2, "google.protobuf.StringValue"
25
+ end
26
+ add_message "google.ads.googleads.v0.services.KeywordSeed" do
27
+ repeated :keywords, :message, 1, "google.protobuf.StringValue"
28
+ end
29
+ add_message "google.ads.googleads.v0.services.UrlSeed" do
30
+ optional :url, :message, 1, "google.protobuf.StringValue"
31
+ end
32
+ add_message "google.ads.googleads.v0.services.GenerateKeywordIdeaResponse" do
33
+ repeated :results, :message, 1, "google.ads.googleads.v0.services.GenerateKeywordIdeaResult"
34
+ end
35
+ add_message "google.ads.googleads.v0.services.GenerateKeywordIdeaResult" do
36
+ optional :text, :message, 2, "google.protobuf.StringValue"
37
+ optional :keyword_idea_metrics, :message, 3, "google.ads.googleads.v0.common.KeywordPlanHistoricalMetrics"
38
+ end
39
+ end
40
+
41
+ module Google
42
+ module Ads
43
+ module GoogleAds
44
+ module V0
45
+ module Services
46
+ GenerateKeywordIdeasRequest = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.ads.googleads.v0.services.GenerateKeywordIdeasRequest").msgclass
47
+ KeywordAndUrlSeed = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.ads.googleads.v0.services.KeywordAndUrlSeed").msgclass
48
+ KeywordSeed = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.ads.googleads.v0.services.KeywordSeed").msgclass
49
+ UrlSeed = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.ads.googleads.v0.services.UrlSeed").msgclass
50
+ GenerateKeywordIdeaResponse = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.ads.googleads.v0.services.GenerateKeywordIdeaResponse").msgclass
51
+ GenerateKeywordIdeaResult = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.ads.googleads.v0.services.GenerateKeywordIdeaResult").msgclass
52
+ end
53
+ end
54
+ end
55
+ end
56
+ end
@@ -0,0 +1,48 @@
1
+ # Generated by the protocol buffer compiler. DO NOT EDIT!
2
+ # Source: google/ads/google_ads/v0/services/keyword_plan_idea_service.proto for package 'google.ads.googleads.v0.services'
3
+ # Original file comments:
4
+ # Copyright 2018 Google LLC.
5
+ #
6
+ # Licensed under the Apache License, Version 2.0 (the "License");
7
+ # you may not use this file except in compliance with the License.
8
+ # You may obtain a copy of the License at
9
+ #
10
+ # http://www.apache.org/licenses/LICENSE-2.0
11
+ #
12
+ # Unless required by applicable law or agreed to in writing, software
13
+ # distributed under the License is distributed on an "AS IS" BASIS,
14
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15
+ # See the License for the specific language governing permissions and
16
+ # limitations under the License.
17
+ #
18
+ #
19
+
20
+ require 'grpc'
21
+ require 'google/ads/google_ads/v0/services/keyword_plan_idea_service_pb'
22
+
23
+ module Google
24
+ module Ads
25
+ module GoogleAds
26
+ module V0
27
+ module Services
28
+ module KeywordPlanIdeaService
29
+ # Service to generate keyword ideas.
30
+ class Service
31
+
32
+ include GRPC::GenericService
33
+
34
+ self.marshal_class_method = :encode
35
+ self.unmarshal_class_method = :decode
36
+ self.service_name = 'google.ads.googleads.v0.services.KeywordPlanIdeaService'
37
+
38
+ # Returns a list of keyword ideas.
39
+ rpc :GenerateKeywordIdeas, GenerateKeywordIdeasRequest, GenerateKeywordIdeaResponse
40
+ end
41
+
42
+ Stub = Service.rpc_stub_class
43
+ end
44
+ end
45
+ end
46
+ end
47
+ end
48
+ end
@@ -0,0 +1,268 @@
1
+ # Copyright 2018 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
+ # https://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
+ #
15
+ # EDITING INSTRUCTIONS
16
+ # This file was generated from the file
17
+ # https://github.com/googleapis/googleapis/blob/master/google/ads/google_ads/v0/services/keyword_plan_keyword_service.proto,
18
+ # and updates to that file get reflected here through a refresh process.
19
+ # For the short term, the refresh process will only be runnable by Google
20
+ # engineers.
21
+
22
+ require "json"
23
+ require "pathname"
24
+
25
+ require "google/gax"
26
+
27
+ require "google/ads/google_ads/v0/services/keyword_plan_keyword_service_pb"
28
+ require "google/ads/google_ads/v0/services/credentials"
29
+
30
+ module Google
31
+ module Ads
32
+ module GoogleAds
33
+ module V0
34
+ module Services
35
+ # Service to manage Keyword Plan ad group keywords.
36
+ #
37
+ # @!attribute [r] keyword_plan_keyword_service_stub
38
+ # @return [Google::Ads::GoogleAds::V0::Services::KeywordPlanKeywordService::Stub]
39
+ class KeywordPlanKeywordServiceClient
40
+ attr_reader :keyword_plan_keyword_service_stub
41
+
42
+ # The default address of the service.
43
+ SERVICE_ADDRESS = "googleads.googleapis.com".freeze
44
+
45
+ # The default port of the service.
46
+ DEFAULT_SERVICE_PORT = 443
47
+
48
+ # The default set of gRPC interceptors.
49
+ GRPC_INTERCEPTORS = []
50
+
51
+ DEFAULT_TIMEOUT = 30
52
+
53
+ # The scopes needed to make gRPC calls to all of the methods defined in
54
+ # this service.
55
+ ALL_SCOPES = [
56
+ ].freeze
57
+
58
+
59
+ KEYWORD_PLAN_KEYWORD_PATH_TEMPLATE = Google::Gax::PathTemplate.new(
60
+ "customers/{customer}/keywordPlanKeywords/{keyword_plan_keyword}"
61
+ )
62
+
63
+ private_constant :KEYWORD_PLAN_KEYWORD_PATH_TEMPLATE
64
+
65
+ # Returns a fully-qualified keyword_plan_keyword resource name string.
66
+ # @param customer [String]
67
+ # @param keyword_plan_keyword [String]
68
+ # @return [String]
69
+ def self.keyword_plan_keyword_path customer, keyword_plan_keyword
70
+ KEYWORD_PLAN_KEYWORD_PATH_TEMPLATE.render(
71
+ :"customer" => customer,
72
+ :"keyword_plan_keyword" => keyword_plan_keyword
73
+ )
74
+ end
75
+
76
+ # @param credentials [Google::Auth::Credentials, String, Hash, GRPC::Core::Channel, GRPC::Core::ChannelCredentials, Proc]
77
+ # Provides the means for authenticating requests made by the client. This parameter can
78
+ # be many types.
79
+ # A `Google::Auth::Credentials` uses a the properties of its represented keyfile for
80
+ # authenticating requests made by this client.
81
+ # A `String` will be treated as the path to the keyfile to be used for the construction of
82
+ # credentials for this client.
83
+ # A `Hash` will be treated as the contents of a keyfile to be used for the construction of
84
+ # credentials for this client.
85
+ # A `GRPC::Core::Channel` will be used to make calls through.
86
+ # A `GRPC::Core::ChannelCredentials` for the setting up the RPC client. The channel credentials
87
+ # should already be composed with a `GRPC::Core::CallCredentials` object.
88
+ # A `Proc` will be used as an updater_proc for the Grpc channel. The proc transforms the
89
+ # metadata for requests, generally, to give OAuth credentials.
90
+ # @param scopes [Array<String>]
91
+ # The OAuth scopes for this service. This parameter is ignored if
92
+ # an updater_proc is supplied.
93
+ # @param client_config [Hash]
94
+ # A Hash for call options for each method. See
95
+ # Google::Gax#construct_settings for the structure of
96
+ # this data. Falls back to the default config if not specified
97
+ # or the specified config is missing data points.
98
+ # @param timeout [Numeric]
99
+ # The default timeout, in seconds, for calls made through this client.
100
+ # @param metadata [Hash]
101
+ # Default metadata to be sent with each request. This can be overridden on a per call basis.
102
+ # @param exception_transformer [Proc]
103
+ # An optional proc that intercepts any exceptions raised during an API call to inject
104
+ # custom error handling.
105
+ def initialize \
106
+ credentials: nil,
107
+ scopes: ALL_SCOPES,
108
+ client_config: {},
109
+ timeout: DEFAULT_TIMEOUT,
110
+ metadata: nil,
111
+ exception_transformer: nil,
112
+ lib_name: nil,
113
+ lib_version: ""
114
+ # These require statements are intentionally placed here to initialize
115
+ # the gRPC module only when it's required.
116
+ # See https://github.com/googleapis/toolkit/issues/446
117
+ require "google/gax/grpc"
118
+ require "google/ads/google_ads/v0/services/keyword_plan_keyword_service_services_pb"
119
+
120
+ credentials ||= Google::Ads::GoogleAds::V0::Services::Credentials.default
121
+
122
+ if credentials.is_a?(String) || credentials.is_a?(Hash)
123
+ updater_proc = Google::Ads::GoogleAds::V0::Services::Credentials.new(credentials).updater_proc
124
+ end
125
+ if credentials.is_a?(GRPC::Core::Channel)
126
+ channel = credentials
127
+ end
128
+ if credentials.is_a?(GRPC::Core::ChannelCredentials)
129
+ chan_creds = credentials
130
+ end
131
+ if credentials.is_a?(Proc)
132
+ updater_proc = credentials
133
+ end
134
+ if credentials.is_a?(Google::Auth::Credentials)
135
+ updater_proc = credentials.updater_proc
136
+ end
137
+
138
+ package_version = Gem.loaded_specs['google-ads-googleads'].version.version
139
+
140
+ google_api_client = "gl-ruby/#{RUBY_VERSION}"
141
+ google_api_client << " #{lib_name}/#{lib_version}" if lib_name
142
+ google_api_client << " gapic/#{package_version} gax/#{Google::Gax::VERSION}"
143
+ google_api_client << " grpc/#{GRPC::VERSION}"
144
+ google_api_client.freeze
145
+
146
+ headers = { :"x-goog-api-client" => google_api_client }
147
+ headers.merge!(metadata) unless metadata.nil?
148
+ client_config_file = Pathname.new(__dir__).join(
149
+ "keyword_plan_keyword_service_client_config.json"
150
+ )
151
+ defaults = client_config_file.open do |f|
152
+ Google::Gax.construct_settings(
153
+ "google.ads.googleads.v0.services.KeywordPlanKeywordService",
154
+ JSON.parse(f.read),
155
+ client_config,
156
+ Google::Gax::Grpc::STATUS_CODE_NAMES,
157
+ timeout,
158
+ errors: Google::Gax::Grpc::API_ERRORS,
159
+ metadata: headers
160
+ )
161
+ end
162
+
163
+ # Allow overriding the service path/port in subclasses.
164
+ service_path = self.class::SERVICE_ADDRESS
165
+ port = self.class::DEFAULT_SERVICE_PORT
166
+ interceptors = self.class::GRPC_INTERCEPTORS
167
+ @keyword_plan_keyword_service_stub = Google::Gax::Grpc.create_stub(
168
+ service_path,
169
+ port,
170
+ chan_creds: chan_creds,
171
+ channel: channel,
172
+ updater_proc: updater_proc,
173
+ scopes: scopes,
174
+ interceptors: interceptors,
175
+ &Google::Ads::GoogleAds::V0::Services::KeywordPlanKeywordService::Stub.method(:new)
176
+ )
177
+
178
+ @get_keyword_plan_keyword = Google::Gax.create_api_call(
179
+ @keyword_plan_keyword_service_stub.method(:get_keyword_plan_keyword),
180
+ defaults["get_keyword_plan_keyword"],
181
+ exception_transformer: exception_transformer
182
+ )
183
+ @mutate_keyword_plan_keywords = Google::Gax.create_api_call(
184
+ @keyword_plan_keyword_service_stub.method(:mutate_keyword_plan_keywords),
185
+ defaults["mutate_keyword_plan_keywords"],
186
+ exception_transformer: exception_transformer
187
+ )
188
+ end
189
+
190
+ # Service calls
191
+
192
+ # Returns the requested Keyword Plan keyword in full detail.
193
+ #
194
+ # @param resource_name [String]
195
+ # The resource name of the ad group keyword to fetch.
196
+ # @param options [Google::Gax::CallOptions]
197
+ # Overrides the default settings for this call, e.g, timeout,
198
+ # retries, etc.
199
+ # @yield [result, operation] Access the result along with the RPC operation
200
+ # @yieldparam result [Google::Ads::GoogleAds::V0::Resources::KeywordPlanKeyword]
201
+ # @yieldparam operation [GRPC::ActiveCall::Operation]
202
+ # @return [Google::Ads::GoogleAds::V0::Resources::KeywordPlanKeyword]
203
+ # @raise [Google::Gax::GaxError] if the RPC is aborted.
204
+ # @example
205
+ # require "google/ads/google_ads"
206
+ #
207
+ # keyword_plan_keyword_service_client = Google::Ads::GoogleAds::KeywordPlanKeyword.new(version: :v0)
208
+ # formatted_resource_name = Google::Ads::GoogleAds::V0::Services::KeywordPlanKeywordServiceClient.keyword_plan_keyword_path("[CUSTOMER]", "[KEYWORD_PLAN_KEYWORD]")
209
+ # response = keyword_plan_keyword_service_client.get_keyword_plan_keyword(formatted_resource_name)
210
+
211
+ def get_keyword_plan_keyword \
212
+ resource_name,
213
+ options: nil,
214
+ &block
215
+ req = {
216
+ resource_name: resource_name
217
+ }.delete_if { |_, v| v.nil? }
218
+ req = Google::Gax::to_proto(req, Google::Ads::GoogleAds::V0::Services::GetKeywordPlanKeywordRequest)
219
+ @get_keyword_plan_keyword.call(req, options, &block)
220
+ end
221
+
222
+ # Creates, updates, or removes Keyword Plan keywords. Operation statuses are
223
+ # returned.
224
+ #
225
+ # @param customer_id [String]
226
+ # The ID of the customer whose Keyword Plan keywords are being modified.
227
+ # @param operations [Array<Google::Ads::GoogleAds::V0::Services::KeywordPlanKeywordOperation | Hash>]
228
+ # The list of operations to perform on individual Keyword Plan keywords.
229
+ # A hash of the same form as `Google::Ads::GoogleAds::V0::Services::KeywordPlanKeywordOperation`
230
+ # can also be provided.
231
+ # @param options [Google::Gax::CallOptions]
232
+ # Overrides the default settings for this call, e.g, timeout,
233
+ # retries, etc.
234
+ # @yield [result, operation] Access the result along with the RPC operation
235
+ # @yieldparam result [Google::Ads::GoogleAds::V0::Services::MutateKeywordPlanKeywordsResponse]
236
+ # @yieldparam operation [GRPC::ActiveCall::Operation]
237
+ # @return [Google::Ads::GoogleAds::V0::Services::MutateKeywordPlanKeywordsResponse]
238
+ # @raise [Google::Gax::GaxError] if the RPC is aborted.
239
+ # @example
240
+ # require "google/ads/google_ads"
241
+ #
242
+ # keyword_plan_keyword_service_client = Google::Ads::GoogleAds::KeywordPlanKeyword.new(version: :v0)
243
+ #
244
+ # # TODO: Initialize +customer_id+:
245
+ # customer_id = ''
246
+ #
247
+ # # TODO: Initialize +operations+:
248
+ # operations = []
249
+ # response = keyword_plan_keyword_service_client.mutate_keyword_plan_keywords(customer_id, operations)
250
+
251
+ def mutate_keyword_plan_keywords \
252
+ customer_id,
253
+ operations,
254
+ options: nil,
255
+ &block
256
+ req = {
257
+ customer_id: customer_id,
258
+ operations: operations
259
+ }.delete_if { |_, v| v.nil? }
260
+ req = Google::Gax::to_proto(req, Google::Ads::GoogleAds::V0::Services::MutateKeywordPlanKeywordsRequest)
261
+ @mutate_keyword_plan_keywords.call(req, options, &block)
262
+ end
263
+ end
264
+ end
265
+ end
266
+ end
267
+ end
268
+ end