| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838 |
- <?xml version="1.0" encoding="UTF-8"?>
- <!-- Reviewed: no -->
- <sect1 id="zend.service.amazon">
- <title>Zend_Service_Amazon</title>
- <sect2 id="zend.service.amazon.introduction">
- <title>Introduction</title>
- <para>
- <classname>Zend_Service_Amazon</classname> is a simple <acronym>API</acronym> for using Amazon web services.
- <classname>Zend_Service_Amazon</classname> has two <acronym>API</acronym>s: a more traditional one that follows Amazon's own <acronym>API</acronym>, and a
- simpler "Query <acronym>API</acronym>" for constructing even complex search queries easily.
- </para>
- <para>
- <classname>Zend_Service_Amazon</classname> enables developers to retrieve information appearing throughout Amazon.com
- web sites directly through the Amazon Web Services <acronym>API</acronym>. Examples include:
- <itemizedlist>
- <listitem>
- <para>
- Store item information, such as images, descriptions, pricing, and more
- </para>
- </listitem>
- <listitem>
- <para>
- Customer and editorial reviews
- </para>
- </listitem>
- <listitem>
- <para>
- Similar products and accessories
- </para>
- </listitem>
- <listitem>
- <para>
- Amazon.com offers
- </para>
- </listitem>
- <listitem>
- <para>
- ListMania lists
- </para>
- </listitem>
- </itemizedlist>
- </para>
- <para>
- In order to use <classname>Zend_Service_Amazon</classname>, you should already have an Amazon developer <acronym>API</acronym> key
- aswell as a secret key. To get a key and for more information, please visit the
- <ulink url="http://aws.amazon.com/">Amazon Web Services</ulink> web site. As of August 15th, 2009 you can
- only use the Amazon Product Advertising <acronym>API</acronym> through <classname>Zend_Service_Amazon</classname>, when specifying
- the additional secret key.
- </para>
- <note>
- <title>Attention</title>
- <para>
- Your Amazon developer <acronym>API</acronym> and secret keys are linked to your Amazon identity,
- so take appropriate measures to keep them private.
- </para>
- </note>
- <example id="zend.service.amazon.introduction.example.itemsearch">
- <title>Search Amazon Using the Traditional API</title>
- <para>
- In this example, we search for <acronym>PHP</acronym> books at Amazon and loop through the results, printing them.
- </para>
- <programlisting language="php"><![CDATA[
- $amazon = new Zend_Service_Amazon('AMAZON_API_KEY', 'US', 'AMAZON_SECRET_KEY');
- $results = $amazon->itemSearch(array('SearchIndex' => 'Books',
- 'Keywords' => 'php'));
- foreach ($results as $result) {
- echo $result->Title . '<br />';
- }
- ]]></programlisting>
- </example>
- <example id="zend.service.amazon.introduction.example.query_api">
- <title>Search Amazon Using the Query API</title>
- <para>
- Here, we also search for <acronym>PHP</acronym> books at Amazon, but we instead use the Query <acronym>API</acronym>, which
- resembles the Fluent Interface design pattern.
- </para>
- <programlisting language="php"><![CDATA[
- $query = new Zend_Service_Amazon_Query('AMAZON_API_KEY',
- 'US',
- 'AMAZON_SECRET_KEY');
- $query->category('Books')->Keywords('PHP');
- $results = $query->search();
- foreach ($results as $result) {
- echo $result->Title . '<br />';
- }
- ]]></programlisting>
- </example>
- </sect2>
- <sect2 id="zend.service.amazon.countrycodes">
- <title>Country Codes</title>
- <para>
- By default, <classname>Zend_Service_Amazon</classname> connects to the United States ("<code>US</code>") Amazon
- web service. To connect from a different country, simply specify the appropriate country code string
- as the second parameter to the constructor:
- </para>
- <example id="zend.service.amazon.countrycodes.example.country_code">
- <title>Choosing an Amazon Web Service Country</title>
- <programlisting language="php"><![CDATA[
- // Connect to Amazon in Japan
- $amazon = new Zend_Service_Amazon('AMAZON_API_KEY', 'JP', 'AMAZON_SECRET_KEY');
- ]]></programlisting>
- </example>
- <note>
- <title>Country codes</title>
- <para>
- Valid country codes are: <code>CA</code>, <code>DE</code>, <code>FR</code>, <code>JP</code>,
- <code>UK</code>, and <code>US</code>.
- </para>
- </note>
- </sect2>
- <sect2 id="zend.service.amazon.itemlookup">
- <title>Looking up a Specific Amazon Item by ASIN</title>
- <para>
- The <methodname>itemLookup()</methodname> method provides the ability to fetch a particular Amazon item when
- the <acronym>ASIN</acronym> is known.
- </para>
- <example id="zend.service.amazon.itemlookup.example.asin">
- <title>Looking up a Specific Amazon Item by ASIN</title>
- <programlisting language="php"><![CDATA[
- $amazon = new Zend_Service_Amazon('AMAZON_API_KEY', 'US', 'AMAZON_SECRET_KEY');
- $item = $amazon->itemLookup('B0000A432X');
- ]]></programlisting>
- </example>
- <para>
- The <methodname>itemLookup()</methodname> method also accepts an optional second parameter for handling search
- options. For full details, including a list of available options, please see the
- <ulink
- url="http://www.amazon.com/gp/aws/sdk/main.html/103-9285448-4703844?s=AWSEcommerceService&v=2005-10-05&p=ApiReference/ItemLookupOperation">relevant Amazon documentation</ulink>.
- </para>
- <note>
- <title>Image information</title>
- <para>
- To retrieve images information for your search results, you must set
- <code>ResponseGroup</code> option to <code>Medium</code> or <code>Large</code>.
- </para>
- </note>
- </sect2>
- <sect2 id="zend.service.amazon.itemsearch">
- <title>Performing Amazon Item Searches</title>
- <para>
- Searching for items based on any of various available criteria are made simple using the
- <methodname>itemSearch()</methodname> method, as in the following example:
- </para>
- <example id="zend.service.amazon.itemsearch.example.basic">
- <title>Performing Amazon Item Searches</title>
- <programlisting language="php"><![CDATA[
- $amazon = new Zend_Service_Amazon('AMAZON_API_KEY', 'US', 'AMAZON_SECRET_KEY');
- $results = $amazon->itemSearch(array('SearchIndex' => 'Books',
- 'Keywords' => 'php'));
- foreach ($results as $result) {
- echo $result->Title . '<br />';
- }
- ]]></programlisting>
- </example>
- <example id="zend.service.amazon.itemsearch.example.responsegroup">
- <title>Using the ResponseGroup Option</title>
- <para>
- The <code>ResponseGroup</code> option is used to control the specific information that will be returned
- in the response.
- </para>
- <programlisting language="php"><![CDATA[
- $amazon = new Zend_Service_Amazon('AMAZON_API_KEY', 'US', 'AMAZON_SECRET_KEY');
- $results = $amazon->itemSearch(array(
- 'SearchIndex' => 'Books',
- 'Keywords' => 'php',
- 'ResponseGroup' => 'Small,ItemAttributes,Images,SalesRank,Reviews,' .
- 'EditorialReview,Similarities,ListmaniaLists'
- ));
- foreach ($results as $result) {
- echo $result->Title . '<br />';
- }
- ]]></programlisting>
- </example>
- <para>
- The <methodname>itemSearch()</methodname> method accepts a single array parameter for handling search
- options. For full details, including a list of available options, please see the
- <ulink
- url="http://www.amazon.com/gp/aws/sdk/main.html/103-9285448-4703844?s=AWSEcommerceService&v=2005-10-05&p=ApiReference/ItemSearchOperation">relevant Amazon documentation</ulink>
- </para>
- <tip>
- <para>
- The <link linkend="zend.service.amazon.query"><classname>Zend_Service_Amazon_Query</classname></link> class
- is an easy to use wrapper around this method.
- </para>
- </tip>
- </sect2>
- <sect2 id="zend.service.amazon.query">
- <title>Using the Alternative Query API</title>
- <sect3 id="zend.service.amazon.query.introduction">
- <title>Introduction</title>
- <para>
- <classname>Zend_Service_Amazon_Query</classname> provides an alternative <acronym>API</acronym> for using the Amazon Web Service.
- The alternative <acronym>API</acronym> uses the Fluent Interface pattern. That is, all calls can be made using chained method
- calls. (e.g., <code>$obj->method()->method2($arg)</code>)
- </para>
- <para>
- The <classname>Zend_Service_Amazon_Query</classname> <acronym>API</acronym> uses overloading to easily set up an item search and then
- allows you to search based upon the criteria specified. Each of the options is provided as a method call,
- and each method's argument corresponds to the named option's value:
- </para>
- <example id="zend.service.amazon.query.introduction.example.basic">
- <title>Search Amazon Using the Alternative Query API</title>
- <para>
- In this example, the alternative query <acronym>API</acronym> is used as a fluent interface to specify options and their
- respective values:
- </para>
- <programlisting language="php"><![CDATA[
- $query = new Zend_Service_Amazon_Query('MY_API_KEY', 'US', 'AMAZON_SECRET_KEY');
- $query->Category('Books')->Keywords('PHP');
- $results = $query->search();
- foreach ($results as $result) {
- echo $result->Title . '<br />';
- }
- ]]></programlisting>
- <para>
- This sets the option <code>Category</code> to "Books" and <code>Keywords</code> to "PHP".
- </para>
- <para>
- For more information on the available options, please refer to the
- <ulink
- url="http://www.amazon.com/gp/aws/sdk/main.html/102-9041115-9057709?s=AWSEcommerceService&v=2005-10-05&p=ApiReference/ItemSearchOperation">relevant Amazon documentation</ulink>.
- </para>
- </example>
- </sect3>
- </sect2>
- <sect2 id="zend.service.amazon.classes">
- <title>Zend_Service_Amazon Classes</title>
- <para>
- The following classes are all returned by
- <link linkend="zend.service.amazon.itemlookup"><methodname>Zend_Service_Amazon::itemLookup()</methodname></link>
- and
- <link linkend="zend.service.amazon.itemsearch"><methodname>Zend_Service_Amazon::itemSearch()</methodname></link>:
- <itemizedlist>
- <listitem><para><link linkend="zend.service.amazon.classes.item"><classname>Zend_Service_Amazon_Item</classname></link></para></listitem>
- <listitem><para><link linkend="zend.service.amazon.classes.image"><classname>Zend_Service_Amazon_Image</classname></link></para></listitem>
- <listitem><para><link linkend="zend.service.amazon.classes.resultset"><classname>Zend_Service_Amazon_ResultSet</classname></link></para></listitem>
- <listitem><para><link linkend="zend.service.amazon.classes.offerset"><classname>Zend_Service_Amazon_OfferSet</classname></link></para></listitem>
- <listitem><para><link linkend="zend.service.amazon.classes.offer"><classname>Zend_Service_Amazon_Offer</classname></link></para></listitem>
- <listitem><para><link linkend="zend.service.amazon.classes.similarproduct"><classname>Zend_Service_Amazon_SimilarProduct</classname></link></para></listitem>
- <listitem><para><link linkend="zend.service.amazon.classes.accessories"><classname>Zend_Service_Amazon_Accessories</classname></link></para></listitem>
- <listitem><para><link linkend="zend.service.amazon.classes.customerreview"><classname>Zend_Service_Amazon_CustomerReview</classname></link></para></listitem>
- <listitem><para><link linkend="zend.service.amazon.classes.editorialreview"><classname>Zend_Service_Amazon_EditorialReview</classname></link></para></listitem>
- <listitem><para><link linkend="zend.service.amazon.classes.listmania"><classname>Zend_Service_Amazon_ListMania</classname></link></para></listitem>
- </itemizedlist>
- </para>
- <sect3 id="zend.service.amazon.classes.item">
- <title>Zend_Service_Amazon_Item</title>
- <para>
- <classname>Zend_Service_Amazon_Item</classname> is the class type used to represent an Amazon item returned by the
- web service. It encompasses all of the items attributes, including title, description, reviews, etc.
- </para>
- <sect4 id="zend.service.amazon.classes.item.asxml">
- <title>Zend_Service_Amazon_Item::asXML()</title>
- <para>
- <methodsynopsis>
- <type>string</type>
- <methodname>asXML</methodname>
- <void />
- </methodsynopsis>
- </para>
- <para>Return the original <acronym>XML</acronym> for the item</para>
- </sect4>
- <sect4 id="zend.service.amazon.classes.item.properties">
- <title>Properties</title>
- <para>
- <classname>Zend_Service_Amazon_Item</classname> has a number of properties directly related to their standard
- Amazon <acronym>API</acronym> counterparts.
- </para>
- <table id="zend.service.amazon.classes.item.properties.table-1">
- <title>Zend_Service_Amazon_Item Properties</title>
- <tgroup cols="3">
- <thead>
- <row>
- <entry>Name</entry>
- <entry>Type</entry>
- <entry>Description</entry>
- </row>
- </thead>
- <tbody>
- <row>
- <entry><acronym>ASIN</acronym></entry>
- <entry>string</entry>
- <entry>Amazon Item ID</entry>
- </row>
- <row>
- <entry>DetailPageURL</entry>
- <entry>string</entry>
- <entry>URL to the Items Details Page</entry>
- </row>
- <row>
- <entry>SalesRank</entry>
- <entry>int</entry>
- <entry>Sales Rank for the Item</entry>
- </row>
- <row>
- <entry>SmallImage</entry>
- <entry>Zend_Service_Amazon_Image</entry>
- <entry>Small Image of the Item</entry>
- </row>
- <row>
- <entry>MediumImage</entry>
- <entry>Zend_Service_Amazon_Image</entry>
- <entry>Medium Image of the Item</entry>
- </row>
- <row>
- <entry>LargeImage</entry>
- <entry>Zend_Service_Amazon_Image</entry>
- <entry>Large Image of the Item</entry>
- </row>
- <row>
- <entry>Subjects</entry>
- <entry>array</entry>
- <entry>Item Subjects</entry>
- </row>
- <row>
- <entry>Offers</entry>
- <entry>
- <code>
- <link
- linkend="zend.service.amazon.classes.offerset">Zend_Service_Amazon_OfferSet</link>
- </code>
- </entry>
- <entry>Offer Summary and Offers for the Item</entry>
- </row>
- <row>
- <entry>CustomerReviews</entry>
- <entry>array</entry>
- <entry>
- Customer reviews represented as an array of
- <code>
- <link
- linkend="zend.service.amazon.classes.customerreview">Zend_Service_Amazon_CustomerReview</link>
- </code>
- objects
- </entry>
- </row>
- <row>
- <entry>EditorialReviews</entry>
- <entry>array</entry>
- <entry>
- Editorial reviews represented as an array of
- <code>
- <link
- linkend="zend.service.amazon.classes.editorialreview">Zend_Service_Amazon_EditorialReview</link>
- </code>
- objects
- </entry>
- </row>
- <row>
- <entry>SimilarProducts</entry>
- <entry>array</entry>
- <entry>
- Similar Products represented as an array of
- <code>
- <link
- linkend="zend.service.amazon.classes.similarproduct">Zend_Service_Amazon_SimilarProduct</link>
- </code>
- objects
- </entry>
- </row>
- <row>
- <entry>Accessories</entry>
- <entry>array</entry>
- <entry>
- Accessories for the item represented as an array of
- <code>
- <link
- linkend="zend.service.amazon.classes.accessories">Zend_Service_Amazon_Accessories</link>
- </code>
- objects
- </entry>
- </row>
- <row>
- <entry>Tracks</entry>
- <entry>array</entry>
- <entry>An array of track numbers and names for Music CDs and <constant>DVD</constant>s</entry>
- </row>
- <row>
- <entry>ListmaniaLists</entry>
- <entry>array</entry>
- <entry>
- Item related Listmania Lists as an array of
- <code>
- <link
- linkend="zend.service.amazon.classes.listmania">Zend_Service_Amazon_ListmainList</link>
- </code>
- objects
- </entry>
- </row>
- <row>
- <entry>PromotionalTag</entry>
- <entry>string</entry>
- <entry>Item Promotional Tag</entry>
- </row>
- </tbody>
- </tgroup>
- </table>
- <para>
- <link linkend="zend.service.amazon.classes">Back to Class List</link>
- </para>
- </sect4>
- </sect3>
- <sect3 id="zend.service.amazon.classes.image">
- <title>Zend_Service_Amazon_Image</title>
- <para><classname>Zend_Service_Amazon_Image</classname> represents a remote Image for a product.</para>
- <sect4 id="zend.service.amazon.classes.image.properties">
- <title>Properties</title>
- <table id="zend.service.amazon.classes.image.properties.table-1">
- <title>Zend_Service_Amazon_Image Properties</title>
- <tgroup cols="3">
- <thead>
- <row>
- <entry>Name</entry>
- <entry>Type</entry>
- <entry>Description</entry>
- </row>
- </thead>
- <tbody>
- <row>
- <entry>Url</entry>
- <entry>Zend_Uri</entry>
- <entry>Remote <acronym>URL</acronym> for the Image</entry>
- </row>
- <row>
- <entry>Height</entry>
- <entry>int</entry>
- <entry>The Height of the image in pixels</entry>
- </row>
- <row>
- <entry>Width</entry>
- <entry>int</entry>
- <entry>The Width of the image in pixels</entry>
- </row>
- </tbody>
- </tgroup>
- </table>
- <para>
- <link linkend="zend.service.amazon.classes">Back to Class List</link>
- </para>
- </sect4>
- </sect3>
- <sect3 id="zend.service.amazon.classes.resultset">
- <title>Zend_Service_Amazon_ResultSet</title>
- <para>
- <classname>Zend_Service_Amazon_ResultSet</classname> objects are returned by
- <link linkend="zend.service.amazon.itemsearch">Zend_Service_Amazon::itemSearch()</link>
- and allow you to easily handle the multiple results returned.
- </para>
- <note>
- <title>SeekableIterator</title>
- <para>
- Implements the <code>SeekableIterator</code> for easy iteration (e.g. using <code>foreach</code>), as
- well as direct access to a specific result using <methodname>seek()</methodname>.
- </para>
- </note>
- <sect4 id="zend.service.amazon.classes.resultset.totalresults">
- <title>Zend_Service_Amazon_ResultSet::totalResults()</title>
- <methodsynopsis>
- <type>int</type>
- <methodname>totalResults</methodname>
- <void />
- </methodsynopsis>
- <para>Returns the total number of results returned by the search</para>
- <para>
- <link linkend="zend.service.amazon.classes">Back to Class List</link>
- </para>
- </sect4>
- </sect3>
- <sect3 id="zend.service.amazon.classes.offerset">
- <title>Zend_Service_Amazon_OfferSet</title>
- <para>
- Each result returned by
- <link linkend="zend.service.amazon.itemsearch">Zend_Service_Amazon::itemSearch()</link>
- and
- <link linkend="zend.service.amazon.itemlookup">Zend_Service_Amazon::itemLookup()</link>
- contains a
- <classname>Zend_Service_Amazon_OfferSet</classname>
- object through which pricing information for the item can be retrieved.
- </para>
- <sect4 id="zend.service.amazon.classes.offerset.parameters">
- <title>Properties</title>
- <table id="zend.service.amazon.classes.offerset.parameters.table-1">
- <title>Zend_Service_Amazon_OfferSet Properties</title>
- <tgroup cols="3">
- <thead>
- <row>
- <entry>Name</entry>
- <entry>Type</entry>
- <entry>Description</entry>
- </row>
- </thead>
- <tbody>
- <row>
- <entry>LowestNewPrice</entry>
- <entry>int</entry>
- <entry>Lowest Price for the item in "New" condition</entry>
- </row>
- <row>
- <entry>LowestNewPriceCurrency</entry>
- <entry>string</entry>
- <entry>
- The currency for the
- <code>LowestNewPrice</code>
- </entry>
- </row>
- <row>
- <entry>LowestOldPrice</entry>
- <entry>int</entry>
- <entry>Lowest Price for the item in "Used" condition</entry>
- </row>
- <row>
- <entry>LowestOldPriceCurrency</entry>
- <entry>string</entry>
- <entry>
- The currency for the
- <code>LowestOldPrice</code>
- </entry>
- </row>
- <row>
- <entry>TotalNew</entry>
- <entry>int</entry>
- <entry>Total number of "new" condition available for the item</entry>
- </row>
- <row>
- <entry>TotalUsed</entry>
- <entry>int</entry>
- <entry>Total number of "used" condition available for the item</entry>
- </row>
- <row>
- <entry>TotalCollectible</entry>
- <entry>int</entry>
- <entry>Total number of "collectible" condition available for the item</entry>
- </row>
- <row>
- <entry>TotalRefurbished</entry>
- <entry>int</entry>
- <entry>Total number of "refurbished" condition available for the item</entry>
- </row>
- <row>
- <entry>Offers</entry>
- <entry>array</entry>
- <entry>
- An array of
- <classname>Zend_Service_Amazon_Offer</classname>
- objects.
- </entry>
- </row>
- </tbody>
- </tgroup>
- </table>
- <para>
- <link linkend="zend.service.amazon.classes">Back to Class List</link>
- </para>
- </sect4>
- </sect3>
- <sect3 id="zend.service.amazon.classes.offer">
- <title>Zend_Service_Amazon_Offer</title>
- <para>
- Each offer for an item is returned as an
- <classname>Zend_Service_Amazon_Offer</classname>
- object.
- </para>
- <sect4 id="zend.service.amazon.classes.offer.properties">
- <title>Zend_Service_Amazon_Offer Properties</title>
- <table id="zend.service.amazon.classes.offer.properties.table-1">
- <title>Properties</title>
- <tgroup cols="3">
- <thead>
- <row>
- <entry>Name</entry>
- <entry>Type</entry>
- <entry>Description</entry>
- </row>
- </thead>
- <tbody>
- <row>
- <entry>MerchantId</entry>
- <entry>string</entry>
- <entry>Merchants Amazon ID</entry>
- </row>
- <row>
- <entry>GlancePage</entry>
- <entry>string</entry>
- <entry>URL for a page with a summary of the Merchant</entry>
- </row>
- <row>
- <entry>Condition</entry>
- <entry>string</entry>
- <entry>Condition of the item</entry>
- </row>
- <row>
- <entry>OfferListingId</entry>
- <entry>string</entry>
- <entry>ID of the Offer Listing</entry>
- </row>
- <row>
- <entry>Price</entry>
- <entry>int</entry>
- <entry>Price for the item</entry>
- </row>
- <row>
- <entry>CurrencyCode</entry>
- <entry>string</entry>
- <entry>Currency Code for the price of the item</entry>
- </row>
- <row>
- <entry>Availability</entry>
- <entry>string</entry>
- <entry>Availability of the item</entry>
- </row>
- <row>
- <entry>IsEligibleForSuperSaverShipping</entry>
- <entry>boolean</entry>
- <entry>Whether the item is eligible for Super Saver Shipping or not</entry>
- </row>
- </tbody>
- </tgroup>
- </table>
- <para>
- <link linkend="zend.service.amazon.classes">Back to Class List</link>
- </para>
- </sect4>
- </sect3>
- <sect3 id="zend.service.amazon.classes.similarproduct">
- <title>Zend_Service_Amazon_SimilarProduct</title>
- <para>
- When searching for items, Amazon also returns a list of similar products that the searcher may find to
- their liking. Each of these is returned as a <classname>Zend_Service_Amazon_SimilarProduct</classname> object.
- </para>
- <para>
- Each object contains the information to allow you to make sub-sequent requests to get the full information
- on the item.
- </para>
- <sect4 id="zend.service.amazon.classes.similarproduct.properties">
- <title>Properties</title>
- <table id="zend.service.amazon.classes.similarproduct.properties.table-1">
- <title>Zend_Service_Amazon_SimilarProduct Properties</title>
- <tgroup cols="3">
- <thead>
- <row>
- <entry>Name</entry>
- <entry>Type</entry>
- <entry>Description</entry>
- </row>
- </thead>
- <tbody>
- <row>
- <entry><acronym>ASIN</acronym></entry>
- <entry>string</entry>
- <entry>Products Amazon Unique ID (ASIN)</entry>
- </row>
- <row>
- <entry>Title</entry>
- <entry>string</entry>
- <entry>Products Title</entry>
- </row>
- </tbody>
- </tgroup>
- </table>
- <para>
- <link linkend="zend.service.amazon.classes">Back to Class List</link>
- </para>
- </sect4>
- </sect3>
- <sect3 id="zend.service.amazon.classes.accessories">
- <title>Zend_Service_Amazon_Accessories</title>
- <para>
- Accessories for the returned item are represented as <classname>Zend_Service_Amazon_Accessories</classname> objects
- </para>
- <sect4 id="zend.service.amazon.classes.accessories.properties">
- <title>Properties</title>
- <table id="zend.service.amazon.classes.accessories.properties.table-1">
- <title>Zend_Service_Amazon_Accessories Properties</title>
- <tgroup cols="3">
- <thead>
- <row>
- <entry>Name</entry>
- <entry>Type</entry>
- <entry>Description</entry>
- </row>
- </thead>
- <tbody>
- <row>
- <entry><acronym>ASIN</acronym></entry>
- <entry>string</entry>
- <entry>Products Amazon Unique ID (ASIN)</entry>
- </row>
- <row>
- <entry>Title</entry>
- <entry>string</entry>
- <entry>Products Title</entry>
- </row>
- </tbody>
- </tgroup>
- </table>
- <para>
- <link linkend="zend.service.amazon.classes">Back to Class List</link>
- </para>
- </sect4>
- </sect3>
- <sect3 id="zend.service.amazon.classes.customerreview">
- <title>Zend_Service_Amazon_CustomerReview</title>
- <para>
- Each Customer Review is returned as a <classname>Zend_Service_Amazon_CustomerReview</classname> object.
- </para>
- <sect4 id="zend.service.amazon.classes.customerreview.properties">
- <title>Properties</title>
- <table id="zend.service.amazon.classes.customerreview.properties.table-1">
- <title>Zend_Service_Amazon_CustomerReview Properties</title>
- <tgroup cols="3">
- <thead>
- <row>
- <entry>Name</entry>
- <entry>Type</entry>
- <entry>Description</entry>
- </row>
- </thead>
- <tbody>
- <row>
- <entry>Rating</entry>
- <entry>string</entry>
- <entry>Item Rating</entry>
- </row>
- <row>
- <entry>HelpfulVotes</entry>
- <entry>string</entry>
- <entry>Votes on how helpful the review is</entry>
- </row>
- <row>
- <entry>CustomerId</entry>
- <entry>string</entry>
- <entry>Customer ID</entry>
- </row>
- <row>
- <entry>TotalVotes</entry>
- <entry>string</entry>
- <entry>Total Votes</entry>
- </row>
- <row>
- <entry>Date</entry>
- <entry>string</entry>
- <entry>Date of the Review</entry>
- </row>
- <row>
- <entry>Summary</entry>
- <entry>string</entry>
- <entry>Review Summary</entry>
- </row>
- <row>
- <entry>Content</entry>
- <entry>string</entry>
- <entry>Review Content</entry>
- </row>
- </tbody>
- </tgroup>
- </table>
- <para>
- <link linkend="zend.service.amazon.classes">Back to Class List</link>
- </para>
- </sect4>
- </sect3>
- <sect3 id="zend.service.amazon.classes.editorialreview">
- <title>Zend_Service_Amazon_EditorialReview</title>
- <para>
- Each items Editorial Reviews are returned as a <classname>Zend_Service_Amazon_EditorialReview</classname> object
- </para>
- <sect4 id="zend.service.amazon.classes.editorialreview.properties">
- <title>Properties</title>
- <table id="zend.service.amazon.classes.editorialreview.properties.table-1">
- <title>Zend_Service_Amazon_EditorialReview Properties</title>
- <tgroup cols="3">
- <thead>
- <row>
- <entry>Name</entry>
- <entry>Type</entry>
- <entry>Description</entry>
- </row>
- </thead>
- <tbody>
- <row>
- <entry>Source</entry>
- <entry>string</entry>
- <entry>Source of the Editorial Review</entry>
- </row>
- <row>
- <entry>Content</entry>
- <entry>string</entry>
- <entry>Review Content</entry>
- </row>
- </tbody>
- </tgroup>
- </table>
- <para>
- <link linkend="zend.service.amazon.classes">Back to Class List</link>
- </para>
- </sect4>
- </sect3>
- <sect3 id="zend.service.amazon.classes.listmania">
- <title>Zend_Service_Amazon_Listmania</title>
- <para>
- Each results List Mania List items are returned as <classname>Zend_Service_Amazon_Listmania</classname> objects.
- </para>
- <sect4 id="zend.service.amazon.classes.listmania.properties">
- <title>Properties</title>
- <table id="zend.service.amazon.classes.listmania.properties.table-1">
- <title>Zend_Service_Amazon_Listmania Properties</title>
- <tgroup cols="3">
- <thead>
- <row>
- <entry>Name</entry>
- <entry>Type</entry>
- <entry>Description</entry>
- </row>
- </thead>
- <tbody>
- <row>
- <entry>ListId</entry>
- <entry>string</entry>
- <entry>List ID</entry>
- </row>
- <row>
- <entry>ListName</entry>
- <entry>string</entry>
- <entry>List Name</entry>
- </row>
- </tbody>
- </tgroup>
- </table>
- <para>
- <link linkend="zend.service.amazon.classes">Back to Class List</link>
- </para>
- </sect4>
- </sect3>
- </sect2>
- </sect1>
- <!--
- vim:se ts=4 sw=4 et:
- -->
|