google-adwords-api 0.20.0 → 0.20.1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (201) hide show
  1. checksums.yaml +4 -4
  2. data/ChangeLog +7 -0
  3. data/examples/v201601/remarketing/add_crm_based_user_list.rb +2 -2
  4. data/examples/v201603/remarketing/add_crm_based_user_list.rb +2 -2
  5. data/examples/v201605/advanced_operations/add_click_to_download_ad.rb +2 -2
  6. data/examples/v201605/advanced_operations/add_html5_ad.rb +2 -2
  7. data/examples/v201605/remarketing/add_crm_based_user_list.rb +2 -2
  8. data/examples/v201607/account_management/create_account.rb +88 -0
  9. data/examples/v201607/account_management/get_account_changes.rb +135 -0
  10. data/examples/v201607/account_management/get_account_hierarchy.rb +132 -0
  11. data/examples/v201607/advanced_operations/add_ad_customizers.rb +184 -0
  12. data/examples/v201607/advanced_operations/add_ad_group_bid_modifier.rb +101 -0
  13. data/examples/v201607/advanced_operations/add_click_to_download_ad.rb +148 -0
  14. data/examples/v201607/advanced_operations/add_html5_ad.rb +137 -0
  15. data/examples/v201607/advanced_operations/add_responsive_display_ad.rb +130 -0
  16. data/examples/v201607/advanced_operations/add_text_ad_with_upgraded_urls.rb +134 -0
  17. data/examples/v201607/advanced_operations/create_and_attach_shared_keyword_set.rb +141 -0
  18. data/examples/v201607/advanced_operations/find_and_remove_criteria_from_shared_set.rb +174 -0
  19. data/examples/v201607/advanced_operations/get_ad_group_bid_modifiers.rb +102 -0
  20. data/examples/v201607/advanced_operations/use_portfolio_bidding_strategy.rb +146 -0
  21. data/examples/v201607/basic_operations/add_ad_groups.rb +142 -0
  22. data/examples/v201607/basic_operations/add_campaigns.rb +138 -0
  23. data/examples/v201607/basic_operations/add_expanded_text_ads.rb +108 -0
  24. data/examples/v201607/basic_operations/add_keywords.rb +114 -0
  25. data/examples/v201607/basic_operations/add_text_ads.rb +109 -0
  26. data/examples/v201607/basic_operations/get_ad_groups.rb +102 -0
  27. data/examples/v201607/basic_operations/get_campaigns.rb +97 -0
  28. data/examples/v201607/basic_operations/get_campaigns_with_awql.rb +89 -0
  29. data/examples/v201607/basic_operations/get_expanded_text_ads.rb +122 -0
  30. data/examples/v201607/basic_operations/get_keywords.rb +109 -0
  31. data/examples/v201607/basic_operations/get_text_ads.rb +110 -0
  32. data/examples/v201607/basic_operations/pause_ad.rb +88 -0
  33. data/examples/v201607/basic_operations/remove_ad.rb +89 -0
  34. data/examples/v201607/basic_operations/remove_ad_group.rb +85 -0
  35. data/examples/v201607/basic_operations/remove_campaign.rb +87 -0
  36. data/examples/v201607/basic_operations/remove_keyword.rb +94 -0
  37. data/examples/v201607/basic_operations/update_ad_group.rb +85 -0
  38. data/examples/v201607/basic_operations/update_campaign.rb +86 -0
  39. data/examples/v201607/basic_operations/update_keyword.rb +106 -0
  40. data/examples/v201607/campaign_management/add_campaign_labels.rb +82 -0
  41. data/examples/v201607/campaign_management/add_complete_campaigns_using_batch_job.rb +355 -0
  42. data/examples/v201607/campaign_management/add_draft.rb +114 -0
  43. data/examples/v201607/campaign_management/add_experiment.rb +162 -0
  44. data/examples/v201607/campaign_management/add_keywords_using_incremental_batch_job.rb +210 -0
  45. data/examples/v201607/campaign_management/add_trial.rb +142 -0
  46. data/examples/v201607/campaign_management/get_all_disapproved_ads.rb +97 -0
  47. data/examples/v201607/campaign_management/get_all_disapproved_ads_with_awql.rb +89 -0
  48. data/examples/v201607/campaign_management/get_campaigns_by_label.rb +108 -0
  49. data/examples/v201607/campaign_management/graduate_trial.rb +106 -0
  50. data/examples/v201607/campaign_management/promote_experiment.rb +81 -0
  51. data/examples/v201607/campaign_management/set_ad_parameters.rb +118 -0
  52. data/examples/v201607/campaign_management/set_criterion_bid_modifier.rb +104 -0
  53. data/examples/v201607/campaign_management/validate_text_ad.rb +110 -0
  54. data/examples/v201607/error_handling/handle_partial_failures.rb +130 -0
  55. data/examples/v201607/error_handling/handle_policy_violation_error.rb +141 -0
  56. data/examples/v201607/extensions/add_google_my_business_location_extensions.rb +193 -0
  57. data/examples/v201607/extensions/add_prices.rb +164 -0
  58. data/examples/v201607/extensions/add_site_links.rb +199 -0
  59. data/examples/v201607/extensions/add_site_links_using_feeds.rb +286 -0
  60. data/examples/v201607/migration/migrate_to_extension_settings.rb +386 -0
  61. data/examples/v201607/migration/upgrade_ad_url.rb +93 -0
  62. data/examples/v201607/misc/get_all_images_and_videos.rb +104 -0
  63. data/examples/v201607/misc/setup_oauth2.rb +84 -0
  64. data/examples/v201607/misc/upload_image.rb +93 -0
  65. data/examples/v201607/misc/upload_media_bundle.rb +90 -0
  66. data/examples/v201607/misc/use_oauth2_jwt.rb +93 -0
  67. data/examples/v201607/misc/use_runtime_config.rb +92 -0
  68. data/examples/v201607/optimization/estimate_keyword_traffic.rb +191 -0
  69. data/examples/v201607/optimization/get_campaign_criterion_bid_modifier_simulations.rb +128 -0
  70. data/examples/v201607/optimization/get_keyword_bid_simulations.rb +95 -0
  71. data/examples/v201607/optimization/get_keyword_ideas.rb +136 -0
  72. data/examples/v201607/remarketing/add_audience.rb +118 -0
  73. data/examples/v201607/remarketing/add_conversion_tracker.rb +97 -0
  74. data/examples/v201607/remarketing/add_crm_based_user_list.rb +116 -0
  75. data/examples/v201607/remarketing/add_rule_based_user_lists.rb +167 -0
  76. data/examples/v201607/remarketing/upload_offline_conversions.rb +98 -0
  77. data/examples/v201607/reporting/download_criteria_report.rb +92 -0
  78. data/examples/v201607/reporting/download_criteria_report_with_awql.rb +93 -0
  79. data/examples/v201607/reporting/get_report_fields.rb +75 -0
  80. data/examples/v201607/reporting/parallel_report_download.rb +164 -0
  81. data/examples/v201607/reporting/stream_criteria_report_results.rb +97 -0
  82. data/examples/v201607/shopping_campaigns/add_product_partition_tree.rb +267 -0
  83. data/examples/v201607/shopping_campaigns/add_product_scope.rb +129 -0
  84. data/examples/v201607/shopping_campaigns/add_shopping_campaign.rb +129 -0
  85. data/examples/v201607/shopping_campaigns/get_product_category_taxonomy.rb +115 -0
  86. data/examples/v201607/targeting/add_campaign_targeting_criteria.rb +166 -0
  87. data/examples/v201607/targeting/add_demographic_targeting_criteria.rb +112 -0
  88. data/examples/v201607/targeting/get_campaign_targeting_criteria.rb +106 -0
  89. data/examples/v201607/targeting/get_targetable_languages_and_carriers.rb +89 -0
  90. data/examples/v201607/targeting/lookup_location.rb +108 -0
  91. data/lib/adwords_api/api_config.rb +96 -4
  92. data/lib/adwords_api/batch_job_utils.rb +6 -5
  93. data/lib/adwords_api/v201607/account_label_service.rb +46 -0
  94. data/lib/adwords_api/v201607/account_label_service_registry.rb +46 -0
  95. data/lib/adwords_api/v201607/ad_customizer_feed_service.rb +46 -0
  96. data/lib/adwords_api/v201607/ad_customizer_feed_service_registry.rb +46 -0
  97. data/lib/adwords_api/v201607/ad_group_ad_service.rb +70 -0
  98. data/lib/adwords_api/v201607/ad_group_ad_service_registry.rb +46 -0
  99. data/lib/adwords_api/v201607/ad_group_bid_modifier_service.rb +54 -0
  100. data/lib/adwords_api/v201607/ad_group_bid_modifier_service_registry.rb +46 -0
  101. data/lib/adwords_api/v201607/ad_group_criterion_service.rb +62 -0
  102. data/lib/adwords_api/v201607/ad_group_criterion_service_registry.rb +46 -0
  103. data/lib/adwords_api/v201607/ad_group_extension_setting_service.rb +54 -0
  104. data/lib/adwords_api/v201607/ad_group_extension_setting_service_registry.rb +46 -0
  105. data/lib/adwords_api/v201607/ad_group_feed_service.rb +54 -0
  106. data/lib/adwords_api/v201607/ad_group_feed_service_registry.rb +46 -0
  107. data/lib/adwords_api/v201607/ad_group_service.rb +62 -0
  108. data/lib/adwords_api/v201607/ad_group_service_registry.rb +46 -0
  109. data/lib/adwords_api/v201607/ad_param_service.rb +46 -0
  110. data/lib/adwords_api/v201607/ad_param_service_registry.rb +46 -0
  111. data/lib/adwords_api/v201607/adwords_user_list_service.rb +62 -0
  112. data/lib/adwords_api/v201607/adwords_user_list_service_registry.rb +46 -0
  113. data/lib/adwords_api/v201607/batch_job_service.rb +54 -0
  114. data/lib/adwords_api/v201607/batch_job_service_registry.rb +46 -0
  115. data/lib/adwords_api/v201607/bidding_strategy_service.rb +54 -0
  116. data/lib/adwords_api/v201607/bidding_strategy_service_registry.rb +46 -0
  117. data/lib/adwords_api/v201607/budget_order_service.rb +54 -0
  118. data/lib/adwords_api/v201607/budget_order_service_registry.rb +46 -0
  119. data/lib/adwords_api/v201607/budget_service.rb +54 -0
  120. data/lib/adwords_api/v201607/budget_service_registry.rb +46 -0
  121. data/lib/adwords_api/v201607/campaign_criterion_service.rb +54 -0
  122. data/lib/adwords_api/v201607/campaign_criterion_service_registry.rb +46 -0
  123. data/lib/adwords_api/v201607/campaign_extension_setting_service.rb +54 -0
  124. data/lib/adwords_api/v201607/campaign_extension_setting_service_registry.rb +46 -0
  125. data/lib/adwords_api/v201607/campaign_feed_service.rb +54 -0
  126. data/lib/adwords_api/v201607/campaign_feed_service_registry.rb +46 -0
  127. data/lib/adwords_api/v201607/campaign_service.rb +62 -0
  128. data/lib/adwords_api/v201607/campaign_service_registry.rb +46 -0
  129. data/lib/adwords_api/v201607/campaign_shared_set_service.rb +54 -0
  130. data/lib/adwords_api/v201607/campaign_shared_set_service_registry.rb +46 -0
  131. data/lib/adwords_api/v201607/constant_data_service.rb +110 -0
  132. data/lib/adwords_api/v201607/constant_data_service_registry.rb +46 -0
  133. data/lib/adwords_api/v201607/conversion_tracker_service.rb +54 -0
  134. data/lib/adwords_api/v201607/conversion_tracker_service_registry.rb +46 -0
  135. data/lib/adwords_api/v201607/customer_extension_setting_service.rb +54 -0
  136. data/lib/adwords_api/v201607/customer_extension_setting_service_registry.rb +46 -0
  137. data/lib/adwords_api/v201607/customer_feed_service.rb +54 -0
  138. data/lib/adwords_api/v201607/customer_feed_service_registry.rb +46 -0
  139. data/lib/adwords_api/v201607/customer_service.rb +46 -0
  140. data/lib/adwords_api/v201607/customer_service_registry.rb +46 -0
  141. data/lib/adwords_api/v201607/customer_sync_service.rb +38 -0
  142. data/lib/adwords_api/v201607/customer_sync_service_registry.rb +47 -0
  143. data/lib/adwords_api/v201607/data_service.rb +94 -0
  144. data/lib/adwords_api/v201607/data_service_registry.rb +46 -0
  145. data/lib/adwords_api/v201607/draft_async_error_service.rb +46 -0
  146. data/lib/adwords_api/v201607/draft_async_error_service_registry.rb +46 -0
  147. data/lib/adwords_api/v201607/draft_service.rb +54 -0
  148. data/lib/adwords_api/v201607/draft_service_registry.rb +46 -0
  149. data/lib/adwords_api/v201607/experiment_service.rb +46 -0
  150. data/lib/adwords_api/v201607/experiment_service_registry.rb +46 -0
  151. data/lib/adwords_api/v201607/feed_item_service.rb +54 -0
  152. data/lib/adwords_api/v201607/feed_item_service_registry.rb +46 -0
  153. data/lib/adwords_api/v201607/feed_mapping_service.rb +54 -0
  154. data/lib/adwords_api/v201607/feed_mapping_service_registry.rb +46 -0
  155. data/lib/adwords_api/v201607/feed_service.rb +54 -0
  156. data/lib/adwords_api/v201607/feed_service_registry.rb +46 -0
  157. data/lib/adwords_api/v201607/label_service.rb +54 -0
  158. data/lib/adwords_api/v201607/label_service_registry.rb +46 -0
  159. data/lib/adwords_api/v201607/location_criterion_service.rb +46 -0
  160. data/lib/adwords_api/v201607/location_criterion_service_registry.rb +46 -0
  161. data/lib/adwords_api/v201607/managed_customer_service.rb +78 -0
  162. data/lib/adwords_api/v201607/managed_customer_service_registry.rb +46 -0
  163. data/lib/adwords_api/v201607/media_service.rb +54 -0
  164. data/lib/adwords_api/v201607/media_service_registry.rb +46 -0
  165. data/lib/adwords_api/v201607/offline_conversion_feed_service.rb +38 -0
  166. data/lib/adwords_api/v201607/offline_conversion_feed_service_registry.rb +46 -0
  167. data/lib/adwords_api/v201607/report_definition_service.rb +38 -0
  168. data/lib/adwords_api/v201607/report_definition_service_registry.rb +46 -0
  169. data/lib/adwords_api/v201607/shared_criterion_service.rb +54 -0
  170. data/lib/adwords_api/v201607/shared_criterion_service_registry.rb +46 -0
  171. data/lib/adwords_api/v201607/shared_set_service.rb +54 -0
  172. data/lib/adwords_api/v201607/shared_set_service_registry.rb +46 -0
  173. data/lib/adwords_api/v201607/targeting_idea_service.rb +38 -0
  174. data/lib/adwords_api/v201607/targeting_idea_service_registry.rb +46 -0
  175. data/lib/adwords_api/v201607/traffic_estimator_service.rb +38 -0
  176. data/lib/adwords_api/v201607/traffic_estimator_service_registry.rb +46 -0
  177. data/lib/adwords_api/v201607/trial_async_error_service.rb +46 -0
  178. data/lib/adwords_api/v201607/trial_async_error_service_registry.rb +46 -0
  179. data/lib/adwords_api/v201607/trial_service.rb +54 -0
  180. data/lib/adwords_api/v201607/trial_service_registry.rb +46 -0
  181. data/lib/adwords_api/version.rb +1 -1
  182. data/test/adwords_api/test_adwords_api.rb +1 -1
  183. data/test/adwords_api/test_api_config.rb +8 -8
  184. data/test/adwords_api/test_batch_job_utils.rb +5 -5
  185. data/test/adwords_api/test_choices.rb +2 -2
  186. data/test/adwords_api/test_report_stream.rb +1 -1
  187. data/test/adwords_api/test_report_utils.rb +1 -1
  188. data/test/templates/v201601/basic_operations_get_campaigns.def +116 -0
  189. data/test/templates/v201601/basic_operations_update_keyword.def +125 -0
  190. data/test/templates/v201601/misc_use_oauth2_jwt.def +131 -0
  191. data/test/templates/v201603/basic_operations_get_campaigns.def +116 -0
  192. data/test/templates/v201603/basic_operations_update_keyword.def +125 -0
  193. data/test/templates/v201603/misc_use_oauth2_jwt.def +131 -0
  194. data/test/templates/v201605/basic_operations_get_campaigns.def +1 -1
  195. data/test/templates/v201605/basic_operations_update_keyword.def +125 -0
  196. data/test/templates/v201605/misc_use_oauth2_jwt.def +1 -1
  197. data/test/templates/v201607/basic_operations_get_campaigns.def +116 -0
  198. data/test/templates/v201607/basic_operations_update_keyword.def +125 -0
  199. data/test/templates/v201607/misc_use_oauth2_jwt.def +131 -0
  200. data/test/test_utils.rb +4 -1
  201. metadata +183 -2
