google-adwords-api 0.12.0 → 0.12.1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (161) hide show
  1. checksums.yaml +15 -0
  2. data/ChangeLog +5 -0
  3. data/README.md +53 -30
  4. data/examples/v201406/account_management/create_account.rb +92 -0
  5. data/examples/v201406/account_management/get_account_alerts.rb +122 -0
  6. data/examples/v201406/account_management/get_account_changes.rb +145 -0
  7. data/examples/v201406/account_management/get_account_hierarchy.rb +103 -0
  8. data/examples/v201406/advanced_operations/add_ad_group_bid_modifier.rb +105 -0
  9. data/examples/v201406/advanced_operations/add_click_to_download_ad.rb +137 -0
  10. data/examples/v201406/advanced_operations/add_places_location_extensions.rb +159 -0
  11. data/examples/v201406/advanced_operations/add_site_links.rb +306 -0
  12. data/examples/v201406/advanced_operations/add_text_ad_with_upgraded_urls.rb +137 -0
  13. data/examples/v201406/advanced_operations/get_ad_group_bid_modifiers.rb +106 -0
  14. data/examples/v201406/advanced_operations/update_site_links.rb +194 -0
  15. data/examples/v201406/advanced_operations/upload_offline_conversions.rb +117 -0
  16. data/examples/v201406/advanced_operations/use_shared_bidding_strategy.rb +164 -0
  17. data/examples/v201406/basic_operations/add_ad_groups.rb +142 -0
  18. data/examples/v201406/basic_operations/add_campaigns.rb +153 -0
  19. data/examples/v201406/basic_operations/add_keywords.rb +116 -0
  20. data/examples/v201406/basic_operations/add_text_ads.rb +113 -0
  21. data/examples/v201406/basic_operations/get_ad_groups.rb +106 -0
  22. data/examples/v201406/basic_operations/get_campaigns.rb +101 -0
  23. data/examples/v201406/basic_operations/get_campaigns_with_awql.rb +93 -0
  24. data/examples/v201406/basic_operations/get_keywords.rb +112 -0
  25. data/examples/v201406/basic_operations/get_text_ads.rb +114 -0
  26. data/examples/v201406/basic_operations/pause_ad.rb +92 -0
  27. data/examples/v201406/basic_operations/remove_ad.rb +93 -0
  28. data/examples/v201406/basic_operations/remove_ad_group.rb +110 -0
  29. data/examples/v201406/basic_operations/remove_campaign.rb +111 -0
  30. data/examples/v201406/basic_operations/remove_keyword.rb +98 -0
  31. data/examples/v201406/basic_operations/update_ad_group.rb +89 -0
  32. data/examples/v201406/basic_operations/update_campaign.rb +90 -0
  33. data/examples/v201406/basic_operations/update_keyword.rb +110 -0
  34. data/examples/v201406/campaign_management/add_campaign_labels.rb +86 -0
  35. data/examples/v201406/campaign_management/add_experiment.rb +166 -0
  36. data/examples/v201406/campaign_management/add_keywords_in_bulk.rb +158 -0
  37. data/examples/v201406/campaign_management/add_location_extension.rb +125 -0
  38. data/examples/v201406/campaign_management/get_all_disapproved_ads.rb +101 -0
  39. data/examples/v201406/campaign_management/get_all_disapproved_ads_with_awql.rb +93 -0
  40. data/examples/v201406/campaign_management/get_campaigns_by_label.rb +112 -0
  41. data/examples/v201406/campaign_management/promote_experiment.rb +85 -0
  42. data/examples/v201406/campaign_management/set_ad_parameters.rb +122 -0
  43. data/examples/v201406/campaign_management/set_criterion_bid_modifier.rb +108 -0
  44. data/examples/v201406/campaign_management/validate_text_ad.rb +114 -0
  45. data/examples/v201406/error_handling/handle_captcha_challenge.rb +93 -0
  46. data/examples/v201406/error_handling/handle_partial_failures.rb +134 -0
  47. data/examples/v201406/error_handling/handle_policy_violation_error.rb +145 -0
  48. data/examples/v201406/error_handling/handle_two_factor_authorization_error.rb +88 -0
  49. data/examples/v201406/misc/create_ad_words_session_without_properties_file.rb +94 -0
  50. data/examples/v201406/misc/get_all_images_and_videos.rb +108 -0
  51. data/examples/v201406/misc/setup_oauth2.rb +88 -0
  52. data/examples/v201406/misc/upload_image.rb +97 -0
  53. data/examples/v201406/misc/use_oauth2_jwt.rb +97 -0
  54. data/examples/v201406/optimization/estimate_keyword_traffic.rb +137 -0
  55. data/examples/v201406/optimization/get_keyword_bid_simulations.rb +100 -0
  56. data/examples/v201406/optimization/get_keyword_ideas.rb +130 -0
  57. data/examples/v201406/optimization/get_placement_ideas.rb +112 -0
  58. data/examples/v201406/remarketing/add_audience.rb +123 -0
  59. data/examples/v201406/remarketing/add_conversion_tracker.rb +105 -0
  60. data/examples/v201406/reporting/download_criteria_report.rb +87 -0
  61. data/examples/v201406/reporting/download_criteria_report_with_awql.rb +86 -0
  62. data/examples/v201406/reporting/get_report_fields.rb +79 -0
  63. data/examples/v201406/reporting/parallel_report_download.rb +171 -0
  64. data/examples/v201406/shopping_campaigns/add_product_partition_tree.rb +269 -0
  65. data/examples/v201406/shopping_campaigns/add_product_scope.rb +133 -0
  66. data/examples/v201406/shopping_campaigns/add_shopping_campaign.rb +135 -0
  67. data/examples/v201406/shopping_campaigns/get_product_category_taxonomy.rb +117 -0
  68. data/examples/v201406/shopping_campaigns/set_product_sales_channel.rb +98 -0
  69. data/examples/v201406/targeting/add_campaign_targeting_criteria.rb +173 -0
  70. data/examples/v201406/targeting/add_demographic_targeting_criteria.rb +116 -0
  71. data/examples/v201406/targeting/get_campaign_targeting_criteria.rb +110 -0
  72. data/examples/v201406/targeting/get_targetable_languages_and_carriers.rb +94 -0
  73. data/examples/v201406/targeting/lookup_location.rb +112 -0
  74. data/lib/adwords_api/api_config.rb +91 -5
  75. data/lib/adwords_api/v201402/campaign_shared_set_service.rb +38 -0
  76. data/lib/adwords_api/v201402/campaign_shared_set_service_registry.rb +47 -0
  77. data/lib/adwords_api/v201402/shared_criterion_service.rb +38 -0
  78. data/lib/adwords_api/v201402/shared_criterion_service_registry.rb +47 -0
  79. data/lib/adwords_api/v201402/shared_set_service.rb +38 -0
  80. data/lib/adwords_api/v201402/shared_set_service_registry.rb +47 -0
  81. data/lib/adwords_api/v201406/ad_group_ad_service.rb +46 -0
  82. data/lib/adwords_api/v201406/ad_group_ad_service_registry.rb +46 -0
  83. data/lib/adwords_api/v201406/ad_group_bid_modifier_service.rb +42 -0
  84. data/lib/adwords_api/v201406/ad_group_bid_modifier_service_registry.rb +46 -0
  85. data/lib/adwords_api/v201406/ad_group_criterion_service.rb +46 -0
  86. data/lib/adwords_api/v201406/ad_group_criterion_service_registry.rb +46 -0
  87. data/lib/adwords_api/v201406/ad_group_feed_service.rb +42 -0
  88. data/lib/adwords_api/v201406/ad_group_feed_service_registry.rb +46 -0
  89. data/lib/adwords_api/v201406/ad_group_service.rb +46 -0
  90. data/lib/adwords_api/v201406/ad_group_service_registry.rb +46 -0
  91. data/lib/adwords_api/v201406/ad_param_service.rb +38 -0
  92. data/lib/adwords_api/v201406/ad_param_service_registry.rb +46 -0
  93. data/lib/adwords_api/v201406/adwords_user_list_service.rb +38 -0
  94. data/lib/adwords_api/v201406/adwords_user_list_service_registry.rb +46 -0
  95. data/lib/adwords_api/v201406/alert_service.rb +34 -0
  96. data/lib/adwords_api/v201406/alert_service_registry.rb +46 -0
  97. data/lib/adwords_api/v201406/bidding_strategy_service.rb +42 -0
  98. data/lib/adwords_api/v201406/bidding_strategy_service_registry.rb +46 -0
  99. data/lib/adwords_api/v201406/budget_order_service.rb +42 -0
  100. data/lib/adwords_api/v201406/budget_order_service_registry.rb +46 -0
  101. data/lib/adwords_api/v201406/budget_service.rb +42 -0
  102. data/lib/adwords_api/v201406/budget_service_registry.rb +46 -0
  103. data/lib/adwords_api/v201406/campaign_ad_extension_service.rb +38 -0
  104. data/lib/adwords_api/v201406/campaign_ad_extension_service_registry.rb +46 -0
  105. data/lib/adwords_api/v201406/campaign_criterion_service.rb +42 -0
  106. data/lib/adwords_api/v201406/campaign_criterion_service_registry.rb +46 -0
  107. data/lib/adwords_api/v201406/campaign_feed_service.rb +42 -0
  108. data/lib/adwords_api/v201406/campaign_feed_service_registry.rb +46 -0
  109. data/lib/adwords_api/v201406/campaign_service.rb +46 -0
  110. data/lib/adwords_api/v201406/campaign_service_registry.rb +46 -0
  111. data/lib/adwords_api/v201406/campaign_shared_set_service.rb +38 -0
  112. data/lib/adwords_api/v201406/campaign_shared_set_service_registry.rb +47 -0
  113. data/lib/adwords_api/v201406/constant_data_service.rb +66 -0
  114. data/lib/adwords_api/v201406/constant_data_service_registry.rb +46 -0
  115. data/lib/adwords_api/v201406/conversion_tracker_service.rb +38 -0
  116. data/lib/adwords_api/v201406/conversion_tracker_service_registry.rb +46 -0
  117. data/lib/adwords_api/v201406/customer_feed_service.rb +42 -0
  118. data/lib/adwords_api/v201406/customer_feed_service_registry.rb +46 -0
  119. data/lib/adwords_api/v201406/customer_service.rb +38 -0
  120. data/lib/adwords_api/v201406/customer_service_registry.rb +46 -0
  121. data/lib/adwords_api/v201406/customer_sync_service.rb +34 -0
  122. data/lib/adwords_api/v201406/customer_sync_service_registry.rb +47 -0
  123. data/lib/adwords_api/v201406/data_service.rb +54 -0
  124. data/lib/adwords_api/v201406/data_service_registry.rb +46 -0
  125. data/lib/adwords_api/v201406/experiment_service.rb +38 -0
  126. data/lib/adwords_api/v201406/experiment_service_registry.rb +46 -0
  127. data/lib/adwords_api/v201406/feed_item_service.rb +42 -0
  128. data/lib/adwords_api/v201406/feed_item_service_registry.rb +46 -0
  129. data/lib/adwords_api/v201406/feed_mapping_service.rb +42 -0
  130. data/lib/adwords_api/v201406/feed_mapping_service_registry.rb +46 -0
  131. data/lib/adwords_api/v201406/feed_service.rb +42 -0
  132. data/lib/adwords_api/v201406/feed_service_registry.rb +46 -0
  133. data/lib/adwords_api/v201406/geo_location_service.rb +34 -0
  134. data/lib/adwords_api/v201406/geo_location_service_registry.rb +46 -0
  135. data/lib/adwords_api/v201406/label_service.rb +42 -0
  136. data/lib/adwords_api/v201406/label_service_registry.rb +46 -0
  137. data/lib/adwords_api/v201406/location_criterion_service.rb +38 -0
  138. data/lib/adwords_api/v201406/location_criterion_service_registry.rb +46 -0
  139. data/lib/adwords_api/v201406/managed_customer_service.rb +50 -0
  140. data/lib/adwords_api/v201406/managed_customer_service_registry.rb +46 -0
  141. data/lib/adwords_api/v201406/media_service.rb +42 -0
  142. data/lib/adwords_api/v201406/media_service_registry.rb +46 -0
  143. data/lib/adwords_api/v201406/mutate_job_service.rb +42 -0
  144. data/lib/adwords_api/v201406/mutate_job_service_registry.rb +46 -0
  145. data/lib/adwords_api/v201406/offline_conversion_feed_service.rb +34 -0
  146. data/lib/adwords_api/v201406/offline_conversion_feed_service_registry.rb +46 -0
  147. data/lib/adwords_api/v201406/report_definition_service.rb +34 -0
  148. data/lib/adwords_api/v201406/report_definition_service_registry.rb +46 -0
  149. data/lib/adwords_api/v201406/shared_criterion_service.rb +38 -0
  150. data/lib/adwords_api/v201406/shared_criterion_service_registry.rb +47 -0
  151. data/lib/adwords_api/v201406/shared_set_service.rb +38 -0
  152. data/lib/adwords_api/v201406/shared_set_service_registry.rb +47 -0
  153. data/lib/adwords_api/v201406/targeting_idea_service.rb +38 -0
  154. data/lib/adwords_api/v201406/targeting_idea_service_registry.rb +46 -0
  155. data/lib/adwords_api/v201406/traffic_estimator_service.rb +34 -0
  156. data/lib/adwords_api/v201406/traffic_estimator_service_registry.rb +46 -0
  157. data/lib/adwords_api/version.rb +1 -1
  158. data/lib/adwords_api.rb +1 -1
  159. data/test/adwords_api/test_adwords_api.rb +7 -3
  160. metadata +423 -274
  161. data/test/bugs/test_issue_00000063.rb +0 -141
