google-adwords-api 0.14.2 → 0.15.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (175) hide show
  1. checksums.yaml +8 -8
  2. data/ChangeLog +7 -0
  3. data/README.md +3 -3
  4. data/adwords_api.yml +5 -0
  5. data/examples/v201409/account_management/get_account_hierarchy.rb +2 -2
  6. data/examples/v201409/advanced_operations/{add_ad_customizer.rb → add_ad_customizers.rb} +4 -4
  7. data/examples/v201409/extensions/add_site_links_using_feeds.rb +12 -12
  8. data/examples/v201409/migration/migrate_to_extension_settings.rb +29 -2
  9. data/examples/v201409/reporting/parallel_report_download.rb +1 -1
  10. data/examples/v201502/advanced_operations/{add_ad_customizer.rb → add_ad_customizers.rb} +37 -125
  11. data/examples/v201502/extensions/add_site_links_using_feeds.rb +22 -52
  12. data/examples/v201502/migration/migrate_to_extension_settings.rb +29 -2
  13. data/lib/adwords_api.rb +9 -29
  14. data/lib/adwords_api/api_config.rb +0 -80
  15. data/lib/adwords_api/credential_handler.rb +8 -9
  16. data/lib/adwords_api/report_header_handler.rb +6 -2
  17. data/lib/adwords_api/version.rb +1 -1
  18. data/test/adwords_api/test_adwords_api.rb +0 -9
  19. data/test/adwords_api/test_api_config.rb +8 -8
  20. data/test/adwords_api/test_credential_handler.rb +17 -0
  21. data/test/adwords_api/test_report_utils.rb +1 -1
  22. data/test/templates/v201409/basic_operations_get_campaigns.def +1 -1
  23. data/test/templates/v201409/misc_use_oauth2_jwt.def +1 -1
  24. data/test/templates/v201502/basic_operations_get_campaigns.def +1 -1
  25. data/test/templates/v201502/misc_use_oauth2_jwt.def +1 -1
  26. metadata +4 -153
  27. data/examples/v201406/account_management/create_account.rb +0 -92
  28. data/examples/v201406/account_management/get_account_alerts.rb +0 -122
  29. data/examples/v201406/account_management/get_account_changes.rb +0 -145
  30. data/examples/v201406/account_management/get_account_hierarchy.rb +0 -103
  31. data/examples/v201406/advanced_operations/add_ad_customizer.rb +0 -277
  32. data/examples/v201406/advanced_operations/add_ad_group_bid_modifier.rb +0 -105
  33. data/examples/v201406/advanced_operations/add_click_to_download_ad.rb +0 -137
  34. data/examples/v201406/advanced_operations/add_google_my_business_location_extensions.rb +0 -167
  35. data/examples/v201406/advanced_operations/add_site_links.rb +0 -306
  36. data/examples/v201406/advanced_operations/add_text_ad_with_upgraded_urls.rb +0 -137
  37. data/examples/v201406/advanced_operations/get_ad_group_bid_modifiers.rb +0 -106
  38. data/examples/v201406/advanced_operations/upload_offline_conversions.rb +0 -117
  39. data/examples/v201406/advanced_operations/use_shared_bidding_strategy.rb +0 -164
  40. data/examples/v201406/basic_operations/add_ad_groups.rb +0 -144
  41. data/examples/v201406/basic_operations/add_campaigns.rb +0 -153
  42. data/examples/v201406/basic_operations/add_keywords.rb +0 -116
  43. data/examples/v201406/basic_operations/add_text_ads.rb +0 -113
  44. data/examples/v201406/basic_operations/get_ad_groups.rb +0 -106
  45. data/examples/v201406/basic_operations/get_campaigns.rb +0 -101
  46. data/examples/v201406/basic_operations/get_campaigns_with_awql.rb +0 -93
  47. data/examples/v201406/basic_operations/get_keywords.rb +0 -112
  48. data/examples/v201406/basic_operations/get_text_ads.rb +0 -114
  49. data/examples/v201406/basic_operations/pause_ad.rb +0 -92
  50. data/examples/v201406/basic_operations/remove_ad.rb +0 -93
  51. data/examples/v201406/basic_operations/remove_ad_group.rb +0 -89
  52. data/examples/v201406/basic_operations/remove_campaign.rb +0 -91
  53. data/examples/v201406/basic_operations/remove_keyword.rb +0 -98
  54. data/examples/v201406/basic_operations/update_ad_group.rb +0 -89
  55. data/examples/v201406/basic_operations/update_campaign.rb +0 -90
  56. data/examples/v201406/basic_operations/update_keyword.rb +0 -110
  57. data/examples/v201406/campaign_management/add_campaign_labels.rb +0 -86
  58. data/examples/v201406/campaign_management/add_experiment.rb +0 -166
  59. data/examples/v201406/campaign_management/add_keywords_in_bulk.rb +0 -158
  60. data/examples/v201406/campaign_management/add_location_extension.rb +0 -125
  61. data/examples/v201406/campaign_management/get_all_disapproved_ads.rb +0 -101
  62. data/examples/v201406/campaign_management/get_all_disapproved_ads_with_awql.rb +0 -93
  63. data/examples/v201406/campaign_management/get_campaigns_by_label.rb +0 -112
  64. data/examples/v201406/campaign_management/promote_experiment.rb +0 -85
  65. data/examples/v201406/campaign_management/set_ad_parameters.rb +0 -122
  66. data/examples/v201406/campaign_management/set_criterion_bid_modifier.rb +0 -108
  67. data/examples/v201406/campaign_management/validate_text_ad.rb +0 -114
  68. data/examples/v201406/error_handling/handle_captcha_challenge.rb +0 -93
  69. data/examples/v201406/error_handling/handle_partial_failures.rb +0 -134
  70. data/examples/v201406/error_handling/handle_policy_violation_error.rb +0 -145
  71. data/examples/v201406/error_handling/handle_two_factor_authorization_error.rb +0 -88
  72. data/examples/v201406/misc/create_ad_words_session_without_properties_file.rb +0 -94
  73. data/examples/v201406/misc/get_all_images_and_videos.rb +0 -108
  74. data/examples/v201406/misc/setup_oauth2.rb +0 -88
  75. data/examples/v201406/misc/upload_image.rb +0 -97
  76. data/examples/v201406/misc/use_oauth2_jwt.rb +0 -97
  77. data/examples/v201406/optimization/estimate_keyword_traffic.rb +0 -155
  78. data/examples/v201406/optimization/get_keyword_bid_simulations.rb +0 -100
  79. data/examples/v201406/optimization/get_keyword_ideas.rb +0 -130
  80. data/examples/v201406/optimization/get_placement_ideas.rb +0 -112
  81. data/examples/v201406/remarketing/add_audience.rb +0 -123
  82. data/examples/v201406/remarketing/add_conversion_tracker.rb +0 -105
  83. data/examples/v201406/reporting/download_criteria_report.rb +0 -87
  84. data/examples/v201406/reporting/download_criteria_report_with_awql.rb +0 -86
  85. data/examples/v201406/reporting/get_report_fields.rb +0 -79
  86. data/examples/v201406/reporting/parallel_report_download.rb +0 -171
  87. data/examples/v201406/shopping_campaigns/add_product_partition_tree.rb +0 -269
  88. data/examples/v201406/shopping_campaigns/add_product_scope.rb +0 -133
  89. data/examples/v201406/shopping_campaigns/add_shopping_campaign.rb +0 -135
  90. data/examples/v201406/shopping_campaigns/get_product_category_taxonomy.rb +0 -117
  91. data/examples/v201406/shopping_campaigns/set_product_sales_channel.rb +0 -98
  92. data/examples/v201406/targeting/add_campaign_targeting_criteria.rb +0 -173
  93. data/examples/v201406/targeting/add_demographic_targeting_criteria.rb +0 -116
  94. data/examples/v201406/targeting/get_campaign_targeting_criteria.rb +0 -110
  95. data/examples/v201406/targeting/get_targetable_languages_and_carriers.rb +0 -94
  96. data/examples/v201406/targeting/lookup_location.rb +0 -112
  97. data/examples/v201502/campaign_management/add_location_extension.rb +0 -125
  98. data/lib/adwords_api/v201406/ad_group_ad_service.rb +0 -46
  99. data/lib/adwords_api/v201406/ad_group_ad_service_registry.rb +0 -46
  100. data/lib/adwords_api/v201406/ad_group_bid_modifier_service.rb +0 -42
  101. data/lib/adwords_api/v201406/ad_group_bid_modifier_service_registry.rb +0 -46
  102. data/lib/adwords_api/v201406/ad_group_criterion_service.rb +0 -46
  103. data/lib/adwords_api/v201406/ad_group_criterion_service_registry.rb +0 -46
  104. data/lib/adwords_api/v201406/ad_group_feed_service.rb +0 -42
  105. data/lib/adwords_api/v201406/ad_group_feed_service_registry.rb +0 -46
  106. data/lib/adwords_api/v201406/ad_group_service.rb +0 -46
  107. data/lib/adwords_api/v201406/ad_group_service_registry.rb +0 -46
  108. data/lib/adwords_api/v201406/ad_param_service.rb +0 -38
  109. data/lib/adwords_api/v201406/ad_param_service_registry.rb +0 -46
  110. data/lib/adwords_api/v201406/adwords_user_list_service.rb +0 -38
  111. data/lib/adwords_api/v201406/adwords_user_list_service_registry.rb +0 -46
  112. data/lib/adwords_api/v201406/alert_service.rb +0 -34
  113. data/lib/adwords_api/v201406/alert_service_registry.rb +0 -46
  114. data/lib/adwords_api/v201406/bidding_strategy_service.rb +0 -42
  115. data/lib/adwords_api/v201406/bidding_strategy_service_registry.rb +0 -46
  116. data/lib/adwords_api/v201406/budget_order_service.rb +0 -42
  117. data/lib/adwords_api/v201406/budget_order_service_registry.rb +0 -46
  118. data/lib/adwords_api/v201406/budget_service.rb +0 -42
  119. data/lib/adwords_api/v201406/budget_service_registry.rb +0 -46
  120. data/lib/adwords_api/v201406/campaign_ad_extension_service.rb +0 -38
  121. data/lib/adwords_api/v201406/campaign_ad_extension_service_registry.rb +0 -46
  122. data/lib/adwords_api/v201406/campaign_criterion_service.rb +0 -42
  123. data/lib/adwords_api/v201406/campaign_criterion_service_registry.rb +0 -46
  124. data/lib/adwords_api/v201406/campaign_feed_service.rb +0 -42
  125. data/lib/adwords_api/v201406/campaign_feed_service_registry.rb +0 -46
  126. data/lib/adwords_api/v201406/campaign_service.rb +0 -46
  127. data/lib/adwords_api/v201406/campaign_service_registry.rb +0 -46
  128. data/lib/adwords_api/v201406/campaign_shared_set_service.rb +0 -38
  129. data/lib/adwords_api/v201406/campaign_shared_set_service_registry.rb +0 -47
  130. data/lib/adwords_api/v201406/constant_data_service.rb +0 -66
  131. data/lib/adwords_api/v201406/constant_data_service_registry.rb +0 -46
  132. data/lib/adwords_api/v201406/conversion_tracker_service.rb +0 -38
  133. data/lib/adwords_api/v201406/conversion_tracker_service_registry.rb +0 -46
  134. data/lib/adwords_api/v201406/customer_feed_service.rb +0 -42
  135. data/lib/adwords_api/v201406/customer_feed_service_registry.rb +0 -46
  136. data/lib/adwords_api/v201406/customer_service.rb +0 -38
  137. data/lib/adwords_api/v201406/customer_service_registry.rb +0 -46
  138. data/lib/adwords_api/v201406/customer_sync_service.rb +0 -34
  139. data/lib/adwords_api/v201406/customer_sync_service_registry.rb +0 -47
  140. data/lib/adwords_api/v201406/data_service.rb +0 -54
  141. data/lib/adwords_api/v201406/data_service_registry.rb +0 -46
  142. data/lib/adwords_api/v201406/experiment_service.rb +0 -38
  143. data/lib/adwords_api/v201406/experiment_service_registry.rb +0 -46
  144. data/lib/adwords_api/v201406/feed_item_service.rb +0 -42
  145. data/lib/adwords_api/v201406/feed_item_service_registry.rb +0 -46
  146. data/lib/adwords_api/v201406/feed_mapping_service.rb +0 -42
  147. data/lib/adwords_api/v201406/feed_mapping_service_registry.rb +0 -46
  148. data/lib/adwords_api/v201406/feed_service.rb +0 -42
  149. data/lib/adwords_api/v201406/feed_service_registry.rb +0 -46
  150. data/lib/adwords_api/v201406/geo_location_service.rb +0 -34
  151. data/lib/adwords_api/v201406/geo_location_service_registry.rb +0 -46
  152. data/lib/adwords_api/v201406/label_service.rb +0 -42
  153. data/lib/adwords_api/v201406/label_service_registry.rb +0 -46
  154. data/lib/adwords_api/v201406/location_criterion_service.rb +0 -38
  155. data/lib/adwords_api/v201406/location_criterion_service_registry.rb +0 -46
  156. data/lib/adwords_api/v201406/managed_customer_service.rb +0 -50
  157. data/lib/adwords_api/v201406/managed_customer_service_registry.rb +0 -46
  158. data/lib/adwords_api/v201406/media_service.rb +0 -42
  159. data/lib/adwords_api/v201406/media_service_registry.rb +0 -46
  160. data/lib/adwords_api/v201406/mutate_job_service.rb +0 -42
  161. data/lib/adwords_api/v201406/mutate_job_service_registry.rb +0 -46
  162. data/lib/adwords_api/v201406/offline_conversion_feed_service.rb +0 -34
  163. data/lib/adwords_api/v201406/offline_conversion_feed_service_registry.rb +0 -46
  164. data/lib/adwords_api/v201406/report_definition_service.rb +0 -34
  165. data/lib/adwords_api/v201406/report_definition_service_registry.rb +0 -46
  166. data/lib/adwords_api/v201406/shared_criterion_service.rb +0 -38
  167. data/lib/adwords_api/v201406/shared_criterion_service_registry.rb +0 -47
  168. data/lib/adwords_api/v201406/shared_set_service.rb +0 -38
  169. data/lib/adwords_api/v201406/shared_set_service_registry.rb +0 -47
  170. data/lib/adwords_api/v201406/targeting_idea_service.rb +0 -38
  171. data/lib/adwords_api/v201406/targeting_idea_service_registry.rb +0 -46
  172. data/lib/adwords_api/v201406/traffic_estimator_service.rb +0 -34
  173. data/lib/adwords_api/v201406/traffic_estimator_service_registry.rb +0 -46
  174. data/test/templates/v201406/basic_operations_get_campaigns.def +0 -114
  175. data/test/templates/v201406/misc_use_oauth2_jwt.def +0 -131
