.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.40)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "Net::Google::SafeBrowsing2::Lookup 3pm"
.TH Net::Google::SafeBrowsing2::Lookup 3pm "2021-01-07" "perl v5.32.0" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
Net::Google::SafeBrowsing2::Lookup \- Perl extension for the Google Safe Browsing v2 Lookup API.
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\&  use Net::Google::SafeBrowsing2::Lookup;
\&
\&  my $gsb = Net::Google::SafeBrowsing2::Lookup\->new(
\&        key     => "my key", 
\&  );
\&
\&  my %match = $gsb\->lookup(url => \*(Aqhttp://www.gumblar.cn/\*(Aq);
\&  
\&  if ($match{\*(Aqhttp://www.gumblar.cn/\*(Aq} eq \*(Aqmalware\*(Aq) {
\&        print "http://www.gumblar.cn/ is flagged as a dangerous site\en";
\&  }
\&
\&  my %matches = $gsb\->lookup(urls => [\*(Aqhttp://www.gumblar.cn/\*(Aq, \*(Aqhttp://flahupdate.co.cc\*(Aq]);
\&  foreach my $url (keys %matches) {
\&    print $url, " is ", $matches{$url}, "\en";
\&  }
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
Net::Google::SafeBrowsing2::Lookup implements the Google Safe Browsing v2 Lookup \s-1API.\s0 See the \s-1API\s0 documentation at <http://code.google.com/apis/safebrowsing/lookup_guide.html>.
.PP
If you need to check more than 10,000 URLs a day, you need to use Net::Google::SafeBrowsing2.
.PP
The source code is available on github at <https://github.com/juliensobrier/Net\-Google\-SafeBrowsing2>.
.SH "CONSTRUCTOR"
.IX Header "CONSTRUCTOR"
.SS "\fBnew()\fP"
.IX Subsection "new()"
Create a Net::Google::SafeBrowsing2::Lookup object
.PP
.Vb 4
\&  my $gsb = Net::Google::SafeBrowsing2::Lookup\->new(
\&        key     => "my key", 
\&        debug   => 0,
\&  );
.Ve
.PP
Arguments
.IP "key" 4
.IX Item "key"
Required. Your Google Safe Browsing \s-1API\s0 key
.IP "debug" 4
.IX Item "debug"
Optional. Set to 1 to enable debugging. 0 (disabled) by default.
.Sp
The debug output maybe quite large and can slow down significantly the update and lookup functions.
.IP "errors" 4
.IX Item "errors"
Optional. Set to 1 to show errors to \s-1STDOUT. 0\s0 (disabled by default).
.IP "version" 4
.IX Item "version"
Optional. Google Safe Browsing version. 3.0 by default
.IP "delay" 4
.IX Item "delay"
Optional. Delay, in seconds, between 2 requests to the Google server. See the \f(CW\*(C`lookup\*(C'\fR function for more details. 0 (no delay) by default
.SH "PUBLIC FUNCTIONS"
.IX Header "PUBLIC FUNCTIONS"
.SS "\fBlookup()\fP"
.IX Subsection "lookup()"
Lookup a list URLs against the Google Safe Browsing v2 lists.
.PP
.Vb 1
\&  my %match = $gsb\->lookup(url => \*(Aqhttp://www.gumblar.cn\*(Aq);
.Ve
.PP
Returns a hash \f(CW\*(C`url\*(C'\fR => \f(CW\*(C`Google match\*(C'\fR. The possible list of values for \f(CW\*(C`Google match\*(C'\fR are: \*(L"ok\*(R" (no match), \*(L"malware\*(R", \*(L"phishing\*(R", \*(L"malware,phishing\*(R" (match both lists) and \*(L"error\*(R".
.PP
Arguments
.IP "url" 4
.IX Item "url"
Optional. Single \s-1URL\s0 to lookup.
.IP "urls" 4
.IX Item "urls"
Optional. List of URLs to lookup.
.Sp
The Lookup \s-1API\s0 allows only 10,000 \s-1URL\s0 checks a day. if you need more, use the Net::Google::SafeBrowsing2 library.
.Sp
Each requests must contain 500 URLs at most. The \fBlookup()\fR method will split the list of \s-1URLS\s0 in blocks of 500 URLs if needed.
.IP "delay" 4
.IX Item "delay"
Optional. If more than 500 URLs are checked, wait \f(CW\*(C`delay\*(C'\fR seconds between consecutive requests to avoid rate limiting by Google.
.SH "CHANGELOG"
.IX Header "CHANGELOG"
.IP "0.2" 4
.IX Item "0.2"
Documentation update.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
See Net::Google::SafeBrowsing2 for the implementation of Google Safe Browsing v2 \s-1API.\s0
.SH "AUTHOR"
.IX Header "AUTHOR"
Julien Sobrier, <jsobrier@zscaler.com> or <julien@sobrier.net>
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
Copyright (C) 2012 by Julien Sobrier
.PP
This library is free software; you can redistribute it and/or modify
it under the same terms as Perl itself, either Perl version 5.8.8 or,
at your option, any later version of Perl 5 you may have available.