google-adwords-api 0.18.1 → 0.18.3

Sign up to get free protection for your applications and to get access to all the features.
Files changed (441) hide show
  1. checksums.yaml +4 -4
  2. data/COPYING +0 -0
  3. data/ChangeLog +7 -0
  4. data/README.md +8 -29
  5. data/adwords_api.yml +2 -0
  6. data/examples/v201506/reporting/parallel_report_download.rb +1 -3
  7. data/examples/v201509/reporting/parallel_report_download.rb +1 -3
  8. data/examples/v201601/reporting/parallel_report_download.rb +1 -3
  9. data/examples/v201603/account_management/create_account.rb +88 -0
  10. data/examples/v201603/account_management/get_account_changes.rb +135 -0
  11. data/examples/v201603/account_management/get_account_hierarchy.rb +132 -0
  12. data/examples/v201603/advanced_operations/add_ad_customizers.rb +184 -0
  13. data/examples/v201603/advanced_operations/add_ad_group_bid_modifier.rb +101 -0
  14. data/examples/v201603/advanced_operations/add_click_to_download_ad.rb +133 -0
  15. data/examples/v201603/advanced_operations/add_html5_ad.rb +137 -0
  16. data/examples/v201603/advanced_operations/add_keywords_using_incremental_batch_job.rb +210 -0
  17. data/examples/v201603/advanced_operations/add_text_ad_with_upgraded_urls.rb +134 -0
  18. data/examples/v201603/advanced_operations/create_and_attach_shared_keyword_set.rb +141 -0
  19. data/examples/v201603/advanced_operations/find_and_remove_criteria_from_shared_set.rb +174 -0
  20. data/examples/v201603/advanced_operations/get_ad_group_bid_modifiers.rb +102 -0
  21. data/examples/v201603/advanced_operations/use_portfolio_bidding_strategy.rb +146 -0
  22. data/examples/v201603/basic_operations/add_ad_groups.rb +142 -0
  23. data/examples/v201603/basic_operations/add_campaigns.rb +138 -0
  24. data/examples/v201603/basic_operations/add_keywords.rb +114 -0
  25. data/examples/v201603/basic_operations/add_text_ads.rb +109 -0
  26. data/examples/v201603/basic_operations/get_ad_groups.rb +102 -0
  27. data/examples/v201603/basic_operations/get_campaigns.rb +97 -0
  28. data/examples/v201603/basic_operations/get_campaigns_with_awql.rb +89 -0
  29. data/examples/v201603/basic_operations/get_keywords.rb +109 -0
  30. data/examples/v201603/basic_operations/get_text_ads.rb +110 -0
  31. data/examples/v201603/basic_operations/pause_ad.rb +88 -0
  32. data/examples/v201603/basic_operations/remove_ad.rb +89 -0
  33. data/examples/v201603/basic_operations/remove_ad_group.rb +85 -0
  34. data/examples/v201603/basic_operations/remove_campaign.rb +87 -0
  35. data/examples/v201603/basic_operations/remove_keyword.rb +94 -0
  36. data/examples/v201603/basic_operations/update_ad_group.rb +85 -0
  37. data/examples/v201603/basic_operations/update_campaign.rb +86 -0
  38. data/examples/v201603/basic_operations/update_keyword.rb +106 -0
  39. data/examples/v201603/campaign_management/add_campaign_labels.rb +82 -0
  40. data/examples/v201603/campaign_management/add_complete_campaigns_using_batch_job.rb +355 -0
  41. data/examples/v201603/campaign_management/add_draft.rb +114 -0
  42. data/examples/v201603/campaign_management/add_experiment.rb +162 -0
  43. data/examples/v201603/campaign_management/add_trial.rb +142 -0
  44. data/examples/v201603/campaign_management/get_all_disapproved_ads.rb +97 -0
  45. data/examples/v201603/campaign_management/get_all_disapproved_ads_with_awql.rb +89 -0
  46. data/examples/v201603/campaign_management/get_campaigns_by_label.rb +108 -0
  47. data/examples/v201603/campaign_management/graduate_trial.rb +106 -0
  48. data/examples/v201603/campaign_management/promote_experiment.rb +81 -0
  49. data/examples/v201603/campaign_management/set_ad_parameters.rb +118 -0
  50. data/examples/v201603/campaign_management/set_criterion_bid_modifier.rb +104 -0
  51. data/examples/v201603/campaign_management/validate_text_ad.rb +110 -0
  52. data/examples/v201603/error_handling/handle_partial_failures.rb +130 -0
  53. data/examples/v201603/error_handling/handle_policy_violation_error.rb +141 -0
  54. data/examples/v201603/extensions/add_google_my_business_location_extensions.rb +193 -0
  55. data/examples/v201603/extensions/add_site_links.rb +184 -0
  56. data/examples/v201603/extensions/add_site_links_using_feeds.rb +281 -0
  57. data/examples/v201603/migration/migrate_to_extension_settings.rb +386 -0
  58. data/examples/v201603/migration/upgrade_ad_url.rb +93 -0
  59. data/examples/v201603/misc/get_all_images_and_videos.rb +104 -0
  60. data/examples/v201603/misc/setup_oauth2.rb +84 -0
  61. data/examples/v201603/misc/upload_image.rb +93 -0
  62. data/examples/v201603/misc/upload_media_bundle.rb +90 -0
  63. data/examples/v201603/misc/use_oauth2_jwt.rb +93 -0
  64. data/examples/v201603/misc/use_runtime_config.rb +92 -0
  65. data/examples/v201603/optimization/estimate_keyword_traffic.rb +146 -0
  66. data/examples/v201603/optimization/get_campaign_criterion_bid_modifier_simulations.rb +128 -0
  67. data/examples/v201603/optimization/get_keyword_bid_simulations.rb +95 -0
  68. data/examples/v201603/optimization/get_keyword_ideas.rb +136 -0
  69. data/examples/v201603/remarketing/add_audience.rb +118 -0
  70. data/examples/v201603/remarketing/add_conversion_tracker.rb +97 -0
  71. data/examples/v201603/remarketing/add_crm_based_user_list.rb +116 -0
  72. data/examples/v201603/remarketing/add_rule_based_user_lists.rb +167 -0
  73. data/examples/v201603/remarketing/upload_offline_conversions.rb +98 -0
  74. data/examples/v201603/reporting/download_criteria_report.rb +92 -0
  75. data/examples/v201603/reporting/download_criteria_report_with_awql.rb +93 -0
  76. data/examples/v201603/reporting/get_report_fields.rb +75 -0
  77. data/examples/v201603/reporting/parallel_report_download.rb +164 -0
  78. data/examples/v201603/reporting/stream_criteria_report_results.rb +97 -0
  79. data/examples/v201603/shopping_campaigns/add_product_partition_tree.rb +267 -0
  80. data/examples/v201603/shopping_campaigns/add_product_scope.rb +129 -0
  81. data/examples/v201603/shopping_campaigns/add_shopping_campaign.rb +129 -0
  82. data/examples/v201603/shopping_campaigns/get_product_category_taxonomy.rb +115 -0
  83. data/examples/v201603/targeting/add_campaign_targeting_criteria.rb +180 -0
  84. data/examples/v201603/targeting/add_demographic_targeting_criteria.rb +112 -0
  85. data/examples/v201603/targeting/get_campaign_targeting_criteria.rb +106 -0
  86. data/examples/v201603/targeting/get_targetable_languages_and_carriers.rb +89 -0
  87. data/examples/v201603/targeting/lookup_location.rb +108 -0
  88. data/lib/adwords_api.rb +4 -0
  89. data/lib/adwords_api/api_config.rb +96 -4
  90. data/lib/adwords_api/batch_job_utils.rb +2 -0
  91. data/lib/adwords_api/credential_handler.rb +0 -0
  92. data/lib/adwords_api/errors.rb +0 -0
  93. data/lib/adwords_api/incremental_upload_helper.rb +0 -0
  94. data/lib/adwords_api/report_header_handler.rb +0 -0
  95. data/lib/adwords_api/report_stream.rb +0 -0
  96. data/lib/adwords_api/report_utils.rb +2 -1
  97. data/lib/adwords_api/utils.rb +0 -0
  98. data/lib/adwords_api/utils_reporter.rb +46 -0
  99. data/lib/adwords_api/v201506/account_label_service.rb +0 -0
  100. data/lib/adwords_api/v201506/account_label_service_registry.rb +0 -0
  101. data/lib/adwords_api/v201506/ad_customizer_feed_service.rb +0 -0
  102. data/lib/adwords_api/v201506/ad_customizer_feed_service_registry.rb +0 -0
  103. data/lib/adwords_api/v201506/ad_group_ad_service.rb +0 -0
  104. data/lib/adwords_api/v201506/ad_group_ad_service_registry.rb +0 -0
  105. data/lib/adwords_api/v201506/ad_group_bid_modifier_service.rb +0 -0
  106. data/lib/adwords_api/v201506/ad_group_bid_modifier_service_registry.rb +0 -0
  107. data/lib/adwords_api/v201506/ad_group_criterion_service.rb +0 -0
  108. data/lib/adwords_api/v201506/ad_group_criterion_service_registry.rb +0 -0
  109. data/lib/adwords_api/v201506/ad_group_extension_setting_service.rb +0 -0
  110. data/lib/adwords_api/v201506/ad_group_extension_setting_service_registry.rb +0 -0
  111. data/lib/adwords_api/v201506/ad_group_feed_service.rb +0 -0
  112. data/lib/adwords_api/v201506/ad_group_feed_service_registry.rb +0 -0
  113. data/lib/adwords_api/v201506/ad_group_service.rb +0 -0
  114. data/lib/adwords_api/v201506/ad_group_service_registry.rb +0 -0
  115. data/lib/adwords_api/v201506/ad_param_service.rb +0 -0
  116. data/lib/adwords_api/v201506/ad_param_service_registry.rb +0 -0
  117. data/lib/adwords_api/v201506/adwords_user_list_service.rb +0 -0
  118. data/lib/adwords_api/v201506/adwords_user_list_service_registry.rb +0 -0
  119. data/lib/adwords_api/v201506/bidding_strategy_service.rb +0 -0
  120. data/lib/adwords_api/v201506/bidding_strategy_service_registry.rb +0 -0
  121. data/lib/adwords_api/v201506/budget_order_service.rb +0 -0
  122. data/lib/adwords_api/v201506/budget_order_service_registry.rb +0 -0
  123. data/lib/adwords_api/v201506/budget_service.rb +0 -0
  124. data/lib/adwords_api/v201506/budget_service_registry.rb +0 -0
  125. data/lib/adwords_api/v201506/campaign_criterion_service.rb +0 -0
  126. data/lib/adwords_api/v201506/campaign_criterion_service_registry.rb +0 -0
  127. data/lib/adwords_api/v201506/campaign_extension_setting_service.rb +0 -0
  128. data/lib/adwords_api/v201506/campaign_extension_setting_service_registry.rb +0 -0
  129. data/lib/adwords_api/v201506/campaign_feed_service.rb +0 -0
  130. data/lib/adwords_api/v201506/campaign_feed_service_registry.rb +0 -0
  131. data/lib/adwords_api/v201506/campaign_service.rb +0 -0
  132. data/lib/adwords_api/v201506/campaign_service_registry.rb +0 -0
  133. data/lib/adwords_api/v201506/campaign_shared_set_service.rb +0 -0
  134. data/lib/adwords_api/v201506/campaign_shared_set_service_registry.rb +0 -0
  135. data/lib/adwords_api/v201506/constant_data_service.rb +0 -0
  136. data/lib/adwords_api/v201506/constant_data_service_registry.rb +0 -0
  137. data/lib/adwords_api/v201506/conversion_tracker_service.rb +0 -0
  138. data/lib/adwords_api/v201506/conversion_tracker_service_registry.rb +0 -0
  139. data/lib/adwords_api/v201506/customer_extension_setting_service.rb +0 -0
  140. data/lib/adwords_api/v201506/customer_extension_setting_service_registry.rb +0 -0
  141. data/lib/adwords_api/v201506/customer_feed_service.rb +0 -0
  142. data/lib/adwords_api/v201506/customer_feed_service_registry.rb +0 -0
  143. data/lib/adwords_api/v201506/customer_service.rb +0 -0
  144. data/lib/adwords_api/v201506/customer_service_registry.rb +0 -0
  145. data/lib/adwords_api/v201506/customer_sync_service.rb +0 -0
  146. data/lib/adwords_api/v201506/customer_sync_service_registry.rb +0 -0
  147. data/lib/adwords_api/v201506/data_service.rb +0 -0
  148. data/lib/adwords_api/v201506/data_service_registry.rb +0 -0
  149. data/lib/adwords_api/v201506/experiment_service.rb +0 -0
  150. data/lib/adwords_api/v201506/experiment_service_registry.rb +0 -0
  151. data/lib/adwords_api/v201506/feed_item_service.rb +0 -0
  152. data/lib/adwords_api/v201506/feed_item_service_registry.rb +0 -0
  153. data/lib/adwords_api/v201506/feed_mapping_service.rb +0 -0
  154. data/lib/adwords_api/v201506/feed_mapping_service_registry.rb +0 -0
  155. data/lib/adwords_api/v201506/feed_service.rb +0 -0
  156. data/lib/adwords_api/v201506/feed_service_registry.rb +0 -0
  157. data/lib/adwords_api/v201506/geo_location_service.rb +0 -0
  158. data/lib/adwords_api/v201506/geo_location_service_registry.rb +0 -0
  159. data/lib/adwords_api/v201506/label_service.rb +0 -0
  160. data/lib/adwords_api/v201506/label_service_registry.rb +0 -0
  161. data/lib/adwords_api/v201506/location_criterion_service.rb +0 -0
  162. data/lib/adwords_api/v201506/location_criterion_service_registry.rb +0 -0
  163. data/lib/adwords_api/v201506/managed_customer_service.rb +0 -0
  164. data/lib/adwords_api/v201506/managed_customer_service_registry.rb +0 -0
  165. data/lib/adwords_api/v201506/media_service.rb +0 -0
  166. data/lib/adwords_api/v201506/media_service_registry.rb +0 -0
  167. data/lib/adwords_api/v201506/mutate_job_service.rb +0 -0
  168. data/lib/adwords_api/v201506/mutate_job_service_registry.rb +0 -0
  169. data/lib/adwords_api/v201506/offline_conversion_feed_service.rb +0 -0
  170. data/lib/adwords_api/v201506/offline_conversion_feed_service_registry.rb +0 -0
  171. data/lib/adwords_api/v201506/report_definition_service.rb +0 -0
  172. data/lib/adwords_api/v201506/report_definition_service_registry.rb +0 -0
  173. data/lib/adwords_api/v201506/shared_criterion_service.rb +0 -0
  174. data/lib/adwords_api/v201506/shared_criterion_service_registry.rb +0 -0
  175. data/lib/adwords_api/v201506/shared_set_service.rb +0 -0
  176. data/lib/adwords_api/v201506/shared_set_service_registry.rb +0 -0
  177. data/lib/adwords_api/v201506/targeting_idea_service.rb +0 -0
  178. data/lib/adwords_api/v201506/targeting_idea_service_registry.rb +0 -0
  179. data/lib/adwords_api/v201506/traffic_estimator_service.rb +0 -0
  180. data/lib/adwords_api/v201506/traffic_estimator_service_registry.rb +0 -0
  181. data/lib/adwords_api/v201509/account_label_service.rb +0 -0
  182. data/lib/adwords_api/v201509/account_label_service_registry.rb +0 -0
  183. data/lib/adwords_api/v201509/ad_customizer_feed_service.rb +0 -0
  184. data/lib/adwords_api/v201509/ad_customizer_feed_service_registry.rb +0 -0
  185. data/lib/adwords_api/v201509/ad_group_ad_service.rb +0 -0
  186. data/lib/adwords_api/v201509/ad_group_ad_service_registry.rb +0 -0
  187. data/lib/adwords_api/v201509/ad_group_bid_modifier_service.rb +0 -0
  188. data/lib/adwords_api/v201509/ad_group_bid_modifier_service_registry.rb +0 -0
  189. data/lib/adwords_api/v201509/ad_group_criterion_service.rb +0 -0
  190. data/lib/adwords_api/v201509/ad_group_criterion_service_registry.rb +0 -0
  191. data/lib/adwords_api/v201509/ad_group_extension_setting_service.rb +0 -0
  192. data/lib/adwords_api/v201509/ad_group_extension_setting_service_registry.rb +0 -0
  193. data/lib/adwords_api/v201509/ad_group_feed_service.rb +0 -0
  194. data/lib/adwords_api/v201509/ad_group_feed_service_registry.rb +0 -0
  195. data/lib/adwords_api/v201509/ad_group_service.rb +0 -0
  196. data/lib/adwords_api/v201509/ad_group_service_registry.rb +0 -0
  197. data/lib/adwords_api/v201509/ad_param_service.rb +0 -0
  198. data/lib/adwords_api/v201509/ad_param_service_registry.rb +0 -0
  199. data/lib/adwords_api/v201509/adwords_user_list_service.rb +0 -0
  200. data/lib/adwords_api/v201509/adwords_user_list_service_registry.rb +0 -0
  201. data/lib/adwords_api/v201509/batch_job_service.rb +0 -0
  202. data/lib/adwords_api/v201509/batch_job_service_registry.rb +0 -0
  203. data/lib/adwords_api/v201509/bidding_strategy_service.rb +0 -0
  204. data/lib/adwords_api/v201509/bidding_strategy_service_registry.rb +0 -0
  205. data/lib/adwords_api/v201509/budget_order_service.rb +0 -0
  206. data/lib/adwords_api/v201509/budget_order_service_registry.rb +0 -0
  207. data/lib/adwords_api/v201509/budget_service.rb +0 -0
  208. data/lib/adwords_api/v201509/budget_service_registry.rb +0 -0
  209. data/lib/adwords_api/v201509/campaign_criterion_service.rb +0 -0
  210. data/lib/adwords_api/v201509/campaign_criterion_service_registry.rb +0 -0
  211. data/lib/adwords_api/v201509/campaign_extension_setting_service.rb +0 -0
  212. data/lib/adwords_api/v201509/campaign_extension_setting_service_registry.rb +0 -0
  213. data/lib/adwords_api/v201509/campaign_feed_service.rb +0 -0
  214. data/lib/adwords_api/v201509/campaign_feed_service_registry.rb +0 -0
  215. data/lib/adwords_api/v201509/campaign_service.rb +0 -0
  216. data/lib/adwords_api/v201509/campaign_service_registry.rb +0 -0
  217. data/lib/adwords_api/v201509/campaign_shared_set_service.rb +0 -0
  218. data/lib/adwords_api/v201509/campaign_shared_set_service_registry.rb +0 -0
  219. data/lib/adwords_api/v201509/constant_data_service.rb +0 -0
  220. data/lib/adwords_api/v201509/constant_data_service_registry.rb +0 -0
  221. data/lib/adwords_api/v201509/conversion_tracker_service.rb +0 -0
  222. data/lib/adwords_api/v201509/conversion_tracker_service_registry.rb +0 -0
  223. data/lib/adwords_api/v201509/customer_extension_setting_service.rb +0 -0
  224. data/lib/adwords_api/v201509/customer_extension_setting_service_registry.rb +0 -0
  225. data/lib/adwords_api/v201509/customer_feed_service.rb +0 -0
  226. data/lib/adwords_api/v201509/customer_feed_service_registry.rb +0 -0
  227. data/lib/adwords_api/v201509/customer_service.rb +0 -0
  228. data/lib/adwords_api/v201509/customer_service_registry.rb +0 -0
  229. data/lib/adwords_api/v201509/customer_sync_service.rb +0 -0
  230. data/lib/adwords_api/v201509/customer_sync_service_registry.rb +0 -0
  231. data/lib/adwords_api/v201509/data_service.rb +0 -0
  232. data/lib/adwords_api/v201509/data_service_registry.rb +0 -0
  233. data/lib/adwords_api/v201509/experiment_service.rb +0 -0
  234. data/lib/adwords_api/v201509/experiment_service_registry.rb +0 -0
  235. data/lib/adwords_api/v201509/feed_item_service.rb +0 -0
  236. data/lib/adwords_api/v201509/feed_item_service_registry.rb +0 -0
  237. data/lib/adwords_api/v201509/feed_mapping_service.rb +0 -0
  238. data/lib/adwords_api/v201509/feed_mapping_service_registry.rb +0 -0
  239. data/lib/adwords_api/v201509/feed_service.rb +0 -0
  240. data/lib/adwords_api/v201509/feed_service_registry.rb +0 -0
  241. data/lib/adwords_api/v201509/label_service.rb +0 -0
  242. data/lib/adwords_api/v201509/label_service_registry.rb +0 -0
  243. data/lib/adwords_api/v201509/location_criterion_service.rb +0 -0
  244. data/lib/adwords_api/v201509/location_criterion_service_registry.rb +0 -0
  245. data/lib/adwords_api/v201509/managed_customer_service.rb +0 -0
  246. data/lib/adwords_api/v201509/managed_customer_service_registry.rb +0 -0
  247. data/lib/adwords_api/v201509/media_service.rb +0 -0
  248. data/lib/adwords_api/v201509/media_service_registry.rb +0 -0
  249. data/lib/adwords_api/v201509/mutate_job_service.rb +0 -0
  250. data/lib/adwords_api/v201509/mutate_job_service_registry.rb +0 -0
  251. data/lib/adwords_api/v201509/offline_conversion_feed_service.rb +0 -0
  252. data/lib/adwords_api/v201509/offline_conversion_feed_service_registry.rb +0 -0
  253. data/lib/adwords_api/v201509/report_definition_service.rb +0 -0
  254. data/lib/adwords_api/v201509/report_definition_service_registry.rb +0 -0
  255. data/lib/adwords_api/v201509/shared_criterion_service.rb +0 -0
  256. data/lib/adwords_api/v201509/shared_criterion_service_registry.rb +0 -0
  257. data/lib/adwords_api/v201509/shared_set_service.rb +0 -0
  258. data/lib/adwords_api/v201509/shared_set_service_registry.rb +0 -0
  259. data/lib/adwords_api/v201509/targeting_idea_service.rb +0 -0
  260. data/lib/adwords_api/v201509/targeting_idea_service_registry.rb +0 -0
  261. data/lib/adwords_api/v201509/traffic_estimator_service.rb +0 -0
  262. data/lib/adwords_api/v201509/traffic_estimator_service_registry.rb +0 -0
  263. data/lib/adwords_api/v201601/account_label_service.rb +0 -0
  264. data/lib/adwords_api/v201601/account_label_service_registry.rb +0 -0
  265. data/lib/adwords_api/v201601/ad_customizer_feed_service.rb +0 -0
  266. data/lib/adwords_api/v201601/ad_customizer_feed_service_registry.rb +0 -0
  267. data/lib/adwords_api/v201601/ad_group_ad_service.rb +0 -0
  268. data/lib/adwords_api/v201601/ad_group_ad_service_registry.rb +0 -0
  269. data/lib/adwords_api/v201601/ad_group_bid_modifier_service.rb +0 -0
  270. data/lib/adwords_api/v201601/ad_group_bid_modifier_service_registry.rb +0 -0
  271. data/lib/adwords_api/v201601/ad_group_criterion_service.rb +0 -0
  272. data/lib/adwords_api/v201601/ad_group_criterion_service_registry.rb +0 -0
  273. data/lib/adwords_api/v201601/ad_group_extension_setting_service.rb +0 -0
  274. data/lib/adwords_api/v201601/ad_group_extension_setting_service_registry.rb +0 -0
  275. data/lib/adwords_api/v201601/ad_group_feed_service.rb +0 -0
  276. data/lib/adwords_api/v201601/ad_group_feed_service_registry.rb +0 -0
  277. data/lib/adwords_api/v201601/ad_group_service.rb +0 -0
  278. data/lib/adwords_api/v201601/ad_group_service_registry.rb +0 -0
  279. data/lib/adwords_api/v201601/ad_param_service.rb +0 -0
  280. data/lib/adwords_api/v201601/ad_param_service_registry.rb +0 -0
  281. data/lib/adwords_api/v201601/adwords_user_list_service.rb +0 -0
  282. data/lib/adwords_api/v201601/adwords_user_list_service_registry.rb +0 -0
  283. data/lib/adwords_api/v201601/batch_job_service.rb +0 -0
  284. data/lib/adwords_api/v201601/batch_job_service_registry.rb +0 -0
  285. data/lib/adwords_api/v201601/bidding_strategy_service.rb +0 -0
  286. data/lib/adwords_api/v201601/bidding_strategy_service_registry.rb +0 -0
  287. data/lib/adwords_api/v201601/budget_order_service.rb +0 -0
  288. data/lib/adwords_api/v201601/budget_order_service_registry.rb +0 -0
  289. data/lib/adwords_api/v201601/budget_service.rb +0 -0
  290. data/lib/adwords_api/v201601/budget_service_registry.rb +0 -0
  291. data/lib/adwords_api/v201601/campaign_criterion_service.rb +0 -0
  292. data/lib/adwords_api/v201601/campaign_criterion_service_registry.rb +0 -0
  293. data/lib/adwords_api/v201601/campaign_extension_setting_service.rb +0 -0
  294. data/lib/adwords_api/v201601/campaign_extension_setting_service_registry.rb +0 -0
  295. data/lib/adwords_api/v201601/campaign_feed_service.rb +0 -0
  296. data/lib/adwords_api/v201601/campaign_feed_service_registry.rb +0 -0
  297. data/lib/adwords_api/v201601/campaign_service.rb +0 -0
  298. data/lib/adwords_api/v201601/campaign_service_registry.rb +0 -0
  299. data/lib/adwords_api/v201601/campaign_shared_set_service.rb +0 -0
  300. data/lib/adwords_api/v201601/campaign_shared_set_service_registry.rb +0 -0
  301. data/lib/adwords_api/v201601/constant_data_service.rb +0 -0
  302. data/lib/adwords_api/v201601/constant_data_service_registry.rb +0 -0
  303. data/lib/adwords_api/v201601/conversion_tracker_service.rb +0 -0
  304. data/lib/adwords_api/v201601/conversion_tracker_service_registry.rb +0 -0
  305. data/lib/adwords_api/v201601/customer_extension_setting_service.rb +0 -0
  306. data/lib/adwords_api/v201601/customer_extension_setting_service_registry.rb +0 -0
  307. data/lib/adwords_api/v201601/customer_feed_service.rb +0 -0
  308. data/lib/adwords_api/v201601/customer_feed_service_registry.rb +0 -0
  309. data/lib/adwords_api/v201601/customer_service.rb +0 -0
  310. data/lib/adwords_api/v201601/customer_service_registry.rb +0 -0
  311. data/lib/adwords_api/v201601/customer_sync_service.rb +0 -0
  312. data/lib/adwords_api/v201601/customer_sync_service_registry.rb +0 -0
  313. data/lib/adwords_api/v201601/data_service.rb +0 -0
  314. data/lib/adwords_api/v201601/data_service_registry.rb +0 -0
  315. data/lib/adwords_api/v201601/experiment_service.rb +0 -0
  316. data/lib/adwords_api/v201601/experiment_service_registry.rb +0 -0
  317. data/lib/adwords_api/v201601/feed_item_service.rb +0 -0
  318. data/lib/adwords_api/v201601/feed_item_service_registry.rb +0 -0
  319. data/lib/adwords_api/v201601/feed_mapping_service.rb +0 -0
  320. data/lib/adwords_api/v201601/feed_mapping_service_registry.rb +0 -0
  321. data/lib/adwords_api/v201601/feed_service.rb +0 -0
  322. data/lib/adwords_api/v201601/feed_service_registry.rb +0 -0
  323. data/lib/adwords_api/v201601/label_service.rb +0 -0
  324. data/lib/adwords_api/v201601/label_service_registry.rb +0 -0
  325. data/lib/adwords_api/v201601/location_criterion_service.rb +0 -0
  326. data/lib/adwords_api/v201601/location_criterion_service_registry.rb +0 -0
  327. data/lib/adwords_api/v201601/managed_customer_service.rb +0 -0
  328. data/lib/adwords_api/v201601/managed_customer_service_registry.rb +0 -0
  329. data/lib/adwords_api/v201601/media_service.rb +0 -0
  330. data/lib/adwords_api/v201601/media_service_registry.rb +0 -0
  331. data/lib/adwords_api/v201601/mutate_job_service.rb +0 -0
  332. data/lib/adwords_api/v201601/mutate_job_service_registry.rb +0 -0
  333. data/lib/adwords_api/v201601/offline_conversion_feed_service.rb +0 -0
  334. data/lib/adwords_api/v201601/offline_conversion_feed_service_registry.rb +0 -0
  335. data/lib/adwords_api/v201601/report_definition_service.rb +0 -0
  336. data/lib/adwords_api/v201601/report_definition_service_registry.rb +0 -0
  337. data/lib/adwords_api/v201601/shared_criterion_service.rb +0 -0
  338. data/lib/adwords_api/v201601/shared_criterion_service_registry.rb +0 -0
  339. data/lib/adwords_api/v201601/shared_set_service.rb +0 -0
  340. data/lib/adwords_api/v201601/shared_set_service_registry.rb +0 -0
  341. data/lib/adwords_api/v201601/targeting_idea_service.rb +0 -0
  342. data/lib/adwords_api/v201601/targeting_idea_service_registry.rb +0 -0
  343. data/lib/adwords_api/v201601/traffic_estimator_service.rb +0 -0
  344. data/lib/adwords_api/v201601/traffic_estimator_service_registry.rb +0 -0
  345. data/lib/adwords_api/v201603/account_label_service.rb +46 -0
  346. data/lib/adwords_api/v201603/account_label_service_registry.rb +46 -0
  347. data/lib/adwords_api/v201603/ad_customizer_feed_service.rb +46 -0
  348. data/lib/adwords_api/v201603/ad_customizer_feed_service_registry.rb +46 -0
  349. data/lib/adwords_api/v201603/ad_group_ad_service.rb +70 -0
  350. data/lib/adwords_api/v201603/ad_group_ad_service_registry.rb +46 -0
  351. data/lib/adwords_api/v201603/ad_group_bid_modifier_service.rb +54 -0
  352. data/lib/adwords_api/v201603/ad_group_bid_modifier_service_registry.rb +46 -0
  353. data/lib/adwords_api/v201603/ad_group_criterion_service.rb +62 -0
  354. data/lib/adwords_api/v201603/ad_group_criterion_service_registry.rb +46 -0
  355. data/lib/adwords_api/v201603/ad_group_extension_setting_service.rb +54 -0
  356. data/lib/adwords_api/v201603/ad_group_extension_setting_service_registry.rb +46 -0
  357. data/lib/adwords_api/v201603/ad_group_feed_service.rb +54 -0
  358. data/lib/adwords_api/v201603/ad_group_feed_service_registry.rb +46 -0
  359. data/lib/adwords_api/v201603/ad_group_service.rb +62 -0
  360. data/lib/adwords_api/v201603/ad_group_service_registry.rb +46 -0
  361. data/lib/adwords_api/v201603/ad_param_service.rb +46 -0
  362. data/lib/adwords_api/v201603/ad_param_service_registry.rb +46 -0
  363. data/lib/adwords_api/v201603/adwords_user_list_service.rb +62 -0
  364. data/lib/adwords_api/v201603/adwords_user_list_service_registry.rb +46 -0
  365. data/lib/adwords_api/v201603/batch_job_service.rb +54 -0
  366. data/lib/adwords_api/v201603/batch_job_service_registry.rb +46 -0
  367. data/lib/adwords_api/v201603/bidding_strategy_service.rb +54 -0
  368. data/lib/adwords_api/v201603/bidding_strategy_service_registry.rb +46 -0
  369. data/lib/adwords_api/v201603/budget_order_service.rb +54 -0
  370. data/lib/adwords_api/v201603/budget_order_service_registry.rb +46 -0
  371. data/lib/adwords_api/v201603/budget_service.rb +54 -0
  372. data/lib/adwords_api/v201603/budget_service_registry.rb +46 -0
  373. data/lib/adwords_api/v201603/campaign_criterion_service.rb +54 -0
  374. data/lib/adwords_api/v201603/campaign_criterion_service_registry.rb +46 -0
  375. data/lib/adwords_api/v201603/campaign_extension_setting_service.rb +54 -0
  376. data/lib/adwords_api/v201603/campaign_extension_setting_service_registry.rb +46 -0
  377. data/lib/adwords_api/v201603/campaign_feed_service.rb +54 -0
  378. data/lib/adwords_api/v201603/campaign_feed_service_registry.rb +46 -0
  379. data/lib/adwords_api/v201603/campaign_service.rb +62 -0
  380. data/lib/adwords_api/v201603/campaign_service_registry.rb +46 -0
  381. data/lib/adwords_api/v201603/campaign_shared_set_service.rb +54 -0
  382. data/lib/adwords_api/v201603/campaign_shared_set_service_registry.rb +46 -0
  383. data/lib/adwords_api/v201603/constant_data_service.rb +110 -0
  384. data/lib/adwords_api/v201603/constant_data_service_registry.rb +46 -0
  385. data/lib/adwords_api/v201603/conversion_tracker_service.rb +54 -0
  386. data/lib/adwords_api/v201603/conversion_tracker_service_registry.rb +46 -0
  387. data/lib/adwords_api/v201603/customer_extension_setting_service.rb +54 -0
  388. data/lib/adwords_api/v201603/customer_extension_setting_service_registry.rb +46 -0
  389. data/lib/adwords_api/v201603/customer_feed_service.rb +54 -0
  390. data/lib/adwords_api/v201603/customer_feed_service_registry.rb +46 -0
  391. data/lib/adwords_api/v201603/customer_service.rb +54 -0
  392. data/lib/adwords_api/v201603/customer_service_registry.rb +46 -0
  393. data/lib/adwords_api/v201603/customer_sync_service.rb +38 -0
  394. data/lib/adwords_api/v201603/customer_sync_service_registry.rb +47 -0
  395. data/lib/adwords_api/v201603/data_service.rb +94 -0
  396. data/lib/adwords_api/v201603/data_service_registry.rb +46 -0
  397. data/lib/adwords_api/v201603/draft_async_error_service.rb +46 -0
  398. data/lib/adwords_api/v201603/draft_async_error_service_registry.rb +46 -0
  399. data/lib/adwords_api/v201603/draft_service.rb +54 -0
  400. data/lib/adwords_api/v201603/draft_service_registry.rb +46 -0
  401. data/lib/adwords_api/v201603/experiment_service.rb +46 -0
  402. data/lib/adwords_api/v201603/experiment_service_registry.rb +46 -0
  403. data/lib/adwords_api/v201603/feed_item_service.rb +54 -0
  404. data/lib/adwords_api/v201603/feed_item_service_registry.rb +46 -0
  405. data/lib/adwords_api/v201603/feed_mapping_service.rb +54 -0
  406. data/lib/adwords_api/v201603/feed_mapping_service_registry.rb +46 -0
  407. data/lib/adwords_api/v201603/feed_service.rb +54 -0
  408. data/lib/adwords_api/v201603/feed_service_registry.rb +46 -0
  409. data/lib/adwords_api/v201603/label_service.rb +54 -0
  410. data/lib/adwords_api/v201603/label_service_registry.rb +46 -0
  411. data/lib/adwords_api/v201603/location_criterion_service.rb +46 -0
  412. data/lib/adwords_api/v201603/location_criterion_service_registry.rb +46 -0
  413. data/lib/adwords_api/v201603/managed_customer_service.rb +78 -0
  414. data/lib/adwords_api/v201603/managed_customer_service_registry.rb +46 -0
  415. data/lib/adwords_api/v201603/media_service.rb +54 -0
  416. data/lib/adwords_api/v201603/media_service_registry.rb +46 -0
  417. data/lib/adwords_api/v201603/offline_conversion_feed_service.rb +38 -0
  418. data/lib/adwords_api/v201603/offline_conversion_feed_service_registry.rb +46 -0
  419. data/lib/adwords_api/v201603/report_definition_service.rb +38 -0
  420. data/lib/adwords_api/v201603/report_definition_service_registry.rb +46 -0
  421. data/lib/adwords_api/v201603/shared_criterion_service.rb +54 -0
  422. data/lib/adwords_api/v201603/shared_criterion_service_registry.rb +46 -0
  423. data/lib/adwords_api/v201603/shared_set_service.rb +54 -0
  424. data/lib/adwords_api/v201603/shared_set_service_registry.rb +46 -0
  425. data/lib/adwords_api/v201603/targeting_idea_service.rb +38 -0
  426. data/lib/adwords_api/v201603/targeting_idea_service_registry.rb +46 -0
  427. data/lib/adwords_api/v201603/traffic_estimator_service.rb +38 -0
  428. data/lib/adwords_api/v201603/traffic_estimator_service_registry.rb +46 -0
  429. data/lib/adwords_api/v201603/trial_async_error_service.rb +46 -0
  430. data/lib/adwords_api/v201603/trial_async_error_service_registry.rb +46 -0
  431. data/lib/adwords_api/v201603/trial_service.rb +54 -0
  432. data/lib/adwords_api/v201603/trial_service_registry.rb +46 -0
  433. data/lib/adwords_api/version.rb +1 -1
  434. data/test/adwords_api/test_batch_job_utils.rb +5 -3
  435. data/test/adwords_api/test_report_utils.rb +2 -4
  436. data/test/suite_unittests.rb +4 -0
  437. data/test/templates/v201506/basic_operations_get_campaigns.def +0 -0
  438. data/test/templates/v201506/misc_use_oauth2_service_account.def +0 -0
  439. data/test/templates/v201509/basic_operations_get_campaigns.def +0 -0
  440. data/test/templates/v201509/misc_use_oauth2_service_account.def +0 -0
  441. metadata +172 -4
