google-dfp-api 0.17.0 → 0.19.0

data/examples/v201602/report_service/run_delivery_report.rb

@@ -1,111 +0,0 @@
-#!/usr/bin/env ruby
-# Encoding: utf-8
-#
-# 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.
-
-require 'date'
-require 'dfp_api'
-
-API_VERSION = :v201602
-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
-
-  # Specify a report to run for the last 7 days.
-  report_end_date = DateTime.now
-  report_start_date = report_end_date - 7
-
-  # Create report query.
-  report_query = {
-    :date_range_type => 'CUSTOM_DATE',
-    :start_date => {:year => report_start_date.year,
-                    :month => report_start_date.month,
-                    :day => report_start_date.day},
-    :end_date => {:year => report_end_date.year,
-                  :month => report_end_date.month,
-                  :day => report_end_date.day},
-    :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_status = report_service.get_report_job_status(report_job[:id])
-
-    break unless 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_service.get_report_job_status(report_job[:id])]
-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/v201602/report_service/run_inventory_report.rb

@@ -1,109 +0,0 @@
-#!/usr/bin/env ruby
-# Encoding: utf-8
-#
-# 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.
-
-require 'dfp_api'
-
-API_VERSION = :v201602
-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 and NetworkService.
-  report_service = dfp.service(:ReportService, API_VERSION)
-  network_service = dfp.service(:NetworkService, API_VERSION)
-
-  # Get the root ad unit ID to filter on.
-  root_ad_unit_id =
-      network_service.get_current_network()[:effective_root_ad_unit_id]
-
-  # Create statement to filter on a parent ad unit with the root ad unit ID
-  # to include all ad units in the network.
-  statement = {
-     :query => 'WHERE PARENT_AD_UNIT_ID = :parent_ad_unit_id',
-     :values => [
-         {:key => 'parent_ad_unit_id',
-          :value => {:value => root_ad_unit_id, :xsi_type => 'NumberValue'}}
-     ]
-  }
-
-  # 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'
-    ],
-    :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_status = report_service.get_report_job_status(report_job[:id])
-
-    break unless 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_service.get_report_job_status(report_job[:id])]
-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/v201602/report_service/run_reach_report.rb

@@ -1,85 +0,0 @@
-#!/usr/bin/env ruby
-# Encoding: utf-8
-#
-# 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.
-
-require 'dfp_api'
-
-API_VERSION = :v201602
-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_status = report_service.get_report_job_status(report_job[:id])
-
-    break unless 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_service.get_report_job_status(report_job[:id])]
-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/v201602/report_service/run_report_with_custom_fields.rb

@@ -1,89 +0,0 @@
-#!/usr/bin/env ruby
-# Encoding: utf-8
-#
-# 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 filtered on a single custom field. To download the
-# report see download_report.rb.
-
-require 'dfp_api'
-
-API_VERSION = :v201602
-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 ReportService.
-  report_service = dfp.service(:ReportService, API_VERSION)
-
-  # Set the ID of the custom field to filter on.
-  custom_field_id = 'INSERT_CUSTOM_FIELD_ID_HERE'.to_i
-
-  # Create report query.
-  report_query = {
-    :date_range_type => 'LAST_MONTH',
-    :dimensions => ['LINE_ITEM_ID', 'LINE_ITEM_NAME'],
-    :custom_field_ids => [custom_field_id],
-    :columns => ['AD_SERVER_IMPRESSIONS'],
-  }
-
-  # 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_status = report_service.get_report_job_status(report_job[:id])
-
-    break unless 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_service.get_report_job_status(report_job[:id])]
-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

data/examples/v201602/report_service/run_sales_report.rb

