google-adwords-api 0.17.0 → 0.18.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (170) hide show
  1. checksums.yaml +5 -13
  2. data/ChangeLog +5 -0
  3. data/README.md +3 -3
  4. data/adwords_api.yml +3 -0
  5. data/examples/v201509/{campaign_management → advanced_operations}/add_complete_campaigns_using_batch_job.rb +10 -16
  6. data/examples/v201509/advanced_operations/add_keywords_using_incremental_batch_job.rb +179 -0
  7. data/examples/v201509/reporting/stream_criteria_report_results.rb +97 -0
  8. data/lib/adwords_api/api_config.rb +0 -86
  9. data/lib/adwords_api/batch_job_utils.rb +124 -51
  10. data/lib/adwords_api/incremental_upload_helper.rb +71 -0
  11. data/lib/adwords_api/report_header_handler.rb +1 -1
  12. data/lib/adwords_api/report_stream.rb +64 -0
  13. data/lib/adwords_api/report_utils.rb +88 -8
  14. data/lib/adwords_api/version.rb +1 -1
  15. data/test/adwords_api/test_batch_job_utils.rb +15 -0
  16. metadata +18 -168
  17. data/examples/v201502/account_management/create_account.rb +0 -88
  18. data/examples/v201502/account_management/get_account_changes.rb +0 -139
  19. data/examples/v201502/account_management/get_account_hierarchy.rb +0 -94
  20. data/examples/v201502/advanced_operations/add_ad_customizers.rb +0 -184
  21. data/examples/v201502/advanced_operations/add_ad_group_bid_modifier.rb +0 -101
  22. data/examples/v201502/advanced_operations/add_click_to_download_ad.rb +0 -133
  23. data/examples/v201502/advanced_operations/add_text_ad_with_upgraded_urls.rb +0 -134
  24. data/examples/v201502/advanced_operations/create_and_attach_shared_keyword_set.rb +0 -133
  25. data/examples/v201502/advanced_operations/find_and_remove_criteria_from_shared_set.rb +0 -166
  26. data/examples/v201502/advanced_operations/get_ad_group_bid_modifiers.rb +0 -102
  27. data/examples/v201502/advanced_operations/upload_offline_conversions.rb +0 -113
  28. data/examples/v201502/advanced_operations/use_shared_bidding_strategy.rb +0 -147
  29. data/examples/v201502/basic_operations/add_ad_groups.rb +0 -140
  30. data/examples/v201502/basic_operations/add_campaigns.rb +0 -139
  31. data/examples/v201502/basic_operations/add_keywords.rb +0 -114
  32. data/examples/v201502/basic_operations/add_text_ads.rb +0 -109
  33. data/examples/v201502/basic_operations/get_ad_groups.rb +0 -102
  34. data/examples/v201502/basic_operations/get_campaigns.rb +0 -97
  35. data/examples/v201502/basic_operations/get_campaigns_with_awql.rb +0 -89
  36. data/examples/v201502/basic_operations/get_keywords.rb +0 -108
  37. data/examples/v201502/basic_operations/get_text_ads.rb +0 -110
  38. data/examples/v201502/basic_operations/pause_ad.rb +0 -88
  39. data/examples/v201502/basic_operations/remove_ad.rb +0 -89
  40. data/examples/v201502/basic_operations/remove_ad_group.rb +0 -85
  41. data/examples/v201502/basic_operations/remove_campaign.rb +0 -87
  42. data/examples/v201502/basic_operations/remove_keyword.rb +0 -94
  43. data/examples/v201502/basic_operations/update_ad_group.rb +0 -85
  44. data/examples/v201502/basic_operations/update_campaign.rb +0 -86
  45. data/examples/v201502/basic_operations/update_keyword.rb +0 -106
  46. data/examples/v201502/campaign_management/add_campaign_labels.rb +0 -82
  47. data/examples/v201502/campaign_management/add_experiment.rb +0 -162
  48. data/examples/v201502/campaign_management/add_keywords_in_bulk.rb +0 -153
  49. data/examples/v201502/campaign_management/get_all_disapproved_ads.rb +0 -97
  50. data/examples/v201502/campaign_management/get_all_disapproved_ads_with_awql.rb +0 -89
  51. data/examples/v201502/campaign_management/get_campaigns_by_label.rb +0 -108
  52. data/examples/v201502/campaign_management/promote_experiment.rb +0 -81
  53. data/examples/v201502/campaign_management/set_ad_parameters.rb +0 -118
  54. data/examples/v201502/campaign_management/set_criterion_bid_modifier.rb +0 -104
  55. data/examples/v201502/campaign_management/validate_text_ad.rb +0 -110
  56. data/examples/v201502/error_handling/handle_partial_failures.rb +0 -130
  57. data/examples/v201502/error_handling/handle_policy_violation_error.rb +0 -141
  58. data/examples/v201502/extensions/add_google_my_business_location_extensions.rb +0 -179
  59. data/examples/v201502/extensions/add_site_links.rb +0 -164
  60. data/examples/v201502/extensions/add_site_links_using_feeds.rb +0 -271
  61. data/examples/v201502/migration/migrate_to_extension_settings.rb +0 -386
  62. data/examples/v201502/migration/upgrade_ad_url.rb +0 -93
  63. data/examples/v201502/misc/create_ad_words_session_without_properties_file.rb +0 -92
  64. data/examples/v201502/misc/get_all_images_and_videos.rb +0 -104
  65. data/examples/v201502/misc/setup_oauth2.rb +0 -84
  66. data/examples/v201502/misc/upload_image.rb +0 -93
  67. data/examples/v201502/misc/use_oauth2_jwt.rb +0 -93
  68. data/examples/v201502/optimization/estimate_keyword_traffic.rb +0 -146
  69. data/examples/v201502/optimization/get_keyword_bid_simulations.rb +0 -95
  70. data/examples/v201502/optimization/get_keyword_ideas.rb +0 -126
  71. data/examples/v201502/remarketing/add_audience.rb +0 -118
  72. data/examples/v201502/remarketing/add_conversion_tracker.rb +0 -100
  73. data/examples/v201502/remarketing/add_rule_based_user_lists.rb +0 -167
  74. data/examples/v201502/reporting/download_criteria_report.rb +0 -85
  75. data/examples/v201502/reporting/download_criteria_report_with_awql.rb +0 -84
  76. data/examples/v201502/reporting/get_report_fields.rb +0 -75
  77. data/examples/v201502/reporting/parallel_report_download.rb +0 -166
  78. data/examples/v201502/shopping_campaigns/add_product_partition_tree.rb +0 -267
  79. data/examples/v201502/shopping_campaigns/add_product_scope.rb +0 -129
  80. data/examples/v201502/shopping_campaigns/add_shopping_campaign.rb +0 -129
  81. data/examples/v201502/shopping_campaigns/get_product_category_taxonomy.rb +0 -115
  82. data/examples/v201502/targeting/add_campaign_targeting_criteria.rb +0 -169
  83. data/examples/v201502/targeting/add_demographic_targeting_criteria.rb +0 -112
  84. data/examples/v201502/targeting/get_campaign_targeting_criteria.rb +0 -106
  85. data/examples/v201502/targeting/get_targetable_languages_and_carriers.rb +0 -89
  86. data/examples/v201502/targeting/lookup_location.rb +0 -108
  87. data/lib/adwords_api/v201502/account_label_service.rb +0 -46
  88. data/lib/adwords_api/v201502/account_label_service_registry.rb +0 -46
  89. data/lib/adwords_api/v201502/ad_customizer_feed_service.rb +0 -46
  90. data/lib/adwords_api/v201502/ad_customizer_feed_service_registry.rb +0 -46
  91. data/lib/adwords_api/v201502/ad_group_ad_service.rb +0 -70
  92. data/lib/adwords_api/v201502/ad_group_ad_service_registry.rb +0 -46
  93. data/lib/adwords_api/v201502/ad_group_bid_modifier_service.rb +0 -54
  94. data/lib/adwords_api/v201502/ad_group_bid_modifier_service_registry.rb +0 -46
  95. data/lib/adwords_api/v201502/ad_group_criterion_service.rb +0 -62
  96. data/lib/adwords_api/v201502/ad_group_criterion_service_registry.rb +0 -46
  97. data/lib/adwords_api/v201502/ad_group_extension_setting_service.rb +0 -54
  98. data/lib/adwords_api/v201502/ad_group_extension_setting_service_registry.rb +0 -46
  99. data/lib/adwords_api/v201502/ad_group_feed_service.rb +0 -54
  100. data/lib/adwords_api/v201502/ad_group_feed_service_registry.rb +0 -46
  101. data/lib/adwords_api/v201502/ad_group_service.rb +0 -62
  102. data/lib/adwords_api/v201502/ad_group_service_registry.rb +0 -46
  103. data/lib/adwords_api/v201502/ad_param_service.rb +0 -46
  104. data/lib/adwords_api/v201502/ad_param_service_registry.rb +0 -46
  105. data/lib/adwords_api/v201502/adwords_user_list_service.rb +0 -46
  106. data/lib/adwords_api/v201502/adwords_user_list_service_registry.rb +0 -46
  107. data/lib/adwords_api/v201502/bidding_strategy_service.rb +0 -54
  108. data/lib/adwords_api/v201502/bidding_strategy_service_registry.rb +0 -46
  109. data/lib/adwords_api/v201502/budget_order_service.rb +0 -54
  110. data/lib/adwords_api/v201502/budget_order_service_registry.rb +0 -46
  111. data/lib/adwords_api/v201502/budget_service.rb +0 -54
  112. data/lib/adwords_api/v201502/budget_service_registry.rb +0 -46
  113. data/lib/adwords_api/v201502/campaign_criterion_service.rb +0 -54
  114. data/lib/adwords_api/v201502/campaign_criterion_service_registry.rb +0 -46
  115. data/lib/adwords_api/v201502/campaign_extension_setting_service.rb +0 -54
  116. data/lib/adwords_api/v201502/campaign_extension_setting_service_registry.rb +0 -46
  117. data/lib/adwords_api/v201502/campaign_feed_service.rb +0 -54
  118. data/lib/adwords_api/v201502/campaign_feed_service_registry.rb +0 -46
  119. data/lib/adwords_api/v201502/campaign_service.rb +0 -62
  120. data/lib/adwords_api/v201502/campaign_service_registry.rb +0 -46
  121. data/lib/adwords_api/v201502/campaign_shared_set_service.rb +0 -46
  122. data/lib/adwords_api/v201502/campaign_shared_set_service_registry.rb +0 -46
  123. data/lib/adwords_api/v201502/constant_data_service.rb +0 -102
  124. data/lib/adwords_api/v201502/constant_data_service_registry.rb +0 -46
  125. data/lib/adwords_api/v201502/conversion_tracker_service.rb +0 -54
  126. data/lib/adwords_api/v201502/conversion_tracker_service_registry.rb +0 -46
  127. data/lib/adwords_api/v201502/customer_extension_setting_service.rb +0 -54
  128. data/lib/adwords_api/v201502/customer_extension_setting_service_registry.rb +0 -46
  129. data/lib/adwords_api/v201502/customer_feed_service.rb +0 -54
  130. data/lib/adwords_api/v201502/customer_feed_service_registry.rb +0 -46
  131. data/lib/adwords_api/v201502/customer_service.rb +0 -46
  132. data/lib/adwords_api/v201502/customer_service_registry.rb +0 -46
  133. data/lib/adwords_api/v201502/customer_sync_service.rb +0 -38
  134. data/lib/adwords_api/v201502/customer_sync_service_registry.rb +0 -47
  135. data/lib/adwords_api/v201502/data_service.rb +0 -78
  136. data/lib/adwords_api/v201502/data_service_registry.rb +0 -46
  137. data/lib/adwords_api/v201502/experiment_service.rb +0 -46
  138. data/lib/adwords_api/v201502/experiment_service_registry.rb +0 -46
  139. data/lib/adwords_api/v201502/feed_item_service.rb +0 -54
  140. data/lib/adwords_api/v201502/feed_item_service_registry.rb +0 -46
  141. data/lib/adwords_api/v201502/feed_mapping_service.rb +0 -54
  142. data/lib/adwords_api/v201502/feed_mapping_service_registry.rb +0 -46
  143. data/lib/adwords_api/v201502/feed_service.rb +0 -54
  144. data/lib/adwords_api/v201502/feed_service_registry.rb +0 -46
  145. data/lib/adwords_api/v201502/geo_location_service.rb +0 -38
  146. data/lib/adwords_api/v201502/geo_location_service_registry.rb +0 -46
  147. data/lib/adwords_api/v201502/label_service.rb +0 -54
  148. data/lib/adwords_api/v201502/label_service_registry.rb +0 -46
  149. data/lib/adwords_api/v201502/location_criterion_service.rb +0 -46
  150. data/lib/adwords_api/v201502/location_criterion_service_registry.rb +0 -46
  151. data/lib/adwords_api/v201502/managed_customer_service.rb +0 -78
  152. data/lib/adwords_api/v201502/managed_customer_service_registry.rb +0 -46
  153. data/lib/adwords_api/v201502/media_service.rb +0 -54
  154. data/lib/adwords_api/v201502/media_service_registry.rb +0 -46
  155. data/lib/adwords_api/v201502/mutate_job_service.rb +0 -54
  156. data/lib/adwords_api/v201502/mutate_job_service_registry.rb +0 -46
  157. data/lib/adwords_api/v201502/offline_conversion_feed_service.rb +0 -38
  158. data/lib/adwords_api/v201502/offline_conversion_feed_service_registry.rb +0 -46
  159. data/lib/adwords_api/v201502/report_definition_service.rb +0 -38
  160. data/lib/adwords_api/v201502/report_definition_service_registry.rb +0 -46
  161. data/lib/adwords_api/v201502/shared_criterion_service.rb +0 -46
  162. data/lib/adwords_api/v201502/shared_criterion_service_registry.rb +0 -46
  163. data/lib/adwords_api/v201502/shared_set_service.rb +0 -46
  164. data/lib/adwords_api/v201502/shared_set_service_registry.rb +0 -46
  165. data/lib/adwords_api/v201502/targeting_idea_service.rb +0 -38
  166. data/lib/adwords_api/v201502/targeting_idea_service_registry.rb +0 -46
  167. data/lib/adwords_api/v201502/traffic_estimator_service.rb +0 -38
  168. data/lib/adwords_api/v201502/traffic_estimator_service_registry.rb +0 -46
  169. data/test/templates/v201502/basic_operations_get_campaigns.def +0 -116
  170. data/test/templates/v201502/misc_use_oauth2_service_account.def +0 -131