@@ -0,0 +1,108 @@
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
@@ -0,0 +1,88 @@
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
@@ -0,0 +1,97 @@
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
@@ -0,0 +1,97 @@
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
@@ -0,0 +1,137 @@
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 gets keyword traffic estimates.
22
+ #
23
+ # Tags: TrafficEstimatorService.get
24
+
25
+ require 'adwords_api'
26
+
27
+ def estimate_keyword_traffic()
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
+ traffic_estimator_srv = adwords.service(:TrafficEstimatorService, API_VERSION)
37
+
38
+ # Create keywords. Up to 2000 keywords can be passed in a single request.
39
+ keywords = [
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 => 'Keyword', :text => 'mars cruise', :match_type => 'BROAD'},
44
+ {:xsi_type => 'Keyword', :text => 'cheap cruise', :match_type => 'PHRASE'},
45
+ {:xsi_type => 'Keyword', :text => 'cruise', :match_type => 'EXACT'},
46
+ {:xsi_type => 'Keyword', :text => 'moon walk', :match_type => 'BROAD'}
47
+ ]
48
+
49
+ # Create a keyword estimate request for each keyword.
50
+ keyword_requests = keywords.map {|keyword| {:keyword => keyword}}
51
+
52
+ # Negative keywords don't return estimates, but adjust the estimates of the
53
+ # other keywords in the hypothetical ad group. To specify a negative keyword
54
+ # set the is_negative field to true.
55
+ keyword_requests[3][:is_negative] = true
56
+
57
+ # Create ad group estimate requests.
58
+ ad_group_request = {
59
+ :keyword_estimate_requests => keyword_requests,
60
+ :max_cpc => {
61
+ :micro_amount => 1000000
62
+ }
63
+ }
64
+
65
+ # Create campaign estimate requests.
66
+ campaign_request = {
67
+ :ad_group_estimate_requests => [ad_group_request],
68
+ # Set targeting criteria. Only locations and languages are supported.
69
+ :criteria => [
70
+ {:xsi_type => 'Location', :id => 2840}, # United States
71
+ {:xsi_type => 'Language', :id => 1000} # English
72
+ ]
73
+ }
74
+
75
+ # Create selector and retrieve reults.
76
+ selector = {:campaign_estimate_requests => [campaign_request]}
77
+ response = traffic_estimator_srv.get(selector)
78
+
79
+ if response and response[:campaign_estimates]
80
+ campaign_estimates = response[:campaign_estimates]
81
+ keyword_estimates =
82
+ campaign_estimates.first[:ad_group_estimates].first[:keyword_estimates]
83
+ keyword_estimates.each_with_index do |estimate, index|
84
+ keyword = keyword_requests[index][:keyword]
85
+
86
+ # Find the mean of the min and max values.
87
+ mean_avg_cpc = (estimate[:min][:average_cpc][:micro_amount] +
88
+ estimate[:max][:average_cpc][:micro_amount]) / 2
89
+ mean_avg_position = (estimate[:min][:average_position] +
90
+ estimate[:max][:average_position]) / 2
91
+ mean_clicks = (estimate[:min][:clicks_per_day] +
92
+ estimate[:max][:clicks_per_day]) / 2
93
+ mean_total_cost = (estimate[:min][:total_cost][:micro_amount] +
94
+ estimate[:max][:total_cost][:micro_amount]) / 2
95
+
96
+ puts "Results for the keyword with text '%s' and match type %s:" %
97
+ [keyword[:text], keyword[:match_type]]
98
+ puts "\tEstimated average CPC: %d" % mean_avg_cpc
99
+ puts "\tEstimated ad position: %.2f" % mean_avg_position
100
+ puts "\tEstimated daily clicks: %d" % mean_clicks
101
+ puts "\tEstimated daily cost: %d" % mean_total_cost
102
+ end
103
+ else
104
+ puts 'No traffic estimates were returned.'
105
+ end
106
+ end
107
+
108
+ if __FILE__ == $0
109
+ API_VERSION = :v201406
110
+
111
+ begin
112
+ estimate_keyword_traffic()
113
+
114
+ # Authorization error.
115
+ rescue AdsCommon::Errors::OAuth2VerificationRequired => e
116
+ puts "Authorization credentials are not valid. Edit adwords_api.yml for " +
117
+ "OAuth2 client ID and secret and run misc/setup_oauth2.rb example " +
118
+ "to retrieve and store OAuth2 tokens."
119
+ puts "See this wiki page for more details:\n\n " +
120
+ 'http://code.google.com/p/google-api-ads-ruby/wiki/OAuth2'
121
+
122
+ # HTTP errors.
123
+ rescue AdsCommon::Errors::HttpError => e
124
+ puts "HTTP Error: %s" % e
125
+
126
+ # API errors.
127
+ rescue AdwordsApi::Errors::ApiException => e
128
+ puts "Message: %s" % e.message
129
+ puts 'Errors:'
130
+ e.errors.each_with_index do |error, index|
131
+ puts "\tError [%d]:" % (index + 1)
132
+ error.each do |field, value|
133
+ puts "\t\t%s: %s" % [field, value]
134
+ end
135
+ end
136
+ end
137
+ end
@@ -0,0 +1,100 @@
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 gets bid landscapes for a keyword. To get keywords, run
22
+ # get_keywords.rb.
23
+ #
24
+ # Tags: DataService.getCriterionBidLandscape
25
+
26
+ require 'adwords_api'
27
+
28
+ def get_criterion_bid_landscapes(ad_group_id, keyword_id)
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
+ data_srv = adwords.service(:DataService, API_VERSION)
38
+
39
+ # Get keyword bid landscape.
40
+ selector = {
41
+ :fields => ['AdGroupId', 'CriterionId', 'StartDate', 'EndDate', 'Bid',
42
+ 'LocalClicks', 'LocalCost', 'MarginalCpc', 'LocalImpressions'],
43
+ :predicates => [
44
+ {:field => 'AdGroupId', :operator => 'IN', :values => [ad_group_id]},
45
+ {:field => 'CriterionId', :operator => 'IN', :values => [keyword_id]},
46
+ ]
47
+ }
48
+ page = data_srv.get_criterion_bid_landscape(selector)
49
+ if page and page[:entries]
50
+ puts "Bid landscape(s) retrieved: %d." % [page[:entries].length]
51
+ page[:entries].each do |bid_landscape|
52
+ puts ("Retrieved keyword bid landscape with ad group ID %d" +
53
+ ", keyword ID %d, start date '%s', end date '%s'" +
54
+ ", with landscape points:") %
55
+ [bid_landscape[:ad_group_id], bid_landscape[:criterion_id],
56
+ bid_landscape[:start_date], bid_landscape[:end_date]]
57
+ bid_landscape[:landscape_points].each do |point|
58
+ puts "\t%d => clicks: %d, cost: %d, marginalCpc: %d, impressions: %d" %
59
+ [point[:bid][:micro_amount], point.clicks,
60
+ point[:cost][:micro_amount], point[:marginal_cpc][:micro_amount],
61
+ point[:impressions]]
62
+ end
63
+ end
64
+ else
65
+ puts 'No bid landscapes retrieved.'
66
+ end
67
+ end
68
+
69
+ if __FILE__ == $0
70
+ API_VERSION = :v201406
71
+
72
+ begin
73
+ ad_group_id = 'INSERT_ADGROUP_ID_HERE'.to_i
74
+ keyword_id = 'INSERT_KEYWORD_ID_HERE'.to_i
75
+ get_criterion_bid_landscapes(ad_group_id, keyword_id)
76
+
77
+ # Authorization error.
78
+ rescue AdsCommon::Errors::OAuth2VerificationRequired => e
79
+ puts "Authorization credentials are not valid. Edit adwords_api.yml for " +
80
+ "OAuth2 client ID and secret and run misc/setup_oauth2.rb example " +
81
+ "to retrieve and store OAuth2 tokens."
82
+ puts "See this wiki page for more details:\n\n " +
83
+ 'http://code.google.com/p/google-api-ads-ruby/wiki/OAuth2'
84
+
85
+ # HTTP errors.
86
+ rescue AdsCommon::Errors::HttpError => e
87
+ puts "HTTP Error: %s" % e
88
+
89
+ # API errors.
90
+ rescue AdwordsApi::Errors::ApiException => e
91
+ puts "Message: %s" % e.message
92
+ puts 'Errors:'
93
+ e.errors.each_with_index do |error, index|
94
+ puts "\tError [%d]:" % (index + 1)
95
+ error.each do |field, value|
96
+ puts "\t\t%s: %s" % [field, value]
97
+ end
98
+ end
99
+ end
100
+ end