google-dfp-api 0.6.3 → 0.7.0

data/examples/v201204/label_service/deactivate_labels.rb

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

@@ -1,95 +0,0 @@
-#!/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 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 = :v201204
-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', types: '%s'." %
-            [index + start_index, label[:id], label[:name],
-             label[:types].join(', ')]
-      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/v201204/label_service/get_label.rb

@@ -1,76 +0,0 @@
-#!/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 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 = :v201204
-
-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 types '%s' was found." %
-        [label[:id], label[:name], label[:types].join(', ')]
-  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/v201204/label_service/get_labels_by_statement.rb

@@ -1,81 +0,0 @@
-#!/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 labels ordered by name. 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 'dfp_api'
-
-API_VERSION = :v201204
-
-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 = {:query => 'ORDER BY name LIMIT 500'}
-
-  # 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', types: '%s'." % [index,
-          label[:id], label[:name], label[:types].join(', ')]
-    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

data/examples/v201204/label_service/update_labels.rb

@@ -1,102 +0,0 @@
-#!/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 descriptions of all active labels 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 = :v201204
-
-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 = {
-      :query => 'WHERE isActive = :is_active LIMIT 500',
-      :values => [
-          {:key => 'is_active',
-           :value => {
-               :value => 'true',
-               :xsi_type => 'BooleanValue'}
-          }
-      ]
-  }
-
-  # 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] = '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
-  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