google-dfp-api 0.2.8 → 0.3.0

data/examples/v201103/placement_service/get_placement.rb

@@ -1,73 +0,0 @@
-#!/usr/bin/ruby
-#
-# Author:: api.dklimkin@gmail.com (Danial Klimkin)
-#
-# Copyright:: Copyright 2011, Google Inc. All Rights Reserved.
-#
-# License:: Licensed under the Apache License, Version 2.0 (the "License");
-#           you may not use this file except in compliance with the License.
-#           You may obtain a copy of the License at
-#
-#           http://www.apache.org/licenses/LICENSE-2.0
-#
-#           Unless required by applicable law or agreed to in writing, software
-#           distributed under the License is distributed on an "AS IS" BASIS,
-#           WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
-#           implied.
-#           See the License for the specific language governing permissions and
-#           limitations under the License.
-#
-# This example gets a placement by its ID. To determine which placements exist,
-# run get_all_placements.rb.
-#
-# Tags: PlacementService.getPlacement
-
-require 'dfp_api'
-
-API_VERSION = :v201103
-
-def get_placement()
-  # Get DfpApi instance and load configuration from ~/dfp_api.yml.
-  dfp = DfpApi::Api.new
-
-  # To enable logging of SOAP requests, set the log_level value to 'DEBUG' in
-  # the configuration file or provide your own logger:
-  # dfp.logger = Logger.new('dfp_xml.log')
-
-  # Get the PlacementService.
-  placement_service = dfp.service(:PlacementService, API_VERSION)
-
-  # Set the ID of the placement to get.
-  placement_id = 'INSERT_PLACEMENT_ID_HERE'.to_i
-
-  # Get the placement.
-  placement = placement_service.get_placement(placement_id)
-
-  if placement
-    puts "Placement with ID: %d, name: %s and status %s was found." %
-        [placement[:id], placement[:name], placement[:status]]
-  else
-    puts 'No placement found for this ID.'
-  end
-end
-
-if __FILE__ == $0
-  begin
-    get_placement()
-
-  # HTTP errors.
-  rescue AdsCommon::Errors::HttpError => e
-    puts "HTTP Error: %s" % e
-
-  # API errors.
-  rescue DfpApi::Errors::ApiException => e
-    puts "Message: %s" % e.message
-    puts 'Errors:'
-    e.errors.each_with_index do |error, index|
-      puts "\tError [%d]:" % (index + 1)
-      error.each do |field, value|
-        puts "\t\t%s: %s" % [field, value]
-      end
-    end
-  end
-end

data/examples/v201103/publisher_query_language_service/get_all_cities.rb

@@ -1,84 +0,0 @@
-#!/usr/bin/ruby
-#
-# Author:: api.dklimkin@gmail.com (Danial Klimkin)
-#
-# Copyright:: Copyright 2011, Google Inc. All Rights Reserved.
-#
-# License:: Licensed under the Apache License, Version 2.0 (the "License");
-#           you may not use this file except in compliance with the License.
-#           You may obtain a copy of the License at
-#
-#           http://www.apache.org/licenses/LICENSE-2.0
-#
-#           Unless required by applicable law or agreed to in writing, software
-#           distributed under the License is distributed on an "AS IS" BASIS,
-#           WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
-#           implied.
-#           See the License for the specific language governing permissions and
-#           limitations under the License.
-#
-# This example gets first 500 cities available to target.
-#
-# Tags: PublisherQueryLanguageService.select
-
-require 'dfp_api'
-
-API_VERSION = :v201103
-# A string to separate columns in output. Use "," to get CSV.
-COLUMN_SEPARATOR = "\t"
-
-def get_all_cities()
-  # Get DfpApi instance and load configuration from ~/dfp_api.yml.
-  dfp = DfpApi::Api.new
-
-  # To enable logging of SOAP requests, set the log_level value to 'DEBUG' in
-  # the configuration file or provide your own logger:
-  # dfp.logger = Logger.new('dfp_xml.log')
-
-  # Get the PublisherQueryLanguageService.
-  pql_service = dfp.service(:PublisherQueryLanguageService, API_VERSION)
-
-  # Create statement to select all targetable cities.
-  statement = {:query => 'SELECT * FROM City WHERE targetable = true LIMIT 500'}
-
-  # Get all cities.
-  result_set = pql_service.select(statement)
-
-  if result_set
-    # Print out columns header.
-    columns = result_set[:column_types].collect {|col| col[:label_name]}
-    puts columns.join(COLUMN_SEPARATOR)
-
-    # Print out every row.
-    result_set[:rows].each do |row_set|
-        row = row_set[:values].collect {|item| item[:value]}
-        puts row.join(COLUMN_SEPARATOR)
-    end
-  end
-
-  # Print a footer.
-  if result_set[:rows]
-    puts "Total number of rows found: %d" % result_set[:rows].size
-  end
-end
-
-if __FILE__ == $0
-  begin
-    get_all_cities()
-
-  # HTTP errors.
-  rescue AdsCommon::Errors::HttpError => e
-    puts "HTTP Error: %s" % e
-
-  # API errors.
-  rescue DfpApi::Errors::ApiException => e
-    puts "Message: %s" % e.message
-    puts 'Errors:'
-    e.errors.each_with_index do |error, index|
-      puts "\tError [%d]:" % (index + 1)
-      error.each do |field, value|
-        puts "\t\t%s: %s" % [field, value]
-      end
-    end
-  end
-end

