google-dfp-api 0.4.0 → 0.5.0

data/examples/v201111/publisher_query_language_service/get_all_postal_codes.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 targetable postal codes.
-#
-# Tags: PublisherQueryLanguageService.select
-
-require 'dfp_api'
-
-API_VERSION = :v201111
-# A string to separate columns in output. Use "," to get CSV.
-COLUMN_SEPARATOR = "\t"
-
-def get_all_postal_codes()
-  # 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 postal codes.
-  statement = {:query => 'SELECT * FROM Postal_Code WHERE targetable = true'}
-
-  # Get all postal codes.
-  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_postal_codes()
-
-  # 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/v201111/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 = :v201111
-# 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/v201111/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 = :v201111
-
-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

data/examples/v201111/report_service/run_delivery_report.rb

@@ -1,90 +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 runs a report equal to the "Orders report" on the DFP website.
-# To download the report see download_report.rb.
-#
-# Tags: ReportService.runReportJob, ReportService.getReportJob
-
-require 'dfp_api'
-
-API_VERSION = :v201111
-MAX_RETRIES = 10
-RETRY_INTERVAL = 30
-
-def run_delivery_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)
-
-  # Create report query.
-  report_query = {
-    :date_range_type => 'LAST_MONTH',
-    :dimensions => ['ORDER'],
-    :dimension_attributes => ['ORDER_TRAFFICKER', 'ORDER_START_DATE_TIME',
-        'ORDER_END_DATE_TIME']
-    :columns => ['AD_SERVER_IMPRESSIONS', 'AD_SERVER_CLICKS', 'AD_SERVER_CTR',
-        'AD_SERVER_REVENUE', 'AD_SERVER_AVERAGE_ECPM']
-  }
-
-  # Create report job.
-  report_job = {:report_query => report_query}
-
-  # Run report job.
-  report_job = report_service.run_report_job(report_job);
-
-  MAX_RETRIES.times do |retry_count|
-    # Get the report job status.
-    report_job = report_service.get_report_job(report_job[:id])
-
-    break unless report_job[:report_job_status] == 'IN_PROGRESS'
-    puts "Report with ID: %d is still running." % report_job[:id]
-    sleep(RETRY_INTERVAL)
-  end
-
-  puts "Report job with ID: %d finished with status %s." %
-      [report_job[:id], report_job[:report_job_status]]
-end
-
-if __FILE__ == $0
-  begin
-    run_delivery_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

data/examples/v201111/report_service/run_inventory_report.rb

@@ -1,89 +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 runs a report equal to the "Whole network report" on the DFP
-# website. To download the report see download_report.rb.
-#
-# Tags: ReportService.runReportJob, ReportService.getReportJob
-
-require 'dfp_api'
-
-API_VERSION = :v201111
-MAX_RETRIES = 10
-RETRY_INTERVAL = 30
-
-def run_inventory_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)
-
-  # Create report query.
-  report_query = {
-    :date_range_type => 'LAST_WEEK',
-    :dimensions => ['DATE'],
-    :columns => ['AD_SERVER_IMPRESSIONS', 'AD_SERVER_CLICKS',
-        'ADSENSE_IMPRESSIONS', 'ADSENSE_CLICKS', 'TOTAL_IMPRESSIONS',
-        'TOTAL_REVENUE']
-  }
-
-  # Create report job.
-  report_job = {:report_query => report_query}
-
-  # Run report job.
-  report_job = report_service.run_report_job(report_job);
-
-  MAX_RETRIES.times do |retry_count|
-    # Get the report job status.
-    report_job = report_service.get_report_job(report_job[:id])
-
-    break unless report_job[:report_job_status] == 'IN_PROGRESS'
-    puts "Report with ID: %d is still running." % report_job[:id]
-    sleep(RETRY_INTERVAL)
-  end
-
-  puts "Report job with ID: %d finished with status %s." %
-      [report_job[:id], report_job[:report_job_status]]
-end
-
-if __FILE__ == $0
-  begin
-    run_inventory_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

data/examples/v201111/suggested_ad_unit_service/approve_suggested_ad_units.rb

@@ -1,115 +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 code example approves all suggested ad units with 50 or more requests.
-#
-# This feature is only available to DFP premium solution networks.
-#
-# Tags: SuggestedAdUnitService.getSuggestedAdUnitsByStatement,
-#       SuggestedAdUnitService.performSuggestedAdUnitAction
-
-require 'dfp_api'
-
-API_VERSION = :v201111
-NUMBER_OF_REQUESTS = 50
-PAGE_SIZE = 500
-
-def approve_suggested_ad_units()
-  # 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 SuggestedAdUnitService.
-  suggested_ad_unit_service = dfp.service(:SuggestedAdUnitService, API_VERSION)
-
-  # Define initial values.
-  offset = 0
-  page = {}
-  suggested_ad_unit_ids = []
-
-  begin
-    # Create statement text to select all suggested ad units.
-    statement = {:query => "LIMIT %d OFFSET %d" % [PAGE_SIZE, offset]}
-
-    # Get suggested ad units by statement.
-    page =
-        suggested_ad_unit_service.get_suggested_ad_units_by_statement(statement)
-
-    if page[:results]
-      # Increase query offset by page size.
-      offset += PAGE_SIZE
-
-      page[:results].each do |ad_unit|
-        if ad_unit[:num_requests] >= NUMBER_OF_REQUESTS
-          puts(("%d) Suggested ad unit with ID '%s' and %d requests will be " +
-              "approved.") % [suggested_ad_unit_ids.size, ad_unit[:id],
-              ad_unit[:num_requests]])
-          suggested_ad_unit_ids << ad_unit[:id]
-        end
-      end
-    end
-  end while offset < page[:total_result_set_size]
-
-  puts "Number of suggested ad units to be approved: %d" %
-      suggested_ad_unit_ids.size
-
-  unless suggested_ad_unit_ids.empty?
-    # Create statement for action.
-    statement = {
-        :query => "WHERE id IN (%s)" % suggested_ad_unit_ids.join(', ')
-    }
-
-    # Perform action.
-    result = suggested_ad_unit_service.perform_suggested_ad_unit_action(
-        {:xsi_type => 'ApproveSuggestedAdUnit'}, statement)
-
-    # Display results.
-    if result and result[:num_changes] > 0
-      puts "Number of ad units approved: %d" % result[:num_changes]
-    else
-      puts 'No ad units were approved.'
-    end
-  else
-    puts 'No ad units found to approve.'
-  end
-end
-
-if __FILE__ == $0
-  begin
-    approve_suggested_ad_units()
-
-  # 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