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,184 @@
1
+ #!/usr/bin/env ruby
2
+ # Encoding: utf-8
3
+ #
4
+ # Copyright:: Copyright 2015, 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 adds an ad customizer feed using Extension Services. Then it adds
20
+ # an ad that uses the feed to populate dynamic data.
21
+
22
+ require 'adwords_api'
23
+ require 'date'
24
+
25
+ def add_ad_customizers(feed_name, ad_group_ids)
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
+ feed_item_srv = adwords.service(:FeedItemService, API_VERSION)
35
+ ad_group_ad_srv = adwords.service(:AdGroupAdService, API_VERSION)
36
+
37
+ # Create a customizer feed. One feed per account can be used for all ads.
38
+ feed_data = create_customizer_feed(adwords, feed_name)
39
+
40
+ # Now adding feed items -- the values we'd like to place.
41
+ now_date = Date.today()
42
+
43
+ items_data = [
44
+ {
45
+ :name => 'Mars',
46
+ :price => '$1234.56',
47
+ :date => now_date.strftime('%Y%m01 000000'),
48
+ :ad_group_id => ad_group_ids[0]
49
+ },
50
+ {
51
+ :name => 'Venus',
52
+ :price => '$1450.00',
53
+ :date => now_date.strftime('%Y%m15 000000'),
54
+ :ad_group_id => ad_group_ids[1]
55
+ }
56
+ ]
57
+
58
+ feed_items = items_data.map do |item|
59
+ {
60
+ :feed_id => feed_data[:feed_id],
61
+ :attribute_values => [
62
+ {
63
+ :feed_attribute_id => feed_data[:name_id],
64
+ :string_value => item[:name]
65
+ },
66
+ {
67
+ :feed_attribute_id => feed_data[:price_id],
68
+ :string_value => item[:price]
69
+ },
70
+ {
71
+ :feed_attribute_id => feed_data[:date_id],
72
+ :string_value => item[:date]
73
+ }
74
+ ],
75
+ :ad_group_targeting => {
76
+ :targeting_ad_group_id => item[:ad_group_id]
77
+ }
78
+ }
79
+ end
80
+
81
+ feed_items_operations = feed_items.map do |item|
82
+ {:operator => 'ADD', :operand => item}
83
+ end
84
+
85
+ response = feed_item_srv.mutate(feed_items_operations)
86
+ if response and response[:value]
87
+ response[:value].each do |feed_item|
88
+ puts 'Feed item with ID %d was added.' % feed_item[:feed_item_id]
89
+ end
90
+ else
91
+ raise new StandardError, 'No feed items were added.'
92
+ end
93
+
94
+ # All set! We can now create ads with customizations.
95
+ text_ad = {
96
+ :xsi_type => 'TextAd',
97
+ :headline => 'Luxury Cruise to {=%s.Name}' % feed_name,
98
+ :description1 => 'Only {=%s.Price}' % feed_name,
99
+ :description2 => 'Offer ends in {=countdown(%s.Date)}!' % feed_name,
100
+ :final_urls => ['http://www.example.com'],
101
+ :display_url => 'www.example.com'
102
+ }
103
+
104
+ # We add the same ad to both ad groups. When they serve, they will show
105
+ # different values, since they match different feed items.
106
+ operations = ad_group_ids.map do |ad_group_id|
107
+ {
108
+ :operator => 'ADD',
109
+ :operand => {
110
+ :ad_group_id => ad_group_id,
111
+ :ad => text_ad.dup()
112
+ }
113
+ }
114
+ end
115
+
116
+ response = ad_group_ad_srv.mutate(operations)
117
+ if response and response[:value]
118
+ ads = response[:value]
119
+ ads.each do |ad|
120
+ puts "\tCreated an ad with ID %d, type '%s' and status '%s'" %
121
+ [ad[:ad][:id], ad[:ad][:ad_type], ad[:status]]
122
+ end
123
+ else
124
+ raise StandardError, 'No ads were added.'
125
+ end
126
+ end
127
+
128
+ def create_customizer_feed(adwords, feed_name)
129
+ ad_customizer_srv = adwords.service(:AdCustomizerFeedService, API_VERSION)
130
+ feed = {
131
+ :feed_name => feed_name,
132
+ :feed_attributes => [
133
+ {:name => 'Name', :type => 'STRING'},
134
+ {:name => 'Price', :type => 'PRICE'},
135
+ {:name => 'Date', :type => 'DATE_TIME'}
136
+ ]
137
+ }
138
+ operation = {:operand => feed, :operator => 'ADD'}
139
+ added_feed = ad_customizer_srv.mutate([operation])[:value].first()
140
+ puts "Created ad customizer feed with ID = %d and name = '%s'." %
141
+ [added_feed[:feed_id], added_feed[:feed_name]]
142
+ return {
143
+ :feed_id => added_feed[:feed_id],
144
+ :name_id => added_feed[:feed_attributes][0][:id],
145
+ :price_id => added_feed[:feed_attributes][1][:id],
146
+ :date_id => added_feed[:feed_attributes][2][:id]
147
+ }
148
+ end
149
+
150
+ if __FILE__ == $0
151
+ API_VERSION = :v201603
152
+
153
+ begin
154
+ feed_name = 'INSERT_FEED_NAME_HERE'.to_s
155
+ ad_group_ids = [
156
+ 'INSERT_AD_GROUP_ID_HERE'.to_i,
157
+ 'INSERT_AD_GROUP_ID_HERE'.to_i
158
+ ]
159
+ add_ad_customizers(feed_name, ad_group_ids)
160
+
161
+ # Authorization error.
162
+ rescue AdsCommon::Errors::OAuth2VerificationRequired => e
163
+ puts "Authorization credentials are not valid. Edit adwords_api.yml for " +
164
+ "OAuth2 client ID and secret and run misc/setup_oauth2.rb example " +
165
+ "to retrieve and store OAuth2 tokens."
166
+ puts "See this wiki page for more details:\n\n " +
167
+ 'https://github.com/googleads/google-api-ads-ruby/wiki/OAuth2'
168
+
169
+ # HTTP errors.
170
+ rescue AdsCommon::Errors::HttpError => e
171
+ puts "HTTP Error: %s" % e
172
+
173
+ # API errors.
174
+ rescue AdwordsApi::Errors::ApiException => e
175
+ puts "Message: %s" % e.message
176
+ puts 'Errors:'
177
+ e.errors.each_with_index do |error, index|
178
+ puts "\tError [%d]:" % (index + 1)
179
+ error.each do |field, value|
180
+ puts "\t\t%s: %s" % [field, value]
181
+ end
182
+ end
183
+ end
184
+ end
@@ -0,0 +1,101 @@
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 illustrates how to add an ad group level mobile bid modifier
20
+ # override for a campaign.
21
+
22
+ require 'adwords_api'
23
+
24
+ def add_ad_group_bid_modifier(ad_group_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
+ bid_modifier_srv = adwords.service(:AdGroupBidModifierService, API_VERSION)
34
+
35
+ # Mobile criterion ID.
36
+ criterion_id = 30001
37
+
38
+ # Prepare to add an ad group level override.
39
+ operation = {
40
+ # Use 'ADD' to add a new modifier and 'SET' to update an existing one. A
41
+ # modifier can be removed with the 'REMOVE' operator.
42
+ :operator => 'ADD',
43
+ :operand => {
44
+ :ad_group_id => ad_group_id,
45
+ :criterion => {
46
+ :xsi_type => 'Platform',
47
+ :id => criterion_id
48
+ },
49
+ :bid_modifier => bid_modifier
50
+ }
51
+ }
52
+
53
+ # Add ad group level mobile bid modifier.
54
+ response = bid_modifier_srv.mutate([operation])
55
+ if response and response[:value]
56
+ modifier = response[:value].first
57
+ value = modifier[:bid_modifier] || 'unset'
58
+ puts ('Campaign ID %d, AdGroup ID %d, Criterion ID %d was updated with ' +
59
+ 'ad group level modifier: %s') %
60
+ [modifier[:campaign_id], modifier[:ad_group_id],
61
+ modifier[:criterion][:id], value]
62
+ else
63
+ puts 'No modifiers were added.'
64
+ end
65
+ end
66
+
67
+ if __FILE__ == $0
68
+ API_VERSION = :v201603
69
+
70
+ begin
71
+ # ID of an ad group to add an override for.
72
+ ad_group_id = 'INSERT_AD_GROUP_ID_HERE'.to_i
73
+ # Bid modifier to override with.
74
+ bid_modifier = 1.5
75
+
76
+ add_ad_group_bid_modifier(ad_group_id, bid_modifier)
77
+
78
+ # Authorization error.
79
+ rescue AdsCommon::Errors::OAuth2VerificationRequired => e
80
+ puts "Authorization credentials are not valid. Edit adwords_api.yml for " +
81
+ "OAuth2 client ID and secret and run misc/setup_oauth2.rb example " +
82
+ "to retrieve and store OAuth2 tokens."
83
+ puts "See this wiki page for more details:\n\n " +
84
+ 'https://github.com/googleads/google-api-ads-ruby/wiki/OAuth2'
85
+
86
+ # HTTP errors.
87
+ rescue AdsCommon::Errors::HttpError => e
88
+ puts "HTTP Error: %s" % e
89
+
90
+ # API errors.
91
+ rescue AdwordsApi::Errors::ApiException => e
92
+ puts "Message: %s" % e.message
93
+ puts 'Errors:'
94
+ e.errors.each_with_index do |error, index|
95
+ puts "\tError [%d]:" % (index + 1)
96
+ error.each do |field, value|
97
+ puts "\t\t%s: %s" % [field, value]
98
+ end
99
+ end
100
+ end
101
+ end
@@ -0,0 +1,133 @@
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 code example creates a click-to-download ad, also known as an app
20
+ # promotion ad to a given ad group. To list ad groups, run get_ad_groups.rb.
21
+
22
+ require 'adwords_api'
23
+
24
+ def add_click_to_download_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
+ # Create the template elements for the ad. You can refer to
36
+ # https://developers.google.com/adwords/api/docs/appendix/templateads
37
+ # for the list of available template fields.
38
+ ad_data = {
39
+ :unique_name => 'adData',
40
+ :fields => [
41
+ {
42
+ :name => 'headline',
43
+ :field_text => 'Enjoy your drive in Mars',
44
+ :type => 'TEXT'
45
+ },
46
+ {
47
+ :name => 'description1',
48
+ :field_text => 'Realistic physics simulation',
49
+ :type => 'TEXT'
50
+ },
51
+ {
52
+ :name => 'description2',
53
+ :field_text => 'Race against players online',
54
+ :type => 'TEXT'
55
+ },
56
+ {
57
+ :name => 'appId',
58
+ :field_text => 'com.example.demogame',
59
+ :type => 'TEXT'
60
+ },
61
+ {
62
+ :name => 'appStore',
63
+ :field_text => '2',
64
+ :type => 'ENUM'
65
+ }
66
+ ]
67
+ }
68
+
69
+ # Create click to download ad.
70
+ click_to_download_app_ad = {
71
+ :xsi_type => 'TemplateAd',
72
+ :name => 'Ad for demo game',
73
+ :template_id => 353,
74
+ :final_urls =>
75
+ ['http://play.google.com/store/apps/details?id=com.example.demogame'],
76
+ :display_url => 'play.google.com',
77
+ :template_elements => [ad_data]
78
+ }
79
+
80
+ # Create ad group ad.
81
+ ad_group_ad = {
82
+ :ad_group_id => ad_group_id,
83
+ :ad => click_to_download_app_ad,
84
+ # Optional.
85
+ :status => 'PAUSED'
86
+ }
87
+
88
+ # Add ad.
89
+ response = ad_group_ad_srv.mutate([
90
+ {:operator => 'ADD', :operand => ad_group_ad}
91
+ ])
92
+ if response and response[:value]
93
+ response[:value].each do |ad|
94
+ puts "Added new click-to-download ad to ad group ID %d with url '%s'." %
95
+ [ad[:ad][:id], ad[:ad][:final_urls[0]]]
96
+ end
97
+ else
98
+ raise StandardError, 'No ads were added.'
99
+ end
100
+ end
101
+
102
+ if __FILE__ == $0
103
+ API_VERSION = :v201603
104
+
105
+ begin
106
+ # Ad group ID to add text ads to.
107
+ ad_group_id = 'INSERT_AD_GROUP_ID_HERE'.to_i
108
+ add_click_to_download_ad(ad_group_id)
109
+
110
+ # Authorization error.
111
+ rescue AdsCommon::Errors::OAuth2VerificationRequired => e
112
+ puts "Authorization credentials are not valid. Edit adwords_api.yml for " +
113
+ "OAuth2 client ID and secret and run misc/setup_oauth2.rb example " +
114
+ "to retrieve and store OAuth2 tokens."
115
+ puts "See this wiki page for more details:\n\n " +
116
+ 'https://github.com/googleads/google-api-ads-ruby/wiki/OAuth2'
117
+
118
+ # HTTP errors.
119
+ rescue AdsCommon::Errors::HttpError => e
120
+ puts "HTTP Error: %s" % e
121
+
122
+ # API errors.
123
+ rescue AdwordsApi::Errors::ApiException => e
124
+ puts "Message: %s" % e.message
125
+ puts 'Errors:'
126
+ e.errors.each_with_index do |error, index|
127
+ puts "\tError [%d]:" % (index + 1)
128
+ error.each do |field, value|
129
+ puts "\t\t%s: %s" % [field, value]
130
+ end
131
+ end
132
+ end
133
+ end
@@ -0,0 +1,137 @@
1
+ #!/usr/bin/env ruby
2
+ # Encoding: utf-8
3
+ #
4
+ # Copyright:: Copyright 2015, 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 code example adds an HTML5 ad to a given ad group.
20
+ # To get ad groups, run basic_operations/get_ad_groups.rb.
21
+
22
+ require 'adwords_api'
23
+ require 'base64'
24
+
25
+ def add_html5_ad(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
+ # The HTML5 zip file contains all the HTML, CSS, and images needed for the
37
+ # HTML5 ad. For help on creating an HTML5 zip file, check out Google Web
38
+ # Designer (https://www.google.com/webdesigner).
39
+ html5_url = 'http://goo.gl/9Y7qI2'
40
+ html5_data = AdsCommon::Http.get(html5_url, adwords.config)
41
+ base64_html5_data = Base64.encode64(html5_data)
42
+
43
+ # Create a media bundle containing the zip file with all the HTML5
44
+ # components.
45
+ media_bundle = {
46
+ :xsi_type => 'MediaBundle',
47
+ :data => base64_html5_data,
48
+ :entry_point => 'carousel/index.html',
49
+ :type => 'MEDIA_BUNDLE'
50
+ }
51
+
52
+ # Create the template elements for the ad. You can refer to
53
+ # https://developers.google.com/adwords/api/docs/appendix/templateads
54
+ # for the list of available template fields.
55
+ ad_data = {
56
+ :unique_name => 'adData',
57
+ :fields => [
58
+ {
59
+ :name => 'Custom_layout',
60
+ :field_media => media_bundle,
61
+ :type => 'MEDIA_BUNDLE'
62
+ },
63
+ {
64
+ :name => 'layout',
65
+ :field_text => 'Custom',
66
+ :type => 'ENUM'
67
+ }
68
+ ]
69
+ }
70
+
71
+ html5_ad = {
72
+ :xsi_type => 'TemplateAd',
73
+ :name => 'Ad for HTML5',
74
+ :template_id => 419,
75
+ :final_urls => ['http://example.com/html5'],
76
+ :display_url => 'www.example.com/html5',
77
+ :dimensions => {
78
+ :width => 300,
79
+ :height => 250
80
+ },
81
+ :template_elements => [ad_data]
82
+ }
83
+
84
+ ad_group_ad = {
85
+ :ad_group_id => ad_group_id,
86
+ :ad => html5_ad,
87
+ :status => 'PAUSED'
88
+ }
89
+
90
+ operation = {
91
+ :operator => 'ADD',
92
+ :operand => ad_group_ad
93
+ }
94
+
95
+ response = ad_group_ad_srv.mutate([operation])
96
+ if response and !response.empty?
97
+ response[:value].each do |ad_group_ad|
98
+ puts "New HTML5 ad with ID %d and display url '%s' was added." %
99
+ [ad_group_ad[:ad][:id], ad_group_ad[:ad][:display_url]]
100
+ end
101
+ else
102
+ puts "No HTML5 ads were added."
103
+ end
104
+ end
105
+
106
+ if __FILE__ == $0
107
+ API_VERSION = :v201603
108
+
109
+ begin
110
+ # Ad group ID to add text ads to.
111
+ ad_group_id = 'INSERT_AD_GROUP_ID_HERE'.to_i
112
+ add_html5_ad(ad_group_id)
113
+
114
+ # Authorization error.
115
+ rescue AdsCommon::Errors::OAuth2VerificationRequired => e
116
+ puts "Authorization credentials are not valid. Edit adwords_api.yml for " +
117
+ "OAuth2 client ID and secret and run misc/setup_oauth2.rb example " +
118
+ "to retrieve and store OAuth2 tokens."
119
+ puts "See this wiki page for more details:\n\n " +
120
+ 'https://github.com/googleads/google-api-ads-ruby/wiki/OAuth2'
121
+
122
+ # HTTP errors.
123
+ rescue AdsCommon::Errors::HttpError => e
124
+ puts "HTTP Error: %s" % e
125
+
126
+ # API errors.
127
+ rescue AdwordsApi::Errors::ApiException => e
128
+ puts "Message: %s" % e.message
129
+ puts 'Errors:'
130
+ e.errors.each_with_index do |error, index|
131
+ puts "\tError [%d]:" % (index + 1)
132
+ error.each do |field, value|
133
+ puts "\t\t%s: %s" % [field, value]
134
+ end
135
+ end
136
+ end
137
+ end