google-dfp-api 0.17.0 → 0.18.0

data/examples/v201511/inventory_service/update_ad_units.rb

@@ -1,105 +0,0 @@
-#!/usr/bin/env ruby
-# Encoding: utf-8
-#
-# 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 adds a new 1x1 creative placeholder for a specific ad unit. To
-# determine which ad units exist, run get_all_ad_units.rb or
-# get_inventory_tree.rb.
-
-require 'dfp_api'
-
-
-API_VERSION = :v201511
-
-def update_ad_units()
-  # 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 InventoryService.
-  inventory_service = dfp.service(:InventoryService, API_VERSION)
-
-  # Specify which ad unit to update.
-  ad_unit_id = 'INSERT_AD_UNIT_ID_HERE'.to_i
-
-  # Create a statement to get first 500 ad units.
-  statement = DfpApi::FilterStatement.new(
-      'WHERE id = :id',
-      [
-          {:key => 'id',
-           :value => {:value => ad_unit_id, :xsi_type => 'NumberValue'}}
-      ],
-      1
-  }
-
-  # Get ad units by statement.
-  page = inventory_service.get_ad_units_by_statement(statement.toStatement())
-
-  if page[:results]
-    ad_units = page[:results]
-
-    new_ad_unit_size = {
-        :size => {:width => 1, :height => 1, :is_aspect_ration => false},
-        :environment_type => 'BROWSER'
-    }
-
-    # Update local ad unit by adding a new size of 1x1.
-    ad_units.each do |ad_unit|
-      ad_unit[:ad_unit_sizes] = ad_unit[:ad_unit_sizes] << new_ad_unit_size
-      # Workaround for issue #94.
-      ad_unit[:description] = "" if ad_unit[:description].nil?
-    end
-
-    # Update the ad units on the server.
-    return_ad_units = inventory_service.update_ad_units(ad_units)
-
-    if return_ad_units
-      return_ad_units.each do |ad_unit|
-        puts ("Ad unit with ID: %d, name: %s and status: %s was updated") %
-            [ad_unit[:id], ad_unit[:name], ad_unit[:status]]
-      end
-    else
-      raise 'No ad units were updated.'
-    end
-  else
-    puts 'No ad units found to update.'
-  end
-end
-
-if __FILE__ == $0
-  begin
-    update_ad_units()
-
-  # 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/v201511/label_service/get_all_labels.rb

@@ -1,82 +0,0 @@
-#!/usr/bin/env ruby
-# Encoding: utf-8
-#
-# 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.
-
-require 'dfp_api'
-
-
-API_VERSION = :v201511
-
-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)
-
-  # Create statement for all labels.
-  statement = DfpApi::FilterStatement.new('ORDER BY id ASC')
-
-  begin
-    # Get labels by statement.
-    page = label_service.get_labels_by_statement(statement.toStatement())
-
-    if page[:results]
-      # Print details about each label in results page.
-      page[:results].each_with_index do |label, index|
-        puts "%d) Label ID: %d, name: '%s', types: '%s'." %
-            [index + statement.offset, label[:id], label[:name],
-             label[:types]]
-      end
-    end
-    statement.offset += DfpApi::SUGGESTED_PAGE_LIMIT
-  end while statement.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/v201511/label_service/get_labels_by_statement.rb

@@ -1,82 +0,0 @@
-#!/usr/bin/env ruby
-# Encoding: utf-8
-#
-# 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 ordered by name. To create labels,
-# run create_labels.rb.
-#
-# This feature is only available to DFP premium solution networks.
-
-require 'dfp_api'
-
-
-API_VERSION = :v201511
-
-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 select labels ordered by name.
-  statement = DfpApi::FilterStatement.new('ORDER BY id ASC')
-
-  begin
-    # Get labels by statement.
-    page = label_service.get_labels_by_statement(statement.toStatement())
-
-    if page and page[:results]
-      page[:results].each_with_index do |label, index|
-        puts "%d) Label ID: %d, name: '%s'." % [
-            index + statement.offset,
-            label[:id], label[:name]]
-      end
-    end
-    statement.offset += DfpApi::SUGGESTED_PAGE_LIMIT
-  end while statement.offset < page[:total_result_set_size]
-
-  # 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

data/examples/v201511/line_item_creative_association_service/create_licas.rb

@@ -1,90 +0,0 @@
-#!/usr/bin/env ruby
-# Encoding: utf-8
-#
-# 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.
-
-require 'dfp_api'
-
-API_VERSION = :v201511
-
-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/v201511/line_item_creative_association_service/get_all_licas.rb

@@ -1,85 +0,0 @@
-#!/usr/bin/env ruby
-# Encoding: utf-8
-#
-# 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.
-
-require 'dfp_api'
-
-
-API_VERSION = :v201511
-
-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)
-
-  begin
-    # Create statement for one page with current offset.
-    statement = DfpApi::FilterStatement.new('ORDER BY lineItemId ASC')
-
-    # Get LICAs by statement.
-    page = lica_service.get_line_item_creative_associations_by_statement(
-        statement.toStatement())
-
-    if page[:results]
-      # 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 + statement.offset, lica[:line_item_id], creative_text,
-             lica[:status]]
-      end
-    end
-    statement.offset += DfpApi::SUGGESTED_PAGE_LIMIT
-  end while statement.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/v201511/line_item_creative_association_service/get_licas_by_statement.rb

@@ -1,89 +0,0 @@
-#!/usr/bin/env ruby
-# Encoding: utf-8
-#
-# 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.
-
-require 'dfp_api'
-
-
-API_VERSION = :v201511
-
-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 = DfpApi::FilterStatement.new(
-      'WHERE lineItemId = :line_item_id ORDER BY lineItemId, orderId ASC',
-      [
-          {: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.toStatement())
-
-  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 + statement.offset,
-           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