google-adwords-api 0.11.1 → 0.12.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (152) hide show
  1. data/ChangeLog +3 -0
  2. data/{README → README.md} +0 -0
  3. data/lib/adwords_api/api_config.rb +0 -76
  4. data/lib/adwords_api/version.rb +1 -1
  5. data/test/templates/v201309/basic_operations_get_campaigns.def +1 -1
  6. data/test/templates/v201309/misc_use_oauth2_jwt.def +1 -1
  7. metadata +3 -148
  8. data/examples/v201306/account_management/create_account.rb +0 -95
  9. data/examples/v201306/account_management/get_account_alerts.rb +0 -122
  10. data/examples/v201306/account_management/get_account_changes.rb +0 -145
  11. data/examples/v201306/account_management/get_account_hierarchy.rb +0 -103
  12. data/examples/v201306/advanced_operations/add_ad_group_bid_modifier.rb +0 -105
  13. data/examples/v201306/advanced_operations/add_click_to_download_ad.rb +0 -137
  14. data/examples/v201306/advanced_operations/add_site_links.rb +0 -244
  15. data/examples/v201306/advanced_operations/create_and_attach_shared_keyword_set.rb +0 -147
  16. data/examples/v201306/advanced_operations/find_and_remove_criteria_from_shared_set.rb +0 -181
  17. data/examples/v201306/advanced_operations/get_ad_group_bid_modifiers.rb +0 -106
  18. data/examples/v201306/basic_operations/add_ad_groups.rb +0 -143
  19. data/examples/v201306/basic_operations/add_campaigns.rb +0 -162
  20. data/examples/v201306/basic_operations/add_keywords.rb +0 -116
  21. data/examples/v201306/basic_operations/add_text_ads.rb +0 -113
  22. data/examples/v201306/basic_operations/delete_ad.rb +0 -93
  23. data/examples/v201306/basic_operations/delete_ad_group.rb +0 -110
  24. data/examples/v201306/basic_operations/delete_campaign.rb +0 -111
  25. data/examples/v201306/basic_operations/delete_keyword.rb +0 -98
  26. data/examples/v201306/basic_operations/get_ad_groups.rb +0 -106
  27. data/examples/v201306/basic_operations/get_campaigns.rb +0 -101
  28. data/examples/v201306/basic_operations/get_campaigns_with_awql.rb +0 -93
  29. data/examples/v201306/basic_operations/get_keywords.rb +0 -112
  30. data/examples/v201306/basic_operations/get_text_ads.rb +0 -114
  31. data/examples/v201306/basic_operations/pause_ad.rb +0 -92
  32. data/examples/v201306/basic_operations/update_ad_group.rb +0 -89
  33. data/examples/v201306/basic_operations/update_campaign.rb +0 -90
  34. data/examples/v201306/basic_operations/update_keyword.rb +0 -110
  35. data/examples/v201306/campaign_management/add_experiment.rb +0 -166
  36. data/examples/v201306/campaign_management/add_keywords_in_bulk.rb +0 -158
  37. data/examples/v201306/campaign_management/add_location_extension.rb +0 -125
  38. data/examples/v201306/campaign_management/add_location_extension_override.rb +0 -91
  39. data/examples/v201306/campaign_management/get_all_disapproved_ads.rb +0 -101
  40. data/examples/v201306/campaign_management/get_all_disapproved_ads_with_awql.rb +0 -92
  41. data/examples/v201306/campaign_management/promote_experiment.rb +0 -85
  42. data/examples/v201306/campaign_management/set_ad_parameters.rb +0 -122
  43. data/examples/v201306/campaign_management/set_criterion_bid_modifier.rb +0 -110
  44. data/examples/v201306/campaign_management/validate_text_ad.rb +0 -114
  45. data/examples/v201306/error_handling/handle_captcha_challenge.rb +0 -93
  46. data/examples/v201306/error_handling/handle_partial_failures.rb +0 -134
  47. data/examples/v201306/error_handling/handle_policy_violation_error.rb +0 -145
  48. data/examples/v201306/error_handling/handle_two_factor_authorization_error.rb +0 -88
  49. data/examples/v201306/migration/upgrade_legacy_sitelinks.rb +0 -313
  50. data/examples/v201306/misc/get_all_images_and_videos.rb +0 -108
  51. data/examples/v201306/misc/setup_oauth2.rb +0 -88
  52. data/examples/v201306/misc/upload_image.rb +0 -97
  53. data/examples/v201306/misc/use_oauth2_jwt.rb +0 -97
  54. data/examples/v201306/optimization/estimate_keyword_traffic.rb +0 -137
  55. data/examples/v201306/optimization/get_keyword_bid_simulations.rb +0 -100
  56. data/examples/v201306/optimization/get_keyword_ideas.rb +0 -130
  57. data/examples/v201306/optimization/get_placement_ideas.rb +0 -112
  58. data/examples/v201306/remarketing/add_audience.rb +0 -123
  59. data/examples/v201306/remarketing/add_conversion_tracker.rb +0 -104
  60. data/examples/v201306/reporting/download_criteria_report.rb +0 -87
  61. data/examples/v201306/reporting/download_criteria_report_with_awql.rb +0 -86
  62. data/examples/v201306/reporting/get_campaign_stats.rb +0 -113
  63. data/examples/v201306/reporting/get_report_fields.rb +0 -79
  64. data/examples/v201306/reporting/parallel_report_download.rb +0 -171
  65. data/examples/v201306/targeting/add_campaign_targeting_criteria.rb +0 -123
  66. data/examples/v201306/targeting/add_demographic_targeting_criteria.rb +0 -116
  67. data/examples/v201306/targeting/get_campaign_targeting_criteria.rb +0 -110
  68. data/examples/v201306/targeting/get_targetable_languages_and_carriers.rb +0 -94
  69. data/examples/v201306/targeting/lookup_location.rb +0 -112
  70. data/examples/v201402/advanced_operations/add_places_location_extensions.rb~ +0 -159
  71. data/examples/v201402/basic_operations/add_ad_groups.rb~ +0 -147
  72. data/examples/v201402/misc/create_ad_words_session_without_properties_file.rb~ +0 -94
  73. data/examples/v201402/remarketing/add_conversion_tracker.rb~ +0 -109
  74. data/examples/v201402/shopping_campaigns/add_product_partition_tree.rb~ +0 -269
  75. data/examples/v201402/shopping_campaigns/add_shopping_campaign.rb~ +0 -136
  76. data/examples/v201402/shopping_campaigns/get_product_category_taxonomy.rb~ +0 -128
  77. data/examples/v201402/shopping_campaigns/set_product_sales_channel.rb~ +0 -98
  78. data/lib/adwords_api/v201306/ad_extension_override_service.rb +0 -38
  79. data/lib/adwords_api/v201306/ad_extension_override_service_registry.rb +0 -46
  80. data/lib/adwords_api/v201306/ad_group_ad_service.rb +0 -42
  81. data/lib/adwords_api/v201306/ad_group_ad_service_registry.rb +0 -46
  82. data/lib/adwords_api/v201306/ad_group_bid_modifier_service.rb +0 -38
  83. data/lib/adwords_api/v201306/ad_group_bid_modifier_service_registry.rb +0 -46
  84. data/lib/adwords_api/v201306/ad_group_criterion_service.rb +0 -42
  85. data/lib/adwords_api/v201306/ad_group_criterion_service_registry.rb +0 -46
  86. data/lib/adwords_api/v201306/ad_group_feed_service.rb +0 -38
  87. data/lib/adwords_api/v201306/ad_group_feed_service_registry.rb +0 -46
  88. data/lib/adwords_api/v201306/ad_group_service.rb +0 -42
  89. data/lib/adwords_api/v201306/ad_group_service_registry.rb +0 -46
  90. data/lib/adwords_api/v201306/ad_param_service.rb +0 -38
  91. data/lib/adwords_api/v201306/ad_param_service_registry.rb +0 -46
  92. data/lib/adwords_api/v201306/adwords_user_list_service.rb +0 -38
  93. data/lib/adwords_api/v201306/adwords_user_list_service_registry.rb +0 -46
  94. data/lib/adwords_api/v201306/alert_service.rb +0 -34
  95. data/lib/adwords_api/v201306/alert_service_registry.rb +0 -46
  96. data/lib/adwords_api/v201306/bidding_strategy_service.rb +0 -38
  97. data/lib/adwords_api/v201306/bidding_strategy_service_registry.rb +0 -46
  98. data/lib/adwords_api/v201306/budget_order_service.rb +0 -42
  99. data/lib/adwords_api/v201306/budget_order_service_registry.rb +0 -46
  100. data/lib/adwords_api/v201306/budget_service.rb +0 -38
  101. data/lib/adwords_api/v201306/budget_service_registry.rb +0 -46
  102. data/lib/adwords_api/v201306/campaign_ad_extension_service.rb +0 -38
  103. data/lib/adwords_api/v201306/campaign_ad_extension_service_registry.rb +0 -46
  104. data/lib/adwords_api/v201306/campaign_criterion_service.rb +0 -42
  105. data/lib/adwords_api/v201306/campaign_criterion_service_registry.rb +0 -46
  106. data/lib/adwords_api/v201306/campaign_feed_service.rb +0 -38
  107. data/lib/adwords_api/v201306/campaign_feed_service_registry.rb +0 -46
  108. data/lib/adwords_api/v201306/campaign_service.rb +0 -42
  109. data/lib/adwords_api/v201306/campaign_service_registry.rb +0 -46
  110. data/lib/adwords_api/v201306/campaign_shared_set_service.rb +0 -38
  111. data/lib/adwords_api/v201306/campaign_shared_set_service_registry.rb +0 -47
  112. data/lib/adwords_api/v201306/constant_data_service.rb +0 -62
  113. data/lib/adwords_api/v201306/constant_data_service_registry.rb +0 -46
  114. data/lib/adwords_api/v201306/conversion_tracker_service.rb +0 -38
  115. data/lib/adwords_api/v201306/conversion_tracker_service_registry.rb +0 -46
  116. data/lib/adwords_api/v201306/customer_service.rb +0 -34
  117. data/lib/adwords_api/v201306/customer_service_registry.rb +0 -46
  118. data/lib/adwords_api/v201306/customer_sync_service.rb +0 -34
  119. data/lib/adwords_api/v201306/customer_sync_service_registry.rb +0 -47
  120. data/lib/adwords_api/v201306/data_service.rb +0 -38
  121. data/lib/adwords_api/v201306/data_service_registry.rb +0 -46
  122. data/lib/adwords_api/v201306/experiment_service.rb +0 -38
  123. data/lib/adwords_api/v201306/experiment_service_registry.rb +0 -46
  124. data/lib/adwords_api/v201306/feed_item_service.rb +0 -38
  125. data/lib/adwords_api/v201306/feed_item_service_registry.rb +0 -46
  126. data/lib/adwords_api/v201306/feed_mapping_service.rb +0 -38
  127. data/lib/adwords_api/v201306/feed_mapping_service_registry.rb +0 -46
  128. data/lib/adwords_api/v201306/feed_service.rb +0 -38
  129. data/lib/adwords_api/v201306/feed_service_registry.rb +0 -46
  130. data/lib/adwords_api/v201306/geo_location_service.rb +0 -34
  131. data/lib/adwords_api/v201306/geo_location_service_registry.rb +0 -46
  132. data/lib/adwords_api/v201306/location_criterion_service.rb +0 -34
  133. data/lib/adwords_api/v201306/location_criterion_service_registry.rb +0 -46
  134. data/lib/adwords_api/v201306/managed_customer_service.rb +0 -50
  135. data/lib/adwords_api/v201306/managed_customer_service_registry.rb +0 -46
  136. data/lib/adwords_api/v201306/media_service.rb +0 -38
  137. data/lib/adwords_api/v201306/media_service_registry.rb +0 -46
  138. data/lib/adwords_api/v201306/mutate_job_service.rb +0 -42
  139. data/lib/adwords_api/v201306/mutate_job_service_registry.rb +0 -46
  140. data/lib/adwords_api/v201306/report_definition_service.rb +0 -34
  141. data/lib/adwords_api/v201306/report_definition_service_registry.rb +0 -46
  142. data/lib/adwords_api/v201306/shared_criterion_service.rb +0 -38
  143. data/lib/adwords_api/v201306/shared_criterion_service_registry.rb +0 -47
  144. data/lib/adwords_api/v201306/shared_set_service.rb +0 -38
  145. data/lib/adwords_api/v201306/shared_set_service_registry.rb +0 -47
  146. data/lib/adwords_api/v201306/targeting_idea_service.rb +0 -38
  147. data/lib/adwords_api/v201306/targeting_idea_service_registry.rb +0 -46
  148. data/lib/adwords_api/v201306/traffic_estimator_service.rb +0 -34
  149. data/lib/adwords_api/v201306/traffic_estimator_service_registry.rb +0 -46
  150. data/test/adwords_api/test_adwords_api.rb~ +0 -127
  151. data/test/templates/v201306/basic_operations_get_campaigns.def +0 -114
  152. data/test/templates/v201306/misc_use_oauth2_jwt.def +0 -131
