google-dfp-api 0.6.3 → 0.7.0

data/examples/v201206/line_item_service/get_line_items_by_statement.rb

@@ -1,93 +0,0 @@
-#!/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");
-#           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 that need creatves for the given order. The
-# statement retrieves up to the maximum page size limit of 500. To create line
-# items, run create_line_items.rb. To determine which orders exist, run
-# get_all_orders.rb.
-#
-# Tags: LineItemService.getLineItemsByStatement
-
-require 'dfp_api'
-
-API_VERSION = :v201206
-
-def get_line_items_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 LineItemService.
-  line_item_service = dfp.service(:LineItemService, API_VERSION)
-
-  # Set the ID of the order to get line items from.
-  order_id = 'INSERT_ORDER_ID_HERE'.to_i
-
-  # Create a statement to only select line items that need creatives from a
-  # given order.
-  statement = {
-      :query => 'WHERE orderId = :order_id AND status = :status LIMIT 500',
-      :values => [
-          {:key => 'order_id',
-           :value => {:value => order_id, :xsi_type => 'NumberValue'}},
-          {:key => 'status',
-           :value => {:value => 'NEEDS_CREATIVES', :xsi_type => 'TextValue'}}
-      ]
-  }
-
-  # Get line items by statement.
-  page = line_item_service.get_line_items_by_statement(statement)
-
-  if page and page[:results]
-    page[:results].each_with_index do |line_item, index|
-      puts "%d) [%d] belongs to order ID %d, name: %s." % [index,
-          line_item[:id], line_item[:order_id], line_item[:name]]
-    end
-  end
-
-  # 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_line_items_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/v201206/line_item_service/target_custom_criteria.rb

@@ -1,129 +0,0 @@
-#!/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");
-#           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 = :v201206
-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.
-  custom_criteria_ids = [
-      {:key => 'INSERT_CUSTOM_TARGETING_KEY_ID_HERE'.to_i,
-       :values => ['INSERT_CUSTOM_TARGETING_VALUE_IDS_HERE'.to_i]},
-      {:key => 'INSERT_CUSTOM_TARGETING_KEY_ID_HERE'.to_i,
-       :values => ['INSERT_CUSTOM_TARGETING_VALUE_IDS_HERE'.to_i]},
-      {:key => 'INSERT_CUSTOM_TARGETING_KEY_ID_HERE'.to_i,
-       :values => ['INSERT_CUSTOM_TARGETING_VALUE_IDS_HERE'.to_i]}
-  ]
-
-  # Create custom criteria.
-  custom_criteria = [
-      {:xsi_type => 'CustomCriteria',
-       :key_id => custom_criteria_ids[0][:key],
-       :value_ids => custom_criteria_ids[0][:values],
-       :operator => 'IS'},
-      {:xsi_type => 'CustomCriteria',
-       :key_id => custom_criteria_ids[1][:key],
-       :value_ids => custom_criteria_ids[1][:values],
-       :operator => 'IS_NOT'},
-      {:xsi_type => 'CustomCriteria',
-       :key_id => custom_criteria_ids[2][:key],
-       :value_ids => custom_criteria_ids[2][:values],
-       :operator => 'IS'}
-  ]
-
-  # Create the custom criteria set that will resemble:
-  #
-  # (custom_criteria[0].key == custom_criteria[0].values OR
-  #     (custom_criteria[1].key != custom_criteria[1].values AND
-  #         custom_criteria[2].key == custom_criteria[2].values))
-  sub_custom_criteria_set = {
-      :xsi_type => 'CustomCriteriaSet',
-      :logical_operator => 'AND',
-      :children => [custom_criteria[1], custom_criteria[2]]
-  }
-  top_custom_criteria_set = {
-      :xsi_type => 'CustomCriteriaSet',
-      :logical_operator => 'OR',
-      :children => [custom_criteria[0], 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/v201206/network_service/get_all_networks.rb

@@ -1,74 +0,0 @@
-#!/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");
-#           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 Networks to which the current login has access.
-#
-# Tags: NetworkService.getAllNetworks
-
-require 'dfp_api'
-
-API_VERSION = :v201206
-
-def get_all_networks()
-  # 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 NetworkService.
-  network_service = dfp.service(:NetworkService, API_VERSION)
-
-  # Execute request and get the response.
-  networks = network_service.get_all_networks()
-
-  if networks
-    # Print details about each network in results page.
-    networks.each_with_index do |network, index|
-      puts "%d) Network ID: %d, name: %s, code: %s." %
-          [index, network[:id], network[:display_name],
-           network[:network_code]]
-    end
-    # Print a footer
-    puts "Total number of networks: %d" % networks.size
-  end
-end
-
-if __FILE__ == $0
-  begin
-    get_all_networks()
-
-  # 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/v201206/network_service/make_test_network.rb

@@ -1,76 +0,0 @@
-#!/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");
-#           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 a test network. You do not need to have a DFP account to
-# run this example, but you do need to have a new Google account (created at
-# http://www.google.com/accounts/newaccount) that is not associated with any
-# other DFP networks (including old sandbox networks). Once this network is
-# created, you can supply the network code in your settings to make calls to
-# other services.
-#
-# Please see the following URL for more information:
-#   https://developers.google.com/doubleclick-publishers/docs/signup
-#
-# Tags: NetworkService.makeTestNetwork
-
-require 'dfp_api'
-
-API_VERSION = :v201206
-
-def make_test_network()
-  # 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 NetworkService.
-  network_service = dfp.service(:NetworkService, API_VERSION)
-
-  # Make a test network.
-  network = network_service.make_test_network()
-
-  puts "Test network with network code %s and display name '%s' created." %
-      [network[:network_code], network[:display_name]]
-  puts "You may now sign in at http://www.google.com/dfp/main?networkCode=%s" %
-      network[:network_code]
-end
-
-if __FILE__ == $0
-  begin
-    make_test_network()
-
-  # 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/v201206/order_service/get_order.rb

@@ -1,74 +0,0 @@
-#!/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");
-#           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 an order by its ID. To determine which orders exist, run
-# get_all_orders.rb.
-#
-# Tags: OrderService.getOrder
-
-require 'dfp_api'
-
-API_VERSION = :v201206
-
-def get_order()
-  # 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 order to get.
-  order_id = 'INSERT_ORDER_ID_HERE'.to_i
-
-  # Get the order.
-  order = order_service.get_order(order_id)
-
-  if order
-    puts "Order with ID: %d, advertiser ID: %d and name %s was found." %
-        [order[:id], order[:advertiser_id], order[:name]]
-  else
-    puts 'No order found for this ID.'
-  end
-end
-
-if __FILE__ == $0
-  begin
-    get_order()
-
-  # 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