google-dfp-api 0.2.3 → 0.2.4

data/examples/{v201101 → v201108}/inventory_service/get_all_ad_units.rb

@@ -24,7 +24,7 @@
 require 'rubygems'
 require 'dfp_api'
 
-API_VERSION = :v201101
+API_VERSION = :v201108
 PAGE_SIZE = 500
 
 def get_all_ad_units()

data/examples/{v201101 → v201108}/inventory_service/update_ad_units.rb

@@ -26,7 +26,7 @@
 require 'rubygems'
 require 'dfp_api'
 
-API_VERSION = :v201101
+API_VERSION = :v201108
 
 def update_ad_units()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.

data/examples/v201108/label_service/create_labels.rb

@@ -0,0 +1,83 @@
+#!/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 creates new labels. To determine which labels exist, run
+# get_all_labels.rb.
+#
+# This feature is only available to DFP premium solution networks.
+#
+# Tags: LabelService.createLabels
+
+require 'rubygems'
+require 'dfp_api'
+
+API_VERSION = :v201108
+# Number of labels to create.
+ITEM_COUNT = 5
+
+def create_labels()
+  # 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 LabelService.
+  label_service = dfp.service(:LabelService, API_VERSION)
+
+  # Create an array to store local label objects.
+  labels = (1..ITEM_COUNT).map do |index|
+    {:name => "Label #%d" % index, :type => 'COMPETITIVE_EXCLUSION'}
+  end
+
+  # Create the labels on the server.
+  return_labels = label_service.create_labels(labels)
+
+  if return_labels
+    return_labels.each do |label|
+      puts "Label with ID: %d, name: %s and type: %s was created." %
+          [label[:id], label[:name], label[:type]]
+    end
+  else
+    raise 'No labels were created.'
+  end
+
+end
+
+if __FILE__ == $0
+  begin
+    create_labels()
+
+  # 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/v201108/label_service/deactivate_labels.rb

@@ -0,0 +1,118 @@
+#!/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 labels. To determine which labels exist,
+# run get_all_labels.rb.
+#
+# This feature is only available to DFP premium solution networks.
+#
+# Tags: LabelService.getLabelsByStatement, LabelService.performLabelAction
+
+require 'rubygems'
+require 'dfp_api'
+
+API_VERSION = :v201108
+PAGE_SIZE = 500
+
+def deactivate_labels()
+  # 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 LabelService.
+  label_service = dfp.service(:LabelService, API_VERSION)
+
+  # Create statement text and statement to select active labels.
+  statement_text = 'WHERE isActive = :is_active'
+  statement = {
+      :values => [
+          {:key => 'is_active',
+           :value => {:value => true, :xsi_type => 'BooleanValue'}}
+      ]
+  }
+
+  # Define initial values.
+  offset = 0
+  page = {}
+  label_ids = []
+
+  begin
+    # Modify the statement to get one page with current offset.
+    statement[:query] = statement_text +
+        " LIMIT %d OFFSET %d" % [PAGE_SIZE, offset]
+
+    # Get labels by statement.
+    page = label_service.get_labels_by_statement(statement)
+
+    if page[:results]
+      # Increase query offset by page size.
+      offset += PAGE_SIZE
+
+      page[:results].each do |label|
+        puts ("%d) Label ID: %d, name: %s will be deactivated.") %
+            [label_ids.size, label[:id], label[:name]]
+        label_ids << label[:id]
+      end
+    end
+  end while offset < page[:total_result_set_size]
+
+  puts "Number of labels to be deactivated: %d" % label_ids.size
+
+  if !label_ids.empty?
+    # Create a statement for action.
+    statement = {:query => "WHERE id IN (%s)" % label_ids.join(', ')}
+
+    # Perform action.
+    result = label_service.perform_label_action(
+        {:xsi_type => 'DeactivateLabels'}, statement)
+
+    # Display results.
+    if result and result[:num_changes] > 0
+      puts "Number of labels deactivated: %d" % result[:num_changes]
+    else
+      puts 'No labels were deactivated.'
+    end
+  else
+    puts 'No labels found to deactivate.'
+  end
+end
+
+if __FILE__ == $0
+  begin
+    deactivate_labels()
+
+  # 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/v201108/label_service/get_all_labels.rb

@@ -0,0 +1,94 @@
+#!/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 labels. To create labels, run create_labels.rb
+#
+# This feature is only available to DFP premium solution networks.
+#
+# Tags: LabelService.getLabelsByStatement
+
+require 'rubygems'
+require 'dfp_api'
+
+API_VERSION = :v201108
+PAGE_SIZE = 500
+
+def get_all_labels()
+  # 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 LabelService.
+  label_service = dfp.service(:LabelService, 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 labels by statement.
+    page = label_service.get_labels_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 label in results page.
+      page[:results].each_with_index do |label, index|
+        puts "%d) Label ID: %d, name: %s, type: %s." %
+            [index + start_index, label[:id], label[:name], label[:type]]
+      end
+    end
+  end while offset < page[:total_result_set_size]
+
+  # Print a footer
+  if page.include?(:total_result_set_size)
+    puts "Total number of labels: %d" % page[:total_result_set_size]
+  end
+end
+
+if __FILE__ == $0
+  begin
+    get_all_labels()
+
+  # 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/v201108/label_service/get_label.rb

@@ -0,0 +1,76 @@
+#!/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 label by its ID. To determine which labels exist,
+# run get_all_labels.rb.
+#
+# This feature is only available to DFP premium solution networks.
+#
+# Tags: LabelService.getLabel
+
+require 'rubygems'
+require 'dfp_api'
+
+API_VERSION = :v201108
+
+def get_label()
+  # 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 LabelService.
+  label_service = dfp.service(:LabelService, API_VERSION)
+
+  # Set the ID of the label to get.
+  label_id = 'INSERT_LABEL_ID_HERE'.to_i
+
+  # Get the label.
+  label = label_service.get_label(label_id)
+
+  if label
+    puts "Label with ID: %d, name: %s and type %s was found." %
+        [label[:id], label[:name], label[:type]]
+  else
+    puts 'No label found for this ID.'
+  end
+end
+
+if __FILE__ == $0
+  begin
+    get_label()
+
+  # 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/v201108/label_service/get_labels_by_statement.rb

@@ -0,0 +1,91 @@
+#!/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 labels that are competitively excluded. The statement
+# retrieves up to the maximum page size limit of 500. To create labels, run
+# create_labels.rb.
+#
+# This feature is only available to DFP premium solution networks.
+#
+# Tags: LabelService.getLabelsByStatement
+
+require 'rubygems'
+require 'dfp_api'
+
+API_VERSION = :v201108
+
+def get_labels_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 LabelService.
+  label_service = dfp.service(:LabelService, API_VERSION)
+
+  # Create a statement to only select active labels.
+  statement = {
+      :query => 'WHERE type = :type ORDER BY name LIMIT 500',
+      :values => [
+          {:key => 'type',
+           :value => {
+               :value => 'COMPETITIVE_EXCLUSION',
+               :xsi_type => 'TextValue'}
+          }
+      ]
+  }
+
+  # Get labels by statement.
+  page = label_service.get_labels_by_statement(statement)
+
+  if page and page[:results]
+    page[:results].each_with_index do |label, index|
+      puts "%d) Label ID: %d, name: %s, type: %s." % [index,
+          label[:id], label[:name], label[:type]]
+    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_labels_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