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,117 @@
|
|
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 copies a given set of image creatives. This would typically be
|
21
|
+
# done to reuse creatives in a small business network. To determine which
|
22
|
+
# creatives exist, run get_all_creatives.rb.
|
23
|
+
#
|
24
|
+
# Tags: CreativeService.getCreativesByStatement, CreativeService.createCreatives
|
25
|
+
|
26
|
+
require 'rubygems'
|
27
|
+
require 'dfp_api'
|
28
|
+
|
29
|
+
require 'base64'
|
30
|
+
|
31
|
+
API_VERSION = :v201101
|
32
|
+
|
33
|
+
def copy_image_creatives()
|
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 CreativeService.
|
42
|
+
creative_service = dfp.service(:CreativeService, API_VERSION)
|
43
|
+
|
44
|
+
# Create a list of creative ids to copy.
|
45
|
+
image_creative_ids = [
|
46
|
+
'INSERT_IMAGE_CREATIVE_ID_HERE'.to_i,
|
47
|
+
'INSERT_IMAGE_CREATIVE_ID_HERE'.to_i,
|
48
|
+
'INSERT_IMAGE_CREATIVE_ID_HERE'.to_i,
|
49
|
+
'INSERT_IMAGE_CREATIVE_ID_HERE'.to_i
|
50
|
+
]
|
51
|
+
|
52
|
+
# Create the statement to filter image creatives by ID.
|
53
|
+
statement = {
|
54
|
+
:query => "WHERE id IN (%s) AND creativeType = :creative_type" %
|
55
|
+
image_creative_ids.join(', '),
|
56
|
+
:values => [
|
57
|
+
{:key => 'creative_type',
|
58
|
+
:value => {:value => 'ImageCreative', :xsi_type => 'TextValue'}}
|
59
|
+
]
|
60
|
+
}
|
61
|
+
|
62
|
+
# Get creatives by statement.
|
63
|
+
page = creative_service.get_creatives_by_statement(statement)
|
64
|
+
|
65
|
+
if page[:results]
|
66
|
+
creatives = page[:results]
|
67
|
+
|
68
|
+
# Copy each local creative object and change its name.
|
69
|
+
new_creatives = creatives.map do |creative|
|
70
|
+
new_creative = creative.dup()
|
71
|
+
old_id = new_creative.delete(:id)
|
72
|
+
new_creative[:name] += " (Copy of %d)" % old_id
|
73
|
+
image_url = new_creative.delete(:image_url)
|
74
|
+
new_creative[:image_byte_array] =
|
75
|
+
Base64.encode64(AdsCommon::Http.get(image_url))
|
76
|
+
# Savon doesn't get us xsi_type back yet so we have to specify it.
|
77
|
+
new_creative[:xsi_type] = 'ImageCreative'
|
78
|
+
new_creative
|
79
|
+
end
|
80
|
+
|
81
|
+
# Create the creatives on the server.
|
82
|
+
return_creatives = creative_service.create_creatives(new_creatives)
|
83
|
+
|
84
|
+
# Display copied creatives.
|
85
|
+
if return_creatives
|
86
|
+
return_creatives.each_with_index do |creative, index|
|
87
|
+
puts "A creative with ID [%d] was copied to ID [%d], name: %s" %
|
88
|
+
[creatives[index][:id], creative[:id], creative[:name]]
|
89
|
+
end
|
90
|
+
else
|
91
|
+
raise 'No creatives were copied.'
|
92
|
+
end
|
93
|
+
else
|
94
|
+
puts 'No creatives found to copy.'
|
95
|
+
end
|
96
|
+
end
|
97
|
+
|
98
|
+
if __FILE__ == $0
|
99
|
+
begin
|
100
|
+
copy_image_creatives()
|
101
|
+
|
102
|
+
# HTTP errors.
|
103
|
+
rescue AdsCommon::Errors::HttpError => e
|
104
|
+
puts "HTTP Error: %s" % e
|
105
|
+
|
106
|
+
# API errors.
|
107
|
+
rescue DfpApi::Errors::ApiException => e
|
108
|
+
puts "Message: %s" % e.message
|
109
|
+
puts 'Errors:'
|
110
|
+
e.errors.each_with_index do |error, index|
|
111
|
+
puts "\tError [%d]:" % (index + 1)
|
112
|
+
error.each do |field, value|
|
113
|
+
puts "\t\t%s: %s" % [field, value]
|
114
|
+
end
|
115
|
+
end
|
116
|
+
end
|
117
|
+
end
|
@@ -0,0 +1,109 @@
|
|
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 image creatives for a given advertiser. To determine
|
21
|
+
# which companies are advertisers, run get_companies_by_statement.rb. To
|
22
|
+
# determine which creatives already exist, run get_all_creatives.rb.
|
23
|
+
#
|
24
|
+
# Tags: CreativeService.createCreatives
|
25
|
+
|
26
|
+
require 'rubygems'
|
27
|
+
require 'base64'
|
28
|
+
require 'dfp_api'
|
29
|
+
|
30
|
+
API_VERSION = :v201101
|
31
|
+
# Number of creatives to create.
|
32
|
+
ITEM_COUNT = 5
|
33
|
+
|
34
|
+
def create_creatives()
|
35
|
+
# Get DfpApi instance and load configuration from ~/dfp_api.yml.
|
36
|
+
dfp = DfpApi::Api.new
|
37
|
+
|
38
|
+
# To enable logging of SOAP requests, set the log_level value to 'DEBUG' in
|
39
|
+
# the configuration file or provide your own logger:
|
40
|
+
# dfp.logger = Logger.new('dfp_xml.log')
|
41
|
+
|
42
|
+
# Get the CreativeService.
|
43
|
+
creative_service = dfp.service(:CreativeService, API_VERSION)
|
44
|
+
|
45
|
+
# Set the ID of the advertiser (company) that all creatives will be assigned
|
46
|
+
# to.
|
47
|
+
advertiser_id = 'INSERT_ADVERTISER_COMPANY_ID_HERE'.to_i
|
48
|
+
|
49
|
+
# Prepare image data for creative.
|
50
|
+
image_url =
|
51
|
+
'http://www.google.com/intl/en/adwords/select/images/samples/inline.jpg'
|
52
|
+
image_data = AdsCommon::Http.get(image_url)
|
53
|
+
image_data_base64 = Base64.encode64(image_data)
|
54
|
+
|
55
|
+
# Create an array to store local creative objects.
|
56
|
+
creatives = Array.new
|
57
|
+
ITEM_COUNT.times do |index|
|
58
|
+
creatives << {
|
59
|
+
:xsi_type => 'ImageCreative',
|
60
|
+
:name => "Image creative #%d" % index,
|
61
|
+
:advertiser_id => advertiser_id,
|
62
|
+
:destination_url => 'http://www.google.com',
|
63
|
+
:image_name => 'image.jpg',
|
64
|
+
:size => {:width => 300, :height => 250, :is_aspect_ratio => false},
|
65
|
+
:image_byte_array => image_data_base64
|
66
|
+
}
|
67
|
+
end
|
68
|
+
|
69
|
+
# Create the creatives on the server.
|
70
|
+
return_creatives = creative_service.create_creatives(creatives)
|
71
|
+
|
72
|
+
if return_creatives
|
73
|
+
return_creatives.each do |creative|
|
74
|
+
if creative[:creative_type] == 'ImageCreative'
|
75
|
+
puts ("Image creative with ID: %d, name: %s, size: %dx%d was " +
|
76
|
+
"created and can be previewed at: [%s]") %
|
77
|
+
[creative[:id], creative[:name],
|
78
|
+
creative[:size][:width], creative[:size][:height],
|
79
|
+
creative[:preview_url]]
|
80
|
+
else
|
81
|
+
puts "Creative with ID: %d, name: %s and type: %s was created." %
|
82
|
+
[creative[:id], creative[:name], creative[:creative_type]]
|
83
|
+
end
|
84
|
+
end
|
85
|
+
else
|
86
|
+
raise 'No creatives were created.'
|
87
|
+
end
|
88
|
+
end
|
89
|
+
|
90
|
+
if __FILE__ == $0
|
91
|
+
begin
|
92
|
+
create_creatives()
|
93
|
+
|
94
|
+
# HTTP errors.
|
95
|
+
rescue AdsCommon::Errors::HttpError => e
|
96
|
+
puts "HTTP Error: %s" % e
|
97
|
+
|
98
|
+
# API errors.
|
99
|
+
rescue DfpApi::Errors::ApiException => e
|
100
|
+
puts "Message: %s" % e.message
|
101
|
+
puts 'Errors:'
|
102
|
+
e.errors.each_with_index do |error, index|
|
103
|
+
puts "\tError [%d]:" % (index + 1)
|
104
|
+
error.each do |field, value|
|
105
|
+
puts "\t\t%s: %s" % [field, value]
|
106
|
+
end
|
107
|
+
end
|
108
|
+
end
|
109
|
+
end
|
@@ -0,0 +1,93 @@
|
|
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 creatives. To create creatives, run create_creatives.rb.
|
21
|
+
#
|
22
|
+
# Tags: CreativeService.getCreativesByStatement
|
23
|
+
|
24
|
+
require 'rubygems'
|
25
|
+
require 'dfp_api'
|
26
|
+
|
27
|
+
API_VERSION = :v201101
|
28
|
+
PAGE_SIZE = 500
|
29
|
+
|
30
|
+
def get_all_creatives()
|
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 CreativeService.
|
39
|
+
creative_service = dfp.service(:CreativeService, 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 creatives by statement.
|
50
|
+
page = creative_service.get_creatives_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 creative in results.
|
60
|
+
page[:results].each_with_index do |creative, index|
|
61
|
+
puts "%d) Creative ID: %d, name: %s, type: %s" %
|
62
|
+
[index + start_index, creative[:id],
|
63
|
+
creative[:name], creative[:type]]
|
64
|
+
end
|
65
|
+
end
|
66
|
+
end while offset < page[:total_result_set_size]
|
67
|
+
|
68
|
+
# Print a footer.
|
69
|
+
if page.include?(:total_result_set_size)
|
70
|
+
puts "Total number of creatives: %d" % page[:total_result_set_size]
|
71
|
+
end
|
72
|
+
end
|
73
|
+
|
74
|
+
if __FILE__ == $0
|
75
|
+
begin
|
76
|
+
get_all_creatives()
|
77
|
+
|
78
|
+
# HTTP errors.
|
79
|
+
rescue AdsCommon::Errors::HttpError => e
|
80
|
+
puts "HTTP Error: %s" % e
|
81
|
+
|
82
|
+
# API errors.
|
83
|
+
rescue DfpApi::Errors::ApiException => e
|
84
|
+
puts "Message: %s" % e.message
|
85
|
+
puts 'Errors:'
|
86
|
+
e.errors.each_with_index do |error, index|
|
87
|
+
puts "\tError [%d]:" % (index + 1)
|
88
|
+
error.each do |field, value|
|
89
|
+
puts "\t\t%s: %s" % [field, value]
|
90
|
+
end
|
91
|
+
end
|
92
|
+
end
|
93
|
+
end
|
@@ -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 creative by its ID. To determine which creatives exist,
|
21
|
+
# run get_all_creatives.rb.
|
22
|
+
#
|
23
|
+
# Tags: CreativeService.getCreative
|
24
|
+
|
25
|
+
require 'rubygems'
|
26
|
+
require 'dfp_api'
|
27
|
+
|
28
|
+
API_VERSION = :v201101
|
29
|
+
|
30
|
+
def get_creative()
|
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 CreativeService.
|
39
|
+
creative_service = dfp.service(:CreativeService, API_VERSION)
|
40
|
+
|
41
|
+
# Set the ID of the creative to get.
|
42
|
+
creative_id = 'INSERT_CREATIVE_ID_HERE'.to_i
|
43
|
+
|
44
|
+
# Get the creative.
|
45
|
+
creative = creative_service.get_creative(creative_id)
|
46
|
+
|
47
|
+
if creative
|
48
|
+
puts "Creative with ID: %d, name: %s and type: %s was found." %
|
49
|
+
[creative[:id], creative[:name], creative[:type]]
|
50
|
+
end
|
51
|
+
end
|
52
|
+
|
53
|
+
if __FILE__ == $0
|
54
|
+
begin
|
55
|
+
get_creative()
|
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,87 @@
|
|
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 image creatives. The statement retrieves up to the
|
21
|
+
# maximum page size limit of 500. To create an image creative, run
|
22
|
+
# create_creatives.rb.
|
23
|
+
#
|
24
|
+
# Tags: CreativeService.getCreativesByStatement
|
25
|
+
|
26
|
+
require 'rubygems'
|
27
|
+
require 'dfp_api'
|
28
|
+
|
29
|
+
API_VERSION = :v201101
|
30
|
+
|
31
|
+
def get_creatives_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 CreativeService.
|
40
|
+
creative_service = dfp.service(:CreativeService, API_VERSION)
|
41
|
+
|
42
|
+
# Create a statement to only select image creatives.
|
43
|
+
statement = {
|
44
|
+
:query => 'WHERE creativeType = :creative_type LIMIT 500',
|
45
|
+
:values => [
|
46
|
+
{:key => 'creative_type',
|
47
|
+
:value => {:value => 'ImageCreative', :xsi_type => 'TextValue'}}
|
48
|
+
]
|
49
|
+
}
|
50
|
+
|
51
|
+
# Get creatives by statement.
|
52
|
+
page = creative_service.get_creatives_by_statement(statement)
|
53
|
+
|
54
|
+
if page[:results]
|
55
|
+
# Print details about each creative in results.
|
56
|
+
page[:results].each_with_index do |creative, index|
|
57
|
+
puts "%d) Creative ID: %d, name: %s, type: %s" %
|
58
|
+
[index, creative[:id], creative[:name], creative[:type]]
|
59
|
+
end
|
60
|
+
end
|
61
|
+
|
62
|
+
# Print a footer.
|
63
|
+
if page.include?(:total_result_set_size)
|
64
|
+
puts "Total number of creatives: %d" % page[:total_result_set_size]
|
65
|
+
end
|
66
|
+
end
|
67
|
+
|
68
|
+
if __FILE__ == $0
|
69
|
+
begin
|
70
|
+
get_creatives_by_statement()
|
71
|
+
|
72
|
+
# HTTP errors.
|
73
|
+
rescue AdsCommon::Errors::HttpError => e
|
74
|
+
puts "HTTP Error: %s" % e
|
75
|
+
|
76
|
+
# API errors.
|
77
|
+
rescue DfpApi::Errors::ApiException => e
|
78
|
+
puts "Message: %s" % e.message
|
79
|
+
puts 'Errors:'
|
80
|
+
e.errors.each_with_index do |error, index|
|
81
|
+
puts "\tError [%d]:" % (index + 1)
|
82
|
+
error.each do |field, value|
|
83
|
+
puts "\t\t%s: %s" % [field, value]
|
84
|
+
end
|
85
|
+
end
|
86
|
+
end
|
87
|
+
end
|