google-adwords-api 0.11.1 → 0.12.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (152) hide show
  1. data/ChangeLog +3 -0
  2. data/{README → README.md} +0 -0
  3. data/lib/adwords_api/api_config.rb +0 -76
  4. data/lib/adwords_api/version.rb +1 -1
  5. data/test/templates/v201309/basic_operations_get_campaigns.def +1 -1
  6. data/test/templates/v201309/misc_use_oauth2_jwt.def +1 -1
  7. metadata +3 -148
  8. data/examples/v201306/account_management/create_account.rb +0 -95
  9. data/examples/v201306/account_management/get_account_alerts.rb +0 -122
  10. data/examples/v201306/account_management/get_account_changes.rb +0 -145
  11. data/examples/v201306/account_management/get_account_hierarchy.rb +0 -103
  12. data/examples/v201306/advanced_operations/add_ad_group_bid_modifier.rb +0 -105
  13. data/examples/v201306/advanced_operations/add_click_to_download_ad.rb +0 -137
  14. data/examples/v201306/advanced_operations/add_site_links.rb +0 -244
  15. data/examples/v201306/advanced_operations/create_and_attach_shared_keyword_set.rb +0 -147
  16. data/examples/v201306/advanced_operations/find_and_remove_criteria_from_shared_set.rb +0 -181
  17. data/examples/v201306/advanced_operations/get_ad_group_bid_modifiers.rb +0 -106
  18. data/examples/v201306/basic_operations/add_ad_groups.rb +0 -143
  19. data/examples/v201306/basic_operations/add_campaigns.rb +0 -162
  20. data/examples/v201306/basic_operations/add_keywords.rb +0 -116
  21. data/examples/v201306/basic_operations/add_text_ads.rb +0 -113
  22. data/examples/v201306/basic_operations/delete_ad.rb +0 -93
  23. data/examples/v201306/basic_operations/delete_ad_group.rb +0 -110
  24. data/examples/v201306/basic_operations/delete_campaign.rb +0 -111
  25. data/examples/v201306/basic_operations/delete_keyword.rb +0 -98
  26. data/examples/v201306/basic_operations/get_ad_groups.rb +0 -106
  27. data/examples/v201306/basic_operations/get_campaigns.rb +0 -101
  28. data/examples/v201306/basic_operations/get_campaigns_with_awql.rb +0 -93
  29. data/examples/v201306/basic_operations/get_keywords.rb +0 -112
  30. data/examples/v201306/basic_operations/get_text_ads.rb +0 -114
  31. data/examples/v201306/basic_operations/pause_ad.rb +0 -92
  32. data/examples/v201306/basic_operations/update_ad_group.rb +0 -89
  33. data/examples/v201306/basic_operations/update_campaign.rb +0 -90
  34. data/examples/v201306/basic_operations/update_keyword.rb +0 -110
  35. data/examples/v201306/campaign_management/add_experiment.rb +0 -166
  36. data/examples/v201306/campaign_management/add_keywords_in_bulk.rb +0 -158
  37. data/examples/v201306/campaign_management/add_location_extension.rb +0 -125
  38. data/examples/v201306/campaign_management/add_location_extension_override.rb +0 -91
  39. data/examples/v201306/campaign_management/get_all_disapproved_ads.rb +0 -101
  40. data/examples/v201306/campaign_management/get_all_disapproved_ads_with_awql.rb +0 -92
  41. data/examples/v201306/campaign_management/promote_experiment.rb +0 -85
  42. data/examples/v201306/campaign_management/set_ad_parameters.rb +0 -122
  43. data/examples/v201306/campaign_management/set_criterion_bid_modifier.rb +0 -110
  44. data/examples/v201306/campaign_management/validate_text_ad.rb +0 -114
  45. data/examples/v201306/error_handling/handle_captcha_challenge.rb +0 -93
  46. data/examples/v201306/error_handling/handle_partial_failures.rb +0 -134
  47. data/examples/v201306/error_handling/handle_policy_violation_error.rb +0 -145
  48. data/examples/v201306/error_handling/handle_two_factor_authorization_error.rb +0 -88
  49. data/examples/v201306/migration/upgrade_legacy_sitelinks.rb +0 -313
  50. data/examples/v201306/misc/get_all_images_and_videos.rb +0 -108
  51. data/examples/v201306/misc/setup_oauth2.rb +0 -88
  52. data/examples/v201306/misc/upload_image.rb +0 -97
  53. data/examples/v201306/misc/use_oauth2_jwt.rb +0 -97
  54. data/examples/v201306/optimization/estimate_keyword_traffic.rb +0 -137
  55. data/examples/v201306/optimization/get_keyword_bid_simulations.rb +0 -100
  56. data/examples/v201306/optimization/get_keyword_ideas.rb +0 -130
  57. data/examples/v201306/optimization/get_placement_ideas.rb +0 -112
  58. data/examples/v201306/remarketing/add_audience.rb +0 -123
  59. data/examples/v201306/remarketing/add_conversion_tracker.rb +0 -104
  60. data/examples/v201306/reporting/download_criteria_report.rb +0 -87
  61. data/examples/v201306/reporting/download_criteria_report_with_awql.rb +0 -86
  62. data/examples/v201306/reporting/get_campaign_stats.rb +0 -113
  63. data/examples/v201306/reporting/get_report_fields.rb +0 -79
  64. data/examples/v201306/reporting/parallel_report_download.rb +0 -171
  65. data/examples/v201306/targeting/add_campaign_targeting_criteria.rb +0 -123
  66. data/examples/v201306/targeting/add_demographic_targeting_criteria.rb +0 -116
  67. data/examples/v201306/targeting/get_campaign_targeting_criteria.rb +0 -110
  68. data/examples/v201306/targeting/get_targetable_languages_and_carriers.rb +0 -94
  69. data/examples/v201306/targeting/lookup_location.rb +0 -112
  70. data/examples/v201402/advanced_operations/add_places_location_extensions.rb~ +0 -159
  71. data/examples/v201402/basic_operations/add_ad_groups.rb~ +0 -147
  72. data/examples/v201402/misc/create_ad_words_session_without_properties_file.rb~ +0 -94
  73. data/examples/v201402/remarketing/add_conversion_tracker.rb~ +0 -109
  74. data/examples/v201402/shopping_campaigns/add_product_partition_tree.rb~ +0 -269
  75. data/examples/v201402/shopping_campaigns/add_shopping_campaign.rb~ +0 -136
  76. data/examples/v201402/shopping_campaigns/get_product_category_taxonomy.rb~ +0 -128
  77. data/examples/v201402/shopping_campaigns/set_product_sales_channel.rb~ +0 -98
  78. data/lib/adwords_api/v201306/ad_extension_override_service.rb +0 -38
  79. data/lib/adwords_api/v201306/ad_extension_override_service_registry.rb +0 -46
  80. data/lib/adwords_api/v201306/ad_group_ad_service.rb +0 -42
  81. data/lib/adwords_api/v201306/ad_group_ad_service_registry.rb +0 -46
  82. data/lib/adwords_api/v201306/ad_group_bid_modifier_service.rb +0 -38
  83. data/lib/adwords_api/v201306/ad_group_bid_modifier_service_registry.rb +0 -46
  84. data/lib/adwords_api/v201306/ad_group_criterion_service.rb +0 -42
  85. data/lib/adwords_api/v201306/ad_group_criterion_service_registry.rb +0 -46
  86. data/lib/adwords_api/v201306/ad_group_feed_service.rb +0 -38
  87. data/lib/adwords_api/v201306/ad_group_feed_service_registry.rb +0 -46
  88. data/lib/adwords_api/v201306/ad_group_service.rb +0 -42
  89. data/lib/adwords_api/v201306/ad_group_service_registry.rb +0 -46
  90. data/lib/adwords_api/v201306/ad_param_service.rb +0 -38
  91. data/lib/adwords_api/v201306/ad_param_service_registry.rb +0 -46
  92. data/lib/adwords_api/v201306/adwords_user_list_service.rb +0 -38
  93. data/lib/adwords_api/v201306/adwords_user_list_service_registry.rb +0 -46
  94. data/lib/adwords_api/v201306/alert_service.rb +0 -34
  95. data/lib/adwords_api/v201306/alert_service_registry.rb +0 -46
  96. data/lib/adwords_api/v201306/bidding_strategy_service.rb +0 -38
  97. data/lib/adwords_api/v201306/bidding_strategy_service_registry.rb +0 -46
  98. data/lib/adwords_api/v201306/budget_order_service.rb +0 -42
  99. data/lib/adwords_api/v201306/budget_order_service_registry.rb +0 -46
  100. data/lib/adwords_api/v201306/budget_service.rb +0 -38
  101. data/lib/adwords_api/v201306/budget_service_registry.rb +0 -46
  102. data/lib/adwords_api/v201306/campaign_ad_extension_service.rb +0 -38
  103. data/lib/adwords_api/v201306/campaign_ad_extension_service_registry.rb +0 -46
  104. data/lib/adwords_api/v201306/campaign_criterion_service.rb +0 -42
  105. data/lib/adwords_api/v201306/campaign_criterion_service_registry.rb +0 -46
  106. data/lib/adwords_api/v201306/campaign_feed_service.rb +0 -38
  107. data/lib/adwords_api/v201306/campaign_feed_service_registry.rb +0 -46
  108. data/lib/adwords_api/v201306/campaign_service.rb +0 -42
  109. data/lib/adwords_api/v201306/campaign_service_registry.rb +0 -46
  110. data/lib/adwords_api/v201306/campaign_shared_set_service.rb +0 -38
  111. data/lib/adwords_api/v201306/campaign_shared_set_service_registry.rb +0 -47
  112. data/lib/adwords_api/v201306/constant_data_service.rb +0 -62
  113. data/lib/adwords_api/v201306/constant_data_service_registry.rb +0 -46
  114. data/lib/adwords_api/v201306/conversion_tracker_service.rb +0 -38
  115. data/lib/adwords_api/v201306/conversion_tracker_service_registry.rb +0 -46
  116. data/lib/adwords_api/v201306/customer_service.rb +0 -34
  117. data/lib/adwords_api/v201306/customer_service_registry.rb +0 -46
  118. data/lib/adwords_api/v201306/customer_sync_service.rb +0 -34
  119. data/lib/adwords_api/v201306/customer_sync_service_registry.rb +0 -47
  120. data/lib/adwords_api/v201306/data_service.rb +0 -38
  121. data/lib/adwords_api/v201306/data_service_registry.rb +0 -46
  122. data/lib/adwords_api/v201306/experiment_service.rb +0 -38
  123. data/lib/adwords_api/v201306/experiment_service_registry.rb +0 -46
  124. data/lib/adwords_api/v201306/feed_item_service.rb +0 -38
  125. data/lib/adwords_api/v201306/feed_item_service_registry.rb +0 -46
  126. data/lib/adwords_api/v201306/feed_mapping_service.rb +0 -38
  127. data/lib/adwords_api/v201306/feed_mapping_service_registry.rb +0 -46
  128. data/lib/adwords_api/v201306/feed_service.rb +0 -38
  129. data/lib/adwords_api/v201306/feed_service_registry.rb +0 -46
  130. data/lib/adwords_api/v201306/geo_location_service.rb +0 -34
  131. data/lib/adwords_api/v201306/geo_location_service_registry.rb +0 -46
  132. data/lib/adwords_api/v201306/location_criterion_service.rb +0 -34
  133. data/lib/adwords_api/v201306/location_criterion_service_registry.rb +0 -46
  134. data/lib/adwords_api/v201306/managed_customer_service.rb +0 -50
  135. data/lib/adwords_api/v201306/managed_customer_service_registry.rb +0 -46
  136. data/lib/adwords_api/v201306/media_service.rb +0 -38
  137. data/lib/adwords_api/v201306/media_service_registry.rb +0 -46
  138. data/lib/adwords_api/v201306/mutate_job_service.rb +0 -42
  139. data/lib/adwords_api/v201306/mutate_job_service_registry.rb +0 -46
  140. data/lib/adwords_api/v201306/report_definition_service.rb +0 -34
  141. data/lib/adwords_api/v201306/report_definition_service_registry.rb +0 -46
  142. data/lib/adwords_api/v201306/shared_criterion_service.rb +0 -38
  143. data/lib/adwords_api/v201306/shared_criterion_service_registry.rb +0 -47
  144. data/lib/adwords_api/v201306/shared_set_service.rb +0 -38
  145. data/lib/adwords_api/v201306/shared_set_service_registry.rb +0 -47
  146. data/lib/adwords_api/v201306/targeting_idea_service.rb +0 -38
  147. data/lib/adwords_api/v201306/targeting_idea_service_registry.rb +0 -46
  148. data/lib/adwords_api/v201306/traffic_estimator_service.rb +0 -34
  149. data/lib/adwords_api/v201306/traffic_estimator_service_registry.rb +0 -46
  150. data/test/adwords_api/test_adwords_api.rb~ +0 -127
  151. data/test/templates/v201306/basic_operations_get_campaigns.def +0 -114
  152. data/test/templates/v201306/misc_use_oauth2_jwt.def +0 -131
