google-adwords-api 0.20.0 → 0.20.1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (201) hide show
  1. checksums.yaml +4 -4
  2. data/ChangeLog +7 -0
  3. data/examples/v201601/remarketing/add_crm_based_user_list.rb +2 -2
  4. data/examples/v201603/remarketing/add_crm_based_user_list.rb +2 -2
  5. data/examples/v201605/advanced_operations/add_click_to_download_ad.rb +2 -2
  6. data/examples/v201605/advanced_operations/add_html5_ad.rb +2 -2
  7. data/examples/v201605/remarketing/add_crm_based_user_list.rb +2 -2
  8. data/examples/v201607/account_management/create_account.rb +88 -0
  9. data/examples/v201607/account_management/get_account_changes.rb +135 -0
  10. data/examples/v201607/account_management/get_account_hierarchy.rb +132 -0
  11. data/examples/v201607/advanced_operations/add_ad_customizers.rb +184 -0
  12. data/examples/v201607/advanced_operations/add_ad_group_bid_modifier.rb +101 -0
  13. data/examples/v201607/advanced_operations/add_click_to_download_ad.rb +148 -0
  14. data/examples/v201607/advanced_operations/add_html5_ad.rb +137 -0
  15. data/examples/v201607/advanced_operations/add_responsive_display_ad.rb +130 -0
  16. data/examples/v201607/advanced_operations/add_text_ad_with_upgraded_urls.rb +134 -0
  17. data/examples/v201607/advanced_operations/create_and_attach_shared_keyword_set.rb +141 -0
  18. data/examples/v201607/advanced_operations/find_and_remove_criteria_from_shared_set.rb +174 -0
  19. data/examples/v201607/advanced_operations/get_ad_group_bid_modifiers.rb +102 -0
  20. data/examples/v201607/advanced_operations/use_portfolio_bidding_strategy.rb +146 -0
  21. data/examples/v201607/basic_operations/add_ad_groups.rb +142 -0
  22. data/examples/v201607/basic_operations/add_campaigns.rb +138 -0
  23. data/examples/v201607/basic_operations/add_expanded_text_ads.rb +108 -0
  24. data/examples/v201607/basic_operations/add_keywords.rb +114 -0
  25. data/examples/v201607/basic_operations/add_text_ads.rb +109 -0
  26. data/examples/v201607/basic_operations/get_ad_groups.rb +102 -0
  27. data/examples/v201607/basic_operations/get_campaigns.rb +97 -0
  28. data/examples/v201607/basic_operations/get_campaigns_with_awql.rb +89 -0
  29. data/examples/v201607/basic_operations/get_expanded_text_ads.rb +122 -0
  30. data/examples/v201607/basic_operations/get_keywords.rb +109 -0
  31. data/examples/v201607/basic_operations/get_text_ads.rb +110 -0
  32. data/examples/v201607/basic_operations/pause_ad.rb +88 -0
  33. data/examples/v201607/basic_operations/remove_ad.rb +89 -0
  34. data/examples/v201607/basic_operations/remove_ad_group.rb +85 -0
  35. data/examples/v201607/basic_operations/remove_campaign.rb +87 -0
  36. data/examples/v201607/basic_operations/remove_keyword.rb +94 -0
  37. data/examples/v201607/basic_operations/update_ad_group.rb +85 -0
  38. data/examples/v201607/basic_operations/update_campaign.rb +86 -0
  39. data/examples/v201607/basic_operations/update_keyword.rb +106 -0
  40. data/examples/v201607/campaign_management/add_campaign_labels.rb +82 -0
  41. data/examples/v201607/campaign_management/add_complete_campaigns_using_batch_job.rb +355 -0
  42. data/examples/v201607/campaign_management/add_draft.rb +114 -0
  43. data/examples/v201607/campaign_management/add_experiment.rb +162 -0
  44. data/examples/v201607/campaign_management/add_keywords_using_incremental_batch_job.rb +210 -0
  45. data/examples/v201607/campaign_management/add_trial.rb +142 -0
  46. data/examples/v201607/campaign_management/get_all_disapproved_ads.rb +97 -0
  47. data/examples/v201607/campaign_management/get_all_disapproved_ads_with_awql.rb +89 -0
  48. data/examples/v201607/campaign_management/get_campaigns_by_label.rb +108 -0
  49. data/examples/v201607/campaign_management/graduate_trial.rb +106 -0
  50. data/examples/v201607/campaign_management/promote_experiment.rb +81 -0
  51. data/examples/v201607/campaign_management/set_ad_parameters.rb +118 -0
  52. data/examples/v201607/campaign_management/set_criterion_bid_modifier.rb +104 -0
  53. data/examples/v201607/campaign_management/validate_text_ad.rb +110 -0
  54. data/examples/v201607/error_handling/handle_partial_failures.rb +130 -0
  55. data/examples/v201607/error_handling/handle_policy_violation_error.rb +141 -0
  56. data/examples/v201607/extensions/add_google_my_business_location_extensions.rb +193 -0
  57. data/examples/v201607/extensions/add_prices.rb +164 -0
  58. data/examples/v201607/extensions/add_site_links.rb +199 -0
  59. data/examples/v201607/extensions/add_site_links_using_feeds.rb +286 -0
  60. data/examples/v201607/migration/migrate_to_extension_settings.rb +386 -0
  61. data/examples/v201607/migration/upgrade_ad_url.rb +93 -0
  62. data/examples/v201607/misc/get_all_images_and_videos.rb +104 -0
  63. data/examples/v201607/misc/setup_oauth2.rb +84 -0
  64. data/examples/v201607/misc/upload_image.rb +93 -0
  65. data/examples/v201607/misc/upload_media_bundle.rb +90 -0
  66. data/examples/v201607/misc/use_oauth2_jwt.rb +93 -0
  67. data/examples/v201607/misc/use_runtime_config.rb +92 -0
  68. data/examples/v201607/optimization/estimate_keyword_traffic.rb +191 -0
  69. data/examples/v201607/optimization/get_campaign_criterion_bid_modifier_simulations.rb +128 -0
  70. data/examples/v201607/optimization/get_keyword_bid_simulations.rb +95 -0
  71. data/examples/v201607/optimization/get_keyword_ideas.rb +136 -0
  72. data/examples/v201607/remarketing/add_audience.rb +118 -0
  73. data/examples/v201607/remarketing/add_conversion_tracker.rb +97 -0
  74. data/examples/v201607/remarketing/add_crm_based_user_list.rb +116 -0
  75. data/examples/v201607/remarketing/add_rule_based_user_lists.rb +167 -0
  76. data/examples/v201607/remarketing/upload_offline_conversions.rb +98 -0
  77. data/examples/v201607/reporting/download_criteria_report.rb +92 -0
  78. data/examples/v201607/reporting/download_criteria_report_with_awql.rb +93 -0
  79. data/examples/v201607/reporting/get_report_fields.rb +75 -0
  80. data/examples/v201607/reporting/parallel_report_download.rb +164 -0
  81. data/examples/v201607/reporting/stream_criteria_report_results.rb +97 -0
  82. data/examples/v201607/shopping_campaigns/add_product_partition_tree.rb +267 -0
  83. data/examples/v201607/shopping_campaigns/add_product_scope.rb +129 -0
  84. data/examples/v201607/shopping_campaigns/add_shopping_campaign.rb +129 -0
  85. data/examples/v201607/shopping_campaigns/get_product_category_taxonomy.rb +115 -0
  86. data/examples/v201607/targeting/add_campaign_targeting_criteria.rb +166 -0
  87. data/examples/v201607/targeting/add_demographic_targeting_criteria.rb +112 -0
  88. data/examples/v201607/targeting/get_campaign_targeting_criteria.rb +106 -0
  89. data/examples/v201607/targeting/get_targetable_languages_and_carriers.rb +89 -0
  90. data/examples/v201607/targeting/lookup_location.rb +108 -0
  91. data/lib/adwords_api/api_config.rb +96 -4
  92. data/lib/adwords_api/batch_job_utils.rb +6 -5
  93. data/lib/adwords_api/v201607/account_label_service.rb +46 -0
  94. data/lib/adwords_api/v201607/account_label_service_registry.rb +46 -0
  95. data/lib/adwords_api/v201607/ad_customizer_feed_service.rb +46 -0
  96. data/lib/adwords_api/v201607/ad_customizer_feed_service_registry.rb +46 -0
  97. data/lib/adwords_api/v201607/ad_group_ad_service.rb +70 -0
  98. data/lib/adwords_api/v201607/ad_group_ad_service_registry.rb +46 -0
  99. data/lib/adwords_api/v201607/ad_group_bid_modifier_service.rb +54 -0
  100. data/lib/adwords_api/v201607/ad_group_bid_modifier_service_registry.rb +46 -0
  101. data/lib/adwords_api/v201607/ad_group_criterion_service.rb +62 -0
  102. data/lib/adwords_api/v201607/ad_group_criterion_service_registry.rb +46 -0
  103. data/lib/adwords_api/v201607/ad_group_extension_setting_service.rb +54 -0
  104. data/lib/adwords_api/v201607/ad_group_extension_setting_service_registry.rb +46 -0
  105. data/lib/adwords_api/v201607/ad_group_feed_service.rb +54 -0
  106. data/lib/adwords_api/v201607/ad_group_feed_service_registry.rb +46 -0
  107. data/lib/adwords_api/v201607/ad_group_service.rb +62 -0
  108. data/lib/adwords_api/v201607/ad_group_service_registry.rb +46 -0
  109. data/lib/adwords_api/v201607/ad_param_service.rb +46 -0
  110. data/lib/adwords_api/v201607/ad_param_service_registry.rb +46 -0
  111. data/lib/adwords_api/v201607/adwords_user_list_service.rb +62 -0
  112. data/lib/adwords_api/v201607/adwords_user_list_service_registry.rb +46 -0
  113. data/lib/adwords_api/v201607/batch_job_service.rb +54 -0
  114. data/lib/adwords_api/v201607/batch_job_service_registry.rb +46 -0
  115. data/lib/adwords_api/v201607/bidding_strategy_service.rb +54 -0
  116. data/lib/adwords_api/v201607/bidding_strategy_service_registry.rb +46 -0
  117. data/lib/adwords_api/v201607/budget_order_service.rb +54 -0
  118. data/lib/adwords_api/v201607/budget_order_service_registry.rb +46 -0
  119. data/lib/adwords_api/v201607/budget_service.rb +54 -0
  120. data/lib/adwords_api/v201607/budget_service_registry.rb +46 -0
  121. data/lib/adwords_api/v201607/campaign_criterion_service.rb +54 -0
  122. data/lib/adwords_api/v201607/campaign_criterion_service_registry.rb +46 -0
  123. data/lib/adwords_api/v201607/campaign_extension_setting_service.rb +54 -0
  124. data/lib/adwords_api/v201607/campaign_extension_setting_service_registry.rb +46 -0
  125. data/lib/adwords_api/v201607/campaign_feed_service.rb +54 -0
  126. data/lib/adwords_api/v201607/campaign_feed_service_registry.rb +46 -0
  127. data/lib/adwords_api/v201607/campaign_service.rb +62 -0
  128. data/lib/adwords_api/v201607/campaign_service_registry.rb +46 -0
  129. data/lib/adwords_api/v201607/campaign_shared_set_service.rb +54 -0
  130. data/lib/adwords_api/v201607/campaign_shared_set_service_registry.rb +46 -0
  131. data/lib/adwords_api/v201607/constant_data_service.rb +110 -0
  132. data/lib/adwords_api/v201607/constant_data_service_registry.rb +46 -0
  133. data/lib/adwords_api/v201607/conversion_tracker_service.rb +54 -0
  134. data/lib/adwords_api/v201607/conversion_tracker_service_registry.rb +46 -0
  135. data/lib/adwords_api/v201607/customer_extension_setting_service.rb +54 -0
  136. data/lib/adwords_api/v201607/customer_extension_setting_service_registry.rb +46 -0
  137. data/lib/adwords_api/v201607/customer_feed_service.rb +54 -0
  138. data/lib/adwords_api/v201607/customer_feed_service_registry.rb +46 -0
  139. data/lib/adwords_api/v201607/customer_service.rb +46 -0
  140. data/lib/adwords_api/v201607/customer_service_registry.rb +46 -0
  141. data/lib/adwords_api/v201607/customer_sync_service.rb +38 -0
  142. data/lib/adwords_api/v201607/customer_sync_service_registry.rb +47 -0
  143. data/lib/adwords_api/v201607/data_service.rb +94 -0
  144. data/lib/adwords_api/v201607/data_service_registry.rb +46 -0
  145. data/lib/adwords_api/v201607/draft_async_error_service.rb +46 -0
  146. data/lib/adwords_api/v201607/draft_async_error_service_registry.rb +46 -0
  147. data/lib/adwords_api/v201607/draft_service.rb +54 -0
  148. data/lib/adwords_api/v201607/draft_service_registry.rb +46 -0
  149. data/lib/adwords_api/v201607/experiment_service.rb +46 -0
  150. data/lib/adwords_api/v201607/experiment_service_registry.rb +46 -0
  151. data/lib/adwords_api/v201607/feed_item_service.rb +54 -0
  152. data/lib/adwords_api/v201607/feed_item_service_registry.rb +46 -0
  153. data/lib/adwords_api/v201607/feed_mapping_service.rb +54 -0
  154. data/lib/adwords_api/v201607/feed_mapping_service_registry.rb +46 -0
  155. data/lib/adwords_api/v201607/feed_service.rb +54 -0
  156. data/lib/adwords_api/v201607/feed_service_registry.rb +46 -0
  157. data/lib/adwords_api/v201607/label_service.rb +54 -0
  158. data/lib/adwords_api/v201607/label_service_registry.rb +46 -0
  159. data/lib/adwords_api/v201607/location_criterion_service.rb +46 -0
  160. data/lib/adwords_api/v201607/location_criterion_service_registry.rb +46 -0
  161. data/lib/adwords_api/v201607/managed_customer_service.rb +78 -0
  162. data/lib/adwords_api/v201607/managed_customer_service_registry.rb +46 -0
  163. data/lib/adwords_api/v201607/media_service.rb +54 -0
  164. data/lib/adwords_api/v201607/media_service_registry.rb +46 -0
  165. data/lib/adwords_api/v201607/offline_conversion_feed_service.rb +38 -0
  166. data/lib/adwords_api/v201607/offline_conversion_feed_service_registry.rb +46 -0
  167. data/lib/adwords_api/v201607/report_definition_service.rb +38 -0
  168. data/lib/adwords_api/v201607/report_definition_service_registry.rb +46 -0
  169. data/lib/adwords_api/v201607/shared_criterion_service.rb +54 -0
  170. data/lib/adwords_api/v201607/shared_criterion_service_registry.rb +46 -0
  171. data/lib/adwords_api/v201607/shared_set_service.rb +54 -0
  172. data/lib/adwords_api/v201607/shared_set_service_registry.rb +46 -0
  173. data/lib/adwords_api/v201607/targeting_idea_service.rb +38 -0
  174. data/lib/adwords_api/v201607/targeting_idea_service_registry.rb +46 -0
  175. data/lib/adwords_api/v201607/traffic_estimator_service.rb +38 -0
  176. data/lib/adwords_api/v201607/traffic_estimator_service_registry.rb +46 -0
  177. data/lib/adwords_api/v201607/trial_async_error_service.rb +46 -0
  178. data/lib/adwords_api/v201607/trial_async_error_service_registry.rb +46 -0
  179. data/lib/adwords_api/v201607/trial_service.rb +54 -0
  180. data/lib/adwords_api/v201607/trial_service_registry.rb +46 -0
  181. data/lib/adwords_api/version.rb +1 -1
  182. data/test/adwords_api/test_adwords_api.rb +1 -1
  183. data/test/adwords_api/test_api_config.rb +8 -8
  184. data/test/adwords_api/test_batch_job_utils.rb +5 -5
  185. data/test/adwords_api/test_choices.rb +2 -2
  186. data/test/adwords_api/test_report_stream.rb +1 -1
  187. data/test/adwords_api/test_report_utils.rb +1 -1
  188. data/test/templates/v201601/basic_operations_get_campaigns.def +116 -0
  189. data/test/templates/v201601/basic_operations_update_keyword.def +125 -0
  190. data/test/templates/v201601/misc_use_oauth2_jwt.def +131 -0
  191. data/test/templates/v201603/basic_operations_get_campaigns.def +116 -0
  192. data/test/templates/v201603/basic_operations_update_keyword.def +125 -0
  193. data/test/templates/v201603/misc_use_oauth2_jwt.def +131 -0
  194. data/test/templates/v201605/basic_operations_get_campaigns.def +1 -1
  195. data/test/templates/v201605/basic_operations_update_keyword.def +125 -0
  196. data/test/templates/v201605/misc_use_oauth2_jwt.def +1 -1
  197. data/test/templates/v201607/basic_operations_get_campaigns.def +116 -0
  198. data/test/templates/v201607/basic_operations_update_keyword.def +125 -0
  199. data/test/templates/v201607/misc_use_oauth2_jwt.def +131 -0
  200. data/test/test_utils.rb +4 -1
  201. metadata +183 -2
