blob: c8356bf30e5536eeafe6f5e6257d76e68906a04d [file] [log] [blame]
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001<html><body>
2<style>
3
4body, h1, h2, h3, div, span, p, pre, a {
5 margin: 0;
6 padding: 0;
7 border: 0;
8 font-weight: inherit;
9 font-style: inherit;
10 font-size: 100%;
11 font-family: inherit;
12 vertical-align: baseline;
13}
14
15body {
16 font-size: 13px;
17 padding: 1em;
18}
19
20h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23}
24
25h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28}
29
30h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34}
35
36pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42 margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46 font-family: Arial, sans serif;
47}
48
49h1, h2, h3 {
50 border-bottom: solid #CCC 1px;
51}
52
53.toc_element {
54 margin-top: 0.5em;
55}
56
57.firstline {
58 margin-left: 2 em;
59}
60
61.method {
62 margin-top: 1em;
63 border: solid 1px #CCC;
64 padding: 1em;
65 background: #EEE;
66}
67
68.details {
69 font-weight: bold;
70 font-size: 14px;
71}
72
73</style>
74
Bu Sun Kim65020912020-05-20 12:08:20 -070075<h1><a href="customsearch_v1.html">Custom Search API</a> . <a href="customsearch_v1.cse.html">cse</a> . <a href="customsearch_v1.cse.siterestrict.html">siterestrict</a></h1>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -070076<h2>Instance Methods</h2>
77<p class="toc_element">
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -070078 <code><a href="#list">list(highRange=None, q=None, cr=None, siteSearch=None, dateRestrict=None, siteSearchFilter=None, lr=None, exactTerms=None, relatedSite=None, imgType=None, num=None, safe=None, imgColorType=None, imgSize=None, gl=None, imgDominantColor=None, linkSite=None, excludeTerms=None, googlehost=None, rights=None, cx=None, start=None, filter=None, orTerms=None, hq=None, searchType=None, hl=None, sort=None, fileType=None, lowRange=None, c2coff=None, x__xgafv=None)</a></code></p>
Bu Sun Kim65020912020-05-20 12:08:20 -070079<p class="firstline">Returns metadata about the search performed, metadata about the custom</p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -070080<h3>Method Details</h3>
81<div class="method">
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -070082 <code class="details" id="list">list(highRange=None, q=None, cr=None, siteSearch=None, dateRestrict=None, siteSearchFilter=None, lr=None, exactTerms=None, relatedSite=None, imgType=None, num=None, safe=None, imgColorType=None, imgSize=None, gl=None, imgDominantColor=None, linkSite=None, excludeTerms=None, googlehost=None, rights=None, cx=None, start=None, filter=None, orTerms=None, hq=None, searchType=None, hl=None, sort=None, fileType=None, lowRange=None, c2coff=None, x__xgafv=None)</code>
Bu Sun Kim65020912020-05-20 12:08:20 -070083 <pre>Returns metadata about the search performed, metadata about the custom
84search engine used for the search, and the search results. Uses a small set
85of url patterns.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -070086
87Args:
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -070088 highRange: string, Specifies the ending value for a search range.
89
90* Use `lowRange` and `highRange` to append an inclusive search range of
91`lowRange...highRange` to the query.
92 q: string, Query
93 cr: string, Restricts search results to documents originating in a particular country.
94You may use [Boolean
95operators](https://developers.google.com/custom-search/docs/xml_results_appendices#booleanOperators)
96in the cr parameter&#x27;s value.
97
98Google Search determines the country of a document by analyzing:
99
100* the top-level domain (TLD) of the document&#x27;s URL
101
102* the geographic location of the Web server&#x27;s IP address
103
104See the [Country Parameter
105Values](https://developers.google.com/custom-search/docs/xml_results_appendices#countryCollections)
106page for a list of valid values for this parameter.
Bu Sun Kim65020912020-05-20 12:08:20 -0700107 siteSearch: string, Specifies a given site which should always be included or excluded from
108results (see `siteSearchFilter` parameter, below).
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700109 dateRestrict: string, Restricts results to URLs based on date. Supported values include:
110
111* `d[number]`: requests results from the specified number of past days.
112
113* `w[number]`: requests results from the specified number of past weeks.
114
115* `m[number]`: requests results from the specified number of past months.
116
117* `y[number]`: requests results from the specified number of past years.
118 siteSearchFilter: string, Controls whether to include or exclude results from the site named in the
119`siteSearch` parameter.
120
121Acceptable values are:
122
123* `&quot;e&quot;`: exclude
124
125* `&quot;i&quot;`: include
Bu Sun Kim65020912020-05-20 12:08:20 -0700126 lr: string, Restricts the search to documents written in a particular language (e.g.,
127`lr=lang_ja`).
128
129Acceptable values are:
130
131* `&quot;lang_ar&quot;`: Arabic
132
133* `&quot;lang_bg&quot;`: Bulgarian
134
135* `&quot;lang_ca&quot;`: Catalan
136
137* `&quot;lang_cs&quot;`: Czech
138
139* `&quot;lang_da&quot;`: Danish
140
141* `&quot;lang_de&quot;`: German
142
143* `&quot;lang_el&quot;`: Greek
144
145* `&quot;lang_en&quot;`: English
146
147* `&quot;lang_es&quot;`: Spanish
148
149* `&quot;lang_et&quot;`: Estonian
150
151* `&quot;lang_fi&quot;`: Finnish
152
153* `&quot;lang_fr&quot;`: French
154
155* `&quot;lang_hr&quot;`: Croatian
156
157* `&quot;lang_hu&quot;`: Hungarian
158
159* `&quot;lang_id&quot;`: Indonesian
160
161* `&quot;lang_is&quot;`: Icelandic
162
163* `&quot;lang_it&quot;`: Italian
164
165* `&quot;lang_iw&quot;`: Hebrew
166
167* `&quot;lang_ja&quot;`: Japanese
168
169* `&quot;lang_ko&quot;`: Korean
170
171* `&quot;lang_lt&quot;`: Lithuanian
172
173* `&quot;lang_lv&quot;`: Latvian
174
175* `&quot;lang_nl&quot;`: Dutch
176
177* `&quot;lang_no&quot;`: Norwegian
178
179* `&quot;lang_pl&quot;`: Polish
180
181* `&quot;lang_pt&quot;`: Portuguese
182
183* `&quot;lang_ro&quot;`: Romanian
184
185* `&quot;lang_ru&quot;`: Russian
186
187* `&quot;lang_sk&quot;`: Slovak
188
189* `&quot;lang_sl&quot;`: Slovenian
190
191* `&quot;lang_sr&quot;`: Serbian
192
193* `&quot;lang_sv&quot;`: Swedish
194
195* `&quot;lang_tr&quot;`: Turkish
196
197* `&quot;lang_zh-CN&quot;`: Chinese (Simplified)
198
199* `&quot;lang_zh-TW&quot;`: Chinese (Traditional)
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700200 exactTerms: string, Identifies a phrase that all documents in the search results must contain.
201 relatedSite: string, Specifies that all search results should be pages that are related to the
202specified URL.
203 imgType: string, Returns images of a type. Acceptable values are:
204
205* `&quot;clipart&quot;`
206
207* `&quot;face&quot;`
208
209* `&quot;lineart&quot;`
210
211* `&quot;stock&quot;`
212
213* `&quot;photo&quot;`
214
215* `&quot;animated&quot;`
216 num: integer, Number of search results to return.
217
218* Valid values are integers between 1 and 10, inclusive.
219 safe: string, Search safety level. Acceptable values are:
220
221* `&quot;active&quot;`: Enables SafeSearch filtering.
222
223* `&quot;off&quot;`: Disables SafeSearch filtering. (default)
224 imgColorType: string, Returns black and white, grayscale, transparent, or color images.
225Acceptable values are:
226
227* `&quot;color&quot;`
228
229* `&quot;gray&quot;`
230
231* `&quot;mono&quot;`: black and white
232
233* `&quot;trans&quot;`: transparent background
234 imgSize: string, Returns images of a specified size. Acceptable values are:
235
236* `&quot;huge&quot;`
237
238* `&quot;icon&quot;`
239
240* `&quot;large&quot;`
241
242* `&quot;medium&quot;`
243
244* `&quot;small&quot;`
245
246* `&quot;xlarge&quot;`
247
248* `&quot;xxlarge&quot;`
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700249 gl: string, Geolocation of end user.
Bu Sun Kim65020912020-05-20 12:08:20 -0700250
251* The `gl` parameter value is a two-letter country code. The `gl` parameter
252boosts search results whose country of origin matches the parameter value.
253See the [Country
254Codes](https://developers.google.com/custom-search/docs/xml_results_appendices#countryCodes)
255page for a list of valid values.
256
257* Specifying a `gl` parameter value should lead to more relevant results.
258This is particularly true for international customers and, even more
259specifically, for customers in English- speaking countries other than the
260United States.
Bu Sun Kim65020912020-05-20 12:08:20 -0700261 imgDominantColor: string, Returns images of a specific dominant color. Acceptable values are:
262
263* `&quot;black&quot;`
264
265* `&quot;blue&quot;`
266
267* `&quot;brown&quot;`
268
269* `&quot;gray&quot;`
270
271* `&quot;green&quot;`
272
273* `&quot;orange&quot;`
274
275* `&quot;pink&quot;`
276
277* `&quot;purple&quot;`
278
279* `&quot;red&quot;`
280
281* `&quot;teal&quot;`
282
283* `&quot;white&quot;`
284
285* `&quot;yellow&quot;`
Bu Sun Kim65020912020-05-20 12:08:20 -0700286 linkSite: string, Specifies that all search results should contain a link to a particular
287URL.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700288 excludeTerms: string, Identifies a word or phrase that should not appear in any documents in the
289search results.
290 googlehost: string, **Deprecated**. Use the `gl` parameter for a similar effect.
Bu Sun Kim65020912020-05-20 12:08:20 -0700291
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700292The local Google domain (for example, google.com, google.de, or
293google.fr) to use to perform the search.
294 rights: string, Filters based on licensing. Supported values include: `cc_publicdomain`,
295`cc_attribute`, `cc_sharealike`, `cc_noncommercial`, `cc_nonderived` and
296combinations of these. See [typical
297combinations](https://wiki.creativecommons.org/wiki/CC_Search_integration).
298 cx: string, The custom search engine ID to use for this request.
299 start: integer, The index of the first result to return. The default number of results per
300page is 10, so `&amp;start=11` would start at the top of the second page of
301results. **Note**: The JSON API will never return more than 100 results,
302even if more than 100 documents match the query, so setting the sum of
303`start + num` to a number greater than 100 will produce an error. Also note
304that the maximum value for `num` is 10.
Bu Sun Kim65020912020-05-20 12:08:20 -0700305 filter: string, Controls turning on or off the duplicate content filter.
306
307* See [Automatic
308Filtering](https://developers.google.com/custom-search/docs/xml_results#automaticFiltering)
309for more information about Google&#x27;s search results filters. Note that host
310crowding filtering applies only to multi-site searches.
311
312* By default, Google applies filtering to all search results to improve the
313quality of those results.
314
315Acceptable values are:
316
317* `0`: Turns off duplicate content filter.
318
319* `1`: Turns on duplicate content filter.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700320 orTerms: string, Provides additional search terms to check for in a document, where each
321document in the search results must contain at least one of the additional
322search terms.
323 hq: string, Appends the specified query terms to the query, as if they were combined
324with a logical AND operator.
325 searchType: string, Specifies the search type: `image`. If unspecified, results are limited to
326webpages.
Bu Sun Kim65020912020-05-20 12:08:20 -0700327
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700328Acceptable values are:
329
330* `&quot;image&quot;`: custom image search.
331 hl: string, Sets the user interface language.
332
333* Explicitly setting this parameter improves the performance and the
334quality of your search results.
335
336* See the [Interface
337Languages](https://developers.google.com/custom-search/docs/xml_results#wsInterfaceLanguages)
338section of [Internationalizing Queries and Results
339Presentation](https://developers.google.com/custom-search/docs/xml_results#wsInternationalizing)
340for more information, and (Supported Interface
341Languages)[https://developers.google.com/custom-search/docs/xml_results_appendices#interfaceLanguages]
342for a list of supported languages.
343 sort: string, The sort expression to apply to the results.
344 fileType: string, Restricts results to files of a specified extension. A list of file types
345indexable by Google can be found in Search Console [Help
346Center](https://support.google.com/webmasters/answer/35287).
347 lowRange: string, Specifies the starting value for a search range. Use `lowRange` and
348`highRange` to append an inclusive search range of `lowRange...highRange`
349to the query.
350 c2coff: string, Enables or disables [Simplified and Traditional Chinese
351Search](https://developers.google.com/custom-search/docs/xml_results#chineseSearch).
352
353The default value for this parameter is 0 (zero), meaning that the feature
354is enabled. Supported values are:
355
356* `1`: Disabled
357
358* `0`: Enabled (default)
Bu Sun Kim65020912020-05-20 12:08:20 -0700359 x__xgafv: string, V1 error format.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700360 Allowed values
Bu Sun Kim65020912020-05-20 12:08:20 -0700361 1 - v1 error format
362 2 - v2 error format
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700363
364Returns:
365 An object of the form:
366
Bu Sun Kim65020912020-05-20 12:08:20 -0700367 { # Response to a custom search request.
368 &quot;queries&quot;: { # Query metadata for the previous, current, and next pages of results.
Bu Sun Kim65020912020-05-20 12:08:20 -0700369 &quot;request&quot;: [ # Metadata representing the current request.
370 { # Custom search request metadata.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700371 &quot;language&quot;: &quot;A String&quot;, # The language of the search results.
372 &quot;googleHost&quot;: &quot;A String&quot;, # Specifies the Google domain (for example, google.com, google.de, or
373 # google.fr) to which the search should be limited.
374 &quot;imgSize&quot;: &quot;A String&quot;, # Restricts results to images of a specified size. Supported values are:
375 #
376 # * `icon` (small)
377 #
378 # * `small | medium | large | xlarge` (medium)
379 #
380 # * `xxlarge` (large)
381 #
382 # * `huge` (extra-large)
383 &quot;filter&quot;: &quot;A String&quot;, # Activates or deactivates the automatic filtering of Google search
384 # results. See [Automatic
385 # Filtering](https://developers.google.com/custom-search/docs/xml_results#automaticFiltering)
386 # for more information about Google&#x27;s search results filters. Valid values
387 # for this parameter are:
388 #
389 # * `0`: Disabled
390 #
391 # * `1`: Enabled (default)
392 #
393 # **Note**: By default, Google applies filtering to all search results to
394 # improve the quality of those results.
395 &quot;imgDominantColor&quot;: &quot;A String&quot;, # Restricts results to images with a specific dominant color. Supported
396 # values are:
397 #
398 # * `red`
399 #
400 # * `orange`
401 #
402 # * `yellow`
403 #
404 # * `green`
405 #
406 # * `teal`
407 #
408 # * `blue`
409 #
410 # * `purple`
411 #
412 # * `pink`
413 #
414 # * `white`
415 #
416 # * `gray`
417 #
418 # * `black`
419 #
420 # * `brown`
421 &quot;title&quot;: &quot;A String&quot;, # A description of the query.
Bu Sun Kim65020912020-05-20 12:08:20 -0700422 &quot;disableCnTwTranslation&quot;: &quot;A String&quot;, # Enables or disables the [Simplified and Traditional Chinese
423 # Search](https://developers.google.com/custom-search/docs/xml_results#chineseSearch)
424 # feature.
425 #
426 # Supported values are:
427 #
428 # * `0`: enabled (default)
429 #
430 # * `1`: disabled
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700431 &quot;sort&quot;: &quot;A String&quot;, # Specifies that results should be sorted according to the specified
432 # expression. For example, sort by date.
433 &quot;startPage&quot;: 42, # The page number of this set of results, where the page length is set by
434 # the `count` property.
435 &quot;inputEncoding&quot;: &quot;A String&quot;, # The character encoding supported for search requests.
436 &quot;cx&quot;: &quot;A String&quot;, # The identifier of a custom search engine created using the Custom Search
437 # [Control Panel](https://cse.google.com/). This is a custom property not
438 # defined in the OpenSearch spec. This parameter is **required**.
439 &quot;gl&quot;: &quot;A String&quot;, # Boosts search results whose country of origin matches the parameter
440 # value. See [Country
441 # Codes](https://developers.google.com/custom-search/docs/xml_results#countryCodes)
442 # for a list of valid values.
443 #
444 # Specifying a `gl` parameter value in WebSearch requests should improve
445 # the relevance of results. This is particularly true for international
446 # customers and, even more specifically, for customers in English-speaking
447 # countries other than the United States.
448 &quot;excludeTerms&quot;: &quot;A String&quot;, # Identifies a word or phrase that should not appear in any documents in
449 # the search results.
450 &quot;outputEncoding&quot;: &quot;A String&quot;, # The character encoding supported for search results.
451 &quot;searchTerms&quot;: &quot;A String&quot;, # The search terms entered by the user.
452 &quot;highRange&quot;: &quot;A String&quot;, # Specifies the ending value for a search range. Use `cse:lowRange` and
453 # `cse:highrange` to append an inclusive search range of
454 # `lowRange...highRange` to the query.
455 &quot;siteSearch&quot;: &quot;A String&quot;, # Restricts results to URLs from a specified site.
456 &quot;hq&quot;: &quot;A String&quot;, # Appends the specified query terms to the query, as if they were combined
457 # with a logical `AND` operator.
458 &quot;count&quot;: 42, # Number of search results returned in this set.
459 &quot;relatedSite&quot;: &quot;A String&quot;, # Specifies that all search results should be pages that are related to the
460 # specified URL. The parameter value should be a URL.
461 &quot;hl&quot;: &quot;A String&quot;, # Specifies the interface language (host language) of your user interface.
462 # Explicitly setting this parameter improves the performance and the
463 # quality of your search results.
464 #
465 # See the [Interface
466 # Languages](https://developers.google.com/custom-search/docs/xml_results#wsInterfaceLanguages)
467 # section of [Internationalizing Queries and Results
468 # Presentation](https://developers.google.com/custom-search/docs/xml_results#wsInternationalizing)
469 # for more information, and [Supported Interface
470 # Languages](https://developers.google.com/custom-search/docs/xml_results_appendices#interfaceLanguages)
471 # for a list of supported languages.
472 &quot;totalResults&quot;: &quot;A String&quot;, # Estimated number of total search results. May not be accurate.
473 &quot;rights&quot;: &quot;A String&quot;, # Filters based on licensing. Supported values include:
474 #
475 # * `cc_publicdomain`
476 #
477 # * `cc_attribute`
478 #
479 # * `cc_sharealike`
480 #
481 # * `cc_noncommercial`
482 #
483 # * `cc_nonderived`
484 &quot;cr&quot;: &quot;A String&quot;, # Restricts search results to documents originating in a particular
485 # country. You may use [Boolean
486 # operators](https://developers.google.com/custom-search/docs/xml_results#booleanOperators)
487 # in the `cr` parameter&#x27;s value.
488 #
489 # Google WebSearch determines the country of a document by analyzing the
490 # following:
491 #
492 # * The top-level domain (TLD) of the document&#x27;s URL.
493 #
494 # * The geographic location of the web server&#x27;s IP address.
495 #
496 # See [Country (cr) Parameter
497 # Values](https://developers.google.com/custom-search/docs/xml_results#countryCollections)
498 # for a list of valid values for this parameter.
499 &quot;imgColorType&quot;: &quot;A String&quot;, # Restricts results to images of a specified color type. Supported values
500 # are:
501 #
502 # * `mono` (black and white)
503 #
504 # * `gray` (grayscale)
505 #
506 # * `color` (color)
507 &quot;safe&quot;: &quot;A String&quot;, # Specifies the [SafeSearch
508 # level](https://developers.google.com/custom-search/docs/xml_results#safeSearchLevels)
509 # used for filtering out adult results. This is a custom property not
510 # defined in the OpenSearch spec. Valid parameter values are:
511 #
512 # * `&quot;off&quot;`: Disable SafeSearch
513 #
514 # * `&quot;active&quot;`: Enable SafeSearch
515 &quot;dateRestrict&quot;: &quot;A String&quot;, # Restricts results to URLs based on date. Supported values include:
516 #
517 # * `d[number]`: requests results from the specified number of past days.
518 #
519 # * `w[number]`: requests results from the specified number of past weeks.
520 #
521 # * `m[number]`: requests results from the specified number of past months.
522 #
523 # * `y[number]`: requests results from the specified number of past years.
Bu Sun Kim65020912020-05-20 12:08:20 -0700524 &quot;fileType&quot;: &quot;A String&quot;, # Restricts results to files of a specified extension. Filetypes supported
525 # by Google include:
526 #
527 # * Adobe Portable Document Format (`pdf`)
528 #
529 # * Adobe PostScript (`ps`)
530 #
531 # * Lotus 1-2-3 (`wk1`, `wk2`, `wk3`, `wk4`, `wk5`, `wki`, `wks`, `wku`)
532 #
533 # * Lotus WordPro (`lwp`)
534 #
535 # * Macwrite (`mw`)
536 #
537 # * Microsoft Excel (`xls`)
538 #
539 # * Microsoft PowerPoint (`ppt`)
540 #
541 # * Microsoft Word (`doc`)
542 #
543 # * Microsoft Works (`wks`, `wps`, `wdb`)
544 #
545 # * Microsoft Write (`wri`)
546 #
547 # * Rich Text Format (`rtf`)
548 #
549 # * Shockwave Flash (`swf`)
550 #
551 # * Text (`ans`, `txt`).
552 #
553 # Additional filetypes may be added in the future. An up-to-date list can
554 # always be found in Google&#x27;s [file type
555 # FAQ](https://support.google.com/webmasters/answer/35287).
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700556 &quot;searchType&quot;: &quot;A String&quot;, # Allowed values are `web` or `image`. If unspecified, results are limited
557 # to webpages.
558 &quot;imgType&quot;: &quot;A String&quot;, # Restricts results to images of a specified type. Supported values are:
559 #
560 # * `clipart` (Clip art)
561 #
562 # * `face` (Face)
563 #
564 # * `lineart` (Line drawing)
565 #
566 # * `photo` (Photo)
567 #
568 # * `animated` (Animated)
569 #
570 # * `stock` (Stock)
571 &quot;linkSite&quot;: &quot;A String&quot;, # Specifies that all results should contain a link to a specific URL.
Bu Sun Kim65020912020-05-20 12:08:20 -0700572 &quot;siteSearchFilter&quot;: &quot;A String&quot;, # Specifies whether to include or exclude results from the site named in
573 # the `sitesearch` parameter. Supported values are:
574 #
575 # * `i`: include content from site
576 #
577 # * `e`: exclude content from site
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700578 &quot;startIndex&quot;: 42, # The index of the current set of search results into the total set of
579 # results, where the index of the first result is 1.
580 &quot;lowRange&quot;: &quot;A String&quot;, # Specifies the starting value for a search range. Use `cse:lowRange` and
581 # `cse:highrange` to append an inclusive search range of
582 # `lowRange...highRange` to the query.
583 &quot;exactTerms&quot;: &quot;A String&quot;, # Identifies a phrase that all documents in the search results must
584 # contain.
585 &quot;orTerms&quot;: &quot;A String&quot;, # Provides additional search terms to check for in a document, where each
586 # document in the search results must contain at least one of the
587 # additional search terms. You can also use the [Boolean
588 # OR](https://developers.google.com/custom-search/docs/xml_results#BooleanOrqt)
589 # query term for this type of query.
590 },
591 ],
592 &quot;nextPage&quot;: [ # Metadata representing the next page of results, if applicable.
593 { # Custom search request metadata.
Bu Sun Kim65020912020-05-20 12:08:20 -0700594 &quot;gl&quot;: &quot;A String&quot;, # Boosts search results whose country of origin matches the parameter
595 # value. See [Country
596 # Codes](https://developers.google.com/custom-search/docs/xml_results#countryCodes)
597 # for a list of valid values.
598 #
599 # Specifying a `gl` parameter value in WebSearch requests should improve
600 # the relevance of results. This is particularly true for international
601 # customers and, even more specifically, for customers in English-speaking
602 # countries other than the United States.
Bu Sun Kim65020912020-05-20 12:08:20 -0700603 &quot;safe&quot;: &quot;A String&quot;, # Specifies the [SafeSearch
604 # level](https://developers.google.com/custom-search/docs/xml_results#safeSearchLevels)
605 # used for filtering out adult results. This is a custom property not
606 # defined in the OpenSearch spec. Valid parameter values are:
607 #
608 # * `&quot;off&quot;`: Disable SafeSearch
609 #
610 # * `&quot;active&quot;`: Enable SafeSearch
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700611 &quot;language&quot;: &quot;A String&quot;, # The language of the search results.
Bu Sun Kim65020912020-05-20 12:08:20 -0700612 &quot;hl&quot;: &quot;A String&quot;, # Specifies the interface language (host language) of your user interface.
613 # Explicitly setting this parameter improves the performance and the
614 # quality of your search results.
615 #
616 # See the [Interface
617 # Languages](https://developers.google.com/custom-search/docs/xml_results#wsInterfaceLanguages)
618 # section of [Internationalizing Queries and Results
619 # Presentation](https://developers.google.com/custom-search/docs/xml_results#wsInternationalizing)
620 # for more information, and [Supported Interface
621 # Languages](https://developers.google.com/custom-search/docs/xml_results_appendices#interfaceLanguages)
622 # for a list of supported languages.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700623 &quot;excludeTerms&quot;: &quot;A String&quot;, # Identifies a word or phrase that should not appear in any documents in
624 # the search results.
Bu Sun Kim65020912020-05-20 12:08:20 -0700625 &quot;filter&quot;: &quot;A String&quot;, # Activates or deactivates the automatic filtering of Google search
626 # results. See [Automatic
627 # Filtering](https://developers.google.com/custom-search/docs/xml_results#automaticFiltering)
628 # for more information about Google&#x27;s search results filters. Valid values
629 # for this parameter are:
630 #
631 # * `0`: Disabled
632 #
633 # * `1`: Enabled (default)
634 #
635 # **Note**: By default, Google applies filtering to all search results to
636 # improve the quality of those results.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700637 &quot;title&quot;: &quot;A String&quot;, # A description of the query.
638 &quot;dateRestrict&quot;: &quot;A String&quot;, # Restricts results to URLs based on date. Supported values include:
639 #
640 # * `d[number]`: requests results from the specified number of past days.
641 #
642 # * `w[number]`: requests results from the specified number of past weeks.
643 #
644 # * `m[number]`: requests results from the specified number of past months.
645 #
646 # * `y[number]`: requests results from the specified number of past years.
647 &quot;highRange&quot;: &quot;A String&quot;, # Specifies the ending value for a search range. Use `cse:lowRange` and
648 # `cse:highrange` to append an inclusive search range of
649 # `lowRange...highRange` to the query.
Bu Sun Kim65020912020-05-20 12:08:20 -0700650 &quot;sort&quot;: &quot;A String&quot;, # Specifies that results should be sorted according to the specified
651 # expression. For example, sort by date.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700652 &quot;relatedSite&quot;: &quot;A String&quot;, # Specifies that all search results should be pages that are related to the
653 # specified URL. The parameter value should be a URL.
654 &quot;orTerms&quot;: &quot;A String&quot;, # Provides additional search terms to check for in a document, where each
655 # document in the search results must contain at least one of the
656 # additional search terms. You can also use the [Boolean
657 # OR](https://developers.google.com/custom-search/docs/xml_results#BooleanOrqt)
658 # query term for this type of query.
659 &quot;searchTerms&quot;: &quot;A String&quot;, # The search terms entered by the user.
660 &quot;outputEncoding&quot;: &quot;A String&quot;, # The character encoding supported for search results.
661 &quot;imgType&quot;: &quot;A String&quot;, # Restricts results to images of a specified type. Supported values are:
Bu Sun Kim65020912020-05-20 12:08:20 -0700662 #
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700663 # * `clipart` (Clip art)
Bu Sun Kim65020912020-05-20 12:08:20 -0700664 #
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700665 # * `face` (Face)
Bu Sun Kim65020912020-05-20 12:08:20 -0700666 #
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700667 # * `lineart` (Line drawing)
Bu Sun Kim65020912020-05-20 12:08:20 -0700668 #
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700669 # * `photo` (Photo)
670 #
671 # * `animated` (Animated)
672 #
673 # * `stock` (Stock)
Bu Sun Kim65020912020-05-20 12:08:20 -0700674 &quot;imgDominantColor&quot;: &quot;A String&quot;, # Restricts results to images with a specific dominant color. Supported
675 # values are:
676 #
677 # * `red`
678 #
679 # * `orange`
680 #
681 # * `yellow`
682 #
683 # * `green`
684 #
685 # * `teal`
686 #
687 # * `blue`
688 #
689 # * `purple`
690 #
691 # * `pink`
692 #
693 # * `white`
694 #
695 # * `gray`
696 #
697 # * `black`
698 #
699 # * `brown`
Bu Sun Kim65020912020-05-20 12:08:20 -0700700 &quot;hq&quot;: &quot;A String&quot;, # Appends the specified query terms to the query, as if they were combined
701 # with a logical `AND` operator.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700702 &quot;count&quot;: 42, # Number of search results returned in this set.
703 &quot;startPage&quot;: 42, # The page number of this set of results, where the page length is set by
704 # the `count` property.
705 &quot;startIndex&quot;: 42, # The index of the current set of search results into the total set of
706 # results, where the index of the first result is 1.
707 &quot;cx&quot;: &quot;A String&quot;, # The identifier of a custom search engine created using the Custom Search
708 # [Control Panel](https://cse.google.com/). This is a custom property not
709 # defined in the OpenSearch spec. This parameter is **required**.
710 &quot;exactTerms&quot;: &quot;A String&quot;, # Identifies a phrase that all documents in the search results must
711 # contain.
712 &quot;linkSite&quot;: &quot;A String&quot;, # Specifies that all results should contain a link to a specific URL.
713 &quot;imgColorType&quot;: &quot;A String&quot;, # Restricts results to images of a specified color type. Supported values
714 # are:
Bu Sun Kim65020912020-05-20 12:08:20 -0700715 #
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700716 # * `mono` (black and white)
Bu Sun Kim65020912020-05-20 12:08:20 -0700717 #
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700718 # * `gray` (grayscale)
Bu Sun Kim65020912020-05-20 12:08:20 -0700719 #
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700720 # * `color` (color)
721 &quot;siteSearchFilter&quot;: &quot;A String&quot;, # Specifies whether to include or exclude results from the site named in
722 # the `sitesearch` parameter. Supported values are:
Bu Sun Kim65020912020-05-20 12:08:20 -0700723 #
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700724 # * `i`: include content from site
Bu Sun Kim65020912020-05-20 12:08:20 -0700725 #
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700726 # * `e`: exclude content from site
727 &quot;inputEncoding&quot;: &quot;A String&quot;, # The character encoding supported for search requests.
728 &quot;cr&quot;: &quot;A String&quot;, # Restricts search results to documents originating in a particular
729 # country. You may use [Boolean
730 # operators](https://developers.google.com/custom-search/docs/xml_results#booleanOperators)
731 # in the `cr` parameter&#x27;s value.
Bu Sun Kim65020912020-05-20 12:08:20 -0700732 #
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700733 # Google WebSearch determines the country of a document by analyzing the
734 # following:
735 #
736 # * The top-level domain (TLD) of the document&#x27;s URL.
737 #
738 # * The geographic location of the web server&#x27;s IP address.
739 #
740 # See [Country (cr) Parameter
741 # Values](https://developers.google.com/custom-search/docs/xml_results#countryCollections)
742 # for a list of valid values for this parameter.
743 &quot;rights&quot;: &quot;A String&quot;, # Filters based on licensing. Supported values include:
744 #
745 # * `cc_publicdomain`
746 #
747 # * `cc_attribute`
748 #
749 # * `cc_sharealike`
750 #
751 # * `cc_noncommercial`
752 #
753 # * `cc_nonderived`
754 &quot;imgSize&quot;: &quot;A String&quot;, # Restricts results to images of a specified size. Supported values are:
755 #
756 # * `icon` (small)
757 #
758 # * `small | medium | large | xlarge` (medium)
759 #
760 # * `xxlarge` (large)
761 #
762 # * `huge` (extra-large)
763 &quot;siteSearch&quot;: &quot;A String&quot;, # Restricts results to URLs from a specified site.
764 &quot;disableCnTwTranslation&quot;: &quot;A String&quot;, # Enables or disables the [Simplified and Traditional Chinese
765 # Search](https://developers.google.com/custom-search/docs/xml_results#chineseSearch)
766 # feature.
767 #
768 # Supported values are:
769 #
770 # * `0`: enabled (default)
771 #
772 # * `1`: disabled
773 &quot;searchType&quot;: &quot;A String&quot;, # Allowed values are `web` or `image`. If unspecified, results are limited
774 # to webpages.
775 &quot;lowRange&quot;: &quot;A String&quot;, # Specifies the starting value for a search range. Use `cse:lowRange` and
776 # `cse:highrange` to append an inclusive search range of
777 # `lowRange...highRange` to the query.
778 &quot;googleHost&quot;: &quot;A String&quot;, # Specifies the Google domain (for example, google.com, google.de, or
779 # google.fr) to which the search should be limited.
780 &quot;fileType&quot;: &quot;A String&quot;, # Restricts results to files of a specified extension. Filetypes supported
781 # by Google include:
782 #
783 # * Adobe Portable Document Format (`pdf`)
784 #
785 # * Adobe PostScript (`ps`)
786 #
787 # * Lotus 1-2-3 (`wk1`, `wk2`, `wk3`, `wk4`, `wk5`, `wki`, `wks`, `wku`)
788 #
789 # * Lotus WordPro (`lwp`)
790 #
791 # * Macwrite (`mw`)
792 #
793 # * Microsoft Excel (`xls`)
794 #
795 # * Microsoft PowerPoint (`ppt`)
796 #
797 # * Microsoft Word (`doc`)
798 #
799 # * Microsoft Works (`wks`, `wps`, `wdb`)
800 #
801 # * Microsoft Write (`wri`)
802 #
803 # * Rich Text Format (`rtf`)
804 #
805 # * Shockwave Flash (`swf`)
806 #
807 # * Text (`ans`, `txt`).
808 #
809 # Additional filetypes may be added in the future. An up-to-date list can
810 # always be found in Google&#x27;s [file type
811 # FAQ](https://support.google.com/webmasters/answer/35287).
Bu Sun Kim65020912020-05-20 12:08:20 -0700812 &quot;totalResults&quot;: &quot;A String&quot;, # Estimated number of total search results. May not be accurate.
813 },
814 ],
815 &quot;previousPage&quot;: [ # Metadata representing the previous page of results, if applicable.
816 { # Custom search request metadata.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700817 &quot;safe&quot;: &quot;A String&quot;, # Specifies the [SafeSearch
818 # level](https://developers.google.com/custom-search/docs/xml_results#safeSearchLevels)
819 # used for filtering out adult results. This is a custom property not
820 # defined in the OpenSearch spec. Valid parameter values are:
Bu Sun Kim65020912020-05-20 12:08:20 -0700821 #
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700822 # * `&quot;off&quot;`: Disable SafeSearch
Bu Sun Kim65020912020-05-20 12:08:20 -0700823 #
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700824 # * `&quot;active&quot;`: Enable SafeSearch
825 &quot;rights&quot;: &quot;A String&quot;, # Filters based on licensing. Supported values include:
Bu Sun Kim65020912020-05-20 12:08:20 -0700826 #
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700827 # * `cc_publicdomain`
Bu Sun Kim65020912020-05-20 12:08:20 -0700828 #
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700829 # * `cc_attribute`
Bu Sun Kim65020912020-05-20 12:08:20 -0700830 #
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700831 # * `cc_sharealike`
Bu Sun Kim65020912020-05-20 12:08:20 -0700832 #
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700833 # * `cc_noncommercial`
Bu Sun Kim65020912020-05-20 12:08:20 -0700834 #
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700835 # * `cc_nonderived`
Bu Sun Kim65020912020-05-20 12:08:20 -0700836 &quot;googleHost&quot;: &quot;A String&quot;, # Specifies the Google domain (for example, google.com, google.de, or
837 # google.fr) to which the search should be limited.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700838 &quot;sort&quot;: &quot;A String&quot;, # Specifies that results should be sorted according to the specified
839 # expression. For example, sort by date.
840 &quot;orTerms&quot;: &quot;A String&quot;, # Provides additional search terms to check for in a document, where each
841 # document in the search results must contain at least one of the
842 # additional search terms. You can also use the [Boolean
843 # OR](https://developers.google.com/custom-search/docs/xml_results#BooleanOrqt)
844 # query term for this type of query.
Bu Sun Kim65020912020-05-20 12:08:20 -0700845 &quot;startIndex&quot;: 42, # The index of the current set of search results into the total set of
846 # results, where the index of the first result is 1.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700847 &quot;startPage&quot;: 42, # The page number of this set of results, where the page length is set by
848 # the `count` property.
849 &quot;searchType&quot;: &quot;A String&quot;, # Allowed values are `web` or `image`. If unspecified, results are limited
850 # to webpages.
Bu Sun Kim65020912020-05-20 12:08:20 -0700851 &quot;fileType&quot;: &quot;A String&quot;, # Restricts results to files of a specified extension. Filetypes supported
852 # by Google include:
853 #
854 # * Adobe Portable Document Format (`pdf`)
855 #
856 # * Adobe PostScript (`ps`)
857 #
858 # * Lotus 1-2-3 (`wk1`, `wk2`, `wk3`, `wk4`, `wk5`, `wki`, `wks`, `wku`)
859 #
860 # * Lotus WordPro (`lwp`)
861 #
862 # * Macwrite (`mw`)
863 #
864 # * Microsoft Excel (`xls`)
865 #
866 # * Microsoft PowerPoint (`ppt`)
867 #
868 # * Microsoft Word (`doc`)
869 #
870 # * Microsoft Works (`wks`, `wps`, `wdb`)
871 #
872 # * Microsoft Write (`wri`)
873 #
874 # * Rich Text Format (`rtf`)
875 #
876 # * Shockwave Flash (`swf`)
877 #
878 # * Text (`ans`, `txt`).
879 #
880 # Additional filetypes may be added in the future. An up-to-date list can
881 # always be found in Google&#x27;s [file type
882 # FAQ](https://support.google.com/webmasters/answer/35287).
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700883 &quot;imgSize&quot;: &quot;A String&quot;, # Restricts results to images of a specified size. Supported values are:
Bu Sun Kim65020912020-05-20 12:08:20 -0700884 #
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700885 # * `icon` (small)
Bu Sun Kim65020912020-05-20 12:08:20 -0700886 #
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700887 # * `small | medium | large | xlarge` (medium)
Bu Sun Kim65020912020-05-20 12:08:20 -0700888 #
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700889 # * `xxlarge` (large)
Bu Sun Kim65020912020-05-20 12:08:20 -0700890 #
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700891 # * `huge` (extra-large)
Bu Sun Kim65020912020-05-20 12:08:20 -0700892 &quot;cr&quot;: &quot;A String&quot;, # Restricts search results to documents originating in a particular
893 # country. You may use [Boolean
894 # operators](https://developers.google.com/custom-search/docs/xml_results#booleanOperators)
895 # in the `cr` parameter&#x27;s value.
896 #
897 # Google WebSearch determines the country of a document by analyzing the
898 # following:
899 #
900 # * The top-level domain (TLD) of the document&#x27;s URL.
901 #
902 # * The geographic location of the web server&#x27;s IP address.
903 #
904 # See [Country (cr) Parameter
905 # Values](https://developers.google.com/custom-search/docs/xml_results#countryCollections)
906 # for a list of valid values for this parameter.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700907 &quot;disableCnTwTranslation&quot;: &quot;A String&quot;, # Enables or disables the [Simplified and Traditional Chinese
908 # Search](https://developers.google.com/custom-search/docs/xml_results#chineseSearch)
909 # feature.
910 #
911 # Supported values are:
912 #
913 # * `0`: enabled (default)
914 #
915 # * `1`: disabled
916 &quot;imgColorType&quot;: &quot;A String&quot;, # Restricts results to images of a specified color type. Supported values
917 # are:
918 #
919 # * `mono` (black and white)
920 #
921 # * `gray` (grayscale)
922 #
923 # * `color` (color)
924 &quot;highRange&quot;: &quot;A String&quot;, # Specifies the ending value for a search range. Use `cse:lowRange` and
925 # `cse:highrange` to append an inclusive search range of
926 # `lowRange...highRange` to the query.
927 &quot;excludeTerms&quot;: &quot;A String&quot;, # Identifies a word or phrase that should not appear in any documents in
928 # the search results.
929 &quot;count&quot;: 42, # Number of search results returned in this set.
930 &quot;title&quot;: &quot;A String&quot;, # A description of the query.
931 &quot;searchTerms&quot;: &quot;A String&quot;, # The search terms entered by the user.
932 &quot;filter&quot;: &quot;A String&quot;, # Activates or deactivates the automatic filtering of Google search
933 # results. See [Automatic
934 # Filtering](https://developers.google.com/custom-search/docs/xml_results#automaticFiltering)
935 # for more information about Google&#x27;s search results filters. Valid values
936 # for this parameter are:
937 #
938 # * `0`: Disabled
939 #
940 # * `1`: Enabled (default)
941 #
942 # **Note**: By default, Google applies filtering to all search results to
943 # improve the quality of those results.
944 &quot;language&quot;: &quot;A String&quot;, # The language of the search results.
945 &quot;lowRange&quot;: &quot;A String&quot;, # Specifies the starting value for a search range. Use `cse:lowRange` and
946 # `cse:highrange` to append an inclusive search range of
947 # `lowRange...highRange` to the query.
948 &quot;imgType&quot;: &quot;A String&quot;, # Restricts results to images of a specified type. Supported values are:
949 #
950 # * `clipart` (Clip art)
951 #
952 # * `face` (Face)
953 #
954 # * `lineart` (Line drawing)
955 #
956 # * `photo` (Photo)
957 #
958 # * `animated` (Animated)
959 #
960 # * `stock` (Stock)
961 &quot;hl&quot;: &quot;A String&quot;, # Specifies the interface language (host language) of your user interface.
962 # Explicitly setting this parameter improves the performance and the
963 # quality of your search results.
964 #
965 # See the [Interface
966 # Languages](https://developers.google.com/custom-search/docs/xml_results#wsInterfaceLanguages)
967 # section of [Internationalizing Queries and Results
968 # Presentation](https://developers.google.com/custom-search/docs/xml_results#wsInternationalizing)
969 # for more information, and [Supported Interface
970 # Languages](https://developers.google.com/custom-search/docs/xml_results_appendices#interfaceLanguages)
971 # for a list of supported languages.
972 &quot;outputEncoding&quot;: &quot;A String&quot;, # The character encoding supported for search results.
973 &quot;gl&quot;: &quot;A String&quot;, # Boosts search results whose country of origin matches the parameter
974 # value. See [Country
975 # Codes](https://developers.google.com/custom-search/docs/xml_results#countryCodes)
976 # for a list of valid values.
977 #
978 # Specifying a `gl` parameter value in WebSearch requests should improve
979 # the relevance of results. This is particularly true for international
980 # customers and, even more specifically, for customers in English-speaking
981 # countries other than the United States.
982 &quot;siteSearch&quot;: &quot;A String&quot;, # Restricts results to URLs from a specified site.
983 &quot;hq&quot;: &quot;A String&quot;, # Appends the specified query terms to the query, as if they were combined
984 # with a logical `AND` operator.
985 &quot;siteSearchFilter&quot;: &quot;A String&quot;, # Specifies whether to include or exclude results from the site named in
986 # the `sitesearch` parameter. Supported values are:
987 #
988 # * `i`: include content from site
989 #
990 # * `e`: exclude content from site
991 &quot;relatedSite&quot;: &quot;A String&quot;, # Specifies that all search results should be pages that are related to the
992 # specified URL. The parameter value should be a URL.
993 &quot;linkSite&quot;: &quot;A String&quot;, # Specifies that all results should contain a link to a specific URL.
994 &quot;totalResults&quot;: &quot;A String&quot;, # Estimated number of total search results. May not be accurate.
995 &quot;dateRestrict&quot;: &quot;A String&quot;, # Restricts results to URLs based on date. Supported values include:
996 #
997 # * `d[number]`: requests results from the specified number of past days.
998 #
999 # * `w[number]`: requests results from the specified number of past weeks.
1000 #
1001 # * `m[number]`: requests results from the specified number of past months.
1002 #
1003 # * `y[number]`: requests results from the specified number of past years.
1004 &quot;imgDominantColor&quot;: &quot;A String&quot;, # Restricts results to images with a specific dominant color. Supported
1005 # values are:
1006 #
1007 # * `red`
1008 #
1009 # * `orange`
1010 #
1011 # * `yellow`
1012 #
1013 # * `green`
1014 #
1015 # * `teal`
1016 #
1017 # * `blue`
1018 #
1019 # * `purple`
1020 #
1021 # * `pink`
1022 #
1023 # * `white`
1024 #
1025 # * `gray`
1026 #
1027 # * `black`
1028 #
1029 # * `brown`
1030 &quot;exactTerms&quot;: &quot;A String&quot;, # Identifies a phrase that all documents in the search results must
1031 # contain.
1032 &quot;inputEncoding&quot;: &quot;A String&quot;, # The character encoding supported for search requests.
1033 &quot;cx&quot;: &quot;A String&quot;, # The identifier of a custom search engine created using the Custom Search
1034 # [Control Panel](https://cse.google.com/). This is a custom property not
1035 # defined in the OpenSearch spec. This parameter is **required**.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001036 },
1037 ],
1038 },
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -07001039 &quot;url&quot;: { # OpenSearch template and URL.
1040 &quot;type&quot;: &quot;A String&quot;, # The MIME type of the OpenSearch URL template for the Custom Search API.
1041 &quot;template&quot;: &quot;A String&quot;, # The actual [OpenSearch
1042 # template](http://www.opensearch.org/specifications/opensearch/1.1#opensearch_url_template_syntax)
1043 # for this API.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001044 },
Bu Sun Kim65020912020-05-20 12:08:20 -07001045 &quot;context&quot;: { # Metadata and refinements associated with the given search engine,
1046 # including:
1047 #
1048 # * The name of the search engine that was used for the query.
1049 #
1050 # * A set of [facet
1051 # objects](https://developers.google.com/custom-search/docs/refinements#create)
1052 # (refinements) you can use for refining a search.
1053 &quot;a_key&quot;: &quot;&quot;, # Properties of the object.
1054 },
Bu Sun Kim65020912020-05-20 12:08:20 -07001055 &quot;kind&quot;: &quot;A String&quot;, # Unique identifier for the type of current object. For this API, it is
1056 # customsearch#search.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -07001057 &quot;promotions&quot;: [ # The set of
1058 # [promotions](https://developers.google.com/custom-search/docs/promotions).
1059 # Present only if the custom search engine&#x27;s configuration files define any
1060 # promotions for the given query.
1061 { # Promotion result.
1062 &quot;title&quot;: &quot;A String&quot;, # The title of the promotion.
1063 &quot;htmlTitle&quot;: &quot;A String&quot;, # The title of the promotion, in HTML.
1064 &quot;link&quot;: &quot;A String&quot;, # The URL of the promotion.
1065 &quot;displayLink&quot;: &quot;A String&quot;, # An abridged version of this search&#x27;s result URL, e.g. www.example.com.
1066 &quot;bodyLines&quot;: [ # An array of block objects for this promotion. See [Google WebSearch
1067 # Protocol
1068 # reference](https://developers.google.com/custom-search/docs/xml_results)
1069 # for more information.
1070 { # Block object belonging to a promotion.
1071 &quot;title&quot;: &quot;A String&quot;, # The block object&#x27;s text, if it has text.
1072 &quot;htmlTitle&quot;: &quot;A String&quot;, # The block object&#x27;s text in HTML, if it has text.
1073 &quot;url&quot;: &quot;A String&quot;, # The URL of the block object&#x27;s link, if it has one.
1074 &quot;link&quot;: &quot;A String&quot;, # The anchor text of the block object&#x27;s link, if it has a link.
1075 },
1076 ],
1077 &quot;image&quot;: { # Image belonging to a promotion.
1078 &quot;source&quot;: &quot;A String&quot;, # URL of the image for this promotion link.
1079 &quot;height&quot;: 42, # Image height in pixels.
1080 &quot;width&quot;: 42, # Image width in pixels.
1081 },
1082 },
1083 ],
1084 &quot;searchInformation&quot;: { # Metadata about a search operation.
1085 &quot;totalResults&quot;: &quot;A String&quot;, # The total number of search results returned by the query.
1086 &quot;formattedTotalResults&quot;: &quot;A String&quot;, # The total number of search results, formatted according to locale style.
1087 &quot;formattedSearchTime&quot;: &quot;A String&quot;, # The time taken for the server to return search results, formatted
1088 # according to locale style.
1089 &quot;searchTime&quot;: 3.14, # The time taken for the server to return search results.
1090 },
1091 &quot;items&quot;: [ # The current set of custom search results.
1092 { # A custom search result.
1093 &quot;fileFormat&quot;: &quot;A String&quot;, # The file format of the search result.
1094 &quot;image&quot;: { # Image belonging to a custom search result.
1095 &quot;thumbnailWidth&quot;: 42, # The width of the thumbnail image, in pixels.
1096 &quot;width&quot;: 42, # The width of the image, in pixels.
1097 &quot;contextLink&quot;: &quot;A String&quot;, # A URL pointing to the webpage hosting the image.
1098 &quot;byteSize&quot;: 42, # The size of the image, in pixels.
1099 &quot;thumbnailHeight&quot;: 42, # The height of the thumbnail image, in pixels.
1100 &quot;height&quot;: 42, # The height of the image, in pixels.
1101 &quot;thumbnailLink&quot;: &quot;A String&quot;, # A URL to the thumbnail image.
1102 },
1103 &quot;formattedUrl&quot;: &quot;A String&quot;, # The URL displayed after the snippet for each search result.
1104 &quot;mime&quot;: &quot;A String&quot;, # The MIME type of the search result.
1105 &quot;displayLink&quot;: &quot;A String&quot;, # An abridged version of this search result’s URL, e.g. www.example.com.
1106 &quot;cacheId&quot;: &quot;A String&quot;, # Indicates the ID of Google&#x27;s cached version of the search result.
1107 &quot;htmlTitle&quot;: &quot;A String&quot;, # The title of the search result, in HTML.
1108 &quot;snippet&quot;: &quot;A String&quot;, # The snippet of the search result, in plain text.
1109 &quot;labels&quot;: [ # Encapsulates all information about [refinement
1110 # labels](https://developers.google.com/custom-search/docs/xml_results).
1111 { # Refinement label associated with a custom search result.
1112 &quot;displayName&quot;: &quot;A String&quot;, # The display name of a refinement label. This is the name you should
1113 # display in your user interface.
1114 &quot;name&quot;: &quot;A String&quot;, # The name of a refinement label, which you can use to refine searches.
1115 # Don&#x27;t display this in your user interface; instead, use displayName.
1116 &quot;label_with_op&quot;: &quot;A String&quot;, # Refinement label and the associated refinement operation.
1117 },
1118 ],
1119 &quot;title&quot;: &quot;A String&quot;, # The title of the search result, in plain text.
1120 &quot;link&quot;: &quot;A String&quot;, # The full URL to which the search result is pointing, e.g.
1121 # http://www.example.com/foo/bar.
1122 &quot;htmlSnippet&quot;: &quot;A String&quot;, # The snippet of the search result, in HTML.
1123 &quot;htmlFormattedUrl&quot;: &quot;A String&quot;, # The HTML-formatted URL displayed after the snippet for each search result.
1124 &quot;kind&quot;: &quot;A String&quot;, # A unique identifier for the type of current object. For this API, it is
1125 # `customsearch#result.`
1126 &quot;pagemap&quot;: { # Contains
1127 # [PageMap](https://developers.google.com/custom-search/docs/structured_data#pagemaps)
1128 # information for this search result.
1129 &quot;a_key&quot;: &quot;&quot;, # Properties of the object.
1130 },
1131 },
1132 ],
1133 &quot;spelling&quot;: { # Spell correction information for a query.
1134 &quot;correctedQuery&quot;: &quot;A String&quot;, # The corrected query.
1135 &quot;htmlCorrectedQuery&quot;: &quot;A String&quot;, # The corrected query, formatted in HTML.
1136 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001137 }</pre>
1138</div>
1139
1140</body></html>