google-adwords-api 0.21.1 → 0.22.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (182) hide show
  1. checksums.yaml +4 -4
  2. data/ChangeLog +3 -0
  3. data/examples/{v201603/basic_operations/remove_campaign.rb → v201609/account_management/accept_service_link.rb} +24 -20
  4. data/examples/v201609/advanced_operations/add_universal_app_campaign.rb +3 -0
  5. data/examples/v201609/advanced_operations/use_portfolio_bidding_strategy.rb +3 -0
  6. data/examples/v201609/basic_operations/add_campaigns.rb +3 -0
  7. data/examples/v201609/campaign_management/add_complete_campaigns_using_batch_job.rb +3 -0
  8. data/examples/v201609/misc/use_oauth2_jwt.rb +1 -1
  9. data/examples/v201609/shopping_campaigns/add_shopping_campaign.rb +4 -0
  10. data/lib/adwords_api/api_config.rb +0 -92
  11. data/lib/adwords_api/version.rb +1 -1
  12. data/test/adwords_api/test_choices.rb +88 -25
  13. metadata +5 -174
  14. data/examples/v201603/account_management/create_account.rb +0 -88
  15. data/examples/v201603/account_management/get_account_changes.rb +0 -135
  16. data/examples/v201603/account_management/get_account_hierarchy.rb +0 -132
  17. data/examples/v201603/advanced_operations/add_ad_customizers.rb +0 -184
  18. data/examples/v201603/advanced_operations/add_ad_group_bid_modifier.rb +0 -101
  19. data/examples/v201603/advanced_operations/add_click_to_download_ad.rb +0 -133
  20. data/examples/v201603/advanced_operations/add_html5_ad.rb +0 -137
  21. data/examples/v201603/advanced_operations/add_text_ad_with_upgraded_urls.rb +0 -134
  22. data/examples/v201603/advanced_operations/create_and_attach_shared_keyword_set.rb +0 -141
  23. data/examples/v201603/advanced_operations/find_and_remove_criteria_from_shared_set.rb +0 -174
  24. data/examples/v201603/advanced_operations/get_ad_group_bid_modifiers.rb +0 -102
  25. data/examples/v201603/advanced_operations/use_portfolio_bidding_strategy.rb +0 -146
  26. data/examples/v201603/basic_operations/add_ad_groups.rb +0 -142
  27. data/examples/v201603/basic_operations/add_campaigns.rb +0 -138
  28. data/examples/v201603/basic_operations/add_keywords.rb +0 -114
  29. data/examples/v201603/basic_operations/add_text_ads.rb +0 -109
  30. data/examples/v201603/basic_operations/get_ad_groups.rb +0 -102
  31. data/examples/v201603/basic_operations/get_campaigns.rb +0 -97
  32. data/examples/v201603/basic_operations/get_campaigns_with_awql.rb +0 -89
  33. data/examples/v201603/basic_operations/get_keywords.rb +0 -109
  34. data/examples/v201603/basic_operations/get_text_ads.rb +0 -110
  35. data/examples/v201603/basic_operations/pause_ad.rb +0 -88
  36. data/examples/v201603/basic_operations/remove_ad.rb +0 -89
  37. data/examples/v201603/basic_operations/remove_ad_group.rb +0 -85
  38. data/examples/v201603/basic_operations/remove_keyword.rb +0 -94
  39. data/examples/v201603/basic_operations/update_ad_group.rb +0 -85
  40. data/examples/v201603/basic_operations/update_campaign.rb +0 -86
  41. data/examples/v201603/basic_operations/update_keyword.rb +0 -106
  42. data/examples/v201603/campaign_management/add_campaign_labels.rb +0 -82
  43. data/examples/v201603/campaign_management/add_complete_campaigns_using_batch_job.rb +0 -355
  44. data/examples/v201603/campaign_management/add_draft.rb +0 -114
  45. data/examples/v201603/campaign_management/add_experiment.rb +0 -162
  46. data/examples/v201603/campaign_management/add_keywords_using_incremental_batch_job.rb +0 -210
  47. data/examples/v201603/campaign_management/add_trial.rb +0 -142
  48. data/examples/v201603/campaign_management/get_all_disapproved_ads.rb +0 -97
  49. data/examples/v201603/campaign_management/get_all_disapproved_ads_with_awql.rb +0 -89
  50. data/examples/v201603/campaign_management/get_campaigns_by_label.rb +0 -108
  51. data/examples/v201603/campaign_management/graduate_trial.rb +0 -106
  52. data/examples/v201603/campaign_management/promote_experiment.rb +0 -81
  53. data/examples/v201603/campaign_management/set_ad_parameters.rb +0 -118
  54. data/examples/v201603/campaign_management/set_criterion_bid_modifier.rb +0 -104
  55. data/examples/v201603/campaign_management/validate_text_ad.rb +0 -110
  56. data/examples/v201603/error_handling/handle_partial_failures.rb +0 -130
  57. data/examples/v201603/error_handling/handle_policy_violation_error.rb +0 -141
  58. data/examples/v201603/extensions/add_google_my_business_location_extensions.rb +0 -193
  59. data/examples/v201603/extensions/add_site_links.rb +0 -184
  60. data/examples/v201603/extensions/add_site_links_using_feeds.rb +0 -281
  61. data/examples/v201603/migration/migrate_to_extension_settings.rb +0 -386
  62. data/examples/v201603/migration/upgrade_ad_url.rb +0 -93
  63. data/examples/v201603/misc/get_all_images_and_videos.rb +0 -104
  64. data/examples/v201603/misc/setup_oauth2.rb +0 -84
  65. data/examples/v201603/misc/upload_image.rb +0 -93
  66. data/examples/v201603/misc/upload_media_bundle.rb +0 -90
  67. data/examples/v201603/misc/use_oauth2_jwt.rb +0 -93
  68. data/examples/v201603/misc/use_runtime_config.rb +0 -92
  69. data/examples/v201603/optimization/estimate_keyword_traffic.rb +0 -146
  70. data/examples/v201603/optimization/get_campaign_criterion_bid_modifier_simulations.rb +0 -128
  71. data/examples/v201603/optimization/get_keyword_bid_simulations.rb +0 -95
  72. data/examples/v201603/optimization/get_keyword_ideas.rb +0 -136
  73. data/examples/v201603/remarketing/add_audience.rb +0 -118
  74. data/examples/v201603/remarketing/add_conversion_tracker.rb +0 -97
  75. data/examples/v201603/remarketing/add_crm_based_user_list.rb +0 -116
  76. data/examples/v201603/remarketing/add_rule_based_user_lists.rb +0 -167
  77. data/examples/v201603/remarketing/upload_offline_conversions.rb +0 -98
  78. data/examples/v201603/reporting/download_criteria_report.rb +0 -92
  79. data/examples/v201603/reporting/download_criteria_report_with_awql.rb +0 -93
  80. data/examples/v201603/reporting/get_report_fields.rb +0 -75
  81. data/examples/v201603/reporting/parallel_report_download.rb +0 -164
  82. data/examples/v201603/reporting/stream_criteria_report_results.rb +0 -97
  83. data/examples/v201603/shopping_campaigns/add_product_partition_tree.rb +0 -267
  84. data/examples/v201603/shopping_campaigns/add_product_scope.rb +0 -130
  85. data/examples/v201603/shopping_campaigns/add_shopping_campaign.rb +0 -129
  86. data/examples/v201603/shopping_campaigns/get_product_category_taxonomy.rb +0 -115
  87. data/examples/v201603/targeting/add_campaign_targeting_criteria.rb +0 -180
  88. data/examples/v201603/targeting/add_demographic_targeting_criteria.rb +0 -112
  89. data/examples/v201603/targeting/get_campaign_targeting_criteria.rb +0 -106
  90. data/examples/v201603/targeting/get_targetable_languages_and_carriers.rb +0 -89
  91. data/examples/v201603/targeting/lookup_location.rb +0 -108
  92. data/lib/adwords_api/v201603/account_label_service.rb +0 -46
  93. data/lib/adwords_api/v201603/account_label_service_registry.rb +0 -46
  94. data/lib/adwords_api/v201603/ad_customizer_feed_service.rb +0 -46
  95. data/lib/adwords_api/v201603/ad_customizer_feed_service_registry.rb +0 -46
  96. data/lib/adwords_api/v201603/ad_group_ad_service.rb +0 -70
  97. data/lib/adwords_api/v201603/ad_group_ad_service_registry.rb +0 -46
  98. data/lib/adwords_api/v201603/ad_group_bid_modifier_service.rb +0 -54
  99. data/lib/adwords_api/v201603/ad_group_bid_modifier_service_registry.rb +0 -46
  100. data/lib/adwords_api/v201603/ad_group_criterion_service.rb +0 -62
  101. data/lib/adwords_api/v201603/ad_group_criterion_service_registry.rb +0 -46
  102. data/lib/adwords_api/v201603/ad_group_extension_setting_service.rb +0 -54
  103. data/lib/adwords_api/v201603/ad_group_extension_setting_service_registry.rb +0 -46
  104. data/lib/adwords_api/v201603/ad_group_feed_service.rb +0 -54
  105. data/lib/adwords_api/v201603/ad_group_feed_service_registry.rb +0 -46
  106. data/lib/adwords_api/v201603/ad_group_service.rb +0 -62
  107. data/lib/adwords_api/v201603/ad_group_service_registry.rb +0 -46
  108. data/lib/adwords_api/v201603/ad_param_service.rb +0 -46
  109. data/lib/adwords_api/v201603/ad_param_service_registry.rb +0 -46
  110. data/lib/adwords_api/v201603/adwords_user_list_service.rb +0 -62
  111. data/lib/adwords_api/v201603/adwords_user_list_service_registry.rb +0 -46
  112. data/lib/adwords_api/v201603/batch_job_service.rb +0 -54
  113. data/lib/adwords_api/v201603/batch_job_service_registry.rb +0 -46
  114. data/lib/adwords_api/v201603/bidding_strategy_service.rb +0 -54
  115. data/lib/adwords_api/v201603/bidding_strategy_service_registry.rb +0 -46
  116. data/lib/adwords_api/v201603/budget_order_service.rb +0 -54
  117. data/lib/adwords_api/v201603/budget_order_service_registry.rb +0 -46
  118. data/lib/adwords_api/v201603/budget_service.rb +0 -54
  119. data/lib/adwords_api/v201603/budget_service_registry.rb +0 -46
  120. data/lib/adwords_api/v201603/campaign_criterion_service.rb +0 -54
  121. data/lib/adwords_api/v201603/campaign_criterion_service_registry.rb +0 -46
  122. data/lib/adwords_api/v201603/campaign_extension_setting_service.rb +0 -54
  123. data/lib/adwords_api/v201603/campaign_extension_setting_service_registry.rb +0 -46
  124. data/lib/adwords_api/v201603/campaign_feed_service.rb +0 -54
  125. data/lib/adwords_api/v201603/campaign_feed_service_registry.rb +0 -46
  126. data/lib/adwords_api/v201603/campaign_service.rb +0 -62
  127. data/lib/adwords_api/v201603/campaign_service_registry.rb +0 -46
  128. data/lib/adwords_api/v201603/campaign_shared_set_service.rb +0 -54
  129. data/lib/adwords_api/v201603/campaign_shared_set_service_registry.rb +0 -46
  130. data/lib/adwords_api/v201603/constant_data_service.rb +0 -110
  131. data/lib/adwords_api/v201603/constant_data_service_registry.rb +0 -46
  132. data/lib/adwords_api/v201603/conversion_tracker_service.rb +0 -54
  133. data/lib/adwords_api/v201603/conversion_tracker_service_registry.rb +0 -46
  134. data/lib/adwords_api/v201603/customer_extension_setting_service.rb +0 -54
  135. data/lib/adwords_api/v201603/customer_extension_setting_service_registry.rb +0 -46
  136. data/lib/adwords_api/v201603/customer_feed_service.rb +0 -54
  137. data/lib/adwords_api/v201603/customer_feed_service_registry.rb +0 -46
  138. data/lib/adwords_api/v201603/customer_service.rb +0 -54
  139. data/lib/adwords_api/v201603/customer_service_registry.rb +0 -46
  140. data/lib/adwords_api/v201603/customer_sync_service.rb +0 -38
  141. data/lib/adwords_api/v201603/customer_sync_service_registry.rb +0 -47
  142. data/lib/adwords_api/v201603/data_service.rb +0 -94
  143. data/lib/adwords_api/v201603/data_service_registry.rb +0 -46
  144. data/lib/adwords_api/v201603/draft_async_error_service.rb +0 -46
  145. data/lib/adwords_api/v201603/draft_async_error_service_registry.rb +0 -46
  146. data/lib/adwords_api/v201603/draft_service.rb +0 -54
  147. data/lib/adwords_api/v201603/draft_service_registry.rb +0 -46
  148. data/lib/adwords_api/v201603/experiment_service.rb +0 -46
  149. data/lib/adwords_api/v201603/experiment_service_registry.rb +0 -46
  150. data/lib/adwords_api/v201603/feed_item_service.rb +0 -54
  151. data/lib/adwords_api/v201603/feed_item_service_registry.rb +0 -46
  152. data/lib/adwords_api/v201603/feed_mapping_service.rb +0 -54
  153. data/lib/adwords_api/v201603/feed_mapping_service_registry.rb +0 -46
  154. data/lib/adwords_api/v201603/feed_service.rb +0 -54
  155. data/lib/adwords_api/v201603/feed_service_registry.rb +0 -46
  156. data/lib/adwords_api/v201603/label_service.rb +0 -54
  157. data/lib/adwords_api/v201603/label_service_registry.rb +0 -46
  158. data/lib/adwords_api/v201603/location_criterion_service.rb +0 -46
  159. data/lib/adwords_api/v201603/location_criterion_service_registry.rb +0 -46
  160. data/lib/adwords_api/v201603/managed_customer_service.rb +0 -78
  161. data/lib/adwords_api/v201603/managed_customer_service_registry.rb +0 -46
  162. data/lib/adwords_api/v201603/media_service.rb +0 -54
  163. data/lib/adwords_api/v201603/media_service_registry.rb +0 -46
  164. data/lib/adwords_api/v201603/offline_conversion_feed_service.rb +0 -38
  165. data/lib/adwords_api/v201603/offline_conversion_feed_service_registry.rb +0 -46
  166. data/lib/adwords_api/v201603/report_definition_service.rb +0 -38
  167. data/lib/adwords_api/v201603/report_definition_service_registry.rb +0 -46
  168. data/lib/adwords_api/v201603/shared_criterion_service.rb +0 -54
  169. data/lib/adwords_api/v201603/shared_criterion_service_registry.rb +0 -46
  170. data/lib/adwords_api/v201603/shared_set_service.rb +0 -54
  171. data/lib/adwords_api/v201603/shared_set_service_registry.rb +0 -46
  172. data/lib/adwords_api/v201603/targeting_idea_service.rb +0 -38
  173. data/lib/adwords_api/v201603/targeting_idea_service_registry.rb +0 -46
  174. data/lib/adwords_api/v201603/traffic_estimator_service.rb +0 -38
  175. data/lib/adwords_api/v201603/traffic_estimator_service_registry.rb +0 -46
  176. data/lib/adwords_api/v201603/trial_async_error_service.rb +0 -46
  177. data/lib/adwords_api/v201603/trial_async_error_service_registry.rb +0 -46
  178. data/lib/adwords_api/v201603/trial_service.rb +0 -54
  179. data/lib/adwords_api/v201603/trial_service_registry.rb +0 -46
  180. data/test/templates/v201603/basic_operations_get_campaigns.def +0 -116
  181. data/test/templates/v201603/basic_operations_update_keyword.def +0 -125
  182. data/test/templates/v201603/misc_use_oauth2_jwt.def +0 -131
