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,164 @@
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 adds a Shared Bidding Strategy and uses it to construct a
22
+ # campaign.
23
+ #
24
+ # Tags: BiddingStrategyService.mutate, CampaignService.mutate
25
+ # Tags: BudgetService.mutate
26
+
27
+ require 'adwords_api'
28
+ require 'date'
29
+
30
+ def use_shared_bidding_strategy()
31
+ # AdwordsApi::Api will read a config file from ENV['HOME']/adwords_api.yml
32
+ # when called without parameters.
33
+ adwords = AdwordsApi::Api.new
34
+
35
+ # To enable logging of SOAP requests, set the log_level value to 'DEBUG' in
36
+ # the configuration file or provide your own logger:
37
+ # adwords.logger = Logger.new('adwords_xml.log')
38
+
39
+ budget_srv = adwords.service(:BudgetService, API_VERSION)
40
+ bidding_srv = adwords.service(:BiddingStrategyService, API_VERSION)
41
+ campaign_srv = adwords.service(:CampaignService, API_VERSION)
42
+
43
+ # Create a budget, which can be shared by multiple campaigns.
44
+ budget = {
45
+ :name => 'Interplanetary budget #%d' % (Time.new.to_f * 1000).to_i,
46
+ :amount => {:micro_amount => 50000000},
47
+ :delivery_method => 'STANDARD',
48
+ :period => 'DAILY',
49
+ :is_explicitly_shared => true
50
+ }
51
+ return_budget = budget_srv.mutate([
52
+ {:operator => 'ADD', :operand => budget}])
53
+ budget_id = return_budget[:value].first[:budget_id]
54
+
55
+ # Create a shared bidding strategy.
56
+ shared_bidding_strategy = {
57
+ :name => 'Maximize Clicks #%d' % (Time.new.to_f * 1000).to_i,
58
+ :bidding_scheme => {
59
+ :xsi_type => 'TargetSpendBiddingScheme',
60
+ # Optionally set additional bidding scheme parameters.
61
+ :bid_ceiling => {:micro_amount => 20000000},
62
+ :spend_target => {:micro_amount => 40000000}
63
+ }
64
+ }
65
+ return_strategy = bidding_srv.mutate([
66
+ {:operator => 'ADD', :operand => shared_bidding_strategy}])
67
+
68
+ bidding_strategy = return_strategy[:value].first
69
+ puts ("Shared bidding strategy with name '%s' and ID %d of type '%s' was " +
70
+ 'created') %
71
+ [bidding_strategy[:name], bidding_strategy[:id], bidding_strategy[:type]]
72
+
73
+ # Create campaigns.
74
+ campaigns = [
75
+ {
76
+ :name => "Interplanetary Cruise #%d" % (Time.new.to_f * 1000).to_i,
77
+ :status => 'PAUSED',
78
+ :bidding_strategy_configuration => {
79
+ :bidding_strategy_id => bidding_strategy[:id]
80
+ },
81
+ # Budget (required) - note only the budget ID is required.
82
+ :budget => {:budget_id => budget_id},
83
+ :advertising_channel_type => 'SEARCH',
84
+ :network_setting => {
85
+ :target_google_search => true,
86
+ :target_search_network => true,
87
+ :target_content_network => true
88
+ },
89
+ :settings => [
90
+ {
91
+ :xsi_type => 'KeywordMatchSetting',
92
+ :opt_in => true
93
+ }
94
+ ]
95
+ },
96
+ {
97
+ :name => "Interplanetary Cruise banner #%d" % (Time.new.to_f * 1000).to_i,
98
+ :status => 'PAUSED',
99
+ :bidding_strategy_configuration => {
100
+ :bidding_strategy_id => bidding_strategy[:id]
101
+ },
102
+ :budget => {:budget_id => budget_id},
103
+ :advertising_channel_type => 'DISPLAY',
104
+ :settings => [
105
+ {
106
+ :xsi_type => 'KeywordMatchSetting',
107
+ :opt_in => true
108
+ }
109
+ ],
110
+ :network_setting => {
111
+ :target_google_search => false,
112
+ :target_search_network => false,
113
+ :target_content_network => true
114
+ }
115
+ }
116
+ ]
117
+
118
+ # Prepare for adding campaign.
119
+ operations = campaigns.map do |campaign|
120
+ {:operator => 'ADD', :operand => campaign}
121
+ end
122
+
123
+ # Add campaign.
124
+ response = campaign_srv.mutate(operations)
125
+ if response and response[:value]
126
+ response[:value].each do |campaign|
127
+ puts "Campaign with name '%s' and ID %d was added." %
128
+ [campaign[:name], campaign[:id]]
129
+ end
130
+ else
131
+ raise new StandardError, 'No campaigns were added.'
132
+ end
133
+ end
134
+
135
+ if __FILE__ == $0
136
+ API_VERSION = :v201406
137
+
138
+ begin
139
+ use_shared_bidding_strategy()
140
+
141
+ # Authorization error.
142
+ rescue AdsCommon::Errors::OAuth2VerificationRequired => e
143
+ puts "Authorization credentials are not valid. Edit adwords_api.yml for " +
144
+ "OAuth2 client ID and secret and run misc/setup_oauth2.rb example " +
145
+ "to retrieve and store OAuth2 tokens."
146
+ puts "See this wiki page for more details:\n\n " +
147
+ 'http://code.google.com/p/google-api-ads-ruby/wiki/OAuth2'
148
+
149
+ # HTTP errors.
150
+ rescue AdsCommon::Errors::HttpError => e
151
+ puts "HTTP Error: %s" % e
152
+
153
+ # API errors.
154
+ rescue AdwordsApi::Errors::ApiException => e
155
+ puts "Message: %s" % e.message
156
+ puts 'Errors:'
157
+ e.errors.each_with_index do |error, index|
158
+ puts "\tError [%d]:" % (index + 1)
159
+ error.each do |field, value|
160
+ puts "\t\t%s: %s" % [field, value]
161
+ end
162
+ end
163
+ end
164
+ end
@@ -0,0 +1,142 @@
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 create ad groups. To get a list of existing
22
+ # campaigns run get_campaigns.rb.
23
+ #
24
+ # Tags: AdGroupService.mutate
25
+
26
+ require 'adwords_api'
27
+
28
+ def add_ad_groups(campaign_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
+ ad_group_srv = adwords.service(:AdGroupService, API_VERSION)
38
+
39
+ ad_groups = [
40
+ {
41
+ :name => "Earth to Mars Cruises #%d" % (Time.new.to_f * 1000).to_i,
42
+ :status => 'ENABLED',
43
+ :campaign_id => campaign_id,
44
+ :bidding_strategy_configuration => {
45
+ :bids => [
46
+ {
47
+ # The 'xsi_type' field allows you to specify the xsi:type of the
48
+ # object being created. It's only necessary when you must provide
49
+ # an explicit type that the client library can't infer.
50
+ :xsi_type => 'CpcBid',
51
+ :bid => {:micro_amount => 10000000}
52
+ }
53
+ ]
54
+ },
55
+ :settings => [
56
+ # Targetting restriction settings - these setting only affect serving
57
+ # for the Display Network.
58
+ {
59
+ :xsi_type => 'TargetingSetting',
60
+ :details => [
61
+ # Restricting to serve ads that match your ad group placements.
62
+ {
63
+ :xsi_type => 'TargetingSettingDetail',
64
+ :criterion_type_group => 'PLACEMENT',
65
+ :target_all => true
66
+ },
67
+ # Using your ad group verticals only for bidding.
68
+ {
69
+ :xsi_type => 'TargetingSettingDetail',
70
+ :criterion_type_group => 'VERTICAL',
71
+ :target_all => false
72
+ }
73
+ ]
74
+ }
75
+ ]
76
+ },
77
+ {
78
+ :name => 'Earth to Pluto Cruises #%d' % (Time.new.to_f * 1000).to_i,
79
+ :status => 'ENABLED',
80
+ :campaign_id => campaign_id,
81
+ :bidding_strategy_configuration => {
82
+ :bids => [
83
+ {
84
+ # The 'xsi_type' field allows you to specify the xsi:type of the
85
+ # object being created. It's only necessary when you must provide
86
+ # an explicit type that the client library can't infer.
87
+ :xsi_type => 'CpcBid',
88
+ :bid => {:micro_amount => 10000000}
89
+ }
90
+ ]
91
+ }
92
+ }
93
+ ]
94
+
95
+ # Prepare operations for adding ad groups.
96
+ operations = ad_groups.map do |ad_group|
97
+ {:operator => 'ADD', :operand => ad_group}
98
+ end
99
+
100
+ # Add ad groups.
101
+ response = ad_group_srv.mutate(operations)
102
+ if response and response[:value]
103
+ response[:value].each do |ad_group|
104
+ puts "Ad group ID %d was successfully added." % ad_group[:id]
105
+ end
106
+ else
107
+ raise StandardError, 'No ad group was added'
108
+ end
109
+ end
110
+
111
+ if __FILE__ == $0
112
+ API_VERSION = :v201406
113
+
114
+ begin
115
+ # Campaign ID to add ad group to.
116
+ campaign_id = 'INSERT_CAMPAIGN_ID_HERE'.to_i
117
+ add_ad_groups(campaign_id)
118
+
119
+ # Authorization error.
120
+ rescue AdsCommon::Errors::OAuth2VerificationRequired => e
121
+ puts "Authorization credentials are not valid. Edit adwords_api.yml for " +
122
+ "OAuth2 client ID and secret and run misc/setup_oauth2.rb example " +
123
+ "to retrieve and store OAuth2 tokens."
124
+ puts "See this wiki page for more details:\n\n " +
125
+ 'http://code.google.com/p/google-api-ads-ruby/wiki/OAuth2'
126
+
127
+ # HTTP errors.
128
+ rescue AdsCommon::Errors::HttpError => e
129
+ puts "HTTP Error: %s" % e
130
+
131
+ # API errors.
132
+ rescue AdwordsApi::Errors::ApiException => e
133
+ puts "Message: %s" % e.message
134
+ puts 'Errors:'
135
+ e.errors.each_with_index do |error, index|
136
+ puts "\tError [%d]:" % (index + 1)
137
+ error.each do |field, value|
138
+ puts "\t\t%s: %s" % [field, value]
139
+ end
140
+ end
141
+ end
142
+ end
@@ -0,0 +1,153 @@
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 create campaigns.
22
+ #
23
+ # Tags: CampaignService.mutate, BudgetService.mutate
24
+
25
+ require 'adwords_api'
26
+ require 'date'
27
+
28
+ def add_campaigns()
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
+ budget_srv = adwords.service(:BudgetService, API_VERSION)
38
+ campaign_srv = adwords.service(:CampaignService, API_VERSION)
39
+
40
+ # Create a budget, which can be shared by multiple campaigns.
41
+ budget = {
42
+ :name => 'Interplanetary budget #%d' % (Time.new.to_f * 1000).to_i,
43
+ :amount => {:micro_amount => 50000000},
44
+ :delivery_method => 'STANDARD',
45
+ :period => 'DAILY'
46
+ }
47
+ budget_operation = {:operator => 'ADD', :operand => budget}
48
+
49
+ # Add budget.
50
+ return_budget = budget_srv.mutate([budget_operation])
51
+ budget_id = return_budget[:value].first[:budget_id]
52
+
53
+ # Create campaigns.
54
+ campaigns = [
55
+ {
56
+ :name => "Interplanetary Cruise #%d" % (Time.new.to_f * 1000).to_i,
57
+ :status => 'PAUSED',
58
+ :bidding_strategy_configuration => {
59
+ :bidding_strategy_type => 'MANUAL_CPC'
60
+ },
61
+ # Budget (required) - note only the budget ID is required.
62
+ :budget => {:budget_id => budget_id},
63
+ :advertising_channel_type => 'SEARCH',
64
+ # Optional fields:
65
+ :start_date =>
66
+ DateTime.parse((Date.today + 1).to_s).strftime('%Y%m%d'),
67
+ :ad_serving_optimization_status => 'ROTATE',
68
+ :network_setting => {
69
+ :target_google_search => true,
70
+ :target_search_network => true,
71
+ :target_content_network => true
72
+ },
73
+ :settings => [
74
+ {
75
+ :xsi_type => 'GeoTargetTypeSetting',
76
+ :positive_geo_target_type => 'DONT_CARE',
77
+ :negative_geo_target_type => 'DONT_CARE'
78
+ },
79
+ {
80
+ :xsi_type => 'KeywordMatchSetting',
81
+ :opt_in => true
82
+ }
83
+ ],
84
+ :frequency_cap => {
85
+ :impressions => '5',
86
+ :time_unit => 'DAY',
87
+ :level => 'ADGROUP'
88
+ }
89
+ },
90
+ {
91
+ :name => "Interplanetary Cruise banner #%d" % (Time.new.to_f * 1000).to_i,
92
+ :status => 'PAUSED',
93
+ :bidding_strategy_configuration => {
94
+ :bidding_strategy_type => 'MANUAL_CPC'
95
+ },
96
+ :budget => {:budget_id => budget_id},
97
+ :settings => [
98
+ {
99
+ :xsi_type => 'KeywordMatchSetting',
100
+ :opt_in => true
101
+ }
102
+ ],
103
+ :advertising_channel_type => 'DISPLAY'
104
+ }
105
+ ]
106
+
107
+ # Prepare for adding campaign.
108
+ operations = campaigns.map do |campaign|
109
+ {:operator => 'ADD', :operand => campaign}
110
+ end
111
+
112
+ # Add campaign.
113
+ response = campaign_srv.mutate(operations)
114
+ if response and response[:value]
115
+ response[:value].each do |campaign|
116
+ puts "Campaign with name '%s' and ID %d was added." %
117
+ [campaign[:name], campaign[:id]]
118
+ end
119
+ else
120
+ raise new StandardError, 'No campaigns were added.'
121
+ end
122
+ end
123
+
124
+ if __FILE__ == $0
125
+ API_VERSION = :v201406
126
+
127
+ begin
128
+ add_campaigns()
129
+
130
+ # Authorization error.
131
+ rescue AdsCommon::Errors::OAuth2VerificationRequired => e
132
+ puts "Authorization credentials are not valid. Edit adwords_api.yml for " +
133
+ "OAuth2 client ID and secret and run misc/setup_oauth2.rb example " +
134
+ "to retrieve and store OAuth2 tokens."
135
+ puts "See this wiki page for more details:\n\n " +
136
+ 'http://code.google.com/p/google-api-ads-ruby/wiki/OAuth2'
137
+
138
+ # HTTP errors.
139
+ rescue AdsCommon::Errors::HttpError => e
140
+ puts "HTTP Error: %s" % e
141
+
142
+ # API errors.
143
+ rescue AdwordsApi::Errors::ApiException => e
144
+ puts "Message: %s" % e.message
145
+ puts 'Errors:'
146
+ e.errors.each_with_index do |error, index|
147
+ puts "\tError [%d]:" % (index + 1)
148
+ error.each do |field, value|
149
+ puts "\t\t%s: %s" % [field, value]
150
+ end
151
+ end
152
+ end
153
+ end
@@ -0,0 +1,116 @@
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 add multiple keywords to a given ad group. To
22
+ # create an ad group, run add_ad_group.rb.
23
+ #
24
+ # Tags: AdGroupCriterionService.mutate
25
+
26
+ require 'adwords_api'
27
+
28
+ def add_keywords(ad_group_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
+ ad_group_criterion_srv =
38
+ adwords.service(:AdGroupCriterionService, API_VERSION)
39
+
40
+ # Create keywords.
41
+ # The 'xsi_type' field allows you to specify the xsi:type of the object
42
+ # being created. It's only necessary when you must provide an explicit
43
+ # type that the client library can't infer.
44
+ keywords = [
45
+ {:xsi_type => 'BiddableAdGroupCriterion',
46
+ :ad_group_id => ad_group_id,
47
+ :criterion => {
48
+ :xsi_type => 'Keyword',
49
+ :text => 'mars cruise',
50
+ :match_type => 'BROAD'
51
+ },
52
+ # Optional fields:
53
+ :user_status => 'PAUSED',
54
+ :destination_url => 'http://example.com/mars'
55
+ },
56
+ {:xsi_type => 'BiddableAdGroupCriterion',
57
+ :ad_group_id => ad_group_id,
58
+ :criterion => {
59
+ :xsi_type => 'Keyword',
60
+ :text => 'space hotel',
61
+ :match_type => 'BROAD'}}
62
+ ]
63
+
64
+ # Create 'ADD' operations.
65
+ operations = keywords.map do |keyword|
66
+ {:operator => 'ADD', :operand => keyword}
67
+ end
68
+
69
+ # Add keywords.
70
+ response = ad_group_criterion_srv.mutate(operations)
71
+ if response and response[:value]
72
+ ad_group_criteria = response[:value]
73
+ puts "Added %d keywords to ad group ID %d:" %
74
+ [ad_group_criteria.length, ad_group_id]
75
+ ad_group_criteria.each do |ad_group_criterion|
76
+ puts "\tKeyword ID is %d and type is '%s'" %
77
+ [ad_group_criterion[:criterion][:id],
78
+ ad_group_criterion[:criterion][:type]]
79
+ end
80
+ else
81
+ raise StandardError, 'No keywords were added.'
82
+ end
83
+ end
84
+
85
+ if __FILE__ == $0
86
+ API_VERSION = :v201406
87
+
88
+ begin
89
+ # Ad group ID to add keywords to.
90
+ ad_group_id = 'INSERT_AD_GROUP_ID_HERE'.to_i
91
+ add_keywords(ad_group_id)
92
+
93
+ # Authorization error.
94
+ rescue AdsCommon::Errors::OAuth2VerificationRequired => e
95
+ puts "Authorization credentials are not valid. Edit adwords_api.yml for " +
96
+ "OAuth2 client ID and secret and run misc/setup_oauth2.rb example " +
97
+ "to retrieve and store OAuth2 tokens."
98
+ puts "See this wiki page for more details:\n\n " +
99
+ 'http://code.google.com/p/google-api-ads-ruby/wiki/OAuth2'
100
+
101
+ # HTTP errors.
102
+ rescue AdsCommon::Errors::HttpError => e
103
+ puts "HTTP Error: %s" % e
104
+
105
+ # API errors.
106
+ rescue AdwordsApi::Errors::ApiException => e
107
+ puts "Message: %s" % e.message
108
+ puts 'Errors:'
109
+ e.errors.each_with_index do |error, index|
110
+ puts "\tError [%d]:" % (index + 1)
111
+ error.each do |field, value|
112
+ puts "\t\t%s: %s" % [field, value]
113
+ end
114
+ end
115
+ end
116
+ end
@@ -0,0 +1,113 @@
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 add text ads to a given ad group. To create an
22
+ # ad group, run add_ad_group.rb.
23
+ #
24
+ # Tags: AdGroupAdService.mutate
25
+
26
+ require 'adwords_api'
27
+
28
+ def add_text_ads(ad_group_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
+ ad_group_ad_srv = adwords.service(:AdGroupAdService, API_VERSION)
38
+
39
+ # Create text ads.
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
+ text_ads = [
44
+ {
45
+ :xsi_type => 'TextAd',
46
+ :headline => 'Luxury Cruise to Mars',
47
+ :description1 => 'Visit the Red Planet in style.',
48
+ :description2 => 'Low-gravity fun for everyone!',
49
+ :url => 'http://www.example.com',
50
+ :display_url => 'www.example.com'
51
+ },
52
+ {
53
+ :xsi_type => 'TextAd',
54
+ :headline => 'Luxury Cruise to Mars',
55
+ :description1 => 'Enjoy your stay at Red Planet.',
56
+ :description2 => 'Buy your tickets now!',
57
+ :url => 'http://www.example.com',
58
+ :display_url => 'www.example.com'
59
+ }
60
+ ]
61
+
62
+ # Create ad 'ADD' operations.
63
+ text_ad_operations = text_ads.map do |text_ad|
64
+ {:operator => 'ADD',
65
+ :operand => {:ad_group_id => ad_group_id, :ad => text_ad}}
66
+ end
67
+
68
+ # Add ads.
69
+ response = ad_group_ad_srv.mutate(text_ad_operations)
70
+ if response and response[:value]
71
+ ads = response[:value]
72
+ puts "Added %d ad(s) to ad group ID %d:" % [ads.length, ad_group_id]
73
+ ads.each do |ad|
74
+ puts "\tAd ID %d, type '%s' and status '%s'" %
75
+ [ad[:ad][:id], ad[:ad][:ad_type], ad[:status]]
76
+ end
77
+ else
78
+ raise StandardError, 'No ads were added.'
79
+ end
80
+ end
81
+
82
+ if __FILE__ == $0
83
+ API_VERSION = :v201406
84
+
85
+ begin
86
+ # Ad group ID to add text ads to.
87
+ ad_group_id = 'INSERT_AD_GROUP_ID_HERE'.to_i
88
+ add_text_ads(ad_group_id)
89
+
90
+ # Authorization error.
91
+ rescue AdsCommon::Errors::OAuth2VerificationRequired => e
92
+ puts "Authorization credentials are not valid. Edit adwords_api.yml for " +
93
+ "OAuth2 client ID and secret and run misc/setup_oauth2.rb example " +
94
+ "to retrieve and store OAuth2 tokens."
95
+ puts "See this wiki page for more details:\n\n " +
96
+ 'http://code.google.com/p/google-api-ads-ruby/wiki/OAuth2'
97
+
98
+ # HTTP errors.
99
+ rescue AdsCommon::Errors::HttpError => e
100
+ puts "HTTP Error: %s" % e
101
+
102
+ # API errors.
103
+ rescue AdwordsApi::Errors::ApiException => e
104
+ puts "Message: %s" % e.message
105
+ puts 'Errors:'
106
+ e.errors.each_with_index do |error, index|
107
+ puts "\tError [%d]:" % (index + 1)
108
+ error.each do |field, value|
109
+ puts "\t\t%s: %s" % [field, value]
110
+ end
111
+ end
112
+ end
113
+ end