data/examples/v201103/publisher_query_language_service/get_all_countries.rb

@@ -1,84 +0,0 @@
-#!/usr/bin/ruby
-#
-# Author:: api.dklimkin@gmail.com (Danial Klimkin)
-#
-# Copyright:: Copyright 2011, Google Inc. All Rights Reserved.
-#
-# License:: Licensed under the Apache License, Version 2.0 (the "License");
-#           you may not use this file except in compliance with the License.
-#           You may obtain a copy of the License at
-#
-#           http://www.apache.org/licenses/LICENSE-2.0
-#
-#           Unless required by applicable law or agreed to in writing, software
-#           distributed under the License is distributed on an "AS IS" BASIS,
-#           WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
-#           implied.
-#           See the License for the specific language governing permissions and
-#           limitations under the License.
-#
-# This example gets all countries available to target.
-#
-# Tags: PublisherQueryLanguageService.select
-
-require 'dfp_api'
-
-API_VERSION = :v201103
-# A string to separate columns in output. Use "," to get CSV.
-COLUMN_SEPARATOR = "\t"
-
-def get_all_countries()
-  # Get DfpApi instance and load configuration from ~/dfp_api.yml.
-  dfp = DfpApi::Api.new
-
-  # To enable logging of SOAP requests, set the log_level value to 'DEBUG' in
-  # the configuration file or provide your own logger:
-  # dfp.logger = Logger.new('dfp_xml.log')
-
-  # Get the PublisherQueryLanguageService.
-  pql_service = dfp.service(:PublisherQueryLanguageService, API_VERSION)
-
-  # Create statement to select all targetable countries.
-  statement = {:query => 'SELECT * FROM Country WHERE targetable = true'}
-
-  # Get all countries.
-  result_set = pql_service.select(statement)
-
-  if result_set
-    # Print out columns header.
-    columns = result_set[:column_types].collect {|col| col[:label_name]}
-    puts columns.join(COLUMN_SEPARATOR)
-
-    # Print out every row.
-    result_set[:rows].each do |row_set|
-        row = row_set[:values].collect {|item| item[:value]}
-        puts row.join(COLUMN_SEPARATOR)
-    end
-  end
-
-  # Print a footer.
-  if result_set[:rows]
-    puts "Total number of rows found: %d" % result_set[:rows].size
-  end
-end
-
-if __FILE__ == $0
-  begin
-    get_all_countries()
-
-  # HTTP errors.
-  rescue AdsCommon::Errors::HttpError => e
-    puts "HTTP Error: %s" % e
-
-  # API errors.
-  rescue DfpApi::Errors::ApiException => e
-    puts "Message: %s" % e.message
-    puts 'Errors:'
-    e.errors.each_with_index do |error, index|
-      puts "\tError [%d]:" % (index + 1)
-      error.each do |field, value|
-        puts "\t\t%s: %s" % [field, value]
-      end
-    end
-  end
-end

data/examples/v201103/publisher_query_language_service/get_all_metros.rb