@@ -1,92 +0,0 @@
1
- #!/usr/bin/env ruby
2
- # Encoding: utf-8
3
- #
4
- # Author:: api.dklimkin@gmail.com (Danial Klimkin)
5
- #
6
- # Copyright:: Copyright 2011, Google Inc. All Rights Reserved.
7
- #
8
- # License:: Licensed under the Apache License, Version 2.0 (the "License");
9
- # you may not use this file except in compliance with the License.
10
- # You may obtain a copy of the License at
11
- #
12
- # http://www.apache.org/licenses/LICENSE-2.0
13
- #
14
- # Unless required by applicable law or agreed to in writing, software
15
- # distributed under the License is distributed on an "AS IS" BASIS,
16
- # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
17
- # implied.
18
- # See the License for the specific language governing permissions and
19
- # limitations under the License.
20
- #
21
- # This example illustrates how to update an ad, setting its status to 'PAUSED'.
22
- # To create ads, run add_text_ads.rb.
23
- #
24
- # Tags: AdGroupAdService.mutate
25
-
26
- require 'adwords_api'
27
-
28
- def pause_ad(ad_group_id, ad_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
- # Prepare operation for updating ad.
40
- operation = {
41
- :operator => 'SET',
42
- :operand => {
43
- :ad_group_id => ad_group_id,
44
- :status => 'PAUSED',
45
- :ad => {:id => ad_id}
46
- }
47
- }
48
-
49
- # Update ad.
50
- response = ad_group_ad_srv.mutate([operation])
51
- if response and response[:value]
52
- ad = response[:value].first
53
- puts "Ad ID %d was successfully updated, status set to '%s'." %
54
- [ad[:ad][:id], ad[:status]]
55
- else
56
- puts 'No ads were updated.'
57
- end
58
- end
59
-
60
- if __FILE__ == $0
61
- API_VERSION = :v201306
62
-
63
- begin
64
- # IDs of ad to pause and its ad group.
65
- ad_group_id = 'INSERT_AD_GROUP_ID_HERE'.to_i
66
- ad_id = 'INSERT_AD_ID_HERE'.to_i
67
- pause_ad(ad_group_id, ad_id)
68
-
69
- # Authorization error.
70
- rescue AdsCommon::Errors::OAuth2VerificationRequired => e
71
- puts "Authorization credentials are not valid. Edit adwords_api.yml for " +
72
- "OAuth2 client ID and secret and run misc/setup_oauth2.rb example " +
73
- "to retrieve and store OAuth2 tokens."
74
- puts "See this wiki page for more details:\n\n " +
75
- 'http://code.google.com/p/google-api-ads-ruby/wiki/OAuth2'
76
-
77
- # HTTP errors.
78
- rescue AdsCommon::Errors::HttpError => e
79
- puts "HTTP Error: %s" % e
80
-
81
- # API errors.
82
- rescue AdwordsApi::Errors::ApiException => e
83
- puts "Message: %s" % e.message
84
- puts 'Errors:'
85
- e.errors.each_with_index do |error, index|
86
- puts "\tError [%d]:" % (index + 1)
87
- error.each do |field, value|
88
- puts "\t\t%s: %s" % [field, value]
89
- end
90
- end
91
- end
92
- end
@@ -1,89 +0,0 @@
1
- #!/usr/bin/env ruby
2
- # Encoding: utf-8
3
- #
4
- # Author:: api.sgomes@gmail.com (Sérgio Gomes)
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 update an ad group, setting its status to
22
- # 'PAUSED'. To create an ad group, run add_ad_group.rb.
23
- #
24
- # Tags: AdGroupService.mutate
25
-
26
- require 'adwords_api'
27
-
28
- def update_ad_group(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_srv = adwords.service(:AdGroupService, API_VERSION)
38
-
39
- # Prepare for updating ad group.
40
- operation = {
41
- :operator => 'SET',
42
- :operand => {
43
- :status => 'PAUSED',
44
- :id => ad_group_id
45
- }
46
- }
47
-
48
- # Update ad group.
49
- response = ad_group_srv.mutate([operation])
50
- if response and response[:value]
51
- ad_group = response[:value].first
52
- puts 'Ad group id %d was successfully updated.' % ad_group[:id]
53
- else
54
- puts 'No ad groups were updated.'
55
- end
56
- end
57
-
58
- if __FILE__ == $0
59
- API_VERSION = :v201306
60
-
61
- begin
62
- # ID of an ad group to update.
63
- ad_group_id = 'INSERT_AD_GROUP_ID_HERE'.to_i
64
- update_ad_group(ad_group_id)
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
@@ -1,90 +0,0 @@
1
- #!/usr/bin/env ruby
2
- # Encoding: utf-8
3
- #
4
- # Author:: api.dklimkin@gmail.com (Danial Klimkin)
5
- #
6
- # Copyright:: Copyright 2011, Google Inc. All Rights Reserved.
7
- #
8
- # License:: Licensed under the Apache License, Version 2.0 (the "License");
9
- # you may not use this file except in compliance with the License.
10
- # You may obtain a copy of the License at
11
- #
12
- # http://www.apache.org/licenses/LICENSE-2.0
13
- #
14
- # Unless required by applicable law or agreed to in writing, software
15
- # distributed under the License is distributed on an "AS IS" BASIS,
16
- # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
17
- # implied.
18
- # See the License for the specific language governing permissions and
19
- # limitations under the License.
20
- #
21
- # This example illustrates how to update a campaign, setting its status to
22
- # 'PAUSED'. To create a campaign, run add_campaigns.rb.
23
- #
24
- # Tags: CampaignService.mutate
25
-
26
- require 'adwords_api'
27
-
28
- def update_campaign(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
- campaign_srv = adwords.service(:CampaignService, API_VERSION)
38
-
39
- # Prepare for updating campaign.
40
- operation = {
41
- :operator => 'SET',
42
- :operand => {
43
- :id => campaign_id,
44
- :status => 'PAUSED'
45
- }
46
- }
47
-
48
- # Update campaign.
49
- response = campaign_srv.mutate([operation])
50
- if response and response[:value]
51
- campaign = response[:value].first
52
- puts "Campaign ID %d was successfully updated, status was set to '%s'." %
53
- [campaign[:id], campaign[:status]]
54
- else
55
- puts 'No campaigns were updated.'
56
- end
57
- end
58
-
59
- if __FILE__ == $0
60
- API_VERSION = :v201306
61
-
62
- begin
63
- # ID of a campaign to update.
64
- campaign_id = 'INSERT_CAMPAIGN_ID_HERE'.to_i
65
- update_campaign(campaign_id)
66
-
67
- # Authorization error.
68
- rescue AdsCommon::Errors::OAuth2VerificationRequired => e
69
- puts "Authorization credentials are not valid. Edit adwords_api.yml for " +
70
- "OAuth2 client ID and secret and run misc/setup_oauth2.rb example " +
71
- "to retrieve and store OAuth2 tokens."
72
- puts "See this wiki page for more details:\n\n " +
73
- 'http://code.google.com/p/google-api-ads-ruby/wiki/OAuth2'
74
-
75
- # HTTP errors.
76
- rescue AdsCommon::Errors::HttpError => e
77
- puts "HTTP Error: %s" % e
78
-
79
- # API errors.
80
- rescue AdwordsApi::Errors::ApiException => e
81
- puts "Message: %s" % e.message
82
- puts 'Errors:'
83
- e.errors.each_with_index do |error, index|
84
- puts "\tError [%d]:" % (index + 1)
85
- error.each do |field, value|
86
- puts "\t\t%s: %s" % [field, value]
87
- end
88
- end
89
- end
90
- end
@@ -1,110 +0,0 @@
1
- #!/usr/bin/env ruby
2
- # Encoding: utf-8
3
- #
4
- # Author:: api.dklimkin@gmail.com (Danial Klimkin)
5
- #
6
- # Copyright:: Copyright 2011, Google Inc. All Rights Reserved.
7
- #
8
- # License:: Licensed under the Apache License, Version 2.0 (the "License");
9
- # you may not use this file except in compliance with the License.
10
- # You may obtain a copy of the License at
11
- #
12
- # http://www.apache.org/licenses/LICENSE-2.0
13
- #
14
- # Unless required by applicable law or agreed to in writing, software
15
- # distributed under the License is distributed on an "AS IS" BASIS,
16
- # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
17
- # implied.
18
- # See the License for the specific language governing permissions and
19
- # limitations under the License.
20
- #
21
- # This example updates the bid of a keyword. To create a keyword, run
22
- # add_keywords.rb.
23
- #
24
- # Tags: AdGroupCriterionService.mutate
25
-
26
- require 'adwords_api'
27
-
28
- def update_keyword(ad_group_id, criterion_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
- # Prepare for updating a keyword.
41
- operation = {
42
- :operator => 'SET',
43
- :operand => {
44
- # The 'xsi_type' field allows you to specify the xsi:type of the object
45
- # being created. It's only necessary when you must provide an explicit
46
- # type that the client library can't infer.
47
- :xsi_type => 'BiddableAdGroupCriterion',
48
- :ad_group_id => ad_group_id,
49
- :criterion => {
50
- :id => criterion_id
51
- },
52
- :bidding_strategy_configuration => {
53
- :bids => [
54
- {
55
- :xsi_type => 'CpcBid',
56
- :bid => {:micro_amount => 1000000}
57
- }
58
- ]
59
- }
60
- }
61
- }
62
-
63
- # Update criterion.
64
- response = ad_group_criterion_srv.mutate([operation])
65
- if response and response[:value]
66
- ad_group_criterion = response[:value].first
67
- puts "Keyword ID %d was successfully updated, current bids are:" %
68
- ad_group_criterion[:criterion][:id]
69
- ad_group_criterion[:bidding_strategy_configuration][:bids].each do |bid|
70
- puts "\tType: '%s', value: %d" %
71
- [bid[:bids_type], bid[:bid][:micro_amount]]
72
- end
73
- else
74
- puts 'No keywords were updated.'
75
- end
76
- end
77
-
78
- if __FILE__ == $0
79
- API_VERSION = :v201306
80
-
81
- begin
82
- # IDs of a criterion to update and its ad group.
83
- ad_group_id = 'INSERT_AD_GROUP_ID_HERE'.to_i
84
- criterion_id = 'INSERT_CRITERION_ID_HERE'.to_i
85
- update_keyword(ad_group_id, criterion_id)
86
-
87
- # Authorization error.
88
- rescue AdsCommon::Errors::OAuth2VerificationRequired => e
89
- puts "Authorization credentials are not valid. Edit adwords_api.yml for " +
90
- "OAuth2 client ID and secret and run misc/setup_oauth2.rb example " +
91
- "to retrieve and store OAuth2 tokens."
92
- puts "See this wiki page for more details:\n\n " +
93
- 'http://code.google.com/p/google-api-ads-ruby/wiki/OAuth2'
94
-
95
- # HTTP errors.
96
- rescue AdsCommon::Errors::HttpError => e
97
- puts "HTTP Error: %s" % e
98
-
99
- # API errors.
100
- rescue AdwordsApi::Errors::ApiException => e
101
- puts "Message: %s" % e.message
102
- puts 'Errors:'
103
- e.errors.each_with_index do |error, index|
104
- puts "\tError [%d]:" % (index + 1)
105
- error.each do |field, value|
106
- puts "\t\t%s: %s" % [field, value]
107
- end
108
- end
109
- end
110
- end
@@ -1,166 +0,0 @@
1
- #!/usr/bin/env ruby
2
- # Encoding: utf-8
3
- #
4
- # Author:: api.sgomes@gmail.com (Sérgio Gomes)
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 creates an experiment using a query percentage of 10, which
22
- # defines what fraction of auctions should go to the control split (90%) vs.
23
- # the experiment split (10%), then adds experimental bid changes for criteria
24
- # and ad groups. To get campaigns, run get_campaigns.rb. To get ad groups,
25
- # run get_ad_groups.rb. To get keywords, run get_keywords.rb.
26
- #
27
- # Tags: ExperimentService.mutate
28
-
29
- require 'adwords_api'
30
- require 'date'
31
-
32
- def add_experiment(campaign_id, ad_group_id, criterion_id)
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
- experiment_srv = adwords.service(:ExperimentService, API_VERSION)
42
- ad_group_srv = adwords.service(:AdGroupService, API_VERSION)
43
- ad_group_criterion_srv =
44
- adwords.service(:AdGroupCriterionService, API_VERSION)
45
-
46
- # Prepare for adding experiment.
47
- operation = {
48
- :operator => 'ADD',
49
- :operand => {
50
- :campaign_id => campaign_id,
51
- :name => "Interplanetary Experiment #%d" % (Time.new.to_f * 1000).to_i,
52
- :query_percentage => 10,
53
- :start_date_time => Time.now.strftime('%Y%m%d %H%M%S'),
54
- # Optional fields:
55
- :status => 'ACTIVE',
56
- :end_date_time =>
57
- DateTime.parse((Date.today + 30).to_s).strftime('%Y%m%d %H%M%S')
58
- }
59
- }
60
-
61
- # Add experiment.
62
- response = experiment_srv.mutate([operation])
63
- experiment = response[:value].first
64
- puts "Experiment with name '%s' and ID %d was added." %
65
- [experiment[:name], experiment[:id]]
66
-
67
- experiment_id = experiment[:id]
68
-
69
- # Setup ad group for the experiment.
70
- ad_group = {
71
- :id => ad_group_id,
72
- # Set experiment data for the ad group.
73
- :experiment_data => {
74
- :experiment_id => experiment_id,
75
- :experiment_delta_status => 'MODIFIED',
76
- # Bid multiplier rule that will modify ad group bid for the experiment.
77
- :experiment_bid_multipliers => {
78
- :xsi_type => 'ManualCPCAdGroupExperimentBidMultipliers',
79
- :max_cpc_multiplier => {
80
- :multiplier => 1.5
81
- }
82
- }
83
- }
84
- }
85
-
86
- # Prepare for updating ad group.
87
- operation = {
88
- :operator => 'SET',
89
- :operand => ad_group
90
- }
91
-
92
- # Update ad group.
93
- response = ad_group_srv.mutate([operation])
94
- ad_group = response[:value].first
95
- puts "Ad group ID %d was updated for the experiment." % ad_group[:id]
96
-
97
- # Setup ad group criterion for the experiment.
98
- ad_group_criterion = {
99
- :xsi_type => 'BiddableAdGroupCriterion',
100
- :ad_group_id => ad_group_id,
101
- :criterion => {
102
- :id => criterion_id
103
- },
104
- # Set experiment data for the criterion.
105
- :experiment_data => {
106
- :xsi_type => 'BiddableAdGroupCriterionExperimentData',
107
- :experiment_id => experiment_id,
108
- :experiment_delta_status => 'MODIFIED',
109
- # Bid multiplier rule that will modify criterion bid for the experiment.
110
- :experiment_bid_multiplier => {
111
- :xsi_type => 'ManualCPCAdGroupCriterionExperimentBidMultiplier',
112
- :max_cpc_multiplier => {
113
- :multiplier => 1.5
114
- }
115
- }
116
- }
117
- }
118
-
119
- # Prepare for updating ad group criterion.
120
- operation = {
121
- :operator => 'SET',
122
- :operand => ad_group_criterion
123
- }
124
-
125
- # Update criterion.
126
- response = ad_group_criterion_srv.mutate([operation])
127
- criterion = response[:value].first
128
- puts "Criterion ID %d was successfully updated for the experiment." %
129
- [criterion[:criterion][:id]]
130
-
131
- end
132
-
133
- if __FILE__ == $0
134
- API_VERSION = :v201306
135
-
136
- begin
137
- # IDs of the required objects.
138
- campaign_id = 'INSERT_CAMPAIGN_ID_HERE'.to_i
139
- ad_group_id = 'INSERT_AD_GROUP_ID_HERE'.to_i
140
- criterion_id = 'INSERT_CRITERION_ID_HERE'.to_i
141
- add_experiment(campaign_id, ad_group_id, criterion_id)
142
-
143
- # Authorization error.
144
- rescue AdsCommon::Errors::OAuth2VerificationRequired => e
145
- puts "Authorization credentials are not valid. Edit adwords_api.yml for " +
146
- "OAuth2 client ID and secret and run misc/setup_oauth2.rb example " +
147
- "to retrieve and store OAuth2 tokens."
148
- puts "See this wiki page for more details:\n\n " +
149
- 'http://code.google.com/p/google-api-ads-ruby/wiki/OAuth2'
150
-
151
- # HTTP errors.
152
- rescue AdsCommon::Errors::HttpError => e
153
- puts "HTTP Error: %s" % e
154
-
155
- # API errors.
156
- rescue AdwordsApi::Errors::ApiException => e
157
- puts "Message: %s" % e.message
158
- puts 'Errors:'
159
- e.errors.each_with_index do |error, index|
160
- puts "\tError [%d]:" % (index + 1)
161
- error.each do |field, value|
162
- puts "\t\t%s: %s" % [field, value]
163
- end
164
- end
165
- end
166
- end