#!/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 Ad Manager premium solution networks.

require 'ad_manager_api'

def deactivate_labels(ad_manager)
  # Get the LabelService.
  label_service = ad_manager.service(:LabelService, API_VERSION)

  # Create statement to select active labels.
  statement = ad_manager.new_statement_builder do |sb|
    sb.where = 'isActive = :is_active'
    sb.with_bind_variable('is_active', true)
  end

  # Define initial values.
  label_ids = []

  # Retrieve a small number of labels at a time, paging
  # through until all labels have been retrieved.
  page = {:total_result_set_size => 0}
  begin
    # Get labels by statement.
    page = label_service.get_labels_by_statement(statement.to_statement())

    unless page[:results].nil?
      page[:results].each_with_index do |label, index|
        puts ('%d) Label ID %d and name "%s" will be deactivated.') %
            [index + statement.offset, label[:id], label[:name]]
        label_ids << label[:id]
      end
    end

    # Increase the statement offset by the page size to get the next page.
    statement.offset += statement.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 = ad_manager.new_statement_builder do |sb|
      sb.where = 'id IN (%s)' % label_ids.join(', ')
      sb.offset = nil
      sb.limit = nil
    end

    # Perform action.
    result = label_service.perform_label_action(
        {:xsi_type => 'DeactivateLabels'}, statement.to_statement()
    )

    # Display results.
    if !result.nil? && 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
  API_VERSION = :v202508

  # Get AdManagerApi instance and load configuration from ~/ad_manager_api.yml.
  ad_manager = AdManagerApi::Api.new

  # To enable logging of SOAP requests, set the log_level value to 'DEBUG' in
  # the configuration file or provide your own logger:
  # ad_manager.logger = Logger.new('ad_manager_xml.log')

  begin
    deactivate_labels(ad_manager)

  # HTTP errors.
  rescue AdsCommon::Errors::HttpError => e
    puts "HTTP Error: %s" % e

  # API errors.
  rescue AdManagerApi::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