@@ -1,136 +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 adds a Shopping campaign.
22
- #
23
- # Tags: CampaignService.mutate, AdGroupService.mutate, AdGroupAdService.mutate
24
-
25
- require 'adwords_api'
26
- require 'date'
27
-
28
- def add_shopping_campaign(budget_id, merchant_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
- ad_group_srv = adwords.service(:AdGroupService, API_VERSION)
39
- ad_group_ad_srv = adwords.service(:AdGroupAdService, API_VERSION)
40
-
41
- # Create campaign.
42
- campaign = {
43
- :name => "Shopping campaign #%d" % (Time.new.to_f * 1000).to_i,
44
- # The advertising_channel_type is what makes this a Shopping campaign.
45
- :advertising_channel_type => 'SHOPPING',
46
- :budget => {:budget_id => budget_id},
47
- :bidding_strategy_configuration => {
48
- :bidding_strategy_type => 'MANUAL_CPC'
49
- },
50
- :settings => [
51
- {
52
- :xsi_type => 'KeywordMatchSetting',
53
- :opt_in => false
54
- },
55
- {
56
- :xsi_type => 'ShoppingSetting',
57
- :sales_country => 'US',
58
- :campaign_priority => 0,
59
- :merchant_id => merchant_id
60
- }
61
- ]
62
- }
63
- campaign_operation = {:operator => 'ADD', :operand => campaign}
64
-
65
- # Make the mutate request.
66
- result = campaign_srv.mutate([campaign_operation])
67
-
68
- # Print the result.
69
- campaign = result[:value].first
70
- puts "Campaign with name '%s' and ID %d was added." %
71
- [campaign[:name], campaign[:id]]
72
-
73
- # Create ad group.
74
- ad_group = {
75
- :campaign_id => campaign[:id],
76
- :name => 'Ad Group #%d' % (Time.new.to_f * 1000).to_i
77
- }
78
- ad_group_operation = {:operator => 'ADD', :operand => ad_group}
79
-
80
- # Make the mutate request.
81
- result = ad_group_srv.mutate([ad_group_operation])
82
-
83
- # Print the result.
84
- ad_group = result[:value].first
85
- puts "Ad group with name '%s' and ID %d was added." %
86
- [ad_group[:name], ad_group[:id]]
87
-
88
- # Create product ad.
89
- ad_group_ad = {
90
- :ad_group_id => ad_group[:id],
91
- :ad => {:xsi_type => 'ProductAd'}
92
- }
93
- ad_group_operation = {:operator => 'ADD', :operand => ad_group_ad}
94
-
95
- # Make the mutate request.
96
- result = ad_group_ad_srv.mutate([ad_group_operation])
97
-
98
- # Print the result.
99
- ad_group_ad = result[:value].first
100
- puts "Product ad with ID %d was added." %
101
- [ad_group_ad[:id]]
102
- end
103
-
104
- if __FILE__ == $0
105
- API_VERSION = :v201402
106
-
107
- begin
108
- budget_id = 'INSERT_BUDGET_ID_HERE'.to_i
109
- merchant_id = 'INSERT_MERCHANT_ID_HERE'.to_i
110
-
111
- add_shopping_campaign(budget_id, merchant_id)
112
-
113
- # Authorization error.
114
- rescue AdsCommon::Errors::OAuth2VerificationRequired => e
115
- puts "Authorization credentials are not valid. Edit adwords_api.yml for " +
116
- "OAuth2 client ID and secret and run misc/setup_oauth2.rb example " +
117
- "to retrieve and store OAuth2 tokens."
118
- puts "See this wiki page for more details:\n\n " +
119
- 'http://code.google.com/p/google-api-ads-ruby/wiki/OAuth2'
120
-
121
- # HTTP errors.
122
- rescue AdsCommon::Errors::HttpError => e
123
- puts "HTTP Error: %s" % e
124
-
125
- # API errors.
126
- rescue AdwordsApi::Errors::ApiException => e
127
- puts "Message: %s" % e.message
128
- puts 'Errors:'
129
- e.errors.each_with_index do |error, index|
130
- puts "\tError [%d]:" % (index + 1)
131
- error.each do |field, value|
132
- puts "\t\t%s: %s" % [field, value]
133
- end
134
- end
135
- end
136
- end
@@ -1,128 +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 fetches the set of valid ProductBiddingCategories.
22
- #
23
- # Tags: ConstantDataService.getProductBiddingCategoryData
24
-
25
- require 'adwords_api'
26
-
27
- def display_categories(categories, prefix='')
28
- categories.each do |category|
29
- puts "%s%s [%s]" % [prefix, category[:name], category[:id]]
30
- if category[:children]
31
- display_categories(category[:children],
32
- "%s%s > " % [prefix, category[:name]])
33
- end
34
- end
35
- end
36
-
37
- def get_product_category_taxonomy()
38
- # AdwordsApi::Api will read a config file from ENV['HOME']/adwords_api.yml
39
- # when called without parameters.
40
- adwords = AdwordsApi::Api.new
41
-
42
- # To enable logging of SOAP requests, set the log_level value to 'DEBUG' in
43
- # the configuration file or provide your own logger:
44
- # adwords.logger = Logger.new('adwords_xml.log')
45
-
46
- constant_data_srv = adwords.service(:ConstantDataService, API_VERSION)
47
-
48
- selector = {
49
- :predicates => {
50
- :field => 'Country',
51
- :operator => 'IN',
52
- :values => ['US']
53
- }
54
- }
55
-
56
- results = constant_data_srv.get_product_bidding_category_data(selector)
57
-
58
- bidding_categories = {}
59
- root_categories = []
60
-
61
- result[:value].each do |product_bidding_category|
62
- id = product_bidding_category[:dimension_value][:value]
63
- parent_id = nil
64
- name = product_bidding_category[:display_value].first()[:value]
65
-
66
- if product_bidding_category[:parent_dimension_value]
67
- parent_id = product_bidding_category[:parent_dimension_value][:value]
68
- end
69
-
70
- unless bidding_categories[id]
71
- bidding_categories[id] = {}
72
- end
73
-
74
- category = bidding_categories[id]
75
-
76
- if parent_id
77
- unless bidding_categories[parent_id]
78
- bidding_categories[parent_id] = {}
79
- end
80
-
81
- parent = bidding_categories[parent_id]
82
-
83
- unless parent[:children]
84
- parent[:children] = []
85
- end
86
-
87
- parent[:children] << category
88
- else
89
- root_categories << category
90
- end
91
-
92
- category[:id] = id
93
- category[:name] = name
94
- end
95
-
96
- display_categories(root_categories)
97
- end
98
-
99
- if __FILE__ == $0
100
- API_VERSION = :v201402
101
-
102
- begin
103
- get_product_category_taxonomy()
104
-
105
- # Authorization error.
106
- rescue AdsCommon::Errors::OAuth2VerificationRequired => e
107
- puts "Authorization credentials are not valid. Edit adwords_api.yml for " +
108
- "OAuth2 client ID and secret and run misc/setup_oauth2.rb example " +
109
- "to retrieve and store OAuth2 tokens."
110
- puts "See this wiki page for more details:\n\n " +
111
- 'http://code.google.com/p/google-api-ads-ruby/wiki/OAuth2'
112
-
113
- # HTTP errors.
114
- rescue AdsCommon::Errors::HttpError => e
115
- puts "HTTP Error: %s" % e
116
-
117
- # API errors.
118
- rescue AdwordsApi::Errors::ApiException => e
119
- puts "Message: %s" % e.message
120
- puts 'Errors:'
121
- e.errors.each_with_index do |error, index|
122
- puts "\tError [%d]:" % (index + 1)
123
- error.each do |field, value|
124
- puts "\t\t%s: %s" % [field, value]
125
- end
126
- end
127
- end
128
- end
@@ -1,98 +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 sets the product sales channel.
22
- #
23
- # Tags: CampaignCriterionService.mutate
24
-
25
- require 'adwords_api'
26
-
27
- def set_product_sales_channel(campaign_id)
28
- # AdwordsApi::Api will read a config file from ENV['HOME']/adwords_api.yml
29
- # when called without parameters.
30
- adwords = AdwordsApi::Api.new
31
-
32
- # To enable logging of SOAP requests, set the log_level value to 'DEBUG' in
33
- # the configuration file or provide your own logger:
34
- # adwords.logger = Logger.new('adwords_xml.log')
35
-
36
- campaign_criterion_srv =
37
- adwords.service(:CampaignCriterionService, API_VERSION)
38
-
39
- # ProductSalesChannel is a fixedId criterion, wiht the possible values
40
- # defined here.
41
- ONLINE = 200
42
- LOCAL = 201
43
-
44
- product_sales_channel = {
45
- :xsi_type => 'PRODUCT_SALES_CHANNEL',
46
- :id => ONLINE
47
- }
48
-
49
- campaign_criterion = {
50
- :campaign_id => campaign_id,
51
- :criterion => product_sales_channel
52
- }
53
-
54
- campaign_criterion_operation = {
55
- :operator => 'ADD',
56
- :operand => campaign_criterion
57
- }
58
-
59
- # Make the mutate request.
60
- result = campaign_criterion_srv.mutate([campaign_criterion_operation])
61
-
62
- campaign_criterion = result[:value].first()[:criterion]
63
- puts "Added ProductSalesChannel CampaignCriterion with ID %d" %
64
- [campaign_criterion[:id]]
65
- end
66
-
67
- if __FILE__ == $0
68
- API_VERSION = :v201402
69
-
70
- begin
71
- campaign_id = 'INSERT_CAMPAIGN_ID_HERE'.to_i
72
-
73
- set_product_sales_channel(campaign_id)
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
- 'http://code.google.com/p/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,38 +0,0 @@
1
- # Encoding: utf-8
2
- #
3
- # This is auto-generated code, changes will be overwritten.
4
- #
5
- # Copyright:: Copyright 2012, Google Inc. All Rights Reserved.
6
- # License:: Licensed under the Apache License, Version 2.0.
7
- #
8
- # Code generated by AdsCommon library 0.9.2 on 2013-07-10 22:02:49.
9
-
10
- require 'ads_common/savon_service'
11
- require 'adwords_api/v201306/ad_extension_override_service_registry'
12
-
13
- module AdwordsApi; module V201306; module AdExtensionOverrideService
14
- class AdExtensionOverrideService < AdsCommon::SavonService
15
- def initialize(config, endpoint)
16
- namespace = 'https://adwords.google.com/api/adwords/cm/v201306'
17
- super(config, endpoint, namespace, :v201306)
18
- end
19
-
20
- def get(*args, &block)
21
- return execute_action('get', args, &block)
22
- end
23
-
24
- def mutate(*args, &block)
25
- return execute_action('mutate', args, &block)
26
- end
27
-
28
- private
29
-
30
- def get_service_registry()
31
- return AdExtensionOverrideServiceRegistry
32
- end
33
-
34
- def get_module()
35
- return AdwordsApi::V201306::AdExtensionOverrideService
36
- end
37
- end
38
- end; end; end
@@ -1,46 +0,0 @@
1
- # Encoding: utf-8
2
- #
3
- # This is auto-generated code, changes will be overwritten.
4
- #
5
- # Copyright:: Copyright 2012, Google Inc. All Rights Reserved.
6
- # License:: Licensed under the Apache License, Version 2.0.
7
- #
8
- # Code generated by AdsCommon library 0.9.2 on 2013-07-10 22:02:50.
9
-
10
- require 'adwords_api/errors'
11
-
12
- module AdwordsApi; module V201306; module AdExtensionOverrideService
13
- class AdExtensionOverrideServiceRegistry
14
- ADEXTENSIONOVERRIDESERVICE_METHODS = {:get=>{:input=>[{:name=>:selector, :type=>"AdExtensionOverrideSelector", :min_occurs=>0, :max_occurs=>1}], :output=>{:name=>"get_response", :fields=>[{:name=>:rval, :type=>"AdExtensionOverridePage", :min_occurs=>0, :max_occurs=>1}]}}, :mutate=>{:input=>[{:name=>:operations, :type=>"AdExtensionOverrideOperation", :min_occurs=>0, :max_occurs=>:unbounded}], :output=>{:name=>"mutate_response", :fields=>[{:name=>:rval, :type=>"AdExtensionOverrideReturnValue", :min_occurs=>0, :max_occurs=>1}]}}}
15
- ADEXTENSIONOVERRIDESERVICE_TYPES = {:AdExtensionOverrideError=>{:fields=>[{:name=>:reason, :type=>"AdExtensionOverrideError.Reason", :min_occurs=>0, :max_occurs=>1}], :base=>"ApiError"}, :AdExtensionOverrideStats=>{:fields=>[], :base=>"Stats"}, :Address=>{:fields=>[{:name=>:street_address, :type=>"string", :min_occurs=>0, :max_occurs=>1}, {:name=>:street_address2, :type=>"string", :min_occurs=>0, :max_occurs=>1}, {:name=>:city_name, :type=>"string", :min_occurs=>0, :max_occurs=>1}, {:name=>:province_code, :type=>"string", :min_occurs=>0, :max_occurs=>1}, {:name=>:province_name, :type=>"string", :min_occurs=>0, :max_occurs=>1}, {:name=>:postal_code, :type=>"string", :min_occurs=>0, :max_occurs=>1}, {:name=>:country_code, :type=>"string", :min_occurs=>0, :max_occurs=>1}]}, :AdxError=>{:fields=>[{:name=>:reason, :type=>"AdxError.Reason", :min_occurs=>0, :max_occurs=>1}], :base=>"ApiError"}, :AuthenticationError=>{:fields=>[{:name=>:reason, :type=>"AuthenticationError.Reason", :min_occurs=>0, :max_occurs=>1}], :base=>"ApiError"}, :AuthorizationError=>{:fields=>[{:name=>:reason, :type=>"AuthorizationError.Reason", :min_occurs=>0, :max_occurs=>1}], :base=>"ApiError"}, :ClientTermsError=>{:fields=>[{:name=>:reason, :type=>"ClientTermsError.Reason", :min_occurs=>0, :max_occurs=>1}], :base=>"ApiError"}, :DistinctError=>{:fields=>[{:name=>:reason, :type=>"DistinctError.Reason", :min_occurs=>0, :max_occurs=>1}], :base=>"ApiError"}, :DomainInfoExtension=>{:fields=>[{:name=>:domain_name, :type=>"string", :min_occurs=>0, :max_occurs=>1}, {:name=>:language_code, :type=>"string", :min_occurs=>0, :max_occurs=>1}], :base=>"AdExtension"}, :DoubleValue=>{:fields=>[{:name=>:number, :type=>"double", :min_occurs=>0, :max_occurs=>1}], :base=>"NumberValue"}, :EntityNotFound=>{:fields=>[{:name=>:reason, :type=>"EntityNotFound.Reason", :min_occurs=>0, :max_occurs=>1}], :base=>"ApiError"}, :GeoPoint=>{:fields=>[{:name=>:latitude_in_micro_degrees, :type=>"int", :min_occurs=>0, :max_occurs=>1}, {:name=>:longitude_in_micro_degrees, :type=>"int", :min_occurs=>0, :max_occurs=>1}]}, :IdError=>{:fields=>[{:name=>:reason, :type=>"IdError.Reason", :min_occurs=>0, :max_occurs=>1}], :base=>"ApiError"}, :InAppLinkExtension=>{:fields=>[{:name=>:in_app_link_text, :type=>"string", :min_occurs=>0, :max_occurs=>1}, {:name=>:in_app_link_url, :type=>"string", :min_occurs=>0, :max_occurs=>1}, {:name=>:app_store, :type=>"InAppLinkExtension.AppStore", :min_occurs=>0, :max_occurs=>1}, {:name=>:app_id, :type=>"string", :min_occurs=>0, :max_occurs=>1}], :base=>"AdExtension"}, :InternalApiError=>{:fields=>[{:name=>:reason, :type=>"InternalApiError.Reason", :min_occurs=>0, :max_occurs=>1}], :base=>"ApiError"}, :LocationOverrideInfo=>{:fields=>[{:name=>:radius, :type=>"int", :min_occurs=>0, :max_occurs=>1}, {:name=>:radius_units, :type=>"LocationOverrideInfo.RadiusUnits", :min_occurs=>0, :max_occurs=>1}]}, :LongValue=>{:fields=>[{:name=>:number, :type=>"long", :min_occurs=>0, :max_occurs=>1}], :base=>"NumberValue"}, :MobileExtension=>{:fields=>[{:name=>:phone_number, :type=>"string", :min_occurs=>0, :max_occurs=>1}, {:name=>:country_code, :type=>"string", :min_occurs=>0, :max_occurs=>1}, {:name=>:is_call_tracking_enabled, :type=>"boolean", :min_occurs=>0, :max_occurs=>1}, {:name=>:is_call_only, :type=>"boolean", :min_occurs=>0, :max_occurs=>1}], :base=>"AdExtension"}, :NotEmptyError=>{:fields=>[{:name=>:reason, :type=>"NotEmptyError.Reason", :min_occurs=>0, :max_occurs=>1}], :base=>"ApiError"}, :NotWhitelistedError=>{:fields=>[{:name=>:reason, :type=>"NotWhitelistedError.Reason", :min_occurs=>0, :max_occurs=>1}], :base=>"ApiError"}, :NullError=>{:fields=>[{:name=>:reason, :type=>"NullError.Reason", :min_occurs=>0, :max_occurs=>1}], :base=>"ApiError"}, :NumberValue=>{:fields=>[], :abstract=>true, :base=>"ComparableValue"}, :OAuthInfo=>{:fields=>[{:name=>:http_method, :type=>"string", :min_occurs=>0, :max_occurs=>1}, {:name=>:http_request_url, :type=>"string", :min_occurs=>0, :max_occurs=>1}, {:name=>:http_authorization_header, :type=>"string", :min_occurs=>0, :max_occurs=>1}]}, :OperatorError=>{:fields=>[{:name=>:reason, :type=>"OperatorError.Reason", :min_occurs=>0, :max_occurs=>1}], :base=>"ApiError"}, :OverrideInfo=>{:fields=>[], :choices=>[{:name=>:location_override_info, :original_name=>"LocationOverrideInfo", :type=>"LocationOverrideInfo", :min_occurs=>1, :max_occurs=>1}]}, :Paging=>{:fields=>[{:name=>:start_index, :type=>"int", :min_occurs=>0, :max_occurs=>1}, {:name=>:number_results, :type=>"int", :min_occurs=>0, :max_occurs=>1}]}, :QuotaCheckError=>{:fields=>[{:name=>:reason, :type=>"QuotaCheckError.Reason", :min_occurs=>0, :max_occurs=>1}], :base=>"ApiError"}, :RangeError=>{:fields=>[{:name=>:reason, :type=>"RangeError.Reason", :min_occurs=>0, :max_occurs=>1}], :base=>"ApiError"}, :RateExceededError=>{:fields=>[{:name=>:reason, :type=>"RateExceededError.Reason", :min_occurs=>0, :max_occurs=>1}, {:name=>:rate_name, :type=>"string", :min_occurs=>0, :max_occurs=>1}, {:name=>:rate_scope, :type=>"string", :min_occurs=>0, :max_occurs=>1}, {:name=>:retry_after_seconds, :type=>"int", :min_occurs=>0, :max_occurs=>1}], :base=>"ApiError"}, :ReadOnlyError=>{:fields=>[{:name=>:reason, :type=>"ReadOnlyError.Reason", :min_occurs=>0, :max_occurs=>1}], :base=>"ApiError"}, :RequestError=>{:fields=>[{:name=>:reason, :type=>"RequestError.Reason", :min_occurs=>0, :max_occurs=>1}], :base=>"ApiError"}, :RequiredError=>{:fields=>[{:name=>:reason, :type=>"RequiredError.Reason", :min_occurs=>0, :max_occurs=>1}], :base=>"ApiError"}, :Sitelink=>{:fields=>[{:name=>:display_text, :type=>"string", :min_occurs=>0, :max_occurs=>1}, {:name=>:destination_url, :type=>"string", :min_occurs=>0, :max_occurs=>1}]}, :SitelinksExtension=>{:fields=>[{:name=>:sitelinks, :type=>"Sitelink", :min_occurs=>0, :max_occurs=>:unbounded}], :base=>"AdExtension"}, :SizeLimitError=>{:fields=>[{:name=>:reason, :type=>"SizeLimitError.Reason", :min_occurs=>0, :max_occurs=>1}], :base=>"ApiError"}, :SoapHeader=>{:fields=>[{:name=>:auth_token, :type=>"string", :min_occurs=>0, :max_occurs=>1}, {:name=>:client_customer_id, :type=>"string", :min_occurs=>0, :max_occurs=>1}, {:name=>:developer_token, :type=>"string", :min_occurs=>0, :max_occurs=>1}, {:name=>:user_agent, :type=>"string", :min_occurs=>0, :max_occurs=>1}, {:name=>:validate_only, :type=>"boolean", :min_occurs=>0, :max_occurs=>1}, {:name=>:partial_failure, :type=>"boolean", :min_occurs=>0, :max_occurs=>1}]}, :SoapResponseHeader=>{:fields=>[{:name=>:request_id, :type=>"string", :min_occurs=>0, :max_occurs=>1}, {:name=>:service_name, :type=>"string", :min_occurs=>0, :max_occurs=>1}, {:name=>:method_name, :type=>"string", :min_occurs=>0, :max_occurs=>1}, {:name=>:operations, :type=>"long", :min_occurs=>0, :max_occurs=>1}, {:name=>:response_time, :type=>"long", :min_occurs=>0, :max_occurs=>1}]}, :StringLengthError=>{:fields=>[{:name=>:reason, :type=>"StringLengthError.Reason", :min_occurs=>0, :max_occurs=>1}], :base=>"ApiError"}, :AdExtensionOverrideSelector=>{:fields=>[{:name=>:campaign_ids, :type=>"long", :min_occurs=>0, :max_occurs=>:unbounded}, {:name=>:ad_ids, :type=>"long", :min_occurs=>0, :max_occurs=>:unbounded}, {:name=>:ad_extension_ids, :type=>"long", :min_occurs=>0, :max_occurs=>:unbounded}, {:name=>:statuses, :type=>"AdExtensionOverride.Status", :min_occurs=>0, :max_occurs=>:unbounded}, {:name=>:paging, :type=>"Paging", :min_occurs=>0, :max_occurs=>1}]}, :DatabaseError=>{:fields=>[{:name=>:reason, :type=>"DatabaseError.Reason", :min_occurs=>0, :max_occurs=>1}], :base=>"ApiError"}, :LocationExtension=>{:fields=>[{:name=>:address, :type=>"Address", :min_occurs=>0, :max_occurs=>1}, {:name=>:geo_point, :type=>"GeoPoint", :min_occurs=>0, :max_occurs=>1}, {:name=>:encoded_location, :type=>"base64Binary", :min_occurs=>0, :max_occurs=>1}, {:name=>:company_name, :type=>"string", :min_occurs=>0, :max_occurs=>1}, {:name=>:phone_number, :type=>"string", :min_occurs=>0, :max_occurs=>1}, {:name=>:source, :type=>"LocationExtension.Source", :min_occurs=>0, :max_occurs=>1}, {:name=>:icon_media_id, :type=>"long", :min_occurs=>0, :max_occurs=>1}, {:name=>:image_media_id, :type=>"long", :min_occurs=>0, :max_occurs=>1}], :base=>"AdExtension"}, :Money=>{:fields=>[{:name=>:micro_amount, :type=>"long", :min_occurs=>0, :max_occurs=>1}], :base=>"ComparableValue"}, :ApiError=>{:fields=>[{:name=>:field_path, :type=>"string", :min_occurs=>0, :max_occurs=>1}, {:name=>:trigger, :type=>"string", :min_occurs=>0, :max_occurs=>1}, {:name=>:error_string, :type=>"string", :min_occurs=>0, :max_occurs=>1}, {:name=>:api_error_type, :original_name=>"ApiError.Type", :type=>"string", :min_occurs=>0, :max_occurs=>1}], :abstract=>true}, :ApiException=>{:fields=>[{:name=>:errors, :type=>"ApiError", :min_occurs=>0, :max_occurs=>:unbounded}], :base=>"ApplicationException"}, :ApplicationException=>{:fields=>[{:name=>:message, :type=>"string", :min_occurs=>0, :max_occurs=>1}, {:name=>:application_exception_type, :original_name=>"ApplicationException.Type", :type=>"string", :min_occurs=>0, :max_occurs=>1}]}, :ComparableValue=>{:fields=>[{:name=>:comparable_value_type, :original_name=>"ComparableValue.Type", :type=>"string", :min_occurs=>0, :max_occurs=>1}], :abstract=>true}, :LocationSyncExtension=>{:fields=>[{:name=>:email, :type=>"string", :min_occurs=>0, :max_occurs=>1}, {:name=>:auth_token, :type=>"string", :min_occurs=>0, :max_occurs=>1}, {:name=>:o_auth_info, :type=>"OAuthInfo", :min_occurs=>0, :max_occurs=>1}, {:name=>:icon_media_id, :type=>"long", :min_occurs=>0, :max_occurs=>1}, {:name=>:should_sync_url, :type=>"boolean", :min_occurs=>0, :max_occurs=>1}], :base=>"AdExtension"}, :Stats=>{:fields=>[{:name=>:start_date, :type=>"string", :min_occurs=>0, :max_occurs=>1}, {:name=>:end_date, :type=>"string", :min_occurs=>0, :max_occurs=>1}, {:name=>:network, :type=>"Stats.Network", :min_occurs=>0, :max_occurs=>1}, {:name=>:clicks, :type=>"long", :min_occurs=>0, :max_occurs=>1}, {:name=>:impressions, :type=>"long", :min_occurs=>0, :max_occurs=>1}, {:name=>:cost, :type=>"Money", :min_occurs=>0, :max_occurs=>1}, {:name=>:average_position, :type=>"double", :min_occurs=>0, :max_occurs=>1}, {:name=>:average_cpc, :type=>"Money", :min_occurs=>0, :max_occurs=>1}, {:name=>:average_cpm, :type=>"Money", :min_occurs=>0, :max_occurs=>1}, {:name=>:ctr, :type=>"double", :min_occurs=>0, :max_occurs=>1}, {:name=>:conversions, :type=>"long", :min_occurs=>0, :max_occurs=>1}, {:name=>:view_through_conversions, :type=>"long", :min_occurs=>0, :max_occurs=>1}, {:name=>:total_budget, :type=>"Money", :min_occurs=>0, :max_occurs=>1}, {:name=>:stats_type, :original_name=>"Stats.Type", :type=>"string", :min_occurs=>0, :max_occurs=>1}]}, :AdExtension=>{:fields=>[{:name=>:id, :type=>"long", :min_occurs=>0, :max_occurs=>1}, {:name=>:ad_extension_type, :original_name=>"AdExtension.Type", :type=>"string", :min_occurs=>0, :max_occurs=>1}]}, :AdExtensionOverride=>{:fields=>[{:name=>:ad_id, :type=>"long", :min_occurs=>0, :max_occurs=>1}, {:name=>:ad_extension, :type=>"AdExtension", :min_occurs=>0, :max_occurs=>1}, {:name=>:override_info, :type=>"OverrideInfo", :min_occurs=>0, :max_occurs=>1}, {:name=>:status, :type=>"AdExtensionOverride.Status", :min_occurs=>0, :max_occurs=>1}, {:name=>:approval_status, :type=>"AdExtensionOverride.ApprovalStatus", :min_occurs=>0, :max_occurs=>1}, {:name=>:stats, :type=>"AdExtensionOverrideStats", :min_occurs=>0, :max_occurs=>1}]}, :AdExtensionOverrideOperation=>{:fields=>[{:name=>:operand, :type=>"AdExtensionOverride", :min_occurs=>0, :max_occurs=>1}], :base=>"Operation"}, :AdExtensionOverridePage=>{:fields=>[{:name=>:entries, :type=>"AdExtensionOverride", :min_occurs=>0, :max_occurs=>:unbounded}], :base=>"Page"}, :AdExtensionOverrideReturnValue=>{:fields=>[{:name=>:value, :type=>"AdExtensionOverride", :min_occurs=>0, :max_occurs=>:unbounded}, {:name=>:partial_failure_errors, :type=>"ApiError", :min_occurs=>0, :max_occurs=>:unbounded}], :base=>"ListReturnValue"}, :ListReturnValue=>{:fields=>[{:name=>:list_return_value_type, :original_name=>"ListReturnValue.Type", :type=>"string", :min_occurs=>0, :max_occurs=>1}], :abstract=>true}, :Operation=>{:fields=>[{:name=>:operator, :type=>"Operator", :min_occurs=>0, :max_occurs=>1}, {:name=>:operation_type, :original_name=>"Operation.Type", :type=>"string", :min_occurs=>0, :max_occurs=>1}], :abstract=>true}, :Page=>{:fields=>[{:name=>:total_num_entries, :type=>"int", :min_occurs=>0, :max_occurs=>1}, {:name=>:page_type, :original_name=>"Page.Type", :type=>"string", :min_occurs=>0, :max_occurs=>1}], :abstract=>true}, :"AdExtensionOverride.ApprovalStatus"=>{:fields=>[]}, :"AdExtensionOverride.Status"=>{:fields=>[]}, :"AdExtensionOverrideError.Reason"=>{:fields=>[]}, :"AdxError.Reason"=>{:fields=>[]}, :"AuthenticationError.Reason"=>{:fields=>[]}, :"AuthorizationError.Reason"=>{:fields=>[]}, :"ClientTermsError.Reason"=>{:fields=>[]}, :"DatabaseError.Reason"=>{:fields=>[]}, :"DistinctError.Reason"=>{:fields=>[]}, :"EntityNotFound.Reason"=>{:fields=>[]}, :"IdError.Reason"=>{:fields=>[]}, :"InAppLinkExtension.AppStore"=>{:fields=>[]}, :"InternalApiError.Reason"=>{:fields=>[]}, :"LocationExtension.Source"=>{:fields=>[]}, :"LocationOverrideInfo.RadiusUnits"=>{:fields=>[]}, :"NotEmptyError.Reason"=>{:fields=>[]}, :"NotWhitelistedError.Reason"=>{:fields=>[]}, :"NullError.Reason"=>{:fields=>[]}, :Operator=>{:fields=>[]}, :"OperatorError.Reason"=>{:fields=>[]}, :"QuotaCheckError.Reason"=>{:fields=>[]}, :"RangeError.Reason"=>{:fields=>[]}, :"RateExceededError.Reason"=>{:fields=>[]}, :"ReadOnlyError.Reason"=>{:fields=>[]}, :"RequestError.Reason"=>{:fields=>[]}, :"RequiredError.Reason"=>{:fields=>[]}, :"SizeLimitError.Reason"=>{:fields=>[]}, :"Stats.Network"=>{:fields=>[]}, :"StringLengthError.Reason"=>{:fields=>[]}}
16
- ADEXTENSIONOVERRIDESERVICE_NAMESPACES = []
17
-
18
- def self.get_method_signature(method_name)
19
- return ADEXTENSIONOVERRIDESERVICE_METHODS[method_name.to_sym]
20
- end
21
-
22
- def self.get_type_signature(type_name)
23
- return ADEXTENSIONOVERRIDESERVICE_TYPES[type_name.to_sym]
24
- end
25
-
26
- def self.get_namespace(index)
27
- return ADEXTENSIONOVERRIDESERVICE_NAMESPACES[index]
28
- end
29
- end
30
-
31
- # Base class for exceptions.
32
- class ApplicationException < AdwordsApi::Errors::ApiException
33
- attr_reader :message # string
34
- attr_reader :application_exception_type # string
35
- end
36
-
37
- # Exception class for holding a list of service errors.
38
- class ApiException < ApplicationException
39
- attr_reader :errors # ApiError
40
- def initialize(exception_fault)
41
- @array_fields ||= []
42
- @array_fields << 'errors'
43
- super(exception_fault, AdExtensionOverrideServiceRegistry)
44
- end
45
- end
46
- end; end; end