google-dfp-api 0.2.0
Sign up to get free protection for your applications and to get access to all the features.
- data/COPYING +201 -0
- data/ChangeLog +10 -0
- data/README +210 -0
- data/Rakefile +83 -0
- data/examples/v201101/common/error_handling.rb +76 -0
- data/examples/v201101/company_service/create_companies.rb +82 -0
- data/examples/v201101/company_service/get_all_companies.rb +92 -0
- data/examples/v201101/company_service/get_companies_by_statement.rb +88 -0
- data/examples/v201101/company_service/get_company.rb +72 -0
- data/examples/v201101/company_service/update_companies.rb +95 -0
- data/examples/v201101/creative_service/copy_image_creatives.rb +117 -0
- data/examples/v201101/creative_service/create_creatives.rb +109 -0
- data/examples/v201101/creative_service/get_all_creatives.rb +93 -0
- data/examples/v201101/creative_service/get_creative.rb +72 -0
- data/examples/v201101/creative_service/get_creatives_by_statement.rb +87 -0
- data/examples/v201101/creative_service/update_creatives.rb +98 -0
- data/examples/v201101/custom_targeting_service/create_custom_targeting_keys_and_values.rb +118 -0
- data/examples/v201101/custom_targeting_service/delete_custom_targeting_keys.rb +121 -0
- data/examples/v201101/custom_targeting_service/delete_custom_targeting_values.rb +125 -0
- data/examples/v201101/custom_targeting_service/get_all_custom_targeting_keys_and_values.rb +148 -0
- data/examples/v201101/custom_targeting_service/get_custom_targeting_keys_by_statement.rb +92 -0
- data/examples/v201101/custom_targeting_service/get_custom_targeting_values_by_statement.rb +98 -0
- data/examples/v201101/custom_targeting_service/update_custom_targeting_keys.rb +94 -0
- data/examples/v201101/custom_targeting_service/update_custom_targeting_values.rb +106 -0
- data/examples/v201101/forecast_service/get_forecast.rb +103 -0
- data/examples/v201101/forecast_service/get_forecast_by_id.rb +80 -0
- data/examples/v201101/inventory_service/create_ad_units.rb +98 -0
- data/examples/v201101/inventory_service/deactivate_ad_units.rb +119 -0
- data/examples/v201101/inventory_service/get_ad_unit.rb +72 -0
- data/examples/v201101/inventory_service/get_ad_units_by_statement.rb +96 -0
- data/examples/v201101/inventory_service/get_all_ad_units.rb +93 -0
- data/examples/v201101/inventory_service/update_ad_units.rb +94 -0
- data/examples/v201101/line_item_creative_association_service/create_licas.rb +94 -0
- data/examples/v201101/line_item_creative_association_service/deactivate_licas.rb +127 -0
- data/examples/v201101/line_item_creative_association_service/get_all_licas.rb +95 -0
- data/examples/v201101/line_item_creative_association_service/get_lica.rb +77 -0
- data/examples/v201101/line_item_creative_association_service/get_licas_by_statement.rb +91 -0
- data/examples/v201101/line_item_creative_association_service/update_licas.rb +92 -0
- data/examples/v201101/line_item_service/activate_line_items.rb +131 -0
- data/examples/v201101/line_item_service/create_line_items.rb +141 -0
- data/examples/v201101/line_item_service/get_all_line_items.rb +94 -0
- data/examples/v201101/line_item_service/get_line_item.rb +74 -0
- data/examples/v201101/line_item_service/get_line_items_by_statement.rb +89 -0
- data/examples/v201101/line_item_service/target_custom_criteria.rb +135 -0
- data/examples/v201101/line_item_service/update_line_items.rb +110 -0
- data/examples/v201101/network_service/get_all_networks.rb +74 -0
- data/examples/v201101/network_service/get_current_network.rb +66 -0
- data/examples/v201101/order_service/approve_orders.rb +116 -0
- data/examples/v201101/order_service/create_orders.rb +93 -0
- data/examples/v201101/order_service/get_all_orders.rb +93 -0
- data/examples/v201101/order_service/get_order.rb +74 -0
- data/examples/v201101/order_service/get_orders_by_statement.rb +90 -0
- data/examples/v201101/order_service/update_orders.rb +95 -0
- data/examples/v201101/placement_service/create_placements.rb +128 -0
- data/examples/v201101/placement_service/deactivate_placements.rb +118 -0
- data/examples/v201101/placement_service/get_all_placements.rb +93 -0
- data/examples/v201101/placement_service/get_placement.rb +74 -0
- data/examples/v201101/placement_service/get_placements_by_statement.rb +86 -0
- data/examples/v201101/placement_service/update_placements.rb +96 -0
- data/examples/v201101/publisher_query_language_service/get_all_cities.rb +85 -0
- data/examples/v201101/publisher_query_language_service/get_all_countries.rb +85 -0
- data/examples/v201101/publisher_query_language_service/get_all_metros.rb +85 -0
- data/examples/v201101/publisher_query_language_service/get_all_regions.rb +85 -0
- data/examples/v201101/report_service/download_report.rb +81 -0
- data/examples/v201101/report_service/run_delivery_report.rb +89 -0
- data/examples/v201101/report_service/run_inventory_report.rb +90 -0
- data/examples/v201101/report_service/run_sales_report.rb +89 -0
- data/examples/v201101/user_service/create_users.rb +89 -0
- data/examples/v201101/user_service/deactivate_users.rb +99 -0
- data/examples/v201101/user_service/get_all_roles.rb +73 -0
- data/examples/v201101/user_service/get_all_users.rb +92 -0
- data/examples/v201101/user_service/get_user.rb +73 -0
- data/examples/v201101/user_service/get_users_by_statement.rb +79 -0
- data/examples/v201101/user_service/update_users.rb +89 -0
- data/lib/dfp_api.rb +142 -0
- data/lib/dfp_api/api_config.rb +126 -0
- data/lib/dfp_api/credential_handler.rb +60 -0
- data/lib/dfp_api/errors.rb +59 -0
- data/lib/dfp_api/extensions.rb +54 -0
- data/lib/dfp_api/v201101/company_service.rb +52 -0
- data/lib/dfp_api/v201101/company_service_registry.rb +37 -0
- data/lib/dfp_api/v201101/creative_service.rb +52 -0
- data/lib/dfp_api/v201101/creative_service_registry.rb +37 -0
- data/lib/dfp_api/v201101/custom_targeting_service.rb +60 -0
- data/lib/dfp_api/v201101/custom_targeting_service_registry.rb +37 -0
- data/lib/dfp_api/v201101/forecast_service.rb +36 -0
- data/lib/dfp_api/v201101/forecast_service_registry.rb +37 -0
- data/lib/dfp_api/v201101/inventory_service.rb +56 -0
- data/lib/dfp_api/v201101/inventory_service_registry.rb +37 -0
- data/lib/dfp_api/v201101/line_item_creative_association_service.rb +56 -0
- data/lib/dfp_api/v201101/line_item_creative_association_service_registry.rb +37 -0
- data/lib/dfp_api/v201101/line_item_service.rb +56 -0
- data/lib/dfp_api/v201101/line_item_service_registry.rb +37 -0
- data/lib/dfp_api/v201101/network_service.rb +40 -0
- data/lib/dfp_api/v201101/network_service_registry.rb +37 -0
- data/lib/dfp_api/v201101/order_service.rb +56 -0
- data/lib/dfp_api/v201101/order_service_registry.rb +37 -0
- data/lib/dfp_api/v201101/placement_service.rb +56 -0
- data/lib/dfp_api/v201101/placement_service_registry.rb +37 -0
- data/lib/dfp_api/v201101/publisher_query_language_service.rb +32 -0
- data/lib/dfp_api/v201101/publisher_query_language_service_registry.rb +37 -0
- data/lib/dfp_api/v201101/report_service.rb +40 -0
- data/lib/dfp_api/v201101/report_service_registry.rb +37 -0
- data/lib/dfp_api/v201101/user_service.rb +60 -0
- data/lib/dfp_api/v201101/user_service_registry.rb +37 -0
- metadata +204 -0
@@ -0,0 +1,76 @@
|
|
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 runs incorrect query and demonstrates how to handle errors.
|
21
|
+
#
|
22
|
+
# Tags: UserService.updateUser
|
23
|
+
|
24
|
+
require 'rubygems'
|
25
|
+
require 'dfp_api'
|
26
|
+
|
27
|
+
API_VERSION = :v201101
|
28
|
+
|
29
|
+
def produce_api_error()
|
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
|
+
# Omitting "id" field here to produce an error.
|
41
|
+
user = {:preferred_locale => 'en_UK', :name => 'foo_bar'}
|
42
|
+
|
43
|
+
# Execute request and get the response, this should raise an exception.
|
44
|
+
user = user_service.update_user(user)
|
45
|
+
|
46
|
+
# Output retrieved data.
|
47
|
+
puts "User ID: %d, name: %s, email: %s" %
|
48
|
+
[user[:id], user[:name], user[:email]]
|
49
|
+
end
|
50
|
+
|
51
|
+
if __FILE__ == $0
|
52
|
+
begin
|
53
|
+
# This function should produce an exception for demo.
|
54
|
+
produce_api_error()
|
55
|
+
|
56
|
+
# One of two kinds of exception might occur, general HTTP error like 403 or
|
57
|
+
# 404 and DFP API error defined in WSDL and described in documentation.
|
58
|
+
|
59
|
+
# Handling HTTP errors.
|
60
|
+
rescue AdsCommon::Errors::HttpError => e
|
61
|
+
puts "HTTP Error: %s" % e
|
62
|
+
|
63
|
+
# Handling API errors.
|
64
|
+
rescue DfpApi::Errors::ApiException => e
|
65
|
+
# Standard DFP API error includes message and array of errors occured.
|
66
|
+
puts "Message: %s" % e.message
|
67
|
+
puts 'Errors:'
|
68
|
+
# Print out each of the errors.
|
69
|
+
e.errors.each_with_index do |error, index|
|
70
|
+
puts "\tError [%d]:" % (index + 1)
|
71
|
+
error.each do |field, value|
|
72
|
+
puts "\t\t%s: %s" % [field, value]
|
73
|
+
end
|
74
|
+
end
|
75
|
+
end
|
76
|
+
end
|
@@ -0,0 +1,82 @@
|
|
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 companies. To determine which companies exist, run
|
21
|
+
# get_all_companies.java.
|
22
|
+
|
23
|
+
# Tags: CompanyService.createCompanies
|
24
|
+
|
25
|
+
require 'rubygems'
|
26
|
+
require 'dfp_api'
|
27
|
+
|
28
|
+
API_VERSION = :v201101
|
29
|
+
# Number of companies to create.
|
30
|
+
ITEM_COUNT = 5
|
31
|
+
|
32
|
+
def create_companies()
|
33
|
+
# Get DfpApi instance and load configuration from ~/dfp_api.yml.
|
34
|
+
dfp = DfpApi::Api.new
|
35
|
+
|
36
|
+
# To enable logging of SOAP requests, set the log_level value to 'DEBUG' in
|
37
|
+
# the configuration file or provide your own logger:
|
38
|
+
# dfp.logger = Logger.new('dfp_xml.log')
|
39
|
+
|
40
|
+
# Get the CompanyService.
|
41
|
+
company_service = dfp.service(:CompanyService, API_VERSION)
|
42
|
+
|
43
|
+
# Create an array to store local company objects.
|
44
|
+
companies = Array.new
|
45
|
+
ITEM_COUNT.times do |index|
|
46
|
+
companies << {:name => "Advertiser #%d" % index, :type => 'ADVERTISER'}
|
47
|
+
end
|
48
|
+
|
49
|
+
# Create the companies on the server.
|
50
|
+
return_companies = company_service.create_companies(companies)
|
51
|
+
|
52
|
+
if return_companies
|
53
|
+
return_companies.each do |company|
|
54
|
+
puts "Company with ID: %d, name: %s and type: %s was created." %
|
55
|
+
[company[:id], company[:name], company[:type]]
|
56
|
+
end
|
57
|
+
else
|
58
|
+
raise 'No companies were created.'
|
59
|
+
end
|
60
|
+
|
61
|
+
end
|
62
|
+
|
63
|
+
if __FILE__ == $0
|
64
|
+
begin
|
65
|
+
create_companies()
|
66
|
+
|
67
|
+
# HTTP errors.
|
68
|
+
rescue AdsCommon::Errors::HttpError => e
|
69
|
+
puts "HTTP Error: %s" % e
|
70
|
+
|
71
|
+
# API errors.
|
72
|
+
rescue DfpApi::Errors::ApiException => e
|
73
|
+
puts "Message: %s" % e.message
|
74
|
+
puts 'Errors:'
|
75
|
+
e.errors.each_with_index do |error, index|
|
76
|
+
puts "\tError [%d]:" % (index + 1)
|
77
|
+
error.each do |field, value|
|
78
|
+
puts "\t\t%s: %s" % [field, value]
|
79
|
+
end
|
80
|
+
end
|
81
|
+
end
|
82
|
+
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 companies. To create companies, run create_companies.rb.
|
21
|
+
#
|
22
|
+
# Tags: CompanyService.getCompaniesByStatement
|
23
|
+
|
24
|
+
require 'rubygems'
|
25
|
+
require 'dfp_api'
|
26
|
+
|
27
|
+
API_VERSION = :v201101
|
28
|
+
PAGE_SIZE = 500
|
29
|
+
|
30
|
+
def get_all_companies()
|
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 CompanyService.
|
39
|
+
company_service = dfp.service(:CompanyService, API_VERSION)
|
40
|
+
|
41
|
+
# Define initial values.
|
42
|
+
offset = 0
|
43
|
+
page = Hash.new
|
44
|
+
|
45
|
+
begin
|
46
|
+
# Create a statement to get one page with current offset.
|
47
|
+
statement = {:query => "LIMIT %d OFFSET %d" % [PAGE_SIZE, offset]}
|
48
|
+
|
49
|
+
# Get companies by statement.
|
50
|
+
page = company_service.get_companies_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 company in results.
|
60
|
+
page[:results].each_with_index do |company, index|
|
61
|
+
puts "%d) Company ID: %d, name: %s, type: %s" %
|
62
|
+
[index + start_index, company[:id], company[:name], company[:type]]
|
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 companies: %d" % page[:total_result_set_size]
|
70
|
+
end
|
71
|
+
end
|
72
|
+
|
73
|
+
if __FILE__ == $0
|
74
|
+
begin
|
75
|
+
get_all_companies()
|
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,88 @@
|
|
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 companies that are advertisers. The statement retrieves
|
21
|
+
# up to the maximum page size limit of 500. To create companies, run
|
22
|
+
# create_companies.rb.
|
23
|
+
#
|
24
|
+
# Tags: CompanyService.getCompaniesByStatement
|
25
|
+
|
26
|
+
require 'rubygems'
|
27
|
+
require 'dfp_api'
|
28
|
+
|
29
|
+
API_VERSION = :v201101
|
30
|
+
|
31
|
+
def get_companies_by_statement()
|
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 CompanyService.
|
40
|
+
company_service = dfp.service(:CompanyService, API_VERSION)
|
41
|
+
|
42
|
+
# Create a statement to only select companies that are advertisers, sorted by
|
43
|
+
# name.
|
44
|
+
statement = {
|
45
|
+
:query => 'WHERE type = :type ORDER BY name LIMIT 500',
|
46
|
+
:values => [
|
47
|
+
{:key => 'type',
|
48
|
+
:value => {:value => 'ADVERTISER', :xsi_type => 'TextValue'}}
|
49
|
+
]
|
50
|
+
}
|
51
|
+
|
52
|
+
# Get companies by statement.
|
53
|
+
page = company_service.get_companies_by_statement(statement)
|
54
|
+
|
55
|
+
if page[:results]
|
56
|
+
# Print details about each company in results.
|
57
|
+
page[:results].each_with_index do |company, index|
|
58
|
+
puts "%d) [%d] name: %s, type: %s" %
|
59
|
+
[index, company[:id], company[:name], company[:type]]
|
60
|
+
end
|
61
|
+
end
|
62
|
+
|
63
|
+
# Print a footer.
|
64
|
+
if page.include?(:total_result_set_size)
|
65
|
+
puts "Total number of companies: %d" % page[:total_result_set_size]
|
66
|
+
end
|
67
|
+
end
|
68
|
+
|
69
|
+
if __FILE__ == $0
|
70
|
+
begin
|
71
|
+
get_companies_by_statement()
|
72
|
+
|
73
|
+
# HTTP errors.
|
74
|
+
rescue AdsCommon::Errors::HttpError => e
|
75
|
+
puts "HTTP Error: %s" % e
|
76
|
+
|
77
|
+
# API errors.
|
78
|
+
rescue DfpApi::Errors::ApiException => e
|
79
|
+
puts "Message: %s" % e.message
|
80
|
+
puts 'Errors:'
|
81
|
+
e.errors.each_with_index do |error, index|
|
82
|
+
puts "\tError [%d]:" % (index + 1)
|
83
|
+
error.each do |field, value|
|
84
|
+
puts "\t\t%s: %s" % [field, value]
|
85
|
+
end
|
86
|
+
end
|
87
|
+
end
|
88
|
+
end
|
@@ -0,0 +1,72 @@
|
|
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 company by its ID. To determine which companies exist, run
|
21
|
+
# get_all_companies.rb.
|
22
|
+
#
|
23
|
+
# Tags: CompanyService.getCompany
|
24
|
+
|
25
|
+
require 'rubygems'
|
26
|
+
require 'dfp_api'
|
27
|
+
|
28
|
+
API_VERSION = :v201101
|
29
|
+
|
30
|
+
def get_company()
|
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 CompanyService.
|
39
|
+
company_service = dfp.service(:CompanyService, API_VERSION)
|
40
|
+
|
41
|
+
# Set the ID of the company to get.
|
42
|
+
company_id = 'INSERT_COMPANY_ID_HERE'.to_i
|
43
|
+
|
44
|
+
# Get the company.
|
45
|
+
company = company_service.get_company(company_id)
|
46
|
+
|
47
|
+
if company
|
48
|
+
puts "Company with ID: %d, name: %s and type: %s was found." %
|
49
|
+
[company[:id], company[:name], company[:type]]
|
50
|
+
end
|
51
|
+
end
|
52
|
+
|
53
|
+
if __FILE__ == $0
|
54
|
+
begin
|
55
|
+
get_company()
|
56
|
+
|
57
|
+
# HTTP errors.
|
58
|
+
rescue AdsCommon::Errors::HttpError => e
|
59
|
+
puts "HTTP Error: %s" % e
|
60
|
+
|
61
|
+
# API errors.
|
62
|
+
rescue DfpApi::Errors::ApiException => e
|
63
|
+
puts "Message: %s" % e.message
|
64
|
+
puts 'Errors:'
|
65
|
+
e.errors.each_with_index do |error, index|
|
66
|
+
puts "\tError [%d]:" % (index + 1)
|
67
|
+
error.each do |field, value|
|
68
|
+
puts "\t\t%s: %s" % [field, value]
|
69
|
+
end
|
70
|
+
end
|
71
|
+
end
|
72
|
+
end
|
@@ -0,0 +1,95 @@
|
|
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 the names of all companies that are advertisers by
|
21
|
+
# appending "LLC." up to the first 500. To determine which companies exist, run
|
22
|
+
# get_all_companies.rb
|
23
|
+
#
|
24
|
+
# Tags: CompanyService.updateCompanies
|
25
|
+
|
26
|
+
require 'rubygems'
|
27
|
+
require 'dfp_api'
|
28
|
+
|
29
|
+
API_VERSION = :v201101
|
30
|
+
|
31
|
+
def update_companies()
|
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 CompanyService.
|
40
|
+
company_service = dfp.service(:CompanyService, API_VERSION)
|
41
|
+
|
42
|
+
# Create a statement to only select companies that are advertisers.
|
43
|
+
statement = {
|
44
|
+
:query => "WHERE type = :type LIMIT 500",
|
45
|
+
:values => [
|
46
|
+
{:key => 'type',
|
47
|
+
:value => {:value => 'ADVERTISER', :xsi_type => 'TextValue'}}
|
48
|
+
]
|
49
|
+
}
|
50
|
+
|
51
|
+
# Get companies by statement.
|
52
|
+
page = company_service.get_companies_by_statement(statement)
|
53
|
+
|
54
|
+
if page[:results]
|
55
|
+
companies = page[:results]
|
56
|
+
|
57
|
+
# Update each local company object by appending ' LLC.' to its name.
|
58
|
+
companies.each {|company| company[:name] += ' LLC.'}
|
59
|
+
|
60
|
+
# Update the companies on the server.
|
61
|
+
return_companies = company_service.update_companies(companies)
|
62
|
+
|
63
|
+
if return_companies
|
64
|
+
return_companies.each do |company|
|
65
|
+
puts "A company with ID [%d], name: %s and type %s was updated." %
|
66
|
+
[company[:id], company[:name], company[:type]]
|
67
|
+
end
|
68
|
+
else
|
69
|
+
raise 'No companies were updated.'
|
70
|
+
end
|
71
|
+
else
|
72
|
+
puts 'No companies found to update.'
|
73
|
+
end
|
74
|
+
end
|
75
|
+
|
76
|
+
if __FILE__ == $0
|
77
|
+
begin
|
78
|
+
update_companies()
|
79
|
+
|
80
|
+
# HTTP errors.
|
81
|
+
rescue AdsCommon::Errors::HttpError => e
|
82
|
+
puts "HTTP Error: %s" % e
|
83
|
+
|
84
|
+
# API errors.
|
85
|
+
rescue DfpApi::Errors::ApiException => e
|
86
|
+
puts "Message: %s" % e.message
|
87
|
+
puts 'Errors:'
|
88
|
+
e.errors.each_with_index do |error, index|
|
89
|
+
puts "\tError [%d]:" % (index + 1)
|
90
|
+
error.each do |field, value|
|
91
|
+
puts "\t\t%s: %s" % [field, value]
|
92
|
+
end
|
93
|
+
end
|
94
|
+
end
|
95
|
+
end
|