google-dfp-api 0.7.0 → 0.7.1

data/examples/v201311/placement_service/update_placements.rb

@@ -0,0 +1,97 @@
+#!/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 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
+# Tags: PlacementService.updatePlacements
+
+require 'dfp_api'
+
+API_VERSION = :v201311
+
+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

data/examples/v201311/publisher_query_language_service/fetch_match_tables.rb

@@ -0,0 +1,113 @@
+#!/usr/bin/env ruby
+# Encoding: utf-8
+#
+# Author:: api.dklimkin@gmail.com (Danial Klimkin)
+#
+# Copyright:: Copyright 2013, 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 fetches and creates match table files from the Line_Item and
+# Ad_Unit tables. This example may take a while to run.
+#
+# A full list of available tables can be found at:
+# https://developers.google.com/doubleclick-publishers/docs/reference/v201311/PublisherQueryLanguageService
+#
+# Tags: PublisherQueryLanguageService.select
+
+require 'tempfile'
+
+require 'dfp_api'
+
+API_VERSION = :v201311
+# A string to separate columns in output. Use "," to get CSV.
+COLUMN_SEPARATOR = ','
+PAGE_SIZE = 500
+
+def fetch_match_tables()
+  # 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 PublisherQueryLanguageService.
+  pql_service = dfp.service(:PublisherQueryLanguageService, API_VERSION)
+
+  # List of tables to fetch.
+  fetch_tables = ['Line_Item', 'Ad_Unit']
+
+  fetch_tables.each do |table|
+    results_file_path = fetch_match_table(table, pql_service)
+    puts "%s table saved to:\n\t%s" % [table, results_file_path]
+  end
+end
+
+# Fetches a match table from a PQL statement and writes it to a file.
+def fetch_match_table(table_name, pql_service)
+  # Create a statement to select all items for the table.
+  statement_text = ('SELECT Id, Name, Status FROM %s ' % table_name) +
+      'ORDER BY Id ASC LIMIT %d OFFSET %d'
+
+  # Set initial values.
+  offset = 0
+  file_path = '%s.csv' % table_name
+
+  open(file_path, 'wb') do |file|
+    file_path = file.path()
+    begin
+      # Create statement for a page.
+      statement = {:query => statement_text % [PAGE_SIZE, offset]}
+      result_set = pql_service.select(statement)
+
+      if result_set
+        # Only write column names if the first page.
+        if (offset == 0)
+          columns = result_set[:column_types].collect {|col| col[:label_name]}
+          file.write(columns.join(COLUMN_SEPARATOR) + "\n")
+        end
+        # Print out every row.
+        result_set[:rows].each do |row_set|
+          row = row_set[:values].collect {|item| item[:value]}
+          file.write(row.join(COLUMN_SEPARATOR) + "\n")
+        end
+      end
+      # Update the counters.
+      offset += PAGE_SIZE
+    end while result_set[:rows].size == PAGE_SIZE
+  end
+  return file_path
+end
+
+if __FILE__ == $0
+  begin
+    fetch_match_tables()
+
+  # 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/v201311/publisher_query_language_service/get_all_line_items.rb

@@ -0,0 +1,100 @@
+#!/usr/bin/env ruby
+# Encoding: utf-8
+#
+# Author:: api.dklimkin@gmail.com (Danial Klimkin)
+#
+# Copyright:: Copyright 2013, 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 line items in your network using the Line_Item table.
+# The Line_Item PQL table schema can be found here:
+#
+# https://developers.google.com/doubleclick-publishers/docs/reference/latest/PublisherQueryLanguageService
+#
+# Tags: PublisherQueryLanguageService.select
+
+require 'dfp_api'
+
+API_VERSION = :v201311
+# A string to separate columns in output. Use "," to get CSV.
+COLUMN_SEPARATOR = "\t"
+PAGE_SIZE = 500
+
+def get_all_line_items()
+  # 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 PublisherQueryLanguageService.
+  pql_service = dfp.service(:PublisherQueryLanguageService, API_VERSION)
+
+  # Statement parts to help build a statement to select all line items.
+  statement_text = 'SELECT Id, Name, Status FROM Line_Item LIMIT %d OFFSET %d'
+
+  # Set initial values for paging.
+  offset, result_set, all_rows = 0, nil, 0
+
+  # Get all line items with paging.
+  begin
+    # Create statement for a page.
+    statement = {:query => statement_text % [PAGE_SIZE, offset]}
+    result_set = pql_service.select(statement)
+
+    if result_set
+      # Print out columns header.
+      columns = result_set[:column_types].collect {|col| col[:label_name]}
+      puts columns.join(COLUMN_SEPARATOR)
+
+      # Print out every row.
+      result_set[:rows].each do |row_set|
+          row = row_set[:values].collect {|item| item[:value]}
+          puts row.join(COLUMN_SEPARATOR)
+      end
+    end
+
+    # Update the counters.
+    offset += PAGE_SIZE
+    all_rows += result_set[:rows].size
+  end while result_set[:rows].size == PAGE_SIZE
+
+  # Print a footer.
+  if result_set[:rows]
+    puts "Total number of rows found: %d" % all_rows
+  end
+end
+
+if __FILE__ == $0
+  begin
+    get_all_line_items()
+
+  # 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/v201311/publisher_query_language_service/get_geo_targets.rb

