Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / b4169b5fff9e64688e4e3f4254624fbdcd00b25d / . / docs / dyn / customsearch.v1.cse.html
blob: fcada8665554aa4e59a1e734798cd688544ff591 [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
Joe Gregorioad258e22011-02-22 22:53:30 -0500[diff] [blame]17<dl><dt><a name="Resource-list"><strong>list</strong></a> = method(self, **kwargs)</dt><dd><tt>Returns&nbsp;metadata&nbsp;about&nbsp;the&nbsp;search&nbsp;performed,&nbsp;metadata&nbsp;about&nbsp;the&nbsp;custom&nbsp;search&nbsp;engine&nbsp;used&nbsp;for&nbsp;the&nbsp;search,&nbsp;and&nbsp;the&nbsp;search&nbsp;results.<br>
Joe Gregorioafc45f22011-02-20 16:11:28 -0500[diff] [blame]18&nbsp;<br>
19Args:<br>
Joe Gregorioad258e22011-02-22 22:53:30 -0500[diff] [blame]20&nbsp;&nbsp;sort:&nbsp;string,&nbsp;The&nbsp;sort&nbsp;expression&nbsp;to&nbsp;apply&nbsp;to&nbsp;the&nbsp;results<br>
Joe Gregorio02503852011-08-31 09:07:55 -0400[diff] [blame]21&nbsp;&nbsp;filter:&nbsp;string,&nbsp;Controls&nbsp;turning&nbsp;on&nbsp;or&nbsp;off&nbsp;the&nbsp;duplicate&nbsp;content&nbsp;filter.<br>
22&nbsp;&nbsp;&nbsp;&nbsp;Allowed&nbsp;values<br>
23&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;0&nbsp;-&nbsp;Turns&nbsp;off&nbsp;duplicate&nbsp;content&nbsp;filter.<br>
24&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;1&nbsp;-&nbsp;Turns&nbsp;on&nbsp;duplicate&nbsp;content&nbsp;filter.<br>
Joe Gregorio20a5aa92011-04-01 17:44:25 -0400[diff] [blame]25&nbsp;&nbsp;start:&nbsp;string,&nbsp;The&nbsp;index&nbsp;of&nbsp;the&nbsp;first&nbsp;result&nbsp;to&nbsp;return<br>
Joe Gregorio02503852011-08-31 09:07:55 -0400[diff] [blame]26&nbsp;&nbsp;cx:&nbsp;string,&nbsp;The&nbsp;custom&nbsp;search&nbsp;engine&nbsp;ID&nbsp;to&nbsp;scope&nbsp;this&nbsp;search&nbsp;query<br>
27&nbsp;&nbsp;googlehost:&nbsp;string,&nbsp;The&nbsp;local&nbsp;Google&nbsp;domain&nbsp;to&nbsp;use&nbsp;to&nbsp;perform&nbsp;the&nbsp;search.<br>
Joe Gregorioad258e22011-02-22 22:53:30 -0500[diff] [blame]28&nbsp;&nbsp;safe:&nbsp;string,&nbsp;Search&nbsp;safety&nbsp;level<br>
Joe Gregorio93841702011-03-02 16:12:05 -0800[diff] [blame]29&nbsp;&nbsp;&nbsp;&nbsp;Allowed&nbsp;values<br>
30&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;high&nbsp;-&nbsp;Enables&nbsp;highest&nbsp;level&nbsp;of&nbsp;safe&nbsp;search&nbsp;filtering.<br>
31&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;medium&nbsp;-&nbsp;Enables&nbsp;moderate&nbsp;safe&nbsp;search&nbsp;filtering.<br>
32&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;off&nbsp;-&nbsp;Disables&nbsp;safe&nbsp;search&nbsp;filtering.<br>
Joe Gregorioad258e22011-02-22 22:53:30 -0500[diff] [blame]33&nbsp;&nbsp;q:&nbsp;string,&nbsp;Query&nbsp;(required)<br>
Joe Gregorio02503852011-08-31 09:07:55 -0400[diff] [blame]34&nbsp;&nbsp;num:&nbsp;string,&nbsp;Number&nbsp;of&nbsp;search&nbsp;results&nbsp;to&nbsp;return<br>
Joe Gregorioad258e22011-02-22 22:53:30 -0500[diff] [blame]35&nbsp;&nbsp;lr:&nbsp;string,&nbsp;The&nbsp;language&nbsp;restriction&nbsp;for&nbsp;the&nbsp;search&nbsp;results<br>
Joe Gregorio93841702011-03-02 16:12:05 -0800[diff] [blame]36&nbsp;&nbsp;&nbsp;&nbsp;Allowed&nbsp;values<br>
37&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;lang_ar&nbsp;-&nbsp;Arabic<br>
38&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;lang_bg&nbsp;-&nbsp;Bulgarian<br>
39&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;lang_ca&nbsp;-&nbsp;Catalan<br>
40&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;lang_cs&nbsp;-&nbsp;Czech<br>
41&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;lang_da&nbsp;-&nbsp;Danish<br>
42&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;lang_de&nbsp;-&nbsp;German<br>
43&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;lang_el&nbsp;-&nbsp;Greek<br>
44&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;lang_en&nbsp;-&nbsp;English<br>
45&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;lang_es&nbsp;-&nbsp;Spanish<br>
46&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;lang_et&nbsp;-&nbsp;Estonian<br>
47&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;lang_fi&nbsp;-&nbsp;Finnish<br>
48&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;lang_fr&nbsp;-&nbsp;French<br>
49&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;lang_hr&nbsp;-&nbsp;Croatian<br>
50&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;lang_hu&nbsp;-&nbsp;Hungarian<br>
51&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;lang_id&nbsp;-&nbsp;Indonesian<br>
52&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;lang_is&nbsp;-&nbsp;Icelandic<br>
53&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;lang_it&nbsp;-&nbsp;Italian<br>
54&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;lang_iw&nbsp;-&nbsp;Hebrew<br>
55&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;lang_ja&nbsp;-&nbsp;Japanese<br>
56&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;lang_ko&nbsp;-&nbsp;Korean<br>
57&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;lang_lt&nbsp;-&nbsp;Lithuanian<br>
58&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;lang_lv&nbsp;-&nbsp;Latvian<br>
59&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;lang_nl&nbsp;-&nbsp;Dutch<br>
60&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;lang_no&nbsp;-&nbsp;Norwegian<br>
61&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;lang_pl&nbsp;-&nbsp;Polish<br>
62&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;lang_pt&nbsp;-&nbsp;Portuguese<br>
63&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;lang_ro&nbsp;-&nbsp;Romanian<br>
64&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;lang_ru&nbsp;-&nbsp;Russian<br>
65&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;lang_sk&nbsp;-&nbsp;Slovak<br>
66&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;lang_sl&nbsp;-&nbsp;Slovenian<br>
67&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;lang_sr&nbsp;-&nbsp;Serbian<br>
68&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;lang_sv&nbsp;-&nbsp;Swedish<br>
69&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;lang_tr&nbsp;-&nbsp;Turkish<br>
70&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;lang_zh-CN&nbsp;-&nbsp;Chinese&nbsp;(Simplified)<br>
71&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;lang_zh-TW&nbsp;-&nbsp;Chinese&nbsp;(Traditional)<br>
Joe Gregorio02503852011-08-31 09:07:55 -0400[diff] [blame]72&nbsp;&nbsp;cr:&nbsp;string,&nbsp;Country&nbsp;restrict(s).<br>
73&nbsp;&nbsp;gl:&nbsp;string,&nbsp;Geolocation&nbsp;of&nbsp;end&nbsp;user.<br>
Joe Gregoriob417caf2011-12-08 12:04:24 -0500[diff] [blame]74&nbsp;&nbsp;cref:&nbsp;string,&nbsp;The&nbsp;URL&nbsp;of&nbsp;a&nbsp;linked&nbsp;custom&nbsp;search&nbsp;engine<br>
75&nbsp;<br>
76Returns:<br>
77&nbsp;&nbsp;An&nbsp;object&nbsp;of&nbsp;the&nbsp;form<br>
78&nbsp;<br>
79&nbsp;&nbsp;&nbsp;&nbsp;{<br>
80&nbsp;&nbsp;&nbsp;&nbsp;"promotions":&nbsp;[<br>
81&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;{<br>
82&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"link":&nbsp;"A&nbsp;String",<br>
83&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"displayLink":&nbsp;"A&nbsp;String",<br>
84&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"image":&nbsp;{<br>
85&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"source":&nbsp;"A&nbsp;String",<br>
86&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"width":&nbsp;42,<br>
87&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"height":&nbsp;42,<br>
88&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;},<br>
89&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"bodyLines":&nbsp;[<br>
90&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;{<br>
91&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"url":&nbsp;"A&nbsp;String",<br>
92&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"link":&nbsp;"A&nbsp;String",<br>
93&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"title":&nbsp;"A&nbsp;String",<br>
94&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;},<br>
95&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;],<br>
96&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"title":&nbsp;"A&nbsp;String",<br>
97&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;},<br>
98&nbsp;&nbsp;&nbsp;&nbsp;],<br>
99&nbsp;&nbsp;&nbsp;&nbsp;"kind":&nbsp;"customsearch#search",<br>
100&nbsp;&nbsp;&nbsp;&nbsp;"url":&nbsp;{<br>
101&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"type":&nbsp;"application/json",<br>
102&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"template":&nbsp;"https://www.googleapis.com/customsearch/v1?q={searchTerms}&amp;num={count?}&amp;start={startIndex?}&amp;hr={language?}&amp;safe={safe?}&amp;cx={cx?}&amp;cref={cref?}&amp;sort={sort?}&amp;filter={filter?}&amp;gl={gl?}&amp;cr={cr?}&amp;googlehost={googleHost?}&amp;alt=json",<br>
103&nbsp;&nbsp;&nbsp;&nbsp;},<br>
104&nbsp;&nbsp;&nbsp;&nbsp;"items":&nbsp;[<br>
105&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;{<br>
106&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"kind":&nbsp;"customsearch#result",<br>
107&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"title":&nbsp;"A&nbsp;String",<br>
108&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"displayLink":&nbsp;"A&nbsp;String",<br>
109&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"cacheId":&nbsp;"A&nbsp;String",<br>
110&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"pagemap":&nbsp;{<br>
111&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;},<br>
112&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"snippet":&nbsp;"A&nbsp;String",<br>
113&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"htmlSnippet":&nbsp;"A&nbsp;String",<br>
114&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"link":&nbsp;"A&nbsp;String",<br>
115&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"htmlTitle":&nbsp;"A&nbsp;String",<br>
116&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;},<br>
117&nbsp;&nbsp;&nbsp;&nbsp;],<br>
118&nbsp;&nbsp;&nbsp;&nbsp;"context":&nbsp;{<br>
119&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"facets":&nbsp;[<br>
120&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[<br>
121&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;{<br>
122&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"anchor":&nbsp;"A&nbsp;String",<br>
123&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"label":&nbsp;"A&nbsp;String",<br>
124&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;},<br>
125&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;],<br>
126&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;],<br>
127&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"title":&nbsp;"A&nbsp;String",<br>
128&nbsp;&nbsp;&nbsp;&nbsp;},<br>
129&nbsp;&nbsp;&nbsp;&nbsp;"queries":&nbsp;{<br>
130&nbsp;&nbsp;&nbsp;&nbsp;},<br>
131&nbsp;&nbsp;}</tt></dd></dl>
Joe Gregorioafc45f22011-02-20 16:11:28 -0500[diff] [blame]132
133<hr>
134Data descriptors defined here:<br>
135<dl><dt><strong>__dict__</strong></dt>
136<dd><tt>dictionary&nbsp;for&nbsp;instance&nbsp;variables&nbsp;(if&nbsp;defined)</tt></dd>
137</dl>
138<dl><dt><strong>__weakref__</strong></dt>
139<dd><tt>list&nbsp;of&nbsp;weak&nbsp;references&nbsp;to&nbsp;the&nbsp;object&nbsp;(if&nbsp;defined)</tt></dd>
140</dl>
141</td></tr></table>
142</body></html>