google-dfp-api 0.6.1 → 0.6.2

data/examples/v201302/report_service/run_delivery_report.rb

@@ -0,0 +1,103 @@
+#!/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 = :v201302
+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/v201302/report_service/run_inventory_report.rb

@@ -0,0 +1,96 @@
+#!/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 = :v201302
+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

data/examples/v201302/report_service/run_merged_delivery_report.rb

@@ -0,0 +1,94 @@
+#!/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 that an upgraded publisher would use to include
+# statistics before the upgrade. To download the report see download_report.rb.
+#
+# Tags: ReportService.runReportJob, ReportService.getReportJob
+
+require 'dfp_api'
+
+API_VERSION = :v201302
+MAX_RETRIES = 10
+RETRY_INTERVAL = 30
+
+def run_merged_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_ID', 'ORDER_NAME'],
+    :columns => [
+        'MERGED_AD_SERVER_IMPRESSIONS',
+        'MERGED_AD_SERVER_CLICKS',
+        'MERGED_AD_SERVER_CTR',
+        'MERGED_AD_SERVER_CPM_AND_CPC_REVENUE',
+        'MERGED_AD_SERVER_WITHOUT_CPD_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_merged_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/v201302/report_service/run_reach_report.rb

@@ -0,0 +1,87 @@
+#!/usr/bin/ruby
+#
+# 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 runs a reach report. To download the report see
+# download_report.rb.
+#
+# Tags: ReportService.runReportJob, ReportService.getReportJob
+
+require 'dfp_api'
+
+API_VERSION = :v201302
+MAX_RETRIES = 10
+RETRY_INTERVAL = 30
+
+def run_reach_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 => 'REACH_LIFETIME',
+    :dimensions => ['LINE_ITEM_ID', 'LINE_ITEM_NAME'],
+    :columns => ['REACH_FREQUENCY', 'REACH_AVERAGE_REVENUE', 'REACH']
+  }
+
+  # 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_reach_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/v201302/report_service/run_report_with_custom_fields.rb

@@ -0,0 +1,135 @@
+#!/usr/bin/env ruby
+# Encoding: utf-8
+#
+# Author:: api.dklimkin@gmail.com (Danial Klimkin)
+#
+# Copyright:: Copyright 2012, 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 that includes custom fields found in the line items
+# of an order. To download the report see download_report.rb.
+#
+# Tags: LineItemService.getLineItemByStatement
+# Tags: ReportService.runReportJob, ReportService.getReportJob
+
+require 'dfp_api'
+
+API_VERSION = :v201302
+PAGE_SIZE = 500
+MAX_RETRIES = 10
+RETRY_INTERVAL = 30
+
+def run_report_with_custom_fields()
+  # 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 LineItemService.
+  line_item_service = dfp.service(:LineItemService, API_VERSION)
+
+  # Get the ReportService.
+  report_service = dfp.service(:ReportService, API_VERSION)
+
+  # Set the ID of the order to get line items from.
+  order_id = 'INSERT_ORDER_ID_HERE'.to_i
+
+  # Define initial values.
+  offset = 0
+  page = {}
+  custom_field_ids = []
+
+  # Create a statement to only select line items from a given order.
+  statement = {
+      :values => [
+          {:key => 'order_id',
+           :value => {:value => order_id, :xsi_type => 'NumberValue'}}
+      ]
+  }
+  query_text = 'WHERE orderId = :order_id LIMIT %d OFFSET %d'
+
+  begin
+    # Update the statement to get one page with current offset.
+    statement[:query] = query_text % [PAGE_SIZE, offset]
+
+    # Get line items by statement.
+    page = line_item_service.get_line_items_by_statement(statement)
+
+    if page[:results]
+      # Increase query offset by page size.
+      offset += PAGE_SIZE
+
+      # Get custom field IDs from the line items of an order.
+      page[:results].each do |line_item|
+        if line_item[:custom_field_values]
+          line_item[:custom_field_values].each do |value|
+            custom_field_ids |= [value[:custom_field_id]]
+          end
+        end
+      end
+    end
+  end while offset < page[:total_result_set_size]
+
+  # Create report query.
+  statement[:query] = 'WHERE ORDER_ID = :order_id'
+  report_query = {
+    :date_range_type => 'LAST_MONTH',
+    :dimensions => ['LINE_ITEM_ID', 'LINE_ITEM_NAME'],
+    :custom_field_ids => custom_field_ids,
+    :columns => ['AD_SERVER_IMPRESSIONS'],
+    :statement => statement
+  }
+
+  # 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_report_with_custom_fields()
+
+  # 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