@@ -1,134 +0,0 @@
1
- #!/usr/bin/env ruby
2
- # Encoding: utf-8
3
- #
4
- # Copyright:: Copyright 2014, Google Inc. All Rights Reserved.
5
- #
6
- # License:: Licensed under the Apache License, Version 2.0 (the "License");
7
- # you may not use this file except in compliance with the License.
8
- # You may obtain a copy of the License at
9
- #
10
- # http://www.apache.org/licenses/LICENSE-2.0
11
- #
12
- # Unless required by applicable law or agreed to in writing, software
13
- # distributed under the License is distributed on an "AS IS" BASIS,
14
- # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
15
- # implied.
16
- # See the License for the specific language governing permissions and
17
- # limitations under the License.
18
- #
19
- # This code example adds a text ad that uses advanced features of upgraded
20
- # URLs.
21
-
22
- require 'adwords_api'
23
-
24
- def add_text_ad_with_upgraded_urls(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
- # Since your tracking URL will have two custom parameters, provide their
36
- # values too. This can be provided at campaign, ad group, ad, criterion, or
37
- # feed item levels.
38
- season_parameter = {
39
- :key => 'season',
40
- :value => 'christmas'
41
- }
42
-
43
- promo_code_parameter = {
44
- :key => 'promocode',
45
- :value => 'NYC123'
46
- }
47
-
48
- tracking_url_parameters = {
49
- :parameters => [season_parameter, promo_code_parameter]
50
- }
51
-
52
- text_ad = {
53
- :xsi_type => 'TextAd',
54
- :headline => 'Luxury Cruise to Mars',
55
- :description1 => 'Visit the Red Planet in style.',
56
- :description2 => 'Low-gravity fun for everyone!',
57
- :display_url => 'www.example.com',
58
- # Specify a tracking URL for 3rd party tracking provider. You may specify
59
- # one at customer, campaign, ad group, ad, criterion, or feed item levels.
60
- :tracking_url_template => 'http://tracker.example.com/' +
61
- '?season={_season}&promocode={_promocode}&u={lpurl}',
62
- :url_custom_parameters => tracking_url_parameters,
63
- # Specify a list of final URLs. This field cannot be set if :url field
64
- # is set. This may be specified at ad, criterion, and feed item levels.
65
- :final_urls => [
66
- 'http://www.example.com/cruise/space/',
67
- 'http://www.example.com/locations/mars/'
68
- ],
69
- # Specify a list of final mobile URLs. This field cannot be set if :url
70
- # field is set. This may be specificed at ad, criterion, and
71
- # feed item levels.
72
- :final_mobile_urls => [
73
- 'http://mobile.example.com/cruise/space/',
74
- 'http://mobile.example.com/locations/mars/'
75
- ]
76
- }
77
-
78
- operation = {
79
- :operator => 'ADD',
80
- :operand => {:ad_group_id => ad_group_id, :ad => text_ad}
81
- }
82
-
83
- # Add ads.
84
- response = ad_group_ad_srv.mutate([operation])
85
- if response and response[:value]
86
- response[:value].each do |ad|
87
- text_ad = ad[:ad]
88
- puts "Ad with ID %d and displayUrl '%s' was added." %
89
- [text_ad[:id], text_ad[:display_url]]
90
- puts "\tFinal URLs: %s" % [text_ad[:final_urls].join(', ')]
91
- puts "\tFinal Mobile URLs: %s" % [text_ad[:final_mobile_urls].join(', ')]
92
- puts "\tTracking URL template: %s" % [text_ad[:tracking_url_template]]
93
- custom_parameters =
94
- text_ad[:url_custom_parameters][:parameters].map do |custom_parameter|
95
- "%s=%s" % [custom_parameter[:key], custom_parameter[:value]]
96
- end
97
- puts "\tCustom parameters: %s" % [custom_parameters.join(', ')]
98
- end
99
- else
100
- raise StandardError, 'No ads were added.'
101
- end
102
- end
103
-
104
- if __FILE__ == $0
105
- API_VERSION = :v201502
106
-
107
- begin
108
- ad_group_id = 'INSERT_AD_GROUP_ID_HERE'.to_i
109
- add_text_ad_with_upgraded_urls(ad_group_id)
110
-
111
- # Authorization error.
112
- rescue AdsCommon::Errors::OAuth2VerificationRequired => e
113
- puts "Authorization credentials are not valid. Edit adwords_api.yml for " +
114
- "OAuth2 client ID and secret and run misc/setup_oauth2.rb example " +
115
- "to retrieve and store OAuth2 tokens."
116
- puts "See this wiki page for more details:\n\n " +
117
- 'http://code.google.com/p/google-api-ads-ruby/wiki/OAuth2'
118
-
119
- # HTTP errors.
120
- rescue AdsCommon::Errors::HttpError => e
121
- puts "HTTP Error: %s" % e
122
-
123
- # API errors.
124
- rescue AdwordsApi::Errors::ApiException => e
125
- puts "Message: %s" % e.message
126
- puts 'Errors:'
127
- e.errors.each_with_index do |error, index|
128
- puts "\tError [%d]:" % (index + 1)
129
- error.each do |field, value|
130
- puts "\t\t%s: %s" % [field, value]
131
- end
132
- end
133
- end
134
- end
@@ -1,133 +0,0 @@
1
- #!/usr/bin/env ruby
2
- # Encoding: utf-8
3
- #
4
- # Copyright:: Copyright 2015, Google Inc. All Rights Reserved.
5
- #
6
- # License:: Licensed under the Apache License, Version 2.0 (the "License");
7
- # you may not use this file except in compliance with the License.
8
- # You may obtain a copy of the License at
9
- #
10
- # http://www.apache.org/licenses/LICENSE-2.0
11
- #
12
- # Unless required by applicable law or agreed to in writing, software
13
- # distributed under the License is distributed on an "AS IS" BASIS,
14
- # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
15
- # implied.
16
- # See the License for the specific language governing permissions and
17
- # limitations under the License.
18
- #
19
- # This example creates a shared list of negative broad match keywords, it then
20
- # attaches them to a campaign.
21
-
22
- require 'adwords_api'
23
- require 'date'
24
-
25
- def create_and_attach_shared_keyword_set(campaign_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
- shared_set_srv = adwords.service(:SharedSetService, API_VERSION)
35
- shared_criterion_srv = adwords.service(:SharedCriterionService, API_VERSION)
36
- campaign_shared_set_srv =
37
- adwords.service(:CampaignSharedSetService, API_VERSION)
38
-
39
- # Keywords to create a shared set of.
40
- keywords = ['mars cruise', 'mars hotels']
41
-
42
- # Create shared negative keyword set.
43
- shared_set = {
44
- :name => 'API Negative keyword list - %d' % (Time.new.to_f * 1000).to_i,
45
- :type => 'NEGATIVE_KEYWORDS'
46
- }
47
-
48
- # Add shared set.
49
- response = shared_set_srv.mutate([
50
- {:operator => 'ADD', :operand => shared_set}
51
- ])
52
-
53
- if response and response[:value]
54
- shared_set = response[:value].first
55
- shared_set_id = shared_set[:shared_set_id]
56
- puts "Shared set with ID %d and name '%s' was successfully added." %
57
- [shared_set_id, shared_set[:name]]
58
- else
59
- raise StandardError, 'No shared set was added'
60
- end
61
-
62
- # Add negative keywords to shared set.
63
- shared_criteria = keywords.map do |keyword|
64
- {
65
- :criterion => {
66
- :xsi_type => 'Keyword',
67
- :text => keyword,
68
- :match_type => 'BROAD'
69
- },
70
- :negative => true,
71
- :shared_set_id => shared_set_id
72
- }
73
- end
74
-
75
- operations = shared_criteria.map do |criterion|
76
- {:operator => 'ADD', :operand => criterion}
77
- end
78
-
79
- response = shared_criterion_srv.mutate(operations)
80
- if response and response[:value]
81
- response[:value].each do |shared_criterion|
82
- puts "Added shared criterion ID %d '%s' to shared set with ID %d." %
83
- [shared_criterion[:criterion][:id],
84
- shared_criterion[:criterion][:text],
85
- shared_criterion[:shared_set_id]]
86
- end
87
- else
88
- raise StandardError, 'No shared keyword was added'
89
- end
90
-
91
- # Attach the articles to the campaign.
92
- campaign_set = {
93
- :campaign_id => campaign_id,
94
- :shared_set_id => shared_set_id
95
- }
96
-
97
- response = campaign_shared_set_srv.mutate([
98
- {:operator => 'ADD', :operand => campaign_set}
99
- ])
100
- if response and response[:value]
101
- campaign_shared_set = response[:value].first
102
- puts 'Shared set ID %d was attached to campaign ID %d' %
103
- [campaign_shared_set[:shared_set_id], campaign_shared_set[:campaign_id]]
104
- else
105
- raise StandardError, 'No campaign shared set was added'
106
- end
107
- end
108
-
109
- if __FILE__ == $0
110
- API_VERSION = :v201502
111
-
112
- begin
113
- # Campaign ID to attach shared keyword set to.
114
- campaign_id = 'INSERT_CAMPAIGN_ID_HERE'.to_i
115
-
116
- create_and_attach_shared_keyword_set(campaign_id)
117
-
118
- # HTTP errors.
119
- rescue AdsCommon::Errors::HttpError => e
120
- puts "HTTP Error: %s" % e
121
-
122
- # API errors.
123
- rescue AdwordsApi::Errors::ApiException => e
124
- puts "Message: %s" % e.message
125
- puts 'Errors:'
126
- e.errors.each_with_index do |error, index|
127
- puts "\tError [%d]:" % (index + 1)
128
- error.each do |field, value|
129
- puts "\t\t%s: %s" % [field, value]
130
- end
131
- end
132
- end
133
- end
@@ -1,166 +0,0 @@
1
- #!/usr/bin/env ruby
2
- # Encoding: utf-8
3
- #
4
- # Copyright:: Copyright 2015, 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 demonstrates how to find shared sets, shared set criterions and
20
- # how to remove them.
21
-
22
- require 'adwords_api'
23
-
24
- def find_and_remove_criteria_from_shared_set(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_shared_set_srv =
34
- adwords.service(:CampaignSharedSetService, API_VERSION)
35
- shared_criterion_srv = adwords.service(:SharedCriterionService, API_VERSION)
36
-
37
- shared_set_ids = []
38
- criterion_ids = []
39
-
40
- # First, retrieve all shared sets associated with the campaign.
41
-
42
- # Create selector for shared sets to:
43
- # - filter by campaign ID,
44
- # - filter by shared set type.
45
- selector = {
46
- :fields => ['SharedSetId', 'CampaignId', 'SharedSetName', 'SharedSetType',
47
- 'Status'],
48
- :predicates => [
49
- {:field => 'CampaignId', :operator => 'EQUALS', :values => [campaign_id]},
50
- {:field => 'SharedSetType', :operator => 'IN', :values =>
51
- ['NEGATIVE_KEYWORDS', 'NEGATIVE_PLACEMENTS']}
52
- ],
53
- :paging => {
54
- :start_index => 0,
55
- :number_results => PAGE_SIZE
56
- }
57
- }
58
-
59
- # Set initial values.
60
- offset, page = 0, {}
61
-
62
- begin
63
- page = campaign_shared_set_srv.get(selector)
64
- if page[:entries]
65
- page[:entries].each do |shared_set|
66
- puts "Campaign shared set ID %d and name '%s'" %
67
- [shared_set[:shared_set_id], shared_set[:shared_set_name]]
68
- shared_set_ids << shared_set[:shared_set_id]
69
- end
70
- # Increment values to request the next page.
71
- offset += PAGE_SIZE
72
- selector[:paging][:start_index] = offset
73
- end
74
- end while page[:total_num_entries] > offset
75
-
76
- # Next, Retrieve criterion IDs for all found shared sets.
77
- selector = {
78
- :fields => ['SharedSetId', 'Id', 'KeywordText', 'KeywordMatchType',
79
- 'PlacementUrl'],
80
- :predicates => [
81
- {:field => 'SharedSetId', :operator => 'IN', :values => shared_set_ids}
82
- ],
83
- :paging => {
84
- :start_index => 0,
85
- :number_results => PAGE_SIZE
86
- }
87
- }
88
-
89
- # Set initial values.
90
- offset, page = 0, {}
91
-
92
- begin
93
- page = shared_criterion_srv.get(selector)
94
- if page[:entries]
95
- page[:entries].each do |shared_criterion|
96
- if shared_criterion[:criterion][:type] == 'KEYWORD'
97
- puts "Shared negative keyword with ID %d and text '%s' was found." %
98
- [shared_criterion[:criterion][:id],
99
- shared_criterion[:criterion][:text]]
100
- elsif shared_criterion[:criterion][:type] == 'PLACEMENT'
101
- puts "Shared negative placement with ID %d and url '%s' was found." %
102
- [shared_criterion[:criterion][:id],
103
- shared_criterion[:criterion][:url]]
104
- else
105
- puts 'Shared criterion with ID %d was found.' %
106
- [shared_criterion[:criterion][:id]]
107
- end
108
- criterion_ids << {
109
- :shared_set_id => shared_criterion[:shared_set_id],
110
- :criterion_id => shared_criterion[:criterion][:id]
111
- }
112
- end
113
- # Increment values to request the next page.
114
- offset += PAGE_SIZE
115
- selector[:paging][:start_index] = offset
116
- end
117
- end while page[:total_num_entries] > offset
118
-
119
- # Finally, remove the criteria.
120
- operations = criterion_ids.map do |criterion|
121
- {
122
- :operator => 'REMOVE',
123
- :operand => {
124
- :criterion => {:id => criterion[:criterion_id]},
125
- :shared_set_id => criterion[:shared_set_id]
126
- }
127
- }
128
- end
129
-
130
- response = shared_criterion_srv.mutate(operations)
131
- if response and response[:value]
132
- response[:value].each do |criterion|
133
- puts "Criterion ID %d was successfully removed from shared set ID %d." %
134
- [criterion[:criterion][:id], criterion[:shared_set_id]]
135
- end
136
- else
137
- puts 'No shared criteria were removed.'
138
- end
139
- end
140
-
141
- if __FILE__ == $0
142
- API_VERSION = :v201502
143
- PAGE_SIZE = 500
144
-
145
- begin
146
- # ID of a campaign to remove shared criteria from.
147
- campaign_id = 'INSERT_CAMPAIGN_ID_HERE'.to_i
148
-
149
- find_and_remove_criteria_from_shared_set(campaign_id)
150
-
151
- # HTTP errors.
152
- rescue AdsCommon::Errors::HttpError => e
153
- puts "HTTP Error: %s" % e
154
-
155
- # API errors.
156
- rescue AdwordsApi::Errors::ApiException => e
157
- puts "Message: %s" % e.message
158
- puts 'Errors:'
159
- e.errors.each_with_index do |error, index|
160
- puts "\tError [%d]:" % (index + 1)
161
- error.each do |field, value|
162
- puts "\t\t%s: %s" % [field, value]
163
- end
164
- end
165
- end
166
- end
@@ -1,102 +0,0 @@
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 = :v201502
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
- 'http://code.google.com/p/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