google-dfp-api 0.10.0 → 0.10.1

data/examples/{v201408 → v201508}/common/error_handling.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");
@@ -19,12 +17,10 @@
 #           limitations under the License.
 #
 # This example runs incorrect query and demonstrates how to handle errors.
-#
-# Tags: UserService.updateUser
 
 require 'dfp_api'
 
-API_VERSION = :v201408
+API_VERSION = :v201508
 
 def produce_api_error()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.

data/examples/{v201408 → v201508}/common/oauth2_jwt_handling.rb

@@ -1,8 +1,6 @@
 #!/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");
@@ -24,13 +22,11 @@
 #
 # See https://developers.google.com/doubleclick-publishers/docs/service_accounts
 # for more information.
-#
-# Tags: UserService.getUsersByStatement
 
 require 'dfp_api'
+require 'dfp_api_statement'
 
-API_VERSION = :v201408
-PAGE_SIZE = 500
+API_VERSION = :v201508
 
 def oauth2_jwt_handling()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.
@@ -57,31 +53,23 @@ def oauth2_jwt_handling()
   # Get the UserService.
   user_service = dfp.service(:UserService, API_VERSION)
 
+  # Create a statement to select all users.
+  statement = DfpApiStatement::FilterStatement.new('ORDER BY id ASC')
   # Define initial values.
-  offset = 0
-  page = Hash.new
 
   begin
-    # Create statement for one page with current offset.
-    statement = {:query => "LIMIT %d OFFSET %d" % [PAGE_SIZE, offset]}
-
     # Get users by statement.
-    page = user_service.get_users_by_statement(statement)
+    page = user_service.get_users_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 user in results page.
       page[:results].each_with_index do |user, index|
         puts "%d) User ID: %d, name: %s, email: %s" %
-            [index + start_index, user[:id], user[:name], user[:email]]
+            [index + statement.offset, user[:id], user[:name], user[:email]]
       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}/common/setup_oauth2.rb

@@ -1,8 +1,6 @@
 #!/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");
@@ -20,12 +18,10 @@
 #
 # This example shows how to use OAuth2.0 authorization method. It is designed to
 # be run from console and requires user input.
-#
-# Tags: UserService.getUsersByStatement
 
 require 'dfp_api'
 
-API_VERSION = :v201408
+API_VERSION = :v201508
 
 def setup_oauth2()
   # DfpApi::Api will read a config file from ENV['HOME']/dfp_api.yml

data/examples/{v201408 → v201508}/company_service/create_companies.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,12 +18,10 @@
 #
 # This example creates new companies. To determine which companies exist, run
 # get_all_companies.rb.
-#
-# Tags: CompanyService.createCompanies
 
 require 'dfp_api'
 
-API_VERSION = :v201408
+API_VERSION = :v201508
 # Number of companies to create.
 ITEM_COUNT = 5
 

data/examples/{v201408 → v201508}/company_service/get_all_companies.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");
@@ -19,13 +17,11 @@
 #           limitations under the License.
 #
 # This example gets all companies. To create companies, run create_companies.rb.
-#
-# Tags: CompanyService.getCompaniesByStatement
 
 require 'dfp_api'
+require 'dfp_api_statement'
 
-API_VERSION = :v201408
-PAGE_SIZE = 500
+API_VERSION = :v201508
 
 def get_all_companies()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.
@@ -38,32 +34,23 @@ def get_all_companies()
   # Get the CompanyService.
   company_service = dfp.service(:CompanyService, API_VERSION)
 
-  # Define initial values.
-  offset = 0
-  page = {}
+  # Create a statement to select all companies.
+  statement = DfpApiStatement::FilterStatement.new('ORDER BY id ASC')
 
   begin
-    # Create a statement to get one page with current offset.
-    statement = {:query => "ORDER BY id ASC LIMIT %d OFFSET %d" %
-        [PAGE_SIZE, offset]}
-
     # Get companies by statement.
-    page = company_service.get_companies_by_statement(statement)
+    page = company_service.get_companies_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 company in results.
       page[:results].each_with_index do |company, index|
         puts "%d) Company ID: %d, name: '%s', type: '%s'" %
-            [index + start_index, company[:id], company[:name], company[:type]]
+            [index + statement.offset,
+             company[:id], company[:name], company[:type]]
       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}/company_service/get_companies_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");
@@ -21,12 +19,11 @@
 # This example gets all companies that are advertisers. The statement retrieves
 # up to the maximum page size limit of 500. To create companies, run
 # create_companies.rb.
-#
-# Tags: CompanyService.getCompaniesByStatement
 
 require 'dfp_api'
+require 'dfp_api_statement'
 
-API_VERSION = :v201408
+API_VERSION = :v201508
 
 def get_companies_by_statement()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.
@@ -41,24 +38,28 @@ def get_companies_by_statement()
 
   # Create a statement to only select companies that are advertisers, sorted by
   # name.
-  statement = {
-     :query => 'WHERE type = :type ORDER BY id ASC LIMIT 500',
-     :values => [
-         {:key => 'type',
-          :value => {:value => 'ADVERTISER', :xsi_type => 'TextValue'}}
-     ]
-  }
+  statement = DfpApiStatement::FilterStatement.new(
+      'WHERE type = :type ORDER BY id ASC',
+      [
+          {:key => 'type',
+           :value => {:value => 'ADVERTISER', :xsi_type => 'TextValue'}}
+      ]
+  )
 
-  # Get companies by statement.
-  page = company_service.get_companies_by_statement(statement)
+  begin
+    # Get companies by statement.
+    page = company_service.get_companies_by_statement(
+        statement.toStatement())
 
-  if page[:results]
-    # Print details about each company in results.
-    page[:results].each_with_index do |company, index|
-      puts "%d) [%d] name: %s, type: %s" %
-          [index, company[:id], company[:name], company[:type]]
+    if page[:results]
+      page[:results].each_with_index do |company, index|
+        puts "%d) [%d] name: %s, type: %s" %
+            [index + statement.offset,
+             company[:id], company[:name], company[:type]]
+      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}/company_service/update_companies.rb

@@ -1,8 +1,6 @@
-#!/usr/bin/env ruby
+# !/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");
@@ -21,12 +19,11 @@
 # This example updates the names of all companies that are advertisers by
 # appending "LLC." up to the first 500. To determine which companies exist, run
 # get_all_companies.rb.
-#
-# Tags: CompanyService.getCompaniesByStatement, CompanyService.updateCompanies
 
 require 'dfp_api'
+require 'dfp_api_statement'
 
-API_VERSION = :v201408
+API_VERSION = :v201508
 
 def update_companies()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.
@@ -43,16 +40,18 @@ def update_companies()
   company_id = 'INSERT_COMPANY_ID_HERE'
 
   # Create a statement to only select a single company.
-  statement = {
-      :query => "WHERE id = :id LIMIT 1",
-      :values => [
-          {:key => 'id',
-           :value => {:value => company_id, :xsi_type => 'NumberValue'}}
-      ]
-  }
+  statement = DfpApiStatement::FilterStatement.new(
+      'WHERE id = :company_id ORDER BY id ASC',
+      [
+          {:key => 'company_id',
+           :value => {:value => company_id, :xsi_type => 'NumberValue'}
+          }
+      ],
+      1
+  )
 
   # Get companies by statement.
-  page = company_service.get_companies_by_statement(statement)
+  page = company_service.get_companies_by_statement(statement.toStatement())
 
   if page[:results]
     companies = page[:results]

data/examples/{v201408 → v201508}/contact_service/create_contacts.rb

@@ -1,8 +1,6 @@
 #!/usr/bin/env ruby
 # Encoding: utf-8
 #
-# 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");
@@ -20,12 +18,10 @@
 #
 # This example creates new contacts. To determine which contacts exist, run
 # get_all_contacts.rb.
-#
-# Tags: ContactService.createContacts
 
 require 'dfp_api'
 
-API_VERSION = :v201408
+API_VERSION = :v201508
 
 def create_contacts()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.

data/examples/{v201408 → v201508}/contact_service/get_all_contacts.rb

@@ -1,8 +1,6 @@
 #!/usr/bin/env ruby
 # Encoding: utf-8
 #
-# 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");
@@ -19,13 +17,11 @@
 #           limitations under the License.
 #
 # This example gets all contacts. To create contacts, run create_contacts.rb.
-#
-# Tags: ContactService.getContactsByStatement.
 
 require 'dfp_api'
+require 'dfp_api_statement'
 
-API_VERSION = :v201408
-PAGE_SIZE = 500
+API_VERSION = :v201508
 
 def get_all_contacts()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.
@@ -38,32 +34,23 @@ def get_all_contacts()
   # Get the ContactService.
   contact_service = dfp.service(:ContactService, API_VERSION)
 
-  # Define initial values.
-  offset = 0
-  page = {}
+  # Create statement for one page with current offset.
+  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 contacts by statement.
-    page = contact_service.get_contacts_by_statement(statement)
+    page = contact_service.get_contacts_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 content object in results page.
       page[:results].each_with_index do |contact, index|
-        puts "%d) Contact ID: %d, name: %s." % [index + start_index,
-            contact[:id], contact[:name]]
+        puts "%d) Contact ID: %d, name: '%s'" %
+            [index + statement.offset,
+             contact[:id], contact[: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}/contact_service/get_uninvited_contacts.rb

@@ -1,8 +1,6 @@
 #!/usr/bin/env ruby
 # Encoding: utf-8
 #
-# 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");
@@ -20,12 +18,11 @@
 #
 # This example gets uninvited contacts. To create contacts, run
 # create_contacts.rb.
-#
-# Tags: ContactService.getContactsByStatement.
 
 require 'dfp_api'
+require 'dfp_api_statement'
 
-API_VERSION = :v201408
+API_VERSION = :v201508
 PAGE_SIZE = 500
 
 def get_uninvited_contacts()
@@ -45,34 +42,29 @@ def get_uninvited_contacts()
   query_base = 'WHERE status = :status ORDER BY id ASC LIMIT %d OFFSET %d'
 
   # Create statement.
-  statement = {
-    :values => [
-      {:key => 'status',
-       :value => {:value => 'UNINVITED', :xsi_type => 'TextValue'}}
-    ]
-  }
 
-  begin
-    # Update statement for one page with current offset.
-    statement[:query] = query_base % [PAGE_SIZE, offset]
+  statement = DfpApiStatement::FilterStatement.new(
+      'WHERE status = :status ORDER BY id ASC',
+      [
+          {:key => 'status',
+           :value => {:value => 'UNINVITED', :xsi_type => 'TextValue'}}
+      ]
+  )
 
+  begin
     # Get contacts by statement.
-    page = contact_service.get_contacts_by_statement(statement)
+    page = contact_service.get_contacts_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 content object in results page.
       page[:results].each_with_index do |contact, index|
-        puts "%d) Contact ID: %d, name: %s." % [index + start_index,
-            contact[:id], contact[:name]]
+        puts "%d) Contact ID: %d, name: '%s'" %
+            [index + statement.offset,
+             contact[:id], contact[: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)