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,193 @@
1
+ #!/usr/bin/env ruby
2
+ # Encoding: utf-8
3
+ #
4
+ # Copyright:: Copyright 2014, 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 a feed that syncs feed items from a Google My Business (GMB)
20
+ # account and associates the feed with a customer.
21
+
22
+ require 'adwords_api'
23
+ require 'date'
24
+
25
+ def add_gmb_location_extensions(gmb_email_address, gmb_access_token,
26
+ business_account_identifier)
27
+ # AdwordsApi::Api will read a config file from ENV['HOME']/adwords_api.yml
28
+ # when called without parameters.
29
+ adwords = AdwordsApi::Api.new
30
+
31
+ # To enable logging of SOAP requests, set the log_level value to 'DEBUG' in
32
+ # the configuration file or provide your own logger:
33
+ # adwords.logger = Logger.new('adwords_xml.log')
34
+
35
+ feed_srv = adwords.service(:FeedService, API_VERSION)
36
+ customer_feed_srv = adwords.service(:CustomerFeedService, API_VERSION)
37
+
38
+ if gmb_access_token.nil?
39
+ gmb_access_token = adwords.get_auth_handler.get_token(
40
+ adwords.credential_handler.credentials)[:access_token]
41
+ end
42
+
43
+ # Create a feed that will sync to the Google My Business account specified
44
+ # by gmb_email_address. Do not add FeedAttributes to this object, as AdWords
45
+ # will add them automatically because this will be a system generated feed.
46
+ gmb_feed = {
47
+ :name => "GMB feed #%d" % (Time.new.to_f * 1000).to_i,
48
+ :system_feed_generation_data => {
49
+ :xsi_type => 'PlacesLocationFeedData',
50
+ :o_auth_info => {
51
+ :http_method => 'GET',
52
+ :http_request_url => 'https://www.googleapis.com/auth/adwords',
53
+ :http_authorization_header => "Bearer %s" % gmb_access_token
54
+ },
55
+ :email_address => gmb_email_address
56
+ },
57
+ # Since this feed's feed items will be managed by AdWords, you must set
58
+ # its origin to ADWORDS.
59
+ :origin => 'ADWORDS'
60
+ }
61
+
62
+ # Optional: specify labels to filter Google My Business listings. If
63
+ # specified, only listings that have any of the labels set are synchronized
64
+ # into FeedItems.
65
+ gmb_feed[:system_feed_generation_data][:label_filters] =
66
+ ['Stores in New York City']
67
+
68
+ # Only include the business_account_identifier if it's specified.
69
+ # A nil value will cause an invalid request.
70
+ unless business_account_identifier.nil?
71
+ gmb_feed[:system_feed_generation_data][:business_account_identifier] =
72
+ business_account_identifier
73
+ end
74
+
75
+ gmb_operation = {
76
+ :operator => 'ADD',
77
+ :operand => gmb_feed
78
+ }
79
+
80
+ result = feed_srv.mutate([gmb_operation])
81
+ added_feed = result[:value].first
82
+ puts "Added GMB feed with ID %d" % added_feed[:id]
83
+
84
+ # Add a CustomerFeed that associates the feed with this customer for the
85
+ # LOCATION placeholder type.
86
+ customer_feed = {
87
+ :feed_id => added_feed[:id],
88
+ :placeholder_types => [PLACEHOLDER_TYPE_LOCATION],
89
+ :matching_function => {
90
+ :operator => 'IDENTITY',
91
+ :lhs_operand => {
92
+ :xsi_type => 'ConstantOperand',
93
+ :type => 'BOOLEAN',
94
+ :boolean_value => true
95
+ }
96
+ }
97
+ }
98
+
99
+ customer_feed_operation = {
100
+ :xsi_type => 'CustomerFeedOperation',
101
+ :operator => 'ADD',
102
+ :operand => customer_feed
103
+ }
104
+
105
+ added_customer_feed = nil
106
+ number_of_attempts = 0
107
+ while i < MAX_CUSTOMER_FEED_ADD_ATTEMPTS && !added_customer_feed
108
+ number_of_attempts += 1
109
+ begin
110
+ result = customer_feed_srv.mutate([customer_feed_operation])
111
+ added_customer_feed = result[:value].first
112
+ puts "Attempt #%d to add the CustomerFeed was successful" %
113
+ number_of_attempts
114
+ rescue
115
+ sleep_seconds = 5 * (2 ** number_of_attempts)
116
+ puts ("Attempt #%d to add the CustomerFeed was not succeessful. " +
117
+ "Waiting %d seconds before trying again.") %
118
+ [number_of_attempts, sleep_seconds]
119
+ sleep(sleep_seconds)
120
+ end
121
+ end
122
+
123
+ unless added_customer_feed
124
+ raise StandardError, ("Could not create the CustomerFeed after %d " +
125
+ "attempts. Please retry the CustomerFeed ADD operation later.") %
126
+ MAX_CUSTOMER_FEED_ADD_ATTEMPTS
127
+ end
128
+
129
+ puts "Added CustomerFeed for feed ID %d and placeholder type %d" %
130
+ [added_customer_feed[:id], added_customer_feed[:placeholder_types].first]
131
+
132
+ # OPTIONAL: Create a CampaignFeed to specify which FeedItems to use at the
133
+ # Campaign level. This will be similar to the CampaignFeed in the
134
+ # add_site_links example, except you can filter based on the business name
135
+ # and category of each FeedItem by using a FeedAttributeOperand in your
136
+ # matching function.
137
+
138
+ # OPTIONAL: Create an AdGroupFeed for even more fine grained control over
139
+ # which feed items are used at the AdGroup level.
140
+ end
141
+
142
+ if __FILE__ == $0
143
+ API_VERSION = :v201603
144
+ PLACEHOLDER_TYPE_LOCATION = 7
145
+ MAX_CUSTOMER_FEED_ADD_ATTEMPTS = 10
146
+
147
+ begin
148
+ # The email address of either an owner or a manager of the GMB account.
149
+ gmb_email_address = 'INSERT_GMB_EMAIL_ADDRESS_HERE'
150
+
151
+ # If the gmbEmailAddress above is the same as you used to generate your
152
+ # AdWords API refresh token, leave the value below as nil.
153
+ # Otherwise, to obtain an access token for your GMB account, generate a
154
+ # refresh token as you did for AdWords, but make sure you are logged in as
155
+ # the same user as gmb_email_address above when you follow the link, then
156
+ # capture the generated access token
157
+ gmb_access_token = nil
158
+
159
+ # If the gmb_email_address above is for a GMB manager instead of
160
+ # the GMB account owner, then set business_account_identifier to the
161
+ # +Page ID of a location for which the manager has access. See the
162
+ # location extensions guide at
163
+ # https://developers.google.com/adwords/api/docs/guides/feed-services-locations
164
+ # for details.
165
+ business_account_identifier = nil
166
+
167
+ add_gmb_location_extensions(gmb_email_address, gmb_access_token,
168
+ business_account_identifier)
169
+
170
+ # Authorization error.
171
+ rescue AdsCommon::Errors::OAuth2VerificationRequired => e
172
+ puts "Authorization credentials are not valid. Edit adwords_api.yml for " +
173
+ "OAuth2 client ID and secret and run misc/setup_oauth2.rb example " +
174
+ "to retrieve and store OAuth2 tokens."
175
+ puts "See this wiki page for more details:\n\n " +
176
+ 'https://github.com/googleads/google-api-ads-ruby/wiki/OAuth2'
177
+
178
+ # HTTP errors.
179
+ rescue AdsCommon::Errors::HttpError => e
180
+ puts "HTTP Error: %s" % e
181
+
182
+ # API errors.
183
+ rescue AdwordsApi::Errors::ApiException => e
184
+ puts "Message: %s" % e.message
185
+ puts 'Errors:'
186
+ e.errors.each_with_index do |error, index|
187
+ puts "\tError [%d]:" % (index + 1)
188
+ error.each do |field, value|
189
+ puts "\t\t%s: %s" % [field, value]
190
+ end
191
+ end
192
+ end
193
+ end
@@ -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 a sitelinks feed and associates it with a campaign.
20
+
21
+ require 'adwords_api'
22
+ require 'date'
23
+
24
+ def add_site_links(campaign_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
+ customer_srv = adwords.service(:CustomerService, API_VERSION)
34
+ customer = customer_srv.get()
35
+ customer_time_zone = customer[:date_time_zone]
36
+
37
+ campaign_extension_setting_srv =
38
+ adwords.service(:CampaignExtensionSettingService, API_VERSION)
39
+
40
+ sitelink_1 = {
41
+ :xsi_type => "SitelinkFeedItem",
42
+ :sitelink_text => "Store Hours",
43
+ :sitelink_final_urls => {
44
+ :urls => ["http://www.example.com/storehours"]
45
+ }
46
+ }
47
+
48
+ sitelink_2 = {
49
+ :xsi_type => "SitelinkFeedItem",
50
+ :sitelink_text => "Thanksgiving Specials",
51
+ :sitelink_final_urls => {
52
+ :urls => ["http://www.example.com/thanksgiving"]
53
+ },
54
+ :start_time => DateTime.new(Date.today.year, 11, 20, 0, 0, 0).
55
+ strftime("%Y%m%d %H%M%S ") + customer_time_zone,
56
+ :end_time => DateTime.new(Date.today.year, 11, 27, 23, 59, 59).
57
+ strftime("%Y%m%d %H%M%S ") + customer_time_zone,
58
+ # Target this sitelink for United States only. See
59
+ # https://developers.google.com/adwords/api/docs/appendix/geotargeting
60
+ # for valid geolocation codes.
61
+ :geo_targeting => {
62
+ :id => 2840
63
+ }
64
+ }
65
+
66
+ sitelink_3 = {
67
+ :xsi_type => "SitelinkFeedItem",
68
+ :sitelink_text => "Wifi available",
69
+ :sitelink_final_urls => {
70
+ :urls => ["http://www.example.com/mobile/wifi"]
71
+ },
72
+ :device_preference => {:device_preference => 30001},
73
+ # Target this sitelink only when the ad is triggered by the keyword
74
+ # "free wifi".
75
+ :keyword_targeting => {
76
+ :text => "free wifi",
77
+ :match_type => 'BROAD'
78
+ }
79
+ }
80
+
81
+ sitelink_4 = {
82
+ :xsi_type => "SitelinkFeedItem",
83
+ :sitelink_text => "Happy hours",
84
+ :sitelink_final_urls => {
85
+ :urls => ["http://www.example.com/happyhours"]
86
+ },
87
+ :scheduling => {
88
+ :feed_item_schedules => [
89
+ {
90
+ :day_of_week => 'MONDAY',
91
+ :start_hour => 18,
92
+ :start_minute => 'ZERO',
93
+ :end_hour => 21,
94
+ :end_minute => 'ZERO'
95
+ },
96
+ {
97
+ :day_of_week => 'TUESDAY',
98
+ :start_hour => 18,
99
+ :start_minute => 'ZERO',
100
+ :end_hour => 21,
101
+ :end_minute => 'ZERO'
102
+ },
103
+ {
104
+ :day_of_week => 'WEDNESDAY',
105
+ :start_hour => 18,
106
+ :start_minute => 'ZERO',
107
+ :end_hour => 21,
108
+ :end_minute => 'ZERO'
109
+ },
110
+ {
111
+ :day_of_week => 'THURSDAY',
112
+ :start_hour => 18,
113
+ :start_minute => 'ZERO',
114
+ :end_hour => 21,
115
+ :end_minute => 'ZERO'
116
+ },
117
+ {
118
+ :day_of_week => 'FRIDAY',
119
+ :start_hour => 18,
120
+ :start_minute => 'ZERO',
121
+ :end_hour => 21,
122
+ :end_minute => 'ZERO'
123
+ }
124
+ ]
125
+ }
126
+ }
127
+
128
+ campaign_extension_setting = {
129
+ :campaign_id => campaign_id,
130
+ :extension_type => 'SITELINK',
131
+ :extension_setting => {
132
+ :extensions => [sitelink_1, sitelink_2, sitelink_3, sitelink_4]
133
+ }
134
+ }
135
+
136
+ operation = {
137
+ :operand => campaign_extension_setting,
138
+ :operator => 'ADD'
139
+ }
140
+
141
+ response = campaign_extension_setting_srv.mutate([operation])
142
+ if response and response[:value]
143
+ new_extension_setting = response[:value].first
144
+ puts "Extension setting with type = %s was added to campaign ID %d" % [
145
+ new_extension_setting[:extension_type],
146
+ new_extension_setting[:campaign_id]
147
+ ]
148
+ elsif
149
+ puts "No extension settings were created."
150
+ end
151
+ end
152
+
153
+ if __FILE__ == $0
154
+ API_VERSION = :v201603
155
+
156
+ begin
157
+ # Campaign ID to add site link to.
158
+ campaign_id = 'INSERT_CAMPAIGN_ID_HERE'.to_i
159
+ add_site_links(campaign_id)
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,281 @@
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 adds a sitelinks feed and associates it with a campaign.
20
+
21
+ require 'adwords_api'
22
+
23
+ def add_site_links(campaign_id)
24
+ # AdwordsApi::Api will read a config file from ENV['HOME']/adwords_api.yml
25
+ # when called without parameters.
26
+ adwords = AdwordsApi::Api.new
27
+
28
+ # To enable logging of SOAP requests, set the log_level value to 'DEBUG' in
29
+ # the configuration file or provide your own logger:
30
+ # adwords.logger = Logger.new('adwords_xml.log')
31
+
32
+ feed_srv = adwords.service(:FeedService, API_VERSION)
33
+ feed_item_srv = adwords.service(:FeedItemService, API_VERSION)
34
+ feed_mapping_srv = adwords.service(:FeedMappingService, API_VERSION)
35
+ campaign_feed_srv = adwords.service(:CampaignFeedService, API_VERSION)
36
+
37
+ sitelinks_data = {}
38
+
39
+ # Create site links feed first.
40
+ site_links_feed = {
41
+ :name => 'Feed For Site Links',
42
+ :attributes => [
43
+ {:type => 'STRING', :name => 'Link Text'},
44
+ {:type => 'URL_LIST', :name => 'Final URLs'},
45
+ {:type => 'STRING', :name => 'Line 1 Description'},
46
+ {:type => 'STRING', :name => 'Line 2 Description'}
47
+ ]
48
+ }
49
+
50
+ response = feed_srv.mutate([
51
+ {:operator => 'ADD', :operand => site_links_feed}
52
+ ])
53
+ if response and response[:value]
54
+ feed = response[:value].first
55
+ # Attribute of type STRING.
56
+ link_text_feed_attribute_id = feed[:attributes][0][:id]
57
+ # Attribute of type URL_LIST.
58
+ final_url_feed_attribute_id = feed[:attributes][1][:id]
59
+ # Attribute of type STRING.
60
+ line_1_feed_attribute_id = feed[:attributes][2][:id]
61
+ #Attribute of type STRING.
62
+ line_2_feed_attribute_id = feed[:attributes][3][:id]
63
+ puts "Feed with name '%s' and ID %d was added with" %
64
+ [feed[:name], feed[:id]]
65
+ puts "\tText attribute ID %d and Final URLs attribute ID %d " +
66
+ "and Line 1 attribute ID %d and Line 2 attribute ID %d." % [
67
+ link_text_feed_attribute_id,
68
+ final_url_feed_attribute_id,
69
+ line_1_feed_attribute_id,
70
+ line_2_feed_attribute_id
71
+ ]
72
+
73
+ sitelinks_data[:feed_id] = feed[:id]
74
+ sitelinks_data[:link_text_feed_id] = link_text_feed_attribute_id
75
+ sitelinks_data[:final_url_feed_id] = final_url_feed_attribute_id
76
+ sitelinks_data[:line_1_feed_id] = line_1_feed_attribute_id
77
+ sitelinks_data[:line_2_feed_id] = line_2_feed_attribute_id
78
+ else
79
+ raise new StandardError, 'No feeds were added.'
80
+ end
81
+
82
+ # Create site links feed items.
83
+ items_data = [
84
+ {
85
+ :text => 'Home',
86
+ :final_urls => ['http://www.example.com'],
87
+ :line_1 => 'Home line 1',
88
+ :line_2 => 'Home line 2'
89
+ },
90
+ {
91
+ :text => 'Stores',
92
+ :final_urls => ['http://www.example.com/stores'],
93
+ :line_1 => 'Stores line 1',
94
+ :line_2 => 'Stores line 2'
95
+ },
96
+ {
97
+ :text => 'On Sale',
98
+ :final_urls => ['http://www.example.com/sale'],
99
+ :line_1 => 'On Sale line 1',
100
+ :line_2 => 'On Sale line 2'
101
+ },
102
+ {
103
+ :text => 'Support',
104
+ :final_urls => ['http://www.example.com/support'],
105
+ :line_1 => 'Support line 1',
106
+ :line_2 => 'Support line 2'
107
+ },
108
+ {
109
+ :text => 'Products',
110
+ :final_urls => ['http://www.example.com/products'],
111
+ :line_1 => 'Products line 1',
112
+ :line_2 => 'Products line 2'
113
+ },
114
+ {
115
+ :text => 'About Us',
116
+ :final_urls => ['http://www.example.com/about'],
117
+ :line_1 => 'About line 1',
118
+ :line_2 => 'About line 2',
119
+ :location_id => '21137'
120
+ }
121
+ ]
122
+
123
+ feed_items = items_data.map do |item|
124
+ feed_item = {
125
+ :feed_id => sitelinks_data[:feed_id],
126
+ :attribute_values => [
127
+ {
128
+ :feed_attribute_id => sitelinks_data[:link_text_feed_id],
129
+ :string_value => item[:text]
130
+ },
131
+ {
132
+ :feed_attribute_id => sitelinks_data[:final_url_feed_id],
133
+ :string_values => item[:final_urls]
134
+ },
135
+ {
136
+ :feed_attribute_id => sitelinks_data[:line_1_feed_id],
137
+ :string_value => item[:line_1]
138
+ },
139
+ {
140
+ :feed_attribute_id => sitelinks_data[:line_2_feed_id],
141
+ :string_value => item[:line_2]
142
+ }
143
+ ]
144
+ }
145
+ # OPTIONAL: Use geographical targeting on a feed.
146
+ # The IDs can be found in the documentation or retrieved with the
147
+ # LocationCriterionService.
148
+ unless item[:location_id].nil?
149
+ feed_item[:geo_targeting] = {
150
+ :id => item[:location_id]
151
+ }
152
+ end
153
+ next feed_item
154
+ end
155
+
156
+ feed_items_operations = feed_items.map do |item|
157
+ {:operator => 'ADD', :operand => item}
158
+ end
159
+
160
+ response = feed_item_srv.mutate(feed_items_operations)
161
+ if response and response[:value]
162
+ sitelinks_data[:feed_item_ids] = []
163
+ response[:value].each do |feed_item|
164
+ puts 'Feed item with ID %d was added.' % feed_item[:feed_item_id]
165
+ sitelinks_data[:feed_item_ids] << feed_item[:feed_item_id]
166
+ end
167
+ else
168
+ raise new StandardError, 'No feed items were added.'
169
+ end
170
+
171
+ # Create site links feed mapping.
172
+ feed_mapping = {
173
+ :placeholder_type => PLACEHOLDER_SITELINKS,
174
+ :feed_id => sitelinks_data[:feed_id],
175
+ :attribute_field_mappings => [
176
+ {
177
+ :feed_attribute_id => sitelinks_data[:link_text_feed_id],
178
+ :field_id => PLACEHOLDER_FIELD_SITELINK_LINK_TEXT
179
+ },
180
+ {
181
+ :feed_attribute_id => sitelinks_data[:final_url_feed_id],
182
+ :field_id => PLACEHOLDER_FIELD_SITELINK_FINAL_URLS
183
+ },
184
+ {
185
+ :feed_attribute_id => sitelinks_data[:line_1_feed_id],
186
+ :field_id => PLACEHOLDER_FIELD_SITELINK_LINE_1_TEXT
187
+ },
188
+ {
189
+ :feed_attribute_id => sitelinks_data[:line_2_feed_id],
190
+ :field_id => PLACEHOLDER_FIELD_SITELINK_LINE_2_TEXT
191
+ }
192
+ ]
193
+ }
194
+
195
+ response = feed_mapping_srv.mutate([
196
+ {:operator => 'ADD', :operand => feed_mapping}
197
+ ])
198
+ if response and response[:value]
199
+ feed_mapping = response[:value].first
200
+ puts ('Feed mapping with ID %d and placeholder type %d was saved for feed' +
201
+ ' with ID %d.') % [
202
+ feed_mapping[:feed_mapping_id],
203
+ feed_mapping[:placeholder_type],
204
+ feed_mapping[:feed_id]
205
+ ]
206
+ else
207
+ raise new StandardError, 'No feed mappings were added.'
208
+ end
209
+
210
+ # Construct a matching function that associates the sitelink feeditems to the
211
+ # campaign, and set the device preference to Mobile. See the matching function
212
+ # guide at:
213
+ # https://developers.google.com/adwords/api/docs/guides/feed-matching-functions
214
+ # for more details.
215
+ matching_function_string =
216
+ "AND(IN(FEED_ITEM_ID, {%s}), EQUALS(CONTEXT.DEVICE, 'Mobile'))" %
217
+ sitelinks_data[:feed_item_ids].join(',')
218
+
219
+ # Create site links campaign feed.
220
+ campaign_feed = {
221
+ :feed_id => sitelinks_data[:feed_id],
222
+ :campaign_id => campaign_id,
223
+ :matching_function => {:function_string => matching_function_string},
224
+ # Specifying placeholder types on the CampaignFeed allows the same feed
225
+ # to be used for different placeholders in different Campaigns.
226
+ :placeholder_types => [PLACEHOLDER_SITELINKS]
227
+ }
228
+
229
+ response = campaign_feed_srv.mutate([
230
+ {:operator => 'ADD', :operand => campaign_feed}
231
+ ])
232
+ if response and response[:value]
233
+ campaign_feed = response[:value].first
234
+ puts 'Campaign with ID %d was associated with feed with ID %d.' %
235
+ [campaign_feed[:campaign_id], campaign_feed[:feed_id]]
236
+ else
237
+ raise new StandardError, 'No campaign feeds were added.'
238
+ end
239
+ end
240
+
241
+ if __FILE__ == $0
242
+ API_VERSION = :v201603
243
+
244
+ # See the Placeholder reference page for a list of all the placeholder types
245
+ # and fields, see:
246
+ # https://developers.google.com/adwords/api/docs/appendix/placeholders
247
+ PLACEHOLDER_SITELINKS = 1
248
+ PLACEHOLDER_FIELD_SITELINK_LINK_TEXT = 1
249
+ PLACEHOLDER_FIELD_SITELINK_FINAL_URLS = 5
250
+ PLACEHOLDER_FIELD_SITELINK_LINE_1_TEXT = 3
251
+ PLACEHOLDER_FIELD_SITELINK_LINE_2_TEXT = 4
252
+
253
+ begin
254
+ # Campaign ID to add site link to.
255
+ campaign_id = 'INSERT_CAMPAIGN_ID_HERE'.to_i
256
+ add_site_links(campaign_id)
257
+
258
+ # Authorization error.
259
+ rescue AdsCommon::Errors::OAuth2VerificationRequired => e
260
+ puts "Authorization credentials are not valid. Edit adwords_api.yml for " +
261
+ "OAuth2 client ID and secret and run misc/setup_oauth2.rb example " +
262
+ "to retrieve and store OAuth2 tokens."
263
+ puts "See this wiki page for more details:\n\n " +
264
+ 'https://github.com/googleads/google-api-ads-ruby/wiki/OAuth2'
265
+
266
+ # HTTP errors.
267
+ rescue AdsCommon::Errors::HttpError => e
268
+ puts "HTTP Error: %s" % e
269
+
270
+ # API errors.
271
+ rescue AdwordsApi::Errors::ApiException => e
272
+ puts "Message: %s" % e.message
273
+ puts 'Errors:'
274
+ e.errors.each_with_index do |error, index|
275
+ puts "\tError [%d]:" % (index + 1)
276
+ error.each do |field, value|
277
+ puts "\t\t%s: %s" % [field, value]
278
+ end
279
+ end
280
+ end
281
+ end