google-dfp-api 0.7.1 → 0.8.0

data/examples/v201308/placement_service/update_placements.rb

@@ -1,97 +0,0 @@
-#!/usr/bin/env ruby
-# Encoding: utf-8
-#
-# 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 updates all placements to allow for AdSense targeting up to the
-# first 500. To determine which placements exist, run get_all_placements.rb.
-#
-# Tags: PlacementService.getPlacementsByStatement
-# Tags: PlacementService.updatePlacements
-
-require 'dfp_api'
-
-API_VERSION = :v201308
-
-def update_placements()
-  # 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)
-
-  # Create a statement to get first 500 placements.
-  statement = {:query => 'LIMIT 500'}
-
-  # Get placements by statement.
-  page = placement_service.get_placements_by_statement(statement)
-
-  if page[:results]
-    placements = page[:results]
-
-    # Update each local placement object by enabling AdSense targeting.
-    placements.each do |placement|
-      placement[:targeting_description] =
-          (placement[:description].nil? || placement[:description].empty?) ?
-          'Generic description' : placement[:description]
-      placement[:targeting_ad_location] = 'All images on sports pages.'
-      placement[:targeting_site_name] = 'http://code.google.com'
-      placement[:is_ad_sense_targeting_enabled] = true
-    end
-
-    # Update the placements on the server.
-    return_placements = placement_service.update_placements(placements)
-
-    if return_placements
-      return_placements.each do |placement|
-        puts ("Placement ID: %d, name: %s was updated with AdSense targeting " +
-              "enabled: %s.") % [placement[:id], placement[:name],
-                                 placement[:is_ad_sense_targeting_enabled]]
-      end
-    else
-      raise 'No placements were updated.'
-    end
-  else
-    puts 'No placements found to update.'
-  end
-end
-
-if __FILE__ == $0
-  begin
-    update_placements()
-
-  # 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/v201308/report_service/display_report.rb

@@ -1,81 +0,0 @@
-#!/usr/bin/env ruby
-# Encoding: utf-8
-#
-# Author:: api.davidtorres@gmail.com (David Torres)
-#
-# Copyright:: Copyright 2013, 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 and prints out its contents. To
-# download a completed report to a file, run download_report.rb. To run
-# a report, run run_delivery_report.rb.
-#
-# Tags: ReportService.getReportDownloadURL
-
-require 'dfp_api'
-
-require 'open-uri'
-
-API_VERSION = :v201308
-
-def display_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 format of the report (e.g. CSV_DUMP) and download without
-  # compression so we can print it.
-  report_download_options = {
-      :export_format => 'CSV_DUMP',
-      :use_gzip_compression => false
-  }
-
-  # Get the report URL.
-  download_url = report_service.get_report_download_url_with_options(
-      report_job_id, report_download_options);
-
-  puts "Downloading report from URL %s.\n" % download_url
-  puts open(download_url).read()
-end
-
-if __FILE__ == $0
-  begin
-    display_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/v201308/report_service/download_report.rb

@@ -1,81 +0,0 @@
-#!/usr/bin/env ruby
-# Encoding: utf-8
-#
-# 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 = :v201308
-
-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_DUMP'
-
-  # 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/v201308/report_service/run_delivery_report.rb

@@ -1,103 +0,0 @@
-#!/usr/bin/env ruby
-# Encoding: utf-8
-#
-# 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 similar to the "Orders report" on the DFP website
-# with additional attributes and can filter to include just one order.
-# To download the report see download_report.rb.
-#
-# Tags: ReportService.runReportJob, ReportService.getReportJob
-
-require 'dfp_api'
-
-API_VERSION = :v201308
-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)
-
-  # Specify the order ID to filter by.
-  order_id = 'INSERT_ORDER_ID_HERE'.to_i
-
-  # Create report query.
-  report_query = {
-    :date_range_type => 'LAST_MONTH',
-    :dimensions => ['ORDER_ID', 'ORDER_NAME'],
-    :dimension_attributes => ['ORDER_TRAFFICKER', 'ORDER_START_DATE_TIME',
-        'ORDER_END_DATE_TIME'],
-    :columns => ['AD_SERVER_IMPRESSIONS', 'AD_SERVER_CLICKS', 'AD_SERVER_CTR',
-        'AD_SERVER_CPM_AND_CPC_REVENUE', 'AD_SERVER_WITHOUT_CPD_AVERAGE_ECPM'],
-    # Create statement object to filter for an order.
-    :statement => {
-        :query => 'WHERE ORDER_ID = :order_id',
-        :values => [
-            {:key => 'order_id',
-             :value => {:value => order_id, :xsi_type => 'NumberValue'}}
-        ]
-    }
-  }
-
-  # 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/v201308/report_service/run_inventory_report.rb

@@ -1,96 +0,0 @@
-#!/usr/bin/env ruby
-# Encoding: utf-8
-#
-# 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 = :v201308
-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', 'AD_UNIT_NAME'],
-    :ad_unit_view => 'HIERARCHICAL',
-    :columns => [
-        'AD_SERVER_IMPRESSIONS',
-        'AD_SERVER_CLICKS',
-        'DYNAMIC_ALLOCATION_INVENTORY_LEVEL_IMPRESSIONS',
-        'DYNAMIC_ALLOCATION_INVENTORY_LEVEL_CLICKS',
-        'TOTAL_INVENTORY_LEVEL_IMPRESSIONS',
-        'TOTAL_INVENTORY_LEVEL_CPM_AND_CPC_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