google-dfp-api 0.2.2 → 0.2.3
Sign up to get free protection for your applications and to get access to all the features.
- data/ChangeLog +3 -0
- data/examples/v201101/company_service/create_companies.rb +3 -4
- data/examples/v201101/company_service/update_companies.rb +2 -2
- data/examples/v201101/creative_service/create_creatives.rb +8 -11
- data/examples/v201101/inventory_service/create_ad_units.rb +7 -10
- data/examples/v201101/inventory_service/update_ad_units.rb +1 -1
- data/examples/v201101/line_item_service/create_line_items.rb +2 -3
- data/examples/v201101/line_item_service/update_line_items.rb +1 -1
- data/examples/v201101/order_service/create_orders.rb +5 -6
- data/examples/v201101/order_service/update_orders.rb +1 -1
- data/examples/v201101/placement_service/create_placements.rb +1 -1
- data/examples/v201101/placement_service/update_placements.rb +2 -1
- data/examples/v201101/user_service/update_users.rb +1 -1
- data/examples/v201103/company_service/create_companies.rb +3 -4
- data/examples/v201103/company_service/update_companies.rb +2 -2
- data/examples/v201103/creative_service/create_creatives.rb +8 -11
- data/examples/v201103/inventory_service/create_ad_units.rb +7 -10
- data/examples/v201103/inventory_service/update_ad_units.rb +1 -1
- data/examples/v201103/line_item_service/create_line_items.rb +2 -3
- data/examples/v201103/line_item_service/update_line_items.rb +1 -1
- data/examples/v201103/order_service/create_orders.rb +5 -6
- data/examples/v201103/order_service/update_orders.rb +1 -1
- data/examples/v201103/placement_service/create_placements.rb +1 -1
- data/examples/v201103/placement_service/update_placements.rb +2 -1
- data/examples/v201103/user_service/update_users.rb +1 -1
- data/examples/v201104/company_service/create_companies.rb +3 -4
- data/examples/v201104/company_service/update_companies.rb +2 -2
- data/examples/v201104/creative_service/create_creatives.rb +8 -11
- data/examples/v201104/inventory_service/create_ad_units.rb +7 -10
- data/examples/v201104/inventory_service/update_ad_units.rb +1 -1
- data/examples/v201104/line_item_service/create_line_items.rb +2 -3
- data/examples/v201104/line_item_service/update_line_items.rb +1 -1
- data/examples/v201104/order_service/create_orders.rb +5 -6
- data/examples/v201104/order_service/update_orders.rb +1 -1
- data/examples/v201104/placement_service/create_placements.rb +1 -1
- data/examples/v201104/placement_service/update_placements.rb +2 -1
- data/examples/v201104/user_service/update_users.rb +1 -1
- data/examples/v201107/common/error_handling.rb +76 -0
- data/examples/v201107/common/oauth_handling.rb +128 -0
- data/examples/v201107/company_service/create_companies.rb +81 -0
- data/examples/v201107/company_service/get_all_companies.rb +92 -0
- data/examples/v201107/company_service/get_companies_by_statement.rb +88 -0
- data/examples/v201107/company_service/get_company.rb +72 -0
- data/examples/v201107/company_service/update_companies.rb +95 -0
- data/examples/v201107/creative_service/copy_image_creatives.rb +117 -0
- data/examples/v201107/creative_service/create_creatives.rb +106 -0
- data/examples/v201107/creative_service/get_all_creatives.rb +93 -0
- data/examples/v201107/creative_service/get_creative.rb +72 -0
- data/examples/v201107/creative_service/get_creatives_by_statement.rb +87 -0
- data/examples/v201107/creative_service/update_creatives.rb +98 -0
- data/examples/v201107/custom_targeting_service/create_custom_targeting_keys_and_values.rb +118 -0
- data/examples/v201107/custom_targeting_service/delete_custom_targeting_keys.rb +121 -0
- data/examples/v201107/custom_targeting_service/delete_custom_targeting_values.rb +125 -0
- data/examples/v201107/custom_targeting_service/get_all_custom_targeting_keys_and_values.rb +148 -0
- data/examples/v201107/custom_targeting_service/get_custom_targeting_keys_by_statement.rb +92 -0
- data/examples/v201107/custom_targeting_service/get_custom_targeting_values_by_statement.rb +98 -0
- data/examples/v201107/custom_targeting_service/update_custom_targeting_keys.rb +94 -0
- data/examples/v201107/custom_targeting_service/update_custom_targeting_values.rb +106 -0
- data/examples/v201107/forecast_service/get_forecast.rb +103 -0
- data/examples/v201107/forecast_service/get_forecast_by_id.rb +80 -0
- data/examples/v201107/inventory_service/create_ad_units.rb +95 -0
- data/examples/v201107/inventory_service/deactivate_ad_units.rb +119 -0
- data/examples/v201107/inventory_service/get_ad_unit.rb +72 -0
- data/examples/v201107/inventory_service/get_ad_unit_sizes.rb +73 -0
- data/examples/v201107/inventory_service/get_ad_units_by_statement.rb +96 -0
- data/examples/v201107/inventory_service/get_all_ad_units.rb +93 -0
- data/examples/v201107/inventory_service/update_ad_units.rb +94 -0
- data/examples/v201107/label_service/create_labels.rb +83 -0
- data/examples/v201107/label_service/deactivate_labels.rb +118 -0
- data/examples/v201107/label_service/get_all_labels.rb +94 -0
- data/examples/v201107/label_service/get_label.rb +76 -0
- data/examples/v201107/label_service/get_labels_by_statement.rb +91 -0
- data/examples/v201107/label_service/update_labels.rb +104 -0
- data/examples/v201107/line_item_creative_association_service/create_licas.rb +94 -0
- data/examples/v201107/line_item_creative_association_service/deactivate_licas.rb +127 -0
- data/examples/v201107/line_item_creative_association_service/get_all_licas.rb +95 -0
- data/examples/v201107/line_item_creative_association_service/get_lica.rb +77 -0
- data/examples/v201107/line_item_creative_association_service/get_licas_by_statement.rb +91 -0
- data/examples/v201107/line_item_creative_association_service/update_licas.rb +92 -0
- data/examples/v201107/line_item_service/activate_line_items.rb +131 -0
- data/examples/v201107/line_item_service/create_line_items.rb +167 -0
- data/examples/v201107/line_item_service/get_all_line_items.rb +94 -0
- data/examples/v201107/line_item_service/get_line_item.rb +74 -0
- data/examples/v201107/line_item_service/get_line_items_by_statement.rb +89 -0
- data/examples/v201107/line_item_service/target_custom_criteria.rb +129 -0
- data/examples/v201107/line_item_service/update_line_items.rb +110 -0
- data/examples/v201107/network_service/get_all_networks.rb +74 -0
- data/examples/v201107/network_service/get_current_network.rb +66 -0
- data/examples/v201107/order_service/approve_orders.rb +116 -0
- data/examples/v201107/order_service/create_orders.rb +92 -0
- data/examples/v201107/order_service/get_all_orders.rb +93 -0
- data/examples/v201107/order_service/get_order.rb +74 -0
- data/examples/v201107/order_service/get_orders_by_statement.rb +90 -0
- data/examples/v201107/order_service/update_orders.rb +95 -0
- data/examples/v201107/placement_service/create_placements.rb +128 -0
- data/examples/v201107/placement_service/deactivate_placements.rb +118 -0
- data/examples/v201107/placement_service/get_all_placements.rb +93 -0
- data/examples/v201107/placement_service/get_placement.rb +74 -0
- data/examples/v201107/placement_service/get_placements_by_statement.rb +86 -0
- data/examples/v201107/placement_service/update_placements.rb +97 -0
- data/examples/v201107/publisher_query_language_service/get_all_bandwidth_groups.rb +85 -0
- data/examples/v201107/publisher_query_language_service/get_all_browser_languages.rb +85 -0
- data/examples/v201107/publisher_query_language_service/get_all_browsers.rb +85 -0
- data/examples/v201107/publisher_query_language_service/get_all_cities.rb +85 -0
- data/examples/v201107/publisher_query_language_service/get_all_countries.rb +85 -0
- data/examples/v201107/publisher_query_language_service/get_all_metros.rb +85 -0
- data/examples/v201107/publisher_query_language_service/get_all_operating_systems.rb +85 -0
- data/examples/v201107/publisher_query_language_service/get_all_regions.rb +85 -0
- data/examples/v201107/report_service/download_report.rb +81 -0
- data/examples/v201107/report_service/run_delivery_report.rb +89 -0
- data/examples/v201107/report_service/run_inventory_report.rb +90 -0
- data/examples/v201107/report_service/run_sales_report.rb +89 -0
- data/examples/v201107/user_service/create_users.rb +89 -0
- data/examples/v201107/user_service/deactivate_users.rb +99 -0
- data/examples/v201107/user_service/get_all_roles.rb +73 -0
- data/examples/v201107/user_service/get_all_users.rb +92 -0
- data/examples/v201107/user_service/get_current_user.rb +66 -0
- data/examples/v201107/user_service/get_user.rb +73 -0
- data/examples/v201107/user_service/get_users_by_statement.rb +79 -0
- data/examples/v201107/user_service/update_users.rb +89 -0
- data/lib/dfp_api/api_config.rb +16 -7
- data/lib/dfp_api/v201107/company_service.rb +52 -0
- data/lib/dfp_api/v201107/company_service_registry.rb +42 -0
- data/lib/dfp_api/v201107/creative_service.rb +52 -0
- data/lib/dfp_api/v201107/creative_service_registry.rb +42 -0
- data/lib/dfp_api/v201107/custom_targeting_service.rb +60 -0
- data/lib/dfp_api/v201107/custom_targeting_service_registry.rb +42 -0
- data/lib/dfp_api/v201107/forecast_service.rb +36 -0
- data/lib/dfp_api/v201107/forecast_service_registry.rb +42 -0
- data/lib/dfp_api/v201107/inventory_service.rb +60 -0
- data/lib/dfp_api/v201107/inventory_service_registry.rb +42 -0
- data/lib/dfp_api/v201107/label_service.rb +56 -0
- data/lib/dfp_api/v201107/label_service_registry.rb +42 -0
- data/lib/dfp_api/v201107/line_item_creative_association_service.rb +56 -0
- data/lib/dfp_api/v201107/line_item_creative_association_service_registry.rb +42 -0
- data/lib/dfp_api/v201107/line_item_service.rb +56 -0
- data/lib/dfp_api/v201107/line_item_service_registry.rb +42 -0
- data/lib/dfp_api/v201107/network_service.rb +40 -0
- data/lib/dfp_api/v201107/network_service_registry.rb +42 -0
- data/lib/dfp_api/v201107/order_service.rb +56 -0
- data/lib/dfp_api/v201107/order_service_registry.rb +42 -0
- data/lib/dfp_api/v201107/placement_service.rb +56 -0
- data/lib/dfp_api/v201107/placement_service_registry.rb +42 -0
- data/lib/dfp_api/v201107/publisher_query_language_service.rb +32 -0
- data/lib/dfp_api/v201107/publisher_query_language_service_registry.rb +42 -0
- data/lib/dfp_api/v201107/report_service.rb +40 -0
- data/lib/dfp_api/v201107/report_service_registry.rb +42 -0
- data/lib/dfp_api/v201107/user_service.rb +64 -0
- data/lib/dfp_api/v201107/user_service_registry.rb +42 -0
- metadata +115 -4
@@ -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 creates new users. To determine which users exist, run
|
21
|
+
# get_all_users.rb. To determine which roles exist, run get_all_roles.rb.
|
22
|
+
#
|
23
|
+
# Tags: UserService.createUsers
|
24
|
+
|
25
|
+
require 'rubygems'
|
26
|
+
require 'dfp_api'
|
27
|
+
|
28
|
+
API_VERSION = :v201107
|
29
|
+
|
30
|
+
def create_users()
|
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
|
+
# Set the user's email addresses and names.
|
42
|
+
emails_and_names = [
|
43
|
+
{:name => 'INSERT_NAME_HERE',
|
44
|
+
:email => 'INSERT_EMAIL_ADDRESS_HERE'},
|
45
|
+
{:name => 'INSERT_NAME_HERE',
|
46
|
+
:email => 'INSERT_EMAIL_ADDRESS_HERE'}
|
47
|
+
]
|
48
|
+
|
49
|
+
# Set the role ID for new users.
|
50
|
+
role_id = 'INSERT_ROLE_ID_HERE'.to_i
|
51
|
+
|
52
|
+
# Create an array to store local user objects.
|
53
|
+
users = emails_and_names.map do |email_and_name|
|
54
|
+
email_and_name.merge({:role_id => role_id, :preferred_locale => 'en_US'})
|
55
|
+
end
|
56
|
+
|
57
|
+
# Create the users on the server.
|
58
|
+
return_users = user_service.create_users(users)
|
59
|
+
|
60
|
+
if return_users
|
61
|
+
return_users.each do |user|
|
62
|
+
puts "User with ID: %d, name: %s and email: %s was created." %
|
63
|
+
[user[:id], user[:name], user[:email]]
|
64
|
+
end
|
65
|
+
else
|
66
|
+
raise 'No users were created.'
|
67
|
+
end
|
68
|
+
end
|
69
|
+
|
70
|
+
if __FILE__ == $0
|
71
|
+
begin
|
72
|
+
create_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
|
@@ -0,0 +1,99 @@
|
|
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 deactivates a user. Deactivated users can no longer make requests
|
21
|
+
# to the API. The user making the request cannot deactivate itself. To determine
|
22
|
+
# which users exist, run get_all_users.rb.
|
23
|
+
#
|
24
|
+
# Tags: UserService.getUsersByStatement,
|
25
|
+
# UserService.performUserAction
|
26
|
+
|
27
|
+
require 'rubygems'
|
28
|
+
require 'dfp_api'
|
29
|
+
|
30
|
+
API_VERSION = :v201107
|
31
|
+
PAGE_SIZE = 500
|
32
|
+
|
33
|
+
def deactivate_users()
|
34
|
+
# Get DfpApi instance and load configuration from ~/dfp_api.yml.
|
35
|
+
dfp = DfpApi::Api.new
|
36
|
+
|
37
|
+
# To enable logging of SOAP requests, set the log_level value to 'DEBUG' in
|
38
|
+
# the configuration file or provide your own logger:
|
39
|
+
# dfp.logger = Logger.new('dfp_xml.log')
|
40
|
+
|
41
|
+
# Get the UserService.
|
42
|
+
user_service = dfp.service(:UserService, API_VERSION)
|
43
|
+
|
44
|
+
# Set the ID of the user to deactivate
|
45
|
+
user_id = 'INSERT_USER_ID_HERE'
|
46
|
+
|
47
|
+
# Create filter text to select user by id.
|
48
|
+
statement = {
|
49
|
+
:query => 'WHERE id = :user_id',
|
50
|
+
:values => [
|
51
|
+
{:key => 'user_id',
|
52
|
+
:value => {:value => user_id, :xsi_type => 'NumberValue'}}
|
53
|
+
]
|
54
|
+
}
|
55
|
+
|
56
|
+
# Get users by statement.
|
57
|
+
page = user_service.get_users_by_statement(statement)
|
58
|
+
|
59
|
+
if page[:results]
|
60
|
+
page[:results].each do |user|
|
61
|
+
puts "User ID: %d, name: %s and status: %s will be deactivated." %
|
62
|
+
[user[:id], user[:name], user[:status]]
|
63
|
+
end
|
64
|
+
|
65
|
+
# Perform action.
|
66
|
+
result = user_service.perform_user_action(
|
67
|
+
{:xsi_type => 'DeactivateUsers'}, statement)
|
68
|
+
|
69
|
+
# Display results.
|
70
|
+
if result and result[:num_changes] > 0
|
71
|
+
puts "Number of users deactivated: %d" % result[:num_changes]
|
72
|
+
else
|
73
|
+
puts 'No users were deactivated.'
|
74
|
+
end
|
75
|
+
else
|
76
|
+
puts 'No user found to deactivate.'
|
77
|
+
end
|
78
|
+
end
|
79
|
+
|
80
|
+
if __FILE__ == $0
|
81
|
+
begin
|
82
|
+
deactivate_users()
|
83
|
+
|
84
|
+
# HTTP errors.
|
85
|
+
rescue AdsCommon::Errors::HttpError => e
|
86
|
+
puts "HTTP Error: %s" % e
|
87
|
+
|
88
|
+
# API errors.
|
89
|
+
rescue DfpApi::Errors::ApiException => e
|
90
|
+
puts "Message: %s" % e.message
|
91
|
+
puts 'Errors:'
|
92
|
+
e.errors.each_with_index do |error, index|
|
93
|
+
puts "\tError [%d]:" % (index + 1)
|
94
|
+
error.each do |field, value|
|
95
|
+
puts "\t\t%s: %s" % [field, value]
|
96
|
+
end
|
97
|
+
end
|
98
|
+
end
|
99
|
+
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 all roles. This example can be used to determine which role
|
21
|
+
# ID is needed when getting and creating users.
|
22
|
+
#
|
23
|
+
# Tags: UserService.getAllRoles
|
24
|
+
|
25
|
+
require 'rubygems'
|
26
|
+
require 'dfp_api'
|
27
|
+
|
28
|
+
API_VERSION = :v201107
|
29
|
+
|
30
|
+
def get_all_roles()
|
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
|
+
# Get all roles.
|
42
|
+
roles = user_service.get_all_roles()
|
43
|
+
|
44
|
+
if roles
|
45
|
+
# Print details about each role in results page.
|
46
|
+
roles.each_with_index do |role, index|
|
47
|
+
puts "%d) Role ID: %d, name: %s" % [index, role[:id], role[:name]]
|
48
|
+
end
|
49
|
+
# Print a footer
|
50
|
+
puts "Total number of roles: %d" % roles.size
|
51
|
+
end
|
52
|
+
end
|
53
|
+
|
54
|
+
if __FILE__ == $0
|
55
|
+
begin
|
56
|
+
get_all_roles()
|
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,92 @@
|
|
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 for an account. To create users run create_user.rb
|
21
|
+
#
|
22
|
+
# Tags: UserService.getUsersByStatement
|
23
|
+
|
24
|
+
require 'rubygems'
|
25
|
+
require 'dfp_api'
|
26
|
+
|
27
|
+
API_VERSION = :v201107
|
28
|
+
PAGE_SIZE = 500
|
29
|
+
|
30
|
+
def get_all_users()
|
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
|
+
# Define initial values.
|
42
|
+
offset = 0
|
43
|
+
page = {}
|
44
|
+
|
45
|
+
begin
|
46
|
+
# Create statement for one page with current offset.
|
47
|
+
statement = {:query => "LIMIT %d OFFSET %d" % [PAGE_SIZE, offset]}
|
48
|
+
|
49
|
+
# Get users by statement.
|
50
|
+
page = user_service.get_users_by_statement(statement)
|
51
|
+
|
52
|
+
if page[:results]
|
53
|
+
# Increase query offset by page size.
|
54
|
+
offset += PAGE_SIZE
|
55
|
+
|
56
|
+
# Get the start index for printout.
|
57
|
+
start_index = page[:start_index]
|
58
|
+
|
59
|
+
# Print details about each user in results page.
|
60
|
+
page[:results].each_with_index do |user, index|
|
61
|
+
puts "%d) User ID: %d, name: %s, email: %s" %
|
62
|
+
[index + start_index, user[:id], user[:name], user[:email]]
|
63
|
+
end
|
64
|
+
end
|
65
|
+
end while offset < page[:total_result_set_size]
|
66
|
+
|
67
|
+
# Print a footer
|
68
|
+
if page.include?(:total_result_set_size)
|
69
|
+
puts "Total number of users: %d" % page[:total_result_set_size]
|
70
|
+
end
|
71
|
+
end
|
72
|
+
|
73
|
+
if __FILE__ == $0
|
74
|
+
begin
|
75
|
+
get_all_users()
|
76
|
+
|
77
|
+
# HTTP errors.
|
78
|
+
rescue AdsCommon::Errors::HttpError => e
|
79
|
+
puts "HTTP Error: %s" % e
|
80
|
+
|
81
|
+
# API errors.
|
82
|
+
rescue DfpApi::Errors::ApiException => e
|
83
|
+
puts "Message: %s" % e.message
|
84
|
+
puts 'Errors:'
|
85
|
+
e.errors.each_with_index do |error, index|
|
86
|
+
puts "\tError [%d]:" % (index + 1)
|
87
|
+
error.each do |field, value|
|
88
|
+
puts "\t\t%s: %s" % [field, value]
|
89
|
+
end
|
90
|
+
end
|
91
|
+
end
|
92
|
+
end
|
@@ -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 = :v201107
|
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 = :v201107
|
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
|