google-dfp-api 0.17.0 → 0.19.0

data/examples/v201508/order_service/get_all_orders.rb

@@ -1,80 +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 orders. To create orders, run create_orders.rb.
-
-require 'dfp_api'
-
-
-API_VERSION = :v201508
-
-def get_all_orders()
-  # 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 OrderService.
-  order_service = dfp.service(:OrderService, API_VERSION)
-
-  # Create statement for one page with current offset.
-  statement = DfpApi::FilterStatement.new('ORDER BY id ASC')
-
-  begin
-    # Get orders by statement.
-    page = order_service.get_orders_by_statement(statement.toStatement())
-
-    if page[:results]
-      # Print details about each order in results page.
-      page[:results].each_with_index do |order, index|
-        puts "%d) Order ID: %d, name: %s, advertiser ID: %d" %
-            [index + statement.offset, order[:id], order[:name],
-             order[:advertiser_id]]
-      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 orders: %d" % page[:total_result_set_size]
-  end
-end
-
-if __FILE__ == $0
-  begin
-    get_all_orders()
-
-  # 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/order_service/get_orders_by_statement.rb

@@ -1,90 +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 orders for a given advertiser. To create orders, run
-# create_orders.rb. To determine which companies are advertisers, run
-# get_companies_by_statement.rb.
-
-require 'dfp_api'
-
-
-API_VERSION = :v201508
-
-def get_orders_by_statement()
-  # 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 OrderService.
-  order_service = dfp.service(:OrderService, API_VERSION)
-
-  # Set the ID of the advertiser (company) to get orders for.
-  advertiser_id = 'INSERT_ADVERTISER_COMPANY_ID_HERE'.to_i
-
-  # Create a statement to only select orders for a given advertiser.
-  statement = DfpApi::FilterStatement.new(
-      'WHERE advertiserId = :advertiser_id ORDER BY id ASC',
-      [
-          {:key => 'advertiser_id',
-           :value => {:value => advertiser_id, :xsi_type => 'NumberValue'}}
-      ]
-  )
-
-  begin
-    # Get orders by statement.
-    page = order_service.get_orders_by_statement(statement.toStatement())
-
-    if page and page[:results]
-      page[:results].each_with_index do |order, index|
-        puts "%d) Order ID: %d, belongs to advertiser ID: %d, name: %s." % [
-            index + statement.offset,
-            order[:id], order[:advertiser_id], order[: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 "Number of results found: %d" % page[:total_result_set_size]
-  end
-end
-
-if __FILE__ == $0
-  begin
-    get_orders_by_statement()
-
-  # 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/order_service/update_orders.rb

@@ -1,101 +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 the notes of a specific order.
-# To determine which orders exist, run get_all_orders.rb.
-
-require 'dfp_api'
-
-
-API_VERSION = :v201508
-
-def update_orders()
-  # 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 OrderService.
-  order_service = dfp.service(:OrderService, API_VERSION)
-
-  order_id = 'INSERT_ORDER_ID_HERE'.to_i
-
-  # Create a statement to get first 500 orders.
-  statement = DfpApi::FilterStatement.new(
-      'WHERE id = :id ORDER BY id ASC',
-      [
-          {:key => 'id',
-          :value => {:value => order_id, :xsi_type => 'NumberValue'}}
-      ],
-      1
-  )
-
-  # Get orders by statement.
-  page = order_service.get_orders_by_statement(statement.toStatement())
-
-  if page[:results]
-    orders = page[:results]
-
-    orders.each do |order|
-      # 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?
-      end
-    end
-
-    # Update the orders on the server.
-    return_orders = order_service.update_orders(orders)
-
-    if return_orders
-      return_orders.each do |order|
-        puts ("Order ID: %d, advertiser ID: %d, name: %s was updated " +
-              "with notes %s") % [order[:id], order[:advertiser_id],
-                                  order[:name], order[:notes]]
-      end
-    else
-      raise 'No orders were updated.'
-    end
-  else
-    puts 'No orders found to update.'
-  end
-end
-
-if __FILE__ == $0
-  begin
-    update_orders()
-
-  # 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/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/deactivate_placements.rb

@@ -1,106 +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 deactivates all active placements. To determine which placements
-# exist, run get_all_placements.rb.
-
-require 'dfp_api'
-
-
-API_VERSION = :v201508
-
-def deactivate_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 to select active placements.
-  statement = DfpApi::FilterStatement.new(
-      'WHERE status = :status',
-      [
-          {:key => 'status',
-           :value => {:value => 'ACTIVE', :xsi_type => 'TextValue'}}
-      ]
-  )
-
-  # Define initial values.
-  placement_ids = []
-
-  begin
-    # Get placements by statement.
-    page = placement_service.get_placements_by_statement(
-        statement.toStatement())
-
-    if page[:results]
-      page[:results].each_with_index do |placement, index|
-        puts ("%d) Placement ID: %d, name: %s and status: %s will be " +
-            "deactivated.") % [index + statement.offset, placement[:id],
-            placement[:name], placement[:status]]
-        placement_ids << placement[:id]
-      end
-    end
-  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 = DfpApi::FilterStatement.new(
-        "WHERE id IN (%s)" % placement_ids.join(', '))
-
-    # Perform action.
-    result = placement_service.perform_placement_action(
-        {:xsi_type => 'DeactivatePlacements'}, statement.toStatement())
-
-    # Display results.
-    if result and result[:num_changes] > 0
-      puts "Number of placements deactivated: %d" % result[:num_changes]
-    else
-      puts 'No placements were deactivated.'
-    end
-  else
-    puts 'No placements found to deactivate.'
-  end
-end
-
-if __FILE__ == $0
-  begin
-    deactivate_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/get_placements_by_statement.rb

@@ -1,87 +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 active placements. To create a placement, run
-# create_placements.rb.
-
-require 'dfp_api'
-
-
-API_VERSION = :v201508
-
-def get_placements_by_statement()
-  # 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 a statement to only select active placements.
-  statement = DfpApi::FilterStatement.new(
-      'WHERE status = :status ORDER BY id ASC',
-      [
-          {:key => 'status',
-           :value => {:value => 'ACTIVE', :xsi_type => 'TextValue'}}
-      ]
-  }
-
-  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 + statement.offset,
-            placement[:id], placement[:name], placement[:status]]
-      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 "Number of results found: %d" % page[:total_result_set_size]
-  end
-end
-
-if __FILE__ == $0
-  begin
-    get_placements_by_statement()
-
-  # 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