@@ -1,94 +0,0 @@
1
- #!/usr/bin/env ruby
2
- # Encoding: utf-8
3
- #
4
- # Author:: api.mcloonan@gmail.com (Michael Cloonan)
5
- #
6
- # Copyright:: Copyright 2014, Google Inc. All Rights Reserved.
7
- #
8
- # License:: Licensed under the Apache License, Version 2.0 (the "License");
9
- # you may not use this file except in compliance with the License.
10
- # You may obtain a copy of the License at
11
- #
12
- # http://www.apache.org/licenses/LICENSE-2.0
13
- #
14
- # Unless required by applicable law or agreed to in writing, software
15
- # distributed under the License is distributed on an "AS IS" BASIS,
16
- # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
17
- # implied.
18
- # See the License for the specific language governing permissions and
19
- # limitations under the License.
20
- #
21
- # This example demonstrates how to make AdWords queries without using the
22
- # adwords_api.yml file.
23
-
24
- require 'adwords_api'
25
- require 'date'
26
-
27
- def create_ad_words_session(client_id, client_secret, refresh_token,
28
- developer_token, client_customer_id, user_agent)
29
- # AdwordsApi::Api will read a config file from ENV['HOME']/adwords_api.yml
30
- # when called without parameters.
31
- adwords = AdwordsApi::Api.new({
32
- :authentication => {
33
- :method => 'OAuth2',
34
- :oauth2_client_id => client_id,
35
- :oauth2_client_secret => client_secret,
36
- :developer_token => developer_token,
37
- :client_customer_id => client_customer_id
38
- :user_agent => user_agent,
39
- :oauth2_token => {
40
- :refresh_token => refresh_token
41
- }
42
- },
43
- :service => {
44
- :environment => 'PRODUCTION'
45
- }
46
- })
47
-
48
- # To enable logging of SOAP requests, set the log_level value to 'DEBUG' in
49
- # the hash above or provide your own logger:
50
- # adwords.logger = Logger.new('adwords_xml.log')
51
-
52
- customer_srv = adwords.service(:CustomerService, API_VERSION)
53
- customer = customer_srv.get()
54
- puts "You are logged in as customer: %d" % customer[:id]
55
- end
56
-
57
- if __FILE__ == $0
58
- API_VERSION = :v201406
59
-
60
- begin
61
- client_id = 'INSERT_CLIENT_ID_HERE'
62
- client_secret = 'INSERT_CLIENT_SECRET_HERE'
63
- refresh_token = 'INSERT_REFRESH_TOKEN_HERE'
64
- developer_token = 'INSERT_DEVELOPER_TOKEN_HERE'
65
- client_customer_id = 'INSERT_CLIENT_CUSTOMER_ID_HERE'
66
- user_agent = 'INSERT_USER_AGENT_HERE'
67
-
68
- create_ad_words_session(client_id, client_secret, refresh_token,
69
- developer_token, client_customer_id, user_agent)
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
- 'http://code.google.com/p/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,108 +0,0 @@
1
- #!/usr/bin/env ruby
2
- # Encoding: utf-8
3
- #
4
- # Author:: api.dklimkin@gmail.com (Danial Klimkin)
5
- #
6
- # Copyright:: Copyright 2011, Google Inc. All Rights Reserved.
7
- #
8
- # License:: Licensed under the Apache License, Version 2.0 (the "License");
9
- # you may not use this file except in compliance with the License.
10
- # You may obtain a copy of the License at
11
- #
12
- # http://www.apache.org/licenses/LICENSE-2.0
13
- #
14
- # Unless required by applicable law or agreed to in writing, software
15
- # distributed under the License is distributed on an "AS IS" BASIS,
16
- # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
17
- # implied.
18
- # See the License for the specific language governing permissions and
19
- # limitations under the License.
20
- #
21
- # This example illustrates how to retrieve all images and videos. To upload an
22
- # image, run upload_image.rb. To upload video, see:
23
- # http://adwords.google.com/support/aw/bin/answer.py?hl=en&answer=39454.
24
- #
25
- # Tags: MediaService.get
26
-
27
- require 'adwords_api'
28
-
29
- def get_all_images_and_videos()
30
- # AdwordsApi::Api will read a config file from ENV['HOME']/adwords_api.yml
31
- # when called without parameters.
32
- adwords = AdwordsApi::Api.new
33
-
34
- # To enable logging of SOAP requests, set the log_level value to 'DEBUG' in
35
- # the configuration file or provide your own logger:
36
- # adwords.logger = Logger.new('adwords_xml.log')
37
-
38
- media_srv = adwords.service(:MediaService, API_VERSION)
39
-
40
- # Get all the images and videos.
41
- selector = {
42
- :fields => ['MediaId', 'Height', 'Width', 'MimeType', 'Urls'],
43
- :ordering => [
44
- {:field => 'MediaId', :sort_order => 'ASCENDING'}
45
- ],
46
- :predicates => [
47
- {:field => 'Type', :operator => 'IN', :values => ['IMAGE', 'VIDEO']}
48
- ],
49
- :paging => {
50
- :start_index => 0,
51
- :number_results => PAGE_SIZE
52
- }
53
- }
54
-
55
- # Set initial values.
56
- offset, page = 0, {}
57
-
58
- begin
59
- page = media_srv.get(selector)
60
- if page[:entries]
61
- page[:entries].each do |entry|
62
- full_dimensions = entry[:dimensions]['FULL']
63
- puts "Entry ID %d with dimensions %dx%d and MIME type is '%s'" %
64
- [entry[:media_id], full_dimensions[:height],
65
- full_dimensions[:width], entry[:mime_type]]
66
- end
67
- # Increment values to request the next page.
68
- offset += PAGE_SIZE
69
- selector[:paging][:start_index] = offset
70
- end
71
- end while page[:total_num_entries] > offset
72
-
73
- if page.include?(:total_num_entries)
74
- puts "\tFound %d entries." % page[:total_num_entries]
75
- end
76
- end
77
-
78
- if __FILE__ == $0
79
- API_VERSION = :v201406
80
- PAGE_SIZE = 500
81
-
82
- begin
83
- get_all_images_and_videos()
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
- 'http://code.google.com/p/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
@@ -1,88 +0,0 @@
1
- #!/usr/bin/env ruby
2
- # Encoding: utf-8
3
- #
4
- # Author:: api.dklimkin@gmail.com (Danial Klimkin)
5
- #
6
- # Copyright:: Copyright 2013, Google Inc. All Rights Reserved.
7
- #
8
- # License:: Licensed under the Apache License, Version 2.0 (the "License");
9
- # you may not use this file except in compliance with the License.
10
- # You may obtain a copy of the License at
11
- #
12
- # http://www.apache.org/licenses/LICENSE-2.0
13
- #
14
- # Unless required by applicable law or agreed to in writing, software
15
- # distributed under the License is distributed on an "AS IS" BASIS,
16
- # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
17
- # implied.
18
- # See the License for the specific language governing permissions and
19
- # limitations under the License.
20
- #
21
- # This example illustrates how to set up OAuth2.0 authentication credentials.
22
- #
23
- # Tags: CampaignService.get
24
-
25
- require 'adwords_api'
26
-
27
- def setup_oauth2()
28
- # AdwordsApi::Api will read a config file from ENV['HOME']/adwords_api.yml
29
- # when called without parameters.
30
- adwords = AdwordsApi::Api.new
31
-
32
- # To enable logging of SOAP requests, set the log_level value to 'DEBUG' in
33
- # the configuration file or provide your own logger:
34
- # adwords.logger = Logger.new('adwords_xml.log')
35
-
36
- # You can call authorize explicitly to obtain the access token. Otherwise, it
37
- # will be invoked automatically on the first API call.
38
- # There are two ways to provide verification code, first one is via the block:
39
- token = adwords.authorize() do |auth_url|
40
- puts "Hit Auth error, please navigate to URL:\n\t%s" % auth_url
41
- print 'log in and type the verification code: '
42
- verification_code = gets.chomp
43
- verification_code
44
- end
45
- if token
46
- print "\nWould you like to update your adwords_api.yml to save " +
47
- "OAuth2 credentials? (y/N): "
48
- response = gets.chomp
49
- if ('y'.casecmp(response) == 0) or ('yes'.casecmp(response) == 0)
50
- adwords.save_oauth2_token(token)
51
- puts 'OAuth2 token is now saved to ~/adwords_api.yml and will be ' +
52
- 'automatically used by the library.'
53
- end
54
- end
55
-
56
- # Alternatively, you can provide one within the parameters:
57
- # token = adwords.authorize({:oauth2_verification_code => verification_code})
58
-
59
- # Note, 'token' is a Hash. Its value is not used in this example. If you need
60
- # to be able to access the API in offline mode, with no user present, you
61
- # should persist it to be used in subsequent invocations like this:
62
- # adwords.authorize({:oauth2_token => token})
63
-
64
- # No exception thrown - we are good to make a request.
65
- end
66
-
67
- if __FILE__ == $0
68
- API_VERSION = :v201406
69
-
70
- begin
71
- setup_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,97 +0,0 @@
1
- #!/usr/bin/env ruby
2
- # Encoding: utf-8
3
- #
4
- # Author:: api.dklimkin@gmail.com (Danial Klimkin)
5
- #
6
- # Copyright:: Copyright 2011, Google Inc. All Rights Reserved.
7
- #
8
- # License:: Licensed under the Apache License, Version 2.0 (the "License");
9
- # you may not use this file except in compliance with the License.
10
- # You may obtain a copy of the License at
11
- #
12
- # http://www.apache.org/licenses/LICENSE-2.0
13
- #
14
- # Unless required by applicable law or agreed to in writing, software
15
- # distributed under the License is distributed on an "AS IS" BASIS,
16
- # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
17
- # implied.
18
- # See the License for the specific language governing permissions and
19
- # limitations under the License.
20
- #
21
- # This example uploads an image. To get images, run get_all_images.rb.
22
- #
23
- # Tags: MediaService.upload
24
-
25
- require 'adwords_api'
26
- require 'base64'
27
-
28
- def upload_image()
29
- # AdwordsApi::Api will read a config file from ENV['HOME']/adwords_api.yml
30
- # when called without parameters.
31
- adwords = AdwordsApi::Api.new
32
-
33
- # To enable logging of SOAP requests, set the log_level value to 'DEBUG' in
34
- # the configuration file or provide your own logger:
35
- # adwords.logger = Logger.new('adwords_xml.log')
36
-
37
- media_srv = adwords.service(:MediaService, API_VERSION)
38
-
39
- # Create image.
40
- image_url =
41
- 'http://www.google.com/intl/en/adwords/select/images/samples/inline.jpg'
42
- # This utility method retrieves the contents of a URL using all of the config
43
- # options provided to the Api object.
44
- image_data = AdsCommon::Http.get(image_url, adwords.config)
45
- base64_image_data = Base64.encode64(image_data)
46
- image = {
47
- # The 'xsi_type' field allows you to specify the xsi:type of the object
48
- # being created. It's only necessary when you must provide an explicit
49
- # type that the client library can't infer.
50
- :xsi_type => 'Image',
51
- :data => base64_image_data,
52
- :type => 'IMAGE'
53
- }
54
-
55
- # Upload image.
56
- response = media_srv.upload([image])
57
- if response and !response.empty?
58
- ret_image = response.first
59
- full_dimensions = ret_image[:dimensions]['FULL']
60
- puts ("Image with ID %d, dimensions %dx%d and MIME type '%s' uploaded " +
61
- "successfully.") % [ret_image[:media_id], full_dimensions[:height],
62
- full_dimensions[:width], ret_image[:mime_type]]
63
- else
64
- puts 'No images uploaded.'
65
- end
66
- end
67
-
68
- if __FILE__ == $0
69
- API_VERSION = :v201406
70
-
71
- begin
72
- upload_image()
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
- 'http://code.google.com/p/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
@@ -1,97 +0,0 @@
1
- #!/usr/bin/env ruby
2
- # Encoding: utf-8
3
- #
4
- # Author:: api.dklimkin@gmail.com (Danial Klimkin)
5
- #
6
- # Copyright:: Copyright 2012, Google Inc. All Rights Reserved.
7
- #
8
- # License:: Licensed under the Apache License, Version 2.0 (the "License");
9
- # you may not use this file except in compliance with the License.
10
- # You may obtain a copy of the License at
11
- #
12
- # http://www.apache.org/licenses/LICENSE-2.0
13
- #
14
- # Unless required by applicable law or agreed to in writing, software
15
- # distributed under the License is distributed on an "AS IS" BASIS,
16
- # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
17
- # implied.
18
- # See the License for the specific language governing permissions and
19
- # limitations under the License.
20
- #
21
- # This example illustrates how to use OAuth2.0 authentication method with
22
- # Service Account (JWT). For this example to work, your Service Account must be
23
- # a Google Apps for Business Account.
24
- #
25
- # See https://developers.google.com/adwords/api/docs/guides/service-accounts
26
- # for more information.
27
- #
28
- # Tags: CampaignService.get
29
-
30
- require 'adwords_api'
31
-
32
- def use_oauth2_jwt()
33
- # AdwordsApi::Api will read a config file from ENV['HOME']/adwords_api.yml
34
- # when called without parameters.
35
- adwords = AdwordsApi::Api.new
36
-
37
- # To enable logging of SOAP requests, set the log_level value to 'DEBUG' in
38
- # the configuration file or provide your own logger:
39
- # adwords.logger = Logger.new('adwords_xml.log')
40
-
41
- # Option 1: provide key filename as authentication -> oauth2_keyfile in the
42
- # configuration file. No additional code is necessary.
43
- # To provide a file name at runtime, use authorize:
44
- # adwords.authorize({:oauth2_keyfile => key_filename})
45
-
46
- # Option 2: retrieve key manually and create OpenSSL::PKCS12 object.
47
- # key_filename = 'INSERT_FILENAME_HERE'
48
- # key_secret = 'INSERT_SECRET_HERE'
49
- # key_file_data = File.read(key_filename)
50
- # key = OpenSSL::PKCS12.new(key_file_data, key_secret).key
51
- # adwords.authorize({:oauth2_key => key})
52
-
53
- # Now you can make API calls.
54
- campaign_srv = adwords.service(:CampaignService, API_VERSION)
55
-
56
- # Get all the campaigns for this account; empty selector.
57
- selector = {
58
- :fields => ['Id', 'Name', 'Status'],
59
- :ordering => [
60
- {:field => 'Name', :sort_order => 'ASCENDING'}
61
- ]
62
- }
63
-
64
- response = campaign_srv.get(selector)
65
- if response and response[:entries]
66
- campaigns = response[:entries]
67
- campaigns.each do |campaign|
68
- puts "Campaign ID %d, name '%s' and status '%s'" %
69
- [campaign[:id], campaign[:name], campaign[:status]]
70
- end
71
- else
72
- puts 'No campaigns were found.'
73
- end
74
- end
75
-
76
- if __FILE__ == $0
77
- API_VERSION = :v201406
78
-
79
- begin
80
- use_oauth2_jwt()
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