google-dfp-api 0.17.0 → 0.18.0

data/examples/v201511/line_item_service/get_recently_updated_line_items.rb

@@ -1,100 +0,0 @@
-#!/usr/bin/env ruby
-# Encoding: utf-8
-#
-# 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 code example shows how to get recently updated line items. To create line
-# items, run create_line_items.rb. To determine which orders exist, run
-# get_all_orders.rb.
-
-require 'date'
-
-require 'dfp_api'
-
-
-API_VERSION = :v201511
-
-def get_recently_updated_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 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 statement object to only select line items belonging to the order and
-  # have been modified in the last 3 days.
-  statement = DfpApi::FilterStatement.new(
-    'WHERE lastModifiedDateTime >= :date_time_string AND ' +
-    'orderId = :order_id ORDER BY id ASC',
-    [
-      {:key => 'order_id',
-       :value => {:value => order_id, :xsi_type => 'NumberValue'}},
-      {:key => 'date_time_string',
-       :value => {
-           :value => (DateTime.now - 3).strftime('%Y-%m-%dT%H:%M:%S'),
-           :xsi_type => 'TextValue'
-      }},
-    ]
-  )
-
-  begin
-    # Get line items by statement.
-    page = line_item_service.get_line_items_by_statement(
-        statement.toStatement())
-
-    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 + statement.offset, line_item[:id],
-            line_item[:order_id], line_item[: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_recently_updated_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/v201511/network_service/make_test_network.rb

@@ -1,75 +0,0 @@
-#!/usr/bin/env ruby
-# Encoding: utf-8
-#
-# 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 Google account (created at
-# http://www.google.com/accounts/newaccount if you currently don't have one)
-# that is not associated with any other DFP test 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
-#
-# Alternatively, if you do not wish to run this example, you can create a test
-# network at: https://dfp-playground.appspot.com
-
-require 'dfp_api'
-
-API_VERSION = :v201511
-
-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/v201511/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 = :v201511
-
-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/v201511/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 = :v201511
-
-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/v201511/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 = :v201511
-
-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