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,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 disapproved ads in a given
20
- # ad group with AWQL. To add ads, run add_text_ads.rb.
21
-
22
- require 'adwords_api'
23
-
24
- def get_all_disapproved_ads_with_awql(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
- # Get all the disapproved ads for this campaign.
36
- query = ('SELECT Id, AdGroupAdDisapprovalReasons ' +
37
- 'WHERE AdGroupId = %d AND AdGroupCreativeApprovalStatus = DISAPPROVED ' +
38
- 'ORDER BY Id') % ad_group_id
39
-
40
- response = ad_group_ad_srv.query(query)
41
- if response and response[:entries]
42
- puts 'Ad group ID %d has %d disapproved ad(s).' %
43
- [ad_group_id, response[:total_num_entries]]
44
- response[:entries].each do |ad_group_ad|
45
- puts ("\tAd with ID %d and type '%s' was disapproved for the following " +
46
- 'reasons:') % [ad_group_ad[:ad][:id], ad_group_ad[:ad][:xsi_type]]
47
- if ad_group_ad.include?(:disapproval_reasons)
48
- ad_group_ad[:disapproval_reasons].each {|reason| puts "\t\t%s" % reason}
49
- else
50
- puts "\t\tReason not provided."
51
- end
52
- end
53
- else
54
- puts 'No disapproved ads found for ad group ID %d.' % ad_group_id
55
- end
56
- end
57
-
58
- if __FILE__ == $0
59
- API_VERSION = :v201502
60
-
61
- begin
62
- # ID of an ad group to get disapproved ads for.
63
- ad_group_id = 'INSERT_AD_GROUP_ID_HERE'.to_i
64
- get_all_disapproved_ads_with_awql(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,108 +0,0 @@
1
- #!/usr/bin/env ruby
2
- # Encoding: utf-8
3
- #
4
- # Copyright:: Copyright 2014, 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 gets all campaigns with a specific label. To add a label
20
- # to campaigns, run add_campaign_labels.rb.
21
-
22
- require 'adwords_api'
23
-
24
- def get_campaigns_by_label(label_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
- campaign_srv = adwords.service(:CampaignService, API_VERSION)
34
-
35
- # Get all the ad groups for this campaign.
36
- selector = {
37
- :fields => ['Id', 'Name', 'Labels'],
38
- :ordering => [{:field => 'Name', :sort_order => 'ASCENDING'}],
39
- :predicates => [
40
- {
41
- :field => 'Labels',
42
- # Labels filtering is performed by ID. You can use CONTAINS_ANY to
43
- # select campaigns with any of the label IDs, CONTAINS_ALL to select
44
- # campaigns with all of the label IDs, or CONTAINS_NONE to select
45
- # campaigns with none of the label IDs.
46
- :operator => 'CONTAINS_ANY',
47
- :values => [label_id]
48
- }
49
- ],
50
- :paging => {
51
- :start_index => 0,
52
- :number_results => PAGE_SIZE
53
- }
54
- }
55
-
56
- # Set initial values.
57
- offset, page = 0, {}
58
-
59
- begin
60
- page = campaign_srv.get(selector)
61
- if page[:entries]
62
- page[:entries].each do |campaign|
63
- label_string = campaign[:labels].map do |label|
64
- '%d/"%s"' % [label[:id], label[:name]]
65
- end.join(', ')
66
- puts 'Campaign found with name "%s" and ID %d and labels: %s.' %
67
- [campaign[:name], campaign[:id], label_string]
68
- end
69
- # Increment values to request the next page.
70
- offset += PAGE_SIZE
71
- selector[:paging][:start_index] = offset
72
- end
73
- end while page[:total_num_entries] > offset
74
- end
75
-
76
- if __FILE__ == $0
77
- API_VERSION = :v201502
78
- PAGE_SIZE = 500
79
-
80
- begin
81
- # Label ID to get campaigns for.
82
- label_id = 'INSERT_LABEL_ID_HERE'.to_i
83
- get_campaigns_by_label(label_id)
84
-
85
- # Authorization error.
86
- rescue AdsCommon::Errors::OAuth2VerificationRequired => e
87
- puts "Authorization credentials are not valid. Edit adwords_api.yml for " +
88
- "OAuth2 client ID and secret and run misc/setup_oauth2.rb example " +
89
- "to retrieve and store OAuth2 tokens."
90
- puts "See this wiki page for more details:\n\n " +
91
- 'http://code.google.com/p/google-api-ads-ruby/wiki/OAuth2'
92
-
93
- # HTTP errors.
94
- rescue AdsCommon::Errors::HttpError => e
95
- puts "HTTP Error: %s" % e
96
-
97
- # API errors.
98
- rescue AdwordsApi::Errors::ApiException => e
99
- puts "Message: %s" % e.message
100
- puts 'Errors:'
101
- e.errors.each_with_index do |error, index|
102
- puts "\tError [%d]:" % (index + 1)
103
- error.each do |field, value|
104
- puts "\t\t%s: %s" % [field, value]
105
- end
106
- end
107
- end
108
- end
@@ -1,81 +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 promotes an experiment, which permanently applies all the
20
- # experiment changes made to its related ad groups, criteria and ads.
21
-
22
- require 'adwords_api'
23
-
24
- def promote_experiment(experiment_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
- experiment_srv = adwords.service(:ExperimentService, API_VERSION)
34
-
35
- # Prepare for updating experiment.
36
- operation = {
37
- :operator => 'SET',
38
- :operand => {
39
- :id => experiment_id,
40
- :status => 'PROMOTED',
41
- }
42
- }
43
-
44
- # Update experiment.
45
- response = experiment_srv.mutate([operation])
46
- experiment = response[:value].first
47
- puts "Experiment with name '%s' and ID %d was promoted." %
48
- [experiment[:name], experiment[:id]]
49
- end
50
-
51
- if __FILE__ == $0
52
- API_VERSION = :v201502
53
-
54
- begin
55
- experiment_id = 'INSERT_EXPERIMENT_ID_HERE'.to_i
56
- promote_experiment(experiment_id)
57
-
58
- # Authorization error.
59
- rescue AdsCommon::Errors::OAuth2VerificationRequired => e
60
- puts "Authorization credentials are not valid. Edit adwords_api.yml for " +
61
- "OAuth2 client ID and secret and run misc/setup_oauth2.rb example " +
62
- "to retrieve and store OAuth2 tokens."
63
- puts "See this wiki page for more details:\n\n " +
64
- 'http://code.google.com/p/google-api-ads-ruby/wiki/OAuth2'
65
-
66
- # HTTP errors.
67
- rescue AdsCommon::Errors::HttpError => e
68
- puts "HTTP Error: %s" % e
69
-
70
- # API errors.
71
- rescue AdwordsApi::Errors::ApiException => e
72
- puts "Message: %s" % e.message
73
- puts 'Errors:'
74
- e.errors.each_with_index do |error, index|
75
- puts "\tError [%d]:" % (index + 1)
76
- error.each do |field, value|
77
- puts "\t\t%s: %s" % [field, value]
78
- end
79
- end
80
- end
81
- end
@@ -1,118 +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 create a text ad with ad parameters. To add an
20
- # ad group, run add_ad_group.rb. To add a keyword, run add_keywords.rb.
21
-
22
- require 'adwords_api'
23
-
24
- def set_ad_parameters(ad_group_id, criterion_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
- ad_param_srv = adwords.service(:AdParamService, API_VERSION)
35
-
36
- # Prepare for adding ad.
37
- ad_operation = {
38
- :operator => 'ADD',
39
- :operand => {
40
- :ad_group_id => ad_group_id,
41
- :ad => {
42
- # The 'xsi_type' field allows you to specify the xsi:type of the object
43
- # being created. It's only necessary when you must provide an explicit
44
- # type that the client library can't infer.
45
- :xsi_type => 'TextAd',
46
- :headline => 'Luxury Mars Cruises',
47
- :description1 => 'Low-gravity fun for {param1:cheap}.',
48
- :description2 => 'Only {param2:a few} seats left!',
49
- :final_urls => ['http://www.example.com'],
50
- :display_url => 'www.example.com'
51
- }
52
- }
53
- }
54
-
55
- # Add ad.
56
- response = ad_group_ad_srv.mutate([ad_operation])
57
- ad = response[:value].first[:ad]
58
- puts "Text ad ID %d was successfully added." % ad[:id]
59
-
60
- # Prepare for setting ad parameters.
61
- price_operation = {
62
- :operator => 'SET',
63
- :operand => {
64
- :ad_group_id => ad_group_id,
65
- :criterion_id => criterion_id,
66
- :param_index => 1,
67
- :insertion_text => '$100'
68
- }
69
- }
70
-
71
- seat_operation = {
72
- :operator => 'SET',
73
- :operand => {
74
- :ad_group_id => ad_group_id,
75
- :criterion_id => criterion_id,
76
- :param_index => 2,
77
- :insertion_text => '50'
78
- }
79
- }
80
-
81
- # Set ad parameters.
82
- response = ad_param_srv.mutate([price_operation, seat_operation])
83
- puts 'Parameters were successfully updated.'
84
- end
85
-
86
- if __FILE__ == $0
87
- API_VERSION = :v201502
88
-
89
- begin
90
- # IDs of ad group and criterion to set ad parameter for.
91
- ad_group_id = 'INSERT_AD_GROUP_ID_HERE'.to_i
92
- criterion_id = 'INSERT_CRITERION_ID_HERE'.to_i
93
- set_ad_parameters(ad_group_id, criterion_id)
94
-
95
- # Authorization error.
96
- rescue AdsCommon::Errors::OAuth2VerificationRequired => e
97
- puts "Authorization credentials are not valid. Edit adwords_api.yml for " +
98
- "OAuth2 client ID and secret and run misc/setup_oauth2.rb example " +
99
- "to retrieve and store OAuth2 tokens."
100
- puts "See this wiki page for more details:\n\n " +
101
- 'http://code.google.com/p/google-api-ads-ruby/wiki/OAuth2'
102
-
103
- # HTTP errors.
104
- rescue AdsCommon::Errors::HttpError => e
105
- puts "HTTP Error: %s" % e
106
-
107
- # API errors.
108
- rescue AdwordsApi::Errors::ApiException => e
109
- puts "Message: %s" % e.message
110
- puts 'Errors:'
111
- e.errors.each_with_index do |error, index|
112
- puts "\tError [%d]:" % (index + 1)
113
- error.each do |field, value|
114
- puts "\t\t%s: %s" % [field, value]
115
- end
116
- end
117
- end
118
- end
@@ -1,104 +0,0 @@
1
- #!/usr/bin/env ruby
2
- # Encoding: utf-8
3
- #
4
- # Copyright:: Copyright 2013, 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 sets a bid modifier for the mobile platform on given campaign.
20
- # To get campaigns, run get_campaigns.rb.
21
-
22
- require 'adwords_api'
23
-
24
- def set_criterion_bid_modifier(campaign_id, bid_modifier)
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_criterion_srv =
34
- adwords.service(:CampaignCriterionService, API_VERSION)
35
-
36
- # Create campaign criterion with modified bid.
37
- campaign_criterion = {
38
- :campaign_id => campaign_id,
39
- # Mobile platform. The ID can be found in the documentation.
40
- # https://developers.google.com/adwords/api/docs/appendix/platforms
41
- :criterion => {
42
- :xsi_type => 'Platform',
43
- :id => 30001
44
- },
45
- :bid_modifier => bid_modifier
46
- }
47
-
48
- # Create operation.
49
- operation = {
50
- :operator => 'SET',
51
- :operand => campaign_criterion
52
- }
53
-
54
- response = campaign_criterion_srv.mutate([operation])
55
-
56
- if response and response[:value]
57
- criteria = response[:value]
58
- criteria.each do |campaign_criterion|
59
- criterion = campaign_criterion[:criterion]
60
- puts ("Campaign criterion with campaign ID %d, criterion ID %d was " +
61
- "updated with bid modifier %f.") % [campaign_criterion[:campaign_id],
62
- criterion[:id], campaign_criterion[:bid_modifier]]
63
- end
64
- else
65
- puts 'No criteria were returned.'
66
- end
67
- end
68
-
69
- if __FILE__ == $0
70
- API_VERSION = :v201502
71
-
72
- begin
73
- # ID of a campaign to use mobile bid modifier for.
74
- campaign_id = 'INSERT_CAMPAIGN_ID_HERE'.to_i
75
-
76
- # Bid modifier to set.
77
- bid_modifier = 1.5
78
-
79
- set_criterion_bid_modifier(campaign_id, bid_modifier)
80
-
81
- # Authorization error.
82
- rescue AdsCommon::Errors::OAuth2VerificationRequired => e
83
- puts "Authorization credentials are not valid. Edit adwords_api.yml for " +
84
- "OAuth2 client ID and secret and run misc/setup_oauth2.rb example " +
85
- "to retrieve and store OAuth2 tokens."
86
- puts "See this wiki page for more details:\n\n " +
87
- 'http://code.google.com/p/google-api-ads-ruby/wiki/OAuth2'
88
-
89
- # HTTP errors.
90
- rescue AdsCommon::Errors::HttpError => e
91
- puts "HTTP Error: %s" % e
92
-
93
- # API errors.
94
- rescue AdwordsApi::Errors::ApiException => e
95
- puts "Message: %s" % e.message
96
- puts 'Errors:'
97
- e.errors.each_with_index do |error, index|
98
- puts "\tError [%d]:" % (index + 1)
99
- error.each do |field, value|
100
- puts "\t\t%s: %s" % [field, value]
101
- end
102
- end
103
- end
104
- end