Blame - docs/dyn/customsearch_v1.cse.html - platform/external/python/google-api-python-client

2014-04-24 15:46:26 -0400

[diff] [blame]

88

<h3>Method Details</h3>

89

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

90

<code class="details" id="close">close()</code>

91

<pre>Close httplib2 connections.</pre>

</div>

<code class="details" id="list">list(num=None, c2coff=None, highRange=None, exactTerms=None, imgType=None, googlehost=None, lr=None, q=None, hl=None, fileType=None, siteSearch=None, orTerms=None, imgSize=None, excludeTerms=None, safe=None, gl=None, imgDominantColor=None, searchType=None, relatedSite=None, filter=None, linkSite=None, siteSearchFilter=None, rights=None, imgColorType=None, dateRestrict=None, start=None, sort=None, lowRange=None, cr=None, cx=None, hq=None, x__xgafv=None)</code>

96

<pre>Returns metadata about the search performed, metadata about the engine used for the search, and the search results.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

97

98

Args:

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

99

num: integer, Number of search results to return. * Valid values are integers between 1 and 10, inclusive.

100

c2coff: string, Enables or disables [Simplified and Traditional Chinese Search](https://developers.google.com/custom-search/docs/xml_results#chineseSearch). The default value for this parameter is 0 (zero), meaning that the feature is enabled. Supported values are: * `1`: Disabled * `0`: Enabled (default)

101

highRange: string, Specifies the ending value for a search range. * Use `lowRange` and `highRange` to append an inclusive search range of `lowRange...highRange` to the query.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

102

exactTerms: string, Identifies a phrase that all documents in the search results must contain.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

103

imgType: string, Returns images of a type. Acceptable values are: * `"clipart"` * `"face"` * `"lineart"` * `"stock"` * `"photo"` * `"animated"`

104

Allowed values

105

imgTypeUndefined - No image type specified.

106

clipart - Clipart-style images only.

107

face - Images of faces only.

108

lineart - Line art images only.

109

stock - Stock images only.

110

photo - Photo images only.

111

animated - Animated images only.

112

googlehost: string, **Deprecated**. Use the `gl` parameter for a similar effect. The local Google domain (for example, google.com, google.de, or google.fr) to use to perform the search.

113

lr: string, Restricts the search to documents written in a particular language (e.g., `lr=lang_ja`). Acceptable values are: * `"lang_ar"`: Arabic * `"lang_bg"`: Bulgarian * `"lang_ca"`: Catalan * `"lang_cs"`: Czech * `"lang_da"`: Danish * `"lang_de"`: German * `"lang_el"`: Greek * `"lang_en"`: English * `"lang_es"`: Spanish * `"lang_et"`: Estonian * `"lang_fi"`: Finnish * `"lang_fr"`: French * `"lang_hr"`: Croatian * `"lang_hu"`: Hungarian * `"lang_id"`: Indonesian * `"lang_is"`: Icelandic * `"lang_it"`: Italian * `"lang_iw"`: Hebrew * `"lang_ja"`: Japanese * `"lang_ko"`: Korean * `"lang_lt"`: Lithuanian * `"lang_lv"`: Latvian * `"lang_nl"`: Dutch * `"lang_no"`: Norwegian * `"lang_pl"`: Polish * `"lang_pt"`: Portuguese * `"lang_ro"`: Romanian * `"lang_ru"`: Russian * `"lang_sk"`: Slovak * `"lang_sl"`: Slovenian * `"lang_sr"`: Serbian * `"lang_sv"`: Swedish * `"lang_tr"`: Turkish * `"lang_zh-CN"`: Chinese (Simplified) * `"lang_zh-TW"`: Chinese (Traditional)

114

q: string, Query

115

hl: string, Sets the user interface language. * Explicitly setting this parameter improves the performance and the quality of your search results. * See the [Interface Languages](https://developers.google.com/custom-search/docs/xml_results#wsInterfaceLanguages) section of [Internationalizing Queries and Results Presentation](https://developers.google.com/custom-search/docs/xml_results#wsInternationalizing) for more information, and (Supported Interface Languages)[https://developers.google.com/custom-search/docs/xml_results_appendices#interfaceLanguages] for a list of supported languages.

116

fileType: string, Restricts results to files of a specified extension. A list of file types indexable by Google can be found in Search Console [Help Center](https://support.google.com/webmasters/answer/35287).

117

siteSearch: string, Specifies a given site which should always be included or excluded from results (see `siteSearchFilter` parameter, below).

118

orTerms: string, Provides additional search terms to check for in a document, where each document in the search results must contain at least one of the additional search terms.

119

imgSize: string, Returns images of a specified size. Acceptable values are: * `"huge"` * `"icon"` * `"large"` * `"medium"` * `"small"` * `"xlarge"` * `"xxlarge"`

120

Allowed values

121

imgSizeUndefined - No image size specified.

122

HUGE - Only the largest possible images.

123

ICON - Only very small icon-sized images.

124

LARGE - Only large images.

125

MEDIUM - Only medium images.

126

SMALL - Only small images.

127

XLARGE - Only very large images.

128

XXLARGE - Only extremely large images.

129

excludeTerms: string, Identifies a word or phrase that should not appear in any documents in the search results.

130

safe: string, Search safety level. Acceptable values are: * `"active"`: Enables SafeSearch filtering. * `"off"`: Disables SafeSearch filtering. (default)

131

Allowed values

132

safeUndefined - SafeSearch mode unspecified. (Falls back to engine's configuration.)

133

active - Turn SafeSearch on.

134

high - Deprecated, equivalent to "active".

135

medium - Deprecated, equivalent to "active".

136

off - Turn SafeSearch off.

137

gl: string, Geolocation of end user. * The `gl` parameter value is a two-letter country code. The `gl` parameter boosts search results whose country of origin matches the parameter value. See the [Country Codes](https://developers.google.com/custom-search/docs/xml_results_appendices#countryCodes) page for a list of valid values. * Specifying a `gl` parameter value should lead to more relevant results. This is particularly true for international customers and, even more specifically, for customers in English- speaking countries other than the United States.

138

imgDominantColor: string, Returns images of a specific dominant color. Acceptable values are: * `"black"` * `"blue"` * `"brown"` * `"gray"` * `"green"` * `"orange"` * `"pink"` * `"purple"` * `"red"` * `"teal"` * `"white"` * `"yellow"`

139

Allowed values

140

imgDominantColorUndefined - No dominant color specified.

141

black - Predominantly black images only.

142

blue - Predominantly blue images only.

143

brown - Predominantly brown images only.

144

gray - Predominantly gray images only.

145

green - Predominantly green images only.

146

orange - Predominantly orange images only.

147

pink - Predominantly pink images only.

148

purple - Predominantly purple images only.

149

red - Predominantly red images only.

150

teal - Predominantly teal images only.

151

white - Predominantly white images only.

152

yellow - Predominantly yellow images only.

153

searchType: string, Specifies the search type: `image`. If unspecified, results are limited to webpages. Acceptable values are: * `"image"`: custom image search.

154

Allowed values

155

searchTypeUndefined - Search type unspecified (defaults to web search).

156

image - Image search.

157

relatedSite: string, Specifies that all search results should be pages that are related to the specified URL.

158

filter: string, Controls turning on or off the duplicate content filter. * See [Automatic Filtering](https://developers.google.com/custom-search/docs/xml_results#automaticFiltering) for more information about Google's search results filters. Note that host crowding filtering applies only to multi-site searches. * By default, Google applies filtering to all search results to improve the quality of those results. Acceptable values are: * `0`: Turns off duplicate content filter. * `1`: Turns on duplicate content filter.

159

linkSite: string, Specifies that all search results should contain a link to a particular URL.

160

siteSearchFilter: string, Controls whether to include or exclude results from the site named in the `siteSearch` parameter. Acceptable values are: * `"e"`: exclude * `"i"`: include

161

Allowed values

162

siteSearchFilterUndefined - Filter mode unspecified.

163

e - Exclude results from the listed sites.

164

i - Include only results from the listed sites.

165

rights: string, Filters based on licensing. Supported values include: `cc_publicdomain`, `cc_attribute`, `cc_sharealike`, `cc_noncommercial`, `cc_nonderived` and combinations of these. See [typical combinations](https://wiki.creativecommons.org/wiki/CC_Search_integration).

166

imgColorType: string, Returns black and white, grayscale, transparent, or color images. Acceptable values are: * `"color"` * `"gray"` * `"mono"`: black and white * `"trans"`: transparent background

167

Allowed values

168

imgColorTypeUndefined - No image color type specified.

169

mono - Black and white images only.

170

gray - Grayscale images only.

171

color - Color images only.

172

trans - Images with transparent background

173

dateRestrict: string, Restricts results to URLs based on date. Supported values include: * `d[number]`: requests results from the specified number of past days. * `w[number]`: requests results from the specified number of past weeks. * `m[number]`: requests results from the specified number of past months. * `y[number]`: requests results from the specified number of past years.

174

start: integer, The index of the first result to return. The default number of results per page is 10, so `&start=11` would start at the top of the second page of results. **Note**: The JSON API will never return more than 100 results, even if more than 100 documents match the query, so setting the sum of `start + num` to a number greater than 100 will produce an error. Also note that the maximum value for `num` is 10.

175

sort: string, The sort expression to apply to the results. The sort parameter specifies that the results be sorted according to the specified expression i.e. sort by date. [Example: sort=date](https://developers.google.com/custom-search/docs/structured_search#sort-by-attribute).

176

lowRange: string, Specifies the starting value for a search range. Use `lowRange` and `highRange` to append an inclusive search range of `lowRange...highRange` to the query.

177

cr: string, Restricts search results to documents originating in a particular country. You may use [Boolean operators](https://developers.google.com/custom-search/docs/xml_results_appendices#booleanOperators) in the cr parameter's value. Google Search determines the country of a document by analyzing: * the top-level domain (TLD) of the document's URL * the geographic location of the Web server's IP address See the [Country Parameter Values](https://developers.google.com/custom-search/docs/xml_results_appendices#countryCollections) page for a list of valid values for this parameter.

178

cx: string, The Programmable Search Engine ID to use for this request.

179

hq: string, Appends the specified query terms to the query, as if they were combined with a logical AND operator.

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

180

x__xgafv: string, V1 error format.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

181

Allowed values

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

182

1 - v1 error format

183

2 - v2 error format

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

184

185

Returns:

186

An object of the form:

187

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

188

{ # Response to a custom search request.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

189

"promotions": [ # The set of [promotions](https://developers.google.com/custom-search/docs/promotions). Present only if the custom search engine's configuration files define any promotions for the given query.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

190

{ # Promotion result.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

191

"displayLink": "A String", # An abridged version of this search's result URL, e.g. www.example.com.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

192

"title": "A String", # The title of the promotion.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

193

"htmlTitle": "A String", # The title of the promotion, in HTML.

194

"link": "A String", # The URL of the promotion.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

195

"image": { # Image belonging to a promotion.

196

"source": "A String", # URL of the image for this promotion link.

197

"width": 42, # Image width in pixels.

198

"height": 42, # Image height in pixels.

199

},

200

"bodyLines": [ # An array of block objects for this promotion. See [Google WebSearch Protocol reference](https://developers.google.com/custom-search/docs/xml_results) for more information.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

201

{ # Block object belonging to a promotion.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

202

"htmlTitle": "A String", # The block object's text in HTML, if it has text.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

203

"title": "A String", # The block object's text, if it has text.

204

"url": "A String", # The URL of the block object's link, if it has one.

205

"link": "A String", # The anchor text of the block object's link, if it has a link.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

},

],

},

],

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

210

"spelling": { # Spell correction information for a query.

211

"htmlCorrectedQuery": "A String", # The corrected query, formatted in HTML.

212

"correctedQuery": "A String", # The corrected query.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

213

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

214

"searchInformation": { # Metadata about a search operation.

215

"formattedTotalResults": "A String", # The total number of search results, formatted according to locale style.

216

"formattedSearchTime": "A String", # The time taken for the server to return search results, formatted according to locale style.

217

"searchTime": 3.14, # The time taken for the server to return search results.

218

"totalResults": "A String", # The total number of search results returned by the query.

219

},

220

"queries": { # Query metadata for the previous, current, and next pages of results.

221

"previousPage": [ # Metadata representing the previous page of results, if applicable.

222

{ # Custom search request metadata.

223

"imgDominantColor": "A String", # Restricts results to images with a specific dominant color. Supported values are: * `red` * `orange` * `yellow` * `green` * `teal` * `blue` * `purple` * `pink` * `white` * `gray` * `black` * `brown`

224

"startIndex": 42, # The index of the current set of search results into the total set of results, where the index of the first result is 1.

225

"language": "A String", # The language of the search results.

226

"cx": "A String", # The identifier of an engine created using the Programmable Search Engine [Control Panel](https://programmablesearchengine.google.com/). This is a custom property not defined in the OpenSearch spec. This parameter is **required**.

227

"hq": "A String", # Appends the specified query terms to the query, as if they were combined with a logical `AND` operator.

228

"searchTerms": "A String", # The search terms entered by the user.

229

"safe": "A String", # Specifies the [SafeSearch level](https://developers.google.com/custom-search/docs/xml_results#safeSearchLevels) used for filtering out adult results. This is a custom property not defined in the OpenSearch spec. Valid parameter values are: * `"off"`: Disable SafeSearch * `"active"`: Enable SafeSearch

230

"gl": "A String", # Boosts search results whose country of origin matches the parameter value. See [Country Codes](https://developers.google.com/custom-search/docs/xml_results#countryCodes) for a list of valid values. Specifying a `gl` parameter value in WebSearch requests should improve the relevance of results. This is particularly true for international customers and, even more specifically, for customers in English-speaking countries other than the United States.

231

"lowRange": "A String", # Specifies the starting value for a search range. Use `cse:lowRange` and `cse:highrange` to append an inclusive search range of `lowRange...highRange` to the query.

232

"searchType": "A String", # Allowed values are `web` or `image`. If unspecified, results are limited to webpages.

233

"rights": "A String", # Filters based on licensing. Supported values include: * `cc_publicdomain` * `cc_attribute` * `cc_sharealike` * `cc_noncommercial` * `cc_nonderived`

234

"startPage": 42, # The page number of this set of results, where the page length is set by the `count` property.

235

"imgType": "A String", # Restricts results to images of a specified type. Supported values are: * `clipart` (Clip art) * `face` (Face) * `lineart` (Line drawing) * `photo` (Photo) * `animated` (Animated) * `stock` (Stock)

236

"inputEncoding": "A String", # The character encoding supported for search requests.

237

"fileType": "A String", # Restricts results to files of a specified extension. Filetypes supported by Google include: * Adobe Portable Document Format (`pdf`) * Adobe PostScript (`ps`) * Lotus 1-2-3 (`wk1`, `wk2`, `wk3`, `wk4`, `wk5`, `wki`, `wks`, `wku`) * Lotus WordPro (`lwp`) * Macwrite (`mw`) * Microsoft Excel (`xls`) * Microsoft PowerPoint (`ppt`) * Microsoft Word (`doc`) * Microsoft Works (`wks`, `wps`, `wdb`) * Microsoft Write (`wri`) * Rich Text Format (`rtf`) * Shockwave Flash (`swf`) * Text (`ans`, `txt`). Additional filetypes may be added in the future. An up-to-date list can always be found in Google's [file type FAQ](https://support.google.com/webmasters/answer/35287).

238

"outputEncoding": "A String", # The character encoding supported for search results.

239

"cr": "A String", # Restricts search results to documents originating in a particular country. You may use [Boolean operators](https://developers.google.com/custom-search/docs/xml_results#booleanOperators) in the `cr` parameter's value. Google WebSearch determines the country of a document by analyzing the following: * The top-level domain (TLD) of the document's URL. * The geographic location of the web server's IP address. See [Country (cr) Parameter Values](https://developers.google.com/custom-search/docs/xml_results#countryCollections) for a list of valid values for this parameter.

240

"exactTerms": "A String", # Identifies a phrase that all documents in the search results must contain.

241

"orTerms": "A String", # Provides additional search terms to check for in a document, where each document in the search results must contain at least one of the additional search terms. You can also use the [Boolean OR](https://developers.google.com/custom-search/docs/xml_results#BooleanOrqt) query term for this type of query.

242

"dateRestrict": "A String", # Restricts results to URLs based on date. Supported values include: * `d[number]`: requests results from the specified number of past days. * `w[number]`: requests results from the specified number of past weeks. * `m[number]`: requests results from the specified number of past months. * `y[number]`: requests results from the specified number of past years.

243

"excludeTerms": "A String", # Identifies a word or phrase that should not appear in any documents in the search results.

244

"highRange": "A String", # Specifies the ending value for a search range. Use `cse:lowRange` and `cse:highrange` to append an inclusive search range of `lowRange...highRange` to the query.

245

"relatedSite": "A String", # Specifies that all search results should be pages that are related to the specified URL. The parameter value should be a URL.

246

"count": 42, # Number of search results returned in this set.

247

"filter": "A String", # Activates or deactivates the automatic filtering of Google search results. See [Automatic Filtering](https://developers.google.com/custom-search/docs/xml_results#automaticFiltering) for more information about Google's search results filters. Valid values for this parameter are: * `0`: Disabled * `1`: Enabled (default) **Note**: By default, Google applies filtering to all search results to improve the quality of those results.

248

"linkSite": "A String", # Specifies that all results should contain a link to a specific URL.

249

"siteSearchFilter": "A String", # Specifies whether to include or exclude results from the site named in the `sitesearch` parameter. Supported values are: * `i`: include content from site * `e`: exclude content from site

250

"disableCnTwTranslation": "A String", # Enables or disables the [Simplified and Traditional Chinese Search](https://developers.google.com/custom-search/docs/xml_results#chineseSearch) feature. Supported values are: * `0`: enabled (default) * `1`: disabled

251

"sort": "A String", # Specifies that results should be sorted according to the specified expression. For example, sort by date.

252

"totalResults": "A String", # Estimated number of total search results. May not be accurate.

253

"title": "A String", # A description of the query.

254

"googleHost": "A String", # Specifies the Google domain (for example, google.com, google.de, or google.fr) to which the search should be limited.

255

"imgSize": "A String", # Restricts results to images of a specified size. Supported values are: * `icon` (small) * `small | medium | large | xlarge` (medium) * `xxlarge` (large) * `huge` (extra-large)

256

"siteSearch": "A String", # Restricts results to URLs from a specified site.

257

"imgColorType": "A String", # Restricts results to images of a specified color type. Supported values are: * `mono` (black and white) * `gray` (grayscale) * `color` (color)

258

"hl": "A String", # Specifies the interface language (host language) of your user interface. Explicitly setting this parameter improves the performance and the quality of your search results. See the [Interface Languages](https://developers.google.com/custom-search/docs/xml_results#wsInterfaceLanguages) section of [Internationalizing Queries and Results Presentation](https://developers.google.com/custom-search/docs/xml_results#wsInternationalizing) for more information, and [Supported Interface Languages](https://developers.google.com/custom-search/docs/xml_results_appendices#interfaceLanguages) for a list of supported languages.

259

},

260

],

261

"request": [ # Metadata representing the current request.

262

{ # Custom search request metadata.

263

"searchTerms": "A String", # The search terms entered by the user.

264

"inputEncoding": "A String", # The character encoding supported for search requests.

265

"excludeTerms": "A String", # Identifies a word or phrase that should not appear in any documents in the search results.

266

"totalResults": "A String", # Estimated number of total search results. May not be accurate.

267

"cr": "A String", # Restricts search results to documents originating in a particular country. You may use [Boolean operators](https://developers.google.com/custom-search/docs/xml_results#booleanOperators) in the `cr` parameter's value. Google WebSearch determines the country of a document by analyzing the following: * The top-level domain (TLD) of the document's URL. * The geographic location of the web server's IP address. See [Country (cr) Parameter Values](https://developers.google.com/custom-search/docs/xml_results#countryCollections) for a list of valid values for this parameter.

268

"safe": "A String", # Specifies the [SafeSearch level](https://developers.google.com/custom-search/docs/xml_results#safeSearchLevels) used for filtering out adult results. This is a custom property not defined in the OpenSearch spec. Valid parameter values are: * `"off"`: Disable SafeSearch * `"active"`: Enable SafeSearch

269

"imgSize": "A String", # Restricts results to images of a specified size. Supported values are: * `icon` (small) * `small | medium | large | xlarge` (medium) * `xxlarge` (large) * `huge` (extra-large)

270

"filter": "A String", # Activates or deactivates the automatic filtering of Google search results. See [Automatic Filtering](https://developers.google.com/custom-search/docs/xml_results#automaticFiltering) for more information about Google's search results filters. Valid values for this parameter are: * `0`: Disabled * `1`: Enabled (default) **Note**: By default, Google applies filtering to all search results to improve the quality of those results.

271

"count": 42, # Number of search results returned in this set.

272

"cx": "A String", # The identifier of an engine created using the Programmable Search Engine [Control Panel](https://programmablesearchengine.google.com/). This is a custom property not defined in the OpenSearch spec. This parameter is **required**.

273

"imgDominantColor": "A String", # Restricts results to images with a specific dominant color. Supported values are: * `red` * `orange` * `yellow` * `green` * `teal` * `blue` * `purple` * `pink` * `white` * `gray` * `black` * `brown`

274

"googleHost": "A String", # Specifies the Google domain (for example, google.com, google.de, or google.fr) to which the search should be limited.

275

"lowRange": "A String", # Specifies the starting value for a search range. Use `cse:lowRange` and `cse:highrange` to append an inclusive search range of `lowRange...highRange` to the query.

276

"dateRestrict": "A String", # Restricts results to URLs based on date. Supported values include: * `d[number]`: requests results from the specified number of past days. * `w[number]`: requests results from the specified number of past weeks. * `m[number]`: requests results from the specified number of past months. * `y[number]`: requests results from the specified number of past years.

277

"rights": "A String", # Filters based on licensing. Supported values include: * `cc_publicdomain` * `cc_attribute` * `cc_sharealike` * `cc_noncommercial` * `cc_nonderived`

278

"siteSearch": "A String", # Restricts results to URLs from a specified site.

279

"exactTerms": "A String", # Identifies a phrase that all documents in the search results must contain.

280

"relatedSite": "A String", # Specifies that all search results should be pages that are related to the specified URL. The parameter value should be a URL.

281

"title": "A String", # A description of the query.

282

"imgColorType": "A String", # Restricts results to images of a specified color type. Supported values are: * `mono` (black and white) * `gray` (grayscale) * `color` (color)

283

"outputEncoding": "A String", # The character encoding supported for search results.

284

"disableCnTwTranslation": "A String", # Enables or disables the [Simplified and Traditional Chinese Search](https://developers.google.com/custom-search/docs/xml_results#chineseSearch) feature. Supported values are: * `0`: enabled (default) * `1`: disabled

285

"searchType": "A String", # Allowed values are `web` or `image`. If unspecified, results are limited to webpages.

286

"orTerms": "A String", # Provides additional search terms to check for in a document, where each document in the search results must contain at least one of the additional search terms. You can also use the [Boolean OR](https://developers.google.com/custom-search/docs/xml_results#BooleanOrqt) query term for this type of query.

287

"fileType": "A String", # Restricts results to files of a specified extension. Filetypes supported by Google include: * Adobe Portable Document Format (`pdf`) * Adobe PostScript (`ps`) * Lotus 1-2-3 (`wk1`, `wk2`, `wk3`, `wk4`, `wk5`, `wki`, `wks`, `wku`) * Lotus WordPro (`lwp`) * Macwrite (`mw`) * Microsoft Excel (`xls`) * Microsoft PowerPoint (`ppt`) * Microsoft Word (`doc`) * Microsoft Works (`wks`, `wps`, `wdb`) * Microsoft Write (`wri`) * Rich Text Format (`rtf`) * Shockwave Flash (`swf`) * Text (`ans`, `txt`). Additional filetypes may be added in the future. An up-to-date list can always be found in Google's [file type FAQ](https://support.google.com/webmasters/answer/35287).

288

"highRange": "A String", # Specifies the ending value for a search range. Use `cse:lowRange` and `cse:highrange` to append an inclusive search range of `lowRange...highRange` to the query.

289

"startIndex": 42, # The index of the current set of search results into the total set of results, where the index of the first result is 1.

290

"hq": "A String", # Appends the specified query terms to the query, as if they were combined with a logical `AND` operator.

291

"imgType": "A String", # Restricts results to images of a specified type. Supported values are: * `clipart` (Clip art) * `face` (Face) * `lineart` (Line drawing) * `photo` (Photo) * `animated` (Animated) * `stock` (Stock)

292

"hl": "A String", # Specifies the interface language (host language) of your user interface. Explicitly setting this parameter improves the performance and the quality of your search results. See the [Interface Languages](https://developers.google.com/custom-search/docs/xml_results#wsInterfaceLanguages) section of [Internationalizing Queries and Results Presentation](https://developers.google.com/custom-search/docs/xml_results#wsInternationalizing) for more information, and [Supported Interface Languages](https://developers.google.com/custom-search/docs/xml_results_appendices#interfaceLanguages) for a list of supported languages.

293

"startPage": 42, # The page number of this set of results, where the page length is set by the `count` property.

294

"gl": "A String", # Boosts search results whose country of origin matches the parameter value. See [Country Codes](https://developers.google.com/custom-search/docs/xml_results#countryCodes) for a list of valid values. Specifying a `gl` parameter value in WebSearch requests should improve the relevance of results. This is particularly true for international customers and, even more specifically, for customers in English-speaking countries other than the United States.

295

"language": "A String", # The language of the search results.

296

"sort": "A String", # Specifies that results should be sorted according to the specified expression. For example, sort by date.

297

"linkSite": "A String", # Specifies that all results should contain a link to a specific URL.

298

"siteSearchFilter": "A String", # Specifies whether to include or exclude results from the site named in the `sitesearch` parameter. Supported values are: * `i`: include content from site * `e`: exclude content from site

299

},

300

],

301

"nextPage": [ # Metadata representing the next page of results, if applicable.

302

{ # Custom search request metadata.

303

"imgType": "A String", # Restricts results to images of a specified type. Supported values are: * `clipart` (Clip art) * `face` (Face) * `lineart` (Line drawing) * `photo` (Photo) * `animated` (Animated) * `stock` (Stock)

304

"startPage": 42, # The page number of this set of results, where the page length is set by the `count` property.

305

"relatedSite": "A String", # Specifies that all search results should be pages that are related to the specified URL. The parameter value should be a URL.

306

"hq": "A String", # Appends the specified query terms to the query, as if they were combined with a logical `AND` operator.

307

"cr": "A String", # Restricts search results to documents originating in a particular country. You may use [Boolean operators](https://developers.google.com/custom-search/docs/xml_results#booleanOperators) in the `cr` parameter's value. Google WebSearch determines the country of a document by analyzing the following: * The top-level domain (TLD) of the document's URL. * The geographic location of the web server's IP address. See [Country (cr) Parameter Values](https://developers.google.com/custom-search/docs/xml_results#countryCollections) for a list of valid values for this parameter.

308

"siteSearchFilter": "A String", # Specifies whether to include or exclude results from the site named in the `sitesearch` parameter. Supported values are: * `i`: include content from site * `e`: exclude content from site

309

"outputEncoding": "A String", # The character encoding supported for search results.

310

"gl": "A String", # Boosts search results whose country of origin matches the parameter value. See [Country Codes](https://developers.google.com/custom-search/docs/xml_results#countryCodes) for a list of valid values. Specifying a `gl` parameter value in WebSearch requests should improve the relevance of results. This is particularly true for international customers and, even more specifically, for customers in English-speaking countries other than the United States.

311

"cx": "A String", # The identifier of an engine created using the Programmable Search Engine [Control Panel](https://programmablesearchengine.google.com/). This is a custom property not defined in the OpenSearch spec. This parameter is **required**.

312

"excludeTerms": "A String", # Identifies a word or phrase that should not appear in any documents in the search results.

313

"searchTerms": "A String", # The search terms entered by the user.

314

"imgDominantColor": "A String", # Restricts results to images with a specific dominant color. Supported values are: * `red` * `orange` * `yellow` * `green` * `teal` * `blue` * `purple` * `pink` * `white` * `gray` * `black` * `brown`

315

"totalResults": "A String", # Estimated number of total search results. May not be accurate.

316

"searchType": "A String", # Allowed values are `web` or `image`. If unspecified, results are limited to webpages.

317

"imgSize": "A String", # Restricts results to images of a specified size. Supported values are: * `icon` (small) * `small | medium | large | xlarge` (medium) * `xxlarge` (large) * `huge` (extra-large)

318

"exactTerms": "A String", # Identifies a phrase that all documents in the search results must contain.

319

"language": "A String", # The language of the search results.

320

"siteSearch": "A String", # Restricts results to URLs from a specified site.

321

"startIndex": 42, # The index of the current set of search results into the total set of results, where the index of the first result is 1.

322

"title": "A String", # A description of the query.

323

"fileType": "A String", # Restricts results to files of a specified extension. Filetypes supported by Google include: * Adobe Portable Document Format (`pdf`) * Adobe PostScript (`ps`) * Lotus 1-2-3 (`wk1`, `wk2`, `wk3`, `wk4`, `wk5`, `wki`, `wks`, `wku`) * Lotus WordPro (`lwp`) * Macwrite (`mw`) * Microsoft Excel (`xls`) * Microsoft PowerPoint (`ppt`) * Microsoft Word (`doc`) * Microsoft Works (`wks`, `wps`, `wdb`) * Microsoft Write (`wri`) * Rich Text Format (`rtf`) * Shockwave Flash (`swf`) * Text (`ans`, `txt`). Additional filetypes may be added in the future. An up-to-date list can always be found in Google's [file type FAQ](https://support.google.com/webmasters/answer/35287).

324

"highRange": "A String", # Specifies the ending value for a search range. Use `cse:lowRange` and `cse:highrange` to append an inclusive search range of `lowRange...highRange` to the query.

325

"filter": "A String", # Activates or deactivates the automatic filtering of Google search results. See [Automatic Filtering](https://developers.google.com/custom-search/docs/xml_results#automaticFiltering) for more information about Google's search results filters. Valid values for this parameter are: * `0`: Disabled * `1`: Enabled (default) **Note**: By default, Google applies filtering to all search results to improve the quality of those results.

326

"disableCnTwTranslation": "A String", # Enables or disables the [Simplified and Traditional Chinese Search](https://developers.google.com/custom-search/docs/xml_results#chineseSearch) feature. Supported values are: * `0`: enabled (default) * `1`: disabled

327

"safe": "A String", # Specifies the [SafeSearch level](https://developers.google.com/custom-search/docs/xml_results#safeSearchLevels) used for filtering out adult results. This is a custom property not defined in the OpenSearch spec. Valid parameter values are: * `"off"`: Disable SafeSearch * `"active"`: Enable SafeSearch

328

"lowRange": "A String", # Specifies the starting value for a search range. Use `cse:lowRange` and `cse:highrange` to append an inclusive search range of `lowRange...highRange` to the query.

329

"count": 42, # Number of search results returned in this set.

330

"googleHost": "A String", # Specifies the Google domain (for example, google.com, google.de, or google.fr) to which the search should be limited.

331

"inputEncoding": "A String", # The character encoding supported for search requests.

332

"orTerms": "A String", # Provides additional search terms to check for in a document, where each document in the search results must contain at least one of the additional search terms. You can also use the [Boolean OR](https://developers.google.com/custom-search/docs/xml_results#BooleanOrqt) query term for this type of query.

333

"dateRestrict": "A String", # Restricts results to URLs based on date. Supported values include: * `d[number]`: requests results from the specified number of past days. * `w[number]`: requests results from the specified number of past weeks. * `m[number]`: requests results from the specified number of past months. * `y[number]`: requests results from the specified number of past years.

334

"sort": "A String", # Specifies that results should be sorted according to the specified expression. For example, sort by date.

335

"rights": "A String", # Filters based on licensing. Supported values include: * `cc_publicdomain` * `cc_attribute` * `cc_sharealike` * `cc_noncommercial` * `cc_nonderived`

336

"hl": "A String", # Specifies the interface language (host language) of your user interface. Explicitly setting this parameter improves the performance and the quality of your search results. See the [Interface Languages](https://developers.google.com/custom-search/docs/xml_results#wsInterfaceLanguages) section of [Internationalizing Queries and Results Presentation](https://developers.google.com/custom-search/docs/xml_results#wsInternationalizing) for more information, and [Supported Interface Languages](https://developers.google.com/custom-search/docs/xml_results_appendices#interfaceLanguages) for a list of supported languages.

337

"linkSite": "A String", # Specifies that all results should contain a link to a specific URL.

338

"imgColorType": "A String", # Restricts results to images of a specified color type. Supported values are: * `mono` (black and white) * `gray` (grayscale) * `color` (color)

},

],

},

"context": { # Metadata and refinements associated with the given search engine, including: * The name of the search engine that was used for the query. * A set of [facet objects](https://developers.google.com/custom-search/docs/refinements#create) (refinements) you can use for refining a search.

343

"a_key": "", # Properties of the object.

344

},

345

"url": { # OpenSearch template and URL.

346

"type": "A String", # The MIME type of the OpenSearch URL template for the Custom Search JSON API.

347

"template": "A String", # The actual [OpenSearch template](http://www.opensearch.org/specifications/opensearch/1.1#opensearch_url_template_syntax) for this API.

348

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

349

"items": [ # The current set of custom search results.

350

{ # A custom search result.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

351

"displayLink": "A String", # An abridged version of this search result’s URL, e.g. www.example.com.

352

"htmlSnippet": "A String", # The snippet of the search result, in HTML.

353

"kind": "A String", # A unique identifier for the type of current object. For this API, it is `customsearch#result.`

354

"cacheId": "A String", # Indicates the ID of Google's cached version of the search result.

355

"fileFormat": "A String", # The file format of the search result.

356

"formattedUrl": "A String", # The URL displayed after the snippet for each search result.

357

"snippet": "A String", # The snippet of the search result, in plain text.

358

"labels": [ # Encapsulates all information about [refinement labels](https://developers.google.com/custom-search/docs/xml_results).

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

359

{ # Refinement label associated with a custom search result.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

360

"label_with_op": "A String", # Refinement label and the associated refinement operation.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

361

"displayName": "A String", # The display name of a refinement label. This is the name you should display in your user interface.

362

"name": "A String", # The name of a refinement label, which you can use to refine searches. Don't display this in your user interface; instead, use displayName.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

363

},

364

],

Dmitry Frenkel