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,102 @@
1
+ #!/usr/bin/env ruby
2
+ # Encoding: utf-8
3
+ #
4
+ # Copyright:: Copyright 2013, Google Inc. All Rights Reserved.
5
+ #
6
+ # License:: Licensed under the Apache License, Version 2.0 (the "License");
7
+ # you may not use this file except in compliance with the License.
8
+ # You may obtain a copy of the License at
9
+ #
10
+ # http://www.apache.org/licenses/LICENSE-2.0
11
+ #
12
+ # Unless required by applicable law or agreed to in writing, software
13
+ # distributed under the License is distributed on an "AS IS" BASIS,
14
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
15
+ # implied.
16
+ # See the License for the specific language governing permissions and
17
+ # limitations under the License.
18
+ #
19
+ # This example illustrates how to retrieve ad group level bid modifiers for a
20
+ # campaign.
21
+
22
+ require 'adwords_api'
23
+
24
+ def get_ad_group_bid_modifiers(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
+ bid_modifier_srv = adwords.service(:AdGroupBidModifierService, API_VERSION)
34
+
35
+ # Get all ad group bid modifiers for the campaign.
36
+ selector = {
37
+ :fields => ['CampaignId', 'AdGroupId', 'Id', 'BidModifier'],
38
+ :predicates => [
39
+ {:field => 'CampaignId', :operator => 'EQUALS', :values => [campaign_id]}
40
+ ],
41
+ :paging => {
42
+ :start_index => 0,
43
+ :number_results => PAGE_SIZE
44
+ }
45
+ }
46
+
47
+ # Set initial values.
48
+ offset, page = 0, {}
49
+
50
+ begin
51
+ page = bid_modifier_srv.get(selector)
52
+ if page[:entries]
53
+ page[:entries].each do |modifier|
54
+ value = modifier[:bid_modifier] || 'unset'
55
+ puts ('Campaign ID %d, AdGroup ID %d, Criterion ID %d has ad group ' +
56
+ 'level modifier: %s') %
57
+ [modifier[:campaign_id], modifier[:ad_group_id],
58
+ modifier[:criterion][:id], value]
59
+ end
60
+ # Increment values to request the next page.
61
+ offset += PAGE_SIZE
62
+ selector[:paging][:start_index] = offset
63
+ else
64
+ puts 'No ad group level bid overrides returned.'
65
+ end
66
+ end while page[:total_num_entries] > offset
67
+ end
68
+
69
+ if __FILE__ == $0
70
+ API_VERSION = :v201607
71
+ PAGE_SIZE = 500
72
+
73
+ begin
74
+ # ID of a campaign to pull overrides for.
75
+ campaign_id = 'INSERT_CAMPAIGN_ID_HERE'.to_i
76
+
77
+ get_ad_group_bid_modifiers(campaign_id)
78
+
79
+ # Authorization error.
80
+ rescue AdsCommon::Errors::OAuth2VerificationRequired => e
81
+ puts "Authorization credentials are not valid. Edit adwords_api.yml for " +
82
+ "OAuth2 client ID and secret and run misc/setup_oauth2.rb example " +
83
+ "to retrieve and store OAuth2 tokens."
84
+ puts "See this wiki page for more details:\n\n " +
85
+ 'https://github.com/googleads/google-api-ads-ruby/wiki/OAuth2'
86
+
87
+ # HTTP errors.
88
+ rescue AdsCommon::Errors::HttpError => e
89
+ puts "HTTP Error: %s" % e
90
+
91
+ # API errors.
92
+ rescue AdwordsApi::Errors::ApiException => e
93
+ puts "Message: %s" % e.message
94
+ puts 'Errors:'
95
+ e.errors.each_with_index do |error, index|
96
+ puts "\tError [%d]:" % (index + 1)
97
+ error.each do |field, value|
98
+ puts "\t\t%s: %s" % [field, value]
99
+ end
100
+ end
101
+ end
102
+ end
@@ -0,0 +1,146 @@
1
+ #!/usr/bin/env ruby
2
+ # Encoding: utf-8
3
+ #
4
+ # Copyright:: Copyright 2013, Google Inc. All Rights Reserved.
5
+ #
6
+ # License:: Licensed under the Apache License, Version 2.0 (the "License");
7
+ # you may not use this file except in compliance with the License.
8
+ # You may obtain a copy of the License at
9
+ #
10
+ # http://www.apache.org/licenses/LICENSE-2.0
11
+ #
12
+ # Unless required by applicable law or agreed to in writing, software
13
+ # distributed under the License is distributed on an "AS IS" BASIS,
14
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
15
+ # implied.
16
+ # See the License for the specific language governing permissions and
17
+ # limitations under the License.
18
+ #
19
+ # This example adds a Portfolio Bidding Strategy and uses it to construct a
20
+ # campaign.
21
+
22
+ require 'adwords_api'
23
+ require 'date'
24
+
25
+ def use_portfolio_bidding_strategy()
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
+ budget_srv = adwords.service(:BudgetService, API_VERSION)
35
+ bidding_srv = adwords.service(:BiddingStrategyService, API_VERSION)
36
+ campaign_srv = adwords.service(:CampaignService, API_VERSION)
37
+
38
+ # Create a budget, which can be shared by multiple campaigns.
39
+ budget = {
40
+ :name => 'Interplanetary budget #%d' % (Time.new.to_f * 1000).to_i,
41
+ :amount => {:micro_amount => 50000000},
42
+ :delivery_method => 'STANDARD',
43
+ :is_explicitly_shared => true
44
+ }
45
+ return_budget = budget_srv.mutate([
46
+ {:operator => 'ADD', :operand => budget}])
47
+ budget_id = return_budget[:value].first[:budget_id]
48
+
49
+ # Create a portfolio bidding strategy.
50
+ portfolio_bidding_strategy = {
51
+ :name => 'Maximize Clicks #%d' % (Time.new.to_f * 1000).to_i,
52
+ :bidding_scheme => {
53
+ :xsi_type => 'TargetSpendBiddingScheme',
54
+ # Optionally set additional bidding scheme parameters.
55
+ :bid_ceiling => {:micro_amount => 20000000},
56
+ :spend_target => {:micro_amount => 40000000}
57
+ }
58
+ }
59
+ return_strategy = bidding_srv.mutate([
60
+ {:operator => 'ADD', :operand => portfolio_bidding_strategy}])
61
+
62
+ bidding_strategy = return_strategy[:value].first
63
+ puts ("Portfolio bidding strategy with name '%s' and ID %d of type '%s'" +
64
+ ' was created') %
65
+ [bidding_strategy[:name], bidding_strategy[:id], bidding_strategy[:type]]
66
+
67
+ # Create campaigns.
68
+ campaigns = [
69
+ {
70
+ :name => "Interplanetary Cruise #%d" % (Time.new.to_f * 1000).to_i,
71
+ :status => 'PAUSED',
72
+ :bidding_strategy_configuration => {
73
+ :bidding_strategy_id => bidding_strategy[:id]
74
+ },
75
+ # Budget (required) - note only the budget ID is required.
76
+ :budget => {:budget_id => budget_id},
77
+ :advertising_channel_type => 'SEARCH',
78
+ :network_setting => {
79
+ :target_google_search => true,
80
+ :target_search_network => true,
81
+ :target_content_network => true
82
+ }
83
+ },
84
+ {
85
+ :name => "Interplanetary Cruise banner #%d" % (Time.new.to_f * 1000).to_i,
86
+ :status => 'PAUSED',
87
+ :bidding_strategy_configuration => {
88
+ :bidding_strategy_id => bidding_strategy[:id]
89
+ },
90
+ :budget => {:budget_id => budget_id},
91
+ :advertising_channel_type => 'DISPLAY',
92
+ :network_setting => {
93
+ :target_google_search => false,
94
+ :target_search_network => false,
95
+ :target_content_network => true
96
+ }
97
+ }
98
+ ]
99
+
100
+ # Prepare for adding campaign.
101
+ operations = campaigns.map do |campaign|
102
+ {:operator => 'ADD', :operand => campaign}
103
+ end
104
+
105
+ # Add campaign.
106
+ response = campaign_srv.mutate(operations)
107
+ if response and response[:value]
108
+ response[:value].each do |campaign|
109
+ puts "Campaign with name '%s' and ID %d was added." %
110
+ [campaign[:name], campaign[:id]]
111
+ end
112
+ else
113
+ raise new StandardError, 'No campaigns were added.'
114
+ end
115
+ end
116
+
117
+ if __FILE__ == $0
118
+ API_VERSION = :v201607
119
+
120
+ begin
121
+ use_portfolio_bidding_strategy()
122
+
123
+ # Authorization error.
124
+ rescue AdsCommon::Errors::OAuth2VerificationRequired => e
125
+ puts "Authorization credentials are not valid. Edit adwords_api.yml for " +
126
+ "OAuth2 client ID and secret and run misc/setup_oauth2.rb example " +
127
+ "to retrieve and store OAuth2 tokens."
128
+ puts "See this wiki page for more details:\n\n " +
129
+ 'https://github.com/googleads/google-api-ads-ruby/wiki/OAuth2'
130
+
131
+ # HTTP errors.
132
+ rescue AdsCommon::Errors::HttpError => e
133
+ puts "HTTP Error: %s" % e
134
+
135
+ # API errors.
136
+ rescue AdwordsApi::Errors::ApiException => e
137
+ puts "Message: %s" % e.message
138
+ puts 'Errors:'
139
+ e.errors.each_with_index do |error, index|
140
+ puts "\tError [%d]:" % (index + 1)
141
+ error.each do |field, value|
142
+ puts "\t\t%s: %s" % [field, value]
143
+ end
144
+ end
145
+ end
146
+ end
@@ -0,0 +1,142 @@
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 ad groups. To get a list of existing
20
+ # campaigns run get_campaigns.rb.
21
+
22
+ require 'adwords_api'
23
+
24
+ def add_ad_groups(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
+ ad_group_srv = adwords.service(:AdGroupService, API_VERSION)
34
+
35
+ ad_groups = [
36
+ {
37
+ :name => "Earth to Mars Cruises #%d" % (Time.new.to_f * 1000).to_i,
38
+ :status => 'ENABLED',
39
+ :campaign_id => campaign_id,
40
+ :bidding_strategy_configuration => {
41
+ :bids => [
42
+ {
43
+ # The 'xsi_type' field allows you to specify the xsi:type of the
44
+ # object being created. It's only necessary when you must provide
45
+ # an explicit type that the client library can't infer.
46
+ :xsi_type => 'CpcBid',
47
+ :bid => {:micro_amount => 10000000}
48
+ }
49
+ ]
50
+ },
51
+ :settings => [
52
+ # Targeting restriction settings. Depending on the :criterion_type_group
53
+ # value, most TargetingSettingDetail only affect Display campaigns.
54
+ # However, the USER_INTEREST_AND_LIST value works for RLSA campaigns -
55
+ # Search campaigns targeting using a remarketing list.
56
+ {
57
+ :xsi_type => 'TargetingSetting',
58
+ :details => [
59
+ # Restricting to serve ads that match your ad group placements.
60
+ # This is equivalent to choosing "Target and bid" in the UI.
61
+ {
62
+ :xsi_type => 'TargetingSettingDetail',
63
+ :criterion_type_group => 'PLACEMENT',
64
+ :target_all => false
65
+ },
66
+ # Using your ad group verticals only for bidding. This is equivalent
67
+ # to choosing "Bid only" in the UI.
68
+ {
69
+ :xsi_type => 'TargetingSettingDetail',
70
+ :criterion_type_group => 'VERTICAL',
71
+ :target_all => true
72
+ }
73
+ ]
74
+ }
75
+ ]
76
+ },
77
+ {
78
+ :name => 'Earth to Pluto Cruises #%d' % (Time.new.to_f * 1000).to_i,
79
+ :status => 'ENABLED',
80
+ :campaign_id => campaign_id,
81
+ :bidding_strategy_configuration => {
82
+ :bids => [
83
+ {
84
+ # The 'xsi_type' field allows you to specify the xsi:type of the
85
+ # object being created. It's only necessary when you must provide
86
+ # an explicit type that the client library can't infer.
87
+ :xsi_type => 'CpcBid',
88
+ :bid => {:micro_amount => 10000000}
89
+ }
90
+ ]
91
+ }
92
+ }
93
+ ]
94
+
95
+ # Prepare operations for adding ad groups.
96
+ operations = ad_groups.map do |ad_group|
97
+ {:operator => 'ADD', :operand => ad_group}
98
+ end
99
+
100
+ # Add ad groups.
101
+ response = ad_group_srv.mutate(operations)
102
+ if response and response[:value]
103
+ response[:value].each do |ad_group|
104
+ puts "Ad group ID %d was successfully added." % ad_group[:id]
105
+ end
106
+ else
107
+ raise StandardError, 'No ad group was added'
108
+ end
109
+ end
110
+
111
+ if __FILE__ == $0
112
+ API_VERSION = :v201607
113
+
114
+ begin
115
+ # Campaign ID to add ad group to.
116
+ campaign_id = 'INSERT_CAMPAIGN_ID_HERE'.to_i
117
+ add_ad_groups(campaign_id)
118
+
119
+ # Authorization error.
120
+ rescue AdsCommon::Errors::OAuth2VerificationRequired => e
121
+ puts "Authorization credentials are not valid. Edit adwords_api.yml for " +
122
+ "OAuth2 client ID and secret and run misc/setup_oauth2.rb example " +
123
+ "to retrieve and store OAuth2 tokens."
124
+ puts "See this wiki page for more details:\n\n " +
125
+ 'https://github.com/googleads/google-api-ads-ruby/wiki/OAuth2'
126
+
127
+ # HTTP errors.
128
+ rescue AdsCommon::Errors::HttpError => e
129
+ puts "HTTP Error: %s" % e
130
+
131
+ # API errors.
132
+ rescue AdwordsApi::Errors::ApiException => e
133
+ puts "Message: %s" % e.message
134
+ puts 'Errors:'
135
+ e.errors.each_with_index do |error, index|
136
+ puts "\tError [%d]:" % (index + 1)
137
+ error.each do |field, value|
138
+ puts "\t\t%s: %s" % [field, value]
139
+ end
140
+ end
141
+ end
142
+ end
@@ -0,0 +1,138 @@
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 campaigns.
20
+
21
+ require 'adwords_api'
22
+ require 'date'
23
+
24
+ def add_campaigns()
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
+ budget_srv = adwords.service(:BudgetService, API_VERSION)
34
+ campaign_srv = adwords.service(:CampaignService, API_VERSION)
35
+
36
+ # Create a budget, which can be shared by multiple campaigns.
37
+ budget = {
38
+ :name => 'Interplanetary budget #%d' % (Time.new.to_f * 1000).to_i,
39
+ :amount => {:micro_amount => 50000000},
40
+ :delivery_method => 'STANDARD'
41
+ }
42
+ budget_operation = {:operator => 'ADD', :operand => budget}
43
+
44
+ # Add budget.
45
+ return_budget = budget_srv.mutate([budget_operation])
46
+ budget_id = return_budget[:value].first[:budget_id]
47
+
48
+ # Create campaigns.
49
+ campaigns = [
50
+ {
51
+ :name => "Interplanetary Cruise #%d" % (Time.new.to_f * 1000).to_i,
52
+ :status => 'PAUSED',
53
+ :bidding_strategy_configuration => {
54
+ :bidding_strategy_type => 'MANUAL_CPC'
55
+ },
56
+ # Budget (required) - note only the budget ID is required.
57
+ :budget => {:budget_id => budget_id},
58
+ :advertising_channel_type => 'SEARCH',
59
+ # Optional fields:
60
+ :start_date =>
61
+ DateTime.parse((Date.today + 1).to_s).strftime('%Y%m%d'),
62
+ :ad_serving_optimization_status => 'ROTATE',
63
+ :network_setting => {
64
+ :target_google_search => true,
65
+ :target_search_network => true,
66
+ :target_content_network => true
67
+ },
68
+ :settings => [
69
+ {
70
+ :xsi_type => 'GeoTargetTypeSetting',
71
+ :positive_geo_target_type => 'DONT_CARE',
72
+ :negative_geo_target_type => 'DONT_CARE'
73
+ }
74
+ ],
75
+ :frequency_cap => {
76
+ :impressions => '5',
77
+ :time_unit => 'DAY',
78
+ :level => 'ADGROUP'
79
+ }
80
+ },
81
+ {
82
+ :name => "Interplanetary Cruise banner #%d" % (Time.new.to_f * 1000).to_i,
83
+ :status => 'PAUSED',
84
+ :bidding_strategy_configuration => {
85
+ :bidding_strategy_type => 'MANUAL_CPC'
86
+ },
87
+ :budget => {:budget_id => budget_id},
88
+ :advertising_channel_type => 'DISPLAY'
89
+ }
90
+ ]
91
+
92
+ # Prepare for adding campaign.
93
+ operations = campaigns.map do |campaign|
94
+ {:operator => 'ADD', :operand => campaign}
95
+ end
96
+
97
+ # Add campaign.
98
+ response = campaign_srv.mutate(operations)
99
+ if response and response[:value]
100
+ response[:value].each do |campaign|
101
+ puts "Campaign with name '%s' and ID %d was added." %
102
+ [campaign[:name], campaign[:id]]
103
+ end
104
+ else
105
+ raise new StandardError, 'No campaigns were added.'
106
+ end
107
+ end
108
+
109
+ if __FILE__ == $0
110
+ API_VERSION = :v201607
111
+
112
+ begin
113
+ add_campaigns()
114
+
115
+ # Authorization error.
116
+ rescue AdsCommon::Errors::OAuth2VerificationRequired => e
117
+ puts "Authorization credentials are not valid. Edit adwords_api.yml for " +
118
+ "OAuth2 client ID and secret and run misc/setup_oauth2.rb example " +
119
+ "to retrieve and store OAuth2 tokens."
120
+ puts "See this wiki page for more details:\n\n " +
121
+ 'https://github.com/googleads/google-api-ads-ruby/wiki/OAuth2'
122
+
123
+ # HTTP errors.
124
+ rescue AdsCommon::Errors::HttpError => e
125
+ puts "HTTP Error: %s" % e
126
+
127
+ # API errors.
128
+ rescue AdwordsApi::Errors::ApiException => e
129
+ puts "Message: %s" % e.message
130
+ puts 'Errors:'
131
+ e.errors.each_with_index do |error, index|
132
+ puts "\tError [%d]:" % (index + 1)
133
+ error.each do |field, value|
134
+ puts "\t\t%s: %s" % [field, value]
135
+ end
136
+ end
137
+ end
138
+ end