/ 
Net-Google-1.0
River stage one • 2 direct dependents • 2 total dependents
/ Net::Google::Search

NAME

Net::Google::Search - simple OOP-ish interface to the Google SOAP API for searching

SYNOPSIS

use Net::Google::Search;
my $search = Net::Google::Search->new(\%args);

$search->query(qw(aaron cope));
map { print $_->title()."\n"; } @{$search->results()};

# or

foreach my $r (@{$search->response()}) {
  print "Search time :".$r->searchTime()."\n";

  # returns an array ref of Result objects
  # the same as the $search->results() method
  map { print $_->URL()."\n"; } @{$r->resultElement()}
}

DESCRIPTION

Provides a simple OOP-ish interface to the Google SOAP API for searching.

This package is used by Net::Google.

ENCODING

According to the Google API docs :

"In order to support searching documents in multiple languages 
and character encodings the Google Web APIs perform all requests 
and responses in the UTF-8 encoding. The parameters <ie> and 
<oe> are required in client requests but their values are ignored.
Clients should encode all request data in UTF-8 and should expect
results to be in UTF-8."

(This package takes care of setting both parameters in requests.)

PACKAGE METHODS

__PACKAGE__->new(\%args)

Valid arguments are :

  • key

    string. A Google API key.

    If none is provided then the key passed to the parent Net::Google object will be used.

  • starts_at

    int. First result number to display.

    Default is 0.

  • max_results

    int. Number of results to return.

    Default is 10.

  • lr

    string or array reference. Language restrictions.

  • safe

    boolean.

  • filter

    boolean.

  • http_proxy

    url. A URL for proxy-ing HTTP requests.

  • debug

    Valid options are:

    • boolean

      If true prints debugging information returned by SOAP::Lite to STDERR

    • coderef.

      Your own subroutine for munging the debugging information returned by SOAP::Lite.

The object constructor in Net::Google 0.53, and earlier, expected a GoogleSearchService object as its first argument followed by a hash reference of argument. Versions 0.6 and higher are backwards compatible.

Returns an object. Woot!

OBJECT METHODS

$obj->key($string)

Get/set the Google API key for this object.

$obj->http_proxy($url)

Get/set the HTTP proxy for this object.

Returns a string.

$obj->query(@data)

If the first item in @data is empty, then any existing query data will be removed before the new data is added.

Returns a string of words separated by white space. Returns undef if there was an error.

$obj->starts_at($at)

Returns an int. Default is 0.

Returns undef if there was an error.

$obj->max_results($max)

The default set by Google is 10 results. However, if you pass a number greater than 10 the results method will make multiple calls to Google API.

Returns an int.

Returns undef if there was an error.

$obj->restrict(@types)

If the first item in @types is empty, then any existing restrict data will be removed before the new data is added.

Returns a string. Returns undef if there was an error.

$obj->filter($bool)

Returns true or false. Returns undef if there was an error.

$obj->safe($bool)

Returns true or false. Returns undef if there was an error.

$obj->lr(@lang)

Language restriction.

If the first item in @lang is empty, then any existing lr data will be removed before the new data is added.

Returns a string. Returns undef if there was an error.

$obj->return_estimatedTotal($bool)

Toggle whether or not to return all the results defined by the '__estimatedTotalResultsCount' key.

Default is false.

$obj->response()

Returns an array ref of Net::Google::Response objects, from which the search response metadata as well as the search results may be obtained.

Use this method if you would like to receive a full response as documented in the Google Web APIs Reference (the whole of section 3).

$obj->results()

Returns an array ref of Result objects (see docs for Net::Google::Response), each of which represents one result from the search.

Use this method if you don't care about the search response metadata, and only care about the resources that are found by the search, as described in section 3.2 of the Google Web APIs Reference.

$obj->queries_exhausted()

Returns true or false depending on whether or not the current in-memory session has exhausted the Google API 1000 query limit.

VERSION

1.0

DATE

$Date: 2005/03/26 20:49:03 $

AUTHOR

Aaron Straup Cope

CONTRIBUTORS

Marc Hedlund <marc@precipice.org>

TO DO

  • Add hooks to manage boolean searches and speacial query strings.

SEE ALSO

Net::Google

LICENSE

Copyright (c) 2002-2005, Aaron Straup Cope. All Rights Reserved.

This is free software, you may use it and distribute it under the same terms as Perl itself.