google-dfp-api 0.6.1 → 0.6.2
Sign up to get free protection for your applications and to get access to all the features.
- data/ChangeLog +3 -0
- data/examples/v201302/activity_group_service/create_activity_groups.rb +94 -0
- data/examples/v201302/activity_group_service/get_active_activity_groups.rb +100 -0
- data/examples/v201302/activity_group_service/get_all_activity_groups.rb +95 -0
- data/examples/v201302/activity_group_service/update_activity_groups.rb +87 -0
- data/examples/v201302/activity_service/create_activities.rb +91 -0
- data/examples/v201302/activity_service/get_active_activities.rb +107 -0
- data/examples/v201302/activity_service/get_all_activities.rb +144 -0
- data/examples/v201302/activity_service/update_activities.rb +85 -0
- data/examples/v201302/audience_segment_service/get_all_audience_segments.rb +93 -0
- data/examples/v201302/common/error_handling.rb +76 -0
- data/examples/v201302/common/oauth2_handling.rb +128 -0
- data/examples/v201302/common/oauth2_jwt_handling.rb +107 -0
- data/examples/v201302/company_service/create_companies.rb +81 -0
- data/examples/v201302/company_service/get_all_companies.rb +92 -0
- data/examples/v201302/company_service/get_companies_by_statement.rb +88 -0
- data/examples/v201302/company_service/get_company.rb +72 -0
- data/examples/v201302/company_service/update_companies.rb +102 -0
- data/examples/v201302/contact_service/create_contacts.rb +95 -0
- data/examples/v201302/contact_service/get_all_contacts.rb +92 -0
- data/examples/v201302/contact_service/get_uninvited_contacts.rb +102 -0
- data/examples/v201302/contact_service/update_contacts.rb +84 -0
- data/examples/v201302/content_service/get_all_content.rb +94 -0
- data/examples/v201302/content_service/get_content_by_category.rb +143 -0
- data/examples/v201302/creative_service/copy_image_creatives.rb +115 -0
- data/examples/v201302/creative_service/create_creative_from_template.rb +139 -0
- data/examples/v201302/creative_service/create_creatives.rb +112 -0
- data/examples/v201302/creative_service/create_custom_creative.rb +104 -0
- data/examples/v201302/creative_service/get_all_creatives.rb +93 -0
- data/examples/v201302/creative_service/get_creative.rb +72 -0
- data/examples/v201302/creative_service/get_creatives_by_statement.rb +87 -0
- data/examples/v201302/creative_service/update_creatives.rb +96 -0
- data/examples/v201302/creative_set_service/associate_creative_set_to_line_item.rb +77 -0
- data/examples/v201302/creative_set_service/create_creative_set.rb +83 -0
- data/examples/v201302/creative_set_service/get_all_creative_sets.rb +94 -0
- data/examples/v201302/creative_set_service/get_creative_sets_by_statement.rb +90 -0
- data/examples/v201302/creative_set_service/update_creative_sets.rb +85 -0
- data/examples/v201302/creative_template_service/get_all_creative_templates.rb +94 -0
- data/examples/v201302/creative_template_service/get_creative_template.rb +74 -0
- data/examples/v201302/creative_template_service/get_creative_templates_by_statement.rb +80 -0
- data/examples/v201302/creative_wrapper_service/create_creative_wrappers.rb +89 -0
- data/examples/v201302/creative_wrapper_service/deactivate_creative_wrapper.rb +102 -0
- data/examples/v201302/creative_wrapper_service/get_all_creative_wrappers.rb +94 -0
- data/examples/v201302/creative_wrapper_service/get_creative_wrappers_by_statement.rb +88 -0
- data/examples/v201302/creative_wrapper_service/update_creative_wrappers.rb +86 -0
- data/examples/v201302/custom_field_service/create_custom_field_options.rb +87 -0
- data/examples/v201302/custom_field_service/create_custom_fields.rb +86 -0
- data/examples/v201302/custom_field_service/deactivate_all_line_item_custom_fields.rb +112 -0
- data/examples/v201302/custom_field_service/get_all_custom_fields.rb +102 -0
- data/examples/v201302/custom_field_service/get_all_line_item_custom_fields.rb +86 -0
- data/examples/v201302/custom_field_service/set_line_item_custom_field_value.rb +135 -0
- data/examples/v201302/custom_field_service/update_custom_fields.rb +84 -0
- data/examples/v201302/custom_targeting_service/create_custom_targeting_keys_and_values.rb +140 -0
- data/examples/v201302/custom_targeting_service/delete_custom_targeting_keys.rb +121 -0
- data/examples/v201302/custom_targeting_service/delete_custom_targeting_values.rb +125 -0
- data/examples/v201302/custom_targeting_service/get_all_custom_targeting_keys_and_values.rb +148 -0
- data/examples/v201302/custom_targeting_service/get_custom_targeting_keys_by_statement.rb +92 -0
- data/examples/v201302/custom_targeting_service/get_custom_targeting_values_by_statement.rb +98 -0
- data/examples/v201302/custom_targeting_service/update_custom_targeting_keys.rb +94 -0
- data/examples/v201302/custom_targeting_service/update_custom_targeting_values.rb +106 -0
- data/examples/v201302/forecast_service/get_forecast.rb +107 -0
- data/examples/v201302/forecast_service/get_forecast_by_id.rb +80 -0
- data/examples/v201302/inventory_service/create_ad_units.rb +101 -0
- data/examples/v201302/inventory_service/create_mobile_ad_unit.rb +101 -0
- data/examples/v201302/inventory_service/create_video_ad_unit.rb +108 -0
- data/examples/v201302/inventory_service/deactivate_ad_units.rb +119 -0
- data/examples/v201302/inventory_service/get_ad_unit.rb +72 -0
- data/examples/v201302/inventory_service/get_ad_unit_sizes.rb +85 -0
- data/examples/v201302/inventory_service/get_ad_units_by_statement.rb +96 -0
- data/examples/v201302/inventory_service/get_all_ad_units.rb +93 -0
- data/examples/v201302/inventory_service/update_ad_units.rb +96 -0
- data/examples/v201302/label_service/create_labels.rb +83 -0
- data/examples/v201302/label_service/deactivate_labels.rb +118 -0
- data/examples/v201302/label_service/get_all_labels.rb +95 -0
- data/examples/v201302/label_service/get_label.rb +76 -0
- data/examples/v201302/label_service/get_labels_by_statement.rb +81 -0
- data/examples/v201302/label_service/update_labels.rb +102 -0
- data/examples/v201302/line_item_creative_association_service/create_licas.rb +94 -0
- data/examples/v201302/line_item_creative_association_service/deactivate_licas.rb +127 -0
- data/examples/v201302/line_item_creative_association_service/get_all_licas.rb +98 -0
- data/examples/v201302/line_item_creative_association_service/get_lica.rb +77 -0
- data/examples/v201302/line_item_creative_association_service/get_licas_by_statement.rb +91 -0
- data/examples/v201302/line_item_creative_association_service/update_licas.rb +91 -0
- data/examples/v201302/line_item_service/activate_line_items.rb +131 -0
- data/examples/v201302/line_item_service/create_line_items.rb +177 -0
- data/examples/v201302/line_item_service/create_mobile_line_item.rb +135 -0
- data/examples/v201302/line_item_service/create_video_line_item.rb +158 -0
- data/examples/v201302/line_item_service/get_all_line_items.rb +94 -0
- data/examples/v201302/line_item_service/get_line_item.rb +74 -0
- data/examples/v201302/line_item_service/get_line_items_by_statement.rb +93 -0
- data/examples/v201302/line_item_service/get_recently_updated_line_items.rb +98 -0
- data/examples/v201302/line_item_service/target_custom_criteria.rb +129 -0
- data/examples/v201302/line_item_service/update_line_items.rb +109 -0
- data/examples/v201302/network_service/get_all_networks.rb +74 -0
- data/examples/v201302/network_service/get_current_network.rb +66 -0
- data/examples/v201302/network_service/make_test_network.rb +79 -0
- data/examples/v201302/order_service/approve_orders.rb +122 -0
- data/examples/v201302/order_service/create_orders.rb +92 -0
- data/examples/v201302/order_service/get_all_orders.rb +93 -0
- data/examples/v201302/order_service/get_order.rb +74 -0
- data/examples/v201302/order_service/get_orders_by_statement.rb +90 -0
- data/examples/v201302/order_service/update_orders.rb +97 -0
- data/examples/v201302/placement_service/create_placements.rb +131 -0
- data/examples/v201302/placement_service/deactivate_placements.rb +118 -0
- data/examples/v201302/placement_service/get_all_placements.rb +93 -0
- data/examples/v201302/placement_service/get_placement.rb +74 -0
- data/examples/v201302/placement_service/get_placements_by_statement.rb +86 -0
- data/examples/v201302/placement_service/update_placements.rb +97 -0
- data/examples/v201302/publisher_query_language_service/get_all_cities.rb +104 -0
- data/examples/v201302/report_service/display_report.rb +81 -0
- data/examples/v201302/report_service/download_report.rb +81 -0
- data/examples/v201302/report_service/run_delivery_report.rb +103 -0
- data/examples/v201302/report_service/run_inventory_report.rb +96 -0
- data/examples/v201302/report_service/run_merged_delivery_report.rb +94 -0
- data/examples/v201302/report_service/run_reach_report.rb +87 -0
- data/examples/v201302/report_service/run_report_with_custom_fields.rb +135 -0
- data/examples/v201302/report_service/run_sales_report.rb +92 -0
- data/examples/v201302/suggested_ad_unit_service/approve_all_suggested_ad_units.rb +109 -0
- data/examples/v201302/suggested_ad_unit_service/get_all_suggested_ad_units.rb +96 -0
- data/examples/v201302/suggested_ad_unit_service/get_suggested_ad_unit.rb +75 -0
- data/examples/v201302/suggested_ad_unit_service/get_suggested_ad_units_by_statement.rb +92 -0
- data/examples/v201302/team_service/create_teams.rb +83 -0
- data/examples/v201302/team_service/get_all_teams.rb +92 -0
- data/examples/v201302/team_service/get_team.rb +74 -0
- data/examples/v201302/team_service/get_teams_by_statement.rb +78 -0
- data/examples/v201302/team_service/update_teams.rb +97 -0
- data/examples/v201302/third_party_slot_service/archive_third_party_slots.rb +125 -0
- data/examples/v201302/third_party_slot_service/create_third_party_slot.rb +91 -0
- data/examples/v201302/third_party_slot_service/get_all_third_party_slots.rb +93 -0
- data/examples/v201302/third_party_slot_service/get_third_party_slot_by_statement.rb +86 -0
- data/examples/v201302/third_party_slot_service/update_third_party_slots.rb +95 -0
- data/examples/v201302/user_service/create_users.rb +89 -0
- data/examples/v201302/user_service/deactivate_users.rb +97 -0
- data/examples/v201302/user_service/get_all_roles.rb +73 -0
- data/examples/v201302/user_service/get_all_users.rb +93 -0
- data/examples/v201302/user_service/get_current_user.rb +66 -0
- data/examples/v201302/user_service/get_user.rb +73 -0
- data/examples/v201302/user_service/get_users_by_statement.rb +79 -0
- data/examples/v201302/user_service/update_users.rb +89 -0
- data/examples/v201302/user_team_association_service/create_user_team_associations.rb +86 -0
- data/examples/v201302/user_team_association_service/delete_user_team_associations.rb +111 -0
- data/examples/v201302/user_team_association_service/get_all_user_team_associations.rb +94 -0
- data/examples/v201302/user_team_association_service/get_user_team_association.rb +76 -0
- data/examples/v201302/user_team_association_service/get_user_team_associations_by_statement.rb +94 -0
- data/examples/v201302/user_team_association_service/update_user_team_associations.rb +102 -0
- data/lib/dfp_api/api_config.rb +17 -4
- data/lib/dfp_api/v201302/activity_group_service.rb +54 -0
- data/lib/dfp_api/v201302/activity_group_service_registry.rb +46 -0
- data/lib/dfp_api/v201302/activity_service.rb +54 -0
- data/lib/dfp_api/v201302/activity_service_registry.rb +46 -0
- data/lib/dfp_api/v201302/ad_rule_service.rb +58 -0
- data/lib/dfp_api/v201302/ad_rule_service_registry.rb +46 -0
- data/lib/dfp_api/v201302/audience_segment_service.rb +34 -0
- data/lib/dfp_api/v201302/audience_segment_service_registry.rb +46 -0
- data/lib/dfp_api/v201302/company_service.rb +54 -0
- data/lib/dfp_api/v201302/company_service_registry.rb +46 -0
- data/lib/dfp_api/v201302/contact_service.rb +54 -0
- data/lib/dfp_api/v201302/contact_service_registry.rb +46 -0
- data/lib/dfp_api/v201302/content_bundle_service.rb +58 -0
- data/lib/dfp_api/v201302/content_bundle_service_registry.rb +46 -0
- data/lib/dfp_api/v201302/content_service.rb +38 -0
- data/lib/dfp_api/v201302/content_service_registry.rb +46 -0
- data/lib/dfp_api/v201302/creative_service.rb +54 -0
- data/lib/dfp_api/v201302/creative_service_registry.rb +46 -0
- data/lib/dfp_api/v201302/creative_set_service.rb +46 -0
- data/lib/dfp_api/v201302/creative_set_service_registry.rb +46 -0
- data/lib/dfp_api/v201302/creative_template_service.rb +38 -0
- data/lib/dfp_api/v201302/creative_template_service_registry.rb +46 -0
- data/lib/dfp_api/v201302/creative_wrapper_service.rb +58 -0
- data/lib/dfp_api/v201302/creative_wrapper_service_registry.rb +46 -0
- data/lib/dfp_api/v201302/custom_field_service.rb +78 -0
- data/lib/dfp_api/v201302/custom_field_service_registry.rb +46 -0
- data/lib/dfp_api/v201302/custom_targeting_service.rb +62 -0
- data/lib/dfp_api/v201302/custom_targeting_service_registry.rb +46 -0
- data/lib/dfp_api/v201302/forecast_service.rb +38 -0
- data/lib/dfp_api/v201302/forecast_service_registry.rb +46 -0
- data/lib/dfp_api/v201302/inventory_service.rb +62 -0
- data/lib/dfp_api/v201302/inventory_service_registry.rb +46 -0
- data/lib/dfp_api/v201302/label_service.rb +58 -0
- data/lib/dfp_api/v201302/label_service_registry.rb +46 -0
- data/lib/dfp_api/v201302/line_item_creative_association_service.rb +62 -0
- data/lib/dfp_api/v201302/line_item_creative_association_service_registry.rb +46 -0
- data/lib/dfp_api/v201302/line_item_service.rb +58 -0
- data/lib/dfp_api/v201302/line_item_service_registry.rb +46 -0
- data/lib/dfp_api/v201302/network_service.rb +46 -0
- data/lib/dfp_api/v201302/network_service_registry.rb +46 -0
- data/lib/dfp_api/v201302/order_service.rb +58 -0
- data/lib/dfp_api/v201302/order_service_registry.rb +46 -0
- data/lib/dfp_api/v201302/placement_service.rb +58 -0
- data/lib/dfp_api/v201302/placement_service_registry.rb +46 -0
- data/lib/dfp_api/v201302/publisher_query_language_service.rb +34 -0
- data/lib/dfp_api/v201302/publisher_query_language_service_registry.rb +46 -0
- data/lib/dfp_api/v201302/report_service.rb +46 -0
- data/lib/dfp_api/v201302/report_service_registry.rb +46 -0
- data/lib/dfp_api/v201302/suggested_ad_unit_service.rb +42 -0
- data/lib/dfp_api/v201302/suggested_ad_unit_service_registry.rb +46 -0
- data/lib/dfp_api/v201302/team_service.rb +54 -0
- data/lib/dfp_api/v201302/team_service_registry.rb +46 -0
- data/lib/dfp_api/v201302/third_party_slot_service.rb +46 -0
- data/lib/dfp_api/v201302/third_party_slot_service_registry.rb +46 -0
- data/lib/dfp_api/v201302/user_service.rb +66 -0
- data/lib/dfp_api/v201302/user_service_registry.rb +46 -0
- data/lib/dfp_api/v201302/user_team_association_service.rb +58 -0
- data/lib/dfp_api/v201302/user_team_association_service_registry.rb +46 -0
- data/lib/dfp_api/version.rb +1 -1
- metadata +988 -786
@@ -0,0 +1,86 @@
|
|
1
|
+
#!/usr/bin/env ruby
|
2
|
+
# Encoding: utf-8
|
3
|
+
#
|
4
|
+
# Author:: api.dklimkin@gmail.com (Danial Klimkin)
|
5
|
+
#
|
6
|
+
# Copyright:: Copyright 2011, Google Inc. All Rights Reserved.
|
7
|
+
#
|
8
|
+
# License:: Licensed under the Apache License, Version 2.0 (the "License");
|
9
|
+
# you may not use this file except in compliance with the License.
|
10
|
+
# You may obtain a copy of the License at
|
11
|
+
#
|
12
|
+
# http://www.apache.org/licenses/LICENSE-2.0
|
13
|
+
#
|
14
|
+
# Unless required by applicable law or agreed to in writing, software
|
15
|
+
# distributed under the License is distributed on an "AS IS" BASIS,
|
16
|
+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
17
|
+
# implied.
|
18
|
+
# See the License for the specific language governing permissions and
|
19
|
+
# limitations under the License.
|
20
|
+
#
|
21
|
+
# This example gets all active placements. The statement retrieves up to the
|
22
|
+
# maximum page size limit of 500. To create a placement, run
|
23
|
+
# create_placements.rb.
|
24
|
+
#
|
25
|
+
# Tags: PlacementService.getPlacementsByStatement
|
26
|
+
|
27
|
+
require 'dfp_api'
|
28
|
+
|
29
|
+
API_VERSION = :v201302
|
30
|
+
|
31
|
+
def get_placements_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 PlacementService.
|
40
|
+
placement_service = dfp.service(:PlacementService, API_VERSION)
|
41
|
+
|
42
|
+
# Create a statement to only select active placements.
|
43
|
+
statement = {
|
44
|
+
:query => 'WHERE status = :status LIMIT 500',
|
45
|
+
:values => [
|
46
|
+
{:key => 'status',
|
47
|
+
:value => {:value => 'ACTIVE', :xsi_type => 'TextValue'}}
|
48
|
+
]
|
49
|
+
}
|
50
|
+
|
51
|
+
# Get placements by statement.
|
52
|
+
page = placement_service.get_placements_by_statement(statement)
|
53
|
+
|
54
|
+
if page and page[:results]
|
55
|
+
page[:results].each_with_index do |placement, index|
|
56
|
+
puts "%d) Placement ID: %d, name: %s, status: %s." % [index,
|
57
|
+
placement[:id], placement[:name], placement[:status]]
|
58
|
+
end
|
59
|
+
end
|
60
|
+
|
61
|
+
# Print a footer.
|
62
|
+
if page.include?(:total_result_set_size)
|
63
|
+
puts "Number of results found: %d" % page[:total_result_set_size]
|
64
|
+
end
|
65
|
+
end
|
66
|
+
|
67
|
+
if __FILE__ == $0
|
68
|
+
begin
|
69
|
+
get_placements_by_statement()
|
70
|
+
|
71
|
+
# HTTP errors.
|
72
|
+
rescue AdsCommon::Errors::HttpError => e
|
73
|
+
puts "HTTP Error: %s" % e
|
74
|
+
|
75
|
+
# API errors.
|
76
|
+
rescue DfpApi::Errors::ApiException => e
|
77
|
+
puts "Message: %s" % e.message
|
78
|
+
puts 'Errors:'
|
79
|
+
e.errors.each_with_index do |error, index|
|
80
|
+
puts "\tError [%d]:" % (index + 1)
|
81
|
+
error.each do |field, value|
|
82
|
+
puts "\t\t%s: %s" % [field, value]
|
83
|
+
end
|
84
|
+
end
|
85
|
+
end
|
86
|
+
end
|
@@ -0,0 +1,97 @@
|
|
1
|
+
#!/usr/bin/env ruby
|
2
|
+
# Encoding: utf-8
|
3
|
+
#
|
4
|
+
# Author:: api.dklimkin@gmail.com (Danial Klimkin)
|
5
|
+
#
|
6
|
+
# Copyright:: Copyright 2011, Google Inc. All Rights Reserved.
|
7
|
+
#
|
8
|
+
# License:: Licensed under the Apache License, Version 2.0 (the "License");
|
9
|
+
# you may not use this file except in compliance with the License.
|
10
|
+
# You may obtain a copy of the License at
|
11
|
+
#
|
12
|
+
# http://www.apache.org/licenses/LICENSE-2.0
|
13
|
+
#
|
14
|
+
# Unless required by applicable law or agreed to in writing, software
|
15
|
+
# distributed under the License is distributed on an "AS IS" BASIS,
|
16
|
+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
17
|
+
# implied.
|
18
|
+
# See the License for the specific language governing permissions and
|
19
|
+
# limitations under the License.
|
20
|
+
#
|
21
|
+
# This example updates all placements to allow for AdSense targeting up to the
|
22
|
+
# first 500. To determine which placements exist, run get_all_placements.rb.
|
23
|
+
#
|
24
|
+
# Tags: PlacementService.getPlacementsByStatement
|
25
|
+
# Tags: PlacementService.updatePlacements
|
26
|
+
|
27
|
+
require 'dfp_api'
|
28
|
+
|
29
|
+
API_VERSION = :v201302
|
30
|
+
|
31
|
+
def update_placements()
|
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 PlacementService.
|
40
|
+
placement_service = dfp.service(:PlacementService, API_VERSION)
|
41
|
+
|
42
|
+
# Create a statement to get first 500 placements.
|
43
|
+
statement = {:query => 'LIMIT 500'}
|
44
|
+
|
45
|
+
# Get placements by statement.
|
46
|
+
page = placement_service.get_placements_by_statement(statement)
|
47
|
+
|
48
|
+
if page[:results]
|
49
|
+
placements = page[:results]
|
50
|
+
|
51
|
+
# Update each local placement object by enabling AdSense targeting.
|
52
|
+
placements.each do |placement|
|
53
|
+
placement[:targeting_description] =
|
54
|
+
(placement[:description].nil? || placement[:description].empty?) ?
|
55
|
+
'Generic description' : placement[:description]
|
56
|
+
placement[:targeting_ad_location] = 'All images on sports pages.'
|
57
|
+
placement[:targeting_site_name] = 'http://code.google.com'
|
58
|
+
placement[:is_ad_sense_targeting_enabled] = true
|
59
|
+
end
|
60
|
+
|
61
|
+
# Update the placements on the server.
|
62
|
+
return_placements = placement_service.update_placements(placements)
|
63
|
+
|
64
|
+
if return_placements
|
65
|
+
return_placements.each do |placement|
|
66
|
+
puts ("Placement ID: %d, name: %s was updated with AdSense targeting " +
|
67
|
+
"enabled: %s.") % [placement[:id], placement[:name],
|
68
|
+
placement[:is_ad_sense_targeting_enabled]]
|
69
|
+
end
|
70
|
+
else
|
71
|
+
raise 'No placements were updated.'
|
72
|
+
end
|
73
|
+
else
|
74
|
+
puts 'No placements found to update.'
|
75
|
+
end
|
76
|
+
end
|
77
|
+
|
78
|
+
if __FILE__ == $0
|
79
|
+
begin
|
80
|
+
update_placements()
|
81
|
+
|
82
|
+
# HTTP errors.
|
83
|
+
rescue AdsCommon::Errors::HttpError => e
|
84
|
+
puts "HTTP Error: %s" % e
|
85
|
+
|
86
|
+
# API errors.
|
87
|
+
rescue DfpApi::Errors::ApiException => e
|
88
|
+
puts "Message: %s" % e.message
|
89
|
+
puts 'Errors:'
|
90
|
+
e.errors.each_with_index do |error, index|
|
91
|
+
puts "\tError [%d]:" % (index + 1)
|
92
|
+
error.each do |field, value|
|
93
|
+
puts "\t\t%s: %s" % [field, value]
|
94
|
+
end
|
95
|
+
end
|
96
|
+
end
|
97
|
+
end
|
@@ -0,0 +1,104 @@
|
|
1
|
+
#!/usr/bin/env ruby
|
2
|
+
# Encoding: utf-8
|
3
|
+
#
|
4
|
+
# Author:: api.dklimkin@gmail.com (Danial Klimkin)
|
5
|
+
#
|
6
|
+
# Copyright:: Copyright 2011, Google Inc. All Rights Reserved.
|
7
|
+
#
|
8
|
+
# License:: Licensed under the Apache License, Version 2.0 (the "License");
|
9
|
+
# you may not use this file except in compliance with the License.
|
10
|
+
# You may obtain a copy of the License at
|
11
|
+
#
|
12
|
+
# http://www.apache.org/licenses/LICENSE-2.0
|
13
|
+
#
|
14
|
+
# Unless required by applicable law or agreed to in writing, software
|
15
|
+
# distributed under the License is distributed on an "AS IS" BASIS,
|
16
|
+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
17
|
+
# implied.
|
18
|
+
# See the License for the specific language governing permissions and
|
19
|
+
# limitations under the License.
|
20
|
+
#
|
21
|
+
# This example gets first 500 cities available to target. A full list of
|
22
|
+
# available tables can be found at:
|
23
|
+
#
|
24
|
+
# https://developers.google.com/doubleclick-publishers/docs/reference/v201204/PublisherQueryLanguageService
|
25
|
+
#
|
26
|
+
# Tags: PublisherQueryLanguageService.select
|
27
|
+
|
28
|
+
require 'dfp_api'
|
29
|
+
|
30
|
+
API_VERSION = :v201302
|
31
|
+
# A string to separate columns in output. Use "," to get CSV.
|
32
|
+
COLUMN_SEPARATOR = "\t"
|
33
|
+
PAGE_SIZE = 500
|
34
|
+
|
35
|
+
def get_all_cities()
|
36
|
+
# Get DfpApi instance and load configuration from ~/dfp_api.yml.
|
37
|
+
dfp = DfpApi::Api.new
|
38
|
+
|
39
|
+
# To enable logging of SOAP requests, set the log_level value to 'DEBUG' in
|
40
|
+
# the configuration file or provide your own logger:
|
41
|
+
# dfp.logger = Logger.new('dfp_xml.log')
|
42
|
+
|
43
|
+
# Get the PublisherQueryLanguageService.
|
44
|
+
pql_service = dfp.service(:PublisherQueryLanguageService, API_VERSION)
|
45
|
+
|
46
|
+
# Create a statement to select all targetable cities. For criteria that do not
|
47
|
+
# have a "targetable" property, the predicate may be left off.
|
48
|
+
statement_text =
|
49
|
+
'SELECT * FROM City WHERE targetable = true LIMIT %d' % PAGE_SIZE
|
50
|
+
|
51
|
+
# Set initial values for paging.
|
52
|
+
offset, result_set, all_rows = 0, nil, 0
|
53
|
+
|
54
|
+
# Get all cities with paging.
|
55
|
+
begin
|
56
|
+
# Create statement for a page.
|
57
|
+
statement = {
|
58
|
+
:query => statement_text + ' OFFSET %d' % offset
|
59
|
+
}
|
60
|
+
result_set = pql_service.select(statement)
|
61
|
+
|
62
|
+
if result_set
|
63
|
+
# Print out columns header.
|
64
|
+
columns = result_set[:column_types].collect {|col| col[:label_name]}
|
65
|
+
puts columns.join(COLUMN_SEPARATOR)
|
66
|
+
|
67
|
+
# Print out every row.
|
68
|
+
result_set[:rows].each do |row_set|
|
69
|
+
row = row_set[:values].collect {|item| item[:value]}
|
70
|
+
puts row.join(COLUMN_SEPARATOR)
|
71
|
+
end
|
72
|
+
end
|
73
|
+
|
74
|
+
# Update the counters.
|
75
|
+
offset += PAGE_SIZE
|
76
|
+
all_rows += result_set[:rows].size
|
77
|
+
end while result_set[:rows].size == PAGE_SIZE
|
78
|
+
|
79
|
+
# Print a footer.
|
80
|
+
if result_set[:rows]
|
81
|
+
puts "Total number of rows found: %d" % all_rows
|
82
|
+
end
|
83
|
+
end
|
84
|
+
|
85
|
+
if __FILE__ == $0
|
86
|
+
begin
|
87
|
+
get_all_cities()
|
88
|
+
|
89
|
+
# HTTP errors.
|
90
|
+
rescue AdsCommon::Errors::HttpError => e
|
91
|
+
puts "HTTP Error: %s" % e
|
92
|
+
|
93
|
+
# API errors.
|
94
|
+
rescue DfpApi::Errors::ApiException => e
|
95
|
+
puts "Message: %s" % e.message
|
96
|
+
puts 'Errors:'
|
97
|
+
e.errors.each_with_index do |error, index|
|
98
|
+
puts "\tError [%d]:" % (index + 1)
|
99
|
+
error.each do |field, value|
|
100
|
+
puts "\t\t%s: %s" % [field, value]
|
101
|
+
end
|
102
|
+
end
|
103
|
+
end
|
104
|
+
end
|
@@ -0,0 +1,81 @@
|
|
1
|
+
#!/usr/bin/env ruby
|
2
|
+
# Encoding: utf-8
|
3
|
+
#
|
4
|
+
# Author:: api.davidtorres@gmail.com (David Torres)
|
5
|
+
#
|
6
|
+
# Copyright:: Copyright 2013, Google Inc. All Rights Reserved.
|
7
|
+
#
|
8
|
+
# License:: Licensed under the Apache License, Version 2.0 (the "License");
|
9
|
+
# you may not use this file except in compliance with the License.
|
10
|
+
# You may obtain a copy of the License at
|
11
|
+
#
|
12
|
+
# http://www.apache.org/licenses/LICENSE-2.0
|
13
|
+
#
|
14
|
+
# Unless required by applicable law or agreed to in writing, software
|
15
|
+
# distributed under the License is distributed on an "AS IS" BASIS,
|
16
|
+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
17
|
+
# implied.
|
18
|
+
# See the License for the specific language governing permissions and
|
19
|
+
# limitations under the License.
|
20
|
+
#
|
21
|
+
# This example downloads a completed report and prints out its contents. To
|
22
|
+
# download a completed report to a file, run download_report.rb. To run
|
23
|
+
# a report, run run_delivery_report.rb.
|
24
|
+
#
|
25
|
+
# Tags: ReportService.getReportDownloadURL
|
26
|
+
|
27
|
+
require 'dfp_api'
|
28
|
+
|
29
|
+
require 'open-uri'
|
30
|
+
|
31
|
+
API_VERSION = :v201302
|
32
|
+
|
33
|
+
def display_report()
|
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 ReportService.
|
42
|
+
report_service = dfp.service(:ReportService, API_VERSION)
|
43
|
+
|
44
|
+
# Set the ID of the completed report.
|
45
|
+
report_job_id = 'INSERT_REPORT_JOB_ID_HERE'.to_i
|
46
|
+
|
47
|
+
# Set the format of the report (e.g. CSV_DUMP) and download without
|
48
|
+
# compression so we can print it.
|
49
|
+
report_download_options = {
|
50
|
+
:export_format => 'CSV_DUMP',
|
51
|
+
:use_gzip_compression => false
|
52
|
+
}
|
53
|
+
|
54
|
+
# Get the report URL.
|
55
|
+
download_url = report_service.get_report_download_url_with_options(
|
56
|
+
report_job_id, report_download_options);
|
57
|
+
|
58
|
+
puts "Downloading report from URL %s.\n" % download_url
|
59
|
+
puts open(download_url).read()
|
60
|
+
end
|
61
|
+
|
62
|
+
if __FILE__ == $0
|
63
|
+
begin
|
64
|
+
display_report()
|
65
|
+
|
66
|
+
# HTTP errors.
|
67
|
+
rescue AdsCommon::Errors::HttpError => e
|
68
|
+
puts "HTTP Error: %s" % e
|
69
|
+
|
70
|
+
# API errors.
|
71
|
+
rescue DfpApi::Errors::ApiException => e
|
72
|
+
puts "Message: %s" % e.message
|
73
|
+
puts 'Errors:'
|
74
|
+
e.errors.each_with_index do |error, index|
|
75
|
+
puts "\tError [%d]:" % (index + 1)
|
76
|
+
error.each do |field, value|
|
77
|
+
puts "\t\t%s: %s" % [field, value]
|
78
|
+
end
|
79
|
+
end
|
80
|
+
end
|
81
|
+
end
|
@@ -0,0 +1,81 @@
|
|
1
|
+
#!/usr/bin/env ruby
|
2
|
+
# Encoding: utf-8
|
3
|
+
#
|
4
|
+
# Author:: api.dklimkin@gmail.com (Danial Klimkin)
|
5
|
+
#
|
6
|
+
# Copyright:: Copyright 2011, Google Inc. All Rights Reserved.
|
7
|
+
#
|
8
|
+
# License:: Licensed under the Apache License, Version 2.0 (the "License");
|
9
|
+
# you may not use this file except in compliance with the License.
|
10
|
+
# You may obtain a copy of the License at
|
11
|
+
#
|
12
|
+
# http://www.apache.org/licenses/LICENSE-2.0
|
13
|
+
#
|
14
|
+
# Unless required by applicable law or agreed to in writing, software
|
15
|
+
# distributed under the License is distributed on an "AS IS" BASIS,
|
16
|
+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
17
|
+
# implied.
|
18
|
+
# See the License for the specific language governing permissions and
|
19
|
+
# limitations under the License.
|
20
|
+
#
|
21
|
+
# This example downloads a completed report. To run a report, run
|
22
|
+
# run_delivery_report.rb, run_sales_report.rb or run_inventory_report.rb.
|
23
|
+
#
|
24
|
+
# Tags: ReportService.getReportDownloadURL
|
25
|
+
|
26
|
+
require 'dfp_api'
|
27
|
+
|
28
|
+
require 'open-uri'
|
29
|
+
|
30
|
+
API_VERSION = :v201302
|
31
|
+
|
32
|
+
def download_report()
|
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 ReportService.
|
41
|
+
report_service = dfp.service(:ReportService, API_VERSION)
|
42
|
+
|
43
|
+
# Set the ID of the completed report.
|
44
|
+
report_job_id = 'INSERT_REPORT_JOB_ID_HERE'.to_i
|
45
|
+
|
46
|
+
# Set the file path and name to save to.
|
47
|
+
file_name = 'INSERT_FILE_PATH_AND_NAME_HERE'
|
48
|
+
|
49
|
+
# Change to your preffered export format.
|
50
|
+
export_format = 'CSV_DUMP'
|
51
|
+
|
52
|
+
# Get the report URL.
|
53
|
+
download_url = report_service.get_report_download_url(
|
54
|
+
report_job_id, export_format);
|
55
|
+
|
56
|
+
puts "Downloading [%s] to [%s]..." % [download_url, file_name]
|
57
|
+
open(file_name, 'wb') do |local_file|
|
58
|
+
local_file << open(download_url).read()
|
59
|
+
end
|
60
|
+
end
|
61
|
+
|
62
|
+
if __FILE__ == $0
|
63
|
+
begin
|
64
|
+
download_report()
|
65
|
+
|
66
|
+
# HTTP errors.
|
67
|
+
rescue AdsCommon::Errors::HttpError => e
|
68
|
+
puts "HTTP Error: %s" % e
|
69
|
+
|
70
|
+
# API errors.
|
71
|
+
rescue DfpApi::Errors::ApiException => e
|
72
|
+
puts "Message: %s" % e.message
|
73
|
+
puts 'Errors:'
|
74
|
+
e.errors.each_with_index do |error, index|
|
75
|
+
puts "\tError [%d]:" % (index + 1)
|
76
|
+
error.each do |field, value|
|
77
|
+
puts "\t\t%s: %s" % [field, value]
|
78
|
+
end
|
79
|
+
end
|
80
|
+
end
|
81
|
+
end
|