google-dfp-api 0.9.2 → 0.9.3

data/examples/{v201311 → v201411}/audience_segment_service/create_audience_segments.rb

@@ -25,7 +25,7 @@
 
 require 'dfp_api'
 
-API_VERSION = :v201311
+API_VERSION = :v201411
 
 def create_audience_segments(custom_targeting_key_id, custom_targeting_value_id)
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.

data/examples/{v201311 → v201411}/audience_segment_service/get_all_audience_segments.rb

@@ -24,9 +24,9 @@
 # Tags: AudienceSegmentService.getAudienceSegmentsByStatement
 
 require 'dfp_api'
+require 'dfp_api_statement'
 
-API_VERSION = :v201311
-PAGE_SIZE = 500
+API_VERSION = :v201411
 
 def get_all_audience_segments()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.
@@ -39,32 +39,23 @@ def get_all_audience_segments()
   # Get the AudienceSegmentService.
   audience_segment_service = dfp.service(:AudienceSegmentService, API_VERSION)
 
-  # Define initial values.
-  offset = 0
-  page = {}
+  # Create a statement to select all audience segments.
+  statement = DfpApiStatement::FilterStatement.new('ORDER BY id ASC')
 
   begin
-    # Create statement for one page with current offset.
-    statement = {:query => "LIMIT %d OFFSET %d" % [PAGE_SIZE, offset]}
-
     # Get audience segments by statement.
-    page =
-        audience_segment_service.get_audience_segments_by_statement(statement)
+    page = audience_segment_service.get_audience_segments_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 audience segment in results page.
       page[:results].each_with_index do |segment, index|
         puts "%d) Audience segment ID: %d, name: '%s' of size %d" %
-            [index + start_index, segment[:id], segment[:name], segment[:size]]
+            [index + statement.offset,
+             segment[:id], segment[:name], segment[:size]]
       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/{v201311 → v201411}/audience_segment_service/get_first_party_audience_segments.rb

@@ -24,9 +24,9 @@
 # Tags: AudienceSegmentService.getAudienceSegmentsByStatement
 
 require 'dfp_api'
+require 'dfp_api_statement'
 
-API_VERSION = :v201311
-PAGE_SIZE = 500
+API_VERSION = :v201411
 
 def get_first_party_audience_segments()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.
@@ -41,34 +41,27 @@ def get_first_party_audience_segments()
 
   # Statement parts to help build a statement to select all first party audience
   # segments.
-  statement_text = "WHERE type = 'FIRST_PARTY' ORDER BY id LIMIT %d OFFSET %d"
-
-  # Define initial values.
-  offset = 0
-  page = {}
+  statement = DfpApiStatement::FilterStatement.new(
+      'type = :type ORDER BY id ASC',
+      [
+          {:key => 'type',
+           :value => {:value => 'FIRST_PARTY', :xsi_type => 'TextValue'}}
+      ]
+  )
 
   begin
-    # Create statement for one page with current offset.
-    statement = {:query => statement_text % [PAGE_SIZE, offset]}
-
     # Get audience segments by statement.
-    page =
-        audience_segment_service.get_audience_segments_by_statement(statement)
+    page = audience_segment_service.get_audience_segments_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 audience segment in results page.
       page[:results].each_with_index do |segment, index|
         puts "%d) First party audience segment ID: %d, name: '%s', size %d" %
-            [index + start_index, segment[:id], segment[:name], segment[:size]]
+            [index + statement.offset, segment[:id], segment[:name], segment[:size]]
       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/{v201311 → v201411}/audience_segment_service/populate_first_party_audience_segments.rb

@@ -25,9 +25,9 @@
 # Tags: AudienceSegmentService.performAudienceSegmentAction
 
 require 'dfp_api'
+require 'dfp_api_statement'
 
-API_VERSION = :v201311
-PAGE_SIZE = 500
+API_VERSION = :v201411
 
 def populate_first_party_audience_segments(audience_segment_id)
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.
@@ -42,18 +42,20 @@ def populate_first_party_audience_segments(audience_segment_id)
 
   # Statement parts to help build a statement to select first party audience
   # segment for an ID.
-  statement = {
-    :query => 'WHERE type = :type AND Id = :audience_segment_id LIMIT 1',
-    :values => [
-      {:key => 'type',
-       :value => {:value => 'FIRST_PARTY', :xsi_type => 'TextValue'}},
-      {:key => 'audience_segment_id',
-       :value => {:value => audience_segment_id, :xsi_type => 'TextValue'}},
-    ]
-  }
+  statement = DfpApiStatement::FilterStatement.new(
+     'WHERE type = :type AND id = :audience_segment_id ORDER BY id ASC',
+     [
+       {:key => 'type',
+        :value => {:value => 'FIRST_PARTY', :xsi_type => 'TextValue'}},
+       {:key => 'audience_segment_id',
+        :value => {:value => audience_segment_id, :xsi_type => 'TextValue'}},
+     ],
+     1
+  )
 
   # Get audience segments by statement.
-  page = audience_segment_service.get_audience_segments_by_statement(statement)
+  page = audience_segment_service.get_audience_segments_by_statement(
+      statement.toStatement())
 
   if page[:results]
     page[:results].each do |segment|
