google-adwords-api 0.16.1 → 0.17.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (343) hide show
  1. checksums.yaml +8 -8
  2. data/ChangeLog +6 -1
  3. data/README.md +1 -1
  4. data/examples/v201502/account_management/create_account.rb +1 -1
  5. data/examples/v201502/account_management/get_account_hierarchy.rb +1 -1
  6. data/examples/v201502/reporting/parallel_report_download.rb +1 -1
  7. data/examples/v201506/account_management/create_account.rb +1 -1
  8. data/examples/v201506/account_management/get_account_hierarchy.rb +1 -1
  9. data/examples/v201506/reporting/parallel_report_download.rb +1 -1
  10. data/examples/v201509/account_management/create_account.rb +88 -0
  11. data/examples/v201509/account_management/get_account_changes.rb +139 -0
  12. data/examples/v201509/account_management/get_account_hierarchy.rb +94 -0
  13. data/examples/v201509/advanced_operations/add_ad_customizers.rb +184 -0
  14. data/examples/v201509/advanced_operations/add_ad_group_bid_modifier.rb +101 -0
  15. data/examples/v201509/advanced_operations/add_click_to_download_ad.rb +133 -0
  16. data/examples/v201509/advanced_operations/add_html5_ad.rb +137 -0
  17. data/examples/v201509/advanced_operations/add_text_ad_with_upgraded_urls.rb +134 -0
  18. data/examples/v201509/advanced_operations/create_and_attach_shared_keyword_set.rb +141 -0
  19. data/examples/v201509/advanced_operations/find_and_remove_criteria_from_shared_set.rb +174 -0
  20. data/examples/v201509/advanced_operations/get_ad_group_bid_modifiers.rb +102 -0
  21. data/examples/v201509/advanced_operations/upload_offline_conversions.rb +113 -0
  22. data/examples/v201509/advanced_operations/use_shared_bidding_strategy.rb +147 -0
  23. data/examples/v201509/basic_operations/add_ad_groups.rb +140 -0
  24. data/examples/v201509/basic_operations/add_campaigns.rb +139 -0
  25. data/examples/v201509/basic_operations/add_keywords.rb +114 -0
  26. data/examples/v201509/basic_operations/add_text_ads.rb +109 -0
  27. data/examples/v201509/basic_operations/get_ad_groups.rb +102 -0
  28. data/examples/v201509/basic_operations/get_campaigns.rb +97 -0
  29. data/examples/v201509/basic_operations/get_campaigns_with_awql.rb +89 -0
  30. data/examples/v201509/basic_operations/get_keywords.rb +109 -0
  31. data/examples/v201509/basic_operations/get_text_ads.rb +110 -0
  32. data/examples/v201509/basic_operations/pause_ad.rb +88 -0
  33. data/examples/v201509/basic_operations/remove_ad.rb +89 -0
  34. data/examples/v201509/basic_operations/remove_ad_group.rb +85 -0
  35. data/examples/v201509/basic_operations/remove_campaign.rb +87 -0
  36. data/examples/v201509/basic_operations/remove_keyword.rb +94 -0
  37. data/examples/v201509/basic_operations/update_ad_group.rb +85 -0
  38. data/examples/v201509/basic_operations/update_campaign.rb +86 -0
  39. data/examples/v201509/basic_operations/update_keyword.rb +106 -0
  40. data/examples/v201509/campaign_management/add_campaign_labels.rb +82 -0
  41. data/examples/v201509/campaign_management/add_complete_campaigns_using_batch_job.rb +362 -0
  42. data/examples/v201509/campaign_management/add_experiment.rb +162 -0
  43. data/examples/v201509/campaign_management/add_keywords_in_bulk.rb +153 -0
  44. data/examples/v201509/campaign_management/get_all_disapproved_ads.rb +97 -0
  45. data/examples/v201509/campaign_management/get_all_disapproved_ads_with_awql.rb +89 -0
  46. data/examples/v201509/campaign_management/get_campaigns_by_label.rb +108 -0
  47. data/examples/v201509/campaign_management/promote_experiment.rb +81 -0
  48. data/examples/v201509/campaign_management/set_ad_parameters.rb +118 -0
  49. data/examples/v201509/campaign_management/set_criterion_bid_modifier.rb +104 -0
  50. data/examples/v201509/campaign_management/validate_text_ad.rb +110 -0
  51. data/examples/v201509/error_handling/handle_partial_failures.rb +130 -0
  52. data/examples/v201509/error_handling/handle_policy_violation_error.rb +141 -0
  53. data/examples/v201509/extensions/add_google_my_business_location_extensions.rb +193 -0
  54. data/examples/v201509/extensions/add_site_links.rb +164 -0
  55. data/examples/v201509/extensions/add_site_links_using_feeds.rb +281 -0
  56. data/examples/v201509/migration/migrate_to_extension_settings.rb +386 -0
  57. data/examples/v201509/migration/upgrade_ad_url.rb +93 -0
  58. data/examples/v201509/misc/get_all_images_and_videos.rb +104 -0
  59. data/examples/v201509/misc/setup_oauth2.rb +84 -0
  60. data/examples/v201509/misc/upload_image.rb +93 -0
  61. data/examples/v201509/misc/upload_media_bundle.rb +90 -0
  62. data/examples/v201509/misc/use_oauth2_jwt.rb +93 -0
  63. data/examples/v201509/misc/use_runtime_config.rb +92 -0
  64. data/examples/v201509/optimization/estimate_keyword_traffic.rb +146 -0
  65. data/examples/v201509/optimization/get_keyword_bid_simulations.rb +95 -0
  66. data/examples/v201509/optimization/get_keyword_ideas.rb +126 -0
  67. data/examples/v201509/remarketing/add_audience.rb +118 -0
  68. data/examples/v201509/remarketing/add_conversion_tracker.rb +98 -0
  69. data/examples/v201509/remarketing/add_crm_based_user_list.rb +121 -0
  70. data/examples/v201509/remarketing/add_rule_based_user_lists.rb +167 -0
  71. data/examples/v201509/reporting/download_criteria_report.rb +92 -0
  72. data/examples/v201509/reporting/download_criteria_report_with_awql.rb +93 -0
  73. data/examples/v201509/reporting/get_report_fields.rb +75 -0
  74. data/examples/v201509/reporting/parallel_report_download.rb +166 -0
  75. data/examples/v201509/shopping_campaigns/add_product_partition_tree.rb +267 -0
  76. data/examples/v201509/shopping_campaigns/add_product_scope.rb +129 -0
  77. data/examples/v201509/shopping_campaigns/add_shopping_campaign.rb +129 -0
  78. data/examples/v201509/shopping_campaigns/get_product_category_taxonomy.rb +115 -0
  79. data/examples/v201509/targeting/add_campaign_targeting_criteria.rb +180 -0
  80. data/examples/v201509/targeting/add_demographic_targeting_criteria.rb +112 -0
  81. data/examples/v201509/targeting/get_campaign_targeting_criteria.rb +106 -0
  82. data/examples/v201509/targeting/get_targetable_languages_and_carriers.rb +89 -0
  83. data/examples/v201509/targeting/lookup_location.rb +108 -0
  84. data/lib/adwords_api/api_config.rb +91 -4
  85. data/lib/adwords_api/batch_job_utils.rb +234 -0
  86. data/lib/adwords_api/errors.rb +3 -0
  87. data/lib/adwords_api/report_utils.rb +22 -6
  88. data/lib/adwords_api/v201502/account_label_service.rb +9 -1
  89. data/lib/adwords_api/v201502/account_label_service_registry.rb +1 -1
  90. data/lib/adwords_api/v201502/ad_customizer_feed_service.rb +9 -1
  91. data/lib/adwords_api/v201502/ad_customizer_feed_service_registry.rb +1 -1
  92. data/lib/adwords_api/v201502/ad_group_ad_service.rb +21 -1
  93. data/lib/adwords_api/v201502/ad_group_ad_service_registry.rb +2 -2
  94. data/lib/adwords_api/v201502/ad_group_bid_modifier_service.rb +13 -1
  95. data/lib/adwords_api/v201502/ad_group_bid_modifier_service_registry.rb +1 -1
  96. data/lib/adwords_api/v201502/ad_group_criterion_service.rb +17 -1
  97. data/lib/adwords_api/v201502/ad_group_criterion_service_registry.rb +1 -1
  98. data/lib/adwords_api/v201502/ad_group_extension_setting_service.rb +13 -1
  99. data/lib/adwords_api/v201502/ad_group_extension_setting_service_registry.rb +2 -2
  100. data/lib/adwords_api/v201502/ad_group_feed_service.rb +13 -1
  101. data/lib/adwords_api/v201502/ad_group_feed_service_registry.rb +1 -1
  102. data/lib/adwords_api/v201502/ad_group_service.rb +17 -1
  103. data/lib/adwords_api/v201502/ad_group_service_registry.rb +2 -2
  104. data/lib/adwords_api/v201502/ad_param_service.rb +9 -1
  105. data/lib/adwords_api/v201502/ad_param_service_registry.rb +1 -1
  106. data/lib/adwords_api/v201502/adwords_user_list_service.rb +9 -1
  107. data/lib/adwords_api/v201502/adwords_user_list_service_registry.rb +1 -1
  108. data/lib/adwords_api/v201502/bidding_strategy_service.rb +13 -1
  109. data/lib/adwords_api/v201502/bidding_strategy_service_registry.rb +1 -1
  110. data/lib/adwords_api/v201502/budget_order_service.rb +13 -1
  111. data/lib/adwords_api/v201502/budget_order_service_registry.rb +1 -1
  112. data/lib/adwords_api/v201502/budget_service.rb +13 -1
  113. data/lib/adwords_api/v201502/budget_service_registry.rb +1 -1
  114. data/lib/adwords_api/v201502/campaign_criterion_service.rb +13 -1
  115. data/lib/adwords_api/v201502/campaign_criterion_service_registry.rb +1 -1
  116. data/lib/adwords_api/v201502/campaign_extension_setting_service.rb +13 -1
  117. data/lib/adwords_api/v201502/campaign_extension_setting_service_registry.rb +2 -2
  118. data/lib/adwords_api/v201502/campaign_feed_service.rb +13 -1
  119. data/lib/adwords_api/v201502/campaign_feed_service_registry.rb +1 -1
  120. data/lib/adwords_api/v201502/campaign_service.rb +17 -1
  121. data/lib/adwords_api/v201502/campaign_service_registry.rb +2 -2
  122. data/lib/adwords_api/v201502/campaign_shared_set_service.rb +9 -1
  123. data/lib/adwords_api/v201502/campaign_shared_set_service_registry.rb +1 -1
  124. data/lib/adwords_api/v201502/constant_data_service.rb +37 -1
  125. data/lib/adwords_api/v201502/constant_data_service_registry.rb +1 -1
  126. data/lib/adwords_api/v201502/conversion_tracker_service.rb +13 -1
  127. data/lib/adwords_api/v201502/conversion_tracker_service_registry.rb +1 -1
  128. data/lib/adwords_api/v201502/customer_extension_setting_service.rb +13 -1
  129. data/lib/adwords_api/v201502/customer_extension_setting_service_registry.rb +2 -2
  130. data/lib/adwords_api/v201502/customer_feed_service.rb +13 -1
  131. data/lib/adwords_api/v201502/customer_feed_service_registry.rb +1 -1
  132. data/lib/adwords_api/v201502/customer_service.rb +9 -1
  133. data/lib/adwords_api/v201502/customer_service_registry.rb +1 -1
  134. data/lib/adwords_api/v201502/customer_sync_service.rb +5 -1
  135. data/lib/adwords_api/v201502/customer_sync_service_registry.rb +1 -1
  136. data/lib/adwords_api/v201502/data_service.rb +25 -1
  137. data/lib/adwords_api/v201502/data_service_registry.rb +1 -1
  138. data/lib/adwords_api/v201502/experiment_service.rb +9 -1
  139. data/lib/adwords_api/v201502/experiment_service_registry.rb +1 -1
  140. data/lib/adwords_api/v201502/feed_item_service.rb +13 -1
  141. data/lib/adwords_api/v201502/feed_item_service_registry.rb +1 -1
  142. data/lib/adwords_api/v201502/feed_mapping_service.rb +13 -1
  143. data/lib/adwords_api/v201502/feed_mapping_service_registry.rb +1 -1
  144. data/lib/adwords_api/v201502/feed_service.rb +13 -1
  145. data/lib/adwords_api/v201502/feed_service_registry.rb +1 -1
  146. data/lib/adwords_api/v201502/geo_location_service.rb +5 -1
  147. data/lib/adwords_api/v201502/geo_location_service_registry.rb +1 -1
  148. data/lib/adwords_api/v201502/label_service.rb +13 -1
  149. data/lib/adwords_api/v201502/label_service_registry.rb +1 -1
  150. data/lib/adwords_api/v201502/location_criterion_service.rb +9 -1
  151. data/lib/adwords_api/v201502/location_criterion_service_registry.rb +2 -2
  152. data/lib/adwords_api/v201502/managed_customer_service.rb +25 -1
  153. data/lib/adwords_api/v201502/managed_customer_service_registry.rb +1 -1
  154. data/lib/adwords_api/v201502/media_service.rb +13 -1
  155. data/lib/adwords_api/v201502/media_service_registry.rb +1 -1
  156. data/lib/adwords_api/v201502/mutate_job_service.rb +13 -1
  157. data/lib/adwords_api/v201502/mutate_job_service_registry.rb +2 -2
  158. data/lib/adwords_api/v201502/offline_conversion_feed_service.rb +5 -1
  159. data/lib/adwords_api/v201502/offline_conversion_feed_service_registry.rb +1 -1
  160. data/lib/adwords_api/v201502/report_definition_service.rb +5 -1
  161. data/lib/adwords_api/v201502/report_definition_service_registry.rb +1 -1
  162. data/lib/adwords_api/v201502/shared_criterion_service.rb +9 -1
  163. data/lib/adwords_api/v201502/shared_criterion_service_registry.rb +1 -1
  164. data/lib/adwords_api/v201502/shared_set_service.rb +9 -1
  165. data/lib/adwords_api/v201502/shared_set_service_registry.rb +1 -1
  166. data/lib/adwords_api/v201502/targeting_idea_service.rb +5 -1
  167. data/lib/adwords_api/v201502/targeting_idea_service_registry.rb +2 -2
  168. data/lib/adwords_api/v201502/traffic_estimator_service.rb +5 -1
  169. data/lib/adwords_api/v201502/traffic_estimator_service_registry.rb +2 -2
  170. data/lib/adwords_api/v201506/account_label_service.rb +9 -1
  171. data/lib/adwords_api/v201506/account_label_service_registry.rb +1 -1
  172. data/lib/adwords_api/v201506/ad_customizer_feed_service.rb +9 -1
  173. data/lib/adwords_api/v201506/ad_customizer_feed_service_registry.rb +1 -1
  174. data/lib/adwords_api/v201506/ad_group_ad_service.rb +21 -1
  175. data/lib/adwords_api/v201506/ad_group_ad_service_registry.rb +2 -2
  176. data/lib/adwords_api/v201506/ad_group_bid_modifier_service.rb +13 -1
  177. data/lib/adwords_api/v201506/ad_group_bid_modifier_service_registry.rb +1 -1
  178. data/lib/adwords_api/v201506/ad_group_criterion_service.rb +17 -1
  179. data/lib/adwords_api/v201506/ad_group_criterion_service_registry.rb +1 -1
  180. data/lib/adwords_api/v201506/ad_group_extension_setting_service.rb +13 -1
  181. data/lib/adwords_api/v201506/ad_group_extension_setting_service_registry.rb +2 -2
  182. data/lib/adwords_api/v201506/ad_group_feed_service.rb +13 -1
  183. data/lib/adwords_api/v201506/ad_group_feed_service_registry.rb +1 -1
  184. data/lib/adwords_api/v201506/ad_group_service.rb +17 -1
  185. data/lib/adwords_api/v201506/ad_group_service_registry.rb +2 -2
  186. data/lib/adwords_api/v201506/ad_param_service.rb +9 -1
  187. data/lib/adwords_api/v201506/ad_param_service_registry.rb +1 -1
  188. data/lib/adwords_api/v201506/adwords_user_list_service.rb +9 -1
  189. data/lib/adwords_api/v201506/adwords_user_list_service_registry.rb +1 -1
  190. data/lib/adwords_api/v201506/bidding_strategy_service.rb +13 -1
  191. data/lib/adwords_api/v201506/bidding_strategy_service_registry.rb +1 -1
  192. data/lib/adwords_api/v201506/budget_order_service.rb +13 -1
  193. data/lib/adwords_api/v201506/budget_order_service_registry.rb +1 -1
  194. data/lib/adwords_api/v201506/budget_service.rb +13 -1
  195. data/lib/adwords_api/v201506/budget_service_registry.rb +1 -1
  196. data/lib/adwords_api/v201506/campaign_criterion_service.rb +13 -1
  197. data/lib/adwords_api/v201506/campaign_criterion_service_registry.rb +1 -1
  198. data/lib/adwords_api/v201506/campaign_extension_setting_service.rb +13 -1
  199. data/lib/adwords_api/v201506/campaign_extension_setting_service_registry.rb +2 -2
  200. data/lib/adwords_api/v201506/campaign_feed_service.rb +13 -1
  201. data/lib/adwords_api/v201506/campaign_feed_service_registry.rb +1 -1
  202. data/lib/adwords_api/v201506/campaign_service.rb +17 -1
  203. data/lib/adwords_api/v201506/campaign_service_registry.rb +1 -1
  204. data/lib/adwords_api/v201506/campaign_shared_set_service.rb +13 -1
  205. data/lib/adwords_api/v201506/campaign_shared_set_service_registry.rb +1 -1
  206. data/lib/adwords_api/v201506/constant_data_service.rb +37 -1
  207. data/lib/adwords_api/v201506/constant_data_service_registry.rb +1 -1
  208. data/lib/adwords_api/v201506/conversion_tracker_service.rb +13 -1
  209. data/lib/adwords_api/v201506/conversion_tracker_service_registry.rb +1 -1
  210. data/lib/adwords_api/v201506/customer_extension_setting_service.rb +13 -1
  211. data/lib/adwords_api/v201506/customer_extension_setting_service_registry.rb +2 -2
  212. data/lib/adwords_api/v201506/customer_feed_service.rb +13 -1
  213. data/lib/adwords_api/v201506/customer_feed_service_registry.rb +1 -1
  214. data/lib/adwords_api/v201506/customer_service.rb +9 -1
  215. data/lib/adwords_api/v201506/customer_service_registry.rb +1 -1
  216. data/lib/adwords_api/v201506/customer_sync_service.rb +5 -1
  217. data/lib/adwords_api/v201506/customer_sync_service_registry.rb +1 -1
  218. data/lib/adwords_api/v201506/data_service.rb +25 -1
  219. data/lib/adwords_api/v201506/data_service_registry.rb +1 -1
  220. data/lib/adwords_api/v201506/experiment_service.rb +9 -1
  221. data/lib/adwords_api/v201506/experiment_service_registry.rb +1 -1
  222. data/lib/adwords_api/v201506/feed_item_service.rb +13 -1
  223. data/lib/adwords_api/v201506/feed_item_service_registry.rb +1 -1
  224. data/lib/adwords_api/v201506/feed_mapping_service.rb +13 -1
  225. data/lib/adwords_api/v201506/feed_mapping_service_registry.rb +1 -1
  226. data/lib/adwords_api/v201506/feed_service.rb +13 -1
  227. data/lib/adwords_api/v201506/feed_service_registry.rb +1 -1
  228. data/lib/adwords_api/v201506/geo_location_service.rb +5 -1
  229. data/lib/adwords_api/v201506/geo_location_service_registry.rb +1 -1
  230. data/lib/adwords_api/v201506/label_service.rb +13 -1
  231. data/lib/adwords_api/v201506/label_service_registry.rb +1 -1
  232. data/lib/adwords_api/v201506/location_criterion_service.rb +9 -1
  233. data/lib/adwords_api/v201506/location_criterion_service_registry.rb +2 -2
  234. data/lib/adwords_api/v201506/managed_customer_service.rb +25 -1
  235. data/lib/adwords_api/v201506/managed_customer_service_registry.rb +1 -1
  236. data/lib/adwords_api/v201506/media_service.rb +13 -1
  237. data/lib/adwords_api/v201506/media_service_registry.rb +1 -1
  238. data/lib/adwords_api/v201506/mutate_job_service.rb +13 -1
  239. data/lib/adwords_api/v201506/mutate_job_service_registry.rb +1 -1
  240. data/lib/adwords_api/v201506/offline_conversion_feed_service.rb +5 -1
  241. data/lib/adwords_api/v201506/offline_conversion_feed_service_registry.rb +1 -1
  242. data/lib/adwords_api/v201506/report_definition_service.rb +5 -1
  243. data/lib/adwords_api/v201506/report_definition_service_registry.rb +1 -1
  244. data/lib/adwords_api/v201506/shared_criterion_service.rb +13 -1
  245. data/lib/adwords_api/v201506/shared_criterion_service_registry.rb +1 -1
  246. data/lib/adwords_api/v201506/shared_set_service.rb +13 -1
  247. data/lib/adwords_api/v201506/shared_set_service_registry.rb +1 -1
  248. data/lib/adwords_api/v201506/targeting_idea_service.rb +5 -1
  249. data/lib/adwords_api/v201506/targeting_idea_service_registry.rb +1 -1
  250. data/lib/adwords_api/v201506/traffic_estimator_service.rb +5 -1
  251. data/lib/adwords_api/v201506/traffic_estimator_service_registry.rb +1 -1
  252. data/lib/adwords_api/v201509/account_label_service.rb +46 -0
  253. data/lib/adwords_api/v201509/account_label_service_registry.rb +46 -0
  254. data/lib/adwords_api/v201509/ad_customizer_feed_service.rb +46 -0
  255. data/lib/adwords_api/v201509/ad_customizer_feed_service_registry.rb +46 -0
  256. data/lib/adwords_api/v201509/ad_group_ad_service.rb +70 -0
  257. data/lib/adwords_api/v201509/ad_group_ad_service_registry.rb +46 -0
  258. data/lib/adwords_api/v201509/ad_group_bid_modifier_service.rb +54 -0
  259. data/lib/adwords_api/v201509/ad_group_bid_modifier_service_registry.rb +46 -0
  260. data/lib/adwords_api/v201509/ad_group_criterion_service.rb +62 -0
  261. data/lib/adwords_api/v201509/ad_group_criterion_service_registry.rb +46 -0
  262. data/lib/adwords_api/v201509/ad_group_extension_setting_service.rb +54 -0
  263. data/lib/adwords_api/v201509/ad_group_extension_setting_service_registry.rb +46 -0
  264. data/lib/adwords_api/v201509/ad_group_feed_service.rb +54 -0
  265. data/lib/adwords_api/v201509/ad_group_feed_service_registry.rb +46 -0
  266. data/lib/adwords_api/v201509/ad_group_service.rb +62 -0
  267. data/lib/adwords_api/v201509/ad_group_service_registry.rb +46 -0
  268. data/lib/adwords_api/v201509/ad_param_service.rb +46 -0
  269. data/lib/adwords_api/v201509/ad_param_service_registry.rb +46 -0
  270. data/lib/adwords_api/v201509/adwords_user_list_service.rb +54 -0
  271. data/lib/adwords_api/v201509/adwords_user_list_service_registry.rb +46 -0
  272. data/lib/adwords_api/v201509/batch_job_service.rb +54 -0
  273. data/lib/adwords_api/v201509/batch_job_service_registry.rb +46 -0
  274. data/lib/adwords_api/v201509/bidding_strategy_service.rb +54 -0
  275. data/lib/adwords_api/v201509/bidding_strategy_service_registry.rb +46 -0
  276. data/lib/adwords_api/v201509/budget_order_service.rb +54 -0
  277. data/lib/adwords_api/v201509/budget_order_service_registry.rb +46 -0
  278. data/lib/adwords_api/v201509/budget_service.rb +54 -0
  279. data/lib/adwords_api/v201509/budget_service_registry.rb +46 -0
  280. data/lib/adwords_api/v201509/campaign_criterion_service.rb +54 -0
  281. data/lib/adwords_api/v201509/campaign_criterion_service_registry.rb +46 -0
  282. data/lib/adwords_api/v201509/campaign_extension_setting_service.rb +54 -0
  283. data/lib/adwords_api/v201509/campaign_extension_setting_service_registry.rb +46 -0
  284. data/lib/adwords_api/v201509/campaign_feed_service.rb +54 -0
  285. data/lib/adwords_api/v201509/campaign_feed_service_registry.rb +46 -0
  286. data/lib/adwords_api/v201509/campaign_service.rb +62 -0
  287. data/lib/adwords_api/v201509/campaign_service_registry.rb +46 -0
  288. data/lib/adwords_api/v201509/campaign_shared_set_service.rb +54 -0
  289. data/lib/adwords_api/v201509/campaign_shared_set_service_registry.rb +46 -0
  290. data/lib/adwords_api/v201509/constant_data_service.rb +102 -0
  291. data/lib/adwords_api/v201509/constant_data_service_registry.rb +46 -0
  292. data/lib/adwords_api/v201509/conversion_tracker_service.rb +54 -0
  293. data/lib/adwords_api/v201509/conversion_tracker_service_registry.rb +46 -0
  294. data/lib/adwords_api/v201509/customer_extension_setting_service.rb +54 -0
  295. data/lib/adwords_api/v201509/customer_extension_setting_service_registry.rb +46 -0
  296. data/lib/adwords_api/v201509/customer_feed_service.rb +54 -0
  297. data/lib/adwords_api/v201509/customer_feed_service_registry.rb +46 -0
  298. data/lib/adwords_api/v201509/customer_service.rb +46 -0
  299. data/lib/adwords_api/v201509/customer_service_registry.rb +46 -0
  300. data/lib/adwords_api/v201509/customer_sync_service.rb +38 -0
  301. data/lib/adwords_api/v201509/customer_sync_service_registry.rb +47 -0
  302. data/lib/adwords_api/v201509/data_service.rb +78 -0
  303. data/lib/adwords_api/v201509/data_service_registry.rb +46 -0
  304. data/lib/adwords_api/v201509/experiment_service.rb +46 -0
  305. data/lib/adwords_api/v201509/experiment_service_registry.rb +46 -0
  306. data/lib/adwords_api/v201509/feed_item_service.rb +54 -0
  307. data/lib/adwords_api/v201509/feed_item_service_registry.rb +46 -0
  308. data/lib/adwords_api/v201509/feed_mapping_service.rb +54 -0
  309. data/lib/adwords_api/v201509/feed_mapping_service_registry.rb +46 -0
  310. data/lib/adwords_api/v201509/feed_service.rb +54 -0
  311. data/lib/adwords_api/v201509/feed_service_registry.rb +46 -0
  312. data/lib/adwords_api/v201509/label_service.rb +54 -0
  313. data/lib/adwords_api/v201509/label_service_registry.rb +46 -0
  314. data/lib/adwords_api/v201509/location_criterion_service.rb +46 -0
  315. data/lib/adwords_api/v201509/location_criterion_service_registry.rb +46 -0
  316. data/lib/adwords_api/v201509/managed_customer_service.rb +78 -0
  317. data/lib/adwords_api/v201509/managed_customer_service_registry.rb +46 -0
  318. data/lib/adwords_api/v201509/media_service.rb +54 -0
  319. data/lib/adwords_api/v201509/media_service_registry.rb +46 -0
  320. data/lib/adwords_api/v201509/mutate_job_service.rb +54 -0
  321. data/lib/adwords_api/v201509/mutate_job_service_registry.rb +46 -0
  322. data/lib/adwords_api/v201509/offline_conversion_feed_service.rb +38 -0
  323. data/lib/adwords_api/v201509/offline_conversion_feed_service_registry.rb +46 -0
  324. data/lib/adwords_api/v201509/report_definition_service.rb +38 -0
  325. data/lib/adwords_api/v201509/report_definition_service_registry.rb +46 -0
  326. data/lib/adwords_api/v201509/shared_criterion_service.rb +54 -0
  327. data/lib/adwords_api/v201509/shared_criterion_service_registry.rb +46 -0
  328. data/lib/adwords_api/v201509/shared_set_service.rb +54 -0
  329. data/lib/adwords_api/v201509/shared_set_service_registry.rb +46 -0
  330. data/lib/adwords_api/v201509/targeting_idea_service.rb +38 -0
  331. data/lib/adwords_api/v201509/targeting_idea_service_registry.rb +46 -0
  332. data/lib/adwords_api/v201509/traffic_estimator_service.rb +38 -0
  333. data/lib/adwords_api/v201509/traffic_estimator_service_registry.rb +46 -0
  334. data/lib/adwords_api/version.rb +1 -1
  335. data/lib/adwords_api.rb +16 -0
  336. data/test/adwords_api/test_batch_job_utils.rb +95 -0
  337. data/test/templates/v201502/basic_operations_get_campaigns.def +1 -1
  338. data/test/templates/v201502/misc_use_oauth2_service_account.def +1 -1
  339. data/test/templates/v201506/basic_operations_get_campaigns.def +1 -1
  340. data/test/templates/v201506/misc_use_oauth2_service_account.def +1 -1
  341. data/test/templates/v201509/basic_operations_get_campaigns.def +116 -0
  342. data/test/templates/v201509/misc_use_oauth2_service_account.def +131 -0
  343. metadata +166 -5
