google-dfp-api 0.2.8 → 0.3.0

data/examples/v201103/line_item_service/target_custom_criteria.rb

@@ -1,134 +0,0 @@
-#!/usr/bin/ruby
-#
-# 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");
-#           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 line item to add custom criteria targeting. To
-# determine which line items exist, run get_all_line_items.rb. To determine
-# which custom targeting keys and values exist, run
-# get_all_custom_targeting_keys_and_values.rb.
-#
-# Tags: LineItemService.getLineItem, LineItemService.updateLineItem
-
-require 'dfp_api'
-
-require 'pp'
-
-API_VERSION = :v201103
-PAGE_SIZE = 500
-
-def target_custom_criteria()
-  # 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 LineItemService.
-  line_item_service = dfp.service(:LineItemService, API_VERSION)
-
-  # Set the ID of the line item to update targeting.
-  line_item_id = 'INSERT_LINE_ITEM_ID_HERE'.to_i
-
-  # Set the IDs of the custom targeting keys.
-  free_form_custom_targeting_key_id1 =
-      'INSERT_FREE_FORM_CUSTOM_TARGETING_KEY_ID_HERE'.to_i
-  free_form_custom_targeting_key_id2 =
-      'INSERT_FREE_FORM_CUSTOM_TARGETING_KEY_ID_HERE'.to_i
-
-  # Create the free-form custom criteria for targeting "toyota".
-  toyota_free_form_custom_criteria = {
-      :xsi_type => 'FreeFormCustomCriteria',
-      :operator => 'IS',
-      :key_id => free_form_custom_targeting_key_id1,
-      :values => [{:name => 'toyota', :match_type => 'EXACT'}]
-  }
-
-  # Create the free-form custom criteria for targeting "honda".
-  honda_free_form_custom_criteria = {
-      :xsi_type => 'FreeFormCustomCriteria',
-      :operator => 'IS_NOT',
-      :key_id => free_form_custom_targeting_key_id1,
-      :values => [{:name => 'honda', :match_type => 'EXACT'}]
-  }
-
-  # Create the free-form custom criteria for targeting "ford".
-  ford_free_form_custom_criteria = {
-      :xsi_type => 'FreeFormCustomCriteria',
-      :operator => 'IS',
-      :key_id => free_form_custom_targeting_key_id2,
-      :values => [{:name => 'ford', :match_type => 'EXACT'}]
-  }
-
-  # Create the custom criteria set that will resemble:
-  #
-  # (freeFormCustomTargetingKeyId1 == toyota OR
-  #     (freeFormCustomTargetingKeyId1 != honda AND
-  #      freeFormCustomTargetingKeyId2 == ford))
-  sub_custom_criteria_set = {
-      :xsi_type => 'CustomCriteriaSet',
-      :logical_operator => 'AND',
-      :children => [honda_free_form_custom_criteria,
-                    ford_free_form_custom_criteria]
-  }
-  top_custom_criteria_set = {
-      :xsi_type => 'CustomCriteriaSet',
-      :logical_operator => 'OR',
-      :children => [toyota_free_form_custom_criteria,
-                    sub_custom_criteria_set]
-  }
-
-  # Get the line item.
-  line_item = line_item_service.get_line_item(line_item_id)
-
-  # Set the custom criteria targeting on the line item.
-  line_item[:targeting] = {:custom_targeting => top_custom_criteria_set}
-
-  # Update the line items on the server.
-  return_line_item = line_item_service.update_line_item(line_item)
-
-  # Display the updated line item.
-  if return_line_item
-    puts "Line item ID: %d was updated with custom criteria targeting:" %
-        return_line_item[:id]
-    pp return_line_item[:targeting]
-  else
-    puts 'Line item update failed.'
-  end
-end
-
-if __FILE__ == $0
-  begin
-    target_custom_criteria()
-
-  # 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/v201103/order_service/approve_orders.rb

