google-adwords-api 0.7.0 → 0.7.1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (130) hide show
  1. data/ChangeLog +3 -0
  2. data/README +3 -3
  3. data/examples/v201206/basic_operations/add_campaigns.rb +7 -2
  4. data/examples/v201209/account_management/create_account.rb +84 -0
  5. data/examples/v201209/account_management/get_account_alerts.rb +111 -0
  6. data/examples/v201209/account_management/get_account_changes.rb +137 -0
  7. data/examples/v201209/account_management/get_account_hierarchy.rb +92 -0
  8. data/examples/v201209/account_management/get_client_customer_id.rb +85 -0
  9. data/examples/v201209/account_management/get_client_unit_usage.rb +87 -0
  10. data/examples/v201209/basic_operations/add_ad_groups.rb +136 -0
  11. data/examples/v201209/basic_operations/add_campaigns.rb +159 -0
  12. data/examples/v201209/basic_operations/add_keywords.rb +108 -0
  13. data/examples/v201209/basic_operations/add_text_ads.rb +105 -0
  14. data/examples/v201209/basic_operations/delete_ad.rb +85 -0
  15. data/examples/v201209/basic_operations/delete_ad_group.rb +102 -0
  16. data/examples/v201209/basic_operations/delete_campaign.rb +103 -0
  17. data/examples/v201209/basic_operations/delete_keyword.rb +90 -0
  18. data/examples/v201209/basic_operations/get_ad_groups.rb +98 -0
  19. data/examples/v201209/basic_operations/get_campaigns.rb +93 -0
  20. data/examples/v201209/basic_operations/get_campaigns_with_awql.rb +85 -0
  21. data/examples/v201209/basic_operations/get_keywords.rb +104 -0
  22. data/examples/v201209/basic_operations/get_text_ads.rb +106 -0
  23. data/examples/v201209/basic_operations/pause_ad.rb +84 -0
  24. data/examples/v201209/basic_operations/update_ad_group.rb +81 -0
  25. data/examples/v201209/basic_operations/update_campaign.rb +82 -0
  26. data/examples/v201209/basic_operations/update_keyword.rb +99 -0
  27. data/examples/v201209/campaign_management/add_experiment.rb +158 -0
  28. data/examples/v201209/campaign_management/add_keywords_in_bulk.rb +150 -0
  29. data/examples/v201209/campaign_management/add_location_extension.rb +117 -0
  30. data/examples/v201209/campaign_management/add_location_extension_override.rb +83 -0
  31. data/examples/v201209/campaign_management/get_all_disapproved_ads.rb +93 -0
  32. data/examples/v201209/campaign_management/get_all_disapproved_ads_with_awql.rb +84 -0
  33. data/examples/v201209/campaign_management/promote_experiment.rb +77 -0
  34. data/examples/v201209/campaign_management/set_ad_parameters.rb +114 -0
  35. data/examples/v201209/campaign_management/validate_text_ad.rb +106 -0
  36. data/examples/v201209/error_handling/handle_captcha_challenge.rb +93 -0
  37. data/examples/v201209/error_handling/handle_partial_failures.rb +126 -0
  38. data/examples/v201209/error_handling/handle_policy_violation_error.rb +137 -0
  39. data/examples/v201209/error_handling/handle_two_factor_authorization_error.rb +87 -0
  40. data/examples/v201209/misc/get_all_images_and_videos.rb +100 -0
  41. data/examples/v201209/misc/upload_image.rb +89 -0
  42. data/examples/v201209/misc/use_oauth.rb +100 -0
  43. data/examples/v201209/misc/use_oauth2.rb +97 -0
  44. data/examples/v201209/optimization/estimate_keyword_traffic.rb +129 -0
  45. data/examples/v201209/optimization/get_keyword_bid_simulations.rb +92 -0
  46. data/examples/v201209/optimization/get_keyword_ideas.rb +114 -0
  47. data/examples/v201209/optimization/get_placement_ideas.rb +104 -0
  48. data/examples/v201209/remarketing/add_audience.rb +115 -0
  49. data/examples/v201209/remarketing/add_conversion_tracker.rb +97 -0
  50. data/examples/v201209/reporting/download_criteria_report.rb +79 -0
  51. data/examples/v201209/reporting/download_criteria_report_with_awql.rb +78 -0
  52. data/examples/v201209/reporting/get_campaign_stats.rb +105 -0
  53. data/examples/v201209/reporting/get_report_fields.rb +71 -0
  54. data/examples/v201209/reporting/parallel_report_download.rb +160 -0
  55. data/examples/v201209/targeting/add_campaign_targeting_criteria.rb +118 -0
  56. data/examples/v201209/targeting/add_demographic_targeting_criteria.rb +108 -0
  57. data/examples/v201209/targeting/get_campaign_targeting_criteria.rb +102 -0
  58. data/examples/v201209/targeting/get_targetable_languages_and_carriers.rb +86 -0
  59. data/examples/v201209/targeting/lookup_location.rb +104 -0
  60. data/lib/adwords_api/api_config.rb +64 -5
  61. data/lib/adwords_api/errors.rb +15 -0
  62. data/lib/adwords_api/report_utils.rb +30 -11
  63. data/lib/adwords_api/v201209/ad_extension_override_service.rb +38 -0
  64. data/lib/adwords_api/v201209/ad_extension_override_service_registry.rb +46 -0
  65. data/lib/adwords_api/v201209/ad_group_ad_service.rb +42 -0
  66. data/lib/adwords_api/v201209/ad_group_ad_service_registry.rb +46 -0
  67. data/lib/adwords_api/v201209/ad_group_criterion_service.rb +42 -0
  68. data/lib/adwords_api/v201209/ad_group_criterion_service_registry.rb +46 -0
  69. data/lib/adwords_api/v201209/ad_group_service.rb +42 -0
  70. data/lib/adwords_api/v201209/ad_group_service_registry.rb +46 -0
  71. data/lib/adwords_api/v201209/ad_param_service.rb +38 -0
  72. data/lib/adwords_api/v201209/ad_param_service_registry.rb +46 -0
  73. data/lib/adwords_api/v201209/alert_service.rb +34 -0
  74. data/lib/adwords_api/v201209/alert_service_registry.rb +46 -0
  75. data/lib/adwords_api/v201209/budget_order_service.rb +42 -0
  76. data/lib/adwords_api/v201209/budget_order_service_registry.rb +46 -0
  77. data/lib/adwords_api/v201209/budget_service.rb +38 -0
  78. data/lib/adwords_api/v201209/budget_service_registry.rb +46 -0
  79. data/lib/adwords_api/v201209/campaign_ad_extension_service.rb +38 -0
  80. data/lib/adwords_api/v201209/campaign_ad_extension_service_registry.rb +46 -0
  81. data/lib/adwords_api/v201209/campaign_criterion_service.rb +42 -0
  82. data/lib/adwords_api/v201209/campaign_criterion_service_registry.rb +46 -0
  83. data/lib/adwords_api/v201209/campaign_service.rb +42 -0
  84. data/lib/adwords_api/v201209/campaign_service_registry.rb +46 -0
  85. data/lib/adwords_api/v201209/constant_data_service.rb +62 -0
  86. data/lib/adwords_api/v201209/constant_data_service_registry.rb +46 -0
  87. data/lib/adwords_api/v201209/conversion_tracker_service.rb +38 -0
  88. data/lib/adwords_api/v201209/conversion_tracker_service_registry.rb +46 -0
  89. data/lib/adwords_api/v201209/customer_service.rb +34 -0
  90. data/lib/adwords_api/v201209/customer_service_registry.rb +46 -0
  91. data/lib/adwords_api/v201209/customer_sync_service.rb +34 -0
  92. data/lib/adwords_api/v201209/customer_sync_service_registry.rb +47 -0
  93. data/lib/adwords_api/v201209/data_service.rb +38 -0
  94. data/lib/adwords_api/v201209/data_service_registry.rb +46 -0
  95. data/lib/adwords_api/v201209/experiment_service.rb +38 -0
  96. data/lib/adwords_api/v201209/experiment_service_registry.rb +46 -0
  97. data/lib/adwords_api/v201209/geo_location_service.rb +34 -0
  98. data/lib/adwords_api/v201209/geo_location_service_registry.rb +46 -0
  99. data/lib/adwords_api/v201209/info_service.rb +34 -0
  100. data/lib/adwords_api/v201209/info_service_registry.rb +46 -0
  101. data/lib/adwords_api/v201209/location_criterion_service.rb +34 -0
  102. data/lib/adwords_api/v201209/location_criterion_service_registry.rb +46 -0
  103. data/lib/adwords_api/v201209/managed_customer_service.rb +38 -0
  104. data/lib/adwords_api/v201209/managed_customer_service_registry.rb +46 -0
  105. data/lib/adwords_api/v201209/media_service.rb +38 -0
  106. data/lib/adwords_api/v201209/media_service_registry.rb +46 -0
  107. data/lib/adwords_api/v201209/mutate_job_service.rb +42 -0
  108. data/lib/adwords_api/v201209/mutate_job_service_registry.rb +46 -0
  109. data/lib/adwords_api/v201209/report_definition_service.rb +34 -0
  110. data/lib/adwords_api/v201209/report_definition_service_registry.rb +46 -0
  111. data/lib/adwords_api/v201209/targeting_idea_service.rb +38 -0
  112. data/lib/adwords_api/v201209/targeting_idea_service_registry.rb +46 -0
  113. data/lib/adwords_api/v201209/traffic_estimator_service.rb +34 -0
  114. data/lib/adwords_api/v201209/traffic_estimator_service_registry.rb +46 -0
  115. data/lib/adwords_api/v201209/user_list_service.rb +38 -0
  116. data/lib/adwords_api/v201209/user_list_service_registry.rb +46 -0
  117. data/lib/adwords_api/version.rb +1 -1
  118. data/test/adwords_api/test_report_utils.rb +94 -6
  119. data/test/examples/v201209/test_account_management.rb +60 -0
  120. data/test/examples/v201209/test_basic_operations.rb +177 -0
  121. data/test/examples/v201209/test_campaign_management.rb +124 -0
  122. data/test/examples/v201209/test_error_handling.rb +63 -0
  123. data/test/examples/v201209/test_misc.rb +45 -0
  124. data/test/examples/v201209/test_optimization.rb +63 -0
  125. data/test/examples/v201209/test_remarketing.rb +39 -0
  126. data/test/examples/v201209/test_reporting.rb +84 -0
  127. data/test/examples/v201209/test_targeting.rb +60 -0
  128. data/test/examples/v201209/utils.rb +238 -0
  129. data/test/suite_exampletests_v201209.rb +37 -0
  130. metadata +123 -2