@@ -0,0 +1,102 @@
+#!/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 first 500 cities available to target. A full list of
+# available PQL tables can be found at:
+#
+# https://developers.google.com/doubleclick-publishers/docs/reference/latest/PublisherQueryLanguageService
+#
+# Tags: PublisherQueryLanguageService.select
+
+require 'dfp_api'
+
+API_VERSION = :v201311
+# A string to separate columns in output. Use "," to get CSV.
+COLUMN_SEPARATOR = "\t"
+PAGE_SIZE = 500
+
+def get_geo_targets()
+  # 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 PublisherQueryLanguageService.
+  pql_service = dfp.service(:PublisherQueryLanguageService, API_VERSION)
+
+  # Create a statement to select all targetable cities.
+  statement_text = "SELECT Id, Name, CanonicalParentId, ParentIds, " +
+      "CountryCode, Type, Targetable FROM Geo_Target WHERE Type = 'City' " +
+      "AND Targetable = true LIMIT %d OFFSET %d"
+
+  # Set initial values for paging.
+  offset, result_set, all_rows = 0, nil, 0
+
+  # Get all cities with paging.
+  begin
+    # Create statement for a page.
+    statement = {:query => statement_text % [PAGE_SIZE, offset]}
+    result_set = pql_service.select(statement)
+
+    if result_set
+      # Print out columns header.
+      columns = result_set[:column_types].collect {|col| col[:label_name]}
+      puts columns.join(COLUMN_SEPARATOR)
+
+      # Print out every row.
+      result_set[:rows].each do |row_set|
+          row = row_set[:values].collect {|item| item[:value]}
+          puts row.join(COLUMN_SEPARATOR)
+      end
+    end
+
+    # Update the counters.
+    offset += PAGE_SIZE
+    all_rows += result_set[:rows].size
+  end while result_set[:rows].size == PAGE_SIZE
+
+  # Print a footer.
+  if result_set[:rows]
+    puts "Total number of rows found: %d" % all_rows
+  end
+end
+
+if __FILE__ == $0
+  begin
+    get_geo_targets()
+
+  # 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/v201311/publisher_query_language_service/get_line_items_named_like.rb

@@ -0,0 +1,100 @@
+#!/usr/bin/env ruby
+# Encoding: utf-8
+#
+# Author:: api.dklimkin@gmail.com (Danial Klimkin)
+#
+# Copyright:: Copyright 2013, 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 line items which have a name beginning with "line item".
+# This example may take a while to run.
+#
+# Tags: PublisherQueryLanguageService.select
+
+require 'dfp_api'
+
+API_VERSION = :v201311
+# A string to separate columns in output. Use "," to get CSV.
+COLUMN_SEPARATOR = "\t"
+PAGE_SIZE = 500
+
+def get_line_items_named_like()
+  # 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 PublisherQueryLanguageService.
+  pql_service = dfp.service(:PublisherQueryLanguageService, API_VERSION)
+
+  # Create a statement to select all line items matching subtext.
+  statement_text =
+      "SELECT Id, Name, Status FROM Line_Item WHERE Name LIKE 'line item%%' " +
+      "ORDER BY Id ASC LIMIT %d OFFSET %d"
+
+  # Set initial values for paging.
+  offset, result_set, all_rows = 0, nil, 0
+
+  # Get all cities starting with "Santa".
+  begin
+    # Create statement for a page.
+    statement = {:query => statement_text % [PAGE_SIZE, offset]}
+    result_set = pql_service.select(statement)
+
+    if result_set
+      # Print out columns header.
+      columns = result_set[:column_types].collect {|col| col[:label_name]}
+      puts columns.join(COLUMN_SEPARATOR)
+
+      # Print out every row.
+      result_set[:rows].each do |row_set|
+          row = row_set[:values].collect {|item| item[:value]}
+          puts row.join(COLUMN_SEPARATOR)
+      end
+    end
+
+    # Update the counters.
+    offset += PAGE_SIZE
+    all_rows += result_set[:rows].size
+  end while result_set[:rows].size == PAGE_SIZE
+
+  # Print a footer.
+  if result_set[:rows]
+    puts "Total number of rows found: %d" % all_rows
+  end
+end
+
+if __FILE__ == $0
+  begin
+    get_line_items_named_like()
+
+  # 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