google-adwords-api 0.21.1 → 0.22.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (182) hide show
  1. checksums.yaml +4 -4
  2. data/ChangeLog +3 -0
  3. data/examples/{v201603/basic_operations/remove_campaign.rb → v201609/account_management/accept_service_link.rb} +24 -20
  4. data/examples/v201609/advanced_operations/add_universal_app_campaign.rb +3 -0
  5. data/examples/v201609/advanced_operations/use_portfolio_bidding_strategy.rb +3 -0
  6. data/examples/v201609/basic_operations/add_campaigns.rb +3 -0
  7. data/examples/v201609/campaign_management/add_complete_campaigns_using_batch_job.rb +3 -0
  8. data/examples/v201609/misc/use_oauth2_jwt.rb +1 -1
  9. data/examples/v201609/shopping_campaigns/add_shopping_campaign.rb +4 -0
  10. data/lib/adwords_api/api_config.rb +0 -92
  11. data/lib/adwords_api/version.rb +1 -1
  12. data/test/adwords_api/test_choices.rb +88 -25
  13. metadata +5 -174
  14. data/examples/v201603/account_management/create_account.rb +0 -88
  15. data/examples/v201603/account_management/get_account_changes.rb +0 -135
  16. data/examples/v201603/account_management/get_account_hierarchy.rb +0 -132
  17. data/examples/v201603/advanced_operations/add_ad_customizers.rb +0 -184
  18. data/examples/v201603/advanced_operations/add_ad_group_bid_modifier.rb +0 -101
  19. data/examples/v201603/advanced_operations/add_click_to_download_ad.rb +0 -133
  20. data/examples/v201603/advanced_operations/add_html5_ad.rb +0 -137
  21. data/examples/v201603/advanced_operations/add_text_ad_with_upgraded_urls.rb +0 -134
  22. data/examples/v201603/advanced_operations/create_and_attach_shared_keyword_set.rb +0 -141
  23. data/examples/v201603/advanced_operations/find_and_remove_criteria_from_shared_set.rb +0 -174
  24. data/examples/v201603/advanced_operations/get_ad_group_bid_modifiers.rb +0 -102
  25. data/examples/v201603/advanced_operations/use_portfolio_bidding_strategy.rb +0 -146
  26. data/examples/v201603/basic_operations/add_ad_groups.rb +0 -142
  27. data/examples/v201603/basic_operations/add_campaigns.rb +0 -138
  28. data/examples/v201603/basic_operations/add_keywords.rb +0 -114
  29. data/examples/v201603/basic_operations/add_text_ads.rb +0 -109
  30. data/examples/v201603/basic_operations/get_ad_groups.rb +0 -102
  31. data/examples/v201603/basic_operations/get_campaigns.rb +0 -97
  32. data/examples/v201603/basic_operations/get_campaigns_with_awql.rb +0 -89
  33. data/examples/v201603/basic_operations/get_keywords.rb +0 -109
  34. data/examples/v201603/basic_operations/get_text_ads.rb +0 -110
  35. data/examples/v201603/basic_operations/pause_ad.rb +0 -88
  36. data/examples/v201603/basic_operations/remove_ad.rb +0 -89
  37. data/examples/v201603/basic_operations/remove_ad_group.rb +0 -85
  38. data/examples/v201603/basic_operations/remove_keyword.rb +0 -94
  39. data/examples/v201603/basic_operations/update_ad_group.rb +0 -85
  40. data/examples/v201603/basic_operations/update_campaign.rb +0 -86
  41. data/examples/v201603/basic_operations/update_keyword.rb +0 -106
  42. data/examples/v201603/campaign_management/add_campaign_labels.rb +0 -82
  43. data/examples/v201603/campaign_management/add_complete_campaigns_using_batch_job.rb +0 -355
  44. data/examples/v201603/campaign_management/add_draft.rb +0 -114
  45. data/examples/v201603/campaign_management/add_experiment.rb +0 -162
  46. data/examples/v201603/campaign_management/add_keywords_using_incremental_batch_job.rb +0 -210
  47. data/examples/v201603/campaign_management/add_trial.rb +0 -142
  48. data/examples/v201603/campaign_management/get_all_disapproved_ads.rb +0 -97
  49. data/examples/v201603/campaign_management/get_all_disapproved_ads_with_awql.rb +0 -89
  50. data/examples/v201603/campaign_management/get_campaigns_by_label.rb +0 -108
  51. data/examples/v201603/campaign_management/graduate_trial.rb +0 -106
  52. data/examples/v201603/campaign_management/promote_experiment.rb +0 -81
  53. data/examples/v201603/campaign_management/set_ad_parameters.rb +0 -118
  54. data/examples/v201603/campaign_management/set_criterion_bid_modifier.rb +0 -104
  55. data/examples/v201603/campaign_management/validate_text_ad.rb +0 -110
  56. data/examples/v201603/error_handling/handle_partial_failures.rb +0 -130
  57. data/examples/v201603/error_handling/handle_policy_violation_error.rb +0 -141
  58. data/examples/v201603/extensions/add_google_my_business_location_extensions.rb +0 -193
  59. data/examples/v201603/extensions/add_site_links.rb +0 -184
  60. data/examples/v201603/extensions/add_site_links_using_feeds.rb +0 -281
  61. data/examples/v201603/migration/migrate_to_extension_settings.rb +0 -386
  62. data/examples/v201603/migration/upgrade_ad_url.rb +0 -93
  63. data/examples/v201603/misc/get_all_images_and_videos.rb +0 -104
  64. data/examples/v201603/misc/setup_oauth2.rb +0 -84
  65. data/examples/v201603/misc/upload_image.rb +0 -93
  66. data/examples/v201603/misc/upload_media_bundle.rb +0 -90
  67. data/examples/v201603/misc/use_oauth2_jwt.rb +0 -93
  68. data/examples/v201603/misc/use_runtime_config.rb +0 -92
  69. data/examples/v201603/optimization/estimate_keyword_traffic.rb +0 -146
  70. data/examples/v201603/optimization/get_campaign_criterion_bid_modifier_simulations.rb +0 -128
  71. data/examples/v201603/optimization/get_keyword_bid_simulations.rb +0 -95
  72. data/examples/v201603/optimization/get_keyword_ideas.rb +0 -136
  73. data/examples/v201603/remarketing/add_audience.rb +0 -118
  74. data/examples/v201603/remarketing/add_conversion_tracker.rb +0 -97
  75. data/examples/v201603/remarketing/add_crm_based_user_list.rb +0 -116
  76. data/examples/v201603/remarketing/add_rule_based_user_lists.rb +0 -167
  77. data/examples/v201603/remarketing/upload_offline_conversions.rb +0 -98
  78. data/examples/v201603/reporting/download_criteria_report.rb +0 -92
  79. data/examples/v201603/reporting/download_criteria_report_with_awql.rb +0 -93
  80. data/examples/v201603/reporting/get_report_fields.rb +0 -75
  81. data/examples/v201603/reporting/parallel_report_download.rb +0 -164
  82. data/examples/v201603/reporting/stream_criteria_report_results.rb +0 -97
  83. data/examples/v201603/shopping_campaigns/add_product_partition_tree.rb +0 -267
  84. data/examples/v201603/shopping_campaigns/add_product_scope.rb +0 -130
  85. data/examples/v201603/shopping_campaigns/add_shopping_campaign.rb +0 -129
  86. data/examples/v201603/shopping_campaigns/get_product_category_taxonomy.rb +0 -115
  87. data/examples/v201603/targeting/add_campaign_targeting_criteria.rb +0 -180
  88. data/examples/v201603/targeting/add_demographic_targeting_criteria.rb +0 -112
  89. data/examples/v201603/targeting/get_campaign_targeting_criteria.rb +0 -106
  90. data/examples/v201603/targeting/get_targetable_languages_and_carriers.rb +0 -89
  91. data/examples/v201603/targeting/lookup_location.rb +0 -108
  92. data/lib/adwords_api/v201603/account_label_service.rb +0 -46
  93. data/lib/adwords_api/v201603/account_label_service_registry.rb +0 -46
  94. data/lib/adwords_api/v201603/ad_customizer_feed_service.rb +0 -46
  95. data/lib/adwords_api/v201603/ad_customizer_feed_service_registry.rb +0 -46
  96. data/lib/adwords_api/v201603/ad_group_ad_service.rb +0 -70
  97. data/lib/adwords_api/v201603/ad_group_ad_service_registry.rb +0 -46
  98. data/lib/adwords_api/v201603/ad_group_bid_modifier_service.rb +0 -54
  99. data/lib/adwords_api/v201603/ad_group_bid_modifier_service_registry.rb +0 -46
  100. data/lib/adwords_api/v201603/ad_group_criterion_service.rb +0 -62
  101. data/lib/adwords_api/v201603/ad_group_criterion_service_registry.rb +0 -46
  102. data/lib/adwords_api/v201603/ad_group_extension_setting_service.rb +0 -54
  103. data/lib/adwords_api/v201603/ad_group_extension_setting_service_registry.rb +0 -46
  104. data/lib/adwords_api/v201603/ad_group_feed_service.rb +0 -54
  105. data/lib/adwords_api/v201603/ad_group_feed_service_registry.rb +0 -46
  106. data/lib/adwords_api/v201603/ad_group_service.rb +0 -62
  107. data/lib/adwords_api/v201603/ad_group_service_registry.rb +0 -46
  108. data/lib/adwords_api/v201603/ad_param_service.rb +0 -46
  109. data/lib/adwords_api/v201603/ad_param_service_registry.rb +0 -46
  110. data/lib/adwords_api/v201603/adwords_user_list_service.rb +0 -62
  111. data/lib/adwords_api/v201603/adwords_user_list_service_registry.rb +0 -46
  112. data/lib/adwords_api/v201603/batch_job_service.rb +0 -54
  113. data/lib/adwords_api/v201603/batch_job_service_registry.rb +0 -46
  114. data/lib/adwords_api/v201603/bidding_strategy_service.rb +0 -54
  115. data/lib/adwords_api/v201603/bidding_strategy_service_registry.rb +0 -46
  116. data/lib/adwords_api/v201603/budget_order_service.rb +0 -54
  117. data/lib/adwords_api/v201603/budget_order_service_registry.rb +0 -46
  118. data/lib/adwords_api/v201603/budget_service.rb +0 -54
  119. data/lib/adwords_api/v201603/budget_service_registry.rb +0 -46
  120. data/lib/adwords_api/v201603/campaign_criterion_service.rb +0 -54
  121. data/lib/adwords_api/v201603/campaign_criterion_service_registry.rb +0 -46
  122. data/lib/adwords_api/v201603/campaign_extension_setting_service.rb +0 -54
  123. data/lib/adwords_api/v201603/campaign_extension_setting_service_registry.rb +0 -46
  124. data/lib/adwords_api/v201603/campaign_feed_service.rb +0 -54
  125. data/lib/adwords_api/v201603/campaign_feed_service_registry.rb +0 -46
  126. data/lib/adwords_api/v201603/campaign_service.rb +0 -62
  127. data/lib/adwords_api/v201603/campaign_service_registry.rb +0 -46
  128. data/lib/adwords_api/v201603/campaign_shared_set_service.rb +0 -54
  129. data/lib/adwords_api/v201603/campaign_shared_set_service_registry.rb +0 -46
  130. data/lib/adwords_api/v201603/constant_data_service.rb +0 -110
  131. data/lib/adwords_api/v201603/constant_data_service_registry.rb +0 -46
  132. data/lib/adwords_api/v201603/conversion_tracker_service.rb +0 -54
  133. data/lib/adwords_api/v201603/conversion_tracker_service_registry.rb +0 -46
  134. data/lib/adwords_api/v201603/customer_extension_setting_service.rb +0 -54
  135. data/lib/adwords_api/v201603/customer_extension_setting_service_registry.rb +0 -46
  136. data/lib/adwords_api/v201603/customer_feed_service.rb +0 -54
  137. data/lib/adwords_api/v201603/customer_feed_service_registry.rb +0 -46
  138. data/lib/adwords_api/v201603/customer_service.rb +0 -54
  139. data/lib/adwords_api/v201603/customer_service_registry.rb +0 -46
  140. data/lib/adwords_api/v201603/customer_sync_service.rb +0 -38
  141. data/lib/adwords_api/v201603/customer_sync_service_registry.rb +0 -47
  142. data/lib/adwords_api/v201603/data_service.rb +0 -94
  143. data/lib/adwords_api/v201603/data_service_registry.rb +0 -46
  144. data/lib/adwords_api/v201603/draft_async_error_service.rb +0 -46
  145. data/lib/adwords_api/v201603/draft_async_error_service_registry.rb +0 -46
  146. data/lib/adwords_api/v201603/draft_service.rb +0 -54
  147. data/lib/adwords_api/v201603/draft_service_registry.rb +0 -46
  148. data/lib/adwords_api/v201603/experiment_service.rb +0 -46
  149. data/lib/adwords_api/v201603/experiment_service_registry.rb +0 -46
  150. data/lib/adwords_api/v201603/feed_item_service.rb +0 -54
  151. data/lib/adwords_api/v201603/feed_item_service_registry.rb +0 -46
  152. data/lib/adwords_api/v201603/feed_mapping_service.rb +0 -54
  153. data/lib/adwords_api/v201603/feed_mapping_service_registry.rb +0 -46
  154. data/lib/adwords_api/v201603/feed_service.rb +0 -54
  155. data/lib/adwords_api/v201603/feed_service_registry.rb +0 -46
  156. data/lib/adwords_api/v201603/label_service.rb +0 -54
  157. data/lib/adwords_api/v201603/label_service_registry.rb +0 -46
  158. data/lib/adwords_api/v201603/location_criterion_service.rb +0 -46
  159. data/lib/adwords_api/v201603/location_criterion_service_registry.rb +0 -46
  160. data/lib/adwords_api/v201603/managed_customer_service.rb +0 -78
  161. data/lib/adwords_api/v201603/managed_customer_service_registry.rb +0 -46
  162. data/lib/adwords_api/v201603/media_service.rb +0 -54
  163. data/lib/adwords_api/v201603/media_service_registry.rb +0 -46
  164. data/lib/adwords_api/v201603/offline_conversion_feed_service.rb +0 -38
  165. data/lib/adwords_api/v201603/offline_conversion_feed_service_registry.rb +0 -46
  166. data/lib/adwords_api/v201603/report_definition_service.rb +0 -38
  167. data/lib/adwords_api/v201603/report_definition_service_registry.rb +0 -46
  168. data/lib/adwords_api/v201603/shared_criterion_service.rb +0 -54
  169. data/lib/adwords_api/v201603/shared_criterion_service_registry.rb +0 -46
  170. data/lib/adwords_api/v201603/shared_set_service.rb +0 -54
  171. data/lib/adwords_api/v201603/shared_set_service_registry.rb +0 -46
  172. data/lib/adwords_api/v201603/targeting_idea_service.rb +0 -38
  173. data/lib/adwords_api/v201603/targeting_idea_service_registry.rb +0 -46
  174. data/lib/adwords_api/v201603/traffic_estimator_service.rb +0 -38
  175. data/lib/adwords_api/v201603/traffic_estimator_service_registry.rb +0 -46
  176. data/lib/adwords_api/v201603/trial_async_error_service.rb +0 -46
  177. data/lib/adwords_api/v201603/trial_async_error_service_registry.rb +0 -46
  178. data/lib/adwords_api/v201603/trial_service.rb +0 -54
  179. data/lib/adwords_api/v201603/trial_service_registry.rb +0 -46
  180. data/test/templates/v201603/basic_operations_get_campaigns.def +0 -116
  181. data/test/templates/v201603/basic_operations_update_keyword.def +0 -125
  182. data/test/templates/v201603/misc_use_oauth2_jwt.def +0 -131