@@ -1,84 +0,0 @@
-#!/usr/bin/ruby
-#
-# Author:: api.dklimkin@gmail.com (Danial Klimkin)
-#
-# Copyright:: Copyright 2011, Google Inc. All Rights Reserved.
-#
-# License:: Licensed under the Apache License, Version 2.0 (the "License");
-#           you may not use this file except in compliance with the License.
-#           You may obtain a copy of the License at
-#
-#           http://www.apache.org/licenses/LICENSE-2.0
-#
-#           Unless required by applicable law or agreed to in writing, software
-#           distributed under the License is distributed on an "AS IS" BASIS,
-#           WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
-#           implied.
-#           See the License for the specific language governing permissions and
-#           limitations under the License.
-#
-# This example gets all metros available to target.
-#
-# Tags: PublisherQueryLanguageService.select
-
-require 'dfp_api'
-
-API_VERSION = :v201103
-# A string to separate columns in output. Use "," to get CSV.
-COLUMN_SEPARATOR = "\t"
-
-def get_all_metros()
-  # Get DfpApi instance and load configuration from ~/dfp_api.yml.
-  dfp = DfpApi::Api.new
-
-  # To enable logging of SOAP requests, set the log_level value to 'DEBUG' in
-  # the configuration file or provide your own logger:
-  # dfp.logger = Logger.new('dfp_xml.log')
-
-  # Get the PublisherQueryLanguageService.
-  pql_service = dfp.service(:PublisherQueryLanguageService, API_VERSION)
-
-  # Create statement to select all targetable metros.
-  statement = {:query => 'SELECT * FROM Metro WHERE targetable = true'}
-
-  # Get all metros.
-  result_set = pql_service.select(statement)
-
-  if result_set
-    # Print out columns header.
-    columns = result_set[:column_types].collect {|col| col[:label_name]}
-    puts columns.join(COLUMN_SEPARATOR)
-
-    # Print out every row.
-    result_set[:rows].each do |row_set|
-        row = row_set[:values].collect {|item| item[:value]}
-        puts row.join(COLUMN_SEPARATOR)
-    end
-  end
-
-  # Print a footer.
-  if result_set[:rows]
-    puts "Total number of rows found: %d" % result_set[:rows].size
-  end
-end
-
-if __FILE__ == $0
-  begin
-    get_all_metros()
-
-  # HTTP errors.
-  rescue AdsCommon::Errors::HttpError => e
-    puts "HTTP Error: %s" % e
-
-  # API errors.
-  rescue DfpApi::Errors::ApiException => e
-    puts "Message: %s" % e.message
-    puts 'Errors:'
-    e.errors.each_with_index do |error, index|
-      puts "\tError [%d]:" % (index + 1)
-      error.each do |field, value|
-        puts "\t\t%s: %s" % [field, value]
-      end
-    end
-  end
-end

data/examples/v201103/publisher_query_language_service/get_all_regions.rb

