google-dfp-api 0.2.0 → 0.2.1
Sign up to get free protection for your applications and to get access to all the features.
- data/ChangeLog +7 -1
- data/README +11 -11
- data/Rakefile +13 -11
- data/examples/v201103/common/error_handling.rb +76 -0
- data/examples/v201103/company_service/create_companies.rb +82 -0
- data/examples/v201103/company_service/get_all_companies.rb +92 -0
- data/examples/v201103/company_service/get_companies_by_statement.rb +88 -0
- data/examples/v201103/company_service/get_company.rb +72 -0
- data/examples/v201103/company_service/update_companies.rb +95 -0
- data/examples/v201103/creative_service/copy_image_creatives.rb +117 -0
- data/examples/v201103/creative_service/create_creatives.rb +109 -0
- data/examples/v201103/creative_service/get_all_creatives.rb +93 -0
- data/examples/v201103/creative_service/get_creative.rb +72 -0
- data/examples/v201103/creative_service/get_creatives_by_statement.rb +87 -0
- data/examples/v201103/creative_service/update_creatives.rb +98 -0
- data/examples/v201103/custom_targeting_service/create_custom_targeting_keys_and_values.rb +118 -0
- data/examples/v201103/custom_targeting_service/delete_custom_targeting_keys.rb +121 -0
- data/examples/v201103/custom_targeting_service/delete_custom_targeting_values.rb +125 -0
- data/examples/v201103/custom_targeting_service/get_all_custom_targeting_keys_and_values.rb +148 -0
- data/examples/v201103/custom_targeting_service/get_custom_targeting_keys_by_statement.rb +92 -0
- data/examples/v201103/custom_targeting_service/get_custom_targeting_values_by_statement.rb +98 -0
- data/examples/v201103/custom_targeting_service/update_custom_targeting_keys.rb +94 -0
- data/examples/v201103/custom_targeting_service/update_custom_targeting_values.rb +106 -0
- data/examples/v201103/forecast_service/get_forecast.rb +103 -0
- data/examples/v201103/forecast_service/get_forecast_by_id.rb +80 -0
- data/examples/v201103/inventory_service/create_ad_units.rb +98 -0
- data/examples/v201103/inventory_service/deactivate_ad_units.rb +119 -0
- data/examples/v201103/inventory_service/get_ad_unit.rb +72 -0
- data/examples/v201103/inventory_service/get_ad_units_by_statement.rb +96 -0
- data/examples/v201103/inventory_service/get_all_ad_units.rb +93 -0
- data/examples/v201103/inventory_service/update_ad_units.rb +94 -0
- data/examples/v201103/line_item_creative_association_service/create_licas.rb +94 -0
- data/examples/v201103/line_item_creative_association_service/deactivate_licas.rb +127 -0
- data/examples/v201103/line_item_creative_association_service/get_all_licas.rb +95 -0
- data/examples/v201103/line_item_creative_association_service/get_lica.rb +77 -0
- data/examples/v201103/line_item_creative_association_service/get_licas_by_statement.rb +91 -0
- data/examples/v201103/line_item_creative_association_service/update_licas.rb +92 -0
- data/examples/v201103/line_item_service/activate_line_items.rb +131 -0
- data/examples/v201103/line_item_service/create_line_items.rb +165 -0
- data/examples/v201103/line_item_service/get_all_line_items.rb +94 -0
- data/examples/v201103/line_item_service/get_line_item.rb +74 -0
- data/examples/v201103/line_item_service/get_line_items_by_statement.rb +89 -0
- data/examples/v201103/line_item_service/target_custom_criteria.rb +135 -0
- data/examples/v201103/line_item_service/update_line_items.rb +110 -0
- data/examples/v201103/network_service/get_all_networks.rb +74 -0
- data/examples/v201103/network_service/get_current_network.rb +66 -0
- data/examples/v201103/order_service/approve_orders.rb +116 -0
- data/examples/v201103/order_service/create_orders.rb +93 -0
- data/examples/v201103/order_service/get_all_orders.rb +93 -0
- data/examples/v201103/order_service/get_order.rb +74 -0
- data/examples/v201103/order_service/get_orders_by_statement.rb +90 -0
- data/examples/v201103/order_service/update_orders.rb +95 -0
- data/examples/v201103/placement_service/create_placements.rb +128 -0
- data/examples/v201103/placement_service/deactivate_placements.rb +118 -0
- data/examples/v201103/placement_service/get_all_placements.rb +93 -0
- data/examples/v201103/placement_service/get_placement.rb +74 -0
- data/examples/v201103/placement_service/get_placements_by_statement.rb +86 -0
- data/examples/v201103/placement_service/update_placements.rb +96 -0
- data/examples/v201103/publisher_query_language_service/get_all_cities.rb +85 -0
- data/examples/v201103/publisher_query_language_service/get_all_countries.rb +85 -0
- data/examples/v201103/publisher_query_language_service/get_all_metros.rb +85 -0
- data/examples/v201103/publisher_query_language_service/get_all_regions.rb +85 -0
- data/examples/v201103/report_service/download_report.rb +81 -0
- data/examples/v201103/report_service/run_delivery_report.rb +89 -0
- data/examples/v201103/report_service/run_inventory_report.rb +90 -0
- data/examples/v201103/report_service/run_sales_report.rb +89 -0
- data/examples/v201103/user_service/create_users.rb +89 -0
- data/examples/v201103/user_service/deactivate_users.rb +99 -0
- data/examples/v201103/user_service/get_all_roles.rb +73 -0
- data/examples/v201103/user_service/get_all_users.rb +92 -0
- data/examples/v201103/user_service/get_user.rb +73 -0
- data/examples/v201103/user_service/get_users_by_statement.rb +79 -0
- data/examples/v201103/user_service/update_users.rb +89 -0
- data/examples/v201104/common/error_handling.rb +76 -0
- data/examples/v201104/company_service/create_companies.rb +82 -0
- data/examples/v201104/company_service/get_all_companies.rb +92 -0
- data/examples/v201104/company_service/get_companies_by_statement.rb +88 -0
- data/examples/v201104/company_service/get_company.rb +72 -0
- data/examples/v201104/company_service/update_companies.rb +95 -0
- data/examples/v201104/creative_service/copy_image_creatives.rb +117 -0
- data/examples/v201104/creative_service/create_creatives.rb +109 -0
- data/examples/v201104/creative_service/get_all_creatives.rb +93 -0
- data/examples/v201104/creative_service/get_creative.rb +72 -0
- data/examples/v201104/creative_service/get_creatives_by_statement.rb +87 -0
- data/examples/v201104/creative_service/update_creatives.rb +98 -0
- data/examples/v201104/custom_targeting_service/create_custom_targeting_keys_and_values.rb +118 -0
- data/examples/v201104/custom_targeting_service/delete_custom_targeting_keys.rb +121 -0
- data/examples/v201104/custom_targeting_service/delete_custom_targeting_values.rb +125 -0
- data/examples/v201104/custom_targeting_service/get_all_custom_targeting_keys_and_values.rb +148 -0
- data/examples/v201104/custom_targeting_service/get_custom_targeting_keys_by_statement.rb +92 -0
- data/examples/v201104/custom_targeting_service/get_custom_targeting_values_by_statement.rb +98 -0
- data/examples/v201104/custom_targeting_service/update_custom_targeting_keys.rb +94 -0
- data/examples/v201104/custom_targeting_service/update_custom_targeting_values.rb +106 -0
- data/examples/v201104/forecast_service/get_forecast.rb +103 -0
- data/examples/v201104/forecast_service/get_forecast_by_id.rb +80 -0
- data/examples/v201104/inventory_service/create_ad_units.rb +98 -0
- data/examples/v201104/inventory_service/deactivate_ad_units.rb +119 -0
- data/examples/v201104/inventory_service/get_ad_unit.rb +72 -0
- data/examples/v201104/inventory_service/get_ad_units_by_statement.rb +96 -0
- data/examples/v201104/inventory_service/get_all_ad_units.rb +93 -0
- data/examples/v201104/inventory_service/update_ad_units.rb +94 -0
- data/examples/v201104/line_item_creative_association_service/create_licas.rb +94 -0
- data/examples/v201104/line_item_creative_association_service/deactivate_licas.rb +127 -0
- data/examples/v201104/line_item_creative_association_service/get_all_licas.rb +95 -0
- data/examples/v201104/line_item_creative_association_service/get_lica.rb +77 -0
- data/examples/v201104/line_item_creative_association_service/get_licas_by_statement.rb +91 -0
- data/examples/v201104/line_item_creative_association_service/update_licas.rb +92 -0
- data/examples/v201104/line_item_service/activate_line_items.rb +131 -0
- data/examples/v201104/line_item_service/create_line_items.rb +157 -0
- data/examples/v201104/line_item_service/get_all_line_items.rb +94 -0
- data/examples/v201104/line_item_service/get_line_item.rb +74 -0
- data/examples/v201104/line_item_service/get_line_items_by_statement.rb +89 -0
- data/examples/v201104/line_item_service/target_custom_criteria.rb +129 -0
- data/examples/v201104/line_item_service/update_line_items.rb +110 -0
- data/examples/v201104/network_service/get_all_networks.rb +74 -0
- data/examples/v201104/network_service/get_current_network.rb +66 -0
- data/examples/v201104/order_service/approve_orders.rb +116 -0
- data/examples/v201104/order_service/create_orders.rb +93 -0
- data/examples/v201104/order_service/get_all_orders.rb +93 -0
- data/examples/v201104/order_service/get_order.rb +74 -0
- data/examples/v201104/order_service/get_orders_by_statement.rb +90 -0
- data/examples/v201104/order_service/update_orders.rb +95 -0
- data/examples/v201104/placement_service/create_placements.rb +128 -0
- data/examples/v201104/placement_service/deactivate_placements.rb +118 -0
- data/examples/v201104/placement_service/get_all_placements.rb +93 -0
- data/examples/v201104/placement_service/get_placement.rb +74 -0
- data/examples/v201104/placement_service/get_placements_by_statement.rb +86 -0
- data/examples/v201104/placement_service/update_placements.rb +96 -0
- data/examples/v201104/publisher_query_language_service/get_all_cities.rb +85 -0
- data/examples/v201104/publisher_query_language_service/get_all_countries.rb +85 -0
- data/examples/v201104/publisher_query_language_service/get_all_metros.rb +85 -0
- data/examples/v201104/publisher_query_language_service/get_all_regions.rb +85 -0
- data/examples/v201104/report_service/download_report.rb +81 -0
- data/examples/v201104/report_service/run_delivery_report.rb +89 -0
- data/examples/v201104/report_service/run_inventory_report.rb +90 -0
- data/examples/v201104/report_service/run_sales_report.rb +89 -0
- data/examples/v201104/user_service/create_users.rb +89 -0
- data/examples/v201104/user_service/deactivate_users.rb +99 -0
- data/examples/v201104/user_service/get_all_roles.rb +73 -0
- data/examples/v201104/user_service/get_all_users.rb +92 -0
- data/examples/v201104/user_service/get_user.rb +73 -0
- data/examples/v201104/user_service/get_users_by_statement.rb +79 -0
- data/examples/v201104/user_service/update_users.rb +89 -0
- data/lib/dfp_api.rb +32 -45
- data/lib/dfp_api/api_config.rb +30 -7
- data/lib/dfp_api/v201101/company_service.rb +9 -9
- data/lib/dfp_api/v201101/company_service_registry.rb +3 -3
- data/lib/dfp_api/v201101/creative_service.rb +9 -9
- data/lib/dfp_api/v201101/creative_service_registry.rb +3 -3
- data/lib/dfp_api/v201101/custom_targeting_service.rb +9 -9
- data/lib/dfp_api/v201101/custom_targeting_service_registry.rb +3 -3
- data/lib/dfp_api/v201101/forecast_service.rb +5 -5
- data/lib/dfp_api/v201101/forecast_service_registry.rb +3 -3
- data/lib/dfp_api/v201101/inventory_service.rb +13 -13
- data/lib/dfp_api/v201101/inventory_service_registry.rb +3 -3
- data/lib/dfp_api/v201101/line_item_creative_association_service.rb +5 -5
- data/lib/dfp_api/v201101/line_item_creative_association_service_registry.rb +3 -3
- data/lib/dfp_api/v201101/line_item_service.rb +13 -13
- data/lib/dfp_api/v201101/line_item_service_registry.rb +3 -3
- data/lib/dfp_api/v201101/network_service.rb +5 -5
- data/lib/dfp_api/v201101/network_service_registry.rb +3 -3
- data/lib/dfp_api/v201101/order_service.rb +13 -13
- data/lib/dfp_api/v201101/order_service_registry.rb +3 -3
- data/lib/dfp_api/v201101/placement_service.rb +9 -9
- data/lib/dfp_api/v201101/placement_service_registry.rb +3 -3
- data/lib/dfp_api/v201101/publisher_query_language_service.rb +1 -1
- data/lib/dfp_api/v201101/publisher_query_language_service_registry.rb +3 -3
- data/lib/dfp_api/v201101/report_service.rb +5 -5
- data/lib/dfp_api/v201101/report_service_registry.rb +3 -3
- data/lib/dfp_api/v201101/user_service.rb +17 -17
- data/lib/dfp_api/v201101/user_service_registry.rb +3 -3
- data/lib/dfp_api/v201103/company_service.rb +52 -0
- data/lib/dfp_api/v201103/company_service_registry.rb +37 -0
- data/lib/dfp_api/v201103/creative_service.rb +52 -0
- data/lib/dfp_api/v201103/creative_service_registry.rb +37 -0
- data/lib/dfp_api/v201103/custom_targeting_service.rb +60 -0
- data/lib/dfp_api/v201103/custom_targeting_service_registry.rb +37 -0
- data/lib/dfp_api/v201103/forecast_service.rb +36 -0
- data/lib/dfp_api/v201103/forecast_service_registry.rb +37 -0
- data/lib/dfp_api/v201103/inventory_service.rb +56 -0
- data/lib/dfp_api/v201103/inventory_service_registry.rb +37 -0
- data/lib/dfp_api/v201103/line_item_creative_association_service.rb +56 -0
- data/lib/dfp_api/v201103/line_item_creative_association_service_registry.rb +37 -0
- data/lib/dfp_api/v201103/line_item_service.rb +56 -0
- data/lib/dfp_api/v201103/line_item_service_registry.rb +37 -0
- data/lib/dfp_api/v201103/network_service.rb +40 -0
- data/lib/dfp_api/v201103/network_service_registry.rb +37 -0
- data/lib/dfp_api/v201103/order_service.rb +56 -0
- data/lib/dfp_api/v201103/order_service_registry.rb +37 -0
- data/lib/dfp_api/v201103/placement_service.rb +56 -0
- data/lib/dfp_api/v201103/placement_service_registry.rb +37 -0
- data/lib/dfp_api/v201103/publisher_query_language_service.rb +32 -0
- data/lib/dfp_api/v201103/publisher_query_language_service_registry.rb +37 -0
- data/lib/dfp_api/v201103/report_service.rb +40 -0
- data/lib/dfp_api/v201103/report_service_registry.rb +37 -0
- data/lib/dfp_api/v201103/user_service.rb +60 -0
- data/lib/dfp_api/v201103/user_service_registry.rb +37 -0
- data/lib/dfp_api/v201104/company_service.rb +52 -0
- data/lib/dfp_api/v201104/company_service_registry.rb +37 -0
- data/lib/dfp_api/v201104/creative_service.rb +52 -0
- data/lib/dfp_api/v201104/creative_service_registry.rb +37 -0
- data/lib/dfp_api/v201104/custom_targeting_service.rb +60 -0
- data/lib/dfp_api/v201104/custom_targeting_service_registry.rb +37 -0
- data/lib/dfp_api/v201104/forecast_service.rb +36 -0
- data/lib/dfp_api/v201104/forecast_service_registry.rb +37 -0
- data/lib/dfp_api/v201104/inventory_service.rb +56 -0
- data/lib/dfp_api/v201104/inventory_service_registry.rb +37 -0
- data/lib/dfp_api/v201104/line_item_creative_association_service.rb +56 -0
- data/lib/dfp_api/v201104/line_item_creative_association_service_registry.rb +37 -0
- data/lib/dfp_api/v201104/line_item_service.rb +56 -0
- data/lib/dfp_api/v201104/line_item_service_registry.rb +37 -0
- data/lib/dfp_api/v201104/network_service.rb +40 -0
- data/lib/dfp_api/v201104/network_service_registry.rb +37 -0
- data/lib/dfp_api/v201104/order_service.rb +56 -0
- data/lib/dfp_api/v201104/order_service_registry.rb +37 -0
- data/lib/dfp_api/v201104/placement_service.rb +56 -0
- data/lib/dfp_api/v201104/placement_service_registry.rb +37 -0
- data/lib/dfp_api/v201104/publisher_query_language_service.rb +32 -0
- data/lib/dfp_api/v201104/publisher_query_language_service_registry.rb +37 -0
- data/lib/dfp_api/v201104/report_service.rb +40 -0
- data/lib/dfp_api/v201104/report_service_registry.rb +37 -0
- data/lib/dfp_api/v201104/user_service.rb +60 -0
- data/lib/dfp_api/v201104/user_service_registry.rb +37 -0
- data/test/bugs/test_issue_00000016.rb +154 -0
- data/test/dfp_api/test_dfp_api.rb +64 -0
- metadata +248 -53
@@ -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 updates the destination URL of all LICAs up to the first 500. To
|
21
|
+
# determine which LICAs exist, run get_all_licas.rb.
|
22
|
+
#
|
23
|
+
# Tags:
|
24
|
+
# LineItemCreativeAssociationService.getLineItemCreativeAssociationsByStatement,
|
25
|
+
# LineItemCreativeAssociationService.updateLineItemCreativeAssociations
|
26
|
+
|
27
|
+
require 'rubygems'
|
28
|
+
require 'dfp_api'
|
29
|
+
|
30
|
+
API_VERSION = :v201103
|
31
|
+
|
32
|
+
def update_licas()
|
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 LineItemCreativeAssociationService.
|
41
|
+
lica_service = dfp.service(:LineItemCreativeAssociationService, API_VERSION)
|
42
|
+
|
43
|
+
# Create a statement to get all LICAs.
|
44
|
+
statement = {:query => 'LIMIT 500'}
|
45
|
+
|
46
|
+
# Get LICAs by statement.
|
47
|
+
page =
|
48
|
+
lica_service.get_line_item_creative_associations_by_statement(statement)
|
49
|
+
|
50
|
+
if page[:results]
|
51
|
+
licas = page[:results]
|
52
|
+
|
53
|
+
# Update each local LICA object by changing its destination URL.
|
54
|
+
licas.each {|lica| lica[:destination_url] = 'http://news.google.com'}
|
55
|
+
|
56
|
+
# Update the LICAs on the server.
|
57
|
+
return_licas = lica_service.update_line_item_creative_associations(licas)
|
58
|
+
|
59
|
+
if return_licas
|
60
|
+
return_licas.each do |lica|
|
61
|
+
puts ("LICA with line item ID: %d and creative ID: %d was updated " +
|
62
|
+
"with destination url [%s]") %
|
63
|
+
[lica[:line_item_id], lica[:creative_id], lica[:destination_url]]
|
64
|
+
end
|
65
|
+
else
|
66
|
+
raise 'No LICAs were updated.'
|
67
|
+
end
|
68
|
+
else
|
69
|
+
puts 'No LICAs found to update.'
|
70
|
+
end
|
71
|
+
end
|
72
|
+
|
73
|
+
if __FILE__ == $0
|
74
|
+
begin
|
75
|
+
update_licas()
|
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,131 @@
|
|
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 activates all line items for the given order. To be activated,
|
21
|
+
# line items need to be in the approved (needs creatives) state and have at
|
22
|
+
# least one creative associated with them. To approve line items, approve the
|
23
|
+
# order to which they belong by running approve_orders.rb. To create LICAs, run
|
24
|
+
# create_licas.rb. To determine which line items exist, run
|
25
|
+
# get_all_line_items.rb. To determine which orders exist, run get_all_orders.rb.
|
26
|
+
#
|
27
|
+
# Tags: LineItemService.getLineItemsByStatement,
|
28
|
+
# LineItemService.performLineItemAction
|
29
|
+
|
30
|
+
require 'rubygems'
|
31
|
+
require 'dfp_api'
|
32
|
+
|
33
|
+
API_VERSION = :v201103
|
34
|
+
PAGE_SIZE = 500
|
35
|
+
|
36
|
+
def activate_line_items()
|
37
|
+
# Get DfpApi instance and load configuration from ~/dfp_api.yml.
|
38
|
+
dfp = DfpApi::Api.new
|
39
|
+
|
40
|
+
# To enable logging of SOAP requests, set the log_level value to 'DEBUG' in
|
41
|
+
# the configuration file or provide your own logger:
|
42
|
+
# dfp.logger = Logger.new('dfp_xml.log')
|
43
|
+
|
44
|
+
# Get the LineItemService.
|
45
|
+
line_item_service = dfp.service(:LineItemService, API_VERSION)
|
46
|
+
|
47
|
+
# Set the ID of the order to get line items from.
|
48
|
+
order_id = 'INSERT_ORDER_ID_HERE'.to_i
|
49
|
+
|
50
|
+
# Create a statement to only select line items from the specified order that
|
51
|
+
# are in the approved (needs creatives) state.
|
52
|
+
statement_text = 'WHERE orderID = :order_id AND status = :status'
|
53
|
+
statement = {
|
54
|
+
:values => [
|
55
|
+
{:key => 'order_id',
|
56
|
+
:value => {:value => order_id, :xsi_type => 'NumberValue'}},
|
57
|
+
{:key => 'status',
|
58
|
+
:value => {:value => 'NEEDS_CREATIVES', :xsi_type => 'TextValue'}}
|
59
|
+
]
|
60
|
+
}
|
61
|
+
|
62
|
+
# Define initial values.
|
63
|
+
offset = 0
|
64
|
+
page = Hash.new
|
65
|
+
line_item_ids = Array.new
|
66
|
+
|
67
|
+
begin
|
68
|
+
# Create a statement to get one page with current offset.
|
69
|
+
statement[:query] = statement_text +
|
70
|
+
" LIMIT %d OFFSET %d" % [PAGE_SIZE, offset]
|
71
|
+
|
72
|
+
# Get line items by statement.
|
73
|
+
page = line_item_service.get_line_items_by_statement(statement)
|
74
|
+
|
75
|
+
if page[:results]
|
76
|
+
# Increase query offset by page size.
|
77
|
+
offset += PAGE_SIZE
|
78
|
+
|
79
|
+
page[:results].each do |line_item|
|
80
|
+
if !line_item[:is_archived]
|
81
|
+
puts ("%d) Line item with ID: %d, order ID: %d and name: %s will " +
|
82
|
+
"be activated.") % [line_item_ids.size, line_item[:id],
|
83
|
+
line_item[:order_id], line_item[:name]]
|
84
|
+
line_item_ids << line_item[:id]
|
85
|
+
end
|
86
|
+
end
|
87
|
+
end
|
88
|
+
end while offset < page[:total_result_set_size]
|
89
|
+
|
90
|
+
puts "Number of line items to be activated: %d" % line_item_ids.size
|
91
|
+
|
92
|
+
if !line_item_ids.empty?
|
93
|
+
# Modify statement for action. Note, the values are still present.
|
94
|
+
statement[:query] = statement_text + " AND id IN (%s)" %
|
95
|
+
line_item_ids.join(', ')
|
96
|
+
|
97
|
+
# Perform action.
|
98
|
+
result = line_item_service.perform_line_item_action(
|
99
|
+
{:xsi_type => 'ActivateLineItems'}, statement)
|
100
|
+
|
101
|
+
# Display results.
|
102
|
+
if result and result[:num_changes] > 0
|
103
|
+
puts "Number of line items activated: %d" % result[:num_changes]
|
104
|
+
else
|
105
|
+
puts 'No line items were activated.'
|
106
|
+
end
|
107
|
+
else
|
108
|
+
puts 'No line items found to activate.'
|
109
|
+
end
|
110
|
+
end
|
111
|
+
|
112
|
+
if __FILE__ == $0
|
113
|
+
begin
|
114
|
+
activate_line_items()
|
115
|
+
|
116
|
+
# HTTP errors.
|
117
|
+
rescue AdsCommon::Errors::HttpError => e
|
118
|
+
puts "HTTP Error: %s" % e
|
119
|
+
|
120
|
+
# API errors.
|
121
|
+
rescue DfpApi::Errors::ApiException => e
|
122
|
+
puts "Message: %s" % e.message
|
123
|
+
puts 'Errors:'
|
124
|
+
e.errors.each_with_index do |error, index|
|
125
|
+
puts "\tError [%d]:" % (index + 1)
|
126
|
+
error.each do |field, value|
|
127
|
+
puts "\t\t%s: %s" % [field, value]
|
128
|
+
end
|
129
|
+
end
|
130
|
+
end
|
131
|
+
end
|
@@ -0,0 +1,165 @@
|
|
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 line items. To determine which line items exist, run
|
21
|
+
# get_all_line_items.rb. To determine which orders exist, run
|
22
|
+
# get_all_orders.rb. To determine which placements exist, run
|
23
|
+
# get_all_placements.rb.
|
24
|
+
#
|
25
|
+
# Tags: LineItemService.createLineItems
|
26
|
+
|
27
|
+
require 'rubygems'
|
28
|
+
require 'dfp_api'
|
29
|
+
|
30
|
+
API_VERSION = :v201103
|
31
|
+
# Number of line items to create.
|
32
|
+
ITEM_COUNT = 5
|
33
|
+
|
34
|
+
def create_line_items()
|
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 LineItemService.
|
43
|
+
line_item_service = dfp.service(:LineItemService, API_VERSION)
|
44
|
+
|
45
|
+
# Set the order that all created line items will belong to and the placement
|
46
|
+
# ID to target.
|
47
|
+
order_id = 'INSERT_ORDER_ID_HERE'.to_i
|
48
|
+
targeted_placement_ids = Array.new(ITEM_COUNT) do
|
49
|
+
'INSERT_PLACEMENT_ID_HERE'.to_i
|
50
|
+
end
|
51
|
+
|
52
|
+
# Create inventory targeting.
|
53
|
+
inventory_targeting = {:targeted_placement_ids => targeted_placement_ids}
|
54
|
+
|
55
|
+
# Create geographical targeting.
|
56
|
+
geo_targeting = Hash.new
|
57
|
+
# Include the US and Quebec, Canada.
|
58
|
+
geo_targeting[:targeted_locations] = [
|
59
|
+
{:xsi_type => 'CountryLocation', :country_code => 'US'},
|
60
|
+
{:xsi_type => 'RegionLocation', :region_code => 'CA-QC'}
|
61
|
+
]
|
62
|
+
|
63
|
+
# Exclude Chicago and the New York metro area.
|
64
|
+
geo_targeting[:excluded_locations] = [
|
65
|
+
{:xsi_type => 'CityLocation',
|
66
|
+
:city_name => 'Chicago', :country_code => 'US'},
|
67
|
+
{:xsi_type => 'MetroLocation', :metro_code => '501'}
|
68
|
+
]
|
69
|
+
|
70
|
+
# Create user domain targeting. Exclude domains that are not under the
|
71
|
+
# network's control.
|
72
|
+
user_domain_targeting = {
|
73
|
+
:domains => ['usa.gov'],
|
74
|
+
:targeted => false
|
75
|
+
}
|
76
|
+
|
77
|
+
# Create day-part targeting.
|
78
|
+
day_part_targeting = {
|
79
|
+
# Target only the weekend in the browser's timezone.
|
80
|
+
:time_zone => 'BROWSER',
|
81
|
+
:day_parts => [
|
82
|
+
{:day_of_week => 'SATURDAY',
|
83
|
+
:start_time => {:hour => 0, :minute => 'ZERO'},
|
84
|
+
:end_time => {:hour => 24, :minute => 'ZERO'}},
|
85
|
+
{:day_of_week => 'SUNDAY',
|
86
|
+
:start_time => {:hour => 0, :minute => 'ZERO'},
|
87
|
+
:end_time => {:hour => 24, :minute => 'ZERO'}}
|
88
|
+
]
|
89
|
+
}
|
90
|
+
|
91
|
+
# Create targeting.
|
92
|
+
targeting = {:geo_targeting => geo_targeting,
|
93
|
+
:inventory_targeting => inventory_targeting,
|
94
|
+
:user_domain_targeting => user_domain_targeting,
|
95
|
+
:day_part_targeting => day_part_targeting
|
96
|
+
}
|
97
|
+
|
98
|
+
# Create an array to store local line item objects.
|
99
|
+
line_items = Array.new
|
100
|
+
ITEM_COUNT.times do |index|
|
101
|
+
line_item = {:name => "Line item #%d" % index,
|
102
|
+
:order_id => order_id,
|
103
|
+
:targeting => targeting,
|
104
|
+
:line_item_type => 'STANDARD',
|
105
|
+
:allow_overbook => true}
|
106
|
+
# Set the creative rotation type to even.
|
107
|
+
line_item[:creative_rotation_type] = 'EVEN'
|
108
|
+
|
109
|
+
# Set the size of creatives that can be associated with this line item.
|
110
|
+
line_item[:creative_sizes] = [
|
111
|
+
{:width => 300, :height => 250, :is_aspect_ratio => false}
|
112
|
+
]
|
113
|
+
|
114
|
+
# Set the length of the line item to run.
|
115
|
+
line_item[:start_date_time_type] = 'IMMEDIATELY'
|
116
|
+
line_item[:end_date_time] = Time.new + 60 * 60 * 24 * 7
|
117
|
+
|
118
|
+
# Set the cost per unit to $2.
|
119
|
+
line_item[:cost_type] = 'CPM'
|
120
|
+
line_item[:cost_per_unit] = {
|
121
|
+
:currency_code => 'USD',
|
122
|
+
:micro_amount => 2000000
|
123
|
+
}
|
124
|
+
|
125
|
+
# Set the number of units bought to 500,000 so that the budget is $1,000.
|
126
|
+
line_item[:units_bought] = 500000
|
127
|
+
line_item[:unit_type] = 'IMPRESSIONS'
|
128
|
+
|
129
|
+
line_items << line_item
|
130
|
+
end
|
131
|
+
|
132
|
+
# Create the line items on the server.
|
133
|
+
return_line_items = line_item_service.create_line_items(line_items)
|
134
|
+
|
135
|
+
if return_line_items
|
136
|
+
return_line_items.each do |line_item|
|
137
|
+
puts ("Line item with ID: %d, belonging to order ID: %d, " +
|
138
|
+
"and named: %s was created.") %
|
139
|
+
[line_item[:id], line_item[:order_id], line_item[:name]]
|
140
|
+
end
|
141
|
+
else
|
142
|
+
raise 'No line items were created.'
|
143
|
+
end
|
144
|
+
end
|
145
|
+
|
146
|
+
if __FILE__ == $0
|
147
|
+
begin
|
148
|
+
create_line_items()
|
149
|
+
|
150
|
+
# HTTP errors.
|
151
|
+
rescue AdsCommon::Errors::HttpError => e
|
152
|
+
puts "HTTP Error: %s" % e
|
153
|
+
|
154
|
+
# API errors.
|
155
|
+
rescue DfpApi::Errors::ApiException => e
|
156
|
+
puts "Message: %s" % e.message
|
157
|
+
puts 'Errors:'
|
158
|
+
e.errors.each_with_index do |error, index|
|
159
|
+
puts "\tError [%d]:" % (index + 1)
|
160
|
+
error.each do |field, value|
|
161
|
+
puts "\t\t%s: %s" % [field, value]
|
162
|
+
end
|
163
|
+
end
|
164
|
+
end
|
165
|
+
end
|
@@ -0,0 +1,94 @@
|
|
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 line items. To create line items, run
|
21
|
+
# create_line_items.rb.
|
22
|
+
#
|
23
|
+
# Tags: LineItemService.getLineItemsByStatement
|
24
|
+
|
25
|
+
require 'rubygems'
|
26
|
+
require 'dfp_api'
|
27
|
+
|
28
|
+
API_VERSION = :v201103
|
29
|
+
PAGE_SIZE = 500
|
30
|
+
|
31
|
+
def get_all_line_items()
|
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 LineItemService.
|
40
|
+
line_item_service = dfp.service(:LineItemService, API_VERSION)
|
41
|
+
|
42
|
+
# Define initial values.
|
43
|
+
offset = 0
|
44
|
+
page = Hash.new
|
45
|
+
|
46
|
+
begin
|
47
|
+
# Create a statement to get one page with current offset.
|
48
|
+
statement = {:query => "LIMIT %d OFFSET %d" % [PAGE_SIZE, offset]}
|
49
|
+
|
50
|
+
# Get line items by statement.
|
51
|
+
page = line_item_service.get_line_items_by_statement(statement)
|
52
|
+
|
53
|
+
if page[:results]
|
54
|
+
# Increase query offset by page size.
|
55
|
+
offset += PAGE_SIZE
|
56
|
+
|
57
|
+
# Get the start index for printout.
|
58
|
+
start_index = page[:start_index]
|
59
|
+
|
60
|
+
# Print details about each line item in results.
|
61
|
+
page[:results].each_with_index do |line_item, index|
|
62
|
+
puts "%d) Line item ID: %d, order ID: %d, name: %s" %
|
63
|
+
[index + start_index, line_item[:id],
|
64
|
+
line_item[:order_id], line_item[:name]]
|
65
|
+
end
|
66
|
+
end
|
67
|
+
end while offset < page[:total_result_set_size]
|
68
|
+
|
69
|
+
# Print a footer.
|
70
|
+
if page.include?(:total_result_set_size)
|
71
|
+
puts "Total number of line items: %d" % page[:total_result_set_size]
|
72
|
+
end
|
73
|
+
end
|
74
|
+
|
75
|
+
if __FILE__ == $0
|
76
|
+
begin
|
77
|
+
get_all_line_items()
|
78
|
+
|
79
|
+
# HTTP errors.
|
80
|
+
rescue AdsCommon::Errors::HttpError => e
|
81
|
+
puts "HTTP Error: %s" % e
|
82
|
+
|
83
|
+
# API errors.
|
84
|
+
rescue DfpApi::Errors::ApiException => e
|
85
|
+
puts "Message: %s" % e.message
|
86
|
+
puts 'Errors:'
|
87
|
+
e.errors.each_with_index do |error, index|
|
88
|
+
puts "\tError [%d]:" % (index + 1)
|
89
|
+
error.each do |field, value|
|
90
|
+
puts "\t\t%s: %s" % [field, value]
|
91
|
+
end
|
92
|
+
end
|
93
|
+
end
|
94
|
+
end
|