@@ -1,116 +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 example adds a user list (a.k.a. audience) and uploads hashed email
20
- # 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
- }
49
-
50
- operation = {
51
- :operand => user_list,
52
- :operator => 'ADD'
53
- }
54
-
55
- result = user_list_srv.mutate([operation])
56
- user_list_id = result[:value].first[:id]
57
-
58
- sha_digest = Digest::SHA256.new
59
- hashed_emails = emails.map do |email|
60
- # Remove leading and trailing whitespace and convert all characters to
61
- # lowercase before generating the hashed version.
62
- email = email.strip.downcase
63
- sha_digest.hexdigest(email)
64
- end
65
-
66
- mutate_members_operation = {
67
- :operand => {
68
- :user_list_id => user_list_id,
69
- :data_type => 'EMAIL_SHA256',
70
- :members => hashed_emails
71
- },
72
- :operator => 'ADD'
73
- }
74
-
75
- mutate_members_result =
76
- user_list_srv.mutate_members([mutate_members_operation])
77
-
78
- mutate_members_result[:user_lists].each do |user_list|
79
- puts "User list with name '%s' and ID '%d' was added." %
80
- [user_list[:name], user_list[:id]]
81
- end
82
- end
83
-
84
- if __FILE__ == $0
85
- API_VERSION = :v201603
86
-
87
- emails = ['customer1@example.com', 'customer2@example.com',
88
- ' Customer3@example.com ']
89
-
90
- begin
91
- add_crm_based_user_list(emails)
92
-
93
- # Authorization error.
94
- rescue AdsCommon::Errors::OAuth2VerificationRequired => e
95
- puts "Authorization credentials are not valid. Edit adwords_api.yml for " +
96
- "OAuth2 client ID and secret and run misc/setup_oauth2.rb example " +
97
- "to retrieve and store OAuth2 tokens."
98
- puts "See this wiki page for more details:\n\n " +
99
- 'https://github.com/googleads/google-api-ads-ruby/wiki/OAuth2'
100
-
101
- # HTTP errors.
102
- rescue AdsCommon::Errors::HttpError => e
103
- puts "HTTP Error: %s" % e
104
-
105
- # API errors.
106
- rescue AdwordsApi::Errors::ApiException => e
107
- puts "Message: %s" % e.message
108
- puts 'Errors:'
109
- e.errors.each_with_index do |error, index|
110
- puts "\tError [%d]:" % (index + 1)
111
- error.each do |field, value|
112
- puts "\t\t%s: %s" % [field, value]
113
- end
114
- end
115
- end
116
- end
@@ -1,167 +0,0 @@
1
- #!/usr/bin/env ruby
2
- # Encoding: utf-8
3
- #
4
- # Copyright:: Copyright 2014, Google Inc. All Rights Reserved.
5
- #
6
- # License:: Licensed under the Apache License, Version 2.0 (the "License");
7
- # you may not use this file except in compliance with the License.
8
- # You may obtain a copy of the License at
9
- #
10
- # http://www.apache.org/licenses/LICENSE-2.0
11
- #
12
- # Unless required by applicable law or agreed to in writing, software
13
- # distributed under the License is distributed on an "AS IS" BASIS,
14
- # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
15
- # implied.
16
- # See the License for the specific language governing permissions and
17
- # limitations under the License.
18
- #
19
- # This example 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 = :v201603
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
@@ -1,98 +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 imports offline conversion values for specific clicks to
20
- # your account. To get Google Click ID for a click, run
21
- # CLICK_PERFORMANCE_REPORT. To set up a conversion tracker, run the
22
- # add_conversion_tracker.rb example.
23
-
24
- require 'adwords_api'
25
- require 'date'
26
-
27
- def upload_offline_conversions(conversion_name, google_click_id,
28
- conversion_time, conversion_value)
29
- # AdwordsApi::Api will read a config file from ENV['HOME']/adwords_api.yml
30
- # when called without parameters.
31
- adwords = AdwordsApi::Api.new
32
-
33
- # To enable logging of SOAP requests, set the log_level value to 'DEBUG' in
34
- # the configuration file or provide your own logger:
35
- # adwords.logger = Logger.new('adwords_xml.log')
36
-
37
- conversion_feed_srv =
38
- adwords.service(:OfflineConversionFeedService, API_VERSION)
39
-
40
- # Associate offline conversions with the existing named conversion tracker. If
41
- # this tracker was newly created, it may be a few hours before it can accept
42
- # conversions.
43
- feed = {
44
- :conversion_name => conversion_name,
45
- :google_click_id => google_click_id,
46
- :conversion_time => conversion_time,
47
- :conversion_value => conversion_value
48
- }
49
- return_feeds = conversion_feed_srv.mutate([
50
- {:operator => 'ADD', :operand => feed}])
51
- return_feeds[:value].each do |return_feed|
52
- puts ("Uploaded offline conversion value %.2f for Google Click ID '%s', " +
53
- 'to %s') % [return_feed[:conversion_value],
54
- return_feed[:google_click_id],
55
- return_feed[:conversion_name]]
56
- end
57
- end
58
-
59
- if __FILE__ == $0
60
- API_VERSION = :v201603
61
-
62
- begin
63
- # Name of the conversion tracker to upload to.
64
- conversion_name = 'INSERT_CONVERSION_NAME_HERE'
65
- # Google Click ID of the click for which offline conversions are uploaded.
66
- google_click_id = 'INSERT_GOOGLE_CLICK_ID_HERE'
67
- # Conversion time in 'yyyymmdd hhmmss' format.
68
- conversion_time = Time.new.strftime("%Y%m%d %H%M%S")
69
- # Conversion value to be uploaded.
70
- conversion_value = 'INSERT_CONVERSION_VALUE_HERE'.to_f
71
-
72
- upload_offline_conversions(conversion_name, google_click_id,
73
- conversion_time, conversion_value)
74
-
75
- # Authorization error.
76
- rescue AdsCommon::Errors::OAuth2VerificationRequired => e
77
- puts "Authorization credentials are not valid. Edit adwords_api.yml for " +
78
- "OAuth2 client ID and secret and run misc/setup_oauth2.rb example " +
79
- "to retrieve and store OAuth2 tokens."
80
- puts "See this wiki page for more details:\n\n " +
81
- 'https://github.com/googleads/google-api-ads-ruby/wiki/OAuth2'
82
-
83
- # HTTP errors.
84
- rescue AdsCommon::Errors::HttpError => e
85
- puts "HTTP Error: %s" % e
86
-
87
- # API errors.
88
- rescue AdwordsApi::Errors::ApiException => e
89
- puts "Message: %s" % e.message
90
- puts 'Errors:'
91
- e.errors.each_with_index do |error, index|
92
- puts "\tError [%d]:" % (index + 1)
93
- error.each do |field, value|
94
- puts "\t\t%s: %s" % [field, value]
95
- end
96
- end
97
- end
98
- end
@@ -1,92 +0,0 @@
1
- #!/usr/bin/env ruby
2
- # Encoding: utf-8
3
- #
4
- # Copyright:: Copyright 2011, Google Inc. All Rights Reserved.
5
- #
6
- # License:: Licensed under the Apache License, Version 2.0 (the "License");
7
- # you may not use this file except in compliance with the License.
8
- # You may obtain a copy of the License at
9
- #
10
- # http://www.apache.org/licenses/LICENSE-2.0
11
- #
12
- # Unless required by applicable law or agreed to in writing, software
13
- # distributed under the License is distributed on an "AS IS" BASIS,
14
- # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
15
- # implied.
16
- # See the License for the specific language governing permissions and
17
- # limitations under the License.
18
- #
19
- # This example gets and downloads an Ad Hoc report from a XML report definition.
20
-
21
- require 'adwords_api'
22
-
23
- def download_criteria_report(file_name)
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
- # Get report utilities for the version.
33
- report_utils = adwords.report_utils(API_VERSION)
34
-
35
- # Define report definition. You can also pass your own XML text as a string.
36
- report_definition = {
37
- :selector => {
38
- :fields => ['CampaignId', 'AdGroupId', 'Id', 'Criteria', 'CriteriaType',
39
- 'FinalUrls', 'Impressions', 'Clicks', 'Cost'],
40
- # Predicates are optional.
41
- :predicates => {
42
- :field => 'Status',
43
- :operator => 'IN',
44
- :values => ['ENABLED', 'PAUSED']
45
- }
46
- },
47
- :report_name => 'Last 7 days CRITERIA_PERFORMANCE_REPORT',
48
- :report_type => 'CRITERIA_PERFORMANCE_REPORT',
49
- :download_format => 'CSV',
50
- :date_range_type => 'LAST_7_DAYS',
51
- }
52
-
53
- # Optional: Set the configuration of the API instance to suppress header,
54
- # column name, or summary rows in the report output. You can also configure
55
- # this in your adwords_api.yml configuration file.
56
- adwords.skip_report_header = false
57
- adwords.skip_column_header = false
58
- adwords.skip_report_summary = false
59
- # Enable to allow rows with zero impressions to show.
60
- adwords.include_zero_impressions = false
61
-
62
- # Download report, using "download_report_as_file" utility method.
63
- # To retrieve the report as return value, use "download_report" method.
64
- report_utils.download_report_as_file(report_definition, file_name)
65
- puts "Report was downloaded to '%s'." % file_name
66
- end
67
-
68
- if __FILE__ == $0
69
- API_VERSION = :v201603
70
-
71
- begin
72
- # File name to write report to.
73
- file_name = 'INSERT_OUTPUT_FILE_NAME_HERE'
74
- download_criteria_report(file_name)
75
-
76
- # Authorization error.
77
- rescue AdsCommon::Errors::OAuth2VerificationRequired => e
78
- puts "Authorization credentials are not valid. Edit adwords_api.yml for " +
79
- "OAuth2 client ID and secret and run misc/setup_oauth2.rb example " +
80
- "to retrieve and store OAuth2 tokens."
81
- puts "See this wiki page for more details:\n\n " +
82
- 'https://github.com/googleads/google-api-ads-ruby/wiki/OAuth2'
83
-
84
- # HTTP errors.
85
- rescue AdsCommon::Errors::HttpError => e
86
- puts "HTTP Error: %s" % e
87
-
88
- # API errors.
89
- rescue AdwordsApi::Errors::ReportError => e
90
- puts "Reporting Error: %s" % e.message
91
- end
92
- end