@@ -1,88 +0,0 @@
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 update an ad, setting its status to 'PAUSED'.
20
- # To create ads, run add_text_ads.rb.
21
-
22
- require 'adwords_api'
23
-
24
- def pause_ad(ad_group_id, ad_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
- # Prepare operation for updating ad.
36
- operation = {
37
- :operator => 'SET',
38
- :operand => {
39
- :ad_group_id => ad_group_id,
40
- :status => 'PAUSED',
41
- :ad => {:id => ad_id}
42
- }
43
- }
44
-
45
- # Update ad.
46
- response = ad_group_ad_srv.mutate([operation])
47
- if response and response[:value]
48
- ad = response[:value].first
49
- puts "Ad ID %d was successfully updated, status set to '%s'." %
50
- [ad[:ad][:id], ad[:status]]
51
- else
52
- puts 'No ads were updated.'
53
- end
54
- end
55
-
56
- if __FILE__ == $0
57
- API_VERSION = :v201603
58
-
59
- begin
60
- # IDs of ad to pause and its ad group.
61
- ad_group_id = 'INSERT_AD_GROUP_ID_HERE'.to_i
62
- ad_id = 'INSERT_AD_ID_HERE'.to_i
63
- pause_ad(ad_group_id, ad_id)
64
-
65
- # Authorization error.
66
- rescue AdsCommon::Errors::OAuth2VerificationRequired => e
67
- puts "Authorization credentials are not valid. Edit adwords_api.yml for " +
68
- "OAuth2 client ID and secret and run misc/setup_oauth2.rb example " +
69
- "to retrieve and store OAuth2 tokens."
70
- puts "See this wiki page for more details:\n\n " +
71
- 'https://github.com/googleads/google-api-ads-ruby/wiki/OAuth2'
72
-
73
- # HTTP errors.
74
- rescue AdsCommon::Errors::HttpError => e
75
- puts "HTTP Error: %s" % e
76
-
77
- # API errors.
78
- rescue AdwordsApi::Errors::ApiException => e
79
- puts "Message: %s" % e.message
80
- puts 'Errors:'
81
- e.errors.each_with_index do |error, index|
82
- puts "\tError [%d]:" % (index + 1)
83
- error.each do |field, value|
84
- puts "\t\t%s: %s" % [field, value]
85
- end
86
- end
87
- end
88
- end
@@ -1,89 +0,0 @@
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 removes an ad using the 'REMOVE' operator. To get ads, run
20
- # get_text_ads.rb.
21
-
22
- require 'adwords_api'
23
-
24
- def remove_ad(ad_group_id, ad_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
- # Prepare for deleting ad.
36
- operation = {
37
- :operator => 'REMOVE',
38
- :operand => {
39
- :ad_group_id => ad_group_id,
40
- :ad => {
41
- :xsi_type => 'Ad',
42
- :id => ad_id
43
- }
44
- }
45
- }
46
-
47
- # Remove ad.
48
- response = ad_group_ad_srv.mutate([operation])
49
- if response and response[:value]
50
- ad = response[:value].first
51
- puts "Ad ID %d was successfully removed." % ad[:ad][:id]
52
- else
53
- puts 'No ads were removed.'
54
- end
55
- end
56
-
57
- if __FILE__ == $0
58
- API_VERSION = :v201603
59
-
60
- begin
61
- # IDs of an ad to remove and its ad group.
62
- ad_group_id = 'INSERT_AD_GROUP_ID_HERE'.to_i
63
- ad_id = 'INSERT_AD_ID_HERE'.to_i
64
- remove_ad(ad_group_id, ad_id)
65
-
66
- # Authorization error.
67
- rescue AdsCommon::Errors::OAuth2VerificationRequired => e
68
- puts "Authorization credentials are not valid. Edit adwords_api.yml for " +
69
- "OAuth2 client ID and secret and run misc/setup_oauth2.rb example " +
70
- "to retrieve and store OAuth2 tokens."
71
- puts "See this wiki page for more details:\n\n " +
72
- 'https://github.com/googleads/google-api-ads-ruby/wiki/OAuth2'
73
-
74
- # HTTP errors.
75
- rescue AdsCommon::Errors::HttpError => e
76
- puts "HTTP Error: %s" % e
77
-
78
- # API errors.
79
- rescue AdwordsApi::Errors::ApiException => e
80
- puts "Message: %s" % e.message
81
- puts 'Errors:'
82
- e.errors.each_with_index do |error, index|
83
- puts "\tError [%d]:" % (index + 1)
84
- error.each do |field, value|
85
- puts "\t\t%s: %s" % [field, value]
86
- end
87
- end
88
- end
89
- end
@@ -1,85 +0,0 @@
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 removes an ad group by setting the status to 'REMOVED'. To get ad
20
- # groups, run get_ad_groups.rb.
21
-
22
- require 'adwords_api'
23
-
24
- def remove_ad_group(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_srv = adwords.service(:AdGroupService, API_VERSION)
34
-
35
- # Prepare for deleting ad group.
36
- operation = {
37
- :operator => 'SET',
38
- :operand => {
39
- :id => ad_group_id,
40
- :status => 'REMOVED'
41
- }
42
- }
43
-
44
- # Remove ad group.
45
- response = ad_group_srv.mutate([operation])
46
- if response and response[:value]
47
- ad_group = response[:value].first
48
- puts "Ad group ID %d was successfully removed." % [ad_group[:id]]
49
- else
50
- puts 'No ad group was updated.'
51
- end
52
- end
53
-
54
- if __FILE__ == $0
55
- API_VERSION = :v201603
56
-
57
- begin
58
- # ID of an ad group to remove.
59
- ad_group_id = 'INSERT_AD_GROUP_ID_HERE'.to_i
60
- remove_ad_group(ad_group_id)
61
-
62
- # Authorization error.
63
- rescue AdsCommon::Errors::OAuth2VerificationRequired => e
64
- puts "Authorization credentials are not valid. Edit adwords_api.yml for " +
65
- "OAuth2 client ID and secret and run misc/setup_oauth2.rb example " +
66
- "to retrieve and store OAuth2 tokens."
67
- puts "See this wiki page for more details:\n\n " +
68
- 'https://github.com/googleads/google-api-ads-ruby/wiki/OAuth2'
69
-
70
- # HTTP errors.
71
- rescue AdsCommon::Errors::HttpError => e
72
- puts "HTTP Error: %s" % e
73
-
74
- # API errors.
75
- rescue AdwordsApi::Errors::ApiException => e
76
- puts "Message: %s" % e.message
77
- puts 'Errors:'
78
- e.errors.each_with_index do |error, index|
79
- puts "\tError [%d]:" % (index + 1)
80
- error.each do |field, value|
81
- puts "\t\t%s: %s" % [field, value]
82
- end
83
- end
84
- end
85
- end
@@ -1,94 +0,0 @@
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 removes a keyword using the 'REMOVE' operator. To get list of
20
- # keywords, run get_keywords.rb.
21
-
22
- require 'adwords_api'
23
-
24
- def remove_keyword(ad_group_id, criterion_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
- # Prepare for deleting keyword.
37
- operation = {
38
- :operator => 'REMOVE',
39
- :operand => {
40
- # The 'xsi_type' field allows you to specify the xsi:type of the object
41
- # being created. It's only necessary when you must provide an explicit
42
- # type that the client library can't infer.
43
- :xsi_type => 'BiddableAdGroupCriterion',
44
- :ad_group_id => ad_group_id,
45
- :criterion => {
46
- :id => criterion_id
47
- }
48
- }
49
- }
50
-
51
- # Remove keyword.
52
- response = ad_group_criterion_srv.mutate([operation])
53
- ad_group_criterion = response[:value].first
54
- if ad_group_criterion
55
- puts "Keyword ID %d was successfully removed." %
56
- ad_group_criterion[:criterion][:id]
57
- else
58
- puts 'No keywords were removed.'
59
- end
60
- end
61
-
62
- if __FILE__ == $0
63
- API_VERSION = :v201603
64
-
65
- begin
66
- # IDs of criterion to remove and its ad group.
67
- ad_group_id = 'INSERT_AD_GROUP_ID_HERE'.to_i
68
- criterion_id = 'INSERT_CRITERION_ID_HERE'.to_i
69
- remove_keyword(ad_group_id, criterion_id)
70
-
71
- # Authorization error.
72
- rescue AdsCommon::Errors::OAuth2VerificationRequired => e
73
- puts "Authorization credentials are not valid. Edit adwords_api.yml for " +
74
- "OAuth2 client ID and secret and run misc/setup_oauth2.rb example " +
75
- "to retrieve and store OAuth2 tokens."
76
- puts "See this wiki page for more details:\n\n " +
77
- 'https://github.com/googleads/google-api-ads-ruby/wiki/OAuth2'
78
-
79
- # HTTP errors.
80
- rescue AdsCommon::Errors::HttpError => e
81
- puts "HTTP Error: %s" % e
82
-
83
- # API errors.
84
- rescue AdwordsApi::Errors::ApiException => e
85
- puts "Message: %s" % e.message
86
- puts 'Errors:'
87
- e.errors.each_with_index do |error, index|
88
- puts "\tError [%d]:" % (index + 1)
89
- error.each do |field, value|
90
- puts "\t\t%s: %s" % [field, value]
91
- end
92
- end
93
- end
94
- end
@@ -1,85 +0,0 @@
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 update an ad group, setting its status to
20
- # 'PAUSED'. To create an ad group, run add_ad_group.rb.
21
-
22
- require 'adwords_api'
23
-
24
- def update_ad_group(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_srv = adwords.service(:AdGroupService, API_VERSION)
34
-
35
- # Prepare for updating ad group.
36
- operation = {
37
- :operator => 'SET',
38
- :operand => {
39
- :status => 'PAUSED',
40
- :id => ad_group_id
41
- }
42
- }
43
-
44
- # Update ad group.
45
- response = ad_group_srv.mutate([operation])
46
- if response and response[:value]
47
- ad_group = response[:value].first
48
- puts 'Ad group id %d was successfully updated.' % ad_group[:id]
49
- else
50
- puts 'No ad groups were updated.'
51
- end
52
- end
53
-
54
- if __FILE__ == $0
55
- API_VERSION = :v201603
56
-
57
- begin
58
- # ID of an ad group to update.
59
- ad_group_id = 'INSERT_AD_GROUP_ID_HERE'.to_i
60
- update_ad_group(ad_group_id)
61
-
62
- # Authorization error.
63
- rescue AdsCommon::Errors::OAuth2VerificationRequired => e
64
- puts "Authorization credentials are not valid. Edit adwords_api.yml for " +
65
- "OAuth2 client ID and secret and run misc/setup_oauth2.rb example " +
66
- "to retrieve and store OAuth2 tokens."
67
- puts "See this wiki page for more details:\n\n " +
68
- 'https://github.com/googleads/google-api-ads-ruby/wiki/OAuth2'
69
-
70
- # HTTP errors.
71
- rescue AdsCommon::Errors::HttpError => e
72
- puts "HTTP Error: %s" % e
73
-
74
- # API errors.
75
- rescue AdwordsApi::Errors::ApiException => e
76
- puts "Message: %s" % e.message
77
- puts 'Errors:'
78
- e.errors.each_with_index do |error, index|
79
- puts "\tError [%d]:" % (index + 1)
80
- error.each do |field, value|
81
- puts "\t\t%s: %s" % [field, value]
82
- end
83
- end
84
- end
85
- end
@@ -1,86 +0,0 @@
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 update a campaign, setting its status to
20
- # 'PAUSED'. To create a campaign, run add_campaigns.rb.
21
-
22
- require 'adwords_api'
23
-
24
- def update_campaign(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_srv = adwords.service(:CampaignService, API_VERSION)
34
-
35
- # Prepare for updating campaign.
36
- operation = {
37
- :operator => 'SET',
38
- :operand => {
39
- :id => campaign_id,
40
- :status => 'PAUSED'
41
- }
42
- }
43
-
44
- # Update campaign.
45
- response = campaign_srv.mutate([operation])
46
- if response and response[:value]
47
- campaign = response[:value].first
48
- puts "Campaign ID %d was successfully updated, status was set to '%s'." %
49
- [campaign[:id], campaign[:status]]
50
- else
51
- puts 'No campaigns were updated.'
52
- end
53
- end
54
-
55
- if __FILE__ == $0
56
- API_VERSION = :v201603
57
-
58
- begin
59
- # ID of a campaign to update.
60
- campaign_id = 'INSERT_CAMPAIGN_ID_HERE'.to_i
61
- update_campaign(campaign_id)
62
-
63
- # Authorization error.
64
- rescue AdsCommon::Errors::OAuth2VerificationRequired => e
65
- puts "Authorization credentials are not valid. Edit adwords_api.yml for " +
66
- "OAuth2 client ID and secret and run misc/setup_oauth2.rb example " +
67
- "to retrieve and store OAuth2 tokens."
68
- puts "See this wiki page for more details:\n\n " +
69
- 'https://github.com/googleads/google-api-ads-ruby/wiki/OAuth2'
70
-
71
- # HTTP errors.
72
- rescue AdsCommon::Errors::HttpError => e
73
- puts "HTTP Error: %s" % e
74
-
75
- # API errors.
76
- rescue AdwordsApi::Errors::ApiException => e
77
- puts "Message: %s" % e.message
78
- puts 'Errors:'
79
- e.errors.each_with_index do |error, index|
80
- puts "\tError [%d]:" % (index + 1)
81
- error.each do |field, value|
82
- puts "\t\t%s: %s" % [field, value]
83
- end
84
- end
85
- end
86
- end