google-adwords-api 0.20.1 → 0.21.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (175) hide show
  1. checksums.yaml +4 -4
  2. data/ChangeLog +4 -0
  3. data/README.md +3 -3
  4. data/examples/v201607/campaign_management/add_draft.rb +0 -1
  5. data/examples/v201607/campaign_management/add_trial.rb +0 -1
  6. data/examples/v201607/extensions/add_prices.rb +42 -44
  7. data/lib/adwords_api/api_config.rb +0 -86
  8. data/lib/adwords_api/credential_handler.rb +4 -0
  9. data/lib/adwords_api/errors.rb +11 -0
  10. data/lib/adwords_api/version.rb +1 -1
  11. data/test/adwords_api/test_credential_handler.rb +1 -1
  12. metadata +2 -165
  13. data/examples/v201601/account_management/create_account.rb +0 -88
  14. data/examples/v201601/account_management/get_account_changes.rb +0 -139
  15. data/examples/v201601/account_management/get_account_hierarchy.rb +0 -132
  16. data/examples/v201601/advanced_operations/add_ad_customizers.rb +0 -184
  17. data/examples/v201601/advanced_operations/add_ad_group_bid_modifier.rb +0 -101
  18. data/examples/v201601/advanced_operations/add_click_to_download_ad.rb +0 -133
  19. data/examples/v201601/advanced_operations/add_html5_ad.rb +0 -137
  20. data/examples/v201601/advanced_operations/add_text_ad_with_upgraded_urls.rb +0 -134
  21. data/examples/v201601/advanced_operations/create_and_attach_shared_keyword_set.rb +0 -141
  22. data/examples/v201601/advanced_operations/find_and_remove_criteria_from_shared_set.rb +0 -174
  23. data/examples/v201601/advanced_operations/get_ad_group_bid_modifiers.rb +0 -102
  24. data/examples/v201601/advanced_operations/use_shared_bidding_strategy.rb +0 -147
  25. data/examples/v201601/basic_operations/add_ad_groups.rb +0 -142
  26. data/examples/v201601/basic_operations/add_campaigns.rb +0 -139
  27. data/examples/v201601/basic_operations/add_keywords.rb +0 -114
  28. data/examples/v201601/basic_operations/add_text_ads.rb +0 -109
  29. data/examples/v201601/basic_operations/get_ad_groups.rb +0 -102
  30. data/examples/v201601/basic_operations/get_campaigns.rb +0 -97
  31. data/examples/v201601/basic_operations/get_campaigns_with_awql.rb +0 -89
  32. data/examples/v201601/basic_operations/get_keywords.rb +0 -109
  33. data/examples/v201601/basic_operations/get_text_ads.rb +0 -110
  34. data/examples/v201601/basic_operations/pause_ad.rb +0 -88
  35. data/examples/v201601/basic_operations/remove_ad.rb +0 -89
  36. data/examples/v201601/basic_operations/remove_ad_group.rb +0 -85
  37. data/examples/v201601/basic_operations/remove_campaign.rb +0 -87
  38. data/examples/v201601/basic_operations/remove_keyword.rb +0 -94
  39. data/examples/v201601/basic_operations/update_ad_group.rb +0 -85
  40. data/examples/v201601/basic_operations/update_campaign.rb +0 -86
  41. data/examples/v201601/basic_operations/update_keyword.rb +0 -106
  42. data/examples/v201601/campaign_management/add_campaign_labels.rb +0 -82
  43. data/examples/v201601/campaign_management/add_complete_campaigns_using_batch_job.rb +0 -356
  44. data/examples/v201601/campaign_management/add_experiment.rb +0 -162
  45. data/examples/v201601/campaign_management/add_keywords_in_bulk.rb +0 -153
  46. data/examples/v201601/campaign_management/add_keywords_using_incremental_batch_job.rb +0 -179
  47. data/examples/v201601/campaign_management/get_all_disapproved_ads.rb +0 -97
  48. data/examples/v201601/campaign_management/get_all_disapproved_ads_with_awql.rb +0 -89
  49. data/examples/v201601/campaign_management/get_campaigns_by_label.rb +0 -108
  50. data/examples/v201601/campaign_management/promote_experiment.rb +0 -81
  51. data/examples/v201601/campaign_management/set_ad_parameters.rb +0 -118
  52. data/examples/v201601/campaign_management/set_criterion_bid_modifier.rb +0 -104
  53. data/examples/v201601/campaign_management/validate_text_ad.rb +0 -110
  54. data/examples/v201601/error_handling/handle_partial_failures.rb +0 -130
  55. data/examples/v201601/error_handling/handle_policy_violation_error.rb +0 -141
  56. data/examples/v201601/extensions/add_google_my_business_location_extensions.rb +0 -193
  57. data/examples/v201601/extensions/add_site_links.rb +0 -164
  58. data/examples/v201601/extensions/add_site_links_using_feeds.rb +0 -281
  59. data/examples/v201601/migration/migrate_to_extension_settings.rb +0 -386
  60. data/examples/v201601/migration/upgrade_ad_url.rb +0 -93
  61. data/examples/v201601/misc/get_all_images_and_videos.rb +0 -104
  62. data/examples/v201601/misc/setup_oauth2.rb +0 -84
  63. data/examples/v201601/misc/upload_image.rb +0 -93
  64. data/examples/v201601/misc/upload_media_bundle.rb +0 -90
  65. data/examples/v201601/misc/use_oauth2_jwt.rb +0 -93
  66. data/examples/v201601/misc/use_runtime_config.rb +0 -92
  67. data/examples/v201601/optimization/estimate_keyword_traffic.rb +0 -146
  68. data/examples/v201601/optimization/get_keyword_bid_simulations.rb +0 -95
  69. data/examples/v201601/optimization/get_keyword_ideas.rb +0 -126
  70. data/examples/v201601/remarketing/add_audience.rb +0 -118
  71. data/examples/v201601/remarketing/add_conversion_tracker.rb +0 -97
  72. data/examples/v201601/remarketing/add_crm_based_user_list.rb +0 -119
  73. data/examples/v201601/remarketing/add_rule_based_user_lists.rb +0 -167
  74. data/examples/v201601/remarketing/upload_offline_conversions.rb +0 -98
  75. data/examples/v201601/reporting/download_criteria_report.rb +0 -92
  76. data/examples/v201601/reporting/download_criteria_report_with_awql.rb +0 -93
  77. data/examples/v201601/reporting/get_report_fields.rb +0 -75
  78. data/examples/v201601/reporting/parallel_report_download.rb +0 -164
  79. data/examples/v201601/reporting/stream_criteria_report_results.rb +0 -97
  80. data/examples/v201601/shopping_campaigns/add_product_partition_tree.rb +0 -267
  81. data/examples/v201601/shopping_campaigns/add_product_scope.rb +0 -129
  82. data/examples/v201601/shopping_campaigns/add_shopping_campaign.rb +0 -129
  83. data/examples/v201601/shopping_campaigns/get_product_category_taxonomy.rb +0 -115
  84. data/examples/v201601/targeting/add_campaign_targeting_criteria.rb +0 -180
  85. data/examples/v201601/targeting/add_demographic_targeting_criteria.rb +0 -112
  86. data/examples/v201601/targeting/get_campaign_targeting_criteria.rb +0 -106
  87. data/examples/v201601/targeting/get_targetable_languages_and_carriers.rb +0 -89
  88. data/examples/v201601/targeting/lookup_location.rb +0 -108
  89. data/examples/v201605/migration/upgrade_ad_url.rb +0 -93
  90. data/examples/v201607/migration/upgrade_ad_url.rb +0 -93
  91. data/lib/adwords_api/v201601/account_label_service.rb +0 -46
  92. data/lib/adwords_api/v201601/account_label_service_registry.rb +0 -46
  93. data/lib/adwords_api/v201601/ad_customizer_feed_service.rb +0 -46
  94. data/lib/adwords_api/v201601/ad_customizer_feed_service_registry.rb +0 -46
  95. data/lib/adwords_api/v201601/ad_group_ad_service.rb +0 -70
  96. data/lib/adwords_api/v201601/ad_group_ad_service_registry.rb +0 -46
  97. data/lib/adwords_api/v201601/ad_group_bid_modifier_service.rb +0 -54
  98. data/lib/adwords_api/v201601/ad_group_bid_modifier_service_registry.rb +0 -46
  99. data/lib/adwords_api/v201601/ad_group_criterion_service.rb +0 -62
  100. data/lib/adwords_api/v201601/ad_group_criterion_service_registry.rb +0 -46
  101. data/lib/adwords_api/v201601/ad_group_extension_setting_service.rb +0 -54
  102. data/lib/adwords_api/v201601/ad_group_extension_setting_service_registry.rb +0 -46
  103. data/lib/adwords_api/v201601/ad_group_feed_service.rb +0 -54
  104. data/lib/adwords_api/v201601/ad_group_feed_service_registry.rb +0 -46
  105. data/lib/adwords_api/v201601/ad_group_service.rb +0 -62
  106. data/lib/adwords_api/v201601/ad_group_service_registry.rb +0 -46
  107. data/lib/adwords_api/v201601/ad_param_service.rb +0 -46
  108. data/lib/adwords_api/v201601/ad_param_service_registry.rb +0 -46
  109. data/lib/adwords_api/v201601/adwords_user_list_service.rb +0 -54
  110. data/lib/adwords_api/v201601/adwords_user_list_service_registry.rb +0 -46
  111. data/lib/adwords_api/v201601/batch_job_service.rb +0 -54
  112. data/lib/adwords_api/v201601/batch_job_service_registry.rb +0 -46
  113. data/lib/adwords_api/v201601/bidding_strategy_service.rb +0 -54
  114. data/lib/adwords_api/v201601/bidding_strategy_service_registry.rb +0 -46
  115. data/lib/adwords_api/v201601/budget_order_service.rb +0 -54
  116. data/lib/adwords_api/v201601/budget_order_service_registry.rb +0 -46
  117. data/lib/adwords_api/v201601/budget_service.rb +0 -54
  118. data/lib/adwords_api/v201601/budget_service_registry.rb +0 -46
  119. data/lib/adwords_api/v201601/campaign_criterion_service.rb +0 -54
  120. data/lib/adwords_api/v201601/campaign_criterion_service_registry.rb +0 -46
  121. data/lib/adwords_api/v201601/campaign_extension_setting_service.rb +0 -54
  122. data/lib/adwords_api/v201601/campaign_extension_setting_service_registry.rb +0 -46
  123. data/lib/adwords_api/v201601/campaign_feed_service.rb +0 -54
  124. data/lib/adwords_api/v201601/campaign_feed_service_registry.rb +0 -46
  125. data/lib/adwords_api/v201601/campaign_service.rb +0 -62
  126. data/lib/adwords_api/v201601/campaign_service_registry.rb +0 -46
  127. data/lib/adwords_api/v201601/campaign_shared_set_service.rb +0 -54
  128. data/lib/adwords_api/v201601/campaign_shared_set_service_registry.rb +0 -46
  129. data/lib/adwords_api/v201601/constant_data_service.rb +0 -110
  130. data/lib/adwords_api/v201601/constant_data_service_registry.rb +0 -46
  131. data/lib/adwords_api/v201601/conversion_tracker_service.rb +0 -54
  132. data/lib/adwords_api/v201601/conversion_tracker_service_registry.rb +0 -46
  133. data/lib/adwords_api/v201601/customer_extension_setting_service.rb +0 -54
  134. data/lib/adwords_api/v201601/customer_extension_setting_service_registry.rb +0 -46
  135. data/lib/adwords_api/v201601/customer_feed_service.rb +0 -54
  136. data/lib/adwords_api/v201601/customer_feed_service_registry.rb +0 -46
  137. data/lib/adwords_api/v201601/customer_service.rb +0 -54
  138. data/lib/adwords_api/v201601/customer_service_registry.rb +0 -46
  139. data/lib/adwords_api/v201601/customer_sync_service.rb +0 -38
  140. data/lib/adwords_api/v201601/customer_sync_service_registry.rb +0 -47
  141. data/lib/adwords_api/v201601/data_service.rb +0 -78
  142. data/lib/adwords_api/v201601/data_service_registry.rb +0 -46
  143. data/lib/adwords_api/v201601/experiment_service.rb +0 -46
  144. data/lib/adwords_api/v201601/experiment_service_registry.rb +0 -46
  145. data/lib/adwords_api/v201601/feed_item_service.rb +0 -54
  146. data/lib/adwords_api/v201601/feed_item_service_registry.rb +0 -46
  147. data/lib/adwords_api/v201601/feed_mapping_service.rb +0 -54
  148. data/lib/adwords_api/v201601/feed_mapping_service_registry.rb +0 -46
  149. data/lib/adwords_api/v201601/feed_service.rb +0 -54
  150. data/lib/adwords_api/v201601/feed_service_registry.rb +0 -46
  151. data/lib/adwords_api/v201601/label_service.rb +0 -54
  152. data/lib/adwords_api/v201601/label_service_registry.rb +0 -46
  153. data/lib/adwords_api/v201601/location_criterion_service.rb +0 -46
  154. data/lib/adwords_api/v201601/location_criterion_service_registry.rb +0 -46
  155. data/lib/adwords_api/v201601/managed_customer_service.rb +0 -78
  156. data/lib/adwords_api/v201601/managed_customer_service_registry.rb +0 -46
  157. data/lib/adwords_api/v201601/media_service.rb +0 -54
  158. data/lib/adwords_api/v201601/media_service_registry.rb +0 -46
  159. data/lib/adwords_api/v201601/mutate_job_service.rb +0 -54
  160. data/lib/adwords_api/v201601/mutate_job_service_registry.rb +0 -46
  161. data/lib/adwords_api/v201601/offline_conversion_feed_service.rb +0 -38
  162. data/lib/adwords_api/v201601/offline_conversion_feed_service_registry.rb +0 -46
  163. data/lib/adwords_api/v201601/report_definition_service.rb +0 -38
  164. data/lib/adwords_api/v201601/report_definition_service_registry.rb +0 -46
  165. data/lib/adwords_api/v201601/shared_criterion_service.rb +0 -54
  166. data/lib/adwords_api/v201601/shared_criterion_service_registry.rb +0 -46
  167. data/lib/adwords_api/v201601/shared_set_service.rb +0 -54
  168. data/lib/adwords_api/v201601/shared_set_service_registry.rb +0 -46
  169. data/lib/adwords_api/v201601/targeting_idea_service.rb +0 -38
  170. data/lib/adwords_api/v201601/targeting_idea_service_registry.rb +0 -46
  171. data/lib/adwords_api/v201601/traffic_estimator_service.rb +0 -38
  172. data/lib/adwords_api/v201601/traffic_estimator_service_registry.rb +0 -46
  173. data/test/templates/v201601/basic_operations_get_campaigns.def +0 -116
  174. data/test/templates/v201601/basic_operations_update_keyword.def +0 -125
  175. data/test/templates/v201601/misc_use_oauth2_jwt.def +0 -131
