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
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA1:
3
- metadata.gz: 916926a4584ed9782e9efb72932b0c39b90473cc
4
- data.tar.gz: 48a8aa5a00664fb2116662b84df12d07a9845e10
3
+ metadata.gz: 0b3619b9d24f1262a816603d456c34a24e17716c
4
+ data.tar.gz: 6858e302ec4dc3bb31185f668838c65521aac21d
5
5
  SHA512:
6
- metadata.gz: 5b87032f752d27c955deedeee692a1db207e4d8d96050be8d3c1cb2b70a1dfb12eaa0b0e77324a18fb8ee4f503003af3e48d33637cc41293b7bc7572eb811ca3
7
- data.tar.gz: 1847b728836bbad92cac627a709f3e8a4b7e574009143507d6b48f99179b66f5593ce68c2d6e695730702faa2abb4ae7a3c9aed3b9ad0d30cbc6489f6d79fceb
6
+ metadata.gz: 5221c7253f3ccd0b8fd8abd6b86c84b0d38f7f1d04ce92ea2c2cbf904142825f5ca23b04643c2d607a958a07f0f34a29441ff4f3972314a4c34d08a509ec7251
7
+ data.tar.gz: 8104643988f0a04e5cbc7ec230da9e24f10db81d01a9fc03f957bb767a70099b613725ec5cd50cd745add20ccfeea28f005174c481113fbf5ebfb0e54d13d3a1
data/ChangeLog CHANGED
@@ -1,7 +1,15 @@
1
+ 0.18.1:
2
+ - Support and examples for v201601.
3
+ - Updated batch_job_utils to handle API changes in v201601.
4
+ - Require google-ads-common 0.11.2 or later from now on.
5
+
1
6
  0.18.0:
2
7
  - Removed deprecated API version v201502.
3
8
  - Support for streaming report requests in report_utils.
4
9
  - Require google-ads-common 0.11.1 or later from now on.
10
+ - Updated batch_job_utils to support incremental uploads.
11
+ - Changed interface of batch_job_utils to avoid requiring users to manually
12
+ manage SOAP XML.
5
13
 
6
14
  0.17.0:
7
15
  - Support and examples for v201509.
@@ -49,8 +49,10 @@ def add_ad_groups(campaign_id)
49
49
  ]
50
50
  },