@@ -1,89 +0,0 @@
-#!/usr/bin/env ruby
-# Encoding: utf-8
-#
-# 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 "Sales by salespersons report" on the
-# DFP website. To download the report see download_report.rb.
-
-require 'dfp_api'
-
-API_VERSION = :v201602
-MAX_RETRIES = 10
-RETRY_INTERVAL = 30
-
-def run_sales_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 => ['SALESPERSON_ID', 'SALESPERSON_NAME'],
-    :columns => [
-        'AD_SERVER_IMPRESSIONS',
-        'AD_SERVER_CPM_AND_CPC_REVENUE',
-        '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_status = report_service.get_report_job_status(report_job[:id])
-
-    break unless 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_service.get_report_job_status(report_job[:id])]
-end
-
-if __FILE__ == $0
-  begin
-    run_sales_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/v201602/suggested_ad_unit_service/approve_all_suggested_ad_units.rb

@@ -1,108 +0,0 @@
-#!/usr/bin/env ruby
-# Encoding: utf-8
-#
-# 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.
-
-require 'dfp_api'
-
-
-API_VERSION = :v201602
-NUMBER_OF_REQUESTS = 50
-
-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)
-
-  # Create a statement to only select suggested ad units with 50 or more
-  # requests.
-  statement = DfpApi::FilterStatement.new(
-      'WHERE numRequests >= :num_requests',
-      [
-          {:key => 'num_requests',
-           :value => {:value => NUMBER_OF_REQUESTS,
-                      :xsi_type => 'NumberValue'}}
-      ]
-  )
-
-  begin
-    # Get suggested ad units by statement.
-    page = suggested_ad_unit_service.get_suggested_ad_units_by_statement(
-        statement.toStatement())
-
-    unit_count_to_approve = 0
-
-    if page[:results]
-      page[:results].each_with_index do |ad_unit, index|
-        if ad_unit[:num_requests] >= NUMBER_OF_REQUESTS
-          puts(("%d) Suggested ad unit with ID '%s' and %d requests will be " +
-              "approved.") % [index + statement.offset, ad_unit[:id],
-              ad_unit[:num_requests]])
-          unit_count_to_approve += 1
-        end
-      end
-    end
-    statement.offset += DfpApi::SUGGESTED_PAGE_LIMIT
-  end
-
-  puts "Number of suggested ad units to be approved: %d" % unit_count_to_approve
-
-  if unit_count_to_approve > 0
-    # Perform action with the same statement.
-    result = suggested_ad_unit_service.perform_suggested_ad_unit_action(
-        {:xsi_type => 'ApproveSuggestedAdUnits'}, 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

data/examples/v201602/suggested_ad_unit_service/get_all_suggested_ad_units.rb

@@ -1,83 +0,0 @@
-#!/usr/bin/env ruby
-# Encoding: utf-8
-#
-# 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 suggested ad units. To approve suggested ad units, run
-# approve_suggested_ad_units.rb.
-#
-# This feature is only available to DFP premium solution networks.
-
-require 'dfp_api'
-
-
-API_VERSION = :v201602
-
-def get_all_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)
-
-  # Create a statement to get all suggested ad units.
-  statement = DfpApi::FilterStatement.new('ORDER BY id ASC')
-
-  begin
-    # Get suggested ad units by statement.
-    page = suggested_ad_unit_service.get_suggested_ad_units_by_statement(
-        statement.toStatement())
-
-    if page[:results]
-      # Print details about each suggested ad unit in results.
-      page[:results].each_with_index do |ad_unit, index|
-        puts "%d) Suggested ad unit ID: '%s' with number of requests: %d" %
-            [index + statement.offset, ad_unit[:id], ad_unit[:num_requests]]
-      end
-    end
-    statement.offset += DfpApi::SUGGESTED_PAGE_LIMIT
-  end while statement.offset < page[:total_result_set_size]
-
-  # Print a footer.
-  if page.include?(:total_result_set_size)
-    puts "Total number of suggested ad units: %d" % page[:total_result_set_size]
-  end
-end
-
-if __FILE__ == $0
-  begin
-    get_all_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