google-adwords-api 0.8.1 → 0.8.2

Sign up to get free protection for your applications and to get access to all the features.
Files changed (149) hide show
  1. data/ChangeLog +3 -0
  2. data/examples/v201206/campaign_management/add_keywords_in_bulk.rb +1 -1
  3. data/examples/v201209/campaign_management/add_keywords_in_bulk.rb +1 -1
  4. data/examples/v201302/account_management/create_account.rb +87 -0
  5. data/examples/v201302/account_management/get_account_alerts.rb +114 -0
  6. data/examples/v201302/account_management/get_account_changes.rb +137 -0
  7. data/examples/v201302/account_management/get_account_hierarchy.rb +95 -0
  8. data/examples/v201302/advanced_operations/add_click_to_download_ad.rb +129 -0
  9. data/examples/v201302/advanced_operations/add_site_links.rb +213 -0
  10. data/examples/v201302/basic_operations/add_ad_groups.rb +135 -0
  11. data/examples/v201302/basic_operations/add_campaigns.rb +154 -0
  12. data/examples/v201302/basic_operations/add_keywords.rb +108 -0
  13. data/examples/v201302/basic_operations/add_text_ads.rb +105 -0
  14. data/examples/v201302/basic_operations/delete_ad.rb +85 -0
  15. data/examples/v201302/basic_operations/delete_ad_group.rb +102 -0
  16. data/examples/v201302/basic_operations/delete_campaign.rb +103 -0
  17. data/examples/v201302/basic_operations/delete_keyword.rb +90 -0
  18. data/examples/v201302/basic_operations/get_ad_groups.rb +98 -0
  19. data/examples/v201302/basic_operations/get_campaigns.rb +93 -0
  20. data/examples/v201302/basic_operations/get_campaigns_with_awql.rb +85 -0
  21. data/examples/v201302/basic_operations/get_keywords.rb +104 -0
  22. data/examples/v201302/basic_operations/get_text_ads.rb +106 -0
  23. data/examples/v201302/basic_operations/pause_ad.rb +84 -0
  24. data/examples/v201302/basic_operations/update_ad_group.rb +81 -0
  25. data/examples/v201302/basic_operations/update_campaign.rb +82 -0
  26. data/examples/v201302/basic_operations/update_keyword.rb +102 -0
  27. data/examples/v201302/campaign_management/add_experiment.rb +158 -0
  28. data/examples/v201302/campaign_management/add_keywords_in_bulk.rb +150 -0
  29. data/examples/v201302/campaign_management/add_location_extension.rb +117 -0
  30. data/examples/v201302/campaign_management/add_location_extension_override.rb +83 -0
  31. data/examples/v201302/campaign_management/get_all_disapproved_ads.rb +93 -0
  32. data/examples/v201302/campaign_management/get_all_disapproved_ads_with_awql.rb +84 -0
  33. data/examples/v201302/campaign_management/promote_experiment.rb +77 -0
  34. data/examples/v201302/campaign_management/set_ad_parameters.rb +114 -0
  35. data/examples/v201302/campaign_management/set_campaign_enhanced.rb +83 -0
  36. data/examples/v201302/campaign_management/set_criterion_bid_modifier.rb +102 -0
  37. data/examples/v201302/campaign_management/validate_text_ad.rb +106 -0
  38. data/examples/v201302/error_handling/handle_captcha_challenge.rb +93 -0
  39. data/examples/v201302/error_handling/handle_partial_failures.rb +126 -0
  40. data/examples/v201302/error_handling/handle_policy_violation_error.rb +137 -0
  41. data/examples/v201302/error_handling/handle_two_factor_authorization_error.rb +88 -0
  42. data/examples/v201302/misc/get_all_images_and_videos.rb +100 -0
  43. data/examples/v201302/misc/upload_image.rb +89 -0
  44. data/examples/v201302/misc/use_oauth2.rb +97 -0
  45. data/examples/v201302/misc/use_oauth2_jwt.rb +93 -0
  46. data/examples/v201302/optimization/estimate_keyword_traffic.rb +129 -0
  47. data/examples/v201302/optimization/get_keyword_bid_simulations.rb +92 -0
  48. data/examples/v201302/optimization/get_keyword_ideas.rb +122 -0
  49. data/examples/v201302/optimization/get_placement_ideas.rb +104 -0
  50. data/examples/v201302/remarketing/add_audience.rb +115 -0
  51. data/examples/v201302/remarketing/add_conversion_tracker.rb +96 -0
  52. data/examples/v201302/reporting/download_criteria_report.rb +79 -0
  53. data/examples/v201302/reporting/download_criteria_report_with_awql.rb +78 -0
  54. data/examples/v201302/reporting/get_campaign_stats.rb +105 -0
  55. data/examples/v201302/reporting/get_report_fields.rb +71 -0
  56. data/examples/v201302/reporting/parallel_report_download.rb +163 -0
  57. data/examples/v201302/targeting/add_campaign_targeting_criteria.rb +115 -0
  58. data/examples/v201302/targeting/add_demographic_targeting_criteria.rb +108 -0
  59. data/examples/v201302/targeting/get_campaign_targeting_criteria.rb +102 -0
  60. data/examples/v201302/targeting/get_targetable_languages_and_carriers.rb +86 -0
  61. data/examples/v201302/targeting/lookup_location.rb +104 -0
  62. data/lib/adwords_api/api_config.rb +74 -4
  63. data/lib/adwords_api/v201302/ad_extension_override_service.rb +38 -0
  64. data/lib/adwords_api/v201302/ad_extension_override_service_registry.rb +46 -0
  65. data/lib/adwords_api/v201302/ad_group_ad_service.rb +42 -0
  66. data/lib/adwords_api/v201302/ad_group_ad_service_registry.rb +46 -0
  67. data/lib/adwords_api/v201302/ad_group_criterion_service.rb +42 -0
  68. data/lib/adwords_api/v201302/ad_group_criterion_service_registry.rb +46 -0
  69. data/lib/adwords_api/v201302/ad_group_feed_service.rb +38 -0
  70. data/lib/adwords_api/v201302/ad_group_feed_service_registry.rb +47 -0
  71. data/lib/adwords_api/v201302/ad_group_service.rb +42 -0
  72. data/lib/adwords_api/v201302/ad_group_service_registry.rb +46 -0
  73. data/lib/adwords_api/v201302/ad_param_service.rb +38 -0
  74. data/lib/adwords_api/v201302/ad_param_service_registry.rb +46 -0
  75. data/lib/adwords_api/v201302/alert_service.rb +34 -0
  76. data/lib/adwords_api/v201302/alert_service_registry.rb +46 -0
  77. data/lib/adwords_api/v201302/budget_order_service.rb +42 -0
  78. data/lib/adwords_api/v201302/budget_order_service_registry.rb +46 -0
  79. data/lib/adwords_api/v201302/budget_service.rb +38 -0
  80. data/lib/adwords_api/v201302/budget_service_registry.rb +46 -0
  81. data/lib/adwords_api/v201302/campaign_ad_extension_service.rb +38 -0
  82. data/lib/adwords_api/v201302/campaign_ad_extension_service_registry.rb +46 -0
  83. data/lib/adwords_api/v201302/campaign_criterion_service.rb +42 -0
  84. data/lib/adwords_api/v201302/campaign_criterion_service_registry.rb +46 -0
  85. data/lib/adwords_api/v201302/campaign_feed_service.rb +38 -0
  86. data/lib/adwords_api/v201302/campaign_feed_service_registry.rb +46 -0
  87. data/lib/adwords_api/v201302/campaign_service.rb +42 -0
  88. data/lib/adwords_api/v201302/campaign_service_registry.rb +46 -0
  89. data/lib/adwords_api/v201302/campaign_shared_set_service.rb +38 -0
  90. data/lib/adwords_api/v201302/campaign_shared_set_service_registry.rb +47 -0
  91. data/lib/adwords_api/v201302/constant_data_service.rb +62 -0
  92. data/lib/adwords_api/v201302/constant_data_service_registry.rb +46 -0
  93. data/lib/adwords_api/v201302/conversion_tracker_service.rb +38 -0
  94. data/lib/adwords_api/v201302/conversion_tracker_service_registry.rb +46 -0
  95. data/lib/adwords_api/v201302/customer_service.rb +34 -0
  96. data/lib/adwords_api/v201302/customer_service_registry.rb +46 -0
  97. data/lib/adwords_api/v201302/customer_sync_service.rb +34 -0
  98. data/lib/adwords_api/v201302/customer_sync_service_registry.rb +47 -0
  99. data/lib/adwords_api/v201302/data_service.rb +38 -0
  100. data/lib/adwords_api/v201302/data_service_registry.rb +46 -0
  101. data/lib/adwords_api/v201302/experiment_service.rb +38 -0
  102. data/lib/adwords_api/v201302/experiment_service_registry.rb +46 -0
  103. data/lib/adwords_api/v201302/feed_item_service.rb +38 -0
  104. data/lib/adwords_api/v201302/feed_item_service_registry.rb +47 -0
  105. data/lib/adwords_api/v201302/feed_mapping_service.rb +38 -0
  106. data/lib/adwords_api/v201302/feed_mapping_service_registry.rb +46 -0
  107. data/lib/adwords_api/v201302/feed_service.rb +38 -0
  108. data/lib/adwords_api/v201302/feed_service_registry.rb +47 -0
  109. data/lib/adwords_api/v201302/geo_location_service.rb +34 -0
  110. data/lib/adwords_api/v201302/geo_location_service_registry.rb +46 -0
  111. data/lib/adwords_api/v201302/location_criterion_service.rb +34 -0
  112. data/lib/adwords_api/v201302/location_criterion_service_registry.rb +46 -0
  113. data/lib/adwords_api/v201302/managed_customer_service.rb +50 -0
  114. data/lib/adwords_api/v201302/managed_customer_service_registry.rb +46 -0
  115. data/lib/adwords_api/v201302/media_service.rb +38 -0
  116. data/lib/adwords_api/v201302/media_service_registry.rb +46 -0
  117. data/lib/adwords_api/v201302/mutate_job_service.rb +42 -0
  118. data/lib/adwords_api/v201302/mutate_job_service_registry.rb +46 -0
  119. data/lib/adwords_api/v201302/report_definition_service.rb +34 -0
  120. data/lib/adwords_api/v201302/report_definition_service_registry.rb +46 -0
  121. data/lib/adwords_api/v201302/shared_criterion_service.rb +38 -0
  122. data/lib/adwords_api/v201302/shared_criterion_service_registry.rb +47 -0
  123. data/lib/adwords_api/v201302/targeting_idea_service.rb +38 -0
  124. data/lib/adwords_api/v201302/targeting_idea_service_registry.rb +46 -0
  125. data/lib/adwords_api/v201302/traffic_estimator_service.rb +34 -0
  126. data/lib/adwords_api/v201302/traffic_estimator_service_registry.rb +46 -0
  127. data/lib/adwords_api/v201302/user_list_service.rb +38 -0
  128. data/lib/adwords_api/v201302/user_list_service_registry.rb +46 -0
  129. data/lib/adwords_api/version.rb +1 -1
  130. data/test/adwords_api/test_adwords_api.rb +1 -1
  131. data/test/adwords_api/test_api_config.rb +8 -8
  132. data/test/adwords_api/test_report_utils.rb +1 -1
  133. data/test/bugs/test_issue_00000031.rb +2 -2
  134. data/test/bugs/test_issue_00000063.rb +6 -6
  135. data/test/examples/v201302/test_account_management.rb +50 -0
  136. data/test/examples/v201302/test_advanced_operations.rb +54 -0
  137. data/test/examples/v201302/test_basic_operations.rb +177 -0
  138. data/test/examples/v201302/test_campaign_management.rb +140 -0
  139. data/test/examples/v201302/test_error_handling.rb +63 -0
  140. data/test/examples/v201302/test_misc.rb +39 -0
  141. data/test/examples/v201302/test_optimization.rb +63 -0
  142. data/test/examples/v201302/test_remarketing.rb +39 -0
  143. data/test/examples/v201302/test_reporting.rb +84 -0
  144. data/test/examples/v201302/test_targeting.rb +68 -0
  145. data/test/examples/v201302/utils.rb +267 -0
  146. data/test/suite_exampletests_v201302.rb +37 -0
  147. data/test/templates/v201209/basic_operations_get_campaigns.def +1 -1
  148. data/test/templates/v201302/basic_operations_get_campaigns.def +114 -0
  149. metadata +139 -2
