google-dfp-api 0.6.3 → 0.7.0

data/examples/{v201206 → v201308}/order_service/approve_orders.rb

@@ -27,7 +27,7 @@
 require 'date'
 require 'dfp_api'
 
-API_VERSION = :v201206
+API_VERSION = :v201308
 PAGE_SIZE = 500
 
 def approve_orders()

data/examples/{v201206 → v201308}/order_service/create_orders.rb

@@ -27,7 +27,7 @@
 
 require 'dfp_api'
 
-API_VERSION = :v201206
+API_VERSION = :v201308
 # Number of orders to create.
 ITEM_COUNT = 5
 

data/examples/{v201206 → v201308}/order_service/get_all_orders.rb

@@ -24,7 +24,7 @@
 
 require 'dfp_api'
 
-API_VERSION = :v201206
+API_VERSION = :v201308
 PAGE_SIZE = 500
 
 def get_all_orders()

data/examples/{v201204 → v201308}/order_service/get_order.rb

@@ -25,7 +25,7 @@
 
 require 'dfp_api'
 
-API_VERSION = :v201204
+API_VERSION = :v201308
 
 def get_order()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.

data/examples/{v201206 → v201308}/order_service/get_orders_by_statement.rb

@@ -27,7 +27,7 @@
 
 require 'dfp_api'
 
-API_VERSION = :v201206
+API_VERSION = :v201308
 
 def get_orders_by_statement()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.

data/examples/{v201204 → v201308}/order_service/update_orders.rb

@@ -25,7 +25,7 @@
 
 require 'dfp_api'
 
-API_VERSION = :v201204
+API_VERSION = :v201308
 
 def update_orders()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.
@@ -51,6 +51,8 @@ def update_orders()
       # Archived orders can not be updated.
       if !order[:is_archived]
         order[:notes] = 'Spoke to advertiser. All is well.'
+        # Workaround for issue #94.
+        order[:po_number] = "" if order[:po_number].nil?
         new_orders << order
       end
       new_orders

data/examples/{v201204 → v201308}/placement_service/create_placements.rb

@@ -26,7 +26,7 @@
 
 require 'dfp_api'
 
-API_VERSION = :v201204
+API_VERSION = :v201308
 
 def create_placements()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.

data/examples/{v201206 → v201308}/placement_service/deactivate_placements.rb

@@ -26,7 +26,7 @@
 
 require 'dfp_api'
 
-API_VERSION = :v201206
+API_VERSION = :v201308
 PAGE_SIZE = 500
 
 def deactivate_placements()

data/examples/{v201206 → v201308}/placement_service/get_all_placements.rb

@@ -25,7 +25,7 @@
 
 require 'dfp_api'
 
-API_VERSION = :v201206
+API_VERSION = :v201308
 PAGE_SIZE = 500
 
 def get_all_placements()

data/examples/{v201204 → v201308}/placement_service/get_placement.rb

@@ -25,7 +25,7 @@
 
 require 'dfp_api'
 
-API_VERSION = :v201204
+API_VERSION = :v201308
 
 def get_placement()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.

data/examples/{v201204 → v201308}/placement_service/get_placements_by_statement.rb

@@ -26,7 +26,7 @@
 
 require 'dfp_api'
 
-API_VERSION = :v201204
+API_VERSION = :v201308
 
 def get_placements_by_statement()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.

data/examples/{v201206 → v201308}/placement_service/update_placements.rb

@@ -26,7 +26,7 @@
 
 require 'dfp_api'
 
-API_VERSION = :v201206
+API_VERSION = :v201308
 
 def update_placements()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.

data/examples/{v201206/publisher_query_language_service/get_all_cities.rb → v201308/publisher_query_language_service/get_all_line_items.rb}

@@ -3,7 +3,7 @@
 #
 # Author:: api.dklimkin@gmail.com (Danial Klimkin)
 #
-# Copyright:: Copyright 2011, Google Inc. All Rights Reserved.
+# 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.
@@ -18,20 +18,21 @@
 #           See the License for the specific language governing permissions and
 #           limitations under the License.
 #
-# This example gets first 500 cities available to target. A full list of
-# available tables can be found at:
+# This example gets all line items in your network using the Line_Item table.
+# The Line_Item PQL table schema can be found here:
 #
-# https://developers.google.com/doubleclick-publishers/docs/reference/v201204/PublisherQueryLanguageService
+# https://developers.google.com/doubleclick-publishers/docs/reference/latest/PublisherQueryLanguageService
 #
 # Tags: PublisherQueryLanguageService.select
 
 require 'dfp_api'
 
