Aaron Straup Cope > Net-Google-1.0 > Net::Google::Response

Download:
Net-Google-1.0.tar.gz

Dependencies

Annotate this POD

CPAN RT

New  7
Open  1
Stalled  1
View/Report Bugs
Module Version: 1.0   Source  

NAME ^

Net::Google::Response - simple OOP-ish interface to the Google SOAP API search responses

SYNOPSIS ^

 my $service = Net::Google->new(key=>LOCAL_GOOGLE_KEY);
 my $session = $service->search();

 $session->query(qw(Perl modules));

 # You are probably better off calling
 # $session->results() but if you want
 # the raw response object(s) here ya go :

 my $responses = $session->response();
 my $count     = scalar(@$responses);

 # $r is a Net::Google::Response object

 foreach my $r (@$responses) {
     print sprintf("%s : %s\n",$r->searchQuery(),$r->estimatedTotalResults());
 }

DESCRIPTION ^

Provides a simple OOP-ish interface to the Google SOAP API for searching. This package is used by Net::Google.

The Net::Google::Response object is used to contain response information provided by the Google search service in response to a search query. The Response object allows the client program to easily access the data returned from a search.

Response data is accessed using methods with identical names to the elements of a search response (as documented in the Google Web APIs Reference, section 3). For instance, the first example in the SYNOPSIS section, above, would return the estimated number of total results for the query.

Response objects may contain other response objects, where an element would return an array of other elements. For instance, calling $response->resultElements() will return a reference to an array of Net::Google::Response objects, each one representing one result from the search.

The Response module will automatically provide methods for the search response, as described by the service WSDL file. The results format is described by the Google APIs documentation, to which you should refer for the most up-to-date information. As of the April 8th, 2002 release of the Google APIs, the methods below are provided for each search result.

PACKAGE METHODS ^

__PACKAGE__->new(\%args)

Net::Google::Response OBJECT METHODS ^

$response->documentFiltering()

Returns 0 if false, 1 if true.

$response->searchComments()

Returns a string.

$response->estimatedTotalResultsCount()

Returns an integer.

$response->estimateIsExact()

Returns 0 if false, 1 if true.

$response->resultElements()

Returns a reference to an array of Response objects.

$response->searchQuery()

Returns a string.

$response->startIndex()

Returns an integer.

$response->endIndex()

Returns an integer.

$response->searchTips()

Returns a string.

$response->directoryCategories()

Returns a reference to an array of Response objects (one per directory category -- see below).

$response->searchTime()

Returns a float.

$pkg->to_string()

Result OBJECT METHODS ^

$result->title()

Returns a string.

$result->URL()

Returns a string.

$result->snippet()

Returns a string, formatted in HTML.

$result->cachedSize()

Returns a string.

$result->directoryTitle()

Returns a string.

$result->summary()

Returns a string.

$result->hostName()

Returns a string.

$result->directoryCategory()

Returns a hash reference.

VERSION ^

1.0

DATE ^

$Date: 2005/04/02 21:51:16 $

AUTHOR ^

Aaron Straup Cope

CONTRIBUTORS ^

Marc Hedlund <marc@precipice.org>

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.

syntax highlighting: