google-dfp-api 0.8.0 → 0.8.1

data/examples/v201405/line_item_creative_association_service/create_licas.rb

@@ -0,0 +1,94 @@
+#!/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 creates new line item creative associations (LICAs) for an
+# existing line item and a set of creative ids. For small business networks,
+# the creative ids must represent new or copied creatives as creatives cannot
+# be used for more than one line item. For premium solution networks, the
+# creative ids can represent any creatvie. To copy creatives, run
+# copy_image_creatives.rb. To determine which LICAs exist, run get_all_licas.rb.
+#
+# Tags: LineItemCreativeAssociationService.createLineItemCreativeAssociations
+
+require 'dfp_api'
+
+API_VERSION = :v201405
+
+def create_licas()
+  # 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 LineItemCreativeAssociationService.
+  lica_service = dfp.service(:LineItemCreativeAssociationService, API_VERSION)
+
+  # Get the CreativeService.
+  creative_service = dfp.service(:CreativeService, API_VERSION)
+
+  # Set the line item ID and creative IDs to associate.
+  line_item_id = 'INSERT_LINE_ITEM_ID_HERE'.to_i
+  creative_ids = [
+      'INSERT_CREATIVE_ID_HERE'.to_i,
+      'INSERT_CREATIVE_ID_HERE'.to_i
+  ]
+
+  # Create an array to store local LICA objects.
+  licas = creative_ids.map do |creative_id|
+    # For each line item, associate it with the given creative.
+    {:line_item_id => line_item_id, :creative_id => creative_id}
+  end
+
+  # Create the LICAs on the server.
+  return_licas = lica_service.create_line_item_creative_associations(licas)
+
+  if return_licas
+    return_licas.each do |lica|
+      puts ("LICA with line item ID: %d, creative ID: %d and status: %s was " +
+          "created.") % [lica[:line_item_id], lica[:creative_id], lica[:status]]
+    end
+  else
+    raise 'No LICAs were created.'
+  end
+
+end
+
+if __FILE__ == $0
+  begin
+    create_licas()
+
+  # 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/v201405/line_item_creative_association_service/deactivate_licas.rb

@@ -0,0 +1,127 @@
+#!/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 deactivates all LICAs for the line item. To determine which LICAs
+# exist, run get_all_licas.rb. To determine which line items exist, run
+# get_all_line_items.rb.
+#
+# Tags: InventoryService.getLineItemsByStatement
+# Tags: InventoryService.performAdUnitAction
+
+require 'dfp_api'
+
+API_VERSION = :v201405
+PAGE_SIZE = 500
+
+def deactivate_licas()
+  # 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 LineItemCreativeAssociationService.
+  lica_service = dfp.service(:LineItemCreativeAssociationService, API_VERSION)
+
+  # Set the line item to get LICAs by.
+  line_item_id = 'INSERT_LINE_ITEM_ID_HERE'.to_i
+
+  # Create statement text to select active LICAs for a given line item.
+  statement_text = 'WHERE lineItemId = :line_item_id AND status = :status'
+
+  statement = {
+      :values => [
+          {:key => 'line_item_id',
+           :value => {:value => line_item_id, :xsi_type => 'NumberValue'}},
+          {:key => 'status',
+           :value => {:value => 'ACTIVE', :xsi_type => 'TextValue'}}
+      ]
+  }
+
+  # Define initial values.
+  offset = 0
+  page = {}
+  creative_ids = []
+
+  begin
+    # Create a statement to get one page with current offset.
+    statement[:query] = statement_text +
+        " LIMIT %d OFFSET %d" % [PAGE_SIZE, offset]
+
+    # Get LICAs by statement.
+    page =
+      lica_service.get_line_item_creative_associations_by_statement(statement)
+
+    if page[:results]
+      # Increase query offset by page size.
+      offset += PAGE_SIZE
+
+      page[:results].each do |lica|
+        puts ("%d) LICA with line item ID: %d, creative ID: %d and status: %s" +
+            " will be deactivated.") % [creative_ids.size, lica[:line_item_id],
+            lica[:creative_id], lica[:status]]
+        creative_ids << lica[:creative_id]
+      end
+    end
+  end while offset < page[:total_result_set_size]
+
+  puts "Number of LICAs to be deactivated: %d" % creative_ids.size
+
+  if !creative_ids.empty?
+    # Modify statement for action. Note, the values are still present.
+    statement[:query] = statement_text + " AND creativeId IN (%s)" %
+        creative_ids.join(', ')
+
+    # Perform action.
+    result = lica_service.perform_line_item_creative_association_action(
+        {:xsi_type => 'DeactivateLineItemCreativeAssociations'}, statement)
+
+    # Display results.
+    if result and result[:num_changes] > 0
+      puts "Number of LICAs deactivated: %d" % result[:num_changes]
+    else
+      puts 'No LICAs were deactivated.'
+    end
+  else
+    puts 'No LICAs found to deactivate.'
+  end
+end
+
+if __FILE__ == $0
+  begin
+    deactivate_licas()
+
+  # 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/v201405/line_item_creative_association_service/get_all_licas.rb

