google-dfp-api 0.3.2 → 0.3.3

data/examples/v201206/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 = :v201206
+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

data/examples/v201206/third_party_slot_service/create_third_party_slot.rb

@@ -0,0 +1,91 @@
+#!/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 creates a new third party slot. To determine which third party
+# slots exist, run get_all_third_party_slots.rb.
+#
+# Tags: ThirdPartySlotService.createThirdPartySlot
+
+require 'dfp_api'
+
+API_VERSION = :v201206
+
+def create_third_party_slot()
+  # 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 ID to associate with this third party slot.
+  company_id = 'INSERT_COMPANY_ID_HERE'.to_i
+
+  # Set the external unique ID and name to associate with this third party slot.
+  external_unique_id = 'INSERT_EXTERNAL_UNIQUE_ID_HERE'.to_i
+  external_unique_name = 'INSERT_EXTERNAL_UNIQUE_NAME_HERE'.to_s
+
+  # Set the creative IDs to associate with this third party slot.
+  creative_ids = ['INSERT_CREATIVE_ID_HERE'.to_i]
+
+  # Create the ThirdPartySlot object.
+  third_party_slot = {
+      :company_id => company_id,
+      :description => 'Third party slot description.',
+      :external_unique_id => external_unique_id,
+      :external_unique_name => external_unique_name,
+      :creative_ids => creative_ids
+  }
+
+  # Create the third party slot.
+  return_slot =
+      third_party_slot_service.create_third_party_slot(third_party_slot)
+
+  if return_slot
+    puts "Third party slot with ID: %d and name: '%s' was created." %
+          [return_slot[:id], return_slot[:name]]
+  else
+    raise 'No third party slots were created.'
+  end
+end
+
+if __FILE__ == $0
+  begin
+    create_third_party_slot()
+
+  # 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/third_party_slot_service/get_all_third_party_slots.rb

@@ -0,0 +1,93 @@
+#!/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 third party slots. To create third party slots, run
+# create_third_party_slot.rb.
+#
+# Tags: ThirdPartySlotService.getThirdPartySlotsByStatement
+
+require 'dfp_api'
+
+API_VERSION = :v201206
+PAGE_SIZE = 500
+
+def get_all_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)
+
+  # 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 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
+
+      # Get the start index for printout.
+      start_index = page[:start_index]
+
+      # Print details about each third party slot in results page.
+      page[:results].each_with_index do |slot, index|
+        puts "%d) Third party slot ID: %d, name: '%s'" %
+            [index + start_index, slot[:id], slot[: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 third party slots: %d" % page[:total_result_set_size]
+  end
+end
+
+if __FILE__ == $0
+  begin
+    get_all_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

data/examples/v201206/third_party_slot_service/get_third_party_slot_by_statement.rb

@@ -0,0 +1,86 @@
+#!/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 archived third party slots. The statement retrieves up to
+# the maximum page size limit of 500. To create third party slots, run
+# create_third_party_slot.rb.
+#
+# Tags: ThirdPartySlotService.getThirdPartySlotsByStatement
+
+require 'dfp_api'
+
+API_VERSION = :v201206
+
+def get_third_party_slot_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 ThirdPartySlotService.
+  third_party_slot_service = dfp.service(:ThirdPartySlotService, API_VERSION)
+
+  # Create a statement to get all slots with status 'ARCHIVED'.
+  statement = {
+      :query => 'WHERE status = :status LIMIT 500',
+      :values => [
+          {:key => 'status',
+           :value => {:value => 'ARCHIVED', :xsi_type => 'TextValue'}}
+      ]
+  }
+
+  # Get third party slots by statement.
+  page = third_party_slot_service.get_third_party_slots_by_statement(statement)
+
+  if page and page[:results]
+    page[:results].each_with_index do |slot, index|
+      puts "%d) Third party slot ID: %d, name: '%s'" %
+          [index, slot[:id], slot[: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_third_party_slot_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/third_party_slot_service/update_third_party_slots.rb

@@ -0,0 +1,95 @@
+#!/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 the first third party slot description.
+#
+# Tags: ThirdPartySlotService.getThirdPartySlotsByStatement
+# Tags: ThirdPartySlotService.updateThirdPartySlots
+
+require 'dfp_api'
+
+API_VERSION = :v201206
+PAGE_SIZE = 500
+
+def update_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)
+
+  # Create statement to get one active third party slot.
+  statement = {
+      :query => 'WHERE status = :status LIMIT 1',
+      :values => [
+          {:key => 'status',
+           :value => {:value => 'ACTIVE', :xsi_type => 'TextValue'}},
+      ]
+  }
+
+  # Get third party slots by statement.
+  page = third_party_slot_service.get_third_party_slots_by_statement(statement)
+
+  if page[:results] and !page[:results].empty?
+    slot = page[:results].first
+
+    # Update local third party slot by changing its description.
+    slot[:description] = 'Updated description'
+
+    # Update the third party slot on the server.
+    return_slot = third_party_slot_service.update_third_party_slot(slot)
+
+    # Display results.
+    if return_slot
+      puts ("Third party slot with ID %d and name '%s' was updated with " +
+            "description '%s'.") %
+          [return_slot[:id], return_slot[:name], return_slot[:description]]
+    else
+      puts 'No third party slots were updated.'
+    end
+  else
+    puts 'No third party slots found to update.'
+  end
+end
+
+if __FILE__ == $0
+  begin
+    update_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