google-dfp-api 0.4.0 → 0.5.0

data/examples/v201111/placement_service/deactivate_placements.rb

@@ -1,117 +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 deactivates all active placements. To determine which placements
-# exist, run get_all_placements.rb.
-#
-# Tags: PlacementService.getPlacementsByStatement,
-#       PlacementService.performPlacementAction
-
-require 'dfp_api'
-
-API_VERSION = :v201111
-PAGE_SIZE = 500
-
-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 text and statement to select active placements.
-  statement_text = 'WHERE status = :status'
-  statement = {
-      :values => [
-          {:key => 'status',
-           :value => {:value => 'ACTIVE', :xsi_type => 'TextValue'}}
-      ]
-  }
-
-  # Define initial values.
-  offset = 0
-  page = {}
-  placement_ids = []
-
-  begin
-    # Modify the statement to get one page with current offset.
-    statement[:query] = statement_text +
-        " LIMIT %d OFFSET %d" % [PAGE_SIZE, offset]
-
-    # Get placements by statement.
-    page = placement_service.get_placements_by_statement(statement)
-
-    if page[:results]
-      # Increase query offset by page size.
-      offset += PAGE_SIZE
-
-      page[:results].each do |placement|
-        puts ("%d) Placement ID: %d, name: %s and status: %s will be " +
-            "deactivated.") % [placement_ids.size, placement[:id],
-            placement[:name], placement[:status]]
-        placement_ids << placement[:id]
-      end
-    end
-  end while 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 = {:query => "WHERE id IN (%s)" % placement_ids.join(', ')}
-
-    # Perform action.
-    result = placement_service.perform_placement_action(
-        {:xsi_type => 'DeactivatePlacements'}, statement)
-
-    # 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

data/examples/v201111/placement_service/get_all_placements.rb

@@ -1,92 +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 placements. To create placements, run
-# create_placements.rb
-#
-# Tags: PlacementService.getPlacementsByStatement
-
-require 'dfp_api'
-
-API_VERSION = :v201111
-PAGE_SIZE = 500
-
-def get_all_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)
-
-  # 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 placements by statement.
-    page = placement_service.get_placements_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 placement in results page.
-      page[:results].each_with_index do |placement, index|
-        puts "%d) Placement ID: %d, name: %s." %
-            [index + start_index, placement[:id], placement[: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 placements: %d" % page[:total_result_set_size]
-  end
-end
-
-if __FILE__ == $0
-  begin
-    get_all_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

data/examples/v201111/placement_service/get_placement.rb

@@ -1,73 +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 placement by its ID. To determine which placements exist,
-# run get_all_placements.rb.
-#
-# Tags: PlacementService.getPlacement
-
-require 'dfp_api'
-
-API_VERSION = :v201111
-
-def get_placement()
-  # 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)
-
-  # Set the ID of the placement to get.
-  placement_id = 'INSERT_PLACEMENT_ID_HERE'.to_i
-
-  # Get the placement.
-  placement = placement_service.get_placement(placement_id)
-
-  if placement
-    puts "Placement with ID: %d, name: %s and status %s was found." %
-        [placement[:id], placement[:name], placement[:status]]
-  else
-    puts 'No placement found for this ID.'
-  end
-end
-
-if __FILE__ == $0
-  begin
-    get_placement()
-
-  # 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/v201111/placement_service/get_placements_by_statement.rb

@@ -1,85 +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 active placements. The statement retrieves up to the
-# maximum page size limit of 500. To create a placement, run
-# create_placements.rb.
-#
-# Tags: PlacementService.getPlacementsByStatement
-
-require 'dfp_api'
-
-API_VERSION = :v201111
-
-def get_placements_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 PlacementService.
-  placement_service = dfp.service(:PlacementService, API_VERSION)
-
-  # Create a statement to only select active placements.
-  statement = {
-      :query => 'WHERE status = :status LIMIT 500',
-      :values => [
-          {:key => 'status',
-           :value => {:value => 'ACTIVE', :xsi_type => 'TextValue'}}
-      ]
-  }
-
-  # Get placements by statement.
-  page = placement_service.get_placements_by_statement(statement)
-
-  if page and page[:results]
-    page[:results].each_with_index do |placement, index|
-      puts "%d) Placement ID: %d, name: %s, status: %s." % [index,
-          placement[:id], placement[:name], placement[:status]]
-    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_placements_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/v201111/placement_service/update_placements.rb

@@ -1,96 +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 updates all placements to allow for AdSense targeting up to the
-# first 500. To determine which placements exist, run get_all_placements.rb.
-#
-# Tags: PlacementService.getPlacementsByStatement,
-#       PlacementService.updatePlacements
-
-require 'dfp_api'
-
-API_VERSION = :v201111
-
-def update_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 a statement to get first 500 placements.
-  statement = {:query => 'LIMIT 500'}
-
-  # Get placements by statement.
-  page = placement_service.get_placements_by_statement(statement)
-
-  if page[:results]
-    placements = page[:results]
-
-    # Update each local placement object by enabling AdSense targeting.
-    placements.each do |placement|
-      placement[:targeting_description] =
-          (placement[:description].nil? || placement[:description].empty?) ?
-          'Generic description' : placement[:description]
-      placement[:targeting_ad_location] = 'All images on sports pages.'
-      placement[:targeting_site_name] = 'http://code.google.com'
-      placement[:is_ad_sense_targeting_enabled] = true
-    end
-
-    # Update the placements on the server.
-    return_placements = placement_service.update_placements(placements)
-
-    if return_placements
-      return_placements.each do |placement|
-        puts ("Placement ID: %d, name: %s was updated with AdSense targeting " +
-              "enabled: %s.") % [placement[:id], placement[:name],
-                                 placement[:is_ad_sense_targeting_enabled]]
-      end
-    else
-      raise 'No placements were updated.'
-    end
-  else
-    puts 'No placements found to update.'
-  end
-end
-
-if __FILE__ == $0
-  begin
-    update_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