google-dfp-api 0.17.0 → 0.18.0

data/examples/v201508/inventory_service/get_ad_units_by_statement.rb

@@ -1,97 +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 first 500 children below the effective root ad unit. To
-# create ad units, run create_ad_units.rb.
-
-require 'dfp_api'
-
-
-API_VERSION = :v201508
-
-def get_ad_units_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 InventoryService.
-  inventory_service = dfp.service(:InventoryService, API_VERSION)
-
-  # Get the NetworkService.
-  network_service = dfp.service(:NetworkService, API_VERSION)
-
-  # Get the effective root ad unit ID of the network.
-  effective_root_ad_unit_id =
-      network_service.get_current_network[:effective_root_ad_unit_id]
-
-  puts "Using effective root ad unit: %d" % effective_root_ad_unit_id
-
-  # Create a statement to select the children of the effective root ad unit.
-  statement = DfpApi::FilterStatement.new(
-     'WHERE parentId = :id ORDER BY id',
-     [
-         {:key => 'id',
-          :value => {:value => effective_root_ad_unit_id,
-                     :xsi_type => 'NumberValue'}}
-     ]
-  )
-
-  begin
-    # Get ad units by statement.
-    page = inventory_service.get_ad_units_by_statement(statement.toStatement())
-
-    if page[:results]
-      # Print details about each ad unit in results.
-      page[:results].each_with_index do |ad_unit, index|
-        puts "%d) Ad unit ID: %d, name: %s, status: %s." %
-            [index + statement.offset, ad_unit[:id],
-             ad_unit[:name], ad_unit[: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 ad units: %d" % page[:total_result_set_size]
-  end
-end
-
-if __FILE__ == $0
-  begin
-    get_ad_units_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/v201508/inventory_service/get_all_ad_units.rb

@@ -1,80 +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 ad units. To create ad units, run create_ad_units.rb.
-
-require 'dfp_api'
-
-
-API_VERSION = :v201508
-
-def get_all_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)
-
-  # Create a statement to get all ad units
-  statement = DfpApi::FilterStatement.new('ORDER BY id ASC')
-
-  begin
-    # Get ad units by statement.
-    page = inventory_service.get_ad_units_by_statement(statement.toStatement())
-
-    if page[:results]
-      # Print details about each ad unit in results.
-      page[:results].each_with_index do |ad_unit, index|
-        puts "%d) Ad unit ID: %d, name: %s, status: %s." %
-            [index + statement.offset, ad_unit[:id],
-             ad_unit[:name], ad_unit[: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 ad units: %d" % page[:total_result_set_size]
-  end
-end
-
-if __FILE__ == $0
-  begin
-    get_all_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/v201508/label_service/create_labels.rb

@@ -1,79 +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 labels. To determine which labels exist, run
-# get_all_labels.rb.
-#
-# This feature is only available to DFP premium solution networks.
-
-require 'dfp_api'
-
-API_VERSION = :v201508
-# 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, :types => ['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 types: '%s' was created." %
-          [label[:id], label[:name], label[:types].join(', ')]
-    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/v201508/label_service/deactivate_labels.rb

@@ -1,107 +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 deactivates all active labels. To determine which labels exist,
-# run get_all_labels.rb.
-#
-# This feature is only available to DFP premium solution networks.
-
-require 'dfp_api'
-
-
-API_VERSION = :v201508
-
-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 to select active labels.
-  statement = DfpApi::FilterStatement.new(
-      'WHERE isActive = :is_active',
-      [
-          {:key => 'is_active',
-           :value => {:value => true, :xsi_type => 'BooleanValue'}}
-      ]
-  )
-
-  # Define initial values.
-  label_ids = []
-
-  begin
-    # Get labels by statement.
-    page = label_service.get_labels_by_statement(statement.toStatement())
-
-    if page[:results]
-      page[:results].each_with_index do |label, index|
-        puts ("%d) Label ID: %d, name: %s will be deactivated.") %
-            [index + statement.offset, label[:id], label[:name]]
-        label_ids << label[:id]
-      end
-    end
-    statement.offset += DfpApi::SUGGESTED_PAGE_LIMIT
-  end while statement.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 = DfpApi::FilterStatement.new(
-        "WHERE id IN (%s)" % label_ids.join(', '))
-
-    # Perform action.
-    result = label_service.perform_label_action(
-        {:xsi_type => 'DeactivateLabels'}, statement.toStatement())
-
-    # 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/v201508/label_service/update_labels.rb

@@ -1,96 +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 updates the descriptions of all active labels by updating its
-# description. To determine which labels exist, run get_all_labels.rb.
-#
-# This feature is only available to DFP premium solution networks.
-
-require 'dfp_api'
-
-
-API_VERSION = :v201508
-
-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 active labels.
-  statement = DfpApi::FilterStatement.new(
-      'WHERE isActive = :is_active',
-      [
-          {:key => 'is_active',
-           :value => {
-               :value => 'true',
-               :xsi_type => 'BooleanValue'}
-          }
-      ]
-  )
-
-  begin
-    # Get labels by statement.
-    page = label_service.get_labels_by_statement(statement.toStatement())
-
-    if page[:results]
-      # Update each local label object by changing its description.
-      page[:results].each do |label|
-        label[:description] = 'This label was updated'
-      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
-    end
-  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