google-dfp-api 0.17.0 → 0.18.0

data/examples/v201508/placement_service/create_placements.rb

@@ -1,128 +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 creates new placements for various ad unit sizes. To determine
-# which placements exist, run get_all_placements.rb.
-
-require 'dfp_api'
-
-
-API_VERSION = :v201508
-
-def create_placements()
-  # 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 InventoryService.
-  inventory_service = dfp.service(:InventoryService, API_VERSION)
-
-  # Get the PlacementService.
-  placement_service = dfp.service(:PlacementService, API_VERSION)
-
-  # Create local placement object to store skyscraper ad units.
-  skyscraper_ad_unit_placement = {
-      :name => "Skyscraper AdUnit Placement #%d" % (Time.new.to_f * 1000),
-      :description => 'Contains ad units for creatives of size 120x600',
-      :targeted_ad_unit_ids => []
-  }
-
-  # Create local placement object to store medium square ad units.
-  medium_square_ad_unit_placement = {
-      :name => "Medium Square AdUnit Placement #%d" % (Time.new.to_f * 1000),
-      :description => 'Contains ad units for creatives of size 300x250',
-      :targeted_ad_unit_ids => []
-  }
-
-  # Create local placement object to store banner ad units.
-  banner_ad_unit_placement = {
-      :name => "Banner AdUnit Placement #%d" % (Time.new.to_f * 1000),
-      :description => 'Contains ad units for creatives of size 468x60',
-      :targeted_ad_unit_ids => []
-  }
-
-  # Get the first 500 ad units.
-  page = inventory_service.get_ad_units_by_statement(
-      DfpApi::FilterStatement.new('ORDER BY id ASC').toStatement())
-
-  # Separate the ad units by size.
-  if page and page[:results]
-    page[:results].each do |ad_unit|
-      if ad_unit[:parent_id] and ad_unit[:sizes]
-        ad_unit[:ad_unit_sizes].each do |ad_unit_size|
-          size = ad_unit_size[:size]
-          receiver = case size[:width]
-            when 120
-              skyscraper_ad_unit_placement if size[:height] == 600
-            when 300
-              medium_square_ad_unit_placement if size[:height] == 250
-            when 468
-              banner_ad_unit_placement if size[:height] == 60
-            else nil
-          end
-          receiver[:targeted_ad_unit_ids] |= [ad_unit[:id]] if receiver
-        end
-      end
-    end
-  end
-
-  # Only create placements with one or more ad units.
-  non_empty_placements = [
-      medium_square_ad_unit_placement,
-      skyscraper_ad_unit_placement,
-      banner_ad_unit_placement].delete_if {|plc| plc.empty?}
-
-  # Create the placements on the server.
-  placements = placement_service.create_placements(non_empty_placements)
-
-  # Display results.
-  if placements
-    placements.each do |placement|
-      puts "Placement with ID: %d and name: %s created with ad units: [%s]" %
-          [placement[:id], placement[:name],
-           placement[:targeted_ad_unit_ids].join(', ')]
-    end
-  else
-    raise 'No placements created.'
-  end
-
-end
-
-if __FILE__ == $0
-  begin
-    create_placements()
-
-  # 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/v201508/placement_service/get_all_placements.rb

@@ -1,81 +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 placements. To create placements, run
-# create_placements.rb
-
-require 'dfp_api'
-
-
-API_VERSION = :v201508
-
-def get_all_placements()
-  # 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 PlacementService.
-  placement_service = dfp.service(:PlacementService, API_VERSION)
-
-  # Create statement for placements ordered by ID.
-  statement = DfpApi::FilterStatement.new('ORDER BY id ASC')
-
-  begin
-    # Get placements by statement.
-    page = placement_service.get_placements_by_statement(
-        statement.toStatement())
-
-    if page[:results]
-      # Print details about each placement in results page.
-      page[:results].each_with_index do |placement, index|
-        puts "%d) Placement ID: %d, name: %s." %
-            [index + statement.offset, placement[:id], placement[:name]]
-      end
-    end
-    statement.offset += DfpApi::SUGGESTED_PAGE_LIMIT
-  end while statement.offset < page[:total_result_set_size]
-
-  # Print a footer
-  if page.include?(:total_result_set_size)
-    puts "Total number of placements: %d" % page[:total_result_set_size]
-  end
-end
-
-if __FILE__ == $0
-  begin
-    get_all_placements()
-
-  # 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/v201508/placement_service/update_placements.rb

@@ -1,102 +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 updates a single placement to allow for AdSense targeting.
-# To determine which placements exist, run get_all_placements.rb.
-
-require 'dfp_api'
-
-
-API_VERSION = :v201508
-
-def update_placements()
-  # 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 PlacementService.
-  placement_service = dfp.service(:PlacementService, API_VERSION)
-
-  placement_id = 'INSERT_PLACEMENT_ID_HERE'.to_i
-
-  # Create a statement to get a single placement by ID.
-  statement = DfpApi::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.toStatement())
-
-  if page[:results]
-    placements = page[:results]
-
-    # Update each local placement object by enabling AdSense targeting.
-    placements.each do |placement|
-      placement[:targeting_description] =
-          (placement[:description].nil? || placement[:description].empty?) ?
-          'Generic description' : placement[:description]
-      placement[:targeting_ad_location] = 'All images on sports pages.'
-      placement[:targeting_site_name] = 'http://developers.google.com'
-      placement[:is_ad_sense_targeting_enabled] = true
-    end
-
-    # Update the placements on the server.
-    return_placements = placement_service.update_placements(placements)
-
-    if return_placements
-      return_placements.each do |placement|
-        puts ("Placement ID: %d, name: %s was updated with AdSense targeting " +
-              "enabled: %s.") % [placement[:id], placement[:name],
-                                 placement[:is_ad_sense_targeting_enabled]]
-      end
-    else
-      raise 'No placements were updated.'
-    end
-  else
-    puts 'No placements found to update.'
-  end
-end
-
-if __FILE__ == $0
-  begin
-    update_placements()
-
-  # 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/v201508/publisher_query_language_service/get_all_line_items.rb

@@ -1,95 +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 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/latest/PublisherQueryLanguageService
-
-require 'dfp_api'
-
-
-API_VERSION = :v201508
-# A string to separate columns in output. Use "," to get CSV.
-COLUMN_SEPARATOR = "\t"
-
-def get_all_line_items()
-  # 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)
-
-  # Statement parts to help build a statement to select all line items.
-  statement = DfpApi::FilterStatement.new(
-      'SELECT Id, Name, Status FROM Line_Item ORDER BY Id ASC')
-
-  # Set initial values for paging.
-  result_set, all_rows = nil, 0
-
-  # Get all line items 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_all_line_items()
-
-  # 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/v201508/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 = :v201508
-# 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