google-dfp-api 0.2.5 → 0.2.6

data/examples/v201111/publisher_query_language_service/get_all_countries.rb

@@ -0,0 +1,85 @@
+#!/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 countries available to target.
+#
+# Tags: PublisherQueryLanguageService.select
+
+require 'rubygems'
+require 'dfp_api'
+
+API_VERSION = :v201111
+# A string to separate columns in output. Use "," to get CSV.
+COLUMN_SEPARATOR = "\t"
+
+def get_all_countries()
+  # 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 statement to select all targetable countries.
+  statement = {:query => 'SELECT * FROM Country WHERE targetable = true'}
+
+  # Get all countries.
+  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
+
+  # Print a footer.
+  if result_set[:rows]
+    puts "Total number of rows found: %d" % result_set[:rows].size
+  end
+end
+
+if __FILE__ == $0
+  begin
+    get_all_countries()
+
+  # 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/publisher_query_language_service/get_all_device_manufacturers.rb

@@ -0,0 +1,85 @@
+#!/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 device manufacturers.
+#
+# Tags: PublisherQueryLanguageService.select
+
+require 'rubygems'
+require 'dfp_api'
+
+API_VERSION = :v201111
+# A string to separate columns in output. Use "," to get CSV.
+COLUMN_SEPARATOR = "\t"
+
+def get_all_device_manufacturers()
+  # 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 statement to select all device manufacturers.
+  statement = {:query => 'SELECT * FROM Device_Manufacturer'}
+
+  # Get all device manufacturers.
+  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
+
+  # Print a footer.
+  if result_set[:rows]
+    puts "Total number of rows found: %d" % result_set[:rows].size
+  end
+end
+
+if __FILE__ == $0
+  begin
+    get_all_device_manufacturers()
+
+  # 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/publisher_query_language_service/get_all_metros.rb

@@ -0,0 +1,85 @@
+#!/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 metros available to target.
+#
+# Tags: PublisherQueryLanguageService.select
+
+require 'rubygems'
+require 'dfp_api'
+
+API_VERSION = :v201111
+# A string to separate columns in output. Use "," to get CSV.
+COLUMN_SEPARATOR = "\t"
+
+def get_all_metros()
+  # 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 statement to select all targetable metros.
+  statement = {:query => 'SELECT * FROM Metro WHERE targetable = true'}
+
+  # Get all metros.
+  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
+
+  # Print a footer.
+  if result_set[:rows]
+    puts "Total number of rows found: %d" % result_set[:rows].size
+  end
+end
+
+if __FILE__ == $0
+  begin
+    get_all_metros()
+
+  # 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/publisher_query_language_service/get_all_mobile_carriers.rb

@@ -0,0 +1,85 @@
+#!/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 mobile carriers.
+#
+# Tags: PublisherQueryLanguageService.select
+
+require 'rubygems'
+require 'dfp_api'
+
+API_VERSION = :v201111
+# A string to separate columns in output. Use "," to get CSV.
+COLUMN_SEPARATOR = "\t"
+
+def get_all_mobile_carriers()
+  # 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 statement to select all mobile carriers.
+  statement = {:query => 'SELECT * FROM Mobile_Carrier'}
+
+  # Get all mobile carriers.
+  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
+
+  # Print a footer.
+  if result_set[:rows]
+    puts "Total number of rows found: %d" % result_set[:rows].size
+  end
+end
+
+if __FILE__ == $0
+  begin
+    get_all_mobile_carriers()
+
+  # 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/publisher_query_language_service/get_all_mobile_device_submodels.rb

@@ -0,0 +1,85 @@
+#!/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 mobile device submodels.
+#
+# Tags: PublisherQueryLanguageService.select
+
+require 'rubygems'
+require 'dfp_api'
+
+API_VERSION = :v201111
+# A string to separate columns in output. Use "," to get CSV.
+COLUMN_SEPARATOR = "\t"
+
+def get_all_mobile_device_submodels()
+  # 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 statement to select all mobile device submodels.
+  statement = {:query => 'SELECT * FROM Mobile_Device_Submodel'}
+
+  # Get all mobile device submodels.
+  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
+
+  # Print a footer.
+  if result_set[:rows]
+    puts "Total number of rows found: %d" % result_set[:rows].size
+  end
+end
+
+if __FILE__ == $0
+  begin
+    get_all_mobile_device_submodels()
+
+  # 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/publisher_query_language_service/get_all_mobile_devices.rb

@@ -0,0 +1,85 @@
+#!/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 first 500 of known mobile devices.
+#
+# Tags: PublisherQueryLanguageService.select
+
+require 'rubygems'
+require 'dfp_api'
+
+API_VERSION = :v201111
+# A string to separate columns in output. Use "," to get CSV.
+COLUMN_SEPARATOR = "\t"
+
+def get_all_mobile_devices()
+  # 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 statement to select mobile devices.
+  statement = {:query => 'SELECT * FROM Mobile_Device LIMIT 500'}
+
+  # Get mobile devices by statement.
+  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
+
+  # Print a footer.
+  if result_set[:rows]
+    puts "Total number of rows found: %d" % result_set[:rows].size
+  end
+end
+
+if __FILE__ == $0
+  begin
+    get_all_mobile_devices()
+
+  # 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