Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / a84516743cd7751c0ded783bb9d10fb5e84f56a8 / . / docs / dyn / shopping.v1.products.html
blob: 4a540ed5280c585973d6e22cdaa8096d2f447423 [file] [log] [blame]
Joe Gregorioafc45f22011-02-20 16:11:28 -0500[diff] [blame]1
2<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
3<html><head><title>Python: class Resource</title>
4</head><body bgcolor="#f0f0f8">
5<p>
6<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
7<tr bgcolor="#ffc8d8">
8<td colspan=3 valign=bottom>&nbsp;<br>
9<font color="#000000" face="helvetica, arial"><a name="Resource">class <strong>Resource</strong></a>(<a href="__builtin__.html#object">__builtin__.object</a>)</font></td></tr>
10
11<tr bgcolor="#ffc8d8"><td rowspan=2><tt>&nbsp;&nbsp;&nbsp;</tt></td>
12<td colspan=2><tt>A&nbsp;class&nbsp;for&nbsp;interacting&nbsp;with&nbsp;a&nbsp;resource.<br>&nbsp;</tt></td></tr>
13<tr><td>&nbsp;</td>
14<td width="100%">Methods defined here:<br>
15<dl><dt><a name="Resource-__init__"><strong>__init__</strong></a>(self)</dt></dl>
16
17<dl><dt><a name="Resource-get"><strong>get</strong></a> = method(self, **kwargs)</dt><dd><tt>Returns&nbsp;a&nbsp;single&nbsp;product<br>
18&nbsp;<br>
19Args:<br>
Joe Gregorio20a5aa92011-04-01 17:44:25 -0400[diff] [blame]20&nbsp;&nbsp;debug_searchResponse:&nbsp;boolean,&nbsp;Google&nbsp;Internal<br>
Joe Gregorioad258e22011-02-22 22:53:30 -0500[diff] [blame]21&nbsp;&nbsp;taxonomy:&nbsp;string,&nbsp;Merchant&nbsp;taxonomy<br>
Joe Gregorio20a5aa92011-04-01 17:44:25 -0400[diff] [blame]22&nbsp;&nbsp;recommendations_useGcsConfig:&nbsp;boolean,&nbsp;This&nbsp;parameter&nbsp;is&nbsp;currently&nbsp;ignored<br>
Joe Gregorio351b1492011-05-08 23:32:46 -0700[diff] [blame]23&nbsp;&nbsp;productFields:&nbsp;string,&nbsp;Google&nbsp;Internal<br>
Joe Gregoriob9e63ff2011-06-30 12:38:10 -0400[diff] [blame]24&nbsp;&nbsp;accountId:&nbsp;integer,&nbsp;Merchant&nbsp;center&nbsp;account&nbsp;id&nbsp;(required)<br>
Joe Gregorio20a5aa92011-04-01 17:44:25 -0400[diff] [blame]25&nbsp;&nbsp;source:&nbsp;string,&nbsp;Query&nbsp;source&nbsp;(required)<br>
Joe Gregorioad258e22011-02-22 22:53:30 -0500[diff] [blame]26&nbsp;&nbsp;recommendations_include:&nbsp;string,&nbsp;Recommendation&nbsp;specification<br>
Joe Gregorio20a5aa92011-04-01 17:44:25 -0400[diff] [blame]27&nbsp;&nbsp;debug_enabled:&nbsp;boolean,&nbsp;Google&nbsp;Internal<br>
Joe Gregorioa8451672011-09-15 09:53:21 -0400[diff] [blame^]28&nbsp;&nbsp;location:&nbsp;string,&nbsp;Location&nbsp;used&nbsp;to&nbsp;determine&nbsp;tax&nbsp;and&nbsp;shipping<br>
Joe Gregorio20a5aa92011-04-01 17:44:25 -0400[diff] [blame]29&nbsp;&nbsp;debug_searchRequest:&nbsp;boolean,&nbsp;Google&nbsp;Internal<br>
30&nbsp;&nbsp;productId:&nbsp;string,&nbsp;Id&nbsp;of&nbsp;product&nbsp;(required)<br>
31&nbsp;&nbsp;productIdType:&nbsp;string,&nbsp;Type&nbsp;of&nbsp;productId&nbsp;(required)<br>
Joe Gregorioad258e22011-02-22 22:53:30 -0500[diff] [blame]32&nbsp;&nbsp;debug_enableLogging:&nbsp;boolean,&nbsp;Google&nbsp;Internal<br>
33&nbsp;&nbsp;recommendations_enabled:&nbsp;boolean,&nbsp;Whether&nbsp;to&nbsp;return&nbsp;recommendation&nbsp;information<br>
Joe Gregorioad258e22011-02-22 22:53:30 -0500[diff] [blame]34&nbsp;&nbsp;categories_enabled:&nbsp;boolean,&nbsp;Whether&nbsp;to&nbsp;return&nbsp;category&nbsp;information<br>
Joe Gregorio351b1492011-05-08 23:32:46 -0700[diff] [blame]35&nbsp;&nbsp;attributeFilter:&nbsp;string,&nbsp;Comma&nbsp;separated&nbsp;list&nbsp;of&nbsp;attributes&nbsp;to&nbsp;return<br>
Joe Gregorioad258e22011-02-22 22:53:30 -0500[diff] [blame]36&nbsp;&nbsp;categories_useGcsConfig:&nbsp;boolean,&nbsp;This&nbsp;parameter&nbsp;is&nbsp;currently&nbsp;ignored<br>
Joe Gregorio20a5aa92011-04-01 17:44:25 -0400[diff] [blame]37&nbsp;&nbsp;thumbnails:&nbsp;string,&nbsp;Thumbnail&nbsp;specification<br>
38&nbsp;&nbsp;categories_include:&nbsp;string,&nbsp;Category&nbsp;specification</tt></dd></dl>
Joe Gregorioafc45f22011-02-20 16:11:28 -0500[diff] [blame]39
40<dl><dt><a name="Resource-list"><strong>list</strong></a> = method(self, **kwargs)</dt><dd><tt>Returns&nbsp;a&nbsp;list&nbsp;of&nbsp;products&nbsp;and&nbsp;content&nbsp;modules<br>
41&nbsp;<br>
42Args:<br>
Joe Gregorioad258e22011-02-22 22:53:30 -0500[diff] [blame]43&nbsp;&nbsp;facets_enabled:&nbsp;boolean,&nbsp;Whether&nbsp;to&nbsp;return&nbsp;facet&nbsp;information<br>
Joe Gregorio4258d6b2011-03-18 10:20:16 -0400[diff] [blame]44&nbsp;&nbsp;debug_geocodeRequest:&nbsp;boolean,&nbsp;Google&nbsp;Internal<br>
Joe Gregorioad258e22011-02-22 22:53:30 -0500[diff] [blame]45&nbsp;&nbsp;debug_searchResponse:&nbsp;boolean,&nbsp;Google&nbsp;Internal<br>
Joe Gregorio4258d6b2011-03-18 10:20:16 -0400[diff] [blame]46&nbsp;&nbsp;debug_rdcRequest:&nbsp;boolean,&nbsp;Google&nbsp;Internal<br>
Joe Gregorioad258e22011-02-22 22:53:30 -0500[diff] [blame]47&nbsp;&nbsp;taxonomy:&nbsp;string,&nbsp;Taxonomy&nbsp;name<br>
48&nbsp;&nbsp;promotions_enabled:&nbsp;boolean,&nbsp;Whether&nbsp;to&nbsp;return&nbsp;promotion&nbsp;information<br>
Joe Gregoriob9e63ff2011-06-30 12:38:10 -0400[diff] [blame]49&nbsp;&nbsp;shelfSpaceAds_enabled:&nbsp;boolean,&nbsp;Whether&nbsp;to&nbsp;return&nbsp;shelf&nbsp;space&nbsp;ads<br>
Joe Gregorio93841702011-03-02 16:12:05 -0800[diff] [blame]50&nbsp;&nbsp;debug_rdcResponse:&nbsp;boolean,&nbsp;Google&nbsp;Internal<br>
Joe Gregorio351b1492011-05-08 23:32:46 -0700[diff] [blame]51&nbsp;&nbsp;productFields:&nbsp;string,&nbsp;Google&nbsp;Internal<br>
52&nbsp;&nbsp;channels:&nbsp;string,&nbsp;Channels&nbsp;specification<br>
Joe Gregorioad258e22011-02-22 22:53:30 -0500[diff] [blame]53&nbsp;&nbsp;facets_discover:&nbsp;string,&nbsp;Facets&nbsp;to&nbsp;discover<br>
54&nbsp;&nbsp;startIndex:&nbsp;integer,&nbsp;Index&nbsp;(1-based)&nbsp;of&nbsp;first&nbsp;product&nbsp;to&nbsp;return<br>
Joe Gregoriob9e63ff2011-06-30 12:38:10 -0400[diff] [blame]55&nbsp;&nbsp;attributeFilter:&nbsp;string,&nbsp;Comma&nbsp;separated&nbsp;list&nbsp;of&nbsp;attributes&nbsp;to&nbsp;return<br>
Joe Gregorioad258e22011-02-22 22:53:30 -0500[diff] [blame]56&nbsp;&nbsp;crowdBy:&nbsp;string,&nbsp;Crowding&nbsp;specification<br>
57&nbsp;&nbsp;spelling_enabled:&nbsp;boolean,&nbsp;Whether&nbsp;to&nbsp;return&nbsp;spelling&nbsp;suggestions<br>
58&nbsp;&nbsp;debug_enabled:&nbsp;boolean,&nbsp;Google&nbsp;Internal<br>
59&nbsp;&nbsp;spelling_useGcsConfig:&nbsp;boolean,&nbsp;This&nbsp;parameter&nbsp;is&nbsp;currently&nbsp;ignored<br>
60&nbsp;&nbsp;source:&nbsp;string,&nbsp;Query&nbsp;source&nbsp;(required)<br>
Joe Gregorio351b1492011-05-08 23:32:46 -0700[diff] [blame]61&nbsp;&nbsp;useCase:&nbsp;string,&nbsp;One&nbsp;of&nbsp;CommerceSearchUseCase,&nbsp;ShoppingApiUseCase<br>
Joe Gregorio4258d6b2011-03-18 10:20:16 -0400[diff] [blame]62&nbsp;&nbsp;debug_geocodeResponse:&nbsp;boolean,&nbsp;Google&nbsp;Internal<br>
Joe Gregorioa8451672011-09-15 09:53:21 -0400[diff] [blame^]63&nbsp;&nbsp;location:&nbsp;string,&nbsp;Location&nbsp;used&nbsp;to&nbsp;determine&nbsp;tax&nbsp;and&nbsp;shipping<br>
Joe Gregorio4258d6b2011-03-18 10:20:16 -0400[diff] [blame]64&nbsp;&nbsp;categories_include:&nbsp;string,&nbsp;Category&nbsp;specification<br>
Joe Gregorioad258e22011-02-22 22:53:30 -0500[diff] [blame]65&nbsp;&nbsp;debug_searchRequest:&nbsp;boolean,&nbsp;Google&nbsp;Internal<br>
Joe Gregorio4258d6b2011-03-18 10:20:16 -0400[diff] [blame]66&nbsp;&nbsp;relatedQueries_enabled:&nbsp;boolean,&nbsp;Whether&nbsp;to&nbsp;return&nbsp;related&nbsp;queries<br>
Joe Gregorioad258e22011-02-22 22:53:30 -0500[diff] [blame]67&nbsp;&nbsp;facets_useGcsConfig:&nbsp;boolean,&nbsp;Whether&nbsp;to&nbsp;return&nbsp;facet&nbsp;information&nbsp;as&nbsp;configured&nbsp;in&nbsp;the&nbsp;GCS&nbsp;account<br>
Joe Gregorio49396552011-03-08 10:39:00 -0500[diff] [blame]68&nbsp;&nbsp;safe:&nbsp;boolean,&nbsp;Whether&nbsp;safe&nbsp;search&nbsp;is&nbsp;enabled.&nbsp;Default:&nbsp;true<br>
Joe Gregorio4258d6b2011-03-18 10:20:16 -0400[diff] [blame]69&nbsp;&nbsp;boostBy:&nbsp;string,&nbsp;Boosting&nbsp;specification<br>
70&nbsp;&nbsp;debug_enableLogging:&nbsp;boolean,&nbsp;Google&nbsp;Internal<br>
Joe Gregorioad258e22011-02-22 22:53:30 -0500[diff] [blame]71&nbsp;&nbsp;maxResults:&nbsp;integer,&nbsp;Maximum&nbsp;number&nbsp;of&nbsp;results&nbsp;to&nbsp;return<br>
72&nbsp;&nbsp;categories_enabled:&nbsp;boolean,&nbsp;Whether&nbsp;to&nbsp;return&nbsp;category&nbsp;information<br>
Joe Gregoriob9e63ff2011-06-30 12:38:10 -0400[diff] [blame]73&nbsp;&nbsp;shelfSpaceAds_useGcsConfig:&nbsp;boolean,&nbsp;This&nbsp;parameter&nbsp;is&nbsp;currently&nbsp;ignored<br>
74&nbsp;&nbsp;shelfSpaceAds_maxResults:&nbsp;integer,&nbsp;The&nbsp;maximum&nbsp;number&nbsp;of&nbsp;shelf&nbsp;space&nbsp;ads&nbsp;to&nbsp;return<br>
Joe Gregorioad258e22011-02-22 22:53:30 -0500[diff] [blame]75&nbsp;&nbsp;categories_useGcsConfig:&nbsp;boolean,&nbsp;This&nbsp;parameter&nbsp;is&nbsp;currently&nbsp;ignored<br>
Joe Gregorio351b1492011-05-08 23:32:46 -0700[diff] [blame]76&nbsp;&nbsp;promotions_useGcsConfig:&nbsp;boolean,&nbsp;Whether&nbsp;to&nbsp;return&nbsp;promotion&nbsp;information&nbsp;as&nbsp;configured&nbsp;in&nbsp;the&nbsp;GCS&nbsp;account<br>
Joe Gregorioad258e22011-02-22 22:53:30 -0500[diff] [blame]77&nbsp;&nbsp;facets_include:&nbsp;string,&nbsp;Facets&nbsp;to&nbsp;include&nbsp;(applies&nbsp;when&nbsp;useGcsConfig&nbsp;==&nbsp;false)<br>
78&nbsp;&nbsp;thumbnails:&nbsp;string,&nbsp;Image&nbsp;thumbnails&nbsp;specification<br>
79&nbsp;&nbsp;language:&nbsp;string,&nbsp;Language&nbsp;restriction&nbsp;(BCP&nbsp;47)<br>
80&nbsp;&nbsp;currency:&nbsp;string,&nbsp;Currency&nbsp;restriction&nbsp;(ISO&nbsp;4217)<br>
Joe Gregorio20a5aa92011-04-01 17:44:25 -0400[diff] [blame]81&nbsp;&nbsp;sayt_enabled:&nbsp;boolean,&nbsp;Google&nbsp;Internal<br>
Joe Gregorio4258d6b2011-03-18 10:20:16 -0400[diff] [blame]82&nbsp;&nbsp;rankBy:&nbsp;string,&nbsp;Ranking&nbsp;specification<br>
Joe Gregorioad258e22011-02-22 22:53:30 -0500[diff] [blame]83&nbsp;&nbsp;redirects_enabled:&nbsp;boolean,&nbsp;Whether&nbsp;to&nbsp;return&nbsp;redirect&nbsp;information<br>
84&nbsp;&nbsp;restrictBy:&nbsp;string,&nbsp;Restriction&nbsp;specification<br>
85&nbsp;&nbsp;q:&nbsp;string,&nbsp;Search&nbsp;query<br>
Joe Gregorio20a5aa92011-04-01 17:44:25 -0400[diff] [blame]86&nbsp;&nbsp;redirects_useGcsConfig:&nbsp;boolean,&nbsp;Whether&nbsp;to&nbsp;return&nbsp;redirect&nbsp;information&nbsp;as&nbsp;configured&nbsp;in&nbsp;the&nbsp;GCS&nbsp;account<br>
Joe Gregorio4258d6b2011-03-18 10:20:16 -0400[diff] [blame]87&nbsp;&nbsp;sayt_useGcsConfig:&nbsp;boolean,&nbsp;Google&nbsp;Internal<br>
Joe Gregorio20a5aa92011-04-01 17:44:25 -0400[diff] [blame]88&nbsp;&nbsp;country:&nbsp;string,&nbsp;Country&nbsp;restriction&nbsp;(ISO&nbsp;3166)<br>
Joe Gregorio4258d6b2011-03-18 10:20:16 -0400[diff] [blame]89&nbsp;&nbsp;relatedQueries_useGcsConfig:&nbsp;boolean,&nbsp;This&nbsp;parameter&nbsp;is&nbsp;currently&nbsp;ignored<br>
Joe Gregorio351b1492011-05-08 23:32:46 -0700[diff] [blame]90&nbsp;&nbsp;minAvailability:&nbsp;string,&nbsp;A&nbsp;parameter<br>
91&nbsp;&nbsp;&nbsp;&nbsp;Allowed&nbsp;values<br>
92&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;inStock&nbsp;-&nbsp;Only&nbsp;in&nbsp;stcok&nbsp;prodicts&nbsp;will&nbsp;be&nbsp;returned<br>
93&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;limited&nbsp;-&nbsp;Limited&nbsp;availability&nbsp;and&nbsp;in&nbsp;stock&nbsp;products&nbsp;will&nbsp;be&nbsp;returned<br>
94&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;outOfStock&nbsp;-&nbsp;Out&nbsp;of&nbsp;stock,&nbsp;limited&nbsp;availability&nbsp;and&nbsp;in&nbsp;stock&nbsp;products&nbsp;will&nbsp;be&nbsp;returned<br>
95&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;unknown&nbsp;-&nbsp;All&nbsp;products&nbsp;will&nbsp;be&nbsp;returned</tt></dd></dl>
Joe Gregorioafc45f22011-02-20 16:11:28 -0500[diff] [blame]96
97<hr>
98Data descriptors defined here:<br>
99<dl><dt><strong>__dict__</strong></dt>
100<dd><tt>dictionary&nbsp;for&nbsp;instance&nbsp;variables&nbsp;(if&nbsp;defined)</tt></dd>
101</dl>
102<dl><dt><strong>__weakref__</strong></dt>
103<dd><tt>list&nbsp;of&nbsp;weak&nbsp;references&nbsp;to&nbsp;the&nbsp;object&nbsp;(if&nbsp;defined)</tt></dd>
104</dl>
105</td></tr></table>
106</body></html>