@@ -0,0 +1,129 @@
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 restricts the products that will be included in the campaign by
20
+ # setting a ProductScope.
21
+
22
+ require 'adwords_api'
23
+
24
+ def add_product_scope(campaign_id)
25
+ # AdwordsApi::Api will read a config file from ENV['HOME']/adwords_api.yml
26
+ # when called without parameters.
27
+ adwords = AdwordsApi::Api.new
28
+
29
+ # To enable logging of SOAP requests, set the log_level value to 'DEBUG' in
30
+ # the configuration file or provide your own logger:
31
+ # adwords.logger = Logger.new('adwords_xml.log')
32
+
33
+ campaign_criterion_srv = adwords.service(:CampaignCriterionService,
34
+ API_VERSION)
35
+
36
+ product_scope = {
37
+ # This set of dimensions is for demonstration purposes only. It is
38
+ # extremely unlikely that you want to include so many dimensions in your
39
+ # product scope.
40
+ :dimensions => [
41
+ {
42
+ :xsi_type => 'ProductBrand',
43
+ :value => 'Nexus'
44
+ },
45
+ {
46
+ :xsi_type => 'ProductCanonicalCondition',
47
+ :value => 'NEW'
48
+ },
49
+ {
50
+ :xsi_type => 'ProductCustomAttribute',
51
+ :type => 'CUSTOM_ATTRIBUTE_0',
52
+ :value => 'my attribute value'
53
+ },
54
+ {
55
+ :xsi_type => 'ProductOfferId',
56
+ :value => 'book1'
57
+ },
58
+ {
59
+ :xsi_type => 'ProductType',
60
+ :type => 'PRODUCT_TYPE_L1',
61
+ :value => 'Media'
62
+ },
63
+ {
64
+ :xsi_type => 'ProductType',
65
+ :type => 'PRODUCT_TYPE_L2',
66
+ :value => 'Books'
67
+ },
68
+ # The value for the bidding category is a fixed ID for the
69
+ # 'Luggage & Bags' category. You can retrieve IDs for categories from
70
+ # the ConstantDataService. See the 'get_product_category_taxonomy'
71
+ # example for more details.
72
+ {
73
+ :xsi_type => 'ProductBiddingCategory',
74
+ :type => 'BIDDING_CATEGORY_L1',
75
+ :value => '-5914235892932915235',
76
+ }
77
+ ]
78
+ }
79
+
80
+ campaign_criterion = {
81
+ :campaign_id => campaign_id,
82
+ :product_scope => product_scope
83
+ }
84
+
85
+ campaign_criterion_operation = {
86
+ :operator => 'ADD',
87
+ :operand => campaign_criterion
88
+ }
89
+
90
+ # Make the mutate request.
91
+ result = campaign_criterion_srv.mutate([campaign_criterion_operation])
92
+
93
+ campaign_criterion = result[:value].first
94
+ puts "Created a ProductScope criterion with ID %d." %
95
+ [campaign_criterion[:criterion][:id]]
96
+ end
97
+
98
+ if __FILE__ == $0
99
+ API_VERSION = :v201607
100
+
101
+ begin
102
+ campaign_id = 'INSERT_CAMPAIGN_ID_HERE'.to_i
103
+
104
+ add_product_scope(campaign_id)
105
+
106
+ # Authorization error.
107
+ rescue AdsCommon::Errors::OAuth2VerificationRequired => e
108
+ puts "Authorization credentials are not valid. Edit adwords_api.yml for " +
109
+ "OAuth2 client ID and secret and run misc/setup_oauth2.rb example " +
110
+ "to retrieve and store OAuth2 tokens."
111
+ puts "See this wiki page for more details:\n\n " +
112
+ 'https://github.com/googleads/google-api-ads-ruby/wiki/OAuth2'
113
+
114
+ # HTTP errors.
115
+ rescue AdsCommon::Errors::HttpError => e
116
+ puts "HTTP Error: %s" % e
117
+
118
+ # API errors.
119
+ rescue AdwordsApi::Errors::ApiException => e
120
+ puts "Message: %s" % e.message
121
+ puts 'Errors:'
122
+ e.errors.each_with_index do |error, index|
123
+ puts "\tError [%d]:" % (index + 1)
124
+ error.each do |field, value|
125
+ puts "\t\t%s: %s" % [field, value]
126
+ end
127
+ end
128
+ end
129
+ end
@@ -0,0 +1,129 @@
1
+ #!/usr/bin/env ruby
2
+ # Encoding: utf-8
3
+ #
4
+ # Copyright:: Copyright 2014, Google Inc. All Rights Reserved.
5
+ #
6
+ # License:: Licensed under the Apache License, Version 2.0 (the "License");
7
+ # you may not use this file except in compliance with the License.
8
+ # You may obtain a copy of the License at
9
+ #
10
+ # http://www.apache.org/licenses/LICENSE-2.0
11
+ #
12
+ # Unless required by applicable law or agreed to in writing, software
13
+ # distributed under the License is distributed on an "AS IS" BASIS,
14
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
15
+ # implied.
16
+ # See the License for the specific language governing permissions and
17
+ # limitations under the License.
18
+ #
19
+ # This example adds a Shopping campaign.
20
+
21
+ require 'adwords_api'
22
+ require 'date'
23
+
24
+ def add_shopping_campaign(budget_id, merchant_id)
25
+ # AdwordsApi::Api will read a config file from ENV['HOME']/adwords_api.yml
26
+ # when called without parameters.
27
+ adwords = AdwordsApi::Api.new
28
+
29
+ # To enable logging of SOAP requests, set the log_level value to 'DEBUG' in
30
+ # the configuration file or provide your own logger:
31
+ # adwords.logger = Logger.new('adwords_xml.log')
32
+
33
+ campaign_srv = adwords.service(:CampaignService, API_VERSION)
34
+ ad_group_srv = adwords.service(:AdGroupService, API_VERSION)
35
+ ad_group_ad_srv = adwords.service(:AdGroupAdService, API_VERSION)
36
+
37
+ # Create campaign.
38
+ campaign = {
39
+ :name => "Shopping campaign #%d" % (Time.new.to_f * 1000).to_i,
40
+ # The advertising_channel_type is what makes this a Shopping campaign.
41
+ :advertising_channel_type => 'SHOPPING',
42
+ :budget => {:budget_id => budget_id},
43
+ :bidding_strategy_configuration => {
44
+ :bidding_strategy_type => 'MANUAL_CPC'
45
+ },
46
+ :settings => [
47
+ {
48
+ :xsi_type => 'ShoppingSetting',
49
+ :sales_country => 'US',
50
+ :campaign_priority => 0,
51
+ :merchant_id => merchant_id,
52
+ # Set to "true" to enable Local Inventory Ads in your campaign.
53
+ :enable_local => true
54
+ }
55
+ ]
56
+ }
57
+ campaign_operation = {:operator => 'ADD', :operand => campaign}
58
+
59
+ # Make the mutate request.
60
+ result = campaign_srv.mutate([campaign_operation])
61
+
62
+ # Print the result.
63
+ campaign = result[:value].first
64
+ puts "Campaign with name '%s' and ID %d was added." %
65
+ [campaign[:name], campaign[:id]]
66
+
67
+ # Create ad group.
68
+ ad_group = {
69
+ :campaign_id => campaign[:id],
70
+ :name => 'Ad Group #%d' % (Time.new.to_f * 1000).to_i
71
+ }
72
+ ad_group_operation = {:operator => 'ADD', :operand => ad_group}
73
+
74
+ # Make the mutate request.
75
+ result = ad_group_srv.mutate([ad_group_operation])
76
+
77
+ # Print the result.
78
+ ad_group = result[:value].first
79
+ puts "Ad group with name '%s' and ID %d was added." %
80
+ [ad_group[:name], ad_group[:id]]
81
+
82
+ # Create product ad.
83
+ ad_group_ad = {
84
+ :ad_group_id => ad_group[:id],
85
+ :ad => {:xsi_type => 'ProductAd'}
86
+ }
87
+ ad_group_operation = {:operator => 'ADD', :operand => ad_group_ad}
88
+
89
+ # Make the mutate request.
90
+ result = ad_group_ad_srv.mutate([ad_group_operation])
91
+
92
+ # Print the result.
93
+ ad_group_ad = result[:value].first
94
+ puts "Product ad with ID %d was added." % [ad_group_ad[:id]]
95
+ end
96
+
97
+ if __FILE__ == $0
98
+ API_VERSION = :v201607
99
+
100
+ begin
101
+ budget_id = 'INSERT_BUDGET_ID_HERE'.to_i
102
+ merchant_id = 'INSERT_MERCHANT_ID_HERE'.to_i
103
+
104
+ add_shopping_campaign(budget_id, merchant_id)
105
+
106
+ # Authorization error.
107
+ rescue AdsCommon::Errors::OAuth2VerificationRequired => e
108
+ puts "Authorization credentials are not valid. Edit adwords_api.yml for " +
109
+ "OAuth2 client ID and secret and run misc/setup_oauth2.rb example " +
110
+ "to retrieve and store OAuth2 tokens."
111
+ puts "See this wiki page for more details:\n\n " +
112
+ 'https://github.com/googleads/google-api-ads-ruby/wiki/OAuth2'
113
+
114
+ # HTTP errors.
115
+ rescue AdsCommon::Errors::HttpError => e
116
+ puts "HTTP Error: %s" % e
117
+
118
+ # API errors.
119
+ rescue AdwordsApi::Errors::ApiException => e
120
+ puts "Message: %s" % e.message
121
+ puts 'Errors:'
122
+ e.errors.each_with_index do |error, index|
123
+ puts "\tError [%d]:" % (index + 1)
124
+ error.each do |field, value|
125
+ puts "\t\t%s: %s" % [field, value]
126
+ end
127
+ end
128
+ end
129
+ end
@@ -0,0 +1,115 @@
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 fetches the set of valid ProductBiddingCategories.
20
+
21
+ require 'adwords_api'
22
+
23
+ def display_categories(categories, prefix='')
24
+ categories.each do |category|
25
+ puts "%s%s [%s]" % [prefix, category[:name], category[:id]]
26
+ if category[:children]
27
+ display_categories(category[:children],
28
+ "%s%s > " % [prefix, category[:name]])
29
+ end
30
+ end
31
+ end
32
+
33
+ def get_product_category_taxonomy()
34
+ # AdwordsApi::Api will read a config file from ENV['HOME']/adwords_api.yml
35
+ # when called without parameters.
36
+ adwords = AdwordsApi::Api.new
37
+
38
+ # To enable logging of SOAP requests, set the log_level value to 'DEBUG' in
39
+ # the configuration file or provide your own logger:
40
+ # adwords.logger = Logger.new('adwords_xml.log')
41
+
42
+ constant_data_srv = adwords.service(:ConstantDataService, API_VERSION)
43
+
44
+ selector = {
45
+ :predicates => [
46
+ {:field => 'Country', :operator => 'IN', :values => ['US']}
47
+ ]
48
+ }
49
+
50
+ result = constant_data_srv.get_product_bidding_category_data(selector)
51
+
52
+ bidding_categories = {}
53
+ root_categories = []
54
+
55
+ result.each do |product_bidding_category|
56
+ id = product_bidding_category[:dimension_value][:value]
57
+ parent_id = nil
58
+ name = product_bidding_category[:display_value].values.first()
59
+
60
+ if product_bidding_category[:parent_dimension_value]
61
+ parent_id = product_bidding_category[:parent_dimension_value][:value]
62
+ end
63
+
64
+ bidding_categories[id] ||= {}
65
+
66
+ category = bidding_categories[id]
67
+
68
+ if parent_id
69
+ bidding_categories[parent_id] ||= {}
70
+
71
+ parent = bidding_categories[parent_id]
72
+
73
+ parent[:children] ||= []
74
+ parent[:children] << category
75
+ else
76
+ root_categories << category
77
+ end
78
+
79
+ category[:id] = id
80
+ category[:name] = name
81
+ end
82
+
83
+ display_categories(root_categories)
84
+ end
85
+
86
+ if __FILE__ == $0
87
+ API_VERSION = :v201607
88
+
89
+ begin
90
+ get_product_category_taxonomy()
91
+
92
+ # Authorization error.
93
+ rescue AdsCommon::Errors::OAuth2VerificationRequired => e
94
+ puts "Authorization credentials are not valid. Edit adwords_api.yml for " +
95
+ "OAuth2 client ID and secret and run misc/setup_oauth2.rb example " +
96
+ "to retrieve and store OAuth2 tokens."
97
+ puts "See this wiki page for more details:\n\n " +
98
+ 'https://github.com/googleads/google-api-ads-ruby/wiki/OAuth2'
99
+
100
+ # HTTP errors.
101
+ rescue AdsCommon::Errors::HttpError => e
102
+ puts "HTTP Error: %s" % e
103
+
104
+ # API errors.
105
+ rescue AdwordsApi::Errors::ApiException => e
106
+ puts "Message: %s" % e.message
107
+ puts 'Errors:'
108
+ e.errors.each_with_index do |error, index|
109
+ puts "\tError [%d]:" % (index + 1)
110
+ error.each do |field, value|
111
+ puts "\t\t%s: %s" % [field, value]
112
+ end
113
+ end
114
+ end
115
+ 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 adds various types of targeting criteria to a campaign. To get
20
+ # campaigns list, run get_campaigns.rb.
21
+
22
+ require 'adwords_api'
23
+
24
+ def add_campaign_targeting_criteria(campaign_id, location_feed_id = nil)
25
+ # AdwordsApi::Api will read a config file from ENV['HOME']/adwords_api.yml
26
+ # when called without parameters.
27
+ adwords = AdwordsApi::Api.new
28
+
29
+ # To enable logging of SOAP requests, set the log_level value to 'DEBUG' in
30
+ # the configuration file or provide your own logger:
31
+ # adwords.logger = Logger.new('adwords_xml.log')
32
+
33
+ campaign_criterion_srv =
34
+ adwords.service(:CampaignCriterionService, API_VERSION)
35
+
36
+ # Create campaign criteria.
37
+ campaign_criteria = [
38
+ # Location criteria. The IDs can be found in the documentation or retrieved
39
+ # with the LocationCriterionService.
40
+ {:xsi_type => 'Location', :id => 21137}, # California, USA
41
+ {:xsi_type => 'Location', :id => 2484}, # Mexico
42
+ # Language criteria. The IDs can be found in the documentation or retrieved
43
+ # with the ConstantDataService.
44
+ {:xsi_type => 'Language', :id => 1000}, # English
45
+ {:xsi_type => 'Language', :id => 1003}, # Spanish
46
+ # Location Groups criteria. These represent targeting by household income
47
+ # or places of interest. The IDs can be found in the documentation or
48
+ # retrieved with the LocationCriterionService.
49
+ {
50
+ :xsi_type => 'LocationGroups',
51
+ :matching_function => {
52
+ :operator => 'AND',
53
+ :lhs_operand => [{
54
+ :xsi_type => 'IncomeOperand',
55
+ # Tiers are numbered 1-10, and represent 10% segments of earners.
56
+ # For example, TIER_1 is the top 10%, TIER_2 is the 80-90%, etc.
57
+ # Tiers 6 through 10 are grouped into TIER_6_TO_10.
58
+ :tier => 'TIER_3'
59
+ }],
60
+ :rhs_operand => [{
61
+ :xsi_type => 'GeoTargetOperand',
62
+ :locations => [1015116] # Miami, FL
63
+ }]
64
+ }
65
+ }
66
+ ]
67
+
68
+ # Distance targeting. Area of 10 miles around targets above.
69
+ unless location_feed_id.nil?
70
+ campaign_criteria << {
71
+ :xsi_type => 'LocationGroups',
72
+ :feed_id => location_feed_id,
73
+ :matching_function => {
74
+ :operator => 'IDENTITY',
75
+ :lhs_operand => [{
76
+ :xsi_type => 'LocationExtensionOperand',
77
+ :radius => {
78
+ :xsi_type => 'ConstantOperand',
79
+ :type => 'DOUBLE',
80
+ :unit => 'MILES',
81
+ :double_value => 10
82
+ }
83
+ }]
84
+ }
85
+ }
86
+ end
87
+
88
+ # Create operations.
89
+ operations = campaign_criteria.map do |criterion|
90
+ {:operator => 'ADD',
91
+ :operand => {
92
+ :campaign_id => campaign_id,
93
+ :criterion => criterion}
94
+ }
95
+ end
96
+
97
+ # Add negative campaign criterion.
98
+ operations << {
99
+ :operator => 'ADD',
100
+ :operand => {
101
+ # The 'xsi_type' field allows you to specify the xsi:type of the object
102
+ # being created. It's only necessary when you must provide an explicit
103
+ # type that the client library can't infer.
104
+ :xsi_type => 'NegativeCampaignCriterion',
105
+ :campaign_id => campaign_id,
106
+ :criterion => {
107
+ :xsi_type => 'Keyword',
108
+ :text => 'jupiter cruise',
109
+ :match_type => 'BROAD'
110
+ }
111
+ }
112
+ }
113
+
114
+ response = campaign_criterion_srv.mutate(operations)
115
+
116
+ if response and response[:value]
117
+ criteria = response[:value]
118
+ criteria.each do |campaign_criterion|
119
+ criterion = campaign_criterion[:criterion]
120
+ puts ("Campaign criterion with campaign ID %d, criterion ID %d and " +
121
+ "type '%s' was added.") % [campaign_criterion[:campaign_id],
122
+ criterion[:id], criterion[:criterion_type]]
123
+ end
124
+ else
125
+ puts 'No criteria were returned.'
126
+ end
127
+ end
128
+
129
+ if __FILE__ == $0
130
+ API_VERSION = :v201607
131
+
132
+ begin
133
+ campaign_id = 'INSERT_CAMPAIGN_ID_HERE'
134
+ # Replace the value below with the ID a feed that has been configured for
135
+ # location targeting, meaning it has an ENABLED FeedMapping with
136
+ # criterionType of 77. Feeds linked to a GMB account automatically
137
+ # have this FeedMapping.
138
+ # If you don't have such a feed, set this value to nil or delete
139
+ # the variable.
140
+ location_feed_id = 'INSERT_LOCATION_FEED_ID_HERE'
141
+ add_campaign_targeting_criteria(campaign_id, location_feed_id)
142
+
143
+ # Authorization error.
144
+ rescue AdsCommon::Errors::OAuth2VerificationRequired => e
145
+ puts "Authorization credentials are not valid. Edit adwords_api.yml for " +
146
+ "OAuth2 client ID and secret and run misc/setup_oauth2.rb example " +
147
+ "to retrieve and store OAuth2 tokens."
148
+ puts "See this wiki page for more details:\n\n " +
149
+ 'https://github.com/googleads/google-api-ads-ruby/wiki/OAuth2'
150
+
151
+ # HTTP errors.
152
+ rescue AdsCommon::Errors::HttpError => e
153
+ puts "HTTP Error: %s" % e
154
+
155
+ # API errors.
156
+ rescue AdwordsApi::Errors::ApiException => e
157
+ puts "Message: %s" % e.message
158
+ puts 'Errors:'
159
+ e.errors.each_with_index do |error, index|
160
+ puts "\tError [%d]:" % (index + 1)
161
+ error.each do |field, value|
162
+ puts "\t\t%s: %s" % [field, value]
163
+ end
164
+ end
165
+ end
166
+ end