-API_VERSION = :v201206
+API_VERSION = :v201308
 # A string to separate columns in output. Use "," to get CSV.
 COLUMN_SEPARATOR = "\t"
+PAGE_SIZE = 500
 
-def get_all_cities()
+def get_all_line_items()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.
   dfp = DfpApi::Api.new
 
@@ -42,35 +43,44 @@ def get_all_cities()
   # Get the PublisherQueryLanguageService.
   pql_service = dfp.service(:PublisherQueryLanguageService, API_VERSION)
 
-  # Create statement to select all targetable cities.
-  # For criteria that do not have a "targetable" property, the predicate may be
-  # left off.
-  statement = {:query => 'SELECT * FROM City WHERE targetable = true LIMIT 500'}
+  # Statement parts to help build a statement to select all line items.
+  statement_text = 'SELECT Id, Name, Status FROM Line_Item LIMIT %d OFFSET %d'
 
-  # Get all cities.
-  result_set = pql_service.select(statement)
+  # Set initial values for paging.
+  offset, result_set, all_rows = 0, nil, 0
 
-  if result_set
-    # Print out columns header.
-    columns = result_set[:column_types].collect {|col| col[:label_name]}
-    puts columns.join(COLUMN_SEPARATOR)
+  # Get all line items with paging.
+  begin
+    # Create statement for a page.
+    statement = {:query => statement_text % [PAGE_SIZE, offset]}
+    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)
+      # 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
-  end
+
+    # Update the counters.
+    offset += PAGE_SIZE
+    all_rows += result_set[:rows].size
+  end while result_set[:rows].size == PAGE_SIZE
 
   # Print a footer.
   if result_set[:rows]
-    puts "Total number of rows found: %d" % result_set[:rows].size
+    puts "Total number of rows found: %d" % all_rows
   end
 end
 
 if __FILE__ == $0
   begin
-    get_all_cities()
+    get_all_line_items()
 
   # HTTP errors.
   rescue AdsCommon::Errors::HttpError => e

data/examples/{v201204/publisher_query_language_service/get_all_cities.rb → v201308/publisher_query_language_service/get_geo_targets.rb}

@@ -19,19 +19,20 @@
 #           limitations under the License.
 #
 # This example gets first 500 cities available to target. A full list of
-# available tables can be found at:
+# available PQL tables can be found at:
 #
-# https://developers.google.com/doubleclick-publishers/docs/reference/v201204/PublisherQueryLanguageService
+# https://developers.google.com/doubleclick-publishers/docs/reference/latest/PublisherQueryLanguageService
 #
 # Tags: PublisherQueryLanguageService.select
 
 require 'dfp_api'
 
-API_VERSION = :v201204
+API_VERSION = :v201308
 # A string to separate columns in output. Use "," to get CSV.
 COLUMN_SEPARATOR = "\t"
+PAGE_SIZE = 500
 
-def get_all_cities()
+def get_geo_targets()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.
   dfp = DfpApi::Api.new
 
@@ -42,35 +43,46 @@ def get_all_cities()
   # Get the PublisherQueryLanguageService.
   pql_service = dfp.service(:PublisherQueryLanguageService, API_VERSION)
 
-  # Create statement to select all targetable cities.
-  # For criteria that do not have a "targetable" property, the predicate may be
-  # left off.
-  statement = {:query => 'SELECT * FROM City WHERE targetable = true LIMIT 500'}
+  # 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 LIMIT %d OFFSET %d"
 
-  # Get all cities.
-  result_set = pql_service.select(statement)
+  # Set initial values for paging.
+  offset, result_set, all_rows = 0, nil, 0
 
-  if result_set
-    # Print out columns header.
-    columns = result_set[:column_types].collect {|col| col[:label_name]}
-    puts columns.join(COLUMN_SEPARATOR)
+  # Get all cities with paging.
+  begin
+    # Create statement for a page.
+    statement = {:query => statement_text % [PAGE_SIZE, offset]}
+    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)
+      # 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
-  end
+
+    # Update the counters.
+    offset += PAGE_SIZE
+    all_rows += result_set[:rows].size
+  end while result_set[:rows].size == PAGE_SIZE
 
   # Print a footer.
   if result_set[:rows]
-    puts "Total number of rows found: %d" % result_set[:rows].size
+    puts "Total number of rows found: %d" % all_rows
   end
 end
 
 if __FILE__ == $0
   begin
