google-adwords-api 0.15.2 → 0.16.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (167) hide show
  1. checksums.yaml +8 -8
  2. data/ChangeLog +7 -0
  3. data/adwords_api.yml +3 -2
  4. data/examples/v201506/basic_operations/get_keywords.rb +4 -3
  5. data/examples/v201506/misc/{create_ad_words_session_without_properties_file.rb → use_runtime_config.rb} +2 -2
  6. data/lib/adwords_api.rb +1 -1
  7. data/lib/adwords_api/api_config.rb +0 -86
  8. data/lib/adwords_api/report_header_handler.rb +4 -4
  9. data/lib/adwords_api/version.rb +1 -1
  10. data/test/templates/v201502/basic_operations_get_campaigns.def +1 -1
  11. data/test/templates/v201502/{misc_use_oauth2_jwt.def → misc_use_oauth2_service_account.def} +2 -2
  12. data/test/templates/v201506/basic_operations_get_campaigns.def +1 -1
  13. data/test/templates/v201506/{misc_use_oauth2_jwt.def → misc_use_oauth2_service_account.def} +2 -2
  14. metadata +7 -160
  15. data/examples/v201409/account_management/create_account.rb +0 -92
  16. data/examples/v201409/account_management/get_account_changes.rb +0 -145
  17. data/examples/v201409/account_management/get_account_hierarchy.rb +0 -102
  18. data/examples/v201409/advanced_operations/add_ad_customizers.rb +0 -277
  19. data/examples/v201409/advanced_operations/add_ad_group_bid_modifier.rb +0 -105
  20. data/examples/v201409/advanced_operations/add_click_to_download_ad.rb +0 -137
  21. data/examples/v201409/advanced_operations/add_text_ad_with_upgraded_urls.rb +0 -137
  22. data/examples/v201409/advanced_operations/get_ad_group_bid_modifiers.rb +0 -106
  23. data/examples/v201409/advanced_operations/upload_offline_conversions.rb +0 -117
  24. data/examples/v201409/advanced_operations/use_shared_bidding_strategy.rb +0 -152
  25. data/examples/v201409/basic_operations/add_ad_groups.rb +0 -144
  26. data/examples/v201409/basic_operations/add_campaigns.rb +0 -143
  27. data/examples/v201409/basic_operations/add_keywords.rb +0 -118
  28. data/examples/v201409/basic_operations/add_text_ads.rb +0 -113
  29. data/examples/v201409/basic_operations/get_ad_groups.rb +0 -106
  30. data/examples/v201409/basic_operations/get_campaigns.rb +0 -101
  31. data/examples/v201409/basic_operations/get_campaigns_with_awql.rb +0 -93
  32. data/examples/v201409/basic_operations/get_keywords.rb +0 -112
  33. data/examples/v201409/basic_operations/get_text_ads.rb +0 -114
  34. data/examples/v201409/basic_operations/pause_ad.rb +0 -92
  35. data/examples/v201409/basic_operations/remove_ad.rb +0 -93
  36. data/examples/v201409/basic_operations/remove_ad_group.rb +0 -89
  37. data/examples/v201409/basic_operations/remove_campaign.rb +0 -91
  38. data/examples/v201409/basic_operations/remove_keyword.rb +0 -98
  39. data/examples/v201409/basic_operations/update_ad_group.rb +0 -89
  40. data/examples/v201409/basic_operations/update_campaign.rb +0 -90
  41. data/examples/v201409/basic_operations/update_keyword.rb +0 -110
  42. data/examples/v201409/campaign_management/add_campaign_labels.rb +0 -86
  43. data/examples/v201409/campaign_management/add_experiment.rb +0 -166
  44. data/examples/v201409/campaign_management/add_keywords_in_bulk.rb +0 -158
  45. data/examples/v201409/campaign_management/add_location_extension.rb +0 -125
  46. data/examples/v201409/campaign_management/get_all_disapproved_ads.rb +0 -101
  47. data/examples/v201409/campaign_management/get_all_disapproved_ads_with_awql.rb +0 -93
  48. data/examples/v201409/campaign_management/get_campaigns_by_label.rb +0 -112
  49. data/examples/v201409/campaign_management/promote_experiment.rb +0 -85
  50. data/examples/v201409/campaign_management/set_ad_parameters.rb +0 -122
  51. data/examples/v201409/campaign_management/set_criterion_bid_modifier.rb +0 -108
  52. data/examples/v201409/campaign_management/validate_text_ad.rb +0 -114
  53. data/examples/v201409/error_handling/handle_partial_failures.rb +0 -134
  54. data/examples/v201409/error_handling/handle_policy_violation_error.rb +0 -145
  55. data/examples/v201409/extensions/add_google_my_business_location_extensions.rb +0 -183
  56. data/examples/v201409/extensions/add_site_links.rb +0 -167
  57. data/examples/v201409/extensions/add_site_links_using_feeds.rb +0 -306
  58. data/examples/v201409/migration/migrate_to_extension_settings.rb +0 -392
  59. data/examples/v201409/migration/upgrade_ad_url.rb +0 -97
  60. data/examples/v201409/misc/create_ad_words_session_without_properties_file.rb +0 -94
  61. data/examples/v201409/misc/get_all_images_and_videos.rb +0 -108
  62. data/examples/v201409/misc/setup_oauth2.rb +0 -88
  63. data/examples/v201409/misc/upload_image.rb +0 -97
  64. data/examples/v201409/misc/use_oauth2_jwt.rb +0 -97
  65. data/examples/v201409/optimization/estimate_keyword_traffic.rb +0 -155
  66. data/examples/v201409/optimization/get_keyword_bid_simulations.rb +0 -100
  67. data/examples/v201409/optimization/get_keyword_ideas.rb +0 -130
  68. data/examples/v201409/remarketing/add_audience.rb +0 -122
  69. data/examples/v201409/remarketing/add_conversion_tracker.rb +0 -105
  70. data/examples/v201409/remarketing/add_rule_based_user_lists.rb +0 -171
  71. data/examples/v201409/reporting/download_criteria_report.rb +0 -87
  72. data/examples/v201409/reporting/download_criteria_report_with_awql.rb +0 -86
  73. data/examples/v201409/reporting/get_report_fields.rb +0 -79
  74. data/examples/v201409/reporting/parallel_report_download.rb +0 -171
  75. data/examples/v201409/shopping_campaigns/add_product_partition_tree.rb +0 -269
  76. data/examples/v201409/shopping_campaigns/add_product_scope.rb +0 -133
  77. data/examples/v201409/shopping_campaigns/add_shopping_campaign.rb +0 -131
  78. data/examples/v201409/shopping_campaigns/get_product_category_taxonomy.rb +0 -117
  79. data/examples/v201409/targeting/add_campaign_targeting_criteria.rb +0 -173
  80. data/examples/v201409/targeting/add_demographic_targeting_criteria.rb +0 -116
  81. data/examples/v201409/targeting/get_campaign_targeting_criteria.rb +0 -110
  82. data/examples/v201409/targeting/get_targetable_languages_and_carriers.rb +0 -94
  83. data/examples/v201409/targeting/lookup_location.rb +0 -112
  84. data/lib/adwords_api/v201409/ad_customizer_feed_service.rb +0 -38
  85. data/lib/adwords_api/v201409/ad_customizer_feed_service_registry.rb +0 -46
  86. data/lib/adwords_api/v201409/ad_group_ad_service.rb +0 -50
  87. data/lib/adwords_api/v201409/ad_group_ad_service_registry.rb +0 -46
  88. data/lib/adwords_api/v201409/ad_group_bid_modifier_service.rb +0 -42
  89. data/lib/adwords_api/v201409/ad_group_bid_modifier_service_registry.rb +0 -46
  90. data/lib/adwords_api/v201409/ad_group_criterion_service.rb +0 -46
  91. data/lib/adwords_api/v201409/ad_group_criterion_service_registry.rb +0 -46
  92. data/lib/adwords_api/v201409/ad_group_extension_setting_service.rb +0 -42
  93. data/lib/adwords_api/v201409/ad_group_extension_setting_service_registry.rb +0 -46
  94. data/lib/adwords_api/v201409/ad_group_feed_service.rb +0 -42
  95. data/lib/adwords_api/v201409/ad_group_feed_service_registry.rb +0 -46
  96. data/lib/adwords_api/v201409/ad_group_service.rb +0 -46
  97. data/lib/adwords_api/v201409/ad_group_service_registry.rb +0 -46
  98. data/lib/adwords_api/v201409/ad_param_service.rb +0 -38
  99. data/lib/adwords_api/v201409/ad_param_service_registry.rb +0 -46
  100. data/lib/adwords_api/v201409/adwords_user_list_service.rb +0 -38
  101. data/lib/adwords_api/v201409/adwords_user_list_service_registry.rb +0 -46
  102. data/lib/adwords_api/v201409/bidding_strategy_service.rb +0 -42
  103. data/lib/adwords_api/v201409/bidding_strategy_service_registry.rb +0 -46
  104. data/lib/adwords_api/v201409/budget_order_service.rb +0 -42
  105. data/lib/adwords_api/v201409/budget_order_service_registry.rb +0 -46
  106. data/lib/adwords_api/v201409/budget_service.rb +0 -42
  107. data/lib/adwords_api/v201409/budget_service_registry.rb +0 -46
  108. data/lib/adwords_api/v201409/campaign_ad_extension_service.rb +0 -38
  109. data/lib/adwords_api/v201409/campaign_ad_extension_service_registry.rb +0 -46
  110. data/lib/adwords_api/v201409/campaign_criterion_service.rb +0 -42
  111. data/lib/adwords_api/v201409/campaign_criterion_service_registry.rb +0 -46
  112. data/lib/adwords_api/v201409/campaign_extension_setting_service.rb +0 -42
  113. data/lib/adwords_api/v201409/campaign_extension_setting_service_registry.rb +0 -46
  114. data/lib/adwords_api/v201409/campaign_feed_service.rb +0 -42
  115. data/lib/adwords_api/v201409/campaign_feed_service_registry.rb +0 -46
  116. data/lib/adwords_api/v201409/campaign_service.rb +0 -46
  117. data/lib/adwords_api/v201409/campaign_service_registry.rb +0 -46
  118. data/lib/adwords_api/v201409/campaign_shared_set_service.rb +0 -38
  119. data/lib/adwords_api/v201409/campaign_shared_set_service_registry.rb +0 -47
  120. data/lib/adwords_api/v201409/constant_data_service.rb +0 -66
  121. data/lib/adwords_api/v201409/constant_data_service_registry.rb +0 -46
  122. data/lib/adwords_api/v201409/conversion_tracker_service.rb +0 -38
  123. data/lib/adwords_api/v201409/conversion_tracker_service_registry.rb +0 -46
  124. data/lib/adwords_api/v201409/customer_extension_setting_service.rb +0 -42
  125. data/lib/adwords_api/v201409/customer_extension_setting_service_registry.rb +0 -46
  126. data/lib/adwords_api/v201409/customer_feed_service.rb +0 -42
  127. data/lib/adwords_api/v201409/customer_feed_service_registry.rb +0 -46
  128. data/lib/adwords_api/v201409/customer_service.rb +0 -38
  129. data/lib/adwords_api/v201409/customer_service_registry.rb +0 -46
  130. data/lib/adwords_api/v201409/customer_sync_service.rb +0 -34
  131. data/lib/adwords_api/v201409/customer_sync_service_registry.rb +0 -47
  132. data/lib/adwords_api/v201409/data_service.rb +0 -54
  133. data/lib/adwords_api/v201409/data_service_registry.rb +0 -46
  134. data/lib/adwords_api/v201409/experiment_service.rb +0 -38
  135. data/lib/adwords_api/v201409/experiment_service_registry.rb +0 -46
  136. data/lib/adwords_api/v201409/feed_item_service.rb +0 -42
  137. data/lib/adwords_api/v201409/feed_item_service_registry.rb +0 -46
  138. data/lib/adwords_api/v201409/feed_mapping_service.rb +0 -42
  139. data/lib/adwords_api/v201409/feed_mapping_service_registry.rb +0 -46
  140. data/lib/adwords_api/v201409/feed_service.rb +0 -42
  141. data/lib/adwords_api/v201409/feed_service_registry.rb +0 -46
  142. data/lib/adwords_api/v201409/geo_location_service.rb +0 -34
  143. data/lib/adwords_api/v201409/geo_location_service_registry.rb +0 -46
  144. data/lib/adwords_api/v201409/label_service.rb +0 -42
  145. data/lib/adwords_api/v201409/label_service_registry.rb +0 -46
  146. data/lib/adwords_api/v201409/location_criterion_service.rb +0 -38
  147. data/lib/adwords_api/v201409/location_criterion_service_registry.rb +0 -46
  148. data/lib/adwords_api/v201409/managed_customer_service.rb +0 -50
  149. data/lib/adwords_api/v201409/managed_customer_service_registry.rb +0 -46
  150. data/lib/adwords_api/v201409/media_service.rb +0 -42
  151. data/lib/adwords_api/v201409/media_service_registry.rb +0 -46
  152. data/lib/adwords_api/v201409/mutate_job_service.rb +0 -42
  153. data/lib/adwords_api/v201409/mutate_job_service_registry.rb +0 -46
  154. data/lib/adwords_api/v201409/offline_conversion_feed_service.rb +0 -34
  155. data/lib/adwords_api/v201409/offline_conversion_feed_service_registry.rb +0 -46
  156. data/lib/adwords_api/v201409/report_definition_service.rb +0 -34
  157. data/lib/adwords_api/v201409/report_definition_service_registry.rb +0 -46
  158. data/lib/adwords_api/v201409/shared_criterion_service.rb +0 -38
  159. data/lib/adwords_api/v201409/shared_criterion_service_registry.rb +0 -47
  160. data/lib/adwords_api/v201409/shared_set_service.rb +0 -38
  161. data/lib/adwords_api/v201409/shared_set_service_registry.rb +0 -47
  162. data/lib/adwords_api/v201409/targeting_idea_service.rb +0 -34
  163. data/lib/adwords_api/v201409/targeting_idea_service_registry.rb +0 -46
  164. data/lib/adwords_api/v201409/traffic_estimator_service.rb +0 -34
  165. data/lib/adwords_api/v201409/traffic_estimator_service_registry.rb +0 -46
  166. data/test/templates/v201409/basic_operations_get_campaigns.def +0 -116
  167. data/test/templates/v201409/misc_use_oauth2_jwt.def +0 -131