@@ -62,7 +64,8 @@ def populate_first_party_audience_segments(audience_segment_id)
 
       # Perform action.
       result = audience_segment_service.perform_audience_segment_action(
-          {:xsi_type => 'PopulateAudienceSegments'}, {:query => statement})
+          {:xsi_type => 'PopulateAudienceSegments'},
+          {:query => statement.toStatement()})
 
       # Display results.
       if result and result[:num_changes] > 0

data/examples/{v201311 → v201411}/audience_segment_service/update_audience_segments.rb

@@ -26,8 +26,9 @@
 # Tags: AudienceSegmentService.updateAudienceSegments
 
 require 'dfp_api'
+require 'dfp_api_statement'
 
-API_VERSION = :v201311
+API_VERSION = :v201411
 
 def update_audience_segments()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.
@@ -44,18 +45,18 @@ def update_audience_segments()
   audience_segment_service = dfp.service(:AudienceSegmentService, API_VERSION)
 
   # Create statement text to select the audience segment to update.
-  statement = {
-    :query => 'WHERE id = :segment_id',
-    :values => [
-      {
-        :key => 'segment_id',
-        :value => {:value => audience_segment_id, :xsi_type => 'NumberValue'}
-      }
-    ]
-  }
+  statement = DfpApiStatement::FilterStatement.new(
+     'WHERE id = :segment_id ORDER BY id ASC',
+     [
+         {:key => 'segment_id',
+          :value => {:value => audience_segment_id, :xsi_type => 'NumberValue'}}
+     ],
+     1
+  )
 
   # Get audience segments by statement.
-  page = audience_segment_service.get_audience_segments_by_statement(statement)
+  page = audience_segment_service.get_audience_segments_by_statement(
+      statement.toStatement())
 
   if page[:results]
     audience_segments = page[:results]

data/examples/{v201311 → v201411}/common/error_handling.rb

@@ -24,7 +24,7 @@
 
 require 'dfp_api'
 
-API_VERSION = :v201311
+API_VERSION = :v201411
 
 def produce_api_error()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.

data/examples/{v201311 → v201411}/common/oauth2_jwt_handling.rb

@@ -28,9 +28,9 @@
 # Tags: UserService.getUsersByStatement
 
 require 'dfp_api'
+require 'dfp_api_statement'
 
-API_VERSION = :v201311
-PAGE_SIZE = 500
+API_VERSION = :v201411
 
 def oauth2_jwt_handling()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.
@@ -57,31 +57,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/{v201311 → v201411}/common/setup_oauth2.rb

@@ -25,7 +25,7 @@
 
 require 'dfp_api'
 
-API_VERSION = :v201311
+API_VERSION = :v201411
 
 def setup_oauth2()
   # DfpApi::Api will read a config file from ENV['HOME']/dfp_api.yml

data/examples/{v201311 → v201411}/company_service/create_companies.rb

@@ -25,7 +25,7 @@
 
 require 'dfp_api'
 
-API_VERSION = :v201311
+API_VERSION = :v201411
 # Number of companies to create.
 ITEM_COUNT = 5
 

data/examples/{v201311 → v201411}/company_service/get_all_companies.rb

@@ -23,9 +23,9 @@
 # Tags: CompanyService.getCompaniesByStatement
 
 require 'dfp_api'
+require 'dfp_api_statement'
 
-API_VERSION = :v201311
-PAGE_SIZE = 500
+API_VERSION = :v201411
 
 def get_all_companies()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.
@@ -38,31 +38,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 => "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/{v201311 → v201411}/company_service/get_companies_by_statement.rb

@@ -25,8 +25,9 @@
 # Tags: CompanyService.getCompaniesByStatement
 
 require 'dfp_api'
+require 'dfp_api_statement'
 
-API_VERSION = :v201311
+API_VERSION = :v201411
 
 def get_companies_by_statement()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.
@@ -41,24 +42,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 name 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/{v201311 → v201411}/company_service/update_companies.rb

@@ -1,4 +1,4 @@
-#!/usr/bin/env ruby
+# !/usr/bin/env ruby
 # Encoding: utf-8
 #
 # Author:: api.dklimkin@gmail.com (Danial Klimkin)
@@ -25,8 +25,9 @@
 # Tags: CompanyService.getCompaniesByStatement, CompanyService.updateCompanies
 
 require 'dfp_api'
+require 'dfp_api_statement'
 
-API_VERSION = :v201311
+API_VERSION = :v201411
 
 def update_companies()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.
@@ -39,17 +40,22 @@ def update_companies()
   # Get the CompanyService.
   company_service = dfp.service(:CompanyService, API_VERSION)
 
-  # Create a statement to only select companies that are advertisers.
-  statement = {
-      :query => "WHERE type = :type LIMIT 500",
-      :values => [
-          {:key => 'type',
-           :value => {:value => 'ADVERTISER', :xsi_type => 'TextValue'}}
-      ]
-  }
+  # Specify a single company to fetch.
+  company_id = 'INSERT_COMPANY_ID_HERE'
+
+  # Create a statement to only select a single company.
+  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]