google-dfp-api 0.10.0 → 0.10.1

data/examples/{v201408 → v201508}/placement_service/deactivate_placements.rb

@@ -1,8 +1,6 @@
 #!/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");
@@ -20,14 +18,10 @@
 #
 # This example deactivates all active placements. To determine which placements
 # exist, run get_all_placements.rb.
-#
-# Tags: PlacementService.getPlacementsByStatement
-# Tags: PlacementService.performPlacementAction
 
 require 'dfp_api'
 
-API_VERSION = :v201408
-PAGE_SIZE = 500
+API_VERSION = :v201508
 
 def deactivate_placements()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.
@@ -40,50 +34,43 @@ def deactivate_placements()
   # Get the PlacementService.
   placement_service = dfp.service(:PlacementService, API_VERSION)
 
-  # Create statement text and statement to select active placements.
-  statement_text = 'WHERE status = :status'
-  statement = {
-      :values => [
+  # Create statement to select active placements.
+  statement = DfpApiStatement::FilterStatement.new(
+      'WHERE status = :status',
+      [
           {:key => 'status',
            :value => {:value => 'ACTIVE', :xsi_type => 'TextValue'}}
       ]
-  }
+  )
 
   # Define initial values.
-  offset = 0
-  page = {}
   placement_ids = []
 
   begin
-    # Modify the statement to get one page with current offset.
-    statement[:query] = statement_text +
-        " LIMIT %d OFFSET %d" % [PAGE_SIZE, offset]
-
     # Get placements by statement.
-    page = placement_service.get_placements_by_statement(statement)
+    page = placement_service.get_placements_by_statement(
+        statement.toStatement())
 
     if page[:results]
-      # Increase query offset by page size.
-      offset += PAGE_SIZE
-
-      page[:results].each do |placement|
+      page[:results].each_with_index do |placement, index|
         puts ("%d) Placement ID: %d, name: %s and status: %s will be " +
-            "deactivated.") % [placement_ids.size, placement[:id],
+            "deactivated.") % [index + statement.offset, placement[:id],
             placement[:name], placement[:status]]
         placement_ids << placement[:id]
       end
     end
-  end while offset < page[:total_result_set_size]
+  end while statement.offset < page[:total_result_set_size]
 
   puts "Number of placements to be deactivated: %d" % placement_ids.size
 
   if !placement_ids.empty?
     # Create a statement for action.
-    statement = {:query => "WHERE id IN (%s)" % placement_ids.join(', ')}
+    statement = DfpApiStatement::FilterStatement.new(
+        "WHERE id IN (%s)" % placement_ids.join(', '))
 
     # Perform action.
     result = placement_service.perform_placement_action(
-        {:xsi_type => 'DeactivatePlacements'}, statement)
+        {:xsi_type => 'DeactivatePlacements'}, statement.toStatement())
 
     # Display results.
     if result and result[:num_changes] > 0

data/examples/{v201408 → v201508}/placement_service/get_all_placements.rb

@@ -1,8 +1,6 @@
 #!/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");
@@ -20,13 +18,11 @@
 #
 # This example gets all placements. To create placements, run
 # create_placements.rb
-#
-# Tags: PlacementService.getPlacementsByStatement
 
 require 'dfp_api'
+require 'dfp_api_statement'
 
-API_VERSION = :v201408
-PAGE_SIZE = 500
+API_VERSION = :v201508
 
 def get_all_placements()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.
@@ -39,32 +35,23 @@ def get_all_placements()
   # Get the PlacementService.
   placement_service = dfp.service(:PlacementService, API_VERSION)
 
-  # Define initial values.
-  offset = 0
-  page = {}
+  # Create statement for placements ordered by ID.
+  statement = DfpApiStatement::FilterStatement.new('ORDER BY id ASC')
 
   begin
-    # Create statement for one page with current offset.
-    statement = {:query => "ORDER BY id ASC LIMIT %d OFFSET %d" %
-        [PAGE_SIZE, offset]}
-
     # Get placements by statement.
-    page = placement_service.get_placements_by_statement(statement)
+    page = placement_service.get_placements_by_statement(
+        statement.toStatement())
 
     if page[:results]
-      # Increase query offset by page size.
-      offset += PAGE_SIZE
-
-      # Get the start index for printout.
-      start_index = page[:start_index]
-
       # Print details about each placement in results page.
       page[:results].each_with_index do |placement, index|
         puts "%d) Placement ID: %d, name: %s." %
-            [index + start_index, placement[:id], placement[:name]]
+            [index + statement.offset, placement[:id], placement[:name]]
       end
     end
-  end while offset < page[:total_result_set_size]
+    statement.offset += DfpApiStatement::SUGGESTED_PAGE_LIMIT
+  end while statement.offset < page[:total_result_set_size]
 
   # Print a footer
   if page.include?(:total_result_set_size)

data/examples/{v201408 → v201508}/placement_service/get_placements_by_statement.rb

@@ -1,8 +1,6 @@
 #!/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");
@@ -18,15 +16,13 @@
 #           See the License for the specific language governing permissions and
 #           limitations under the License.
 #