@@ -1,101 +0,0 @@
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 all the disapproved ads in a given
22
- # ad group. To add ads, run add_text_ads.rb.
23
- #
24
- # Tags: AdGroupAdService.get
25
-
26
- require 'adwords_api'
27
-
28
- def get_all_disapproved_ads(ad_group_id)
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
- ad_group_ad_srv = adwords.service(:AdGroupAdService, API_VERSION)
38
-
39
- # Get all the disapproved ads for this campaign.
40
- selector = {
41
- :fields => ['Id', 'AdGroupAdDisapprovalReasons'],
42
- :ordering => [{:field => 'Id', :sort_order => 'ASCENDING'}],
43
- :predicates => [
44
- {:field => 'AdGroupId', :operator => 'IN', :values => [ad_group_id]},
45
- {
46
- :field => 'AdGroupCreativeApprovalStatus',
47
- :operator => 'IN',
48
- :values => ['DISAPPROVED']
49
- }
50
- ]
51
- }
52
- response = ad_group_ad_srv.get(selector)
53
- if response and response[:entries]
54
- puts 'Ad group %d has %d disapproved ad(s).' %
55
- [ad_group_id, response[:total_num_entries]]
56
- response[:entries].each do |ad_group_ad|
57
- puts ("\tAd with ID %d and type '%s' was disapproved for the following " +
58
- 'reasons:') % [ad_group_ad[:ad][:id], ad_group_ad[:ad][:xsi_type]]
59
- if ad_group_ad.include?(:disapproval_reasons)
60
- ad_group_ad[:disapproval_reasons].each {|reason| puts "\t\t%s" % reason}
61
- else
62
- puts "\t\tReason not provided."
63
- end
64
- end
65
- else
66
- puts 'No disapproved ads found for ad group %d.' % ad_group_id
67
- end
68
- end
69
-
70
- if __FILE__ == $0
71
- API_VERSION = :v201409
72
-
73
- begin
74
- # ID of an ad group to get disapproved ads for.
75
- ad_group_id = 'INSERT_AD_GROUP_ID_HERE'.to_i
76
- get_all_disapproved_ads(ad_group_id)
77
-
78
- # Authorization error.
79
- rescue AdsCommon::Errors::OAuth2VerificationRequired => e
80
- puts "Authorization credentials are not valid. Edit adwords_api.yml for " +
81
- "OAuth2 client ID and secret and run misc/setup_oauth2.rb example " +
82
- "to retrieve and store OAuth2 tokens."
83
- puts "See this wiki page for more details:\n\n " +
84
- 'http://code.google.com/p/google-api-ads-ruby/wiki/OAuth2'
85
-
86
- # HTTP errors.
87
- rescue AdsCommon::Errors::HttpError => e
88
- puts "HTTP Error: %s" % e
89
-
90
- # API errors.
91
- rescue AdwordsApi::Errors::ApiException => e
92
- puts "Message: %s" % e.message
93
- puts 'Errors:'
94
- e.errors.each_with_index do |error, index|
95
- puts "\tError [%d]:" % (index + 1)
96
- error.each do |field, value|
97
- puts "\t\t%s: %s" % [field, value]
98
- end
99
- end
100
- end
101
- end
@@ -1,93 +0,0 @@
1
- #!/usr/bin/env ruby
2
- # Encoding: utf-8
3
- #
4
- # Author:: api.dklimkin@gmail.com (Danial Klimkin)
5
- #
6
- # Copyright:: Copyright 2012, 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 all the disapproved ads in a given
22
- # ad group with AWQL. To add ads, run add_text_ads.rb.
23
- #
24
- # Tags: AdGroupAdService.query
25
-
26
- require 'adwords_api'
27
-
28
- def get_all_disapproved_ads_with_awql(ad_group_id)
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
- ad_group_ad_srv = adwords.service(:AdGroupAdService, API_VERSION)
38
-
39
- # Get all the disapproved ads for this campaign.
40
- query = ('SELECT Id, AdGroupAdDisapprovalReasons ' +
41
- 'WHERE AdGroupId = %d AND AdGroupCreativeApprovalStatus = DISAPPROVED ' +
42
- 'ORDER BY Id') % ad_group_id
43
-
44
- response = ad_group_ad_srv.query(query)
45
- if response and response[:entries]
46
- puts 'Ad group ID %d has %d disapproved ad(s).' %
47
- [ad_group_id, response[:total_num_entries]]
48
- response[:entries].each do |ad_group_ad|
49
- puts ("\tAd with ID %d and type '%s' was disapproved for the following " +
50
- 'reasons:') % [ad_group_ad[:ad][:id], ad_group_ad[:ad][:xsi_type]]
51
- if ad_group_ad.include?(:disapproval_reasons)
52
- ad_group_ad[:disapproval_reasons].each {|reason| puts "\t\t%s" % reason}
53
- else
54
- puts "\t\tReason not provided."
55
- end
56
- end
57
- else
58
- puts 'No disapproved ads found for ad group ID %d.' % ad_group_id
59
- end
60
- end
61
-
62
- if __FILE__ == $0
63
- API_VERSION = :v201409
64
-
65
- begin
66
- # ID of an ad group to get disapproved ads for.
67
- ad_group_id = 'INSERT_AD_GROUP_ID_HERE'.to_i
68
- get_all_disapproved_ads_with_awql(ad_group_id)
69
-
70
- # Authorization error.
71
- rescue AdsCommon::Errors::OAuth2VerificationRequired => e
72
- puts "Authorization credentials are not valid. Edit adwords_api.yml for " +
73
- "OAuth2 client ID and secret and run misc/setup_oauth2.rb example " +
74
- "to retrieve and store OAuth2 tokens."
75
- puts "See this wiki page for more details:\n\n " +
76
- 'http://code.google.com/p/google-api-ads-ruby/wiki/OAuth2'
77
-
78
- # HTTP errors.
79
- rescue AdsCommon::Errors::HttpError => e
80
- puts 'HTTP Error: %s' % e
81
-
82
- # API errors.
83
- rescue AdwordsApi::Errors::ApiException => e
84
- puts 'Message: %s' % e.message
85
- puts 'Errors:'
86
- e.errors.each_with_index do |error, index|
87
- puts "\tError [%d]:" % (index + 1)
88
- error.each do |field, value|
89
- puts "\t\t%s: %s" % [field, value]
90
- end
91
- end
92
- end
93
- end
@@ -1,112 +0,0 @@
1
- #!/usr/bin/env ruby
2
- # Encoding: utf-8
3
- #
4
- # Author:: api.mcloonan@gmail.com (Michael Cloonan)
5
- #
6
- # Copyright:: Copyright 2014, 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 campaigns with a specific label. To add a label
22
- # to campaigns, run add_campaign_labels.rb.
23
- #
24
- # Tags: CampaignService.get
25
-
26
- require 'adwords_api'
27
-
28
- def get_campaigns_by_label(label_id)
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
- campaign_srv = adwords.service(:CampaignService, API_VERSION)
38
-
39
- # Get all the ad groups for this campaign.
40
- selector = {
41
- :fields => ['Id', 'Name', 'Labels'],
42
- :ordering => [{:field => 'Name', :sort_order => 'ASCENDING'}],
43
- :predicates => [
44
- {
45
- :field => 'Labels',
46
- # Labels filtering is performed by ID. You can use CONTAINS_ANY to
47
- # select campaigns with any of the label IDs, CONTAINS_ALL to select
48
- # campaigns with all of the label IDs, or CONTAINS_NONE to select
49
- # campaigns with none of the label IDs.
50
- :operator => 'CONTAINS_ANY',
51
- :values => [label_id]
52
- }
53
- ],
54
- :paging => {
55
- :start_index => 0,
56
- :number_results => PAGE_SIZE
57
- }
58
- }
59
-
60
- # Set initial values.
61
- offset, page = 0, {}
62
-
63
- begin
64
- page = campaign_srv.get(selector)
65
- if page[:entries]
66
- page[:entries].each do |campaign|
67
- label_string = campaign[:labels].map do |label|
68
- '%d/"%s"' % [label[:id], label[:name]]
69
- end.join(', ')
70
- puts 'Campaign found with name "%s" and ID %d and labels: %s.' %
71
- [campaign[:name], campaign[:id], label_string]
72
- end
73
- # Increment values to request the next page.
74
- offset += PAGE_SIZE
75
- selector[:paging][:start_index] = offset
76
- end
77
- end while page[:total_num_entries] > offset
78
- end
79
-
80
- if __FILE__ == $0
81
- API_VERSION = :v201409
82
- PAGE_SIZE = 500
83
-
84
- begin
85
- # Label ID to get campaigns for.
86
- label_id = 'INSERT_LABEL_ID_HERE'.to_i
87
- get_campaigns_by_label(label_id)
88
-
89
- # Authorization error.
90
- rescue AdsCommon::Errors::OAuth2VerificationRequired => e
91
- puts "Authorization credentials are not valid. Edit adwords_api.yml for " +
92
- "OAuth2 client ID and secret and run misc/setup_oauth2.rb example " +
93
- "to retrieve and store OAuth2 tokens."
94
- puts "See this wiki page for more details:\n\n " +
95
- 'http://code.google.com/p/google-api-ads-ruby/wiki/OAuth2'
96
-
97
- # HTTP errors.
98
- rescue AdsCommon::Errors::HttpError => e
99
- puts "HTTP Error: %s" % e
100
-
101
- # API errors.
102
- rescue AdwordsApi::Errors::ApiException => e
103
- puts "Message: %s" % e.message
104
- puts 'Errors:'
105
- e.errors.each_with_index do |error, index|
106
- puts "\tError [%d]:" % (index + 1)
107
- error.each do |field, value|
108
- puts "\t\t%s: %s" % [field, value]
109
- end
110
- end
111
- end
112
- end
@@ -1,85 +0,0 @@
1
- #!/usr/bin/env ruby
2
- # Encoding: utf-8
3
- #
4
- # Author:: api.sgomes@gmail.com (Sérgio Gomes)
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 promotes an experiment, which permanently applies all the
22
- # experiment changes made to its related ad groups, criteria and ads.
23
- #
24
- # Tags: ExperimentService.mutate
25
-
26
- require 'adwords_api'
27
-
28
- def promote_experiment(experiment_id)
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
- experiment_srv = adwords.service(:ExperimentService, API_VERSION)
38
-
39
- # Prepare for updating experiment.
40
- operation = {
41
- :operator => 'SET',
42
- :operand => {
43
- :id => experiment_id,
44
- :status => 'PROMOTED',
45
- }
46
- }
47
-
48
- # Update experiment.
49
- response = experiment_srv.mutate([operation])
50
- experiment = response[:value].first
51
- puts "Experiment with name '%s' and ID %d was promoted." %
52
- [experiment[:name], experiment[:id]]
53
- end
54
-
55
- if __FILE__ == $0
56
- API_VERSION = :v201409
57
-
58
- begin
59
- experiment_id = 'INSERT_EXPERIMENT_ID_HERE'.to_i
60
- promote_experiment(experiment_id)
61
-
62
- # Authorization error.
63
- rescue AdsCommon::Errors::OAuth2VerificationRequired => e
64
- puts "Authorization credentials are not valid. Edit adwords_api.yml for " +
65
- "OAuth2 client ID and secret and run misc/setup_oauth2.rb example " +
66
- "to retrieve and store OAuth2 tokens."
67
- puts "See this wiki page for more details:\n\n " +
68
- 'http://code.google.com/p/google-api-ads-ruby/wiki/OAuth2'
69
-
70
- # HTTP errors.
71
- rescue AdsCommon::Errors::HttpError => e
72
- puts "HTTP Error: %s" % e
73
-
74
- # API errors.
75
- rescue AdwordsApi::Errors::ApiException => e
76
- puts "Message: %s" % e.message
77
- puts 'Errors:'
78
- e.errors.each_with_index do |error, index|
79
- puts "\tError [%d]:" % (index + 1)
80
- error.each do |field, value|
81
- puts "\t\t%s: %s" % [field, value]
82
- end
83
- end
84
- end
85
- end
@@ -1,122 +0,0 @@
1
- #!/usr/bin/env ruby
2
- # Encoding: utf-8
3
- #
4
- # Author:: api.sgomes@gmail.com (Sérgio Gomes)
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 a text ad with ad parameters. To add an
22
- # ad group, run add_ad_group.rb. To add a keyword, run add_keywords.rb.
23
- #
24
- # Tags: AdGroupAdService.mutate, AdParamService.mutate
25
-
26
- require 'adwords_api'
27
-
28
- def set_ad_parameters(ad_group_id, criterion_id)
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
- ad_group_ad_srv = adwords.service(:AdGroupAdService, API_VERSION)
38
- ad_param_srv = adwords.service(:AdParamService, API_VERSION)
39
-
40
- # Prepare for adding ad.
41
- ad_operation = {
42
- :operator => 'ADD',
43
- :operand => {
44
- :ad_group_id => ad_group_id,
45
- :ad => {
46
- # The 'xsi_type' field allows you to specify the xsi:type of the object
47
- # being created. It's only necessary when you must provide an explicit
48
- # type that the client library can't infer.
49
- :xsi_type => 'TextAd',
50
- :headline => 'Luxury Mars Cruises',
51
- :description1 => 'Low-gravity fun for {param1:cheap}.',
52
- :description2 => 'Only {param2:a few} seats left!',
53
- :final_urls => ['http://www.example.com'],
54
- :display_url => 'www.example.com'
55
- }
56
- }
57
- }
58
-
59
- # Add ad.
60
- response = ad_group_ad_srv.mutate([ad_operation])
61
- ad = response[:value].first[:ad]
62
- puts "Text ad ID %d was successfully added." % ad[:id]
63
-
64
- # Prepare for setting ad parameters.
65
- price_operation = {
66
- :operator => 'SET',
67
- :operand => {
68
- :ad_group_id => ad_group_id,
69
- :criterion_id => criterion_id,
70
- :param_index => 1,
71
- :insertion_text => '$100'
72
- }
73
- }
74
-
75
- seat_operation = {
76
- :operator => 'SET',
77
- :operand => {
78
- :ad_group_id => ad_group_id,
79
- :criterion_id => criterion_id,
80
- :param_index => 2,
81
- :insertion_text => '50'
82
- }
83
- }
84
-
85
- # Set ad parameters.
86
- response = ad_param_srv.mutate([price_operation, seat_operation])
87
- puts 'Parameters were successfully updated.'
88
- end
89
-
90
- if __FILE__ == $0
91
- API_VERSION = :v201409
92
-
93
- begin
94
- # IDs of ad group and criterion to set ad parameter for.
95
- ad_group_id = 'INSERT_AD_GROUP_ID_HERE'.to_i
96
- criterion_id = 'INSERT_CRITERION_ID_HERE'.to_i
97
- set_ad_parameters(ad_group_id, criterion_id)
98
-
99
- # Authorization error.
100
- rescue AdsCommon::Errors::OAuth2VerificationRequired => e
101
- puts "Authorization credentials are not valid. Edit adwords_api.yml for " +
102
- "OAuth2 client ID and secret and run misc/setup_oauth2.rb example " +
103
- "to retrieve and store OAuth2 tokens."
104
- puts "See this wiki page for more details:\n\n " +
105
- 'http://code.google.com/p/google-api-ads-ruby/wiki/OAuth2'
106
-
107
- # HTTP errors.
108
- rescue AdsCommon::Errors::HttpError => e
109
- puts "HTTP Error: %s" % e
110
-
111
- # API errors.
112
- rescue AdwordsApi::Errors::ApiException => e
113
- puts "Message: %s" % e.message
114
- puts 'Errors:'
115
- e.errors.each_with_index do |error, index|
116
- puts "\tError [%d]:" % (index + 1)
117
- error.each do |field, value|
118
- puts "\t\t%s: %s" % [field, value]
119
- end
120
- end
121
- end
122
- end