@@ -0,0 +1,126 @@
1
+ #!/usr/bin/env ruby
2
+ # Encoding: utf-8
3
+ #
4
+ # Copyright:: Copyright 2011, Google Inc. All Rights Reserved.
5
+ #
6
+ # License:: Licensed under the Apache License, Version 2.0 (the "License");
7
+ # you may not use this file except in compliance with the License.
8
+ # You may obtain a copy of the License at
9
+ #
10
+ # http://www.apache.org/licenses/LICENSE-2.0
11
+ #
12
+ # Unless required by applicable law or agreed to in writing, software
13
+ # distributed under the License is distributed on an "AS IS" BASIS,
14
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
15
+ # implied.
16
+ # See the License for the specific language governing permissions and
17
+ # limitations under the License.
18
+ #
19
+ # This example retrieves keywords that are related to a given keyword.
20
+
21
+ require 'adwords_api'
22
+
23
+ def get_keyword_ideas(keyword_text)
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
+ targeting_idea_srv = adwords.service(:TargetingIdeaService, API_VERSION)
33
+
34
+ # Construct selector object.
35
+ selector = {
36
+ :idea_type => 'KEYWORD',
37
+ :request_type => 'IDEAS',
38
+ :requested_attribute_types =>
39
+ ['KEYWORD_TEXT', 'SEARCH_VOLUME', 'CATEGORY_PRODUCTS_AND_SERVICES'],
40
+ :search_parameters => [
41
+ {
42
+ # The 'xsi_type' field allows you to specify the xsi:type of the object
43
+ # being created. It's only necessary when you must provide an explicit
44
+ # type that the client library can't infer.
45
+ :xsi_type => 'RelatedToQuerySearchParameter',
46
+ :queries => [keyword_text]
47
+ },
48
+ {
49
+ # Language setting (optional).
50
+ # The ID can be found in the documentation:
51
+ # https://developers.google.com/adwords/api/docs/appendix/languagecodes
52
+ # Only one LanguageSearchParameter is allowed per request.
53
+ :xsi_type => 'LanguageSearchParameter',
54
+ :languages => [{:id => 1000}]
55
+ }
56
+ ],
57
+ :paging => {
58
+ :start_index => 0,
59
+ :number_results => PAGE_SIZE
60
+ }
61
+ }
62
+
63
+ # Define initial values.
64
+ offset = 0
65
+ results = []
66
+
67
+ begin
68
+ # Perform request.
69
+ page = targeting_idea_srv.get(selector)
70
+ results += page[:entries] if page and page[:entries]
71
+
72
+ # Prepare next page request.
73
+ offset += PAGE_SIZE
74
+ selector[:paging][:start_index] = offset
75
+ end while offset < page[:total_num_entries]
76
+
77
+ # Display results.
78
+ results.each do |result|
79
+ data = result[:data]
80
+ keyword = data['KEYWORD_TEXT'][:value]
81
+ puts "Found keyword with text '%s'" % keyword
82
+ products_and_services = data['CATEGORY_PRODUCTS_AND_SERVICES'][:value]
83
+ if products_and_services
84
+ puts "\tWith Products and Services categories: [%s]" %
85
+ products_and_services.join(', ')
86
+ end
87
+ average_monthly_searches = data['SEARCH_VOLUME'][:value]
88
+ if average_monthly_searches
89
+ puts "\tand average monthly search volume: %d" % average_monthly_searches
90
+ end
91
+ end
92
+ puts "Total keywords related to '%s': %d." % [keyword_text, results.length]
93
+ end
94
+
95
+ if __FILE__ == $0
96
+ API_VERSION = :v201509
97
+ PAGE_SIZE = 100
98
+
99
+ begin
100
+ keyword_text = 'INSERT_KEYWORD_TEXT_HERE'
101
+ get_keyword_ideas(keyword_text)
102
+
103
+ # Authorization error.
104
+ rescue AdsCommon::Errors::OAuth2VerificationRequired => e
105
+ puts "Authorization credentials are not valid. Edit adwords_api.yml for " +
106
+ "OAuth2 client ID and secret and run misc/setup_oauth2.rb example " +
107
+ "to retrieve and store OAuth2 tokens."
108
+ puts "See this wiki page for more details:\n\n " +
109
+ 'https://github.com/googleads/google-api-ads-ruby/wiki/OAuth2'
110
+
111
+ # HTTP errors.
112
+ rescue AdsCommon::Errors::HttpError => e
113
+ puts "HTTP Error: %s" % e
114
+
115
+ # API errors.
116
+ rescue AdwordsApi::Errors::ApiException => e
117
+ puts "Message: %s" % e.message
118
+ puts 'Errors:'
119
+ e.errors.each_with_index do |error, index|
120
+ puts "\tError [%d]:" % (index + 1)
121
+ error.each do |field, value|
122
+ puts "\t\t%s: %s" % [field, value]
123
+ end
124
+ end
125
+ end
126
+ end
@@ -0,0 +1,118 @@
1
+ #!/usr/bin/env ruby
2
+ # Encoding: utf-8
3
+ #
4
+ # Copyright:: Copyright 2011, Google Inc. All Rights Reserved.
5
+ #
6
+ # License:: Licensed under the Apache License, Version 2.0 (the "License");
7
+ # you may not use this file except in compliance with the License.
8
+ # You may obtain a copy of the License at
9
+ #
10
+ # http://www.apache.org/licenses/LICENSE-2.0
11
+ #
12
+ # Unless required by applicable law or agreed to in writing, software
13
+ # distributed under the License is distributed on an "AS IS" BASIS,
14
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
15
+ # implied.
16
+ # See the License for the specific language governing permissions and
17
+ # limitations under the License.
18
+ #
19
+ # This example illustrates how to create a user list (a.k.a. Audience) and shows
20
+ # its associated conversion tracker code snippet.
21
+
22
+ require 'adwords_api'
23
+
24
+ def add_audience()
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
+ user_list_srv = adwords.service(:AdwordsUserListService, API_VERSION)
34
+ conv_tracker_srv = adwords.service(:ConversionTrackerService, API_VERSION)
35
+
36
+ # Prepare for adding remarketing user list.
37
+ name = "Mars cruise customers #%d" % (Time.new.to_f * 1000).to_i
38
+ operation = {
39
+ :operator => 'ADD',
40
+ :operand => {
41
+ # The 'xsi_type' field allows you to specify the xsi:type of the object
42
+ # being created. It's only necessary when you must provide an explicit
43
+ # type that the client library can't infer.
44
+ :xsi_type => 'BasicUserList',
45
+ :name => name,
46
+ :description => 'A list of mars cruise customers in the last year',
47
+ :membership_life_span => 365,
48
+ :conversion_types => [{:name => name}],
49
+ # Optional field.
50
+ :status => 'OPEN'
51
+ }
52
+ }
53
+
54
+ # Add user list.
55
+ response = user_list_srv.mutate([operation])
56
+ if response and response[:value]
57
+ user_list = response[:value].first
58
+
59
+ # Get conversion snippets.
60
+ if user_list and user_list[:conversion_types]
61
+ conversion_ids = user_list[:conversion_types][:id]
62
+ selector = {
63
+ # We're actually interested in the 'Snippet' field, which is returned
64
+ # automatically.
65
+ :fields => ['Id'],
66
+ :predicates => [
67
+ {:field => 'Id', :operator => 'IN', :values => [conversion_ids]}
68
+ ]
69
+ }
70
+ conv_tracker_response = conv_tracker_srv.get(selector)
71
+ if conv_tracker_response and conv_tracker_response[:entries]
72
+ conversions = conv_tracker_response[:entries]
73
+ end
74
+ end
75
+ puts "User list with name '%s' and ID %d was added." %
76
+ [user_list[:name], user_list[:id]]
77
+ # Display user list associated conversion code snippets.
78
+ if conversions
79
+ conversions.each do |conversion|
80
+ puts "Conversion type code snipped associated to the list:\n\t\t%s\n" %
81
+ conversion[:snippet]
82
+ end
83
+ end
84
+ else
85
+ puts 'No user lists were added.'
86
+ end
87
+ end
88
+
89
+ if __FILE__ == $0
90
+ API_VERSION = :v201509
91
+
92
+ begin
93
+ add_audience()
94
+
95
+ # Authorization error.
96
+ rescue AdsCommon::Errors::OAuth2VerificationRequired => e
97
+ puts "Authorization credentials are not valid. Edit adwords_api.yml for " +
98
+ "OAuth2 client ID and secret and run misc/setup_oauth2.rb example " +
99
+ "to retrieve and store OAuth2 tokens."
100
+ puts "See this wiki page for more details:\n\n " +
101
+ 'https://github.com/googleads/google-api-ads-ruby/wiki/OAuth2'
102
+
103
+ # HTTP errors.
104
+ rescue AdsCommon::Errors::HttpError => e
105
+ puts "HTTP Error: %s" % e
106
+
107
+ # API errors.
108
+ rescue AdwordsApi::Errors::ApiException => e
109
+ puts "Message: %s" % e.message
110
+ puts 'Errors:'
111
+ e.errors.each_with_index do |error, index|
112
+ puts "\tError [%d]:" % (index + 1)
113
+ error.each do |field, value|
114
+ puts "\t\t%s: %s" % [field, value]
115
+ end
116
+ end
117
+ end
118
+ end
@@ -0,0 +1,98 @@
1
+ #!/usr/bin/env ruby
2
+ # Encoding: utf-8
3
+ #
4
+ # Copyright:: Copyright 2011, Google Inc. All Rights Reserved.
5
+ #
6
+ # License:: Licensed under the Apache License, Version 2.0 (the "License");
7
+ # you may not use this file except in compliance with the License.
8
+ # You may obtain a copy of the License at
9
+ #
10
+ # http://www.apache.org/licenses/LICENSE-2.0
11
+ #
12
+ # Unless required by applicable law or agreed to in writing, software
13
+ # distributed under the License is distributed on an "AS IS" BASIS,
14
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
15
+ # implied.
16
+ # See the License for the specific language governing permissions and
17
+ # limitations under the License.
18
+ #
19
+ # This example illustrates how to add an AdWords conversion tracker.
20
+
21
+ require 'adwords_api'
22
+
23
+ def add_conversion_tracker()
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
+ conv_tracker_srv = adwords.service(:ConversionTrackerService, API_VERSION)
33
+
34
+ # Prepare for adding conversion.
35
+ operation = {
36
+ :operator => 'ADD',
37
+ :operand => {
38
+ # The 'xsi_type' field allows you to specify the xsi:type of the object
39
+ # being created. It's only necessary when you must provide an explicit
40
+ # type that the client library can't infer.
41
+ :xsi_type => 'AdWordsConversionTracker',
42
+ :name => "Earth to Mars Cruises Conversion #%d" %
43
+ (Time.new.to_f * 1000).to_i,
44
+ :category => 'DEFAULT',
45
+ :markup_language => 'HTML',
46
+ :text_format => 'HIDDEN',
47
+ # Optional fields:
48
+ :status => 'ENABLED',
49
+ :viewthrough_lookback_window => 15,
50
+ :conversion_page_language => 'en',
51
+ :background_color => '#0000FF',
52
+ :default_revenue_value => 23.41,
53
+ :always_use_default_revenue_value => true
54
+ }
55
+ }
56
+
57
+ # Add conversion.
58
+ response = conv_tracker_srv.mutate([operation])
59
+ if response and response[:value]
60
+ conversion = response[:value].first
61
+ puts ("Conversion with ID %d, name '%s', status '%s' and category '%s'" +
62
+ " was added.") % [conversion[:id], conversion[:name],
63
+ conversion[:status], conversion[:category]]
64
+ else
65
+ puts 'No conversions were added.'
66
+ end
67
+ end
68
+
69
+ if __FILE__ == $0
70
+ API_VERSION = :v201509
71
+
72
+ begin
73
+ add_conversion_tracker()
74
+
75
+ # Authorization error.
76
+ rescue AdsCommon::Errors::OAuth2VerificationRequired => e
77
+ puts "Authorization credentials are not valid. Edit adwords_api.yml for " +
78
+ "OAuth2 client ID and secret and run misc/setup_oauth2.rb example " +
79
+ "to retrieve and store OAuth2 tokens."
80
+ puts "See this wiki page for more details:\n\n " +
81
+ 'https://github.com/googleads/google-api-ads-ruby/wiki/OAuth2'
82
+
83
+ # HTTP errors.
84
+ rescue AdsCommon::Errors::HttpError => e
85
+ puts "HTTP Error: %s" % e
86
+
87
+ # API errors.
88
+ rescue AdwordsApi::Errors::ApiException => e
89
+ puts "Message: %s" % e.message
90
+ puts 'Errors:'
91
+ e.errors.each_with_index do |error, index|
92
+ puts "\tError [%d]:" % (index + 1)
93
+ error.each do |field, value|
94
+ puts "\t\t%s: %s" % [field, value]
95
+ end
96
+ end
97
+ end
98
+ end
@@ -0,0 +1,121 @@
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 remarketing user list (a.k.a. audience) and uploads
20
+ # hashed email addresses to populate the list.
21
+ #
22
+ # Note: It may take several hours for the list to be populated with members.
23
+ # Email addresses must be associated with a Google account. For privacy
24
+ # purposes, the user list size will show as zero until the list has at least
25
+ # 1000 members. After that, the size will be rounded to the two most
26
+ # significant digits.
27
+
28
+ require 'adwords_api'
29
+ require 'digest'
30
+
31
+ def add_crm_based_user_list(emails)
32
+ # AdwordsApi::Api will read a config file from ENV['HOME']/adwords_api.yml
33
+ # when called without parameters.
34
+ adwords = AdwordsApi::Api.new
35
+
36
+ # To enable logging of SOAP requests, set the log_level value to 'DEBUG' in
37
+ # the configuration file or provide your own logger:
38
+ # adwords.logger = Logger.new('adwords_xml.log')
39
+
40
+ user_list_srv = adwords.service(:AdwordsUserListService, API_VERSION)
41
+
42
+ user_list = {
43
+ :xsi_type => 'CrmBasedUserList',
44
+ :name => 'Customer relationship management list #%d' % Time.new.usec,
45
+ :description => 'A list of customers that originated from email addresses',
46
+ # Maximum life span is 180 days.
47
+ :membership_life_span => 180,
48
+ # This field is required. It links to a service you created that allows
49
+ # members of this list to remove themselves. It will be shown in the
50
+ # "Why This Ad?" of an ad and so it needs to be verified. Read more about
51
+ # "Why This Ad?" here https://support.google.com/ads/answer/2662850.
52
+ :opt_out_link => 'http://endpoint1.example.com/optout'
53
+ }
54
+
55
+ operation = {
56
+ :operand => user_list,
57
+ :operator => 'ADD'
58
+ }
59
+
60
+ result = user_list_srv.mutate([operation])
61
+ user_list_id = result[:value].first[:id]
62
+
63
+ sha_digest = Digest::SHA256.new
64
+ hashed_emails = emails.map do |email|
65
+ # Remove leading and trailing whitespace and convert all characters to
66
+ # lowercase before generating the hashed version.
67
+ email = email.strip.downcase
68
+ sha_digest.hexdigest(email)
69
+ end
70
+
71
+ mutate_members_operation = {
72
+ :operand => {
73
+ :user_list_id => user_list_id,
74
+ :data_type => 'EMAIL_SHA256',
75
+ :members => hashed_emails
76
+ },
77
+ :operator => 'ADD'
78
+ }
79
+
80
+ mutate_members_result =
81
+ user_list_srv.mutate_members([mutate_members_operation])
82
+
83
+ mutate_members_result[:user_lists].each do |user_list|
84
+ puts "User list with name '%s' and ID '%d' was added." %
85
+ [user_list[:name], user_list[:id]]
86
+ end
87
+ end
88
+
89
+ if __FILE__ == $0
90
+ API_VERSION = :v201509
91
+
92
+ emails = ['customer1@example.com', 'customer2@example.com',
93
+ ' Customer3@example.com ']
94
+
95
+ begin
96
+ add_crm_based_user_list(emails)
97
+
98
+ # Authorization error.
99
+ rescue AdsCommon::Errors::OAuth2VerificationRequired => e
100
+ puts "Authorization credentials are not valid. Edit adwords_api.yml for " +
101
+ "OAuth2 client ID and secret and run misc/setup_oauth2.rb example " +
102
+ "to retrieve and store OAuth2 tokens."
103
+ puts "See this wiki page for more details:\n\n " +
104
+ 'https://github.com/googleads/google-api-ads-ruby/wiki/OAuth2'
105
+
106
+ # HTTP errors.
107
+ rescue AdsCommon::Errors::HttpError => e
108
+ puts "HTTP Error: %s" % e
109
+
110
+ # API errors.
111
+ rescue AdwordsApi::Errors::ApiException => e
112
+ puts "Message: %s" % e.message
113
+ puts 'Errors:'
114
+ e.errors.each_with_index do |error, index|
115
+ puts "\tError [%d]:" % (index + 1)
116
+ error.each do |field, value|
117
+ puts "\t\t%s: %s" % [field, value]
118
+ end
119
+ end
120
+ end
121
+ end
@@ -0,0 +1,167 @@
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 two rule-based remarketing user lists: one with no site
20
+ # visit data restrictions, and another that will only include users who visit
21
+ # your site in the next six months.
22
+
23
+ require 'adwords_api'
24
+
25
+ def add_rule_based_user_lists()
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
+ user_list_srv = adwords.service(:AdwordsUserListService, API_VERSION)
35
+
36
+ # First rule item group - users who visited the checkout page and had more
37
+ # than one item in their shopping cart.
38
+ cart_rule_item = {
39
+ :xsi_type => 'StringRuleItem',
40
+ :key => {
41
+ :name => 'ecomm_pagetype'
42
+ },
43
+ :op => 'EQUALS',
44
+ :value => 'checkout'
45
+ }
46
+
47
+ cart_size_rule_item = {
48
+ :xsi_type => 'NumberRuleItem',
49
+ :key => {
50
+ :name => 'cartsize'
51
+ },
52
+ :op => 'GREATER_THAN',
53
+ :value => 1.0
54
+ }
55
+
56
+ # Combine the two rule items into a RuleItemGroup so AdWords will AND
57
+ # their rules together.
58
+ checkout_multiple_item_group = {
59
+ :items => [cart_rule_item, cart_size_rule_item]
60
+ }
61
+
62
+ # Second rule item group - users who checked out after October 31st
63
+ # and before January 1st.
64
+ start_date_rule_item = {
65
+ :xsi_type => 'DateRuleItem',
66
+ :key => {
67
+ :name => 'checkoutdate'
68
+ },
69
+ :op => 'AFTER',
70
+ :value => '20141031'
71
+ }
72
+
73
+ end_date_rule_item = {
74
+ :xsi_type => 'DateRuleItem',
75
+ :key => {
76
+ :name => 'checkoutdate'
77
+ },
78
+ :op => 'BEFORE',
79
+ :value => '20150101'
80
+ }
81
+
82
+ # Combine the date rule items into a RuleItemGroup.
83
+ checked_out_nov_dec_item_group = {
84
+ :items => [start_date_rule_item, end_date_rule_item]
85
+ }
86
+
87
+ # Combine the rule item groups into a Rule so AdWords will OR the
88
+ # groups together.
89
+ rule = {
90
+ :groups => [checkout_multiple_item_group, checked_out_nov_dec_item_group]
91
+ }
92
+
93
+ # Create the user list with no restrictions on site visit date.
94
+ expression_user_list = {
95
+ :xsi_type => 'ExpressionRuleUserList',
96
+ :name => 'Users who checked out in November or December OR ' +
97
+ 'visited the checkout page with more than one item in their cart',
98
+ :description => 'Expression based user list',
99
+ :rule => rule
100
+ }
101
+
102
+ # Create the user list restricted to users who visit your site within the
103
+ # specified timeframe.
104
+ date_user_list = {
105
+ :xsi_type => 'DateSpecificRuleUserList',
106
+ :name => 'Date rule user list created at ' + Time.now.to_s,
107
+ :description => 'Users who visited the site between 20141031 and ' +
108
+ '20150331 and checked out in November or December OR visited the ' +
109
+ 'checkout page with more than one item in their cart',
110
+ # We re-use the rule here. To avoid side effects, we need a deep copy.
111
+ :rule => Marshal.load(Marshal.dump(rule)),
112
+ # Set the start and end dates of the user list.
113
+ :start_date => '20141031',
114
+ :end_date => '20150331'
115
+ }
116
+
117
+ # Create operations to add the user lists.
118
+ operations = [expression_user_list, date_user_list].map do |user_list|
119
+ {
120
+ :operand => user_list,
121
+ :operator => 'ADD'
122
+ }
123
+ end
124
+
125
+ # Submit the operations.
126
+ response = user_list_srv.mutate(operations)
127
+
128
+ # Display the results.
129
+ response[:value].each do |user_list|
130
+ puts ("User list added with ID %d, name '%s', status '%s', " +
131
+ "list type '%s', accountUserListStatus '%s', description '%s'.") %
132
+ [user_list[:id], user_list[:name], user_list[:status],
133
+ user_list[:list_type], user_list[:account_user_list_status],
134
+ user_list[:description]]
135
+ end
136
+ end
137
+
138
+ if __FILE__ == $0
139
+ API_VERSION = :v201509
140
+
141
+ begin
142
+ add_rule_based_user_lists()
143
+
144
+ # Authorization error.
145
+ rescue AdsCommon::Errors::OAuth2VerificationRequired => e
146
+ puts "Authorization credentials are not valid. Edit adwords_api.yml for " +
147
+ "OAuth2 client ID and secret and run misc/setup_oauth2.rb example " +
148
+ "to retrieve and store OAuth2 tokens."
149
+ puts "See this wiki page for more details:\n\n " +
150
+ 'https://github.com/googleads/google-api-ads-ruby/wiki/OAuth2'
151
+
152
+ # HTTP errors.
153
+ rescue AdsCommon::Errors::HttpError => e
154
+ puts "HTTP Error: %s" % e
155
+
156
+ # API errors.
157
+ rescue AdwordsApi::Errors::ApiException => e
158
+ puts "Message: %s" % e.message
159
+ puts 'Errors:'
160
+ e.errors.each_with_index do |error, index|
161
+ puts "\tError [%d]:" % (index + 1)
162
+ error.each do |field, value|
163
+ puts "\t\t%s: %s" % [field, value]
164
+ end
165
+ end
166
+ end
167
+ end