google-dfp-api 0.18.0 → 0.19.0

data/examples/v201608/publisher_query_language_service/get_geo_targets.rb

@@ -1,98 +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 cities available to target. A full list of
-# available PQL tables can be found at:
-#
-# https://developers.google.com/doubleclick-publishers/docs/reference/latest/PublisherQueryLanguageService
-
-require 'dfp_api'
-
-
-API_VERSION = :v201608
-# A string to separate columns in output. Use "," to get CSV.
-COLUMN_SEPARATOR = "\t"
-
-def get_geo_targets()
-  # 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 a statement to select all targetable cities.
-  statement_text = "SELECT Id, Name, CanonicalParentId, ParentIds, " +
-      "CountryCode, Type, Targetable FROM Geo_Target WHERE Type = 'City' " +
-      "AND Targetable = true ORDER BY Id ASC"
-
-  statement = DfpApi::FilterStatement.new(statement_text)
-
-  # Set initial values for paging.
-  result_set, all_rows = nil, 0
-
-  # Get all cities with paging.
-  begin
-    result_set = pql_service.select(statement.toStatement())
-
-    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
-
-    # Update the counters.
-    statement.offset += DfpApi::SUGGESTED_PAGE_LIMIT
-    all_rows += result_set[:rows].size
-  end while result_set[:rows].size == DfpApi::SUGGESTED_PAGE_LIMIT
-
-  # Print a footer.
-  if result_set[:rows]
-    puts "Total number of rows found: %d" % all_rows
-  end
-end
-
-if __FILE__ == $0
-  begin
-    get_geo_targets()
-
-  # 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/v201608/publisher_query_language_service/get_line_items_named_like.rb

@@ -1,96 +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 gets all line items which have a name beginning with "line item".
-# This example may take a while to run.
-
-require 'dfp_api'
-
-
-API_VERSION = :v201608
-# A string to separate columns in output. Use "," to get CSV.
-COLUMN_SEPARATOR = "\t"
-
-def get_line_items_named_like()
-  # 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 a statement to select all line items matching subtext.
-  statement_text =
-      "SELECT Id, Name, Status FROM Line_Item WHERE Name LIKE 'line item%%' " +
-      "ORDER BY Id ASC"
-
-  statement = DfpApi::FilterStatement.new(statement_text)
-
-  # Set initial values for paging.
-  result_set, all_rows = nil, 0
-
-  # Get all line items starting with "line item".
-  begin
-    result_set = pql_service.select(statement.toStatement())
-
-    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
-
-    # Update the counters.
-    statement.offset += DfpApi::SUGGESTED_PAGE_LIMIT
-    all_rows += result_set[:rows].size
-  end while result_set[:rows].size == DfpApi::SUGGESTED_PAGE_LIMIT
-
-  # Print a footer.
-  if result_set[:rows]
-    puts "Total number of rows found: %d" % all_rows
-  end
-end
-
-if __FILE__ == $0
-  begin
-    get_line_items_named_like()
-
-  # 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/v201608/report_service/display_report.rb

@@ -1,77 +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 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.
-
-require 'dfp_api'
-
-require 'open-uri'
-
-API_VERSION = :v201608
-
-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/v201608/report_service/download_report.rb

@@ -1,77 +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 downloads a completed report. To run a report, run
-# run_delivery_report.rb, run_sales_report.rb or run_inventory_report.rb.
-
-require 'dfp_api'
-
-require 'open-uri'
-
-API_VERSION = :v201608
-
-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/v201608/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 = :v201608
-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