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,108 @@
1
+ #!/usr/bin/env ruby
2
+ # Encoding: utf-8
3
+ #
4
+ # Copyright:: Copyright 2016, 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 expanded text ads to a given ad group.
20
+ # To get ad groups, run get_ad_groups.rb.
21
+
22
+ require 'adwords_api'
23
+ require 'date'
24
+
25
+ def add_expanded_text_ads(ad_group_id)
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
+ ad_group_ad_srv = adwords.service(:AdGroupAdService, API_VERSION)
35
+
36
+ # Create text ads.
37
+ # The 'xsi_type' field allows you to specify the xsi:type of the object
38
+ # being created. It's only necessary when you must provide an explicit
39
+ # type that the client library can't infer.
40
+ operations = 5.times.map do |i|
41
+ expanded_text_ad = {
42
+ :xsi_type => 'ExpandedTextAd',
43
+ :headline_part1 => 'Cruise to Mars #%d' % (Time.new.to_f * 1000).to_i,
44
+ :headline_part2 => 'Best Space Cruise Line',
45
+ :description => 'Buy your tickets now!',
46
+ :final_urls => ['http://www.example.com/%d' % i],
47
+ :path1 => 'all-inclusive',
48
+ :path2 => 'deals'
49
+ }
50
+
51
+ ad_group_ad = {
52
+ :ad_group_id => ad_group_id,
53
+ :ad => expanded_text_ad,
54
+ # Additional properties (non-required).
55
+ :status => 'PAUSED'
56
+ }
57
+
58
+ operation = {
59
+ :operator => 'ADD',
60
+ :operand => ad_group_ad
61
+ }
62
+ end
63
+
64
+ # Add ads.
65
+ response = ad_group_ad_srv.mutate(operations)
66
+ if response and response[:value]
67
+ response[:value].each do |ad_group_ad|
68
+ puts ('New expanded text ad with id "%d" and headine "%s - %s" was ' +
69
+ 'added.') % [ad_group_ad[:ad][:id], ad_group_ad[:ad][:headline_part1],
70
+ ad_group_ad[:ad][:headline_part2]]
71
+ end
72
+ else
73
+ raise StandardError, 'No ads were added.'
74
+ end
75
+ end
76
+
77
+ if __FILE__ == $0
78
+ API_VERSION = :v201607
79
+
80
+ begin
81
+ # Ad group ID to add text ads to.
82
+ ad_group_id = 'INSERT_AD_GROUP_ID_HERE'.to_i
83
+ add_expanded_text_ads(ad_group_id)
84
+
85
+ # Authorization error.
86
+ rescue AdsCommon::Errors::OAuth2VerificationRequired => e
87
+ puts "Authorization credentials are not valid. Edit adwords_api.yml for " +
88
+ "OAuth2 client ID and secret and run misc/setup_oauth2.rb example " +
89
+ "to retrieve and store OAuth2 tokens."
90
+ puts "See this wiki page for more details:\n\n " +
91
+ 'https://github.com/googleads/google-api-ads-ruby/wiki/OAuth2'
92
+
93
+ # HTTP errors.
94
+ rescue AdsCommon::Errors::HttpError => e
95
+ puts "HTTP Error: %s" % e
96
+
97
+ # API errors.
98
+ rescue AdwordsApi::Errors::ApiException => e
99
+ puts "Message: %s" % e.message
100
+ puts 'Errors:'
101
+ e.errors.each_with_index do |error, index|
102
+ puts "\tError [%d]:" % (index + 1)
103
+ error.each do |field, value|
104
+ puts "\t\t%s: %s" % [field, value]
105
+ end
106
+ end
107
+ end
108
+ end
@@ -0,0 +1,114 @@
1
+ #!/usr/bin/env ruby
2
+ # Encoding: utf-8
3
+ #
4
+ # Copyright:: Copyright 2011, Google Inc. All Rights Reserved.
5
+ #
6
+ # License:: Licensed under the Apache License, Version 2.0 (the "License");
7
+ # you may not use this file except in compliance with the License.
8
+ # You may obtain a copy of the License at
9
+ #
10
+ # http://www.apache.org/licenses/LICENSE-2.0
11
+ #
12
+ # Unless required by applicable law or agreed to in writing, software
13
+ # distributed under the License is distributed on an "AS IS" BASIS,
14
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
15
+ # implied.
16
+ # See the License for the specific language governing permissions and
17
+ # limitations under the License.
18
+ #
19
+ # This example illustrates how to add multiple keywords to a given ad group. To
20
+ # create an ad group, run add_ad_group.rb.
21
+
22
+ require 'adwords_api'
23
+
24
+ def add_keywords(ad_group_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_criterion_srv =
34
+ adwords.service(:AdGroupCriterionService, API_VERSION)
35
+
36
+ # Create keywords.
37
+ # The 'xsi_type' field allows you to specify the xsi:type of the object
38
+ # being created. It's only necessary when you must provide an explicit
39
+ # type that the client library can't infer.
40
+ keywords = [
41
+ {:xsi_type => 'BiddableAdGroupCriterion',
42
+ :ad_group_id => ad_group_id,
43
+ :criterion => {
44
+ :xsi_type => 'Keyword',
45
+ :text => 'mars cruise',
46
+ :match_type => 'BROAD'
47
+ },
48
+ # Optional fields:
49
+ :user_status => 'PAUSED',
50
+ :final_urls => {
51
+ :urls => ['http://example.com/mars']
52
+ }
53
+ },
54
+ {:xsi_type => 'BiddableAdGroupCriterion',
55
+ :ad_group_id => ad_group_id,
56
+ :criterion => {
57
+ :xsi_type => 'Keyword',
58
+ :text => 'space hotel',
59
+ :match_type => 'BROAD'}}
60
+ ]
61
+
62
+ # Create 'ADD' operations.
63
+ operations = keywords.map do |keyword|
64
+ {:operator => 'ADD', :operand => keyword}
65
+ end
66
+
67
+ # Add keywords.
68
+ response = ad_group_criterion_srv.mutate(operations)
69
+ if response and response[:value]
70
+ ad_group_criteria = response[:value]
71
+ puts "Added %d keywords to ad group ID %d:" %
72
+ [ad_group_criteria.length, ad_group_id]
73
+ ad_group_criteria.each do |ad_group_criterion|
74
+ puts "\tKeyword ID is %d and type is '%s'" %
75
+ [ad_group_criterion[:criterion][:id],
76
+ ad_group_criterion[:criterion][:type]]
77
+ end
78
+ else
79
+ raise StandardError, 'No keywords were added.'
80
+ end
81
+ end
82
+
83
+ if __FILE__ == $0
84
+ API_VERSION = :v201607
85
+
86
+ begin
87
+ # Ad group ID to add keywords to.
88
+ ad_group_id = 'INSERT_AD_GROUP_ID_HERE'.to_i
89
+ add_keywords(ad_group_id)
90
+
91
+ # Authorization error.
92
+ rescue AdsCommon::Errors::OAuth2VerificationRequired => e
93
+ puts "Authorization credentials are not valid. Edit adwords_api.yml for " +
94
+ "OAuth2 client ID and secret and run misc/setup_oauth2.rb example " +
95
+ "to retrieve and store OAuth2 tokens."
96
+ puts "See this wiki page for more details:\n\n " +
97
+ 'https://github.com/googleads/google-api-ads-ruby/wiki/OAuth2'
98
+
99
+ # HTTP errors.
100
+ rescue AdsCommon::Errors::HttpError => e
101
+ puts "HTTP Error: %s" % e
102
+
103
+ # API errors.
104
+ rescue AdwordsApi::Errors::ApiException => e
105
+ puts "Message: %s" % e.message
106
+ puts 'Errors:'
107
+ e.errors.each_with_index do |error, index|
108
+ puts "\tError [%d]:" % (index + 1)
109
+ error.each do |field, value|
110
+ puts "\t\t%s: %s" % [field, value]
111
+ end
112
+ end
113
+ end
114
+ end
@@ -0,0 +1,109 @@
1
+ #!/usr/bin/env ruby
2
+ # Encoding: utf-8
3
+ #
4
+ # Copyright:: Copyright 2011, Google Inc. All Rights Reserved.
5
+ #
6
+ # License:: Licensed under the Apache License, Version 2.0 (the "License");
7
+ # you may not use this file except in compliance with the License.
8
+ # You may obtain a copy of the License at
9
+ #
10
+ # http://www.apache.org/licenses/LICENSE-2.0
11
+ #
12
+ # Unless required by applicable law or agreed to in writing, software
13
+ # distributed under the License is distributed on an "AS IS" BASIS,
14
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
15
+ # implied.
16
+ # See the License for the specific language governing permissions and
17
+ # limitations under the License.
18
+ #
19
+ # This example illustrates how to add text ads to a given ad group. To create an
20
+ # ad group, run add_ad_group.rb.
21
+
22
+ require 'adwords_api'
23
+
24
+ def add_text_ads(ad_group_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_ad_srv = adwords.service(:AdGroupAdService, API_VERSION)
34
+
35
+ # Create text ads.
36
+ # The 'xsi_type' field allows you to specify the xsi:type of the object
37
+ # being created. It's only necessary when you must provide an explicit
38
+ # type that the client library can't infer.
39
+ text_ads = [
40
+ {
41
+ :xsi_type => 'TextAd',
42
+ :headline => 'Luxury Cruise to Mars',
43
+ :description1 => 'Visit the Red Planet in style.',
44
+ :description2 => 'Low-gravity fun for everyone!',
45
+ :final_urls => ['http://www.example.com'],
46
+ :display_url => 'www.example.com'
47
+ },
48
+ {
49
+ :xsi_type => 'TextAd',
50
+ :headline => 'Luxury Cruise to Mars',
51
+ :description1 => 'Enjoy your stay at Red Planet.',
52
+ :description2 => 'Buy your tickets now!',
53
+ :final_urls => ['http://www.example.com'],
54
+ :display_url => 'www.example.com'
55
+ }
56
+ ]
57
+
58
+ # Create ad 'ADD' operations.
59
+ text_ad_operations = text_ads.map do |text_ad|
60
+ {:operator => 'ADD',
61
+ :operand => {:ad_group_id => ad_group_id, :ad => text_ad}}
62
+ end
63
+
64
+ # Add ads.
65
+ response = ad_group_ad_srv.mutate(text_ad_operations)
66
+ if response and response[:value]
67
+ ads = response[:value]
68
+ puts "Added %d ad(s) to ad group ID %d:" % [ads.length, ad_group_id]
69
+ ads.each do |ad|
70
+ puts "\tAd ID %d, type '%s' and status '%s'" %
71
+ [ad[:ad][:id], ad[:ad][:ad_type], ad[:status]]
72
+ end
73
+ else
74
+ raise StandardError, 'No ads were added.'
75
+ end
76
+ end
77
+
78
+ if __FILE__ == $0
79
+ API_VERSION = :v201607
80
+
81
+ begin
82
+ # Ad group ID to add text ads to.
83
+ ad_group_id = 'INSERT_AD_GROUP_ID_HERE'.to_i
84
+ add_text_ads(ad_group_id)
85
+
86
+ # Authorization error.
87
+ rescue AdsCommon::Errors::OAuth2VerificationRequired => e
88
+ puts "Authorization credentials are not valid. Edit adwords_api.yml for " +
89
+ "OAuth2 client ID and secret and run misc/setup_oauth2.rb example " +
90
+ "to retrieve and store OAuth2 tokens."
91
+ puts "See this wiki page for more details:\n\n " +
92
+ 'https://github.com/googleads/google-api-ads-ruby/wiki/OAuth2'
93
+
94
+ # HTTP errors.
95
+ rescue AdsCommon::Errors::HttpError => e
96
+ puts "HTTP Error: %s" % e
97
+
98
+ # API errors.
99
+ rescue AdwordsApi::Errors::ApiException => e
100
+ puts "Message: %s" % e.message
101
+ puts 'Errors:'
102
+ e.errors.each_with_index do |error, index|
103
+ puts "\tError [%d]:" % (index + 1)
104
+ error.each do |field, value|
105
+ puts "\t\t%s: %s" % [field, value]
106
+ end
107
+ end
108
+ end
109
+ end
@@ -0,0 +1,102 @@
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 retrieve all the ad groups for a campaign. To
20
+ # create an ad group, run add_ad_group.rb.
21
+
22
+ require 'adwords_api'
23
+
24
+ def get_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
+ # Get all the ad groups for this campaign.
36
+ selector = {
37
+ :fields => ['Id', 'Name'],
38
+ :ordering => [{:field => 'Name', :sort_order => 'ASCENDING'}],
39
+ :predicates => [
40
+ {:field => 'CampaignId', :operator => 'IN', :values => [campaign_id]}
41
+ ],
42
+ :paging => {
43
+ :start_index => 0,
44
+ :number_results => PAGE_SIZE
45
+ }
46
+ }
47
+
48
+ # Set initial values.
49
+ offset, page = 0, {}
50
+
51
+ begin
52
+ page = ad_group_srv.get(selector)
53
+ if page[:entries]
54
+ page[:entries].each do |ad_group|
55
+ puts "Ad group name is '%s' and ID is %d" %
56
+ [ad_group[:name], ad_group[:id]]
57
+ end
58
+ # Increment values to request the next page.
59
+ offset += PAGE_SIZE
60
+ selector[:paging][:start_index] = offset
61
+ end
62
+ end while page[:total_num_entries] > offset
63
+
64
+ if page.include?(:total_num_entries)
65
+ puts "\tCampaign ID %d has %d ad group(s)." %
66
+ [campaign_id, page[:total_num_entries]]
67
+ end
68
+ end
69
+
70
+ if __FILE__ == $0
71
+ API_VERSION = :v201607
72
+ PAGE_SIZE = 500
73
+
74
+ begin
75
+ # Campaign ID to get ad groups for.
76
+ campaign_id = 'INSERT_CAMPAIGN_ID_HERE'.to_i
77
+ get_ad_groups(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,97 @@
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 retrieve all the campaigns for an account.
20
+
21
+ require 'adwords_api'
22
+
23
+ def get_campaigns()
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
+ campaign_srv = adwords.service(:CampaignService, API_VERSION)
33
+
34
+ # Get all the campaigns for this account.
35
+ selector = {
36
+ :fields => ['Id', 'Name', 'Status'],
37
+ :ordering => [
38
+ {:field => 'Name', :sort_order => 'ASCENDING'}
39
+ ],
40
+ :paging => {
41
+ :start_index => 0,
42
+ :number_results => PAGE_SIZE
43
+ }
44
+ }
45
+
46
+ # Set initial values.
47
+ offset, page = 0, {}
48
+
49
+ begin
50
+ page = campaign_srv.get(selector)
51
+ if page[:entries]
52
+ page[:entries].each do |campaign|
53
+ puts "Campaign ID %d, name '%s' and status '%s'" %
54
+ [campaign[:id], campaign[:name], campaign[:status]]
55
+ end
56
+ # Increment values to request the next page.
57
+ offset += PAGE_SIZE
58
+ selector[:paging][:start_index] = offset
59
+ end
60
+ end while page[:total_num_entries] > offset
61
+
62
+ if page.include?(:total_num_entries)
63
+ puts "\tTotal number of campaigns found: %d." % [page[:total_num_entries]]
64
+ end
65
+ end
66
+
67
+ if __FILE__ == $0
68
+ API_VERSION = :v201607
69
+ PAGE_SIZE = 500
70
+
71
+ begin
72
+ get_campaigns()
73
+
74
+ # Authorization error.
75
+ rescue AdsCommon::Errors::OAuth2VerificationRequired => e
76
+ puts "Authorization credentials are not valid. Edit adwords_api.yml for " +
77
+ "OAuth2 client ID and secret and run misc/setup_oauth2.rb example " +
78
+ "to retrieve and store OAuth2 tokens."
79
+ puts "See this wiki page for more details:\n\n " +
80
+ 'https://github.com/googleads/google-api-ads-ruby/wiki/OAuth2'
81
+
82
+ # HTTP errors.
83
+ rescue AdsCommon::Errors::HttpError => e
84
+ puts "HTTP Error: %s" % e
85
+
86
+ # API errors.
87
+ rescue AdwordsApi::Errors::ApiException => e
88
+ puts "Message: %s" % e.message
89
+ puts 'Errors:'
90
+ e.errors.each_with_index do |error, index|
91
+ puts "\tError [%d]:" % (index + 1)
92
+ error.each do |field, value|
93
+ puts "\t\t%s: %s" % [field, value]
94
+ end
95
+ end
96
+ end
97
+ end