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