-# This example gets all active placements. The statement retrieves up to the
-# maximum page size limit of 500. To create a placement, run
+# This example gets all active placements. To create a placement, run
 # create_placements.rb.
-#
-# Tags: PlacementService.getPlacementsByStatement
 
 require 'dfp_api'
+require 'dfp_api_statement'
 
-API_VERSION = :v201408
+API_VERSION = :v201508
 
 def get_placements_by_statement()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.
@@ -40,23 +36,28 @@ def get_placements_by_statement()
   placement_service = dfp.service(:PlacementService, API_VERSION)
 
   # Create a statement to only select active placements.
-  statement = {
-      :query => 'WHERE status = :status ORDER BY id ASC LIMIT 500',
-      :values => [
+  statement = DfpApiStatement::FilterStatement.new(
+      'WHERE status = :status ORDER BY id ASC',
+      [
           {:key => 'status',
            :value => {:value => 'ACTIVE', :xsi_type => 'TextValue'}}
       ]
   }
 
-  # Get placements by statement.
-  page = placement_service.get_placements_by_statement(statement)
+  begin
+    # Get placements by statement.
+    page = placement_service.get_placements_by_statement(
+        statement.toStatement())
 
-  if page and page[:results]
-    page[:results].each_with_index do |placement, index|
-      puts "%d) Placement ID: %d, name: %s, status: %s." % [index,
-          placement[:id], placement[:name], placement[:status]]
+    if page and page[:results]
+      page[:results].each_with_index do |placement, index|
+        puts "%d) Placement ID: %d, name: %s, status: %s." % [
+            index + statement.offset,
+            placement[:id], placement[:name], placement[:status]]
+      end
     end
-  end
+    statement.offset += DfpApiStatement::SUGGESTED_PAGE_LIMIT
+  end while statement.offset < page[:total_result_set_size]
 
   # Print a footer.
   if page.include?(:total_result_set_size)

data/examples/{v201408 → v201508}/placement_service/update_placements.rb

@@ -1,8 +1,6 @@
 #!/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");
@@ -18,15 +16,13 @@
 #           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
+# This example updates a single placement to allow for AdSense targeting.
+# To determine which placements exist, run get_all_placements.rb.
 
 require 'dfp_api'
+require 'dfp_api_statement'
 
-API_VERSION = :v201408
+API_VERSION = :v201508
 
 def update_placements()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.
@@ -39,11 +35,20 @@ def update_placements()
   # Get the PlacementService.
   placement_service = dfp.service(:PlacementService, API_VERSION)
 
-  # Create a statement to get first 500 placements.
-  statement = {:query => 'LIMIT 500'}
+  placement_id = 'INSERT_PLACEMENT_ID_HERE'.to_i
+
+  # Create a statement to get a single placement by ID.
+  statement = DfpApiStatement::FilterStatement.new(
+      'WHERE id = :id ORDER BY id ASC',
+      [
+         {:key => 'id',
+          :value => {:value => placement_id, :xsi_type => 'NumberValue'}}
+      ],
+      1
+  )
 
   # Get placements by statement.
-  page = placement_service.get_placements_by_statement(statement)
+  page = placement_service.get_placements_by_statement(statement.toStatement())
 
   if page[:results]
     placements = page[:results]
@@ -54,7 +59,7 @@ def update_placements()
           (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[:targeting_site_name] = 'http://developers.google.com'
       placement[:is_ad_sense_targeting_enabled] = true
     end
 

data/examples/{v201408 → v201508}/publisher_query_language_service/fetch_match_tables.rb

@@ -1,8 +1,6 @@
 #!/usr/bin/env ruby
 # Encoding: utf-8
 #
-# Author:: api.dklimkin@gmail.com (Danial Klimkin)
-#
 # Copyright:: Copyright 2013, Google Inc. All Rights Reserved.
 #
 # License:: Licensed under the Apache License, Version 2.0 (the "License");
@@ -23,18 +21,16 @@
 #
 # A full list of available tables can be found at:
 #
-#   https://developers.google.com/doubleclick-publishers/docs/reference/v201408/PublisherQueryLanguageService
-#
-# Tags: PublisherQueryLanguageService.select
+#   https://developers.google.com/doubleclick-publishers/docs/reference/v201508/PublisherQueryLanguageService
 
 require 'tempfile'
 
 require 'dfp_api'
+require 'dfp_api_statement'
 
-API_VERSION = :v201408
+API_VERSION = :v201508
 # A string to separate columns in output. Use "," to get CSV.
 COLUMN_SEPARATOR = ','
-PAGE_SIZE = 500
 
 def fetch_match_tables()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.
@@ -59,19 +55,16 @@ end
 # Fetches a match table from a PQL statement and writes it to a file.
 def fetch_match_table(table_name, pql_service)
   # Create a statement to select all items for the table.
-  statement_text = ('SELECT Id, Name, Status FROM %s ' % table_name) +
-      'ORDER BY Id ASC LIMIT %d OFFSET %d'
+  statement = DfpApiStatement::FilterStatement.new(
+      'SELECT Id, Name, Status FROM %s ' % table_name + 'ORDER BY Id ASC')
 
   # Set initial values.
-  offset = 0
   file_path = '%s.csv' % table_name
 
   open(file_path, 'wb') do |file|
     file_path = file.path()
     begin
-      # Create statement for a page.
-      statement = {:query => statement_text % [PAGE_SIZE, offset]}
-      result_set = pql_service.select(statement)
+      result_set = pql_service.select(statement.toStatement())
 
       if result_set
         # Only write column names if the first page.
@@ -86,8 +79,8 @@ def fetch_match_table(table_name, pql_service)
         end
       end
       # Update the counters.
-      offset += PAGE_SIZE
-    end while result_set[:rows].size == PAGE_SIZE
+      statement.offset += DfpApiStatement::SUGGESTED_PAGE_LIMIT
+    end while result_set[:rows].size == DfpApiStatement::SUGGESTED_PAGE_LIMIT
   end
   return file_path
 end

data/examples/{v201408 → v201508}/publisher_query_language_service/get_all_line_items.rb

@@ -1,8 +1,6 @@
 #!/usr/bin/env ruby
 # Encoding: utf-8
 #
-# Author:: api.dklimkin@gmail.com (Danial Klimkin)
-#
 # Copyright:: Copyright 2013, Google Inc. All Rights Reserved.
 #
 # License:: Licensed under the Apache License, Version 2.0 (the "License");
@@ -22,15 +20,13 @@
 # The Line_Item PQL table schema can be found here:
 #
 # https://developers.google.com/doubleclick-publishers/docs/reference/latest/PublisherQueryLanguageService
-#
-# Tags: PublisherQueryLanguageService.select
 
 require 'dfp_api'
+require 'dfp_api_statement'
 
-API_VERSION = :v201408
+API_VERSION = :v201508
 # A string to separate columns in output. Use "," to get CSV.
 COLUMN_SEPARATOR = "\t"
-PAGE_SIZE = 500
 
 def get_all_line_items()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.
@@ -44,17 +40,15 @@ def get_all_line_items()
   pql_service = dfp.service(:PublisherQueryLanguageService, API_VERSION)
 
   # Statement parts to help build a statement to select all line items.
-  statement_text = 'SELECT Id, Name, Status FROM Line_Item ORDER BY Id ASC' +
-      'LIMIT %d OFFSET %d'
+  statement = DfpApiStatement::FilterStatement.new(
+      'SELECT Id, Name, Status FROM Line_Item ORDER BY Id ASC')
 
   # Set initial values for paging.
-  offset, result_set, all_rows = 0, nil, 0
+  result_set, all_rows = nil, 0
 
   # 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)
+    result_set = pql_service.select(statement.toStatement())
 
     if result_set
       # Print out columns header.
@@ -69,9 +63,9 @@ def get_all_line_items()
     end
 
     # Update the counters.
-    offset += PAGE_SIZE
+    statement.offset += DfpApiStatement::SUGGESTED_PAGE_LIMIT
     all_rows += result_set[:rows].size
-  end while result_set[:rows].size == PAGE_SIZE
+  end while result_set[:rows].size == DfpApiStatement::SUGGESTED_PAGE_LIMIT
 
   # Print a footer.
   if result_set[:rows]

data/examples/{v201408 → v201508}/publisher_query_language_service/get_geo_targets.rb

@@ -1,8 +1,6 @@
 #!/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");
@@ -18,19 +16,17 @@
 #           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
+# 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
-#
-# Tags: PublisherQueryLanguageService.select
 
 require 'dfp_api'
+require 'dfp_api_statement'
 
-API_VERSION = :v201408
+API_VERSION = :v201508
 # A string to separate columns in output. Use "," to get CSV.
 COLUMN_SEPARATOR = "\t"
-PAGE_SIZE = 500
 
 def get_geo_targets()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.
@@ -46,16 +42,16 @@ def get_geo_targets()
   # 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 LIMIT %d OFFSET %d"
+      "AND Targetable = true ORDER BY Id ASC"
+
+  statement = DfpApiStatement::FilterStatement.new(statement_text)
 
   # Set initial values for paging.
-  offset, result_set, all_rows = 0, nil, 0
+  result_set, all_rows = nil, 0
 
   # Get all cities with paging.
   begin
-    # Create statement for a page.
-    statement = {:query => statement_text % [PAGE_SIZE, offset]}
-    result_set = pql_service.select(statement)
+    result_set = pql_service.select(statement.toStatement())
 
     if result_set
       # Print out columns header.
@@ -70,9 +66,9 @@ def get_geo_targets()
     end
 
     # Update the counters.
-    offset += PAGE_SIZE
+    statement.offset += DfpApiStatement::SUGGESTED_PAGE_LIMIT
     all_rows += result_set[:rows].size
-  end while result_set[:rows].size == PAGE_SIZE
+  end while result_set[:rows].size == DfpApiStatement::SUGGESTED_PAGE_LIMIT
 
   # Print a footer.
   if result_set[:rows]