google-dfp-api 0.6.3 → 0.7.0

data/examples/v201203/suggested_ad_unit_service/approve_all_suggested_ad_units.rb

@@ -1,108 +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 code example approves all suggested ad units with 50 or more requests.
-#
-# This feature is only available to DFP premium solution networks.
-#
-# Tags: SuggestedAdUnitService.getSuggestedAdUnitsByStatement,
-#       SuggestedAdUnitService.performSuggestedAdUnitAction
-
-require 'dfp_api'
-
-API_VERSION = :v201203
-NUMBER_OF_REQUESTS = 50
-
-def approve_suggested_ad_units()
-  # 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 SuggestedAdUnitService.
-  suggested_ad_unit_service = dfp.service(:SuggestedAdUnitService, API_VERSION)
-
-  # Create a statement to only select suggested ad units with 50 or more
-  # requests (with maximum limit of 500).
-  statement = {
-     :query => 'WHERE numRequests >= :num_requests',
-     :values => [
-         {:key => 'num_requests',
-          :value => {:value => NUMBER_OF_REQUESTS,
-                     :xsi_type => 'NumberValue'}}
-     ]
-  }
-
-  # Get suggested ad units by statement.
-  page =
-      suggested_ad_unit_service.get_suggested_ad_units_by_statement(statement)
-
-  unit_count_to_approve = 0
-
-  if page[:results]
-    page[:results].each do |ad_unit|
-      if ad_unit[:num_requests] >= NUMBER_OF_REQUESTS
-        puts(("%d) Suggested ad unit with ID '%s' and %d requests will be " +
-            "approved.") % [suggested_ad_unit_ids.size, ad_unit[:id],
-            ad_unit[:num_requests]])
-        unit_count_to_approve += 1
-      end
-    end
-  end
-
-  puts "Number of suggested ad units to be approved: %d" % unit_count_to_approve
-
-  if unit_count_to_approve > 0
-    # Perform action with the same statement.
-    result = suggested_ad_unit_service.perform_suggested_ad_unit_action(
-        {:xsi_type => 'ApproveSuggestedAdUnit'}, statement)
-
-    # Display results.
-    if result and result[:num_changes] > 0
-      puts "Number of ad units approved: %d" % result[:num_changes]
-    else
-      puts 'No ad units were approved.'
-    end
-  else
-    puts 'No ad units found to approve.'
-  end
-end
-
-if __FILE__ == $0
-  begin
-    approve_suggested_ad_units()
-
-  # 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/v201203/suggested_ad_unit_service/get_all_suggested_ad_units.rb

@@ -1,95 +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 gets all suggested ad units. To approve suggested ad units, run
-# approve_suggested_ad_units.rb.
-#
-# This feature is only available to DFP premium solution networks.
-#
-# Tags: SuggestedAdUnitService.getSuggestedAdUnitsByStatement
-
-require 'dfp_api'
-
-API_VERSION = :v201203
-PAGE_SIZE = 500
-
-def get_all_suggested_ad_units()
-  # 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 SuggestedAdUnitService.
-  suggested_ad_unit_service = dfp.service(:SuggestedAdUnitService, API_VERSION)
-
-  # Define initial values.
-  offset = 0
-  page = {}
-
-  begin
-    # Create a statement to get one page with current offset.
-    statement = {:query => "LIMIT %d OFFSET %d" % [PAGE_SIZE, offset]}
-
-    # Get suggested ad units by statement.
-    page =
-        suggested_ad_unit_service.get_suggested_ad_units_by_statement(statement)
-
-    if page[:results]
-      # Increase query offset by page size.
-      offset += PAGE_SIZE
-
-      # Get the start index for printout.
-      start_index = page[:start_index]
-
-      # Print details about each suggested ad unit in results.
-      page[:results].each_with_index do |ad_unit, index|
-        puts "%d) Suggested ad unit ID: '%s' with number of requests: %d" %
-            [index + start_index, ad_unit[:id], ad_unit[:num_requests]]
-      end
-    end
-  end while offset < page[:total_result_set_size]
-
-  # Print a footer.
-  if page.include?(:total_result_set_size)
-    puts "Total number of suggested ad units: %d" % page[:total_result_set_size]
-  end
-end
-
-if __FILE__ == $0
-  begin
-    get_all_suggested_ad_units()
-
-  # 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/v201203/suggested_ad_unit_service/get_suggested_ad_unit.rb

