#!/usr/bin/ruby
#
# Author:: api.sgomes@gmail.com (SĂŠrgio Gomes)
#
# 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 retrieves URLs that have content keywords related to a given
# website.
#
# Tags: TargetingIdeaService.get

require 'rubygems'
require 'adwords_api'
require 'adwords_api/utils'

API_VERSION = :v201101
PAGE_SIZE = 100

def get_related_placements()
  # AdwordsApi::Api will read a config file from ENV['HOME']/adwords_api.yml
  # when called without parameters.
  adwords = AdwordsApi::Api.new

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

  targeting_idea_srv = adwords.service(:TargetingIdeaService, API_VERSION)

  url = 'INSERT_PLACEMENT_URL_HERE'

  # Construct selector.
  selector = {
    :idea_type => 'PLACEMENT',
    :request_type => 'IDEAS',
    :requested_attribute_types => ['CRITERION'],
    :search_parameters => [{
      # The 'xsi_type' field allows you to specify the xsi:type of the object
      # being created. It's only necessary when you must provide an explicit
      # type that the client library can't infer.
      :xsi_type => 'RelatedToUrlSearchParameter',
      :urls => [url],
      :include_sub_urls => false
    }],
    :paging => {
      :start_index => 0,
      :number_results => PAGE_SIZE
    }
  }

  # Define initial values.
  offset = 0
  results = []

  begin
    # Perform request.
    page = targeting_idea_srv.get(selector)
    results += page[:entries] if page and page[:entries]

    # Prepare next page request.
    offset += PAGE_SIZE
    selector[:paging][:start_index] = offset
  end while offset < page[:total_num_entries]

  # Display results.
  results.each do |result|
    data = AdwordsApi::Utils.map(result[:data])
    placement = data['CRITERION'][:value]
    puts "Related content keywords found at URL [%s]" % placement[:url]
  end
  puts "Total URLs found with keywords related to keywords at [%s]: %d." %
      [url, results.length]
end

if __FILE__ == $0
  begin
    get_related_placements()

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

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