@@ -0,0 +1,98 @@
+#!/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 all line item creative associations (LICA). To create LICAs,
+# run create_licas.rb or associate_creative_set_to_line_item.rb.
+#
+# Tags: LineItemCreativeAssociationService.getLineItemCreativeAssociationsByStatement
+
+require 'dfp_api'
+
+API_VERSION = :v201405
+PAGE_SIZE = 500
+
+def get_all_licas()
+  # 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 LineItemCreativeAssociationService.
+  lica_service = dfp.service(:LineItemCreativeAssociationService, 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 LICAs by statement.
+    page =
+        lica_service.get_line_item_creative_associations_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 LICA in results page.
+      page[:results].each_with_index do |lica, index|
+        creative_text = (lica[:creative_set_id] != nil) ?
+            'creative set ID %d' % lica[:creative_set_id] :
+            'creative ID %d' % lica[:creative_id]
+        puts '%d) LICA with line item ID: %d, %s and status: %s' %
+            [index + start_index, lica[:line_item_id], creative_text,
+             lica[:status]]
+      end
+    end
+  end while offset < page[:total_result_set_size]
+
+  # Print a footer
+  if page.include?(:total_result_set_size)
+    puts 'Total number of LICAs: %d' % page[:total_result_set_size]
+  end
+end
+
+if __FILE__ == $0
+  begin
+    get_all_licas()
+
+  # 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/v201405/line_item_creative_association_service/get_licas_by_statement.rb

@@ -0,0 +1,91 @@
+#!/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 all line item creative associations for a given line item
+# ID. The statement retrieves up to the maximum page size limit of 500. To
+# create LICAs, run create_licas.rb. To determine which line items exist, run
+# get_all_line_items.rb.
+#
+# Tags: LineItemCreativeAssociationService.getLineItemCreativeAssociationsByStatement
+
+require 'dfp_api'
+
+API_VERSION = :v201405
+
+def get_licas_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 LineItemCreativeAssociationService.
+  lica_service = dfp.service(:LineItemCreativeAssociationService, API_VERSION)
+
+  # Set the line item to get LICAs by.
+  line_item_id = 'INSERT_LINE_ITEM_ID_HERE'.to_i
+
+  # Create a statement to only select LICAs for the given line item ID.
+  statement = {
+      :query => 'WHERE lineItemId = :line_item_id LIMIT 500',
+      :values => [
+          {:key => 'line_item_id',
+           :value => {:value => line_item_id, :xsi_type => 'NumberValue'}}
+      ]
+  }
+
+  # Get LICAs by statement.
+  page =
+      lica_service.get_line_item_creative_associations_by_statement(statement)
+
+  if page and page[:results]
+    page[:results].each_with_index do |lica, index|
+      puts "%d) LICA with line item ID: %d, creative ID: %d and status: %s." %
+          [index, lica[:line_item_id], lica[:creative_id], lica[: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_licas_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/v201405/line_item_creative_association_service/update_licas.rb

@@ -0,0 +1,91 @@
+#!/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 the destination URL of all LICAs up to the first 500. To
+# determine which LICAs exist, run get_all_licas.rb.
+#
+# Tags: LineItemCreativeAssociationService.getLineItemCreativeAssociationsByStatement
+# Tags: LineItemCreativeAssociationService.updateLineItemCreativeAssociations
+
+require 'dfp_api'
+
+API_VERSION = :v201405
+
+def update_licas()
+  # 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 LineItemCreativeAssociationService.
+  lica_service = dfp.service(:LineItemCreativeAssociationService, API_VERSION)
+
+  # Create a statement to get all LICAs.
+  statement = {:query => 'LIMIT 500'}
+
+  # Get LICAs by statement.
+  page =
+      lica_service.get_line_item_creative_associations_by_statement(statement)
+
+  if page[:results]
+    licas = page[:results]
+
+    # Update each local LICA object by changing its destination URL.
+    licas.each {|lica| lica[:destination_url] = 'http://news.google.com'}
+
+    # Update the LICAs on the server.
+    return_licas = lica_service.update_line_item_creative_associations(licas)
+
+    if return_licas
+      return_licas.each do |lica|
+        puts ("LICA with line item ID: %d and creative ID: %d was updated " +
+              "with destination url [%s]") %
+              [lica[:line_item_id], lica[:creative_id], lica[:destination_url]]
+      end
+    else
+      raise 'No LICAs were updated.'
+    end
+  else
+    puts 'No LICAs found to update.'
+  end
+end
+
+if __FILE__ == $0
+  begin
+    update_licas()
+
+  # 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