@@ -0,0 +1,93 @@
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 retrieve all the disapproved ads in a given
22
+ # ad group. To add ads, run add_text_ads.rb.
23
+ #
24
+ # Tags: AdGroupAdService.get
25
+
26
+ require 'adwords_api'
27
+
28
+ def get_all_disapproved_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
+ # Get all the disapproved ads for this campaign.
40
+ selector = {
41
+ :fields => ['Id', 'DisapprovalReasons'],
42
+ :ordering => [{:field => 'Id', :sort_order => 'ASCENDING'}],
43
+ :predicates => [
44
+ {:field => 'AdGroupId', :operator => 'IN', :values => [ad_group_id]},
45
+ {
46
+ :field => 'AdGroupCreativeApprovalStatus',
47
+ :operator => 'IN',
48
+ :values => ['DISAPPROVED']
49
+ }
50
+ ]
51
+ }
52
+ response = ad_group_ad_srv.get(selector)
53
+ if response and response[:entries]
54
+ ad_group_ads = response[:entries]
55
+ puts "Ad group ##{ad_group_id} has #{ad_group_ads.length} " +
56
+ "disapproved ad(s)."
57
+ ad_group_ads.each do |ad_group_ad|
58
+ puts " Ad with id #{ad_group_ad[:ad][:id]} and type " +
59
+ "#{ad_group_ad[:ad][:xsi_type]} was disapproved for the following " +
60
+ "reasons:"
61
+ ad_group_ad[:ad][:disapproval_reasons].each do |reason|
62
+ puts " #{reason}"
63
+ end
64
+ end
65
+ else
66
+ puts "No disapproved ads found for ad group ##{ad_group_id}."
67
+ end
68
+ end
69
+
70
+ if __FILE__ == $0
71
+ API_VERSION = :v201209
72
+
73
+ begin
74
+ # ID of an ad group to get disapproved ads for.
75
+ ad_group_id = 'INSERT_AD_GROUP_ID_HERE'.to_i
76
+ get_all_disapproved_ads(ad_group_id)
77
+
78
+ # HTTP errors.
79
+ rescue AdsCommon::Errors::HttpError => e
80
+ puts "HTTP Error: %s" % e
81
+
82
+ # API errors.
83
+ rescue AdwordsApi::Errors::ApiException => e
84
+ puts "Message: %s" % e.message
85
+ puts 'Errors:'
86
+ e.errors.each_with_index do |error, index|
87
+ puts "\tError [%d]:" % (index + 1)
88
+ error.each do |field, value|
89
+ puts "\t\t%s: %s" % [field, value]
90
+ end
91
+ end
92
+ end
93
+ end
@@ -0,0 +1,84 @@
1
+ #!/usr/bin/env ruby
2
+ # Encoding: utf-8
3
+ #
4
+ # Author:: api.dklimkin@gmail.com (Danial Klimkin)
5
+ #
6
+ # Copyright:: Copyright 2012, Google Inc. All Rights Reserved.
7
+ #
8
+ # License:: Licensed under the Apache License, Version 2.0 (the "License");
9
+ # you may not use this file except in compliance with the License.
10
+ # You may obtain a copy of the License at
11
+ #
12
+ # http://www.apache.org/licenses/LICENSE-2.0
13
+ #
14
+ # Unless required by applicable law or agreed to in writing, software
15
+ # distributed under the License is distributed on an "AS IS" BASIS,
16
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
17
+ # implied.
18
+ # See the License for the specific language governing permissions and
19
+ # limitations under the License.
20
+ #
21
+ # This example illustrates how to retrieve all the disapproved ads in a given
22
+ # ad group with AWQL. To add ads, run add_text_ads.rb.
23
+ #
24
+ # Tags: AdGroupAdService.query
25
+
26
+ require 'adwords_api'
27
+
28
+ def get_all_disapproved_ads_with_awql(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
+ # Get all the disapproved ads for this campaign.
40
+ query = ('SELECT Id, DisapprovalReasons ' +
41
+ 'WHERE AdGroupId = %d AND AdGroupCreativeApprovalStatus = DISAPPROVED ' +
42
+ 'ORDER BY Id') % ad_group_id
43
+
44
+ response = ad_group_ad_srv.query(query)
45
+ if response and response[:entries]
46
+ ad_group_ads = response[:entries]
47
+ puts 'Ad group ID %d has %d disapproved ad(s).' %
48
+ [ad_group_id, ad_group_ads.length]
49
+ ad_group_ads.each do |ad_group_ad|
50
+ puts ("\tAd with ID %d and type '%s' was disapproved for the following " +
51
+ + 'reasons:') % [ad_group_ad[:ad][:id], ad_group_ad[:ad][:xsi_type]]
52
+ ad_group_ad[:ad][:disapproval_reasons].each do |reason|
53
+ puts "\t\t%s" % reason
54
+ end
55
+ end
56
+ else
57
+ puts 'No disapproved ads found for ad group ID %d.' % ad_group_id
58
+ end
59
+ end
60
+
61
+ if __FILE__ == $0
62
+ API_VERSION = :v201209
63
+
64
+ begin
65
+ # ID of an ad group to get disapproved ads for.
66
+ ad_group_id = 'INSERT_AD_GROUP_ID_HERE'.to_i
67
+ get_all_disapproved_ads_with_awql(ad_group_id)
68
+
69
+ # HTTP errors.
70
+ rescue AdsCommon::Errors::HttpError => e
71
+ puts 'HTTP Error: %s' % e
72
+
73
+ # API errors.
74
+ rescue AdwordsApi::Errors::ApiException => e
75
+ puts 'Message: %s' % e.message
76
+ puts 'Errors:'
77
+ e.errors.each_with_index do |error, index|
78
+ puts "\tError [%d]:" % (index + 1)
79
+ error.each do |field, value|
80
+ puts "\t\t%s: %s" % [field, value]
81
+ end
82
+ end
83
+ end
84
+ end
@@ -0,0 +1,77 @@
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 promotes an experiment, which permanently applies all the
22
+ # experiment changes made to its related ad groups, criteria and ads.
23
+ #
24
+ # Tags: ExperimentService.mutate
25
+
26
+ require 'adwords_api'
27
+
28
+ def promote_experiment(experiment_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
+ experiment_srv = adwords.service(:ExperimentService, API_VERSION)
38
+
39
+ # Prepare for updating experiment.
40
+ operation = {
41
+ :operator => 'SET',
42
+ :operand => {
43
+ :id => experiment_id,
44
+ :status => 'PROMOTED',
45
+ }
46
+ }
47
+
48
+ # Update experiment.
49
+ response = experiment_srv.mutate([operation])
50
+ experiment = response[:value].first
51
+ puts "Experiment with name '%s' and ID %d was promoted." %
52
+ [experiment[:name], experiment[:id]]
53
+ end
54
+
55
+ if __FILE__ == $0
56
+ API_VERSION = :v201209
57
+
58
+ begin
59
+ experiment_id = 'INSERT_EXPERIMENT_ID_HERE'.to_i
60
+ promote_experiment(experiment_id)
61
+
62
+ # HTTP errors.
63
+ rescue AdsCommon::Errors::HttpError => e
64
+ puts "HTTP Error: %s" % e
65
+
66
+ # API errors.
67
+ rescue AdwordsApi::Errors::ApiException => e
68
+ puts "Message: %s" % e.message
69
+ puts 'Errors:'
70
+ e.errors.each_with_index do |error, index|
71
+ puts "\tError [%d]:" % (index + 1)
72
+ error.each do |field, value|
73
+ puts "\t\t%s: %s" % [field, value]
74
+ end
75
+ end
76
+ end
77
+ end
@@ -0,0 +1,114 @@
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 create a text ad with ad parameters. To add an
22
+ # ad group, run add_ad_group.rb. To add a keyword, run add_keywords.rb.
23
+ #
24
+ # Tags: AdGroupAdService.mutate, AdParamService.mutate
25
+
26
+ require 'adwords_api'
27
+
28
+ def set_ad_parameters(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_ad_srv = adwords.service(:AdGroupAdService, API_VERSION)
38
+ ad_param_srv = adwords.service(:AdParamService, API_VERSION)
39
+
40
+ # Prepare for adding ad.
41
+ ad_operation = {
42
+ :operator => 'ADD',
43
+ :operand => {
44
+ :ad_group_id => ad_group_id,
45
+ :ad => {
46
+ # The 'xsi_type' field allows you to specify the xsi:type of the object
47
+ # being created. It's only necessary when you must provide an explicit
48
+ # type that the client library can't infer.
49
+ :xsi_type => 'TextAd',
50
+ :headline => 'Luxury Mars Cruises',
51
+ :description1 => 'Low-gravity fun for {param1:cheap}.',
52
+ :description2 => 'Only {param2:a few} seats left!',
53
+ :url => 'http://www.example.com',
54
+ :display_url => 'www.example.com'
55
+ }
56
+ }
57
+ }
58
+
59
+ # Add ad.
60
+ response = ad_group_ad_srv.mutate([ad_operation])
61
+ ad = response[:value].first[:ad]
62
+ puts "Text ad ID %d was successfully added." % ad[:id]
63
+
64
+ # Prepare for setting ad parameters.
65
+ price_operation = {
66
+ :operator => 'SET',
67
+ :operand => {
68
+ :ad_group_id => ad_group_id,
69
+ :criterion_id => criterion_id,
70
+ :param_index => 1,
71
+ :insertion_text => '$100'
72
+ }
73
+ }
74
+
75
+ seat_operation = {
76
+ :operator => 'SET',
77
+ :operand => {
78
+ :ad_group_id => ad_group_id,
79
+ :criterion_id => criterion_id,
80
+ :param_index => 2,
81
+ :insertion_text => '50'
82
+ }
83
+ }
84
+
85
+ # Set ad parameters.
86
+ response = ad_param_srv.mutate([price_operation, seat_operation])
87
+ puts 'Parameters were successfully updated.'
88
+ end
89
+
90
+ if __FILE__ == $0
91
+ API_VERSION = :v201209
92
+
93
+ begin
94
+ # IDs of ad group and criterion to set ad parameter for.
95
+ ad_group_id = 'INSERT_AD_GROUP_ID_HERE'.to_i
96
+ criterion_id = 'INSERT_CRITERION_ID_HERE'.to_i
97
+ set_ad_parameters(ad_group_id, criterion_id)
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
@@ -0,0 +1,106 @@
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 shows how to use the 'validate only' header. No objects will be
22
+ # created, but exceptions will still be thrown.
23
+ #
24
+ # Tags: CampaignService.mutate
25
+
26
+ require 'adwords_api'
27
+
28
+ def validate_text_ad(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
+ # Enable 'validate only' option.
40
+ adwords.validate_only = true
41
+
42
+ # Prepare for adding text ad.
43
+ operation = {
44
+ :operator => 'ADD',
45
+ :operand => {
46
+ :ad_group_id => ad_group_id,
47
+ :ad => {
48
+ :xsi_type => 'TextAd',
49
+ :headline => 'Luxury Cruise to Mars',
50
+ :description1 => 'Visit the Red Planet in style.',
51
+ :description2 => 'Low-gravity fun for everyone!',
52
+ :url => 'http://www.example.com',
53
+ :display_url => 'www.example.com'
54
+ }
55
+ }
56
+ }
57
+
58
+ # Validate text ad add operation.
59
+ response = ad_group_ad_srv.mutate([operation])
60
+ if response and response[:value]
61
+ ad = response[:value].first
62
+ puts "Unexpected ad creation! Name '%s', ID %d and status '%s'." %
63
+ [campaign[:name], campaign[:id], campaign[:status]]
64
+ else
65
+ puts 'Text ad validated, no error thrown and no ad created.'
66
+ end
67
+
68
+ # Now let's check an invalid ad using extra punctuation to trigger an error.
69
+ operation[:operand][:ad][:headline] = 'Luxury Cruise to Mars!!!!!'
70
+
71
+ # Validate text ad add operation.
72
+ begin
73
+ response = ad_group_ad_srv.mutate([operation])
74
+ if response and response[:value]
75
+ ad = response[:value].first
76
+ raise StandardError, ("Unexpected ad creation! Name '%s', ID %d and " +
77
+ "status '%s'.") % [campaign[:name], campaign[:id], campaign[:status]]
78
+ end
79
+ rescue AdwordsApi::Errors::ApiException => e
80
+ puts "Validation correctly failed with an exception: %s" % e.class
81
+ end
82
+ end
83
+
84
+ if __FILE__ == $0
85
+ API_VERSION = :v201209
86
+
87
+ begin
88
+ ad_group_id = 'INSERT_AD_GROUP_ID_HERE'.to_i
89
+ validate_text_ad(ad_group_id)
90
+
91
+ # HTTP errors.
92
+ rescue AdsCommon::Errors::HttpError => e
93
+ puts "HTTP Error: %s" % e
94
+
95
+ # API errors.
96
+ rescue AdwordsApi::Errors::ApiException => e
97
+ puts "Message: %s" % e.message
98
+ puts 'Errors:'
99
+ e.errors.each_with_index do |error, index|
100
+ puts "\tError [%d]:" % (index + 1)
101
+ error.each do |field, value|
102
+ puts "\t\t%s: %s" % [field, value]
103
+ end
104
+ end
105
+ end
106
+ end