google-adwords-api 0.18.0 → 0.18.1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (171) hide show
  1. checksums.yaml +4 -4
  2. data/ChangeLog +8 -0
  3. data/examples/v201509/basic_operations/add_ad_groups.rb +4 -2
  4. data/examples/v201509/remarketing/add_crm_based_user_list.rb +2 -4
  5. data/examples/v201509/{advanced_operations → remarketing}/upload_offline_conversions.rb +6 -21
  6. data/examples/v201601/account_management/create_account.rb +88 -0
  7. data/examples/v201601/account_management/get_account_changes.rb +139 -0
  8. data/examples/v201601/account_management/get_account_hierarchy.rb +132 -0
  9. data/examples/v201601/advanced_operations/add_ad_customizers.rb +184 -0
  10. data/examples/v201601/advanced_operations/add_ad_group_bid_modifier.rb +101 -0
  11. data/examples/v201601/advanced_operations/add_click_to_download_ad.rb +133 -0
  12. data/examples/v201601/advanced_operations/add_html5_ad.rb +137 -0
  13. data/examples/v201601/advanced_operations/add_keywords_using_incremental_batch_job.rb +179 -0
  14. data/examples/v201601/advanced_operations/add_text_ad_with_upgraded_urls.rb +134 -0
  15. data/examples/v201601/advanced_operations/create_and_attach_shared_keyword_set.rb +141 -0
  16. data/examples/v201601/advanced_operations/find_and_remove_criteria_from_shared_set.rb +174 -0
  17. data/examples/v201601/advanced_operations/get_ad_group_bid_modifiers.rb +102 -0
  18. data/examples/v201601/advanced_operations/use_shared_bidding_strategy.rb +147 -0
  19. data/examples/v201601/basic_operations/add_ad_groups.rb +142 -0
  20. data/examples/v201601/basic_operations/add_campaigns.rb +139 -0
  21. data/examples/v201601/basic_operations/add_keywords.rb +114 -0
  22. data/examples/v201601/basic_operations/add_text_ads.rb +109 -0
  23. data/examples/v201601/basic_operations/get_ad_groups.rb +102 -0
  24. data/examples/v201601/basic_operations/get_campaigns.rb +97 -0
  25. data/examples/v201601/basic_operations/get_campaigns_with_awql.rb +89 -0
  26. data/examples/v201601/basic_operations/get_keywords.rb +109 -0
  27. data/examples/v201601/basic_operations/get_text_ads.rb +110 -0
  28. data/examples/v201601/basic_operations/pause_ad.rb +88 -0
  29. data/examples/v201601/basic_operations/remove_ad.rb +89 -0
  30. data/examples/v201601/basic_operations/remove_ad_group.rb +85 -0
  31. data/examples/v201601/basic_operations/remove_campaign.rb +87 -0
  32. data/examples/v201601/basic_operations/remove_keyword.rb +94 -0
  33. data/examples/v201601/basic_operations/update_ad_group.rb +85 -0
  34. data/examples/v201601/basic_operations/update_campaign.rb +86 -0
  35. data/examples/v201601/basic_operations/update_keyword.rb +106 -0
  36. data/examples/v201601/campaign_management/add_campaign_labels.rb +82 -0
  37. data/examples/v201601/campaign_management/add_complete_campaigns_using_batch_job.rb +356 -0
  38. data/examples/v201601/campaign_management/add_experiment.rb +162 -0
  39. data/examples/v201601/campaign_management/add_keywords_in_bulk.rb +153 -0
  40. data/examples/v201601/campaign_management/get_all_disapproved_ads.rb +97 -0
  41. data/examples/v201601/campaign_management/get_all_disapproved_ads_with_awql.rb +89 -0
  42. data/examples/v201601/campaign_management/get_campaigns_by_label.rb +108 -0
  43. data/examples/v201601/campaign_management/promote_experiment.rb +81 -0
  44. data/examples/v201601/campaign_management/set_ad_parameters.rb +118 -0
  45. data/examples/v201601/campaign_management/set_criterion_bid_modifier.rb +104 -0
  46. data/examples/v201601/campaign_management/validate_text_ad.rb +110 -0
  47. data/examples/v201601/error_handling/handle_partial_failures.rb +130 -0
  48. data/examples/v201601/error_handling/handle_policy_violation_error.rb +141 -0
  49. data/examples/v201601/extensions/add_google_my_business_location_extensions.rb +193 -0
  50. data/examples/v201601/extensions/add_site_links.rb +164 -0
  51. data/examples/v201601/extensions/add_site_links_using_feeds.rb +281 -0
  52. data/examples/v201601/migration/migrate_to_extension_settings.rb +386 -0
  53. data/examples/v201601/migration/upgrade_ad_url.rb +93 -0
  54. data/examples/v201601/misc/get_all_images_and_videos.rb +104 -0
  55. data/examples/v201601/misc/setup_oauth2.rb +84 -0
  56. data/examples/v201601/misc/upload_image.rb +93 -0
  57. data/examples/v201601/misc/upload_media_bundle.rb +90 -0
  58. data/examples/v201601/misc/use_oauth2_jwt.rb +93 -0
  59. data/examples/v201601/misc/use_runtime_config.rb +92 -0
  60. data/examples/v201601/optimization/estimate_keyword_traffic.rb +146 -0
  61. data/examples/v201601/optimization/get_keyword_bid_simulations.rb +95 -0
  62. data/examples/v201601/optimization/get_keyword_ideas.rb +126 -0
  63. data/examples/v201601/remarketing/add_audience.rb +118 -0
  64. data/examples/v201601/remarketing/add_conversion_tracker.rb +97 -0
  65. data/examples/v201601/remarketing/add_crm_based_user_list.rb +119 -0
  66. data/examples/v201601/remarketing/add_rule_based_user_lists.rb +167 -0
  67. data/examples/v201601/remarketing/upload_offline_conversions.rb +98 -0
  68. data/examples/v201601/reporting/download_criteria_report.rb +92 -0
  69. data/examples/v201601/reporting/download_criteria_report_with_awql.rb +93 -0
  70. data/examples/v201601/reporting/get_report_fields.rb +75 -0
  71. data/examples/v201601/reporting/parallel_report_download.rb +166 -0
  72. data/examples/v201601/reporting/stream_criteria_report_results.rb +97 -0
  73. data/examples/v201601/shopping_campaigns/add_product_partition_tree.rb +267 -0
  74. data/examples/v201601/shopping_campaigns/add_product_scope.rb +129 -0
  75. data/examples/v201601/shopping_campaigns/add_shopping_campaign.rb +129 -0
  76. data/examples/v201601/shopping_campaigns/get_product_category_taxonomy.rb +115 -0
  77. data/examples/v201601/targeting/add_campaign_targeting_criteria.rb +180 -0
  78. data/examples/v201601/targeting/add_demographic_targeting_criteria.rb +112 -0
  79. data/examples/v201601/targeting/get_campaign_targeting_criteria.rb +106 -0
  80. data/examples/v201601/targeting/get_targetable_languages_and_carriers.rb +89 -0
  81. data/examples/v201601/targeting/lookup_location.rb +108 -0
  82. data/lib/adwords_api/api_config.rb +90 -4
  83. data/lib/adwords_api/batch_job_utils.rb +29 -17
  84. data/lib/adwords_api/incremental_upload_helper.rb +5 -1
  85. data/lib/adwords_api/report_stream.rb +7 -8
  86. data/lib/adwords_api/report_utils.rb +4 -4
  87. data/lib/adwords_api/v201601/account_label_service.rb +46 -0
  88. data/lib/adwords_api/v201601/account_label_service_registry.rb +46 -0
  89. data/lib/adwords_api/v201601/ad_customizer_feed_service.rb +46 -0
  90. data/lib/adwords_api/v201601/ad_customizer_feed_service_registry.rb +46 -0
  91. data/lib/adwords_api/v201601/ad_group_ad_service.rb +70 -0
  92. data/lib/adwords_api/v201601/ad_group_ad_service_registry.rb +46 -0
  93. data/lib/adwords_api/v201601/ad_group_bid_modifier_service.rb +54 -0
  94. data/lib/adwords_api/v201601/ad_group_bid_modifier_service_registry.rb +46 -0
  95. data/lib/adwords_api/v201601/ad_group_criterion_service.rb +62 -0
  96. data/lib/adwords_api/v201601/ad_group_criterion_service_registry.rb +46 -0
  97. data/lib/adwords_api/v201601/ad_group_extension_setting_service.rb +54 -0
  98. data/lib/adwords_api/v201601/ad_group_extension_setting_service_registry.rb +46 -0
  99. data/lib/adwords_api/v201601/ad_group_feed_service.rb +54 -0
  100. data/lib/adwords_api/v201601/ad_group_feed_service_registry.rb +46 -0
  101. data/lib/adwords_api/v201601/ad_group_service.rb +62 -0
  102. data/lib/adwords_api/v201601/ad_group_service_registry.rb +46 -0
  103. data/lib/adwords_api/v201601/ad_param_service.rb +46 -0
  104. data/lib/adwords_api/v201601/ad_param_service_registry.rb +46 -0
  105. data/lib/adwords_api/v201601/adwords_user_list_service.rb +54 -0
  106. data/lib/adwords_api/v201601/adwords_user_list_service_registry.rb +46 -0
  107. data/lib/adwords_api/v201601/batch_job_service.rb +54 -0
  108. data/lib/adwords_api/v201601/batch_job_service_registry.rb +46 -0
  109. data/lib/adwords_api/v201601/bidding_strategy_service.rb +54 -0
  110. data/lib/adwords_api/v201601/bidding_strategy_service_registry.rb +46 -0
  111. data/lib/adwords_api/v201601/budget_order_service.rb +54 -0
  112. data/lib/adwords_api/v201601/budget_order_service_registry.rb +46 -0
  113. data/lib/adwords_api/v201601/budget_service.rb +54 -0
  114. data/lib/adwords_api/v201601/budget_service_registry.rb +46 -0
  115. data/lib/adwords_api/v201601/campaign_criterion_service.rb +54 -0
  116. data/lib/adwords_api/v201601/campaign_criterion_service_registry.rb +46 -0
  117. data/lib/adwords_api/v201601/campaign_extension_setting_service.rb +54 -0
  118. data/lib/adwords_api/v201601/campaign_extension_setting_service_registry.rb +46 -0
  119. data/lib/adwords_api/v201601/campaign_feed_service.rb +54 -0
  120. data/lib/adwords_api/v201601/campaign_feed_service_registry.rb +46 -0
  121. data/lib/adwords_api/v201601/campaign_service.rb +62 -0
  122. data/lib/adwords_api/v201601/campaign_service_registry.rb +46 -0
  123. data/lib/adwords_api/v201601/campaign_shared_set_service.rb +54 -0
  124. data/lib/adwords_api/v201601/campaign_shared_set_service_registry.rb +46 -0
  125. data/lib/adwords_api/v201601/constant_data_service.rb +110 -0
  126. data/lib/adwords_api/v201601/constant_data_service_registry.rb +46 -0
  127. data/lib/adwords_api/v201601/conversion_tracker_service.rb +54 -0
  128. data/lib/adwords_api/v201601/conversion_tracker_service_registry.rb +46 -0
  129. data/lib/adwords_api/v201601/customer_extension_setting_service.rb +54 -0
  130. data/lib/adwords_api/v201601/customer_extension_setting_service_registry.rb +46 -0
  131. data/lib/adwords_api/v201601/customer_feed_service.rb +54 -0
  132. data/lib/adwords_api/v201601/customer_feed_service_registry.rb +46 -0
  133. data/lib/adwords_api/v201601/customer_service.rb +54 -0
  134. data/lib/adwords_api/v201601/customer_service_registry.rb +46 -0
  135. data/lib/adwords_api/v201601/customer_sync_service.rb +38 -0
  136. data/lib/adwords_api/v201601/customer_sync_service_registry.rb +47 -0
  137. data/lib/adwords_api/v201601/data_service.rb +78 -0
  138. data/lib/adwords_api/v201601/data_service_registry.rb +46 -0
  139. data/lib/adwords_api/v201601/experiment_service.rb +46 -0
  140. data/lib/adwords_api/v201601/experiment_service_registry.rb +46 -0
  141. data/lib/adwords_api/v201601/feed_item_service.rb +54 -0
  142. data/lib/adwords_api/v201601/feed_item_service_registry.rb +46 -0
  143. data/lib/adwords_api/v201601/feed_mapping_service.rb +54 -0
  144. data/lib/adwords_api/v201601/feed_mapping_service_registry.rb +46 -0
  145. data/lib/adwords_api/v201601/feed_service.rb +54 -0
  146. data/lib/adwords_api/v201601/feed_service_registry.rb +46 -0
  147. data/lib/adwords_api/v201601/label_service.rb +54 -0
  148. data/lib/adwords_api/v201601/label_service_registry.rb +46 -0
  149. data/lib/adwords_api/v201601/location_criterion_service.rb +46 -0
  150. data/lib/adwords_api/v201601/location_criterion_service_registry.rb +46 -0
  151. data/lib/adwords_api/v201601/managed_customer_service.rb +78 -0
  152. data/lib/adwords_api/v201601/managed_customer_service_registry.rb +46 -0
  153. data/lib/adwords_api/v201601/media_service.rb +54 -0
  154. data/lib/adwords_api/v201601/media_service_registry.rb +46 -0
  155. data/lib/adwords_api/v201601/mutate_job_service.rb +54 -0
  156. data/lib/adwords_api/v201601/mutate_job_service_registry.rb +46 -0
  157. data/lib/adwords_api/v201601/offline_conversion_feed_service.rb +38 -0
  158. data/lib/adwords_api/v201601/offline_conversion_feed_service_registry.rb +46 -0
  159. data/lib/adwords_api/v201601/report_definition_service.rb +38 -0
  160. data/lib/adwords_api/v201601/report_definition_service_registry.rb +46 -0
  161. data/lib/adwords_api/v201601/shared_criterion_service.rb +54 -0
  162. data/lib/adwords_api/v201601/shared_criterion_service_registry.rb +46 -0
  163. data/lib/adwords_api/v201601/shared_set_service.rb +54 -0
  164. data/lib/adwords_api/v201601/shared_set_service_registry.rb +46 -0
  165. data/lib/adwords_api/v201601/targeting_idea_service.rb +38 -0
  166. data/lib/adwords_api/v201601/targeting_idea_service_registry.rb +46 -0
  167. data/lib/adwords_api/v201601/traffic_estimator_service.rb +38 -0
  168. data/lib/adwords_api/v201601/traffic_estimator_service_registry.rb +46 -0
  169. data/lib/adwords_api/version.rb +1 -1
  170. data/test/adwords_api/test_batch_job_utils.rb +11 -2
  171. metadata +163 -5