@@ -1,74 +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 gets a suggested ad unit by its ID. To determine which suggested
-# ad units exist, run get_all_suggested_ad_units.rb.
-#
-# This feature is only available to DFP premium solution networks.
-#
-# Tags: SuggestedAdUnitService.getSuggestedAdUnit
-
-require 'dfp_api'
-
-API_VERSION = :v201203
-
-def get_suggested_ad_unit()
-  # 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 SuggestedAdUnitService.
-  suggested_ad_unit_service = dfp.service(:SuggestedAdUnitService, API_VERSION)
-
-  # Set the ID of the ad unit to get.
-  suggested_ad_unit_id = 'INSERT_SUGGESTED_AD_UNIT_ID_HERE'
-
-  # Get the suggested ad unit.
-  suggested_ad_unit =
-      suggested_ad_unit_service.get_suggested_ad_unit(suggested_ad_unit_id)
-
-  if suggested_ad_unit
-    puts "Suggested ad unit with ID: '%s' and number of requests: %d" %
-        [suggested_ad_unit[:id], suggested_ad_unit[:num_requests]]
-  end
-end
-
-if __FILE__ == $0
-  begin
-    get_suggested_ad_unit()
-
-  # 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/v201203/suggested_ad_unit_service/get_suggested_ad_units_by_statement.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 gets suggested ad units that have more than 50 requests. The
-# statement retrieves up to the maximum page size limit of 500.
-#
-# This feature is only available to DFP premium solution networks.
-#
-# Tags: SuggestedAdUnitService.getSuggestedAdUnitsByStatement
-
-require 'dfp_api'
-
-API_VERSION = :v201203
-NUMBER_OF_REQUESTS = 50
-
-def get_suggested_ad_units_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 SuggestedAdUnitService.
-  suggested_ad_unit_service = dfp.service(:SuggestedAdUnitService, API_VERSION)
-
-  # Create a statement to only select suggested ad units with more than 50
-  # requests (with maximum limit of 500).
-  statement = {
-     :query => 'WHERE numRequests > :num_requests LIMIT 500',
-     :values => [
-         {:key => 'num_requests',
-          :value => {:value => NUMBER_OF_REQUESTS,
-                     :xsi_type => 'NumberValue'}}
-     ]
-  }
-
-  # Get ad units by statement.
-  page =
-      suggested_ad_unit_service.get_suggested_ad_units_by_statement(statement)
-
-  if page[:results]
-    # Print details about each suggested ad unit in results.
-    page[:results].each_with_index do |ad_unit, index|
-      puts "%d) Suggested ad unit ID: '%s', number of requests: %d" %
-          [index, ad_unit[:id], ad_unit[:num_requests]]
-    end
-  end
-
-  # Print a footer.
-  if page.include?(:total_result_set_size)
-    puts "Total number of suggested ad units: %d" % page[:total_result_set_size]
-  end
-end
-
-if __FILE__ == $0
-  begin
-    get_suggested_ad_units_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/v201203/team_service/create_teams.rb

@@ -1,91 +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 new teams with the logged in user added to each team. To
-# determine which teams exist, run get_all_teams.rb.
-#
-# Tags: TeamService.createTeams, UserService.getCurrentUser
-
-require 'dfp_api'
-
-API_VERSION = :v201203
-ITEM_COUNT = 5
-
-def create_teams()
-  # 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 TeamService.
-  team_service = dfp.service(:TeamService, API_VERSION)
-
-  # Get the UserService.
-  user_service = dfp.service(:UserService, API_VERSION)
-
-  # Get the current user's ID.
-  current_user = user_service.get_current_user()
-  user_id = current_user[:id]
-
-  # Create an array to store local team objects.
-  teams = (1..ITEM_COUNT).map do |index|
-    {
-      :name => "Team #%d" % index,
-      :user_ids => [user_id],
-      :has_all_companies => true,
-      :has_all_inventory => true
-    }
-  end
-
-  # Create the teams on the server.
-  return_teams = team_service.create_teams(teams)
-
-  if return_teams
-    return_teams.each do |team|
-      puts "Team with ID: %d, name: %s and user ids: [%s] was created." %
-          [team[:id], team[:name], team[:user_ids].join(', ')]
-    end
-  else
-    raise 'No teams were created.'
-  end
-end
-
-if __FILE__ == $0
-  begin
-    create_teams()
-
-  # 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