-    get_all_cities()
+    get_geo_targets()
 
   # HTTP errors.
   rescue AdsCommon::Errors::HttpError => e

data/examples/{v201203/publisher_query_language_service/get_all_cities.rb → v201308/publisher_query_language_service/get_line_items_named_like.rb}

@@ -1,8 +1,9 @@
-#!/usr/bin/ruby
+#!/usr/bin/env ruby
+# Encoding: utf-8
 #
 # Author:: api.dklimkin@gmail.com (Danial Klimkin)
 #
-# Copyright:: Copyright 2011, Google Inc. All Rights Reserved.
+# 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.
@@ -17,20 +18,19 @@
 #           See the License for the specific language governing permissions and
 #           limitations under the License.
 #
-# This example gets first 500 cities available to target. A full list of
-# available tables can be found at:
-#
-# https://developers.google.com/doubleclick-publishers/docs/reference/v201203/PublisherQueryLanguageService
+# This example gets all line items which have a name beginning with "line item".
+# This example may take a while to run.
 #
 # Tags: PublisherQueryLanguageService.select
 
 require 'dfp_api'
 
-API_VERSION = :v201203
+API_VERSION = :v201308
 # A string to separate columns in output. Use "," to get CSV.
 COLUMN_SEPARATOR = "\t"
+PAGE_SIZE = 500
 
-def get_all_cities()
+def get_line_items_named_like()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.
   dfp = DfpApi::Api.new
 
@@ -41,35 +41,46 @@ def get_all_cities()
   # Get the PublisherQueryLanguageService.
   pql_service = dfp.service(:PublisherQueryLanguageService, API_VERSION)
 
-  # Create statement to select all targetable cities.
-  # For criteria that do not have a "targetable" property, the predicate may be
-  # left off.
-  statement = {:query => 'SELECT * FROM City WHERE targetable = true LIMIT 500'}
+  # Create a statement to select all targetable cities.
+  statement_text =
+      "SELECT Id, Name, Status FROM Line_Item WHERE Name LIKE 'line item%%' " +
+      "ORDER BY Id ASC LIMIT %d OFFSET %d"
+
+  # Set initial values for paging.
+  offset, result_set, all_rows = 0, nil, 0
 
-  # Get all cities.
-  result_set = pql_service.select(statement)
+  # Get all cities starting with "Santa".
+  begin
+    # Create statement for a page.
+    statement = {:query => statement_text % [PAGE_SIZE, offset]}
+    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)
+    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)
+      # 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
-  end
+
+    # Update the counters.
+    offset += PAGE_SIZE
+    all_rows += result_set[:rows].size
+  end while result_set[:rows].size == PAGE_SIZE
 
   # Print a footer.
   if result_set[:rows]
-    puts "Total number of rows found: %d" % result_set[:rows].size
+    puts "Total number of rows found: %d" % all_rows
   end
 end
 
 if __FILE__ == $0
   begin
-    get_all_cities()
+    get_line_items_named_like()
 
   # HTTP errors.
   rescue AdsCommon::Errors::HttpError => e

data/examples/{v201204/report_service/download_report.rb → v201308/report_service/display_report.rb}

@@ -1,9 +1,9 @@
 #!/usr/bin/env ruby
 # Encoding: utf-8
 #
-# Author:: api.dklimkin@gmail.com (Danial Klimkin)
+# Author:: api.davidtorres@gmail.com (David Torres)
 #
-# Copyright:: Copyright 2011, Google Inc. All Rights Reserved.
+# 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.
@@ -18,8 +18,9 @@
 #           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.
+# 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
 
@@ -27,9 +28,9 @@ require 'dfp_api'
 
 require 'open-uri'
 
-API_VERSION = :v201204
+API_VERSION = :v201308
 
-def download_report()
+def display_report()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.
   dfp = DfpApi::Api.new
 
@@ -43,25 +44,24 @@ def download_report()
   # 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'
+  # 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(
-      report_job_id, export_format);
+  download_url = report_service.get_report_download_url_with_options(
+      report_job_id, report_download_options);
 
-  puts "Downloading [%s] to [%s]..." % [download_url, file_name]
-  open(file_name, 'wb') do |local_file|
-    local_file << open(download_url).read()
-  end
+  puts "Downloading report from URL %s.\n" % download_url
+  puts open(download_url).read()
 end
 
 if __FILE__ == $0
   begin
-    download_report()
+    display_report()
 
   # HTTP errors.
   rescue AdsCommon::Errors::HttpError => e