@@ -1,101 +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 illustrates how to add an ad group level mobile bid modifier
20
- # override for a campaign.
21
-
22
- require 'adwords_api'
23
-
24
- def add_ad_group_bid_modifier(ad_group_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
- bid_modifier_srv = adwords.service(:AdGroupBidModifierService, API_VERSION)
34
-
35
- # Mobile criterion ID.
36
- criterion_id = 30001
37
-
38
- # Prepare to add an ad group level override.
39
- operation = {
40
- # Use 'ADD' to add a new modifier and 'SET' to update an existing one. A
41
- # modifier can be removed with the 'REMOVE' operator.
42
- :operator => 'ADD',
43
- :operand => {
44
- :ad_group_id => ad_group_id,
45
- :criterion => {
46
- :xsi_type => 'Platform',
47
- :id => criterion_id
48
- },
49
- :bid_modifier => bid_modifier
50
- }
51
- }
52
-
53
- # Add ad group level mobile bid modifier.
54
- response = bid_modifier_srv.mutate([operation])
55
- if response and response[:value]
56
- modifier = response[:value].first
57
- value = modifier[:bid_modifier] || 'unset'
58
- puts ('Campaign ID %d, AdGroup ID %d, Criterion ID %d was updated with ' +
59
- 'ad group level modifier: %s') %
60
- [modifier[:campaign_id], modifier[:ad_group_id],
61
- modifier[:criterion][:id], value]
62
- else
63
- puts 'No modifiers were added.'
64
- end
65
- end
66
-
67
- if __FILE__ == $0
68
- API_VERSION = :v201601
69
-
70
- begin
71
- # ID of an ad group to add an override for.
72
- ad_group_id = 'INSERT_AD_GROUP_ID_HERE'.to_i
73
- # Bid modifier to override with.
74
- bid_modifier = 1.5
75
-
76
- add_ad_group_bid_modifier(ad_group_id, bid_modifier)
77
-
78
- # Authorization error.
79
- rescue AdsCommon::Errors::OAuth2VerificationRequired => e
80
- puts "Authorization credentials are not valid. Edit adwords_api.yml for " +
81
- "OAuth2 client ID and secret and run misc/setup_oauth2.rb example " +
82
- "to retrieve and store OAuth2 tokens."
83
- puts "See this wiki page for more details:\n\n " +
84
- 'https://github.com/googleads/google-api-ads-ruby/wiki/OAuth2'
85
-
86
- # HTTP errors.
87
- rescue AdsCommon::Errors::HttpError => e
88
- puts "HTTP Error: %s" % e
89
-
90
- # API errors.
91
- rescue AdwordsApi::Errors::ApiException => e
92
- puts "Message: %s" % e.message
93
- puts 'Errors:'
94
- e.errors.each_with_index do |error, index|
95
- puts "\tError [%d]:" % (index + 1)
96
- error.each do |field, value|
97
- puts "\t\t%s: %s" % [field, value]
98
- end
99
- end
100
- end
101
- end
@@ -1,133 +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 code example creates a click-to-download ad, also known as an app
20
- # promotion ad to a given ad group. To list ad groups, run get_ad_groups.rb.
21
-
22
- require 'adwords_api'
23
-
24
- def add_click_to_download_ad(ad_group_id)
25
- # AdwordsApi::Api will read a config file from ENV['HOME']/adwords_api.yml
26
- # when called without parameters.
27
- adwords = AdwordsApi::Api.new
28
-
29
- # To enable logging of SOAP requests, set the log_level value to 'DEBUG' in
30
- # the configuration file or provide your own logger:
31
- # adwords.logger = Logger.new('adwords_xml.log')
32
-
33
- ad_group_ad_srv = adwords.service(:AdGroupAdService, API_VERSION)
34
-
35
- # Create the template elements for the ad. You can refer to
36
- # https://developers.google.com/adwords/api/docs/appendix/templateads
37
- # for the list of available template fields.
38
- ad_data = {
39
- :unique_name => 'adData',
40
- :fields => [
41
- {
42
- :name => 'headline',
43
- :field_text => 'Enjoy your drive in Mars',
44
- :type => 'TEXT'
45
- },
46
- {
47
- :name => 'description1',
48
- :field_text => 'Realistic physics simulation',
49
- :type => 'TEXT'
50
- },
51
- {
52
- :name => 'description2',
53
- :field_text => 'Race against players online',
54
- :type => 'TEXT'
55
- },
56
- {
57
- :name => 'appId',
58
- :field_text => 'com.example.demogame',
59
- :type => 'TEXT'
60
- },
61
- {
62
- :name => 'appStore',
63
- :field_text => '2',
64
- :type => 'ENUM'
65
- }
66
- ]
67
- }
68
-
69
- # Create click to download ad.
70
- click_to_download_app_ad = {
71
- :xsi_type => 'TemplateAd',
72
- :name => 'Ad for demo game',
73
- :template_id => 353,
74
- :final_urls =>
75
- ['http://play.google.com/store/apps/details?id=com.example.demogame'],
76
- :display_url => 'play.google.com',
77
- :template_elements => [ad_data]
78
- }
79
-
80
- # Create ad group ad.
81
- ad_group_ad = {
82
- :ad_group_id => ad_group_id,
83
- :ad => click_to_download_app_ad,
84
- # Optional.
85
- :status => 'PAUSED'
86
- }
87
-
88
- # Add ad.
89
- response = ad_group_ad_srv.mutate([
90
- {:operator => 'ADD', :operand => ad_group_ad}
91
- ])
92
- if response and response[:value]
93
- response[:value].each do |ad|
94
- puts "Added new click-to-download ad to ad group ID %d with url '%s'." %
95
- [ad[:ad][:id], ad[:ad][:final_urls[0]]]
96
- end
97
- else
98
- raise StandardError, 'No ads were added.'
99
- end
100
- end
101
-
102
- if __FILE__ == $0
103
- API_VERSION = :v201601
104
-
105
- begin
106
- # Ad group ID to add text ads to.
107
- ad_group_id = 'INSERT_AD_GROUP_ID_HERE'.to_i
108
- add_click_to_download_ad(ad_group_id)
109
-
110
- # Authorization error.
111
- rescue AdsCommon::Errors::OAuth2VerificationRequired => e
112
- puts "Authorization credentials are not valid. Edit adwords_api.yml for " +
113
- "OAuth2 client ID and secret and run misc/setup_oauth2.rb example " +
114
- "to retrieve and store OAuth2 tokens."
115
- puts "See this wiki page for more details:\n\n " +
116
- 'https://github.com/googleads/google-api-ads-ruby/wiki/OAuth2'
117
-
118
- # HTTP errors.
119
- rescue AdsCommon::Errors::HttpError => e
120
- puts "HTTP Error: %s" % e
121
-
122
- # API errors.
123
- rescue AdwordsApi::Errors::ApiException => e
124
- puts "Message: %s" % e.message
125
- puts 'Errors:'
126
- e.errors.each_with_index do |error, index|
127
- puts "\tError [%d]:" % (index + 1)
128
- error.each do |field, value|
129
- puts "\t\t%s: %s" % [field, value]
130
- end
131
- end
132
- end
133
- end
@@ -1,137 +0,0 @@
1
- #!/usr/bin/env ruby
2
- # Encoding: utf-8
3
- #
4
- # Copyright:: Copyright 2015, 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 code example adds an HTML5 ad to a given ad group.
20
- # To get ad groups, run basic_operations/get_ad_groups.rb.
21
-
22
- require 'adwords_api'
23
- require 'base64'
24
-
25
- def add_html5_ad(ad_group_id)
26
- # AdwordsApi::Api will read a config file from ENV['HOME']/adwords_api.yml
27
- # when called without parameters.
28
- adwords = AdwordsApi::Api.new
29
-
30
- # To enable logging of SOAP requests, set the log_level value to 'DEBUG' in
31
- # the configuration file or provide your own logger:
32
- # adwords.logger = Logger.new('adwords_xml.log')
33
-
34
- ad_group_ad_srv = adwords.service(:AdGroupAdService, API_VERSION)
35
-
36
- # The HTML5 zip file contains all the HTML, CSS, and images needed for the
37
- # HTML5 ad. For help on creating an HTML5 zip file, check out Google Web
38
- # Designer (https://www.google.com/webdesigner).
39
- html5_url = 'http://goo.gl/9Y7qI2'
40
- html5_data = AdsCommon::Http.get(html5_url, adwords.config)
41
- base64_html5_data = Base64.encode64(html5_data)
42
-
43
- # Create a media bundle containing the zip file with all the HTML5
44
- # components.
45
- media_bundle = {
46
- :xsi_type => 'MediaBundle',
47
- :data => base64_html5_data,
48
- :entry_point => 'carousel/index.html',
49
- :type => 'MEDIA_BUNDLE'
50
- }
51
-
52
- # Create the template elements for the ad. You can refer to
53
- # https://developers.google.com/adwords/api/docs/appendix/templateads
54
- # for the list of available template fields.
55
- ad_data = {
56
- :unique_name => 'adData',
57
- :fields => [
58
- {
59
- :name => 'Custom_layout',
60
- :field_media => media_bundle,
61
- :type => 'MEDIA_BUNDLE'
62
- },
63
- {
64
- :name => 'layout',
65
- :field_text => 'Custom',
66
- :type => 'ENUM'
67
- }
68
- ]
69
- }
70
-
71
- html5_ad = {
72
- :xsi_type => 'TemplateAd',
73
- :name => 'Ad for HTML5',
74
- :template_id => 419,
75
- :final_urls => ['http://example.com/html5'],
76
- :display_url => 'www.example.com/html5',
77
- :dimensions => {
78
- :width => 300,
79
- :height => 250
80
- },
81
- :template_elements => [ad_data]
82
- }
83
-
84
- ad_group_ad = {
85
- :ad_group_id => ad_group_id,
86
- :ad => html5_ad,
87
- :status => 'PAUSED'
88
- }
89
-
90
- operation = {
91
- :operator => 'ADD',
92
- :operand => ad_group_ad
93
- }
94
-
95
- response = ad_group_ad_srv.mutate([operation])
96
- if response and !response.empty?
97
- response[:value].each do |ad_group_ad|
98
- puts "New HTML5 ad with ID %d and display url '%s' was added." %
99
- [ad_group_ad[:ad][:id], ad_group_ad[:ad][:display_url]]
100
- end
101
- else
102
- puts "No HTML5 ads were added."
103
- end
104
- end
105
-
106
- if __FILE__ == $0
107
- API_VERSION = :v201601
108
-
109
- begin
110
- # Ad group ID to add text ads to.
111
- ad_group_id = 'INSERT_AD_GROUP_ID_HERE'.to_i
112
- add_html5_ad(ad_group_id)
113
-
114
- # Authorization error.
115
- rescue AdsCommon::Errors::OAuth2VerificationRequired => e
116
- puts "Authorization credentials are not valid. Edit adwords_api.yml for " +
117
- "OAuth2 client ID and secret and run misc/setup_oauth2.rb example " +
118
- "to retrieve and store OAuth2 tokens."
119
- puts "See this wiki page for more details:\n\n " +
120
- 'https://github.com/googleads/google-api-ads-ruby/wiki/OAuth2'
121
-
122
- # HTTP errors.
123
- rescue AdsCommon::Errors::HttpError => e
124
- puts "HTTP Error: %s" % e
125
-
126
- # API errors.
127
- rescue AdwordsApi::Errors::ApiException => e
128
- puts "Message: %s" % e.message
129
- puts 'Errors:'
130
- e.errors.each_with_index do |error, index|
131
- puts "\tError [%d]:" % (index + 1)
132
- error.each do |field, value|
133
- puts "\t\t%s: %s" % [field, value]
134
- end
135
- end
136
- end
137
- end
@@ -1,134 +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 code example adds a text ad that uses advanced features of upgraded
20
- # URLs.
21
-
22
- require 'adwords_api'
23
-
24
- def add_text_ad_with_upgraded_urls(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
- # Since your tracking URL will have two custom parameters, provide their
36
- # values too. This can be provided at campaign, ad group, ad, criterion, or
37
- # feed item levels.
38
- season_parameter = {
39
- :key => 'season',
40
- :value => 'christmas'
41
- }
42
-
43
- promo_code_parameter = {
44
- :key => 'promocode',
45
- :value => 'NYC123'
46
- }
47
-
48
- tracking_url_parameters = {
49
- :parameters => [season_parameter, promo_code_parameter]
50
- }
51
-
52
- text_ad = {
53
- :xsi_type => 'TextAd',
54
- :headline => 'Luxury Cruise to Mars',
55
- :description1 => 'Visit the Red Planet in style.',
56
- :description2 => 'Low-gravity fun for everyone!',
57
- :display_url => 'www.example.com',
58
- # Specify a tracking URL for 3rd party tracking provider. You may specify
59
- # one at customer, campaign, ad group, ad, criterion, or feed item levels.
60
- :tracking_url_template => 'http://tracker.example.com/' +
61
- '?season={_season}&promocode={_promocode}&u={lpurl}',
62
- :url_custom_parameters => tracking_url_parameters,
63
- # Specify a list of final URLs. This field cannot be set if :url field
64
- # is set. This may be specified at ad, criterion, and feed item levels.
65
- :final_urls => [
66
- 'http://www.example.com/cruise/space/',
67
- 'http://www.example.com/locations/mars/'
68
- ],
69
- # Specify a list of final mobile URLs. This field cannot be set if :url
70
- # field is set. This may be specificed at ad, criterion, and
71
- # feed item levels.
72
- :final_mobile_urls => [
73
- 'http://mobile.example.com/cruise/space/',
74
- 'http://mobile.example.com/locations/mars/'
75
- ]
76
- }
77
-
78
- operation = {
79
- :operator => 'ADD',
80
- :operand => {:ad_group_id => ad_group_id, :ad => text_ad}
81
- }
82
-
83
- # Add ads.
84
- response = ad_group_ad_srv.mutate([operation])
85
- if response and response[:value]
86
- response[:value].each do |ad|
87
- text_ad = ad[:ad]
88
- puts "Ad with ID %d and displayUrl '%s' was added." %
89
- [text_ad[:id], text_ad[:display_url]]
90
- puts "\tFinal URLs: %s" % [text_ad[:final_urls].join(', ')]
91
- puts "\tFinal Mobile URLs: %s" % [text_ad[:final_mobile_urls].join(', ')]
92
- puts "\tTracking URL template: %s" % [text_ad[:tracking_url_template]]
93
- custom_parameters =
94
- text_ad[:url_custom_parameters][:parameters].map do |custom_parameter|
95
- "%s=%s" % [custom_parameter[:key], custom_parameter[:value]]
96
- end
97
- puts "\tCustom parameters: %s" % [custom_parameters.join(', ')]
98
- end
99
- else
100
- raise StandardError, 'No ads were added.'
101
- end
102
- end
103
-
104
- if __FILE__ == $0
105
- API_VERSION = :v201601
106
-
107
- begin
108
- ad_group_id = 'INSERT_AD_GROUP_ID_HERE'.to_i
109
- add_text_ad_with_upgraded_urls(ad_group_id)
110
-
111
- # Authorization error.
112
- rescue AdsCommon::Errors::OAuth2VerificationRequired => e
113
- puts "Authorization credentials are not valid. Edit adwords_api.yml for " +
114
- "OAuth2 client ID and secret and run misc/setup_oauth2.rb example " +
115
- "to retrieve and store OAuth2 tokens."
116
- puts "See this wiki page for more details:\n\n " +
117
- 'https://github.com/googleads/google-api-ads-ruby/wiki/OAuth2'
118
-
119
- # HTTP errors.
120
- rescue AdsCommon::Errors::HttpError => e
121
- puts "HTTP Error: %s" % e
122
-
123
- # API errors.
124
- rescue AdwordsApi::Errors::ApiException => e
125
- puts "Message: %s" % e.message
126
- puts 'Errors:'
127
- e.errors.each_with_index do |error, index|
128
- puts "\tError [%d]:" % (index + 1)
129
- error.each do |field, value|
130
- puts "\t\t%s: %s" % [field, value]
131
- end
132
- end
133
- end
134
- end