@@ -0,0 +1,104 @@
1
+ #!/usr/bin/env ruby
2
+ # Encoding: utf-8
3
+ #
4
+ # Copyright:: Copyright 2013, Google Inc. All Rights Reserved.
5
+ #
6
+ # License:: 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
15
+ # implied.
16
+ # See the License for the specific language governing permissions and
17
+ # limitations under the License.
18
+ #
19
+ # This example sets a bid modifier for the mobile platform on given campaign.
20
+ # To get campaigns, run get_campaigns.rb.
21
+
22
+ require 'adwords_api'
23
+
24
+ def set_criterion_bid_modifier(campaign_id, bid_modifier)
25
+ # AdwordsApi::Api will read a config file from ENV['HOME']/adwords_api.yml
26
+ # when called without parameters.
27
+ adwords = AdwordsApi::Api.new
28
+
29
+ # To enable logging of SOAP requests, set the log_level value to 'DEBUG' in
30
+ # the configuration file or provide your own logger:
31
+ # adwords.logger = Logger.new('adwords_xml.log')
32
+
33
+ campaign_criterion_srv =
34
+ adwords.service(:CampaignCriterionService, API_VERSION)
35
+
36
+ # Create campaign criterion with modified bid.
37
+ campaign_criterion = {
38
+ :campaign_id => campaign_id,
39
+ # Mobile platform. The ID can be found in the documentation.
40
+ # https://developers.google.com/adwords/api/docs/appendix/platforms
41
+ :criterion => {
42
+ :xsi_type => 'Platform',
43
+ :id => 30001
44
+ },
45
+ :bid_modifier => bid_modifier
46
+ }
47
+
48
+ # Create operation.
49
+ operation = {
50
+ :operator => 'SET',
51
+ :operand => campaign_criterion
52
+ }
53
+
54
+ response = campaign_criterion_srv.mutate([operation])
55
+
56
+ if response and response[:value]
57
+ criteria = response[:value]
58
+ criteria.each do |campaign_criterion|
59
+ criterion = campaign_criterion[:criterion]
60
+ puts ("Campaign criterion with campaign ID %d, criterion ID %d was " +
61
+ "updated with bid modifier %f.") % [campaign_criterion[:campaign_id],
62
+ criterion[:id], campaign_criterion[:bid_modifier]]
63
+ end
64
+ else
65
+ puts 'No criteria were returned.'
66
+ end
67
+ end
68
+
69
+ if __FILE__ == $0
70
+ API_VERSION = :v201603
71
+
72
+ begin
73
+ # ID of a campaign to use mobile bid modifier for.
74
+ campaign_id = 'INSERT_CAMPAIGN_ID_HERE'.to_i
75
+
76
+ # Bid modifier to set.
77
+ bid_modifier = 1.5
78
+
79
+ set_criterion_bid_modifier(campaign_id, bid_modifier)
80
+
81
+ # Authorization error.
82
+ rescue AdsCommon::Errors::OAuth2VerificationRequired => e
83
+ puts "Authorization credentials are not valid. Edit adwords_api.yml for " +
84
+ "OAuth2 client ID and secret and run misc/setup_oauth2.rb example " +
85
+ "to retrieve and store OAuth2 tokens."
86
+ puts "See this wiki page for more details:\n\n " +
87
+ 'https://github.com/googleads/google-api-ads-ruby/wiki/OAuth2'
88
+
89
+ # HTTP errors.
90
+ rescue AdsCommon::Errors::HttpError => e
91
+ puts "HTTP Error: %s" % e
92
+
93
+ # API errors.
94
+ rescue AdwordsApi::Errors::ApiException => e
95
+ puts "Message: %s" % e.message
96
+ puts 'Errors:'
97
+ e.errors.each_with_index do |error, index|
98
+ puts "\tError [%d]:" % (index + 1)
99
+ error.each do |field, value|
100
+ puts "\t\t%s: %s" % [field, value]
101
+ end
102
+ end
103
+ end
104
+ end
@@ -0,0 +1,110 @@
1
+ #!/usr/bin/env ruby
2
+ # Encoding: utf-8
3
+ #
4
+ # Copyright:: Copyright 2011, Google Inc. All Rights Reserved.
5
+ #
6
+ # License:: 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
15
+ # implied.
16
+ # See the License for the specific language governing permissions and
17
+ # limitations under the License.
18
+ #
19
+ # This example shows how to use the 'validate only' header. No objects will be
20
+ # created, but exceptions will still be thrown.
21
+
22
+ require 'adwords_api'
23
+
24
+ def validate_text_ad(ad_group_id)
25
+ # AdwordsApi::Api will read a config file from ENV['HOME']/adwords_api.yml
26
+ # when called without parameters.
27
+ adwords = AdwordsApi::Api.new
28
+
29
+ # To enable logging of SOAP requests, set the log_level value to 'DEBUG' in
30
+ # the configuration file or provide your own logger:
31
+ # adwords.logger = Logger.new('adwords_xml.log')
32
+
33
+ ad_group_ad_srv = adwords.service(:AdGroupAdService, API_VERSION)
34
+
35
+ # Enable 'validate only' option.
36
+ adwords.validate_only = true
37
+
38
+ # Prepare for adding text ad.
39
+ operation = {
40
+ :operator => 'ADD',
41
+ :operand => {
42
+ :ad_group_id => ad_group_id,
43
+ :ad => {
44
+ :xsi_type => 'TextAd',
45
+ :headline => 'Luxury Cruise to Mars',
46
+ :description1 => 'Visit the Red Planet in style.',
47
+ :description2 => 'Low-gravity fun for everyone!',
48
+ :final_urls => ['http://www.example.com'],
49
+ :display_url => 'www.example.com'
50
+ }
51
+ }
52
+ }
53
+
54
+ # Validate text ad add operation.
55
+ response = ad_group_ad_srv.mutate([operation])
56
+ if response and response[:value]
57
+ ad = response[:value].first
58
+ puts "Unexpected ad creation! Name '%s', ID %d and status '%s'." %
59
+ [campaign[:name], campaign[:id], campaign[:status]]
60
+ else
61
+ puts 'Text ad validated, no error thrown and no ad created.'
62
+ end
63
+
64
+ # Now let's check an invalid ad using extra punctuation to trigger an error.
65
+ operation[:operand][:ad][:headline] = 'Luxury Cruise to Mars!!!!!'
66
+
67
+ # Validate text ad add operation.
68
+ begin
69
+ response = ad_group_ad_srv.mutate([operation])
70
+ if response and response[:value]
71
+ ad = response[:value].first
72
+ raise StandardError, ("Unexpected ad creation! Name '%s', ID %d and " +
73
+ "status '%s'.") % [campaign[:name], campaign[:id], campaign[:status]]
74
+ end
75
+ rescue AdwordsApi::Errors::ApiException => e
76
+ puts "Validation correctly failed with an exception: %s" % e.class
77
+ end
78
+ end
79
+
80
+ if __FILE__ == $0
81
+ API_VERSION = :v201603
82
+
83
+ begin
84
+ ad_group_id = 'INSERT_AD_GROUP_ID_HERE'.to_i
85
+ validate_text_ad(ad_group_id)
86
+
87
+ # Authorization error.
88
+ rescue AdsCommon::Errors::OAuth2VerificationRequired => e
89
+ puts "Authorization credentials are not valid. Edit adwords_api.yml for " +
90
+ "OAuth2 client ID and secret and run misc/setup_oauth2.rb example " +
91
+ "to retrieve and store OAuth2 tokens."
92
+ puts "See this wiki page for more details:\n\n " +
93
+ 'https://github.com/googleads/google-api-ads-ruby/wiki/OAuth2'
94
+
95
+ # HTTP errors.
96
+ rescue AdsCommon::Errors::HttpError => e
97
+ puts "HTTP Error: %s" % e
98
+
99
+ # API errors.
100
+ rescue AdwordsApi::Errors::ApiException => e
101
+ puts "Message: %s" % e.message
102
+ puts 'Errors:'
103
+ e.errors.each_with_index do |error, index|
104
+ puts "\tError [%d]:" % (index + 1)
105
+ error.each do |field, value|
106
+ puts "\t\t%s: %s" % [field, value]
107
+ end
108
+ end
109
+ end
110
+ end
@@ -0,0 +1,130 @@
1
+ #!/usr/bin/env ruby
2
+ # Encoding: utf-8
3
+ #
4
+ # Copyright:: Copyright 2011, Google Inc. All Rights Reserved.
5
+ #
6
+ # License:: 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
15
+ # implied.
16
+ # See the License for the specific language governing permissions and
17
+ # limitations under the License.
18
+ #
19
+ # This example demonstrates how to handle partial failures.
20
+
21
+ require 'adwords_api'
22
+ require 'adwords_api/utils'
23
+
24
+ def handle_partial_failures(ad_group_id)
25
+ # AdwordsApi::Api will read a config file from ENV['HOME']/adwords_api.yml
26
+ # when called without parameters.
27
+ adwords = AdwordsApi::Api.new
28
+
29
+ # To enable logging of SOAP requests, set the log_level value to 'DEBUG' in
30
+ # the configuration file or provide your own logger:
31
+ # adwords.logger = Logger.new('adwords_xml.log')
32
+
33
+ ad_group_criterion_srv =
34
+ adwords.service(:AdGroupCriterionService, API_VERSION)
35
+
36
+ # Set partial failures flag.
37
+ adwords.partial_failure = true
38
+
39
+ # Create keywords.
40
+ keyword_text = ['mars cruise', 'inv@lid cruise', 'venus cruise',
41
+ 'b(a)d keyword cruise']
42
+ keywords = []
43
+ keyword_text.each do |text|
44
+ keyword = {
45
+ # The 'xsi_type' field allows you to specify the xsi:type of the object
46
+ # being created. It's only necessary when you must provide an explicit
47
+ # type that the client library can't infer.
48
+ :xsi_type => 'Keyword',
49
+ :match_type => 'BROAD',
50
+ :text => text
51
+ }
52
+ keywords << keyword
53
+ end
54
+
55
+ # Create biddable ad group criteria and operations.
56
+ operations = []
57
+ keywords.each do |kwd|
58
+ operation = {
59
+ :operator => 'ADD',
60
+ :operand => {
61
+ :xsi_type => 'BiddableAdGroupCriterion',
62
+ :ad_group_id => ad_group_id,
63
+ :criterion => kwd
64
+ }
65
+ }
66
+ operations << operation
67
+ end
68
+
69
+ # Add criteria.
70
+ response = ad_group_criterion_srv.mutate(operations)
71
+ if response and response[:value]
72
+ ad_group_criteria = response[:value]
73
+ ad_group_criteria.each do |ad_group_criterion|
74
+ if ad_group_criterion[:criterion]
75
+ puts "Ad group criterion with ad group id " +
76
+ "#{ad_group_criterion[:ad_group_id]}, criterion id "+
77
+ "#{ad_group_criterion[:criterion][:id]} and keyword \"" +
78
+ "#{ad_group_criterion[:criterion][:text]}\" was added."
79
+ end
80
+ end
81
+ else
82
+ puts "No criteria were added."
83
+ end
84
+
85
+ # Check partial failures.
86
+ if response and response[:partial_failure_errors]
87
+ response[:partial_failure_errors].each do |error|
88
+ operation_index = AdwordsApi::Utils.operation_index_for_error(error)
89
+ if operation_index
90
+ ad_group_criterion = operations[operation_index][:operand]
91
+ puts "Ad group criterion with ad group id " +
92
+ "#{ad_group_criterion[:ad_group_id]} and keyword \"" +
93
+ "#{ad_group_criterion[:criterion][:text]}\" triggered an error " +
94
+ "for the following reason: \"#{error[:error_string]}\"."
95
+ end
96
+ end
97
+ end
98
+ end
99
+
100
+ if __FILE__ == $0
101
+ API_VERSION = :v201603
102
+
103
+ begin
104
+ ad_group_id = 'INSERT_AD_GROUP_ID_HERE'.to_i
105
+ handle_partial_failures(ad_group_id)
106
+
107
+ # Authorization error.
108
+ rescue AdsCommon::Errors::OAuth2VerificationRequired => e
109
+ puts "Authorization credentials are not valid. Edit adwords_api.yml for " +
110
+ "OAuth2 client ID and secret and run misc/setup_oauth2.rb example " +
111
+ "to retrieve and store OAuth2 tokens."
112
+ puts "See this wiki page for more details:\n\n " +
113
+ 'https://github.com/googleads/google-api-ads-ruby/wiki/OAuth2'
114
+
115
+ # HTTP errors.
116
+ rescue AdsCommon::Errors::HttpError => e
117
+ puts "HTTP Error: %s" % e
118
+
119
+ # API errors.
120
+ rescue AdwordsApi::Errors::ApiException => e
121
+ puts "Message: %s" % e.message
122
+ puts 'Errors:'
123
+ e.errors.each_with_index do |error, index|
124
+ puts "\tError [%d]:" % (index + 1)
125
+ error.each do |field, value|
126
+ puts "\t\t%s: %s" % [field, value]
127
+ end
128
+ end
129
+ end
130
+ end
@@ -0,0 +1,141 @@
1
+ #!/usr/bin/env ruby
2
+ # Encoding: utf-8
3
+ #
4
+ # Copyright:: Copyright 2011, Google Inc. All Rights Reserved.
5
+ #
6
+ # License:: 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
15
+ # implied.
16
+ # See the License for the specific language governing permissions and
17
+ # limitations under the License.
18
+ #
19
+ # This example demonstrates how to handle policy violation errors. To create
20
+ # an ad group, run add_ad_group.rb.
21
+
22
+ require 'adwords_api'
23
+ require 'adwords_api/utils'
24
+
25
+ def handle_policy_violation_error(ad_group_id)
26
+ # AdwordsApi::Api will read a config file from ENV['HOME']/adwords_api.yml
27
+ # when called without parameters.
28
+ adwords = AdwordsApi::Api.new
29
+
30
+ # To enable logging of SOAP requests, set the log_level value to 'DEBUG' in
31
+ # the configuration file or provide your own logger:
32
+ # adwords.logger = Logger.new('adwords_xml.log')
33
+
34
+ ad_group_ad_srv = adwords.service(:AdGroupAdService, API_VERSION)
35
+
36
+ # Create text ad.
37
+ text_ad_operation = {
38
+ :operator => 'ADD',
39
+ :operand => {
40
+ :ad_group_id => ad_group_id,
41
+ :ad => {
42
+ # The 'xsi_type' field allows you to specify the xsi:type of the object
43
+ # being created. It's only necessary when you must provide an explicit
44
+ # type that the client library can't infer.
45
+ :xsi_type => 'TextAd',
46
+ :headline => 'Mars Cruise!!!',
47
+ :description1 => 'Visit the Red Planet in style.',
48
+ :description2 => 'Low-gravity fun for everyone!',
49
+ :final_urls => ['http://www.example.com'],
50
+ :display_url => 'www.example.com',
51
+ }
52
+ }
53
+ }
54
+
55
+ operations = [text_ad_operation]
56
+
57
+ # Validate ad.
58
+ begin
59
+ # Enable "validate only" for the length of this block
60
+ adwords.validate_only do
61
+ ad_group_ad_srv.mutate(operations)
62
+ end
63
+ puts 'Validation successful, no errors returned.'
64
+ rescue AdwordsApi::Errors::ApiException => e
65
+ e.errors.each do |error|
66
+ if error[:xsi_type] == 'PolicyViolationError'
67
+ operation_index = AdwordsApi::Utils.operation_index_for_error(error)
68
+ operation = operations[operation_index]
69
+ puts "Ad with headline '%s' violated %s policy '%s'." %
70
+ [operation[:operand][:ad][:headline],
71
+ error[:is_exemptable] ? 'exemptable' : 'non-exemptable',
72
+ error[:external_policy_name]]
73
+ if error[:is_exemptable]
74
+ # Add exemption request to the operation.
75
+ puts "Adding exemption request for policy name '%s' on text '%s'." %
76
+ [error[:key][:policy_name], error[:key][:violating_text]]
77
+ unless operation[:exemption_requests]
78
+ operation[:exemption_requests] = []
79
+ end
80
+ operation[:exemption_requests] << {
81
+ :key => error[:key]
82
+ }
83
+ else
84
+ # Remove non-exemptable operation
85
+ puts "Removing the operation from the request."
86
+ operations.delete(operation)
87
+ end
88
+ else
89
+ # Non-policy error returned, re-throw exception.
90
+ raise e
91
+ end
92
+ end
93
+ end
94
+
95
+ # Add ads.
96
+ if operations.size > 0
97
+ response = ad_group_ad_srv.mutate(operations)
98
+ if response and response[:value]
99
+ ads = response[:value]
100
+ puts "Added #{ads.length} ad(s) to ad group #{ad_group_id}."
101
+ ads.each do |ad|
102
+ puts " Ad id is #{ad[:ad][:id]}, type is #{ad[:ad][:xsi_type]} and " +
103
+ "status is \"#{ad[:status]}\"."
104
+ end
105
+ else
106
+ puts "No ads were added."
107
+ end
108
+ end
109
+ end
110
+
111
+ if __FILE__ == $0
112
+ API_VERSION = :v201603
113
+
114
+ begin
115
+ ad_group_id = 'INSERT_AD_GROUP_ID_HERE'.to_i
116
+ handle_policy_violation_error(ad_group_id)
117
+
118
+ # Authorization error.
119
+ rescue AdsCommon::Errors::OAuth2VerificationRequired => e
120
+ puts "Authorization credentials are not valid. Edit adwords_api.yml for " +
121
+ "OAuth2 client ID and secret and run misc/setup_oauth2.rb example " +
122
+ "to retrieve and store OAuth2 tokens."
123
+ puts "See this wiki page for more details:\n\n " +
124
+ 'https://github.com/googleads/google-api-ads-ruby/wiki/OAuth2'
125
+
126
+ # HTTP errors.
127
+ rescue AdsCommon::Errors::HttpError => e
128
+ puts "HTTP Error: %s" % e
129
+
130
+ # API errors.
131
+ rescue AdwordsApi::Errors::ApiException => e
132
+ puts "Message: %s" % e.message
133
+ puts 'Errors:'
134
+ e.errors.each_with_index do |error, index|
135
+ puts "\tError [%d]:" % (index + 1)
136
+ error.each do |field, value|
137
+ puts "\t\t%s: %s" % [field, value]
138
+ end
139
+ end
140
+ end
141
+ end