@@ -1,84 +0,0 @@
-#!/usr/bin/ruby
-#
-# Author:: api.dklimkin@gmail.com (Danial Klimkin)
-#
-# Copyright:: Copyright 2011, Google Inc. All Rights Reserved.
-#
-# License:: Licensed under the Apache License, Version 2.0 (the "License");
-#           you may not use this file except in compliance with the License.
-#           You may obtain a copy of the License at
-#
-#           http://www.apache.org/licenses/LICENSE-2.0
-#
-#           Unless required by applicable law or agreed to in writing, software
-#           distributed under the License is distributed on an "AS IS" BASIS,
-#           WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
-#           implied.
-#           See the License for the specific language governing permissions and
-#           limitations under the License.
-#
-# This example gets all regions available to target.
-#
-# Tags: PublisherQueryLanguageService.select
-
-require 'dfp_api'
-
-API_VERSION = :v201103
-# A string to separate columns in output. Use "," to get CSV.
-COLUMN_SEPARATOR = "\t"
-
-def get_all_regions()
-  # Get DfpApi instance and load configuration from ~/dfp_api.yml.
-  dfp = DfpApi::Api.new
-
-  # To enable logging of SOAP requests, set the log_level value to 'DEBUG' in
-  # the configuration file or provide your own logger:
-  # dfp.logger = Logger.new('dfp_xml.log')
-
-  # Get the PublisherQueryLanguageService.
-  pql_service = dfp.service(:PublisherQueryLanguageService, API_VERSION)
-
-  # Create statement to select all targetable regions.
-  statement = {:query => 'SELECT * FROM Region WHERE targetable = true'}
-
-  # Get all regions.
-  result_set = pql_service.select(statement)
-
-  if result_set
-    # Print out columns header.
-    columns = result_set[:column_types].collect {|col| col[:label_name]}
-    puts columns.join(COLUMN_SEPARATOR)
-
-    # Print out every row.
-    result_set[:rows].each do |row_set|
-        row = row_set[:values].collect {|item| item[:value]}
-        puts row.join(COLUMN_SEPARATOR)
-    end
-  end
-
-  # Print a footer.
-  if result_set[:rows]
-    puts "Total number of rows found: %d" % result_set[:rows].size
-  end
-end
-
-if __FILE__ == $0
-  begin
-    get_all_regions()
-
-  # HTTP errors.
-  rescue AdsCommon::Errors::HttpError => e
-    puts "HTTP Error: %s" % e
-
-  # API errors.
-  rescue DfpApi::Errors::ApiException => e
-    puts "Message: %s" % e.message
-    puts 'Errors:'
-    e.errors.each_with_index do |error, index|
-      puts "\tError [%d]:" % (index + 1)
-      error.each do |field, value|
-        puts "\t\t%s: %s" % [field, value]
-      end
-    end
-  end
-end

data/examples/v201103/report_service/download_report.rb

@@ -1,80 +0,0 @@
-#!/usr/bin/ruby
-#
-# Author:: api.dklimkin@gmail.com (Danial Klimkin)
-#
-# Copyright:: Copyright 2011, Google Inc. All Rights Reserved.
-#
-# License:: Licensed under the Apache License, Version 2.0 (the "License");
-#           you may not use this file except in compliance with the License.
-#           You may obtain a copy of the License at
-#
-#           http://www.apache.org/licenses/LICENSE-2.0
-#
-#           Unless required by applicable law or agreed to in writing, software
-#           distributed under the License is distributed on an "AS IS" BASIS,
-#           WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
-#           implied.
-#           See the License for the specific language governing permissions and
-#           limitations under the License.
-#
-# This example downloads a completed report. To run a report, run
-# run_delivery_report.rb, run_sales_report.rb or run_inventory_report.rb.
-#
-# Tags: ReportService.getReportDownloadURL
-
-require 'dfp_api'
-
-require 'open-uri'
-
-API_VERSION = :v201103
-
-def download_report()
-  # Get DfpApi instance and load configuration from ~/dfp_api.yml.
-  dfp = DfpApi::Api.new
-
-  # To enable logging of SOAP requests, set the log_level value to 'DEBUG' in
-  # the configuration file or provide your own logger:
-  # dfp.logger = Logger.new('dfp_xml.log')
-
-  # Get the ReportService.
-  report_service = dfp.service(:ReportService, API_VERSION)
-
-  # Set the ID of the completed report.
-  report_job_id = 'INSERT_REPORT_JOB_ID_HERE'.to_i
-
-  # Set the file path and name to save to.
-  file_name = 'INSERT_FILE_PATH_AND_NAME_HERE'
-
-  # Change to your preffered export format.
-  export_format = 'CSV'
-
-  # Get the report URL.
-  download_url = report_service.get_report_download_url(
-      report_job_id, export_format);
-
-  puts "Downloading [%s] to [%s]..." % [download_url, file_name]
-  open(file_name, 'wb') do |local_file|
-    local_file << open(download_url).read()
-  end
-end
-
-if __FILE__ == $0
-  begin
-    download_report()
-
-  # HTTP errors.
-  rescue AdsCommon::Errors::HttpError => e
-    puts "HTTP Error: %s" % e
-
-  # API errors.
-  rescue DfpApi::Errors::ApiException => e
-    puts "Message: %s" % e.message
-    puts 'Errors:'
-    e.errors.each_with_index do |error, index|
-      puts "\tError [%d]:" % (index + 1)
-      error.each do |field, value|
-        puts "\t\t%s: %s" % [field, value]
-      end
-    end
-  end
-end