@@ -0,0 +1,118 @@
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 user list (a.k.a. Audience) and shows
20
+ # its associated conversion tracker code snippet.
21
+
22
+ require 'adwords_api'
23
+
24
+ def add_audience()
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
+ user_list_srv = adwords.service(:AdwordsUserListService, API_VERSION)
34
+ conv_tracker_srv = adwords.service(:ConversionTrackerService, API_VERSION)
35
+
36
+ # Prepare for adding remarketing user list.
37
+ name = "Mars cruise customers #%d" % (Time.new.to_f * 1000).to_i
38
+ operation = {
39
+ :operator => 'ADD',
40
+ :operand => {
41
+ # The 'xsi_type' field allows you to specify the xsi:type of the object
42
+ # being created. It's only necessary when you must provide an explicit
43
+ # type that the client library can't infer.
44
+ :xsi_type => 'BasicUserList',
45
+ :name => name,
46
+ :description => 'A list of mars cruise customers in the last year',
47
+ :membership_life_span => 365,
48
+ :conversion_types => [{:name => name}],
49
+ # Optional field.
50
+ :status => 'OPEN'
51
+ }
52
+ }
53
+
54
+ # Add user list.
55
+ response = user_list_srv.mutate([operation])
56
+ if response and response[:value]
57
+ user_list = response[:value].first
58
+
59
+ # Get conversion snippets.
60
+ if user_list and user_list[:conversion_types]
61
+ conversion_ids = user_list[:conversion_types][:id]
62
+ selector = {
63
+ # We're actually interested in the 'Snippet' field, which is returned
64
+ # automatically.
65
+ :fields => ['Id'],
66
+ :predicates => [
67
+ {:field => 'Id', :operator => 'IN', :values => [conversion_ids]}
68
+ ]
69
+ }
70
+ conv_tracker_response = conv_tracker_srv.get(selector)
71
+ if conv_tracker_response and conv_tracker_response[:entries]
72
+ conversions = conv_tracker_response[:entries]
73
+ end
74
+ end
75
+ puts "User list with name '%s' and ID %d was added." %
76
+ [user_list[:name], user_list[:id]]
77
+ # Display user list associated conversion code snippets.
78
+ if conversions
79
+ conversions.each do |conversion|
80
+ puts "Conversion type code snipped associated to the list:\n\t\t%s\n" %
81
+ conversion[:snippet]
82
+ end
83
+ end
84
+ else
85
+ puts 'No user lists were added.'
86
+ end
87
+ end
88
+
89
+ if __FILE__ == $0
90
+ API_VERSION = :v201601
91
+
92
+ begin
93
+ add_audience()
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
+ 'https://github.com/googleads/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
@@ -0,0 +1,97 @@
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 add an AdWords conversion tracker.
20
+
21
+ require 'adwords_api'
22
+
23
+ def add_conversion_tracker()
24
+ # AdwordsApi::Api will read a config file from ENV['HOME']/adwords_api.yml
25
+ # when called without parameters.
26
+ adwords = AdwordsApi::Api.new
27
+
28
+ # To enable logging of SOAP requests, set the log_level value to 'DEBUG' in
29
+ # the configuration file or provide your own logger:
30
+ # adwords.logger = Logger.new('adwords_xml.log')
31
+
32
+ conv_tracker_srv = adwords.service(:ConversionTrackerService, API_VERSION)
33
+
34
+ # Prepare for adding conversion.
35
+ operation = {
36
+ :operator => 'ADD',
37
+ :operand => {
38
+ # The 'xsi_type' field allows you to specify the xsi:type of the object
39
+ # being created. It's only necessary when you must provide an explicit
40
+ # type that the client library can't infer.
41
+ :xsi_type => 'AdWordsConversionTracker',
42
+ :name => "Earth to Mars Cruises Conversion #%d" %
43
+ (Time.new.to_f * 1000).to_i,
44
+ :category => 'DEFAULT',
45
+ :text_format => 'HIDDEN',
46
+ # Optional fields:
47
+ :status => 'ENABLED',
48
+ :viewthrough_lookback_window => 15,
49
+ :conversion_page_language => 'en',
50
+ :background_color => '#0000FF',
51
+ :default_revenue_value => 23.41,
52
+ :always_use_default_revenue_value => true
53
+ }
54
+ }
55
+
56
+ # Add conversion.
57
+ response = conv_tracker_srv.mutate([operation])
58
+ if response and response[:value]
59
+ conversion = response[:value].first
60
+ puts ("Conversion with ID %d, name '%s', status '%s' and category '%s'" +
61
+ " was added.") % [conversion[:id], conversion[:name],
62
+ conversion[:status], conversion[:category]]
63
+ else
64
+ puts 'No conversions were added.'
65
+ end
66
+ end
67
+
68
+ if __FILE__ == $0
69
+ API_VERSION = :v201601
70
+
71
+ begin
72
+ add_conversion_tracker()
73
+
74
+ # Authorization error.
75
+ rescue AdsCommon::Errors::OAuth2VerificationRequired => e
76
+ puts "Authorization credentials are not valid. Edit adwords_api.yml for " +
77
+ "OAuth2 client ID and secret and run misc/setup_oauth2.rb example " +
78
+ "to retrieve and store OAuth2 tokens."
79
+ puts "See this wiki page for more details:\n\n " +
80
+ 'https://github.com/googleads/google-api-ads-ruby/wiki/OAuth2'
81
+
82
+ # HTTP errors.
83
+ rescue AdsCommon::Errors::HttpError => e
84
+ puts "HTTP Error: %s" % e
85
+
86
+ # API errors.
87
+ rescue AdwordsApi::Errors::ApiException => e
88
+ puts "Message: %s" % e.message
89
+ puts 'Errors:'
90
+ e.errors.each_with_index do |error, index|
91
+ puts "\tError [%d]:" % (index + 1)
92
+ error.each do |field, value|
93
+ puts "\t\t%s: %s" % [field, value]
94
+ end
95
+ end
96
+ end
97
+ end
@@ -0,0 +1,119 @@
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 example adds a remarketing user list (a.k.a. audience) and uploads
20
+ # hashed email addresses to populate the list.
21
+ #
22
+ # Note: It may take several hours for the list to be populated with members.
23
+ # Email addresses must be associated with a Google account. For privacy
24
+ # purposes, the user list size will show as zero until the list has at least
25
+ # 1000 members. After that, the size will be rounded to the two most
26
+ # significant digits.
27
+
28
+ require 'adwords_api'
29
+ require 'digest'
30
+
31
+ def add_crm_based_user_list(emails)
32
+ # AdwordsApi::Api will read a config file from ENV['HOME']/adwords_api.yml
33
+ # when called without parameters.
34
+ adwords = AdwordsApi::Api.new
35
+
36
+ # To enable logging of SOAP requests, set the log_level value to 'DEBUG' in
37
+ # the configuration file or provide your own logger:
38
+ # adwords.logger = Logger.new('adwords_xml.log')
39
+
40
+ user_list_srv = adwords.service(:AdwordsUserListService, API_VERSION)
41
+
42
+ user_list = {
43
+ :xsi_type => 'CrmBasedUserList',
44
+ :name => 'Customer relationship management list #%d' % Time.new.usec,
45
+ :description => 'A list of customers that originated from email addresses',
46
+ # Maximum life span is 180 days.
47
+ :membership_life_span => 180,
48
+ # This field is optional. It links to a service you created that allows
49
+ # members of this list to remove themselves.
50
+ :opt_out_link => 'http://endpoint1.example.com/optout'
51
+ }
52
+
53
+ operation = {
54
+ :operand => user_list,
55
+ :operator => 'ADD'
56
+ }
57
+
58
+ result = user_list_srv.mutate([operation])
59
+ user_list_id = result[:value].first[:id]
60
+
61
+ sha_digest = Digest::SHA256.new
62
+ hashed_emails = emails.map do |email|
63
+ # Remove leading and trailing whitespace and convert all characters to
64
+ # lowercase before generating the hashed version.
65
+ email = email.strip.downcase
66
+ sha_digest.hexdigest(email)
67
+ end
68
+
69
+ mutate_members_operation = {
70
+ :operand => {
71
+ :user_list_id => user_list_id,
72
+ :data_type => 'EMAIL_SHA256',
73
+ :members => hashed_emails
74
+ },
75
+ :operator => 'ADD'
76
+ }
77
+
78
+ mutate_members_result =
79
+ user_list_srv.mutate_members([mutate_members_operation])
80
+
81
+ mutate_members_result[:user_lists].each do |user_list|
82
+ puts "User list with name '%s' and ID '%d' was added." %
83
+ [user_list[:name], user_list[:id]]
84
+ end
85
+ end
86
+
87
+ if __FILE__ == $0
88
+ API_VERSION = :v201601
89
+
90
+ emails = ['customer1@example.com', 'customer2@example.com',
91
+ ' Customer3@example.com ']
92
+
93
+ begin
94
+ add_crm_based_user_list(emails)
95
+
96
+ # Authorization error.
97
+ rescue AdsCommon::Errors::OAuth2VerificationRequired => e
98
+ puts "Authorization credentials are not valid. Edit adwords_api.yml for " +
99
+ "OAuth2 client ID and secret and run misc/setup_oauth2.rb example " +
100
+ "to retrieve and store OAuth2 tokens."
101
+ puts "See this wiki page for more details:\n\n " +
102
+ 'https://github.com/googleads/google-api-ads-ruby/wiki/OAuth2'
103
+
104
+ # HTTP errors.
105
+ rescue AdsCommon::Errors::HttpError => e
106
+ puts "HTTP Error: %s" % e
107
+
108
+ # API errors.
109
+ rescue AdwordsApi::Errors::ApiException => e
110
+ puts "Message: %s" % e.message
111
+ puts 'Errors:'
112
+ e.errors.each_with_index do |error, index|
113
+ puts "\tError [%d]:" % (index + 1)
114
+ error.each do |field, value|
115
+ puts "\t\t%s: %s" % [field, value]
116
+ end
117
+ end
118
+ end
119
+ end
@@ -0,0 +1,167 @@
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 two rule-based remarketing user lists: one with no site
20
+ # visit data restrictions, and another that will only include users who visit
21
+ # your site in the next six months.
22
+
23
+ require 'adwords_api'
24
+
25
+ def add_rule_based_user_lists()
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
+ user_list_srv = adwords.service(:AdwordsUserListService, API_VERSION)
35
+
36
+ # First rule item group - users who visited the checkout page and had more
37
+ # than one item in their shopping cart.
38
+ cart_rule_item = {
39
+ :xsi_type => 'StringRuleItem',
40
+ :key => {
41
+ :name => 'ecomm_pagetype'
42
+ },
43
+ :op => 'EQUALS',
44
+ :value => 'checkout'
45
+ }
46
+
47
+ cart_size_rule_item = {
48
+ :xsi_type => 'NumberRuleItem',
49
+ :key => {
50
+ :name => 'cartsize'
51
+ },
52
+ :op => 'GREATER_THAN',
53
+ :value => 1.0
54
+ }
55
+
56
+ # Combine the two rule items into a RuleItemGroup so AdWords will AND
57
+ # their rules together.
58
+ checkout_multiple_item_group = {
59
+ :items => [cart_rule_item, cart_size_rule_item]
60
+ }
61
+
62
+ # Second rule item group - users who checked out after October 31st
63
+ # and before January 1st.
64
+ start_date_rule_item = {
65
+ :xsi_type => 'DateRuleItem',
66
+ :key => {
67
+ :name => 'checkoutdate'
68
+ },
69
+ :op => 'AFTER',
70
+ :value => '20141031'
71
+ }
72
+
73
+ end_date_rule_item = {
74
+ :xsi_type => 'DateRuleItem',
75
+ :key => {
76
+ :name => 'checkoutdate'
77
+ },
78
+ :op => 'BEFORE',
79
+ :value => '20150101'
80
+ }
81
+
82
+ # Combine the date rule items into a RuleItemGroup.
83
+ checked_out_nov_dec_item_group = {
84
+ :items => [start_date_rule_item, end_date_rule_item]
85
+ }
86
+
87
+ # Combine the rule item groups into a Rule so AdWords will OR the
88
+ # groups together.
89
+ rule = {
90
+ :groups => [checkout_multiple_item_group, checked_out_nov_dec_item_group]
91
+ }
92
+
93
+ # Create the user list with no restrictions on site visit date.
94
+ expression_user_list = {
95
+ :xsi_type => 'ExpressionRuleUserList',
96
+ :name => 'Users who checked out in November or December OR ' +
97
+ 'visited the checkout page with more than one item in their cart',
98
+ :description => 'Expression based user list',
99
+ :rule => rule
100
+ }
101
+
102
+ # Create the user list restricted to users who visit your site within the
103
+ # specified timeframe.
104
+ date_user_list = {
105
+ :xsi_type => 'DateSpecificRuleUserList',
106
+ :name => 'Date rule user list created at ' + Time.now.to_s,
107
+ :description => 'Users who visited the site between 20141031 and ' +
108
+ '20150331 and checked out in November or December OR visited the ' +
109
+ 'checkout page with more than one item in their cart',
110
+ # We re-use the rule here. To avoid side effects, we need a deep copy.
111
+ :rule => Marshal.load(Marshal.dump(rule)),
112
+ # Set the start and end dates of the user list.
113
+ :start_date => '20141031',
114
+ :end_date => '20150331'
115
+ }
116
+
117
+ # Create operations to add the user lists.
118
+ operations = [expression_user_list, date_user_list].map do |user_list|
119
+ {
120
+ :operand => user_list,
121
+ :operator => 'ADD'
122
+ }
123
+ end
124
+
125
+ # Submit the operations.
126
+ response = user_list_srv.mutate(operations)
127
+
128
+ # Display the results.
129
+ response[:value].each do |user_list|
130
+ puts ("User list added with ID %d, name '%s', status '%s', " +
131
+ "list type '%s', accountUserListStatus '%s', description '%s'.") %
132
+ [user_list[:id], user_list[:name], user_list[:status],
133
+ user_list[:list_type], user_list[:account_user_list_status],
134
+ user_list[:description]]
135
+ end
136
+ end
137
+
138
+ if __FILE__ == $0
139
+ API_VERSION = :v201601
140
+
141
+ begin
142
+ add_rule_based_user_lists()
143
+
144
+ # Authorization error.
145
+ rescue AdsCommon::Errors::OAuth2VerificationRequired => e
146
+ puts "Authorization credentials are not valid. Edit adwords_api.yml for " +
147
+ "OAuth2 client ID and secret and run misc/setup_oauth2.rb example " +
148
+ "to retrieve and store OAuth2 tokens."
149
+ puts "See this wiki page for more details:\n\n " +
150
+ 'https://github.com/googleads/google-api-ads-ruby/wiki/OAuth2'
151
+
152
+ # HTTP errors.
153
+ rescue AdsCommon::Errors::HttpError => e
154
+ puts "HTTP Error: %s" % e
155
+
156
+ # API errors.
157
+ rescue AdwordsApi::Errors::ApiException => e
158
+ puts "Message: %s" % e.message
159
+ puts 'Errors:'
160
+ e.errors.each_with_index do |error, index|
161
+ puts "\tError [%d]:" % (index + 1)
162
+ error.each do |field, value|
163
+ puts "\t\t%s: %s" % [field, value]
164
+ end
165
+ end
166
+ end
167
+ end