google-dfp-api 0.2.5 → 0.2.6
Sign up to get free protection for your applications and to get access to all the features.
- data/ChangeLog +5 -0
- data/README +8 -7
- data/Rakefile +2 -2
- data/examples/v201111/common/error_handling.rb +76 -0
- data/examples/v201111/common/oauth_handling.rb +128 -0
- data/examples/v201111/company_service/create_companies.rb +81 -0
- data/examples/v201111/company_service/get_all_companies.rb +92 -0
- data/examples/v201111/company_service/get_companies_by_statement.rb +88 -0
- data/examples/v201111/company_service/get_company.rb +72 -0
- data/examples/v201111/company_service/update_companies.rb +95 -0
- data/examples/v201111/content_service/get_all_content.rb +94 -0
- data/examples/v201111/content_service/get_content_by_category.rb +136 -0
- data/examples/v201111/creative_service/copy_image_creatives.rb +115 -0
- data/examples/v201111/creative_service/create_creative_from_template.rb +139 -0
- data/examples/v201111/creative_service/create_creatives.rb +106 -0
- data/examples/v201111/creative_service/create_custom_creative.rb +104 -0
- data/examples/v201111/creative_service/get_all_creatives.rb +93 -0
- data/examples/v201111/creative_service/get_creative.rb +72 -0
- data/examples/v201111/creative_service/get_creatives_by_statement.rb +87 -0
- data/examples/v201111/creative_service/update_creatives.rb +96 -0
- data/examples/v201111/creative_template_service/get_all_creative_templates.rb +94 -0
- data/examples/v201111/creative_template_service/get_creative_template.rb +74 -0
- data/examples/v201111/creative_template_service/get_creative_templates_by_statement.rb +80 -0
- data/examples/v201111/custom_targeting_service/create_custom_targeting_keys_and_values.rb +140 -0
- data/examples/v201111/custom_targeting_service/delete_custom_targeting_keys.rb +121 -0
- data/examples/v201111/custom_targeting_service/delete_custom_targeting_values.rb +125 -0
- data/examples/v201111/custom_targeting_service/get_all_custom_targeting_keys_and_values.rb +148 -0
- data/examples/v201111/custom_targeting_service/get_custom_targeting_keys_by_statement.rb +92 -0
- data/examples/v201111/custom_targeting_service/get_custom_targeting_values_by_statement.rb +98 -0
- data/examples/v201111/custom_targeting_service/update_custom_targeting_keys.rb +94 -0
- data/examples/v201111/custom_targeting_service/update_custom_targeting_values.rb +106 -0
- data/examples/v201111/forecast_service/get_forecast.rb +107 -0
- data/examples/v201111/forecast_service/get_forecast_by_id.rb +80 -0
- data/examples/v201111/inventory_service/create_ad_units.rb +101 -0
- data/examples/v201111/inventory_service/create_mobile_ad_unit.rb +100 -0
- data/examples/v201111/inventory_service/create_video_ad_unit.rb +108 -0
- data/examples/v201111/inventory_service/deactivate_ad_units.rb +119 -0
- data/examples/v201111/inventory_service/get_ad_unit.rb +72 -0
- data/examples/v201111/inventory_service/get_ad_unit_sizes.rb +73 -0
- data/examples/v201111/inventory_service/get_ad_units_by_statement.rb +96 -0
- data/examples/v201111/inventory_service/get_all_ad_units.rb +93 -0
- data/examples/v201111/inventory_service/update_ad_units.rb +94 -0
- data/examples/v201111/label_service/create_labels.rb +83 -0
- data/examples/v201111/label_service/deactivate_labels.rb +118 -0
- data/examples/v201111/label_service/get_all_labels.rb +94 -0
- data/examples/v201111/label_service/get_label.rb +76 -0
- data/examples/v201111/label_service/get_labels_by_statement.rb +91 -0
- data/examples/v201111/label_service/update_labels.rb +104 -0
- data/examples/v201111/line_item_creative_association_service/create_licas.rb +94 -0
- data/examples/v201111/line_item_creative_association_service/deactivate_licas.rb +127 -0
- data/examples/v201111/line_item_creative_association_service/get_all_licas.rb +95 -0
- data/examples/v201111/line_item_creative_association_service/get_lica.rb +77 -0
- data/examples/v201111/line_item_creative_association_service/get_licas_by_statement.rb +91 -0
- data/examples/v201111/line_item_creative_association_service/update_licas.rb +92 -0
- data/examples/v201111/line_item_service/activate_line_items.rb +131 -0
- data/examples/v201111/line_item_service/create_line_items.rb +177 -0
- data/examples/v201111/line_item_service/create_mobile_line_item.rb +135 -0
- data/examples/v201111/line_item_service/create_video_line_item.rb +156 -0
- data/examples/v201111/line_item_service/get_all_line_items.rb +94 -0
- data/examples/v201111/line_item_service/get_line_item.rb +74 -0
- data/examples/v201111/line_item_service/get_line_items_by_statement.rb +89 -0
- data/examples/v201111/line_item_service/target_custom_criteria.rb +129 -0
- data/examples/v201111/line_item_service/update_line_items.rb +109 -0
- data/examples/v201111/network_service/get_all_networks.rb +74 -0
- data/examples/v201111/network_service/get_current_network.rb +66 -0
- data/examples/v201111/order_service/approve_orders.rb +116 -0
- data/examples/v201111/order_service/create_orders.rb +92 -0
- data/examples/v201111/order_service/get_all_orders.rb +93 -0
- data/examples/v201111/order_service/get_order.rb +74 -0
- data/examples/v201111/order_service/get_orders_by_statement.rb +90 -0
- data/examples/v201111/order_service/update_orders.rb +95 -0
- data/examples/v201111/placement_service/create_placements.rb +129 -0
- data/examples/v201111/placement_service/deactivate_placements.rb +118 -0
- data/examples/v201111/placement_service/get_all_placements.rb +93 -0
- data/examples/v201111/placement_service/get_placement.rb +74 -0
- data/examples/v201111/placement_service/get_placements_by_statement.rb +86 -0
- data/examples/v201111/placement_service/update_placements.rb +97 -0
- data/examples/v201111/publisher_query_language_service/get_all_bandwidth_groups.rb +85 -0
- data/examples/v201111/publisher_query_language_service/get_all_browser_languages.rb +85 -0
- data/examples/v201111/publisher_query_language_service/get_all_browsers.rb +85 -0
- data/examples/v201111/publisher_query_language_service/get_all_cities.rb +85 -0
- data/examples/v201111/publisher_query_language_service/get_all_countries.rb +85 -0
- data/examples/v201111/publisher_query_language_service/get_all_device_manufacturers.rb +85 -0
- data/examples/v201111/publisher_query_language_service/get_all_metros.rb +85 -0
- data/examples/v201111/publisher_query_language_service/get_all_mobile_carriers.rb +85 -0
- data/examples/v201111/publisher_query_language_service/get_all_mobile_device_submodels.rb +85 -0
- data/examples/v201111/publisher_query_language_service/get_all_mobile_devices.rb +85 -0
- data/examples/v201111/publisher_query_language_service/get_all_operating_system_versions.rb +85 -0
- data/examples/v201111/publisher_query_language_service/get_all_operating_systems.rb +85 -0
- data/examples/v201111/publisher_query_language_service/get_all_postal_codes.rb +85 -0
- data/examples/v201111/publisher_query_language_service/get_all_regions.rb +85 -0
- data/examples/v201111/report_service/download_report.rb +81 -0
- data/examples/v201111/report_service/run_delivery_report.rb +91 -0
- data/examples/v201111/report_service/run_inventory_report.rb +90 -0
- data/examples/v201111/report_service/run_merged_delivery_report.rb +94 -0
- data/examples/v201111/report_service/run_sales_report.rb +89 -0
- data/examples/v201111/suggested_ad_unit_service/approve_suggested_ad_units.rb +116 -0
- data/examples/v201111/suggested_ad_unit_service/get_all_suggested_ad_units.rb +96 -0
- data/examples/v201111/suggested_ad_unit_service/get_suggested_ad_unit.rb +75 -0
- data/examples/v201111/suggested_ad_unit_service/get_suggested_ad_units_by_statement.rb +91 -0
- data/examples/v201111/user_service/create_users.rb +89 -0
- data/examples/v201111/user_service/deactivate_users.rb +99 -0
- data/examples/v201111/user_service/get_all_roles.rb +73 -0
- data/examples/v201111/user_service/get_all_users.rb +92 -0
- data/examples/v201111/user_service/get_current_user.rb +66 -0
- data/examples/v201111/user_service/get_user.rb +73 -0
- data/examples/v201111/user_service/get_users_by_statement.rb +79 -0
- data/examples/v201111/user_service/update_users.rb +89 -0
- data/lib/dfp_api.rb +1 -1
- data/lib/dfp_api/api_config.rb +15 -6
- data/lib/dfp_api/v201103/company_service.rb +5 -5
- data/lib/dfp_api/v201103/company_service_registry.rb +3 -3
- data/lib/dfp_api/v201103/creative_service.rb +9 -9
- data/lib/dfp_api/v201103/creative_service_registry.rb +3 -3
- data/lib/dfp_api/v201103/custom_targeting_service.rb +17 -17
- data/lib/dfp_api/v201103/custom_targeting_service_registry.rb +3 -3
- data/lib/dfp_api/v201103/forecast_service.rb +1 -1
- data/lib/dfp_api/v201103/forecast_service_registry.rb +3 -3
- data/lib/dfp_api/v201103/inventory_service.rb +9 -9
- data/lib/dfp_api/v201103/inventory_service_registry.rb +3 -3
- data/lib/dfp_api/v201103/line_item_creative_association_service.rb +13 -13
- data/lib/dfp_api/v201103/line_item_creative_association_service_registry.rb +3 -3
- data/lib/dfp_api/v201103/line_item_service.rb +5 -5
- data/lib/dfp_api/v201103/line_item_service_registry.rb +3 -3
- data/lib/dfp_api/v201103/network_service.rb +1 -1
- data/lib/dfp_api/v201103/network_service_registry.rb +3 -3
- data/lib/dfp_api/v201103/order_service.rb +13 -13
- data/lib/dfp_api/v201103/order_service_registry.rb +3 -3
- data/lib/dfp_api/v201103/placement_service.rb +5 -5
- data/lib/dfp_api/v201103/placement_service_registry.rb +3 -3
- data/lib/dfp_api/v201103/publisher_query_language_service.rb +1 -1
- data/lib/dfp_api/v201103/publisher_query_language_service_registry.rb +3 -3
- data/lib/dfp_api/v201103/report_service.rb +5 -5
- data/lib/dfp_api/v201103/report_service_registry.rb +3 -3
- data/lib/dfp_api/v201103/user_service.rb +13 -13
- data/lib/dfp_api/v201103/user_service_registry.rb +3 -3
- data/lib/dfp_api/v201104/company_service.rb +5 -5
- data/lib/dfp_api/v201104/company_service_registry.rb +3 -3
- data/lib/dfp_api/v201104/creative_service.rb +9 -9
- data/lib/dfp_api/v201104/creative_service_registry.rb +3 -3
- data/lib/dfp_api/v201104/custom_targeting_service.rb +17 -17
- data/lib/dfp_api/v201104/custom_targeting_service_registry.rb +3 -3
- data/lib/dfp_api/v201104/forecast_service.rb +1 -1
- data/lib/dfp_api/v201104/forecast_service_registry.rb +3 -3
- data/lib/dfp_api/v201104/inventory_service.rb +9 -9
- data/lib/dfp_api/v201104/inventory_service_registry.rb +3 -3
- data/lib/dfp_api/v201104/line_item_creative_association_service.rb +13 -13
- data/lib/dfp_api/v201104/line_item_creative_association_service_registry.rb +3 -3
- data/lib/dfp_api/v201104/line_item_service.rb +5 -5
- data/lib/dfp_api/v201104/line_item_service_registry.rb +3 -3
- data/lib/dfp_api/v201104/network_service.rb +1 -1
- data/lib/dfp_api/v201104/network_service_registry.rb +3 -3
- data/lib/dfp_api/v201104/order_service.rb +13 -13
- data/lib/dfp_api/v201104/order_service_registry.rb +3 -3
- data/lib/dfp_api/v201104/placement_service.rb +5 -5
- data/lib/dfp_api/v201104/placement_service_registry.rb +3 -3
- data/lib/dfp_api/v201104/publisher_query_language_service.rb +1 -1
- data/lib/dfp_api/v201104/publisher_query_language_service_registry.rb +3 -3
- data/lib/dfp_api/v201104/report_service.rb +5 -5
- data/lib/dfp_api/v201104/report_service_registry.rb +3 -3
- data/lib/dfp_api/v201104/user_service.rb +13 -13
- data/lib/dfp_api/v201104/user_service_registry.rb +3 -3
- data/lib/dfp_api/v201107/company_service.rb +5 -5
- data/lib/dfp_api/v201107/company_service_registry.rb +3 -3
- data/lib/dfp_api/v201107/creative_service.rb +9 -9
- data/lib/dfp_api/v201107/creative_service_registry.rb +3 -3
- data/lib/dfp_api/v201107/custom_targeting_service.rb +17 -17
- data/lib/dfp_api/v201107/custom_targeting_service_registry.rb +3 -3
- data/lib/dfp_api/v201107/forecast_service.rb +1 -1
- data/lib/dfp_api/v201107/forecast_service_registry.rb +3 -3
- data/lib/dfp_api/v201107/inventory_service.rb +9 -9
- data/lib/dfp_api/v201107/inventory_service_registry.rb +3 -3
- data/lib/dfp_api/v201107/label_service.rb +5 -5
- data/lib/dfp_api/v201107/label_service_registry.rb +3 -3
- data/lib/dfp_api/v201107/line_item_creative_association_service.rb +13 -13
- data/lib/dfp_api/v201107/line_item_creative_association_service_registry.rb +3 -3
- data/lib/dfp_api/v201107/line_item_service.rb +5 -5
- data/lib/dfp_api/v201107/line_item_service_registry.rb +3 -3
- data/lib/dfp_api/v201107/network_service.rb +1 -1
- data/lib/dfp_api/v201107/network_service_registry.rb +3 -3
- data/lib/dfp_api/v201107/order_service.rb +13 -13
- data/lib/dfp_api/v201107/order_service_registry.rb +3 -3
- data/lib/dfp_api/v201107/placement_service.rb +5 -5
- data/lib/dfp_api/v201107/placement_service_registry.rb +3 -3
- data/lib/dfp_api/v201107/publisher_query_language_service.rb +1 -1
- data/lib/dfp_api/v201107/publisher_query_language_service_registry.rb +3 -3
- data/lib/dfp_api/v201107/report_service.rb +5 -5
- data/lib/dfp_api/v201107/report_service_registry.rb +3 -3
- data/lib/dfp_api/v201107/user_service.rb +13 -13
- data/lib/dfp_api/v201107/user_service_registry.rb +3 -3
- data/lib/dfp_api/v201108/company_service.rb +5 -5
- data/lib/dfp_api/v201108/company_service_registry.rb +3 -3
- data/lib/dfp_api/v201108/creative_service.rb +9 -9
- data/lib/dfp_api/v201108/creative_service_registry.rb +3 -3
- data/lib/dfp_api/v201108/custom_targeting_service.rb +17 -17
- data/lib/dfp_api/v201108/custom_targeting_service_registry.rb +3 -3
- data/lib/dfp_api/v201108/forecast_service.rb +1 -1
- data/lib/dfp_api/v201108/forecast_service_registry.rb +3 -3
- data/lib/dfp_api/v201108/inventory_service.rb +9 -9
- data/lib/dfp_api/v201108/inventory_service_registry.rb +3 -3
- data/lib/dfp_api/v201108/label_service.rb +5 -5
- data/lib/dfp_api/v201108/label_service_registry.rb +3 -3
- data/lib/dfp_api/v201108/line_item_creative_association_service.rb +13 -13
- data/lib/dfp_api/v201108/line_item_creative_association_service_registry.rb +3 -3
- data/lib/dfp_api/v201108/line_item_service.rb +5 -5
- data/lib/dfp_api/v201108/line_item_service_registry.rb +3 -3
- data/lib/dfp_api/v201108/network_service.rb +1 -1
- data/lib/dfp_api/v201108/network_service_registry.rb +3 -3
- data/lib/dfp_api/v201108/order_service.rb +13 -13
- data/lib/dfp_api/v201108/order_service_registry.rb +3 -3
- data/lib/dfp_api/v201108/placement_service.rb +5 -5
- data/lib/dfp_api/v201108/placement_service_registry.rb +3 -3
- data/lib/dfp_api/v201108/publisher_query_language_service.rb +1 -1
- data/lib/dfp_api/v201108/publisher_query_language_service_registry.rb +3 -3
- data/lib/dfp_api/v201108/report_service.rb +5 -5
- data/lib/dfp_api/v201108/report_service_registry.rb +3 -3
- data/lib/dfp_api/v201108/third_party_slot_service.rb +5 -5
- data/lib/dfp_api/v201108/third_party_slot_service_registry.rb +3 -3
- data/lib/dfp_api/v201108/user_service.rb +13 -13
- data/lib/dfp_api/v201108/user_service_registry.rb +3 -3
- data/lib/dfp_api/v201111/company_service.rb +52 -0
- data/lib/dfp_api/v201111/company_service_registry.rb +44 -0
- data/lib/dfp_api/v201111/content_service.rb +40 -0
- data/lib/dfp_api/v201111/content_service_registry.rb +44 -0
- data/lib/dfp_api/v201111/creative_service.rb +52 -0
- data/lib/dfp_api/v201111/creative_service_registry.rb +44 -0
- data/lib/dfp_api/v201111/creative_template_service.rb +36 -0
- data/lib/dfp_api/v201111/creative_template_service_registry.rb +44 -0
- data/lib/dfp_api/v201111/custom_targeting_service.rb +60 -0
- data/lib/dfp_api/v201111/custom_targeting_service_registry.rb +44 -0
- data/lib/dfp_api/v201111/forecast_service.rb +36 -0
- data/lib/dfp_api/v201111/forecast_service_registry.rb +44 -0
- data/lib/dfp_api/v201111/inventory_service.rb +60 -0
- data/lib/dfp_api/v201111/inventory_service_registry.rb +44 -0
- data/lib/dfp_api/v201111/label_service.rb +56 -0
- data/lib/dfp_api/v201111/label_service_registry.rb +44 -0
- data/lib/dfp_api/v201111/line_item_creative_association_service.rb +60 -0
- data/lib/dfp_api/v201111/line_item_creative_association_service_registry.rb +44 -0
- data/lib/dfp_api/v201111/line_item_service.rb +56 -0
- data/lib/dfp_api/v201111/line_item_service_registry.rb +44 -0
- data/lib/dfp_api/v201111/network_service.rb +40 -0
- data/lib/dfp_api/v201111/network_service_registry.rb +44 -0
- data/lib/dfp_api/v201111/order_service.rb +56 -0
- data/lib/dfp_api/v201111/order_service_registry.rb +44 -0
- data/lib/dfp_api/v201111/placement_service.rb +56 -0
- data/lib/dfp_api/v201111/placement_service_registry.rb +44 -0
- data/lib/dfp_api/v201111/publisher_query_language_service.rb +32 -0
- data/lib/dfp_api/v201111/publisher_query_language_service_registry.rb +44 -0
- data/lib/dfp_api/v201111/report_service.rb +40 -0
- data/lib/dfp_api/v201111/report_service_registry.rb +44 -0
- data/lib/dfp_api/v201111/suggested_ad_unit_service.rb +40 -0
- data/lib/dfp_api/v201111/suggested_ad_unit_service_registry.rb +44 -0
- data/lib/dfp_api/v201111/third_party_slot_service.rb +44 -0
- data/lib/dfp_api/v201111/third_party_slot_service_registry.rb +44 -0
- data/lib/dfp_api/v201111/user_service.rb +64 -0
- data/lib/dfp_api/v201111/user_service_registry.rb +44 -0
- data/test/bugs/test_issue_00000016.rb +3 -3
- metadata +149 -8
@@ -0,0 +1,66 @@
|
|
1
|
+
#!/usr/bin/ruby
|
2
|
+
#
|
3
|
+
# Author:: api.dklimkin@gmail.com (Danial Klimkin)
|
4
|
+
#
|
5
|
+
# Copyright:: Copyright 2011, Google Inc. All Rights Reserved.
|
6
|
+
#
|
7
|
+
# License:: Licensed under the Apache License, Version 2.0 (the "License");
|
8
|
+
# you may not use this file except in compliance with the License.
|
9
|
+
# You may obtain a copy of the License at
|
10
|
+
#
|
11
|
+
# http://www.apache.org/licenses/LICENSE-2.0
|
12
|
+
#
|
13
|
+
# Unless required by applicable law or agreed to in writing, software
|
14
|
+
# distributed under the License is distributed on an "AS IS" BASIS,
|
15
|
+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
16
|
+
# implied.
|
17
|
+
# See the License for the specific language governing permissions and
|
18
|
+
# limitations under the License.
|
19
|
+
#
|
20
|
+
# This example gets the current user.
|
21
|
+
#
|
22
|
+
# Tags: UserService.getCurrentUser
|
23
|
+
|
24
|
+
require 'rubygems'
|
25
|
+
require 'dfp_api'
|
26
|
+
|
27
|
+
API_VERSION = :v201111
|
28
|
+
|
29
|
+
def get_current_user()
|
30
|
+
# Get DfpApi instance and load configuration from ~/dfp_api.yml.
|
31
|
+
dfp = DfpApi::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
|
+
# dfp.logger = Logger.new('dfp_xml.log')
|
36
|
+
|
37
|
+
# Get the UserService.
|
38
|
+
user_service = dfp.service(:UserService, API_VERSION)
|
39
|
+
|
40
|
+
# Get the current user.
|
41
|
+
user = user_service.get_current_user()
|
42
|
+
|
43
|
+
puts "Current user has ID %d, email %s and role %s." %
|
44
|
+
[user[:id], user[:email], user[:role_name]]
|
45
|
+
end
|
46
|
+
|
47
|
+
if __FILE__ == $0
|
48
|
+
begin
|
49
|
+
get_current_user()
|
50
|
+
|
51
|
+
# HTTP errors.
|
52
|
+
rescue AdsCommon::Errors::HttpError => e
|
53
|
+
puts "HTTP Error: %s" % e
|
54
|
+
|
55
|
+
# API errors.
|
56
|
+
rescue DfpApi::Errors::ApiException => e
|
57
|
+
puts "Message: %s" % e.message
|
58
|
+
puts 'Errors:'
|
59
|
+
e.errors.each_with_index do |error, index|
|
60
|
+
puts "\tError [%d]:" % (index + 1)
|
61
|
+
error.each do |field, value|
|
62
|
+
puts "\t\t%s: %s" % [field, value]
|
63
|
+
end
|
64
|
+
end
|
65
|
+
end
|
66
|
+
end
|
@@ -0,0 +1,73 @@
|
|
1
|
+
#!/usr/bin/ruby
|
2
|
+
#
|
3
|
+
# Author:: api.dklimkin@gmail.com (Danial Klimkin)
|
4
|
+
#
|
5
|
+
# Copyright:: Copyright 2011, Google Inc. All Rights Reserved.
|
6
|
+
#
|
7
|
+
# License:: Licensed under the Apache License, Version 2.0 (the "License");
|
8
|
+
# you may not use this file except in compliance with the License.
|
9
|
+
# You may obtain a copy of the License at
|
10
|
+
#
|
11
|
+
# http://www.apache.org/licenses/LICENSE-2.0
|
12
|
+
#
|
13
|
+
# Unless required by applicable law or agreed to in writing, software
|
14
|
+
# distributed under the License is distributed on an "AS IS" BASIS,
|
15
|
+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
16
|
+
# implied.
|
17
|
+
# See the License for the specific language governing permissions and
|
18
|
+
# limitations under the License.
|
19
|
+
#
|
20
|
+
# This example gets a user by its ID. To create users, run create_users.rb.
|
21
|
+
#
|
22
|
+
# Tags: UserService.getUser
|
23
|
+
|
24
|
+
require 'rubygems'
|
25
|
+
require 'dfp_api'
|
26
|
+
|
27
|
+
API_VERSION = :v201111
|
28
|
+
|
29
|
+
def get_user()
|
30
|
+
# Get DfpApi instance and load configuration from ~/dfp_api.yml.
|
31
|
+
dfp = DfpApi::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
|
+
# dfp.logger = Logger.new('dfp_xml.log')
|
36
|
+
|
37
|
+
# Get the UserService.
|
38
|
+
user_service = dfp.service(:UserService, API_VERSION)
|
39
|
+
|
40
|
+
# Set the ID of the user to get.
|
41
|
+
user_id = 'INSERT_USER_ID_HERE'.to_i
|
42
|
+
|
43
|
+
# Get the user.
|
44
|
+
user = user_service.get_user(user_id)
|
45
|
+
|
46
|
+
if user
|
47
|
+
puts "User with ID: %d, name: %s, email: %s and role: %s was found." %
|
48
|
+
[user[:id], user[:name], user[:email], user[:role_name]]
|
49
|
+
else
|
50
|
+
puts 'No user found for this ID.'
|
51
|
+
end
|
52
|
+
end
|
53
|
+
|
54
|
+
if __FILE__ == $0
|
55
|
+
begin
|
56
|
+
get_user()
|
57
|
+
|
58
|
+
# HTTP errors.
|
59
|
+
rescue AdsCommon::Errors::HttpError => e
|
60
|
+
puts "HTTP Error: %s" % e
|
61
|
+
|
62
|
+
# API errors.
|
63
|
+
rescue DfpApi::Errors::ApiException => e
|
64
|
+
puts "Message: %s" % e.message
|
65
|
+
puts 'Errors:'
|
66
|
+
e.errors.each_with_index do |error, index|
|
67
|
+
puts "\tError [%d]:" % (index + 1)
|
68
|
+
error.each do |field, value|
|
69
|
+
puts "\t\t%s: %s" % [field, value]
|
70
|
+
end
|
71
|
+
end
|
72
|
+
end
|
73
|
+
end
|
@@ -0,0 +1,79 @@
|
|
1
|
+
#!/usr/bin/ruby
|
2
|
+
#
|
3
|
+
# Author:: api.dklimkin@gmail.com (Danial Klimkin)
|
4
|
+
#
|
5
|
+
# Copyright:: Copyright 2011, Google Inc. All Rights Reserved.
|
6
|
+
#
|
7
|
+
# License:: Licensed under the Apache License, Version 2.0 (the "License");
|
8
|
+
# you may not use this file except in compliance with the License.
|
9
|
+
# You may obtain a copy of the License at
|
10
|
+
#
|
11
|
+
# http://www.apache.org/licenses/LICENSE-2.0
|
12
|
+
#
|
13
|
+
# Unless required by applicable law or agreed to in writing, software
|
14
|
+
# distributed under the License is distributed on an "AS IS" BASIS,
|
15
|
+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
16
|
+
# implied.
|
17
|
+
# See the License for the specific language governing permissions and
|
18
|
+
# limitations under the License.
|
19
|
+
#
|
20
|
+
# This example gets all users sorted by name. The statement retrieves up to the
|
21
|
+
# maximum page size limit of 500. To create new users, run create_users.rb.
|
22
|
+
#
|
23
|
+
# Tags: UserService.getUsersByStatement
|
24
|
+
|
25
|
+
require 'rubygems'
|
26
|
+
require 'dfp_api'
|
27
|
+
|
28
|
+
API_VERSION = :v201111
|
29
|
+
|
30
|
+
def get_users_by_statement()
|
31
|
+
# Get DfpApi instance and load configuration from ~/dfp_api.yml.
|
32
|
+
dfp = DfpApi::Api.new
|
33
|
+
|
34
|
+
# To enable logging of SOAP requests, set the log_level value to 'DEBUG' in
|
35
|
+
# the configuration file or provide your own logger:
|
36
|
+
# dfp.logger = Logger.new('dfp_xml.log')
|
37
|
+
|
38
|
+
# Get the UserService.
|
39
|
+
user_service = dfp.service(:UserService, API_VERSION)
|
40
|
+
|
41
|
+
# Create a statement to get all users sorted by name.
|
42
|
+
statement = {:query => 'ORDER BY name LIMIT 500'}
|
43
|
+
|
44
|
+
# Get users by statement.
|
45
|
+
page = user_service.get_users_by_statement(statement)
|
46
|
+
|
47
|
+
if page and page[:results]
|
48
|
+
page[:results].each_with_index do |user, index|
|
49
|
+
puts "%d) User ID: %d, name: %s, email: %s, role: %s." % [index,
|
50
|
+
user[:id], user[:name], user[:email], user[:role_name]]
|
51
|
+
end
|
52
|
+
end
|
53
|
+
|
54
|
+
# Print a footer.
|
55
|
+
if page.include?(:total_result_set_size)
|
56
|
+
puts "Number of results found: %d" % page[:total_result_set_size]
|
57
|
+
end
|
58
|
+
end
|
59
|
+
|
60
|
+
if __FILE__ == $0
|
61
|
+
begin
|
62
|
+
get_users_by_statement()
|
63
|
+
|
64
|
+
# HTTP errors.
|
65
|
+
rescue AdsCommon::Errors::HttpError => e
|
66
|
+
puts "HTTP Error: %s" % e
|
67
|
+
|
68
|
+
# API errors.
|
69
|
+
rescue DfpApi::Errors::ApiException => e
|
70
|
+
puts "Message: %s" % e.message
|
71
|
+
puts 'Errors:'
|
72
|
+
e.errors.each_with_index do |error, index|
|
73
|
+
puts "\tError [%d]:" % (index + 1)
|
74
|
+
error.each do |field, value|
|
75
|
+
puts "\t\t%s: %s" % [field, value]
|
76
|
+
end
|
77
|
+
end
|
78
|
+
end
|
79
|
+
end
|
@@ -0,0 +1,89 @@
|
|
1
|
+
#!/usr/bin/ruby
|
2
|
+
#
|
3
|
+
# Author:: api.dklimkin@gmail.com (Danial Klimkin)
|
4
|
+
#
|
5
|
+
# Copyright:: Copyright 2011, Google Inc. All Rights Reserved.
|
6
|
+
#
|
7
|
+
# License:: Licensed under the Apache License, Version 2.0 (the "License");
|
8
|
+
# you may not use this file except in compliance with the License.
|
9
|
+
# You may obtain a copy of the License at
|
10
|
+
#
|
11
|
+
# http://www.apache.org/licenses/LICENSE-2.0
|
12
|
+
#
|
13
|
+
# Unless required by applicable law or agreed to in writing, software
|
14
|
+
# distributed under the License is distributed on an "AS IS" BASIS,
|
15
|
+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
16
|
+
# implied.
|
17
|
+
# See the License for the specific language governing permissions and
|
18
|
+
# limitations under the License.
|
19
|
+
#
|
20
|
+
# This example updates all users by adding "Sr." to the end of each name (after
|
21
|
+
# a very large baby boom and lack of creativity). To determine which users
|
22
|
+
# exist, run get_all_users.rb.
|
23
|
+
#
|
24
|
+
# Tags: UserService.getUsersByStatement, UserService.updateUsers
|
25
|
+
|
26
|
+
require 'rubygems'
|
27
|
+
require 'dfp_api'
|
28
|
+
|
29
|
+
API_VERSION = :v201111
|
30
|
+
|
31
|
+
def update_users()
|
32
|
+
# Get DfpApi instance and load configuration from ~/dfp_api.yml.
|
33
|
+
dfp = DfpApi::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
|
+
# dfp.logger = Logger.new('dfp_xml.log')
|
38
|
+
|
39
|
+
# Get the UserService.
|
40
|
+
user_service = dfp.service(:UserService, API_VERSION)
|
41
|
+
|
42
|
+
# Create a statement to get all users.
|
43
|
+
statement = {:query => 'LIMIT 500'}
|
44
|
+
|
45
|
+
# Get users by statement.
|
46
|
+
page = user_service.get_users_by_statement(statement)
|
47
|
+
|
48
|
+
if page[:results]
|
49
|
+
users = page[:results]
|
50
|
+
|
51
|
+
# Update each local users object by changing its name.
|
52
|
+
users.each {|user| user[:name] += ' Sr.'}
|
53
|
+
|
54
|
+
# Update the users on the server.
|
55
|
+
return_users = user_service.update_users(users)
|
56
|
+
|
57
|
+
if return_users
|
58
|
+
return_users.each do |user|
|
59
|
+
puts ("User ID: %d, email: %s was updated with name %s") %
|
60
|
+
[user[:id], user[:email], user[:name]]
|
61
|
+
end
|
62
|
+
else
|
63
|
+
raise 'No users were updated.'
|
64
|
+
end
|
65
|
+
else
|
66
|
+
puts 'No users found to update.'
|
67
|
+
end
|
68
|
+
end
|
69
|
+
|
70
|
+
if __FILE__ == $0
|
71
|
+
begin
|
72
|
+
update_users()
|
73
|
+
|
74
|
+
# HTTP errors.
|
75
|
+
rescue AdsCommon::Errors::HttpError => e
|
76
|
+
puts "HTTP Error: %s" % e
|
77
|
+
|
78
|
+
# API errors.
|
79
|
+
rescue DfpApi::Errors::ApiException => e
|
80
|
+
puts "Message: %s" % e.message
|
81
|
+
puts 'Errors:'
|
82
|
+
e.errors.each_with_index do |error, index|
|
83
|
+
puts "\tError [%d]:" % (index + 1)
|
84
|
+
error.each do |field, value|
|
85
|
+
puts "\t\t%s: %s" % [field, value]
|
86
|
+
end
|
87
|
+
end
|
88
|
+
end
|
89
|
+
end
|
data/lib/dfp_api.rb
CHANGED
data/lib/dfp_api/api_config.rb
CHANGED
@@ -34,13 +34,13 @@ module DfpApi
|
|
34
34
|
end
|
35
35
|
|
36
36
|
# Set defaults
|
37
|
-
DEFAULT_VERSION = :
|
37
|
+
DEFAULT_VERSION = :v201111
|
38
38
|
DEFAULT_ENVIRONMENT = :PRODUCTION
|
39
|
-
LATEST_VERSION = :
|
39
|
+
LATEST_VERSION = :v201111
|
40
40
|
|
41
41
|
# Set other constants
|
42
42
|
API_NAME = 'DfpApi'
|
43
|
-
CLIENT_LIB_VERSION = '0.2.
|
43
|
+
CLIENT_LIB_VERSION = '0.2.6'
|
44
44
|
DEFAULT_CONFIG_FILENAME = 'dfp_api.yml'
|
45
45
|
|
46
46
|
# Configure the services available to each version
|
@@ -66,7 +66,14 @@ module DfpApi
|
|
66
66
|
:LineItemService, :NetworkService, :OrderService,
|
67
67
|
:PlacementService, :ReportService, :UserService,
|
68
68
|
:CustomTargetingService, :PublisherQueryLanguageService,
|
69
|
-
:LabelService, :ThirdPartySlotService]
|
69
|
+
:LabelService, :ThirdPartySlotService],
|
70
|
+
:v201111 => [:CompanyService, :CreativeService, :ForecastService,
|
71
|
+
:InventoryService, :LineItemCreativeAssociationService,
|
72
|
+
:LineItemService, :NetworkService, :OrderService,
|
73
|
+
:PlacementService, :ReportService, :UserService,
|
74
|
+
:CustomTargetingService, :PublisherQueryLanguageService,
|
75
|
+
:LabelService, :ThirdPartySlotService, :ContentService,
|
76
|
+
:SuggestedAdUnitService, :CreativeTemplateService]
|
70
77
|
}
|
71
78
|
|
72
79
|
# Configure the different environments, with the base URL for each one
|
@@ -76,14 +83,16 @@ module DfpApi
|
|
76
83
|
:v201103 => 'https://www.google.com/apis/ads/publisher/',
|
77
84
|
:v201104 => 'https://www.google.com/apis/ads/publisher/',
|
78
85
|
:v201107 => 'https://www.google.com/apis/ads/publisher/',
|
79
|
-
:v201108 => 'https://www.google.com/apis/ads/publisher/'
|
86
|
+
:v201108 => 'https://www.google.com/apis/ads/publisher/',
|
87
|
+
:v201111 => 'https://www.google.com/apis/ads/publisher/'
|
80
88
|
},
|
81
89
|
:SANDBOX => {
|
82
90
|
:oauth_scope => 'https://sandbox.google.com/apis/ads/publisher/',
|
83
91
|
:v201103 => 'https://sandbox.google.com/apis/ads/publisher/',
|
84
92
|
:v201104 => 'https://sandbox.google.com/apis/ads/publisher/',
|
85
93
|
:v201107 => 'https://sandbox.google.com/apis/ads/publisher/',
|
86
|
-
:v201108 => 'https://sandbox.google.com/apis/ads/publisher/'
|
94
|
+
:v201108 => 'https://sandbox.google.com/apis/ads/publisher/',
|
95
|
+
:v201111 => 'https://sandbox.google.com/apis/ads/publisher/'
|
87
96
|
}
|
88
97
|
}
|
89
98
|
|
@@ -3,7 +3,7 @@
|
|
3
3
|
# Copyright:: Copyright 2011, Google Inc. All Rights Reserved.
|
4
4
|
# License:: Licensed under the Apache License,Version 2.0 (the "License").
|
5
5
|
#
|
6
|
-
# Code generated by AdsCommon library 0.
|
6
|
+
# Code generated by AdsCommon library 0.6.0 on 2011-12-02 16:50:12.
|
7
7
|
|
8
8
|
require 'ads_common/savon_service'
|
9
9
|
require 'dfp_api/v201103/company_service_registry'
|
@@ -15,10 +15,6 @@ module DfpApi; module V201103; module CompanyService
|
|
15
15
|
super(api, endpoint, namespace, :v201103)
|
16
16
|
end
|
17
17
|
|
18
|
-
def update_company(*args, &block)
|
19
|
-
return execute_action('update_company', args, &block)
|
20
|
-
end
|
21
|
-
|
22
18
|
def create_companies(*args, &block)
|
23
19
|
return execute_action('create_companies', args, &block)
|
24
20
|
end
|
@@ -39,6 +35,10 @@ module DfpApi; module V201103; module CompanyService
|
|
39
35
|
return execute_action('update_companies', args, &block)
|
40
36
|
end
|
41
37
|
|
38
|
+
def update_company(*args, &block)
|
39
|
+
return execute_action('update_company', args, &block)
|
40
|
+
end
|
41
|
+
|
42
42
|
private
|
43
43
|
|
44
44
|
def get_service_registry()
|
@@ -3,14 +3,14 @@
|
|
3
3
|
# Copyright:: Copyright 2011, Google Inc. All Rights Reserved.
|
4
4
|
# License:: Licensed under the Apache License,Version 2.0 (the "License").
|
5
5
|
#
|
6
|
-
# Code generated by AdsCommon library 0.
|
6
|
+
# Code generated by AdsCommon library 0.6.0 on 2011-12-02 16:50:12.
|
7
7
|
|
8
8
|
require 'dfp_api/errors'
|
9
9
|
|
10
10
|
module DfpApi; module V201103; module CompanyService
|
11
11
|
class CompanyServiceRegistry
|
12
|
-
COMPANYSERVICE_METHODS = {:
|
13
|
-
COMPANYSERVICE_TYPES = {:
|
12
|
+
COMPANYSERVICE_METHODS = {:create_companies=>{:input=>[{:name=>:companies, :type=>"Company", :min_occurs=>0, :max_occurs=>:unbounded}], :output=>{:name=>"create_companies_response", :fields=>[{:name=>:rval, :type=>"Company", :min_occurs=>0, :max_occurs=>:unbounded}]}}, :create_company=>{:input=>[{:name=>:company, :type=>"Company", :min_occurs=>0, :max_occurs=>1}], :output=>{:name=>"create_company_response", :fields=>[{:name=>:rval, :type=>"Company", :min_occurs=>0, :max_occurs=>1}]}}, :get_companies_by_statement=>{:input=>[{:name=>:filter_statement, :type=>"Statement", :min_occurs=>0, :max_occurs=>1}], :output=>{:name=>"get_companies_by_statement_response", :fields=>[{:name=>:rval, :type=>"CompanyPage", :min_occurs=>0, :max_occurs=>1}]}}, :get_company=>{:input=>[{:name=>:company_id, :type=>"long", :min_occurs=>0, :max_occurs=>1}], :output=>{:name=>"get_company_response", :fields=>[{:name=>:rval, :type=>"Company", :min_occurs=>0, :max_occurs=>1}]}}, :update_companies=>{:input=>[{:name=>:companies, :type=>"Company", :min_occurs=>0, :max_occurs=>:unbounded}], :output=>{:name=>"update_companies_response", :fields=>[{:name=>:rval, :type=>"Company", :min_occurs=>0, :max_occurs=>:unbounded}]}}, :update_company=>{:input=>[{:name=>:company, :type=>"Company", :min_occurs=>0, :max_occurs=>1}], :output=>{:name=>"update_company_response", :fields=>[{:name=>:rval, :type=>"Company", :min_occurs=>0, :max_occurs=>1}]}}}
|
13
|
+
COMPANYSERVICE_TYPES = {:Authentication=>{:fields=>[{:name=>:authentication_type, :type=>"string", :min_occurs=>0, :max_occurs=>1}], :abstract=>true}, :BooleanValue=>{:fields=>[{:name=>:value, :type=>"boolean", :min_occurs=>0, :max_occurs=>1}], :base=>"Value"}, :ClientLogin=>{:fields=>[{:name=>:token, :type=>"string", :min_occurs=>0, :max_occurs=>1}], :base=>"Authentication"}, :Company=>{:fields=>[{:name=>:id, :type=>"long", :min_occurs=>0, :max_occurs=>1}, {:name=>:name, :type=>"string", :min_occurs=>0, :max_occurs=>1}, {:name=>:type, :type=>"Company.Type", :min_occurs=>0, :max_occurs=>1}]}, :CompanyPage=>{:fields=>[{:name=>:total_result_set_size, :type=>"int", :min_occurs=>0, :max_occurs=>1}, {:name=>:start_index, :type=>"int", :min_occurs=>0, :max_occurs=>1}, {:name=>:results, :type=>"Company", :min_occurs=>0, :max_occurs=>:unbounded}]}, :CustomCriteria=>{:fields=>[{:name=>:key_id, :type=>"long", :min_occurs=>0, :max_occurs=>1}, {:name=>:operator, :type=>"CustomCriteria.ComparisonOperator", :min_occurs=>0, :max_occurs=>1}], :base=>"CustomCriteriaNode"}, :CustomCriteriaSet=>{:fields=>[{:name=>:logical_operator, :type=>"CustomCriteriaSet.LogicalOperator", :min_occurs=>0, :max_occurs=>1}, {:name=>:children, :type=>"CustomCriteriaNode", :min_occurs=>0, :max_occurs=>:unbounded}], :base=>"CustomCriteriaNode"}, :CustomCriteriaNode=>{:fields=>[{:name=>:custom_criteria_node_type, :type=>"string", :min_occurs=>0, :max_occurs=>1}], :abstract=>true}, :CustomTargetingValue=>{:fields=>[{:name=>:custom_targeting_key_id, :type=>"long", :min_occurs=>0, :max_occurs=>1}, {:name=>:id, :type=>"long", :min_occurs=>0, :max_occurs=>1}, {:name=>:name, :type=>"string", :min_occurs=>0, :max_occurs=>1}, {:name=>:display_name, :type=>"string", :min_occurs=>0, :max_occurs=>1}, {:name=>:match_type, :type=>"CustomTargetingValue.MatchType", :min_occurs=>0, :max_occurs=>1}]}, :FreeFormCustomCriteria=>{:fields=>[{:name=>:values, :type=>"CustomTargetingValue", :min_occurs=>0, :max_occurs=>:unbounded}], :base=>"CustomCriteria"}, :NumberValue=>{:fields=>[{:name=>:value, :type=>"string", :min_occurs=>0, :max_occurs=>1}], :base=>"Value"}, :OAuth=>{:fields=>[{:name=>:parameters, :type=>"string", :min_occurs=>0, :max_occurs=>1}], :base=>"Authentication"}, :PredefinedCustomCriteria=>{:fields=>[{:name=>:value_ids, :type=>"long", :min_occurs=>0, :max_occurs=>:unbounded}], :base=>"CustomCriteria"}, :SoapRequestHeader=>{:fields=>[{:name=>:network_code, :type=>"string", :min_occurs=>0, :max_occurs=>1}, {:name=>:application_name, :type=>"string", :min_occurs=>0, :max_occurs=>1}, {:name=>:authentication, :type=>"Authentication", :min_occurs=>0, :max_occurs=>1}]}, :SoapResponseHeader=>{:fields=>[{:name=>:request_id, :type=>"string", :min_occurs=>0, :max_occurs=>1}, {:name=>:response_time, :type=>"long", :min_occurs=>0, :max_occurs=>1}]}, :Statement=>{:fields=>[{:name=>:query, :type=>"string", :min_occurs=>0, :max_occurs=>1}, {:name=>:values, :type=>"String_ValueMapEntry", :min_occurs=>0, :max_occurs=>:unbounded}]}, :String_ValueMapEntry=>{:fields=>[{:name=>:key, :type=>"string", :min_occurs=>0, :max_occurs=>1}, {:name=>:value, :type=>"Value", :min_occurs=>0, :max_occurs=>1}]}, :TextValue=>{:fields=>[{:name=>:value, :type=>"string", :min_occurs=>0, :max_occurs=>1}], :base=>"Value"}, :Value=>{:fields=>[{:name=>:value_type, :type=>"string", :min_occurs=>0, :max_occurs=>1}], :abstract=>true}, :"Company.Type"=>{:fields=>[]}, :"CustomCriteria.ComparisonOperator"=>{:fields=>[]}, :"CustomCriteriaSet.LogicalOperator"=>{:fields=>[]}, :"CustomTargetingValue.MatchType"=>{:fields=>[]}}
|
14
14
|
COMPANYSERVICE_NAMESPACES = []
|
15
15
|
|
16
16
|
def self.get_method_signature(method_name)
|
@@ -3,7 +3,7 @@
|
|
3
3
|
# Copyright:: Copyright 2011, Google Inc. All Rights Reserved.
|
4
4
|
# License:: Licensed under the Apache License,Version 2.0 (the "License").
|
5
5
|
#
|
6
|
-
# Code generated by AdsCommon library 0.
|
6
|
+
# Code generated by AdsCommon library 0.6.0 on 2011-12-02 16:50:14.
|
7
7
|
|
8
8
|
require 'ads_common/savon_service'
|
9
9
|
require 'dfp_api/v201103/creative_service_registry'
|
@@ -15,6 +15,14 @@ module DfpApi; module V201103; module CreativeService
|
|
15
15
|
super(api, endpoint, namespace, :v201103)
|
16
16
|
end
|
17
17
|
|
18
|
+
def create_creative(*args, &block)
|
19
|
+
return execute_action('create_creative', args, &block)
|
20
|
+
end
|
21
|
+
|
22
|
+
def create_creatives(*args, &block)
|
23
|
+
return execute_action('create_creatives', args, &block)
|
24
|
+
end
|
25
|
+
|
18
26
|
def get_creative(*args, &block)
|
19
27
|
return execute_action('get_creative', args, &block)
|
20
28
|
end
|
@@ -31,14 +39,6 @@ module DfpApi; module V201103; module CreativeService
|
|
31
39
|
return execute_action('update_creatives', args, &block)
|
32
40
|
end
|
33
41
|
|
34
|
-
def create_creative(*args, &block)
|
35
|
-
return execute_action('create_creative', args, &block)
|
36
|
-
end
|
37
|
-
|
38
|
-
def create_creatives(*args, &block)
|
39
|
-
return execute_action('create_creatives', args, &block)
|
40
|
-
end
|
41
|
-
|
42
42
|
private
|
43
43
|
|
44
44
|
def get_service_registry()
|