google-dfp-api 0.4.0 → 0.5.0

data/examples/v201111/label_service/get_all_labels.rb

@@ -1,93 +0,0 @@
-#!/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 'dfp_api'
-
-API_VERSION = :v201111
-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/v201111/label_service/get_label.rb

@@ -1,75 +0,0 @@
-#!/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 'dfp_api'
-
-API_VERSION = :v201111
-
-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/v201111/label_service/update_labels.rb

@@ -1,103 +0,0 @@
-#!/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 updates the descriptions of all labels that are competitive
-# exclusion by updating its description up to the first 500. To determine which
-# labels exist, run get_all_labels.rb.
-#
-# This feature is only available to DFP premium solution networks.
-#
-# Tags: LabelService.getLabelsByStatement, LabelService.updateLabels
-
-require 'dfp_api'
-
-API_VERSION = :v201111
-
-def update_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 a statement to only select labels that are competitive exclusion and
-  # active.
-  statement = {
-      :query => 'WHERE type = :type and isActive = true 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[:results]
-    labels = page[:results]
-
-    # Update each local label object by changing its description.
-    labels.each do |label|
-      label[:description] =
-          'These labels are still competiting with each other'
-    end
-
-    # Update the labels on the server.
-    return_labels = label_service.update_labels(labels)
-
-    if return_labels
-      return_labels.each do |label|
-        puts ("Label ID: %d, name: %s was updated with description: %s.") %
-            [label[:id], label[:name], label[:description]]
-      end
-    else
-      raise 'No labels were updated.'
-    end
-  else
-    puts 'No labels found to update.'
-  end
-end
-
-if __FILE__ == $0
-  begin
-    update_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/v201111/line_item_creative_association_service/create_licas.rb

@@ -1,93 +0,0 @@
-#!/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 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 = :v201111
-
-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/v201111/line_item_creative_association_service/deactivate_licas.rb

@@ -1,126 +0,0 @@
-#!/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 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,
-#       InventoryService.performAdUnitAction
-
-require 'dfp_api'
-
-API_VERSION = :v201111
-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