51
51
  :settings => [
52
- # Targeting restriction settings - these settings only affect serving
53
- # for the Display Network.
52
+ # Targeting restriction settings. Depending on the :criterion_type_group
53
+ # value, most TargetingSettingDetail only affect Display campaigns.
54
+ # However, the USER_INTEREST_AND_LIST value works for RLSA campaigns -
55
+ # Search campaigns targeting using a remarketing list.
54
56
  {
55
57
  :xsi_type => 'TargetingSetting',
56
58
  :details => [
@@ -45,10 +45,8 @@ def add_crm_based_user_list(emails)
45
45
  :description => 'A list of customers that originated from email addresses',
46
46
  # Maximum life span is 180 days.
47
47
  :membership_life_span => 180,
48
- # This field is required. It links to a service you created that allows
49
- # members of this list to remove themselves. It will be shown in the
50
- # "Why This Ad?" of an ad and so it needs to be verified. Read more about
51
- # "Why This Ad?" here https://support.google.com/ads/answer/2662850.
48
+ # This field is optional. It links to a service you created that allows
49
+ # members of this list to remove themselves.
52
50
  :opt_out_link => 'http://endpoint1.example.com/optout'
53
51
  }
54
52
 
@@ -18,7 +18,8 @@
18
18
  #
19
19
  # This code example imports offline conversion values for specific clicks to
20
20
  # your account. To get Google Click ID for a click, run
21
- # CLICK_PERFORMANCE_REPORT.
21
+ # CLICK_PERFORMANCE_REPORT. To set up a conversion tracker, run the
22
+ # add_conversion_tracker.rb example.
22
23
 
23
24
  require 'adwords_api'
24
25
  require 'date'
@@ -33,28 +34,12 @@ def upload_offline_conversions(conversion_name, google_click_id,
33
34
  # the configuration file or provide your own logger:
34
35
  # adwords.logger = Logger.new('adwords_xml.log')
35
36
 
36
- conversion_tracker_srv =
37
- adwords.service(:ConversionTrackerService, API_VERSION)
38
37
  conversion_feed_srv =
39
38
  adwords.service(:OfflineConversionFeedService, API_VERSION)
40
39
 
41
- # Create an upload conversion. Once created, this entry will be visible under
42
- # Tools and Analysis->Conversion and will have Source = Import.
43
- upload_conversion = {
44
- :xsi_type => 'UploadConversion',
45
- :category => 'PAGE_VIEW',
46
- :name => conversion_name,
47
- :viewthrough_lookback_window => 30,
48
- :ctc_lookback_window => 90
49
- }
50
- return_conversions = conversion_tracker_srv.mutate([
51
- {:operator => 'ADD', :operand => upload_conversion}])
52
- return_conversions[:value].each do |tracker|
53
- puts "Upload conversion tracker with name '%s' and ID %d was created." %
54
- [tracker[:name], tracker[:id]]
55
- end
56
-
57
- # Associate offline conversions with the upload conversion tracker we created.
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.
58
43
  feed = {
59
44
  :conversion_name => conversion_name,
60
45
  :google_click_id => google_click_id,
@@ -75,7 +60,7 @@ if __FILE__ == $0
75
60
  API_VERSION = :v201509
76
61
 
77
62
  begin
78
- # Name of the upload conversion to be created.
63
+ # Name of the conversion tracker to upload to.
79
64
  conversion_name = 'INSERT_CONVERSION_NAME_HERE'
80
65
  # Google Click ID of the click for which offline conversions are uploaded.
81
66
  google_click_id = 'INSERT_GOOGLE_CLICK_ID_HERE'
@@ -0,0 +1,88 @@
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 an account. Note by default this
20
+ # account will only be accessible via parent AdWords manager account.
21
+
22
+ require 'adwords_api'
23
+ require 'adwords_api/utils'
24
+
25
+ def create_account()
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
+ managed_customer_srv = adwords.service(:ManagedCustomerService, API_VERSION)
35
+
36
+ # Create a local Customer object.
37
+ customer = {
38
+ :name => 'Account created with ManagedCustomerService',
39
+ :currency_code => 'EUR',
40
+ :date_time_zone => 'Europe/London'
41
+ }
42
+
43
+ # Prepare operation to create an account.
44
+ operation = {
45
+ :operator => 'ADD',
46
+ :operand => customer
47
+ }
48
+
49
+ # Create the account. It is possible to create multiple accounts with one
50
+ # request by sending an array of operations.
51
+ response = managed_customer_srv.mutate([operation])
52
+
53
+ response[:value].each do |new_account|
54
+ puts "Account with customer ID '%s' was successfully created." %
55
+ AdwordsApi::Utils.format_id(new_account[:customer_id])
56
+ end
57
+ end
58
+
59
+ if __FILE__ == $0
60
+ API_VERSION = :v201601
61
+
62
+ begin
63
+ create_account()
64
+
65
+ # Authorization error.
66
+ rescue AdsCommon::Errors::OAuth2VerificationRequired => e
67
+ puts "Authorization credentials are not valid. Edit adwords_api.yml for " +
68
+ "OAuth2 client ID and secret and run misc/setup_oauth2.rb example " +
69
+ "to retrieve and store OAuth2 tokens."
70
+ puts "See this wiki page for more details:\n\n " +
71
+ 'https://github.com/googleads/google-api-ads-ruby/wiki/OAuth2'
72
+
73
+ # HTTP errors.
74
+ rescue AdsCommon::Errors::HttpError => e
75
+ puts "HTTP Error: %s" % e
76
+
77
+ # API errors.
78
+ rescue AdwordsApi::Errors::ApiException => e
79
+ puts "Message: %s" % e.message
80
+ puts 'Errors:'
81
+ e.errors.each_with_index do |error, index|
82
+ puts "\tError [%d]:" % (index + 1)
83
+ error.each do |field, value|
84
+ puts "\t\t%s: %s" % [field, value]
85
+ end
86
+ end
87
+ end
88
+ end
@@ -0,0 +1,139 @@
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 all account changes that happened within the last 24 hours,
20
+ # for all your campaigns.
21
+
22
+ require 'adwords_api'
23
+ require 'date'
24
+ require 'pp'
25
+
26
+ def get_account_changes()
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
+ campaign_srv = adwords.service(:CampaignService, API_VERSION)
36
+ customer_sync_srv = adwords.service(:CustomerSyncService, API_VERSION)
37
+
38
+ today_at_midnight = DateTime.parse(Date.today.to_s)
39
+ yesterday_at_midnight = DateTime.parse((Date.today - 1).to_s)
40
+ min_date_time = yesterday_at_midnight.strftime("%Y%m%d %H%M%S")
41
+ max_date_time = today_at_midnight.strftime("%Y%m%d %H%M%S")
42
+
43
+ # Get all the campaigns for this account.
44
+ selector = {
45
+ :fields => ['Id']
46
+ }
47
+ response = campaign_srv.get(selector)
48
+
49
+ campaign_ids = []
50
+
51
+ if response and response[:entries]
52
+ campaign_ids = response[:entries].map { |campaign| campaign[:id] }
53
+ else
54
+ raise StandardError, 'No campaigns were found.'
55
+ end
56
+
57
+ # Create a selector for CustomerSyncService.
58
+ selector = {
59
+ :campaign_ids => campaign_ids,
60
+ :date_time_range => {
61
+ :min => min_date_time,
62
+ :max => max_date_time
63
+ }
64
+ }
65
+
66
+ # Get all account changes for the campaigns.
67
+ campaign_changes = customer_sync_srv.get(selector)
68
+
69
+ # Display changes.
70
+ if campaign_changes
71
+ puts "Most recent change: %s" % campaign_changes[:last_change_timestamp]
72
+ campaign_changes[:changed_campaigns].each do |campaign|
73
+ puts "Campaign with ID %d was changed:" % campaign[:campaign_id]
74
+ puts "\tCampaign change status: '%s'" % campaign[:campaign_change_status]
75
+ unless ['NEW', 'FIELDS_UNCHANGED'].include?(
76
+ campaign[:campaign_change_status])
77
+ puts "\tAdded ad extensions: '%s'" %
78
+ campaign[:added_ad_extensions].pretty_inspect.chomp
79
+ puts "\tAdded campaign criteria: '%s'" %
80
+ campaign[:added_campaign_criteria].pretty_inspect.chomp
81
+ puts "\tRemoved ad extensions: '%s'" %
82
+ campaign[:removed_ad_extensions].pretty_inspect.chomp
83
+ puts "\tRemoved campaign criteria: '%s'" %
84
+ campaign[:removed_campaign_criteria].pretty_inspect.chomp
85
+
86
+ if campaign[:changed_ad_groups]
87
+ campaign[:changed_ad_groups].each do |ad_group|
88
+ puts "\tAd group with ID %d was changed:" % ad_group[:ad_group_id]
89
+ puts "\t\tAd group changed status: '%s'" %
90
+ ad_group[:ad_group_change_status]
91
+ unless ['NEW', 'FIELDS_UNCHANGED'].include?(
92
+ ad_group[:ad_group_change_status])
93
+ puts "\t\tAds changed: '%s'" %
94
+ ad_group[:changed_ads].pretty_inspect.chomp
95
+ puts "\t\tCriteria changed: '%s'" %
96
+ ad_group[:changed_criteria].pretty_inspect.chomp
97
+ puts "\t\tCriteria removed: '%s'" %
98
+ ad_group[:removed_criteria].pretty_inspect.chomp
99
+ end
100
+ end
101
+ end
102
+ end
103
+ puts
104
+ end
105
+ else
106
+ puts 'No account changes were found.'
107
+ end
108
+ end
109
+
110
+ if __FILE__ == $0
111
+ API_VERSION = :v201601
112
+
113
+ begin
114
+ get_account_changes()
115
+
116
+ # Authorization error.
117
+ rescue AdsCommon::Errors::OAuth2VerificationRequired => e
118
+ puts "Authorization credentials are not valid. Edit adwords_api.yml for " +
119
+ "OAuth2 client ID and secret and run misc/setup_oauth2.rb example " +
120
+ "to retrieve and store OAuth2 tokens."
121
+ puts "See this wiki page for more details:\n\n " +
122
+ 'https://github.com/googleads/google-api-ads-ruby/wiki/OAuth2'
123
+
124
+ # HTTP errors.
125
+ rescue AdsCommon::Errors::HttpError => e
126
+ puts "HTTP Error: %s" % e
127
+
128
+ # API errors.
129
+ rescue AdwordsApi::Errors::ApiException => e
130
+ puts "Message: %s" % e.message
131
+ puts 'Errors:'
132
+ e.errors.each_with_index do |error, index|
133
+ puts "\tError [%d]:" % (index + 1)
134
+ error.each do |field, value|
135
+ puts "\t\t%s: %s" % [field, value]
136
+ end
137
+ end
138
+ end
139
+ end
@@ -0,0 +1,132 @@
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 retrieve the account hierarchy under an
20
+ # account. This example needs to be run against an AdWords manager account.
21
+
22
+ require 'adwords_api'
23
+ require 'adwords_api/utils'
24
+
25
+ def get_account_hierarchy()
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
+ managed_customer_srv = adwords.service(:ManagedCustomerService, API_VERSION)
35
+
36
+ # Get the account hierarchy for this account.
37
+ selector = {
38
+ :fields => ['CustomerId', 'Name'],
39
+ :paging => {
40
+ :start_index => 0,
41
+ :number_results => PAGE_SIZE
42
+ }
43
+ }
44
+
45
+ # Set initial values
46
+ offset, page = 0, {}
47
+
48
+ accounts = {}
49
+ child_links = {}
50
+ parent_links = {}
51
+ root_account = nil
52
+
53
+ begin
54
+ page = managed_customer_srv.get(selector)
55
+
56
+ if page and page[:entries]
57
+ if page[:links]
58
+ page[:links].each do |link|
59
+ unless child_links.include?(link[:manager_customer_id])
60
+ child_links[link[:manager_customer_id]] = []
61
+ end
62
+ child_links[link[:manager_customer_id]] << link
63
+ unless parent_links.include?(link[:client_customer_id])
64
+ parent_links[link[:client_customer_id]] = []
65
+ end
66
+ parent_links[link[:client_customer_id]] << link
67
+ end
68
+ end
69
+
70
+ page[:entries].each do |account|
71
+ accounts[account[:customer_id]] = account
72
+ unless parent_links.include?(account[:customer_id])
73
+ root_account = account
74
+ end
75
+ end
76
+
77
+ # Increment values to request the next page.
78
+ offset += PAGE_SIZE
79
+ selector[:paging][:start_index] = offset
80
+ end
81
+ end while page[:total_num_entries] > offset
82
+
83
+ if root_account.nil?
84
+ puts "Unable to determine a root account."
85
+ else
86
+ puts "CustomerId, Name"
87
+ display_account_tree(root_account, accounts, child_links, 0)
88
+ end
89
+ end
90
+
91
+ def display_account_tree(account, accounts, links, depth)
92
+ prefix = '-' * depth * 2
93
+ puts '%s%s, %s' % [prefix, account[:customer_id], account[:name]]
94
+ if links.include?(account[:customer_id])
95
+ links[account[:customer_id]].each do |child_link|
96
+ child_account = accounts[child_link[:client_customer_id]]
97
+ display_account_tree(child_account, accounts, links, depth + 1)
98
+ end
99
+ end
100
+ end
101
+
102
+ if __FILE__ == $0
103
+ API_VERSION = :v201601
104
+ PAGE_SIZE = 500
105
+
106
+ begin
107
+ get_account_hierarchy()
108
+
109
+ # Authorization error.
110
+ rescue AdsCommon::Errors::OAuth2VerificationRequired => e
111
+ puts "Authorization credentials are not valid. Edit adwords_api.yml for " +
112
+ "OAuth2 client ID and secret and run misc/setup_oauth2.rb example " +
113
+ "to retrieve and store OAuth2 tokens."
114
+ puts "See this wiki page for more details:\n\n " +
115
+ 'https://github.com/googleads/google-api-ads-ruby/wiki/OAuth2'
116
+
117
+ # HTTP errors.
118
+ rescue AdsCommon::Errors::HttpError => e
119
+ puts "HTTP Error: %s" % e
120
+
121
+ # API errors.
122
+ rescue AdwordsApi::Errors::ApiException => e
123
+ puts "Message: %s" % e.message
124
+ puts 'Errors:'
125
+ e.errors.each_with_index do |error, index|
126
+ puts "\tError [%d]:" % (index + 1)
127
+ error.each do |field, value|
128
+ puts "\t\t%s: %s" % [field, value]
129
+ end
130
+ end
131
+ end
132
+ end