data/ChangeLog CHANGED
@@ -1,3 +1,6 @@
1
+ 0.8.2:
2
+ - Support and examples for v201302.
3
+
1
4
  0.8.1:
2
5
  - Examples for enhanced campaigns.
3
6
  - Require google-ads-common 0.9.2 or later from now on.
@@ -119,7 +119,7 @@ def add_keywords_in_bulk()
119
119
  raise StandardError, 'Error retrieving job results; aborting.'
120
120
  end
121
121
  else
122
- puts "Job failed to complete after %d retries." % RETRY_COUNT
122
+ puts "Job failed to complete after %d retries." % RETRIES_COUNT
123
123
  end
124
124
  end
125
125
 
@@ -119,7 +119,7 @@ def add_keywords_in_bulk()
119
119
  raise StandardError, 'Error retrieving job results; aborting.'
120
120
  end
121
121
  else
122
- puts "Job failed to complete after %d retries." % RETRY_COUNT
122
+ puts "Job failed to complete after %d retries." % RETRIES_COUNT
123
123
  end
124
124
  end
125
125
 
@@ -0,0 +1,87 @@
1
+ #!/usr/bin/env ruby
2
+ # Encoding: utf-8
3
+ #
4
+ # Author:: api.dklimkin@gmail.com (Danial Klimkin)
5
+ #
6
+ # Copyright:: Copyright 2011, Google Inc. All Rights Reserved.
7
+ #
8
+ # License:: Licensed under the Apache License, Version 2.0 (the "License");
9
+ # you may not use this file except in compliance with the License.
10
+ # You may obtain a copy of the License at
11
+ #
12
+ # http://www.apache.org/licenses/LICENSE-2.0
13
+ #
14
+ # Unless required by applicable law or agreed to in writing, software
15
+ # distributed under the License is distributed on an "AS IS" BASIS,
16
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
17
+ # implied.
18
+ # See the License for the specific language governing permissions and
19
+ # limitations under the License.
20
+ #
21
+ # This example illustrates how to create an account. Note by default this
22
+ # account will only be accessible via parent MCC.
23
+ #
24
+ # Note: This code example uses MCC-level calls and won't work with Test
25
+ # Accounts, see: https://developers.google.com/adwords/api/docs/test-accounts
26
+ #
27
+ # Tags: ManagedCustomerService.mutate
28
+
29
+ require 'adwords_api'
30
+ require 'adwords_api/utils'
31
+
32
+ def create_account()
33
+ # AdwordsApi::Api will read a config file from ENV['HOME']/adwords_api.yml
34
+ # when called without parameters.
35
+ adwords = AdwordsApi::Api.new
36
+
37
+ # To enable logging of SOAP requests, set the log_level value to 'DEBUG' in
38
+ # the configuration file or provide your own logger:
39
+ # adwords.logger = Logger.new('adwords_xml.log')
40
+
41
+ managed_customer_srv = adwords.service(:ManagedCustomerService, API_VERSION)
42
+
43
+ # Create a local Customer object.
44
+ customer = {
45
+ :name => 'Account created with ManagedCustomerService',
46
+ :currency_code => 'EUR',
47
+ :date_time_zone => 'Europe/London'
48
+ }
49
+
50
+ # Prepare operation to create an account.
51
+ operation = {
52
+ :operator => 'ADD',
53
+ :operand => customer
54
+ }
55
+
56
+ # Create the account. It is possible to create multiple accounts with one
57
+ # request by sending an array of operations.
58
+ response = managed_customer_srv.mutate([operation])
59
+
60
+ response[:value].each do |new_account|
61
+ puts "Account with customer ID '%s' was successfully created." %
62
+ AdwordsApi::Utils.format_id(new_account[:customer_id])
63
+ end
64
+ end
65
+
66
+ if __FILE__ == $0
67
+ API_VERSION = :v201302
68
+
69
+ begin
70
+ create_account()
71
+
72
+ # HTTP errors.
73
+ rescue AdsCommon::Errors::HttpError => e
74
+ puts "HTTP Error: %s" % e
75
+
76
+ # API errors.
77
+ rescue AdwordsApi::Errors::ApiException => e
78
+ puts "Message: %s" % e.message
79
+ puts 'Errors:'
80
+ e.errors.each_with_index do |error, index|
81
+ puts "\tError [%d]:" % (index + 1)
82
+ error.each do |field, value|
83
+ puts "\t\t%s: %s" % [field, value]
84
+ end
85
+ end
86
+ end
87
+ end
@@ -0,0 +1,114 @@
1
+ #!/usr/bin/env ruby
2
+ # Encoding: utf-8
3
+ #
4
+ # Author:: api.dklimkin@gmail.com (Danial Klimkin)
5
+ #
6
+ # Copyright:: Copyright 2011, Google Inc. All Rights Reserved.
7
+ #
8
+ # License:: Licensed under the Apache License, Version 2.0 (the "License");
9
+ # you may not use this file except in compliance with the License.
10
+ # You may obtain a copy of the License at
11
+ #
12
+ # http://www.apache.org/licenses/LICENSE-2.0
13
+ #
14
+ # Unless required by applicable law or agreed to in writing, software
15
+ # distributed under the License is distributed on an "AS IS" BASIS,
16
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
17
+ # implied.
18
+ # See the License for the specific language governing permissions and
19
+ # limitations under the License.
20
+ #
21
+ # This example gets all alerts for all clients of an MCC account. The effective
22
+ # user (clientCustomerId, or authToken) must be an MCC user to get results.
23
+ #
24
+ # Note: This code example uses MCC-level calls and won't work with Test
25
+ # Accounts, see: https://developers.google.com/adwords/api/docs/test-accounts
26
+ #
27
+ # Tags: AlertService.get
28
+
29
+ require 'adwords_api'
30
+ require 'adwords_api/utils'
31
+
32
+ def get_account_alerts()
33
+ # AdwordsApi::Api will read a config file from ENV['HOME']/adwords_api.yml
34
+ # when called without parameters.
35
+ adwords = AdwordsApi::Api.new
36
+
37
+ # To enable logging of SOAP requests, set the log_level value to 'DEBUG' in
38
+ # the configuration file or provide your own logger:
39
+ # adwords.logger = Logger.new('adwords_xml.log')
40
+
41
+ alert_srv = adwords.service(:AlertService, API_VERSION)
42
+
43
+ # Create the selector.
44
+ selector = {
45
+ :query => {
46
+ :filter_spec => 'ALL',
47
+ :client_spec => 'ALL',
48
+ :trigger_time_spec => 'ALL_TIME',
49
+ :severities => ['GREEN', 'YELLOW', 'RED'],
50
+ :types => [
51
+ 'ACCOUNT_BUDGET_BURN_RATE', 'ACCOUNT_BUDGET_ENDING',
52
+ 'ACCOUNT_ON_TARGET', 'CAMPAIGN_ENDED', 'CAMPAIGN_ENDING',
53
+ 'CREDIT_CARD_EXPIRING', 'DECLINED_PAYMENT', 'MANAGER_LINK_PENDING',
54
+ 'MISSING_BANK_REFERENCE_NUMBER', 'PAYMENT_NOT_ENTERED',
55
+ 'TV_ACCOUNT_BUDGET_ENDING', 'TV_ACCOUNT_ON_TARGET',
56
+ 'TV_ZERO_DAILY_SPENDING_LIMIT', 'USER_INVITE_ACCEPTED',
57
+ 'USER_INVITE_PENDING', 'ZERO_DAILY_SPENDING_LIMIT'
58
+ ]
59
+ },
60
+ :paging => {
61
+ :start_index => 0,
62
+ :number_results => PAGE_SIZE
63
+ }
64
+ }
65
+
66
+ # Set initial values.
67
+ offset, page = 0, {}
68
+
69
+ # Get alerts.
70
+ begin
71
+ page = alert_srv.get(selector)
72
+ if page[:entries]
73
+ page[:entries].each_with_index do |alert, index|
74
+ puts "%d) Customer ID is '%s', alert type is '%s', severity is '%s'."
75
+ [AdwordsApi::Utils.format_id(alert[:client_customer_id]),
76
+ alert[:alert_type], alert[:alert_severity]]
77
+ alert[:details].each do |detail|
78
+ puts "\t- triggered at %s" % detail[:trigger_time]
79
+ end
80
+ end
81
+ # Increment values to request the next page.
82
+ offset += PAGE_SIZE
83
+ selector[:paging][:start_index] = offset
84
+ end
85
+ end while page[:total_num_entries] > offset
86
+
87
+ if page.include?(:total_num_entries)
88
+ puts "\tTotal number of alerts: %d." % page[:total_num_entries]
89
+ end
90
+ end
91
+
92
+ if __FILE__ == $0
93
+ API_VERSION = :v201302
94
+ PAGE_SIZE = 500
95
+
96
+ begin
97
+ get_account_alerts()
98
+
99
+ # HTTP errors.
100
+ rescue AdsCommon::Errors::HttpError => e
101
+ puts "HTTP Error: %s" % e
102
+
103
+ # API errors.
104
+ rescue AdwordsApi::Errors::ApiException => e
105
+ puts "Message: %s" % e.message
106
+ puts 'Errors:'
107
+ e.errors.each_with_index do |error, index|
108
+ puts "\tError [%d]:" % (index + 1)
109
+ error.each do |field, value|
110
+ puts "\t\t%s: %s" % [field, value]
111
+ end
112
+ end
113
+ end
114
+ end
@@ -0,0 +1,137 @@
1
+ #!/usr/bin/env ruby
2
+ # Encoding: utf-8
3
+ #
4
+ # Author:: api.dklimkin@gmail.com (Danial Klimkin)
5
+ #
6
+ # Copyright:: Copyright 2011, Google Inc. All Rights Reserved.
7
+ #
8
+ # License:: Licensed under the Apache License, Version 2.0 (the "License");
9
+ # you may not use this file except in compliance with the License.
10
+ # You may obtain a copy of the License at
11
+ #
12
+ # http://www.apache.org/licenses/LICENSE-2.0
13
+ #
14
+ # Unless required by applicable law or agreed to in writing, software
15
+ # distributed under the License is distributed on an "AS IS" BASIS,
16
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
17
+ # implied.
18
+ # See the License for the specific language governing permissions and
19
+ # limitations under the License.
20
+ #
21
+ # This example gets all account changes that happened within the last 24 hours,
22
+ # for all your campaigns.
23
+ #
24
+ # Tags: CustomerSyncService.get
25
+
26
+ require 'adwords_api'
27
+ require 'date'
28
+ require 'pp'
29
+
30
+ def get_account_changes()
31
+ # AdwordsApi::Api will read a config file from ENV['HOME']/adwords_api.yml
32
+ # when called without parameters.
33
+ adwords = AdwordsApi::Api.new
34
+
35
+ # To enable logging of SOAP requests, set the log_level value to 'DEBUG' in
36
+ # the configuration file or provide your own logger:
37
+ # adwords.logger = Logger.new('adwords_xml.log')
38
+
39
+ campaign_srv = adwords.service(:CampaignService, API_VERSION)
40
+ customer_sync_srv = adwords.service(:CustomerSyncService, API_VERSION)
41
+
42
+ today_at_midnight = DateTime.parse(Date.today.to_s)
43
+ yesterday_at_midnight = DateTime.parse((Date.today - 1).to_s)
44
+ min_date_time = yesterday_at_midnight.strftime("%Y%m%d %H%M%S")
45
+ max_date_time = today_at_midnight.strftime("%Y%m%d %H%M%S")
46
+
47
+ # Get all the campaigns for this account.
48
+ selector = {
49
+ :fields => ['Id']
50
+ }
51
+ response = campaign_srv.get(selector)
52
+
53
+ campaign_ids = []
54
+
55
+ if response and response[:entries]
56
+ campaign_ids = response[:entries].map { |campaign| campaign[:id] }
57
+ else
58
+ raise StandardError, 'No campaigns were found.'
59
+ end
60
+
61
+ # Create a selector for CustomerSyncService.
62
+ selector = {
63
+ :campaign_ids => campaign_ids,
64
+ :date_time_range => {
65
+ :min => min_date_time,
66
+ :max => max_date_time
67
+ }
68
+ }
69
+
70
+ # Get all account changes for the campaigns.
71
+ campaign_changes = customer_sync_srv.get(selector)
72
+
73
+ # Display changes.
74
+ if campaign_changes
75
+ puts "Most recent change: %s" % campaign_changes[:last_change_timestamp]
76
+ campaign_changes[:changed_campaigns].each do |campaign|
77
+ puts "Campaign with ID %d was changed:" % campaign[:campaign_id]
78
+ puts "\tCampaign change status: '%s'" % campaign[:campaign_change_status]
79
+ unless ['NEW', 'FIELDS_UNCHANGED'].include?(
80
+ campaign[:campaign_change_status])
81
+ puts "\tAdded ad extensions: '%s'" %
82
+ campaign[:added_ad_extensions].pretty_inspect.chomp
83
+ puts "\tAdded campaign criteria: '%s'" %
84
+ campaign[:added_campaign_criteria].pretty_inspect.chomp
85
+ puts "\tAdded campaign targeting: '%s'" %
86
+ campaign[:campaign_targeting_changed].pretty_inspect.chomp
87
+ puts "\tDeleted ad extensions: '%s'" %
88
+ campaign[:deleted_ad_extensions].pretty_inspect.chomp
89
+ puts "\tDeleted campaign criteria: '%s'" %
90
+ campaign[:deleted_campaign_criteria].pretty_inspect.chomp
91
+
92
+ if campaign[:changed_ad_groups]
93
+ campaign[:changed_ad_groups].each do |ad_group|
94
+ puts "\tAd group with ID %d was changed:" % ad_group[:ad_group_id]
95
+ puts "\t\tAd group changed status: '%s'" %
96
+ ad_group[:ad_group_change_status]
97
+ unless ['NEW', 'FIELDS_UNCHANGED'].include?(
98
+ ad_group[:ad_group_change_status])
99
+ puts "\t\tAds changed: '%s'" %
100
+ ad_group[:changed_ads].pretty_inspect.chomp
101
+ puts "\t\tCriteria changed: '%s'" %
102
+ ad_group[:changed_criteria].pretty_inspect.chomp
103
+ puts "\t\tCriteria deleted: '%s'" %
104
+ ad_group[:deleted_criteria].pretty_inspect.chomp
105
+ end
106
+ end
107
+ end
108
+ end
109
+ puts
110
+ end
111
+ else
112
+ puts 'No account changes were found.'
113
+ end
114
+ end
115
+
116
+ if __FILE__ == $0
117
+ API_VERSION = :v201302
118
+
119
+ begin
120
+ get_account_changes()
121
+
122
+ # HTTP errors.
123
+ rescue AdsCommon::Errors::HttpError => e
124
+ puts "HTTP Error: %s" % e
125
+
126
+ # API errors.
127
+ rescue AdwordsApi::Errors::ApiException => e
128
+ puts "Message: %s" % e.message
129
+ puts 'Errors:'
130
+ e.errors.each_with_index do |error, index|
131
+ puts "\tError [%d]:" % (index + 1)
132
+ error.each do |field, value|
133
+ puts "\t\t%s: %s" % [field, value]
134
+ end
135
+ end
136
+ end
137
+ end
@@ -0,0 +1,95 @@
1
+ #!/usr/bin/env ruby
2
+ # Encoding: utf-8
3
+ #
4
+ # Author:: api.dklimkin@gmail.com (Danial Klimkin)
5
+ #
6
+ # Copyright:: Copyright 2011, Google Inc. All Rights Reserved.
7
+ #
8
+ # License:: Licensed under the Apache License, Version 2.0 (the "License");
9
+ # you may not use this file except in compliance with the License.
10
+ # You may obtain a copy of the License at
11
+ #
12
+ # http://www.apache.org/licenses/LICENSE-2.0
13
+ #
14
+ # Unless required by applicable law or agreed to in writing, software
15
+ # distributed under the License is distributed on an "AS IS" BASIS,
16
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
17
+ # implied.
18
+ # See the License for the specific language governing permissions and
19
+ # limitations under the License.
20
+ #
21
+ # This example illustrates how to retrieve the account hierarchy under an
22
+ # account.
23
+ #
24
+ # Note: This code example uses MCC-level calls and won't work with Test
25
+ # Accounts, see: https://developers.google.com/adwords/api/docs/test-accounts
26
+ #
27
+ # Tags: ManagedCustomerService.get
28
+
29
+ require 'adwords_api'
30
+ require 'adwords_api/utils'
31
+
32
+ def get_account_hierarchy()
33
+ # AdwordsApi::Api will read a config file from ENV['HOME']/adwords_api.yml
34
+ # when called without parameters.
35
+ adwords = AdwordsApi::Api.new
36
+
37
+ # To enable logging of SOAP requests, set the log_level value to 'DEBUG' in
38
+ # the configuration file or provide your own logger:
39
+ # adwords.logger = Logger.new('adwords_xml.log')
40
+
41
+ managed_customer_srv = adwords.service(:ManagedCustomerService, API_VERSION)
42
+
43
+ # Get the account hierarchy for this account.
44
+ selector = {
45
+ :fields => ['Login', 'CustomerId', 'Name']
46
+ }
47
+
48
+ # Run the request at the MCC level.
49
+ graph = adwords.use_mcc() {managed_customer_srv.get(selector)}
50
+
51
+ if graph and graph[:entries]
52
+ puts 'Accounts under this hierarchy: %d' % graph[:total_num_entries]
53
+ graph[:entries].each_with_index do |account, index|
54
+ puts "%d) Customer ID: %s" %
55
+ [index + 1, AdwordsApi::Utils.format_id(account[:customer_id])]
56
+ puts "\tLogin email: %s" % account[:login]
57
+ puts "\tName: %s" % account[:name]
58
+ end
59
+
60
+ # Display the links.
61
+ if graph[:links]
62
+ puts 'Hierarchy links:'
63
+ graph[:links].each do |link|
64
+ puts "\tThere is a link from %s to %s" %
65
+ [AdwordsApi::Utils.format_id(link[:manager_customer_id]),
66
+ AdwordsApi::Utils.format_id(link[:client_customer_id])]
67
+ end
68
+ end
69
+ else
70
+ puts 'No accounts were found.'
71
+ end
72
+ end
73
+
74
+ if __FILE__ == $0
75
+ API_VERSION = :v201302
76
+
77
+ begin
78
+ get_account_hierarchy()
79
+
80
+ # HTTP errors.
81
+ rescue AdsCommon::Errors::HttpError => e
82
+ puts "HTTP Error: %s" % e
83
+
84
+ # API errors.
85
+ rescue AdwordsApi::Errors::ApiException => e
86
+ puts "Message: %s" % e.message
87
+ puts 'Errors:'
88
+ e.errors.each_with_index do |error, index|
89
+ puts "\tError [%d]:" % (index + 1)
90
+ error.each do |field, value|
91
+ puts "\t\t%s: %s" % [field, value]
92
+ end
93
+ end
94
+ end
95
+ end