@@ -1,115 +0,0 @@
-#!/usr/bin/ruby
-#
-# 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");
-#           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 approves and overbooks all draft orders. To determine which
-# orders exist, run get_all_orders.rb.
-#
-# Tags: OrderService.getOrdersByStatement,
-#       OrderService.performOrderAction
-
-require 'dfp_api'
-
-API_VERSION = :v201103
-PAGE_SIZE = 500
-
-def approve_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 text to select all draft orders.
-  statement_text = "WHERE status IN ('DRAFT', 'PENDING_APPROVAL')"
-
-  # Define initial values.
-  offset = 0
-  page = {}
-  order_ids = []
-
-  begin
-    # Create a statement to get one page with current offset.
-    statement = {
-        :query => statement_text + " LIMIT %d OFFSET %d" % [PAGE_SIZE, offset]
-    }
-
-    # Get orders by statement.
-    page = order_service.get_orders_by_statement(statement)
-
-    if page[:results]
-      # Increase query offset by page size.
-      offset += PAGE_SIZE
-
-      page[:results].each do |order|
-        # Archived orders cannot be approved.
-        if !order[:is_archived]
-          puts ("%d) Order ID: %d, status: %s and name: %s will be " +
-              "approved.") % [order_ids.size, order[:id], order[:status],
-                              order[:name]]
-          order_ids << order[:id]
-        end
-      end
-    end
-  end while offset < page[:total_result_set_size]
-
-  puts "Number of orders to be approved: %d" % order_ids.size
-
-  if !order_ids.empty?
-    # Create statement for action.
-    statement = {:query => "WHERE id IN (%s)" % order_ids.join(', ')}
-
-    # Perform action.
-    result = order_service.perform_order_action(
-        {:xsi_type => 'ApproveAndOverbookOrders'}, statement)
-
-    # Display results.
-    if result and result[:num_changes] > 0
-      puts "Number of orders approved: %d" % result[:num_changes]
-    else
-      puts 'No orders were approved.'
-    end
-  else
-    puts 'No order found to approve.'
-  end
-end
-
-if __FILE__ == $0
-  begin
-    approve_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/v201103/order_service/create_orders.rb

@@ -1,91 +0,0 @@
-#!/usr/bin/ruby
-#
-# 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");
-#           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 orders. To determine which orders exist, run
-# get_all_orders.rb. To determine which companies are advertisers, run
-# get_companies_by_statement.rb. To get salespeople and traffickers, run
-# get_all_users.rb.
-#
-# Tags: OrderService.createOrders
-
-require 'dfp_api'
-
-API_VERSION = :v201103
-# Number of orders to create.
-ITEM_COUNT = 5
-
-def create_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)
-
-  # Set the advertiser (company), salesperson, and trafficker to assign to each
-  # order.
-  advertiser_id = 'INSERT_ADVERTISER_COMPANY_ID_HERE'.to_i
-  salesperson_id = 'INSERT_SALESPERSON_ID_HERE'.to_i
-  trafficker_id = 'INSERT_TRAFFICKER_ID_HERE'.to_i
-
-  # Create an array to store local order objects.
-  orders = (1..ITEM_COUNT).map do |index|
-    {:name => "Order #%d" % index,
-     :advertiser_id => advertiser_id,
-     :salesperson_id => salesperson_id,
-     :trafficker_id => trafficker_id}
-  end
-
-  # Create the orders on the server.
-  return_orders = order_service.create_orders(orders)
-
-  if return_orders
-    return_orders.each do |order|
-      puts "Order with ID: %d and name: %s was created." %
-          [order[:id], order[:name]]
-    end
-  else
-    raise 'No orders were created.'
-  end
-
-end
-
-if __FILE__ == $0
-  begin
-    create_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/v201103/order_service/update_orders.rb

@@ -1,94 +0,0 @@
-#!/usr/bin/ruby
-#
-# 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");
-#           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 each order up to the first 500.
-# To determine which orders exist, run get_all_orders.rb.
-#
-# Tags: OrderService.getOrdersByStatement, OrderService.updateOrders
-
-require 'dfp_api'
-
-API_VERSION = :v201103
-
-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)
-
-  # Create a statement to get first 500 orders.
-  statement = {:query => 'LIMIT 500'}
-
-  # Get orders by statement.
-  page = order_service.get_orders_by_statement(statement)
-
-  if page[:results]
-    orders = page[:results]
-
-    new_orders = orders.inject([]) do |new_orders, order|
-      # Archived orders can not be updated.
-      if !order[:is_archived]
-        order[:notes] = 'Spoke to advertiser. All is well.'
-        new_orders << order
-      end
-      new_orders
-    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/v201103/placement_service/deactivate_placements.rb

@@ -1,117 +0,0 @@
-#!/usr/bin/ruby
-#
-# 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");
-#           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.
-#
-# Tags: PlacementService.getPlacementsByStatement,
-#       PlacementService.performPlacementAction
-
-require 'dfp_api'
-
-API_VERSION = :v201103
-PAGE_SIZE = 500
-
-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 text and statement to select active placements.
-  statement_text = 'WHERE status = :status'
-  statement = {
-      :values => [
-          {: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)
-
-    if page[:results]
-      # Increase query offset by page size.
-      offset += PAGE_SIZE
-
-      page[:results].each do |placement|
-        puts ("%d) Placement ID: %d, name: %s and status: %s will be " +
-            "deactivated.") % [placement_ids.size, placement[:id],
-            placement[:name], placement[:status]]
-        placement_ids << placement[:id]
-      end
-    end
-  end while 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(', ')}
-
-    # Perform action.
-    result = placement_service.perform_placement_action(
-        {:xsi_type => 'DeactivatePlacements'}, statement)
-
-    # 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