google-dfp-api 0.6.1 → 0.6.2

data/examples/v201302/team_service/create_teams.rb

@@ -0,0 +1,83 @@
+#!/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
+
+require 'dfp_api'
+
+API_VERSION = :v201302
+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)
+
+  # Create an array to store local team objects.
+  teams = (1..ITEM_COUNT).map do |index|
+    {
+      :name => "Team #%d" % index,
+      :has_all_companies => false,
+      :has_all_inventory => false
+    }
+  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 and name: '%s' was created." %
+          [team[:id], team[:name]]
+    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

data/examples/v201302/team_service/get_all_teams.rb

@@ -0,0 +1,92 @@
+#!/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 gets all teams. To create teams, run create_teams.rb.
+#
+# Tags: TeamService.getTeamsByStatement
+
+require 'dfp_api'
+
+API_VERSION = :v201302
+PAGE_SIZE = 500
+
+def get_all_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)
+
+  # Define initial values.
+  offset = 0
+  page = {}
+
+  begin
+    # Create statement for one page with current offset.
+    statement = {:query => "LIMIT %d OFFSET %d" % [PAGE_SIZE, offset]}
+
+    # Get teams by statement.
+    page = team_service.get_teams_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 team in results page.
+      page[:results].each_with_index do |team, index|
+        puts "%d) Team ID: %d, name: %s" %
+            [index + start_index, team[:id], team[:name]]
+      end
+    end
+  end while offset < page[:total_result_set_size]
+
+  # Print a footer
+  if page.include?(:total_result_set_size)
+    puts "Total number of teams: %d" % page[:total_result_set_size]
+  end
+end
+
+if __FILE__ == $0
+  begin
+    get_all_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

data/examples/v201302/team_service/get_team.rb

@@ -0,0 +1,74 @@
+#!/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 gets a team by its ID. To determine which teams exist, run
+# get_all_teams.rb.
+#
+# Tags: TeamService.getTeam
+
+require 'dfp_api'
+
+API_VERSION = :v201302
+
+def get_team()
+  # 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)
+
+  # Set the ID of the team to get.
+  team_id = 'INSERT_TEAM_ID_HERE'.to_i
+
+  # Get the team.
+  team = team_service.get_team(team_id)
+
+  if team
+    puts "Team with ID: %d and name '%s' was found." %
+        [team[:id], team[:name]]
+  else
+    puts 'No team found for this ID.'
+  end
+end
+
+if __FILE__ == $0
+  begin
+    get_team()
+
+  # 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/v201302/team_service/get_teams_by_statement.rb

