google-adwords-api 0.16.1 → 0.17.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (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,92 @@
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 gets and downloads an Ad Hoc report from a XML report definition.
20
+
21
+ require 'adwords_api'
22
+
23
+ def download_criteria_report(file_name)
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
+ # Get report utilities for the version.
33
+ report_utils = adwords.report_utils(API_VERSION)
34
+
35
+ # Define report definition. You can also pass your own XML text as a string.
36
+ report_definition = {
37
+ :selector => {
38
+ :fields => ['CampaignId', 'AdGroupId', 'Id', 'Criteria', 'CriteriaType',
39
+ 'FinalUrls', 'Impressions', 'Clicks', 'Cost'],
40
+ # Predicates are optional.
41
+ :predicates => {
42
+ :field => 'Status',
43
+ :operator => 'IN',
44
+ :values => ['ENABLED', 'PAUSED']
45
+ }
46
+ },
47
+ :report_name => 'Last 7 days CRITERIA_PERFORMANCE_REPORT',
48
+ :report_type => 'CRITERIA_PERFORMANCE_REPORT',
49
+ :download_format => 'CSV',
50
+ :date_range_type => 'LAST_7_DAYS',
51
+ }
52
+
53
+ # Optional: Set the configuration of the API instance to suppress header,
54
+ # column name, or summary rows in the report output. You can also configure
55
+ # this in your adwords_api.yml configuration file.
56
+ adwords.skip_report_header = false
57
+ adwords.skip_column_header = false
58
+ adwords.skip_report_summary = false
59
+ # Enable to allow rows with zero impressions to show.
60
+ adwords.include_zero_impressions = false
61
+
62
+ # Download report, using "download_report_as_file" utility method.
63
+ # To retrieve the report as return value, use "download_report" method.
64
+ report_utils.download_report_as_file(report_definition, file_name)
65
+ puts "Report was downloaded to '%s'." % file_name
66
+ end
67
+
68
+ if __FILE__ == $0
69
+ API_VERSION = :v201509
70
+
71
+ begin
72
+ # File name to write report to.
73
+ file_name = 'INSERT_OUTPUT_FILE_NAME_HERE'
74
+ download_criteria_report(file_name)
75
+
76
+ # Authorization error.
77
+ rescue AdsCommon::Errors::OAuth2VerificationRequired => e
78
+ puts "Authorization credentials are not valid. Edit adwords_api.yml for " +
79
+ "OAuth2 client ID and secret and run misc/setup_oauth2.rb example " +
80
+ "to retrieve and store OAuth2 tokens."
81
+ puts "See this wiki page for more details:\n\n " +
82
+ 'https://github.com/googleads/google-api-ads-ruby/wiki/OAuth2'
83
+
84
+ # HTTP errors.
85
+ rescue AdsCommon::Errors::HttpError => e
86
+ puts "HTTP Error: %s" % e
87
+
88
+ # API errors.
89
+ rescue AdwordsApi::Errors::ReportError => e
90
+ puts "Reporting Error: %s" % e.message
91
+ end
92
+ end
@@ -0,0 +1,93 @@
1
+ #!/usr/bin/env ruby
2
+ # Encoding: utf-8
3
+ #
4
+ # Copyright:: Copyright 2012, 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 gets an Ad Hoc report using AdWords Query Language.
20
+ # See AWQL guide for more details:
21
+ # https://developers.google.com/adwords/api/docs/guides/awql
22
+
23
+ require 'date'
24
+
25
+ require 'adwords_api'
26
+
27
+ def download_criteria_report_with_awql(file_name, report_format)
28
+ # AdwordsApi::Api will read a config file from ENV['HOME']/adwords_api.yml
29
+ # when called without parameters.
30
+ adwords = AdwordsApi::Api.new
31
+
32
+ # To enable logging of SOAP requests, set the log_level value to 'DEBUG' in
33
+ # the configuration file or provide your own logger:
34
+ # adwords.logger = Logger.new('adwords_xml.log')
35
+
36
+ # Get report utilities for the version.
37
+ report_utils = adwords.report_utils(API_VERSION)
38
+
39
+ # Prepare a date range for the last week. Instead you can use 'LAST_7_DAYS'.
40
+ date_range = '%s,%s' % [
41
+ DateTime.parse((Date.today - 7).to_s).strftime('%Y%m%d'),
42
+ DateTime.parse((Date.today - 1).to_s).strftime('%Y%m%d')
43
+ ]
44
+
45
+ # Define report definition. You can also pass your own XML text as a string.
46
+ report_query = 'SELECT CampaignId, AdGroupId, Id, Criteria, CriteriaType, ' +
47
+ 'Impressions, Clicks, Cost FROM CRITERIA_PERFORMANCE_REPORT ' +
48
+ 'WHERE Status IN [ENABLED, PAUSED] ' +
49
+ 'DURING %s' % date_range
50
+
51
+ # Optional: Set the configuration of the API instance to suppress header,
52
+ # column name, or summary rows in the report output. You can also configure
53
+ # this in your adwords_api.yml configuration file.
54
+ adwords.skip_report_header = false
55
+ adwords.skip_column_header = false
56
+ adwords.skip_report_summary = false
57
+ # Enable to allow rows with zero impressions to show.
58
+ adwords.include_zero_impressions = true
59
+
60
+ # Download report, using "download_report_as_file_with_awql" utility method.
61
+ # To retrieve the report as return value, use "download_report_with_awql"
62
+ # method.
63
+ report_utils.download_report_as_file_with_awql(report_query, report_format,
64
+ file_name)
65
+ puts "Report was downloaded to '%s'." % file_name
66
+ end
67
+
68
+ if __FILE__ == $0
69
+ API_VERSION = :v201509
70
+
71
+ begin
72
+ # File name to write report to.
73
+ file_name = 'INSERT_OUTPUT_FILE_NAME_HERE'
74
+ report_format = 'CSV'
75
+ download_criteria_report_with_awql(file_name, report_format)
76
+
77
+ # Authorization error.
78
+ rescue AdsCommon::Errors::OAuth2VerificationRequired => e
79
+ puts "Authorization credentials are not valid. Edit adwords_api.yml for " +
80
+ "OAuth2 client ID and secret and run misc/setup_oauth2.rb example " +
81
+ "to retrieve and store OAuth2 tokens."
82
+ puts "See this wiki page for more details:\n\n " +
83
+ 'https://github.com/googleads/google-api-ads-ruby/wiki/OAuth2'
84
+
85
+ # HTTP errors.
86
+ rescue AdsCommon::Errors::HttpError => e
87
+ puts 'HTTP Error: %s' % e
88
+
89
+ # API errors.
90
+ rescue AdwordsApi::Errors::ReportError => e
91
+ puts 'Reporting Error: %s' % e.message
92
+ end
93
+ end
@@ -0,0 +1,75 @@
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 gets the list of possible report fields for a report type.
20
+
21
+ require 'adwords_api'
22
+
23
+ def get_report_fields(report_type)
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
+ report_def_srv = adwords.service(:ReportDefinitionService, API_VERSION)
33
+
34
+ # Get report fields.
35
+ fields = report_def_srv.get_report_fields(report_type)
36
+ if fields
37
+ puts "Report type '%s' contains the following fields:" % report_type
38
+ fields.each do |field|
39
+ puts ' - %s (%s)' % [field[:field_name], field[:field_type]]
40
+ puts ' := [%s]' % field[:enum_values].join(', ') if field[:enum_values]
41
+ end
42
+ end
43
+ end
44
+
45
+ if __FILE__ == $0
46
+ API_VERSION = :v201509
47
+
48
+ begin
49
+ report_type = 'INSERT_REPORT_TYPE_HERE'
50
+ get_report_fields(report_type)
51
+
52
+ # Authorization error.
53
+ rescue AdsCommon::Errors::OAuth2VerificationRequired => e
54
+ puts "Authorization credentials are not valid. Edit adwords_api.yml for " +
55
+ "OAuth2 client ID and secret and run misc/setup_oauth2.rb example " +
56
+ "to retrieve and store OAuth2 tokens."
57
+ puts "See this wiki page for more details:\n\n " +
58
+ 'https://github.com/googleads/google-api-ads-ruby/wiki/OAuth2'
59
+
60
+ # HTTP errors.
61
+ rescue AdsCommon::Errors::HttpError => e
62
+ puts "HTTP Error: %s" % e
63
+
64
+ # API errors.
65
+ rescue AdwordsApi::Errors::ApiException => e
66
+ puts "Message: %s" % e.message
67
+ puts 'Errors:'
68
+ e.errors.each_with_index do |error, index|
69
+ puts "\tError [%d]:" % (index + 1)
70
+ error.each do |field, value|
71
+ puts "\t\t%s: %s" % [field, value]
72
+ end
73
+ end
74
+ end
75
+ end
@@ -0,0 +1,166 @@
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 gets and downloads an Ad Hoc report from a XML report definition
20
+ # for all accounts in hierarchy in multiple parallel threads. This example
21
+ # needs to be run against an AdWords manager account.
22
+
23
+ require 'thread'
24
+
25
+ require 'adwords_api'
26
+ require 'adwords_api/utils'
27
+
28
+ def parallel_report_download()
29
+ # AdwordsApi::Api will read a config file from ENV['HOME']/adwords_api.yml
30
+ # when called without parameters.
31
+ adwords = AdwordsApi::Api.new
32
+
33
+ # To enable logging of SOAP requests, set the log_level value to 'DEBUG' in
34
+ # the configuration file or provide your own logger:
35
+ # adwords.logger = Logger.new('adwords_xml.log')
36
+
37
+ # Determine list of customer IDs to retrieve report for. For this example we
38
+ # will use ManagedCustomerService to get all IDs in hierarchy.
39
+
40
+ managed_customer_srv = adwords.service(:ManagedCustomerService, API_VERSION)
41
+
42
+ # Get the account hierarchy for this account.
43
+ selector = {:fields => ['CustomerId']}
44
+
45
+ graph = managed_customer_srv.get(selector)
46
+
47
+ # Using queue to balance load between threads.
48
+ queue = Queue.new()
49
+
50
+ if graph and graph[:entries] and !graph[:entries].empty?
51
+ graph[:entries].each {|account| queue << account[:customer_id]}
52
+ else
53
+ raise StandardError, 'Can not retrieve any customer ID'
54
+ end
55
+
56
+ # Get report utilities for the version.
57
+ report_utils = adwords.report_utils(API_VERSION)
58
+
59
+ # Define report definition. You can also pass your own XML text as a string.
60
+ report_definition = {
61
+ :selector => {
62
+ :fields => ['CampaignId', 'AdGroupId', 'Impressions', 'Clicks', 'Cost'],
63
+ # Predicates are optional.
64
+ :predicates => {
65
+ :field => 'AdGroupStatus',
66
+ :operator => 'IN',
67
+ :values => ['ENABLED', 'PAUSED']
68
+ }
69
+ },
70
+ :report_name => 'Custom ADGROUP_PERFORMANCE_REPORT',
71
+ :report_type => 'ADGROUP_PERFORMANCE_REPORT',
72
+ :download_format => 'CSV',
73
+ :date_range_type => 'LAST_7_DAYS',
74
+ # Enable to get rows with zero impressions.
75
+ :include_zero_impressions => false
76
+ }
77
+
78
+ puts 'Retrieving %d reports with %d threads:' % [queue.size, THREADS]
79
+
80
+ reports_succeeded = Queue.new()
81
+ reports_failed = Queue.new()
82
+
83
+ # Creating a mutex to control access to the queue.
84
+ queue_mutex = Mutex.new
85
+
86
+ # Start all the threads.
87
+ threads = (1..THREADS).map do |thread_id|
88
+ Thread.new(report_definition) do |local_def|
89
+ cid = nil
90
+ begin
91
+ cid = queue_mutex.synchronize {(queue.empty?) ? nil : queue.pop(true)}
92
+ if cid
93
+ retry_count = 0
94
+ file_name = 'adgroup_%010d.csv' % cid
95
+ puts "[%2d/%d] Loading report for customer ID %s into '%s'..." %
96
+ [thread_id, retry_count,
97
+ AdwordsApi::Utils.format_id(cid), file_name]
98
+ begin
99
+ report_utils.download_report_as_file(local_def, file_name, cid)
100
+ reports_succeeded << {:cid => cid, :file_name => file_name}
101
+ rescue AdwordsApi::Errors::ReportError => e
102
+ if e.http_code == 500 && retry_count < MAX_RETRIES
103
+ retry_count += 1
104
+ sleep(retry_count * BACKOFF_FACTOR)
105
+ retry
106
+ else
107
+ puts(('Report failed for customer ID %s with code %d after %d ' +
108
+ 'retries.') % [cid, e.http_code, retry_count + 1])
109
+ reports_failed <<
110
+ {:cid => cid, :http_code => e.http_code, :message => e.message}
111
+ end
112
+ end
113
+ end
114
+ end while (cid != nil)
115
+ end
116
+ end
117
+
118
+ # Wait for all threads to finish.
119
+ threads.each { |aThread| aThread.join }
120
+
121
+ puts 'Download completed, results:'
122
+ puts 'Successful reports:'
123
+ while !reports_succeeded.empty? do
124
+ result = reports_succeeded.pop()
125
+ puts "\tClient ID %s => '%s'" %
126
+ [AdwordsApi::Utils.format_id(result[:cid]), result[:file_name]]
127
+ end
128
+ puts 'Failed reports:'
129
+ while !reports_failed.empty? do
130
+ result = reports_failed.pop()
131
+ puts "\tClient ID %s => Code: %d, Message: '%s'" %
132
+ [AdwordsApi::Utils.format_id(result[:cid]),
133
+ result[:http_code], result[:message]]
134
+ end
135
+ puts 'End of results.'
136
+ end
137
+
138
+ if __FILE__ == $0
139
+ API_VERSION = :v201509
140
+ # Number of parallel threads to spawn.
141
+ THREADS = 10
142
+ # Maximum number of retries for 500 errors.
143
+ MAX_RETRIES = 5
144
+ # Timeout between retries in seconds.
145
+ BACKOFF_FACTOR = 5
146
+
147
+ begin
148
+ parallel_report_download()
149
+
150
+ # Authorization error.
151
+ rescue AdsCommon::Errors::OAuth2VerificationRequired => e
152
+ puts "Authorization credentials are not valid. Edit adwords_api.yml for " +
153
+ "OAuth2 client ID and secret and run misc/setup_oauth2.rb example " +
154
+ "to retrieve and store OAuth2 tokens."
155
+ puts "See this wiki page for more details:\n\n " +
156
+ 'https://github.com/googleads/google-api-ads-ruby/wiki/OAuth2'
157
+
158
+ # HTTP errors.
159
+ rescue AdsCommon::Errors::HttpError => e
160
+ puts 'HTTP Error: %s' % e
161
+
162
+ # API errors.
163
+ rescue AdwordsApi::Errors::ReportError => e
164
+ puts 'Reporting Error: %s' % e.message
165
+ end
166
+ end
@@ -0,0 +1,267 @@
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 creates a ProductPartition tree.
20
+
21
+ require 'adwords_api'
22
+
23
+ class ProductPartitionHelper
24
+ attr_reader :operations
25
+
26
+ def initialize(ad_group_id)
27
+ # The next temporary criterion ID to be used.
28
+ #
29
+ # When creating our tree we need to specify the parent-child relationships
30
+ # between nodes. However, until a criterion has been created on the server
31
+ # we do not have a criterionId with which to refer to it.
32
+ #
33
+ # Instead we can specify temporary IDs that are specific to a single mutate
34
+ # request. Once the criteria have been created they are assigned an ID as
35
+ # normal and the temporary ID will no longer refer to it.
36
+ #
37
+ # A valid temporary ID is any negative integer.
38
+ @next_id = -1
39
+
40
+ # The set of mutate operations needed to create the current tree.
41
+ @operations = []
42
+
43
+ # The ID of the AdGroup that we wish to attach the partition tree to.
44
+ @ad_group_id = ad_group_id
45
+ end
46
+
47
+ def create_subdivision(parent = nil, value = nil)
48
+ division = {
49
+ :xsi_type => 'ProductPartition',
50
+ :partition_type => 'SUBDIVISION',
51
+ :id => @next_id
52
+ }
53
+
54
+ @next_id -= 1
55
+
56
+ unless parent.nil? || value.nil?
57
+ division[:parent_criterion_id] = parent[:id]
58
+ division[:case_value] = value
59
+ end
60
+
61
+ ad_group_criterion = {
62
+ :xsi_type => 'BiddableAdGroupCriterion',
63
+ :ad_group_id => @ad_group_id,
64
+ :criterion => division
65
+ }
66
+
67
+ create_add_operation(ad_group_criterion)
68
+
69
+ return division
70
+ end
71
+
72
+ def create_unit(parent = nil, value = nil, bid_amount = nil)
73
+ unit = {
74
+ :xsi_type => 'ProductPartition',
75
+ :partition_type => 'UNIT'
76
+ }
77
+
78
+ unless parent.nil? || value.nil?
79
+ unit[:parent_criterion_id] = parent[:id]
80
+ unit[:case_value] = value
81
+ end
82
+
83
+ ad_group_criterion = {}
84
+ if bid_amount && bid_amount > 0
85
+ bidding_strategy_configuration = {
86
+ :bids => [{
87
+ :xsi_type => 'CpcBid',
88
+ :bid => {
89
+ :xsi_type => 'Money',
90
+ :micro_amount => bid_amount
91
+ }
92
+ }]
93
+ }
94
+ ad_group_criterion[:xsi_type] = 'BiddableAdGroupCriterion'
95
+ ad_group_criterion[:bidding_strategy_configuration] =
96
+ bidding_strategy_configuration
97
+ else
98
+ ad_group_criterion[:xsi_type] = 'NegativeAdGroupCriterion'
99
+ end
100
+ ad_group_criterion[:ad_group_id] = @ad_group_id
101
+ ad_group_criterion[:criterion] = unit
102
+
103
+ create_add_operation(ad_group_criterion)
104
+
105
+ return unit
106
+ end
107
+
108
+ private
109
+
110
+ def create_add_operation(ad_group_criterion)
111
+ operation = {
112
+ :operator => 'ADD',
113
+ :operand => ad_group_criterion
114
+ }
115
+
116
+ @operations << operation
117
+ end
118
+ end
119
+
120
+ def display_tree(node, children, level = 0)
121
+ value = ''
122
+ type = ''
123
+
124
+ if node[:case_value]
125
+ type = node[:case_value][:product_dimension_type]
126
+
127
+ value = case type
128
+ when 'ProductCanonicalCondition'
129
+ node[:case_value][:condition]
130
+ when 'ProductBiddingCategory'
131
+ "%s(%s)" % [node[:case_value][:type], node[:case_value][:value]]
132
+ else
133
+ node[:case_value][:value]
134
+ end
135
+ end
136
+
137
+ puts "%sid: %s, type: %s, value: %s" %
138
+ [' ' * level, node[:id], type, value]
139
+
140
+ children[node[:id]].each do |child_node|
141
+ display_tree(child_node, children, level + 1)
142
+ end
143
+ end
144
+
145
+ def add_product_partition_tree(ad_group_id)
146
+ # AdwordsApi::Api will read a config file from ENV['HOME']/adwords_api.yml
147
+ # when called without parameters.
148
+ adwords = AdwordsApi::Api.new
149
+
150
+ # To enable logging of SOAP requests, set the log_level value to 'DEBUG' in
151
+ # the configuration file or provide your own logger:
152
+ # adwords.logger = Logger.new('adwords_xml.log')
153
+
154
+ ad_group_criterion_srv =
155
+ adwords.service(:AdGroupCriterionService, API_VERSION)
156
+
157
+ helper = ProductPartitionHelper.new(ad_group_id)
158
+
159
+ root = helper.create_subdivision()
160
+
161
+ new_product_canonical_condition = {
162
+ :xsi_type => 'ProductCanonicalCondition',
163
+ :condition => 'NEW'
164
+ }
165
+
166
+ used_product_canonical_condition = {
167
+ :xsi_type => 'ProductCanonicalCondition',
168
+ :condition => 'USED'
169
+ }
170
+
171
+ other_product_canonical_condition = {
172
+ :xsi_type => 'ProductCanonicalCondition'
173
+ }
174
+
175
+ helper.create_unit(root, new_product_canonical_condition, 200000)
176
+ helper.create_unit(root, used_product_canonical_condition, 100000)
177
+ other_condition =
178
+ helper.create_subdivision(root, other_product_canonical_condition)
179
+
180
+ cool_product_brand = {
181
+ :xsi_type => 'ProductBrand',
182
+ :value => 'CoolBrand'
183
+ }
184
+
185
+ cheap_product_brand = {
186
+ :xsi_type => 'ProductBrand',
187
+ :value => 'CheapBrand'
188
+ }
189
+
190
+ other_product_brand = {
191
+ :xsi_type => 'ProductBrand'
192
+ }
193
+
194
+ helper.create_unit(other_condition, cool_product_brand, 900000)
195
+ helper.create_unit(other_condition, cheap_product_brand, 10000)
196
+ other_brand = helper.create_subdivision(other_condition, other_product_brand)
197
+
198
+ # The value for the bidding category is a fixed ID for the 'Luggage & Bags'
199
+ # category. You can retrieve IDs for categories from the ConstantDataService.
200
+ # See the get_product_taxonomy example for more details.
201
+ luggage_category = {
202
+ :xsi_type => 'ProductBiddingCategory',
203
+ :type => 'BIDDING_CATEGORY_L1',
204
+ :value => '-5914235892932915235'
205
+ }
206
+
207
+ generic_category = {
208
+ :xsi_type => 'ProductBiddingCategory',
209
+ :type => 'BIDDING_CATEGORY_L1'
210
+ }
211
+
212
+ helper.create_unit(other_brand, luggage_category, 750000)
213
+ helper.create_unit(other_brand, generic_category, 110000)
214
+
215
+ # Make the mutate request.
216
+ result = ad_group_criterion_srv.mutate(helper.operations)
217
+
218
+ children = {}
219
+ root_node = nil
220
+ # For each criterion, make an array containing each of its children.
221
+ # We always create the parent before the child, so we can rely on that here.
222
+ result[:value].each do |criterion|
223
+ children[criterion[:criterion][:id]] = []
224
+
225
+ if criterion[:criterion][:parent_criterion_id]
226
+ children[criterion[:criterion][:parent_criterion_id]] <<
227
+ criterion[:criterion]
228
+ else
229
+ root_node = criterion[:criterion]
230
+ end
231
+ end
232
+
233
+ display_tree(root_node, children)
234
+ end
235
+
236
+ if __FILE__ == $0
237
+ API_VERSION = :v201509
238
+
239
+ begin
240
+ ad_group_id = 'INSERT_AD_GROUP_ID_HERE'.to_i
241
+
242
+ add_product_partition_tree(ad_group_id)
243
+
244
+ # Authorization error.
245
+ rescue AdsCommon::Errors::OAuth2VerificationRequired => e
246
+ puts "Authorization credentials are not valid. Edit adwords_api.yml for " +
247
+ "OAuth2 client ID and secret and run misc/setup_oauth2.rb example " +
248
+ "to retrieve and store OAuth2 tokens."
249
+ puts "See this wiki page for more details:\n\n " +
250
+ 'https://github.com/googleads/google-api-ads-ruby/wiki/OAuth2'
251
+
252
+ # HTTP errors.
253
+ rescue AdsCommon::Errors::HttpError => e
254
+ puts "HTTP Error: %s" % e
255
+
256
+ # API errors.
257
+ rescue AdwordsApi::Errors::ApiException => e
258
+ puts "Message: %s" % e.message
259
+ puts 'Errors:'
260
+ e.errors.each_with_index do |error, index|
261
+ puts "\tError [%d]:" % (index + 1)
262
+ error.each do |field, value|
263
+ puts "\t\t%s: %s" % [field, value]
264
+ end
265
+ end
266
+ end
267
+ end