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

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

[diff] [blame]

87

<p class="firstline">Returns metadata about the search performed, metadata about the engine used for the search, and the search results.</p>

John Asmuth

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>

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

95

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

Dmitry Frenkel

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

[diff] [blame]

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:

Bu Sun Kim

d059ad8

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

[diff] [blame]

99

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]

100

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).

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

101

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)

102

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.

103

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).

104

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

105

Allowed values

106

imgColorTypeUndefined - No image color type specified.

107

mono - Black and white images only.

108

gray - Grayscale images only.

109

color - Color images only.

110

trans - Images with transparent background

111

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

112

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.

113

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.

114

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

115

Allowed values

116

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

117

image - Image search.

118

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.

119

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

120

Allowed values

121

siteSearchFilterUndefined - Filter mode unspecified.

122

e - Exclude results from the listed sites.

123

i - Include only results from the listed sites.

124

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.

Dmitry Frenkel

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

[diff] [blame]

125

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

126

Allowed values

127

imgSizeUndefined - No image size specified.

128

HUGE - Only the largest possible images.

129

ICON - Only very small icon-sized images.

130

LARGE - Only large images.

131

MEDIUM - Only medium images.

132

SMALL - Only small images.

133

XLARGE - Only very large images.

134

XXLARGE - Only extremely large images.

Dmitry Frenkel

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

[diff] [blame]

135

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.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

136

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

137

Allowed values

138

imgTypeUndefined - No image type specified.

139

clipart - Clipart-style images only.

140

face - Images of faces only.

141

lineart - Line art images only.

142

stock - Stock images only.

143

photo - Photo images only.

144

animated - Animated images only.

145

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

146

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.

147

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).

148

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.

Dmitry Frenkel

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

[diff] [blame]

149

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

150

Allowed values

151

imgDominantColorUndefined - No dominant color specified.

152

black - Predominantly black images only.

153

blue - Predominantly blue images only.

154

brown - Predominantly brown images only.

155

gray - Predominantly gray images only.

156

green - Predominantly green images only.

157

orange - Predominantly orange images only.

158

pink - Predominantly pink images only.

159

purple - Predominantly purple images only.

160

red - Predominantly red images only.

161

teal - Predominantly teal images only.

162

white - Predominantly white images only.

163

yellow - Predominantly yellow images only.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

164

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

Dmitry Frenkel

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

[diff] [blame]

165

Allowed values

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

166

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

167

active - Turn SafeSearch on.

168

high - Deprecated, equivalent to "active".

169

medium - Deprecated, equivalent to "active".

170

off - Turn SafeSearch off.

171

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.

172

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

173

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

Dmitry Frenkel

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

[diff] [blame]

174

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

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

175

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)

Dmitry Frenkel

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

[diff] [blame]

176

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

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

177

q: string, Query

178

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.

179

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

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.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

189

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

190

"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.

191

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

192

},

Bu Sun Kim

d059ad8

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

[diff] [blame]

193

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

194

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

195

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

Bu Sun Kim

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

[diff] [blame]

196

},

Dmitry Frenkel

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

[diff] [blame]

197

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

198

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

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

199

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

Dmitry Frenkel

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

[diff] [blame]

200

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

201

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

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

202

},

203

"url": { # OpenSearch template and URL.

204

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

205

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

Dmitry Frenkel

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

[diff] [blame]

206

},

207

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

Dmitry Frenkel

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

[diff] [blame]

208

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

209

{ # Custom search request metadata.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

210

"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.

211

"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)

212

"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.

Dmitry Frenkel

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

[diff] [blame]

213

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

214

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

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

215

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

216

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

217

"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

218

"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)

219

"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.

220

"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.

221

"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.

222

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

223

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

224

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

225

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

226

"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.

227

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

228

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

229

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

Dmitry Frenkel

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

[diff] [blame]

230

"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.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

231

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

232

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

233

"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

234

"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).

235

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

236

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

237

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

238

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

239

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

240

"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`

241

"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.

242

"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.

243

"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**.

244

"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

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

},

247

],

248

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

249

{ # Custom search request metadata.

250

"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**.

251

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

252

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

253

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

254

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

255

"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.

256

"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.

257

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

258

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

259

"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.

260

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

261

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

262

"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).

263

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

264

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

265

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

266

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

267

"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.

Dmitry Frenkel

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

[diff] [blame]

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)

Dmitry Frenkel

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

[diff] [blame]

270

"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.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

271

"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`

272

"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.

273

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

274

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

Dmitry Frenkel

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

[diff] [blame]

275

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

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

276

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

277

"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.

278

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

Dmitry Frenkel

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

[diff] [blame]

279

"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

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

280

"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)

281

"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.

282

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

283

"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.

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

"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.

Dmitry Frenkel

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

[diff] [blame]

286

},

287

],

288

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

289

{ # Custom search request metadata.

Dmitry Frenkel

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

[diff] [blame]

290

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

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

291

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

292

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

293

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

294

"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)

295

"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.

Dmitry Frenkel

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

[diff] [blame]

296

"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`

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

297

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

Dmitry Frenkel

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

[diff] [blame]

298

"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

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

299

"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

300

"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.

301

"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.

302

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

Dmitry Frenkel

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

[diff] [blame]

303

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

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

304

"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.

305

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

306

"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.

307

"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.

308

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

309

"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**.

310

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

311

"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)

Dmitry Frenkel

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

[diff] [blame]

312

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

313

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

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

314

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

315

"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.

316

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

317

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

318

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

Dmitry Frenkel

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

[diff] [blame]

319

"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.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

320

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

321

"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

322

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

323

"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.

Dmitry Frenkel

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

[diff] [blame]

324

"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.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

325

"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).

Dmitry Frenkel

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

[diff] [blame]

326

},

327

],

328

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

329

"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.

330

{ # Promotion result.

331

"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.

332

{ # Block object belonging to a promotion.

333

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

334

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

335

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

336

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

337

},

338

],

339

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

340

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

341

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

342

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

343

},

344

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

345

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

346

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

347

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

348

},

349

],

Bu Sun Kim

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

[diff] [blame]

350

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

351

{ # A custom search result.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

352

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

353

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

Dmitry Frenkel

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

[diff] [blame]

354

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

355

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

Dmitry Frenkel

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

[diff] [blame]

356

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

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

357

"htmlFormattedUrl": "A String", # The HTML-formatted URL displayed after the snippet for each search result.

358

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

359

"image": { # Image belonging to a custom search result.

360

"height": 42, # The height of the image, in pixels.

361

"contextLink": "A String", # A URL pointing to the webpage hosting the image.

362

"byteSize": 42, # The size of the image, in pixels.

363

"thumbnailWidth": 42, # The width of the thumbnail image, in pixels.

364

"width": 42, # The width of the image, in pixels.

365

"thumbnailLink": "A String", # A URL to the thumbnail image.

366

"thumbnailHeight": 42, # The height of the thumbnail image, in pixels.

367

},

368

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

Dmitry Frenkel

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

[diff] [blame]

369

"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]

370

{ # Refinement label associated with a custom search result.

Bu Sun Kim

d059ad8

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

[diff] [blame]

371

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

Dmitry Frenkel

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

[diff] [blame]

372

"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-11-16 11:05:03 -0700

[diff] [blame]

373

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

Bu Sun Kim