@@ -0,0 +1,78 @@
+#!/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 gets all teams ordered by name. The statement retrieves up to the
+# maximum page size limit of 500. To create teams, run create_teams.rb.
+#
+# Tags: TeamService.getTeamsByStatement
+
+require 'dfp_api'
+
+API_VERSION = :v201302
+
+def get_teams_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 TeamService.
+  team_service = dfp.service(:TeamService, API_VERSION)
+
+  # Create a statement to order teams by name.
+  statement = {:query => "ORDER BY name LIMIT 500"}
+
+  # Get teams by statement.
+  page = team_service.get_teams_by_statement(statement)
+
+  if page and page[:results]
+    page[:results].each_with_index do |team, index|
+      puts "%d) Team ID: %d, name: %s." % [index, team[:id], team[: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_teams_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/v201302/team_service/update_teams.rb

@@ -0,0 +1,97 @@
+#!/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 updates teams by adding an ad unit to the first 5. To determine
+# which teams exist, run get_all_teams.rb. To determine which ad units exist,
+# run get_all_ad_units.rb.
+#
+# Tags: TeamService.getTeamsByStatement, TeamService.updateTeams
+
+require 'dfp_api'
+
+API_VERSION = :v201302
+
+def update_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')
+
+  # Set the ID of the ad unit to add to the teams.
+  ad_unit_id = 'INSERT_AD_UNIT_ID_HERE'.to_i
+
+  # Get the TeamService.
+  team_service = dfp.service(:TeamService, API_VERSION)
+
+  # Create a statement to select first 5 teams that aren't built-in.
+  statement = {:query => 'WHERE id > 0 LIMIT 5'}
+
+  # Get teams by statement.
+  page = team_service.get_teams_by_statement(statement)
+
+  if page[:results]
+    teams = page[:results]
+
+    # Create a local set of teams than need to be updated. We are updating by
+    # adding an ad unit to it.
+    updated_teams = teams.inject([]) do |updated_teams, team|
+      # Don't add ad unit if the team has all inventory already.
+      unless team[:has_all_inventory]
+        team[:ad_unit_ids] ||= []
+        team[:ad_unit_ids] << ad_unit_id
+        # Workaround for issue #94.
+        team[:description] = "" if team[:description].nil?
+        updated_teams << team
+      end
+      updated_teams
+    end
+
+    # Update the teams on the server.
+    return_teams = team_service.update_teams(updated_teams)
+    return_teams.each do |team|
+      puts "Team ID: %d was updated" % team[:id]
+    end
+  else
+    puts 'No teams found to update.'
+  end
+end
+
+if __FILE__ == $0
+  begin
+    update_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

data/examples/v201302/third_party_slot_service/archive_third_party_slots.rb

@@ -0,0 +1,125 @@
+#!/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 archives all active third party slots for a company. To determine
+# which third party slots exist, run get_all_third_party_slots.rb.
+#
+# Tags: ThirdPartSlotService.getThirdPartySlotsByStatement
+# Tags: ThirdPartSlotService.performThirdPartySlotsAction
+
+require 'dfp_api'
+
+API_VERSION = :v201302
+PAGE_SIZE = 500
+
+def archive_third_party_slots()
+  # 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 ThirdPartySlotService.
+  third_party_slot_service = dfp.service(:ThirdPartySlotService, API_VERSION)
+
+  # Set the company that the third party slots to archive belong to.
+  company_id = 'INSERT_COMPANY_ID_HERE'.to_i
+
+  # Create a statement to only select active third party slots.
+  statement_text = 'WHERE status = :status AND companyId = :company_id'
+
+  # Create statement bind variables.
+  statement = {
+      :query => statement_text,
+      :values => [
+          {:key => 'status',
+           :value => {:value => 'ARCHIVED', :xsi_type => 'TextValue'}},
+          {:key => 'company_id',
+           :value => {:value => company_id, :xsi_type => 'NumberValue'}},
+      ]
+  }
+
+  # Define initial values.
+  offset = 0
+  page = {}
+  third_party_slot_ids = []
+
+  begin
+    # Update the statement to get one page with current offset.
+    statement[:query] =
+        statement_text + " LIMIT %d OFFSET %d" % [PAGE_SIZE, offset]
+
+    # Get third party slots by statement.
+    page = third_party_slot_service.get_third_party_slots_by_statement(statement)
+
+    if page[:results]
+      # Increase query offset by page size.
+      offset += PAGE_SIZE
+
+      page[:results].each do |slot|
+        puts "%d) Third party slot ID: %d and name: '%s' will be archived." %
+            [third_party_slot_ids.size, slot[:id], slot[:name]]
+        third_party_slot_ids << slot[:id]
+      end
+    end
+  end while offset < page[:total_result_set_size]
+
+  puts "Number of third party slots to be archived: %d" % third_party_slot_ids.size
+
+  unless third_party_slot_ids.empty?
+    # Create statement for action.
+    statement = {:query => "WHERE id IN (%s)" % third_party_slot_ids.join(', ')}
+
+    # Perform action.
+    result = third_party_slot_service.perform_third_party_slot_action(
+        {:xsi_type => 'ArchiveThirdPartySlots'}, statement)
+
+    # Display results.
+    if result and result[:num_changes] > 0
+      puts "Number of third party slots archived: %d" % result[:num_changes]
+    else
+      puts 'No third party slots were archived.'
+    end
+  else
+    puts 'No third party slots found to archive.'
+  end
+end
+
+if __FILE__ == $0
+  begin
+    archive_third_party_slots()
+
+  # 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