@@ -0,0 +1,141 @@
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 demonstrates how to handle policy violation errors. To create
20
+ # an ad group, run add_ad_group.rb.
21
+
22
+ require 'adwords_api'
23
+ require 'adwords_api/utils'
24
+
25
+ def handle_policy_violation_error(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
+ # Create text ad.
37
+ text_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 => 'Mars Cruise!!!',
47
+ :description1 => 'Visit the Red Planet in style.',
48
+ :description2 => 'Low-gravity fun for everyone!',
49
+ :final_urls => ['http://www.example.com'],
50
+ :display_url => 'www.example.com',
51
+ }
52
+ }
53
+ }
54
+
55
+ operations = [text_ad_operation]
56
+
57
+ # Validate ad.
58
+ begin
59
+ # Enable "validate only" for the length of this block
60
+ adwords.validate_only do
61
+ ad_group_ad_srv.mutate(operations)
62
+ end
63
+ puts 'Validation successful, no errors returned.'
64
+ rescue AdwordsApi::Errors::ApiException => e
65
+ e.errors.each do |error|
66
+ if error[:xsi_type] == 'PolicyViolationError'
67
+ operation_index = AdwordsApi::Utils.operation_index_for_error(error)
68
+ operation = operations[operation_index]
69
+ puts "Ad with headline '%s' violated %s policy '%s'." %
70
+ [operation[:operand][:ad][:headline],
71
+ error[:is_exemptable] ? 'exemptable' : 'non-exemptable',
72
+ error[:external_policy_name]]
73
+ if error[:is_exemptable]
74
+ # Add exemption request to the operation.
75
+ puts "Adding exemption request for policy name '%s' on text '%s'." %
76
+ [error[:key][:policy_name], error[:key][:violating_text]]
77
+ unless operation[:exemption_requests]
78
+ operation[:exemption_requests] = []
79
+ end
80
+ operation[:exemption_requests] << {
81
+ :key => error[:key]
82
+ }
83
+ else
84
+ # Remove non-exemptable operation
85
+ puts "Removing the operation from the request."
86
+ operations.delete(operation)
87
+ end
88
+ else
89
+ # Non-policy error returned, re-throw exception.
90
+ raise e
91
+ end
92
+ end
93
+ end
94
+
95
+ # Add ads.
96
+ if operations.size > 0
97
+ response = ad_group_ad_srv.mutate(operations)
98
+ if response and response[:value]
99
+ ads = response[:value]
100
+ puts "Added #{ads.length} ad(s) to ad group #{ad_group_id}."
101
+ ads.each do |ad|
102
+ puts " Ad id is #{ad[:ad][:id]}, type is #{ad[:ad][:xsi_type]} and " +
103
+ "status is \"#{ad[:status]}\"."
104
+ end
105
+ else
106
+ puts "No ads were added."
107
+ end
108
+ end
109
+ end
110
+
111
+ if __FILE__ == $0
112
+ API_VERSION = :v201607
113
+
114
+ begin
115
+ ad_group_id = 'INSERT_AD_GROUP_ID_HERE'.to_i
116
+ handle_policy_violation_error(ad_group_id)
117
+
118
+ # Authorization error.
119
+ rescue AdsCommon::Errors::OAuth2VerificationRequired => e
120
+ puts "Authorization credentials are not valid. Edit adwords_api.yml for " +
121
+ "OAuth2 client ID and secret and run misc/setup_oauth2.rb example " +
122
+ "to retrieve and store OAuth2 tokens."
123
+ puts "See this wiki page for more details:\n\n " +
124
+ 'https://github.com/googleads/google-api-ads-ruby/wiki/OAuth2'
125
+
126
+ # HTTP errors.
127
+ rescue AdsCommon::Errors::HttpError => e
128
+ puts "HTTP Error: %s" % e
129
+
130
+ # API errors.
131
+ rescue AdwordsApi::Errors::ApiException => e
132
+ puts "Message: %s" % e.message
133
+ puts 'Errors:'
134
+ e.errors.each_with_index do |error, index|
135
+ puts "\tError [%d]:" % (index + 1)
136
+ error.each do |field, value|
137
+ puts "\t\t%s: %s" % [field, value]
138
+ end
139
+ end
140
+ end
141
+ end
@@ -0,0 +1,193 @@
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 adds a feed that syncs feed items from a Google My Business (GMB)
20
+ # account and associates the feed with a customer.
21
+
22
+ require 'adwords_api'
23
+ require 'date'
24
+
25
+ def add_gmb_location_extensions(gmb_email_address, gmb_access_token,
26
+ business_account_identifier)
27
+ # AdwordsApi::Api will read a config file from ENV['HOME']/adwords_api.yml
28
+ # when called without parameters.
29
+ adwords = AdwordsApi::Api.new
30
+
31
+ # To enable logging of SOAP requests, set the log_level value to 'DEBUG' in
32
+ # the configuration file or provide your own logger:
33
+ # adwords.logger = Logger.new('adwords_xml.log')
34
+
35
+ feed_srv = adwords.service(:FeedService, API_VERSION)
36
+ customer_feed_srv = adwords.service(:CustomerFeedService, API_VERSION)
37
+
38
+ if gmb_access_token.nil?
39
+ gmb_access_token = adwords.get_auth_handler.get_token(
40
+ adwords.credential_handler.credentials)[:access_token]
41
+ end
42
+
43
+ # Create a feed that will sync to the Google My Business account specified
44
+ # by gmb_email_address. Do not add FeedAttributes to this object, as AdWords
45
+ # will add them automatically because this will be a system generated feed.
46
+ gmb_feed = {
47
+ :name => "GMB feed #%d" % (Time.new.to_f * 1000).to_i,
48
+ :system_feed_generation_data => {
49
+ :xsi_type => 'PlacesLocationFeedData',
50
+ :o_auth_info => {
51
+ :http_method => 'GET',
52
+ :http_request_url => 'https://www.googleapis.com/auth/adwords',
53
+ :http_authorization_header => "Bearer %s" % gmb_access_token
54
+ },
55
+ :email_address => gmb_email_address
56
+ },
57
+ # Since this feed's feed items will be managed by AdWords, you must set
58
+ # its origin to ADWORDS.
59
+ :origin => 'ADWORDS'
60
+ }
61
+
62
+ # Optional: specify labels to filter Google My Business listings. If
63
+ # specified, only listings that have any of the labels set are synchronized
64
+ # into FeedItems.
65
+ gmb_feed[:system_feed_generation_data][:label_filters] =
66
+ ['Stores in New York City']
67
+
68
+ # Only include the business_account_identifier if it's specified.
69
+ # A nil value will cause an invalid request.
70
+ unless business_account_identifier.nil?
71
+ gmb_feed[:system_feed_generation_data][:business_account_identifier] =
72
+ business_account_identifier
73
+ end
74
+
75
+ gmb_operation = {
76
+ :operator => 'ADD',
77
+ :operand => gmb_feed
78
+ }
79
+
80
+ result = feed_srv.mutate([gmb_operation])
81
+ added_feed = result[:value].first
82
+ puts "Added GMB feed with ID %d" % added_feed[:id]
83
+
84
+ # Add a CustomerFeed that associates the feed with this customer for the
85
+ # LOCATION placeholder type.
86
+ customer_feed = {
87
+ :feed_id => added_feed[:id],
88
+ :placeholder_types => [PLACEHOLDER_TYPE_LOCATION],
89
+ :matching_function => {
90
+ :operator => 'IDENTITY',
91
+ :lhs_operand => {
92
+ :xsi_type => 'ConstantOperand',
93
+ :type => 'BOOLEAN',
94
+ :boolean_value => true
95
+ }
96
+ }
97
+ }
98
+
99
+ customer_feed_operation = {
100
+ :xsi_type => 'CustomerFeedOperation',
101
+ :operator => 'ADD',
102
+ :operand => customer_feed
103
+ }
104
+
105
+ added_customer_feed = nil
106
+ number_of_attempts = 0
107
+ while i < MAX_CUSTOMER_FEED_ADD_ATTEMPTS && !added_customer_feed
108
+ number_of_attempts += 1
109
+ begin
110
+ result = customer_feed_srv.mutate([customer_feed_operation])
111
+ added_customer_feed = result[:value].first
112
+ puts "Attempt #%d to add the CustomerFeed was successful" %
113
+ number_of_attempts
114
+ rescue
115
+ sleep_seconds = 5 * (2 ** number_of_attempts)
116
+ puts ("Attempt #%d to add the CustomerFeed was not succeessful. " +
117
+ "Waiting %d seconds before trying again.") %
118
+ [number_of_attempts, sleep_seconds]
119
+ sleep(sleep_seconds)
120
+ end
121
+ end
122
+
123
+ unless added_customer_feed
124
+ raise StandardError, ("Could not create the CustomerFeed after %d " +
125
+ "attempts. Please retry the CustomerFeed ADD operation later.") %
126
+ MAX_CUSTOMER_FEED_ADD_ATTEMPTS
127
+ end
128
+
129
+ puts "Added CustomerFeed for feed ID %d and placeholder type %d" %
130
+ [added_customer_feed[:id], added_customer_feed[:placeholder_types].first]
131
+
132
+ # OPTIONAL: Create a CampaignFeed to specify which FeedItems to use at the
133
+ # Campaign level. This will be similar to the CampaignFeed in the
134
+ # add_site_links example, except you can filter based on the business name
135
+ # and category of each FeedItem by using a FeedAttributeOperand in your
136
+ # matching function.
137
+
138
+ # OPTIONAL: Create an AdGroupFeed for even more fine grained control over
139
+ # which feed items are used at the AdGroup level.
140
+ end
141
+
142
+ if __FILE__ == $0
143
+ API_VERSION = :v201607
144
+ PLACEHOLDER_TYPE_LOCATION = 7
145
+ MAX_CUSTOMER_FEED_ADD_ATTEMPTS = 10
146
+
147
+ begin
148
+ # The email address of either an owner or a manager of the GMB account.
149
+ gmb_email_address = 'INSERT_GMB_EMAIL_ADDRESS_HERE'
150
+
151
+ # If the gmbEmailAddress above is the same as you used to generate your
152
+ # AdWords API refresh token, leave the value below as nil.
153
+ # Otherwise, to obtain an access token for your GMB account, generate a
154
+ # refresh token as you did for AdWords, but make sure you are logged in as
155
+ # the same user as gmb_email_address above when you follow the link, then
156
+ # capture the generated access token
157
+ gmb_access_token = nil
158
+
159
+ # If the gmb_email_address above is for a GMB manager instead of
160
+ # the GMB account owner, then set business_account_identifier to the
161
+ # +Page ID of a location for which the manager has access. See the
162
+ # location extensions guide at
163
+ # https://developers.google.com/adwords/api/docs/guides/feed-services-locations
164
+ # for details.
165
+ business_account_identifier = nil
166
+
167
+ add_gmb_location_extensions(gmb_email_address, gmb_access_token,
168
+ business_account_identifier)
169
+
170
+ # Authorization error.
171
+ rescue AdsCommon::Errors::OAuth2VerificationRequired => e
172
+ puts "Authorization credentials are not valid. Edit adwords_api.yml for " +
173
+ "OAuth2 client ID and secret and run misc/setup_oauth2.rb example " +
174
+ "to retrieve and store OAuth2 tokens."
175
+ puts "See this wiki page for more details:\n\n " +
176
+ 'https://github.com/googleads/google-api-ads-ruby/wiki/OAuth2'
177
+
178
+ # HTTP errors.
179
+ rescue AdsCommon::Errors::HttpError => e
180
+ puts "HTTP Error: %s" % e
181
+
182
+ # API errors.
183
+ rescue AdwordsApi::Errors::ApiException => e
184
+ puts "Message: %s" % e.message
185
+ puts 'Errors:'
186
+ e.errors.each_with_index do |error, index|
187
+ puts "\tError [%d]:" % (index + 1)
188
+ error.each do |field, value|
189
+ puts "\t\t%s: %s" % [field, value]
190
+ end
191
+ end
192
+ end
193
+ end
@@ -0,0 +1,164 @@
1
+ #!/usr/bin/env ruby
2
+ # Encoding: utf-8
3
+ #
4
+ # Copyright:: Copyright 2016, 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 adds a price extension and associates it with an account.
20
+ # Campaign targeting is also set using the specified campaign ID. To get
21
+ # campaigns, run basic_operations/get_campaigns.rb.
22
+
23
+ require 'adwords_api'
24
+
25
+ def add_prices(campaign_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
+ customer_extension_setting_srv =
35
+ adwords.service(:CustomerExtensionSettingService, API_VERSION)
36
+
37
+ price_feed_item = {
38
+ :xsi_type => 'PriceFeedItem',
39
+ :price_extension_type => 'SERVICES',
40
+ # Price qualifier is optional.
41
+ :price_qualifier => 'FROM',
42
+ :tracking_url_template => 'http://tracker.example.com/?u={lpurl}',
43
+ :language => 'en',
44
+ :campaign_targeting => {
45
+ :targeting_campaign_id => campaign_id
46
+ },
47
+ :scheduling => {
48
+ :feed_item_schedules => [
49
+ {
50
+ :day_of_week => 'SUNDAY',
51
+ :start_hour => 10,
52
+ :start_minute => 'ZERO',
53
+ :end_hour => 18,
54
+ :end_minute => 'ZERO'
55
+ },
56
+ {
57
+ :day_of_week => 'SATURDAY',
58
+ :start_hour => 10,
59
+ :start_minute => 'ZERO',
60
+ :end_hour => 22,
61
+ :end_minute => 'ZERO'
62
+ }
63
+ ]
64
+ },
65
+ # To create a price extension, at least three table rows are needed.
66
+ :table_rows => [
67
+ {
68
+ :header => 'Scrubs',
69
+ :description => 'Body Scrub, Salt Scrub',
70
+ :final_urls => {
71
+ :urls => ['http://www.example.com/scrubs']
72
+ },
73
+ :price => {
74
+ :money => {
75
+ :micro_amount => 60 * MICROS_PER_DOLLAR
76
+ },
77
+ :currency_code => 'USD'
78
+ },
79
+ :price_unit => 'PER_HOUR'
80
+ },
81
+ {
82
+ :header => 'Hair Cuts',
83
+ :description => 'Once a month',
84
+ :final_urls => {
85
+ :urls => ['http://www.example.com/haircuts']
86
+ },
87
+ :price => {
88
+ :money => {
89
+ :micro_amount => 75 * MICROS_PER_DOLLAR
90
+ },
91
+ :currency_code => 'USD'
92
+ },
93
+ :price_unit => 'PER_MONTH'
94
+ },
95
+ {
96
+ :header => 'Skin Care Package',
97
+ :description => 'Four times a month',
98
+ :final_urls => {
99
+ :urls => ['http://www.example.com/skincarepackage']
100
+ },
101
+ :price => {
102
+ :money => {
103
+ :micro_amount => 250 * MICROS_PER_DOLLAR
104
+ },
105
+ :currency_code => 'USD'
106
+ },
107
+ :price_unit => 'PER_MONTH'
108
+ }
109
+ ]
110
+ }
111
+
112
+ customer_extension_setting = {
113
+ :extension_type => 'PRICE',
114
+ :extension_setting => {
115
+ :extensions => [price_feed_item]
116
+ }
117
+ }
118
+
119
+ operation = {
120
+ :operator => 'ADD',
121
+ :operand => customer_extension_setting
122
+ }
123
+
124
+ result = customer_extension_setting_srv.mutate([operation])
125
+
126
+ new_extension_setting = result[:value].first
127
+ puts "Extension setting with type '%s' was added to your account.\n" %
128
+ new_extension_setting[:extension_type]
129
+ end
130
+
131
+ if __FILE__ == $0
132
+ API_VERSION = :v201607
133
+
134
+ MICROS_PER_DOLLAR = 1000000
135
+
136
+ begin
137
+ # Campaign ID to add site link to.
138
+ campaign_id = 'INSERT_CAMPAIGN_ID_HERE'.to_i
139
+ add_prices(campaign_id)
140
+
141
+ # Authorization error.
142
+ rescue AdsCommon::Errors::OAuth2VerificationRequired => e
143
+ puts "Authorization credentials are not valid. Edit adwords_api.yml for " +
144
+ "OAuth2 client ID and secret and run misc/setup_oauth2.rb example " +
145
+ "to retrieve and store OAuth2 tokens."
146
+ puts "See this wiki page for more details:\n\n " +
147
+ 'https://github.com/googleads/google-api-ads-ruby/wiki/OAuth2'
148
+
149
+ # HTTP errors.
150
+ rescue AdsCommon::Errors::HttpError => e
151
+ puts "HTTP Error: %s" % e
152
+
153
+ # API errors.
154
+ rescue AdwordsApi::Errors::ApiException => e
155
+ puts "Message: %s" % e.message
156
+ puts 'Errors:'
157
+ e.errors.each_with_index do |error, index|
158
+ puts "\tError [%d]:" % (index + 1)
159
+ error.each do |field, value|
160
+ puts "\t\t%s: %s" % [field, value]
161
+ end
162
+ end
163
+ end
164
+ end