.\" 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::Amazon::Request 3pm" .TH Net::Amazon::Request 3pm "2021-01-02" "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::Amazon::Request \- Baseclass for requests to Amazon's web service .SH "SYNOPSIS" .IX Header "SYNOPSIS" .Vb 7 \& my $req = Net::Amazon::Request::XXX\->new( \& [ type => \*(AqLarge\*(Aq, ] \& [ page => $start_page, ] \& [ mode => $mode, ] \& [ offer => \*(AqAll\*(Aq, ] \& [ sort => $sort_type, ] \& ); .Ve .SH "DESCRIPTION" .IX Header "DESCRIPTION" Don't use this class directly, use derived classes (like \&\f(CW\*(C`Net::Amazon::Request::ASIN\*(C'\fR, etc.) instead to specify the type of request and its parameters. .PP However, there's a bunch of parameters to the constructor that all request types have in common, here they are: .IP "type" 4 .IX Item "type" Defaults to \f(CW\*(C`Large\*(C'\fR, but can also be set to \f(CW\*(C`Medium\*(C'\fR, or \f(CW\*(C`Small\*(C'\fR. .RS 4 .IP "Large" 8 .IX Item "Large" The \f(CW\*(C`Large\*(C'\fR type provides everything in \f(CW\*(C`Medium\*(C'\fR as well as music track information, customer reviews, similar products, offers, and accessory data, i.e. the kitchen sink. .IP "Medium" 8 .IX Item "Medium" The \f(CW\*(C`Medium\*(C'\fR type provides everything in \f(CW\*(C`Small\*(C'\fR as well as sales rank, editorial reviews, and image URLs. .IP "Small" 8 .IX Item "Small" The \f(CW\*(C`Small\*(C'\fR type provies \s-1ASIN,\s0 product title, creator (author, artist, etc.), product group, \s-1URL,\s0 and manufacturer. .RE .RS 4 .RE .IP "mode" 4 .IX Item "mode" Defaults to \f(CW\*(C`books\*(C'\fR, but can be set to other catalog values. .IP "page" 4 .IX Item "page" Defaults to \f(CW1\fR, but can be set to a different number to start with a different result page. Used in conjunction with the \&\f(CW\*(C`max_pages\*(C'\fR parameter of the \f(CW\*(C`Net::Amazon\*(C'\fR object. \f(CW\*(C`page\*(C'\fR is the offset, \f(CW\*(C`max_pages\*(C'\fR is the maximum number of pages pulled in starting at \f(CW\*(C`page\*(C'\fR. .IP "sort" 4 .IX Item "sort" Defaults to \f(CW\*(C`salesrank\*(C'\fR, but search results can be sorted in various ways, depending on the type of product returned by the search. Search results may be sorted by the following criteria: .RS 4 .IP "\(bu" 8 Featured Items .IP "\(bu" 8 Bestselling .IP "\(bu" 8 Alphabetical (A\-Z and Z\-A) .IP "\(bu" 8 Price (High to Low and Low to High) .IP "\(bu" 8 Publication or Release Date .IP "\(bu" 8 Manufacturer .IP "\(bu" 8 Average Customer Review .IP "\(bu" 8 Artist Name .RE .RS 4 .Sp Consult Net::Amazon::Request::Sort for details. .RE .IP "offer" 4 .IX Item "offer" To receive values for the fields \&\f(CW\*(C`CollectibleCount\*(C'\fR, \f(CW\*(C`NumberOfOfferings\*(C'\fR, \f(CW\*(C`UsedCount\*(C'\fR, specify \f(CW\*(C`offer => "All"\*(C'\fR. .SH "AUTHOR" .IX Header "AUTHOR" Mike Schilli, .SH "COPYRIGHT AND LICENSE" .IX Header "COPYRIGHT AND LICENSE" Copyright 2003 by Mike Schilli .PP This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself.