google-dfp-api 0.4.0 → 0.5.0

data/examples/v201201/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 = :v201201
-
-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/v201201/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 = :v201201
-
-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/v201201/report_service/run_merged_delivery_report.rb

@@ -1,93 +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 runs a report that an upgraded publisher would use to include
-# statistics before the upgrade. To download the report see download_report.rb.
-#
-# Tags: ReportService.runReportJob, ReportService.getReportJob
-
-require 'dfp_api'
-
-API_VERSION = :v201201
-MAX_RETRIES = 10
-RETRY_INTERVAL = 30
-
-def run_merged_delivery_report()
-  # 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 ReportService.
-  report_service = dfp.service(:ReportService, API_VERSION)
-
-  # Create report query.
-  report_query = {
-    :date_range_type => 'LAST_MONTH',
-    :dimensions => ['ORDER'],
-    :columns => [
-        'MERGED_AD_SERVER_IMPRESSIONS',
-        'MERGED_AD_SERVER_CLICKS',
-        'MERGED_AD_SERVER_CTR',
-        'MERGED_AD_SERVER_REVENUE',
-        'MERGED_AD_SERVER_AVERAGE_ECPM'
-    ]
-  }
-
-  # Create report job.
-  report_job = {:report_query => report_query}
-
-  # Run report job.
-  report_job = report_service.run_report_job(report_job);
-
-  MAX_RETRIES.times do |retry_count|
-    # Get the report job status.
-    report_job = report_service.get_report_job(report_job[:id])
-
-    break unless report_job[:report_job_status] == 'IN_PROGRESS'
-    puts "Report with ID: %d is still running." % report_job[:id]
-    sleep(RETRY_INTERVAL)
-  end
-
-  puts "Report job with ID: %d finished with status %s." %
-      [report_job[:id], report_job[:report_job_status]]
-end
-
-if __FILE__ == $0
-  begin
-    run_merged_delivery_report()
-
-  # 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/v201201/report_service/run_sales_report.rb

@@ -1,88 +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 runs a report equal to the "Sales by salespersons report" on the
-# DFP website. To download the report see download_report.rb.
-#
-# Tags: ReportService.runReportJob, ReportService.getReportJob
-
-require 'dfp_api'
-
-API_VERSION = :v201201
-MAX_RETRIES = 10
-RETRY_INTERVAL = 30
-
-def run_sales_report()
-  # 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 ReportService.
-  report_service = dfp.service(:ReportService, API_VERSION)
-
-  # Create report query.
-  report_query = {
-    :date_range_type => 'LAST_MONTH',
-    :dimensions => ['SALESPERSON'],
-    :columns =>
-        ['AD_SERVER_IMPRESSIONS', 'AD_SERVER_REVENUE', 'AD_SERVER_AVERAGE_ECPM']
-  }
-
-  # Create report job.
-  report_job = {:report_query => report_query}
-
-  # Run report job.
-  report_job = report_service.run_report_job(report_job);
-
-  MAX_RETRIES.times do |retry_count|
-    # Get the report job status.
-    report_job = report_service.get_report_job(report_job[:id])
-
-    break unless report_job[:report_job_status] == 'IN_PROGRESS'
-    puts "Report with ID: %d is still running." % report_job[:id]
-    sleep(RETRY_INTERVAL)
-  end
-
-  puts "Report job with ID: %d finished with status %s." %
-      [report_job[:id], report_job[:report_job_status]]
-end
-
-if __FILE__ == $0
-  begin
-    run_sales_report()
-
-  # 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/v201201/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 = :v201201
-
-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/v201201/third_party_slot_service/archive_third_party_slots.rb

@@ -1,124 +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 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,
-#       ThirdPartSlotService.performThirdPartySlotsAction
-
-require 'dfp_api'
-
-API_VERSION = :v201201
-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