@maxim_mazurok/gapi.client.customsearch-v1 0.0.20231127 → 0.0.20231128

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (6) hide show
  1. package/index.d.ts +538 -1055
  2. package/package.json +6 -6
  3. package/readme.md +8 -8
  4. package/tests.ts +0 -86
  5. package/tsconfig.json +0 -18
  6. package/tslint.json +0 -6
package/index.d.ts CHANGED
@@ -9,1065 +9,548 @@
9
9
  // This file was generated by https://github.com/Maxim-Mazurok/google-api-typings-generator. Please do not edit it manually.
10
10
  // In case of any problems please post issue to https://github.com/Maxim-Mazurok/google-api-typings-generator
11
11
  // Generated from: https://customsearch.googleapis.com/$discovery/rest?version=v1
12
- // Revision: 20231127
12
+ // Revision: 20231128
13
13
 
14
14
  /// <reference types="gapi.client" />
15
15
 
16
16
  declare namespace gapi.client {
17
- /** Load Custom Search API v1 */
18
- function load(urlOrObject: "https://customsearch.googleapis.com/$discovery/rest?version=v1"): Promise<void>;
19
- /** @deprecated Please load APIs with discovery documents. */
20
- function load(name: "customsearch", version: "v1"): Promise<void>;
21
- /** @deprecated Please load APIs with discovery documents. */
22
- function load(name: "customsearch", version: "v1", callback: () => any): void;
17
+ /** Load Custom Search API v1 */
18
+ function load(
19
+ urlOrObject: 'https://customsearch.googleapis.com/$discovery/rest?version=v1'
20
+ ): Promise<void>;
21
+ /** @deprecated Please load APIs with discovery documents. */
22
+ function load(name: 'customsearch', version: 'v1'): Promise<void>;
23
+ /** @deprecated Please load APIs with discovery documents. */
24
+ function load(name: 'customsearch', version: 'v1', callback: () => any): void;
23
25
 
24
- namespace search {
25
- interface Promotion {
26
- /** An array of block objects for this promotion. */
27
- bodyLines?:
28
- Array<{
29
- /** The block object's text in HTML, if it has text. */
30
- htmlTitle?:
31
- string;
32
- /** The anchor text of the block object's link, if it has a link. */
33
- link?:
34
- string;
35
- /** The block object's text, if it has text. */
36
- title?:
37
- string;
38
- /** The URL of the block object's link, if it has one. */
39
- url?:
40
- string;
41
- }>;
42
- /** An abridged version of this search's result URL, e.g. www.example.com. */
43
- displayLink?:
44
- string;
45
- /** The title of the promotion, in HTML. */
46
- htmlTitle?:
47
- string;
48
- /** Image belonging to a promotion. */
49
- image?:
50
- {
51
- /** Image height in pixels. */
52
- height?:
53
- number;
54
- /** URL of the image for this promotion link. */
55
- source?:
56
- string;
57
- /** Image width in pixels. */
58
- width?:
59
- number;
60
- };
61
- /** The URL of the promotion. */
62
- link?:
63
- string;
64
- /** The title of the promotion. */
65
- title?:
66
- string;
67
- }
68
- interface Result {
69
- /** Indicates the ID of Google's cached version of the search result. */
70
- cacheId?:
71
- string;
72
- /** An abridged version of this search result’s URL, e.g. www.example.com. */
73
- displayLink?:
74
- string;
75
- /** The file format of the search result. */
76
- fileFormat?:
77
- string;
78
- /** The URL displayed after the snippet for each search result. */
79
- formattedUrl?:
80
- string;
81
- /** The HTML-formatted URL displayed after the snippet for each search result. */
82
- htmlFormattedUrl?:
83
- string;
84
- /** The snippet of the search result, in HTML. */
85
- htmlSnippet?:
86
- string;
87
- /** The title of the search result, in HTML. */
88
- htmlTitle?:
89
- string;
90
- /** Image belonging to a custom search result. */
91
- image?:
92
- {
93
- /** The size of the image, in bytes. */
94
- byteSize?:
95
- number;
96
- /** A URL pointing to the webpage hosting the image. */
97
- contextLink?:
98
- string;
99
- /** The height of the image, in pixels. */
100
- height?:
101
- number;
102
- /** The height of the thumbnail image, in pixels. */
103
- thumbnailHeight?:
104
- number;
105
- /** A URL to the thumbnail image. */
106
- thumbnailLink?:
107
- string;
108
- /** The width of the thumbnail image, in pixels. */
109
- thumbnailWidth?:
110
- number;
111
- /** The width of the image, in pixels. */
112
- width?:
113
- number;
114
- };
115
- /** A unique identifier for the type of current object. For this API, it is `customsearch#result.` */
116
- kind?:
117
- string;
118
- /** Encapsulates all information about refinement labels. */
119
- labels?:
120
- Array<{
121
- /** The display name of a refinement label. This is the name you should display in your user interface. */
122
- displayName?:
123
- string;
124
- /** Refinement label and the associated refinement operation. */
125
- label_with_op?:
126
- string;
127
- /** The name of a refinement label, which you can use to refine searches. Don't display this in your user interface; instead, use displayName. */
128
- name?:
129
- string;
130
- }>;
131
- /** The full URL to which the search result is pointing, e.g. http://www.example.com/foo/bar. */
132
- link?:
133
- string;
134
- /** The MIME type of the search result. */
135
- mime?:
136
- string;
137
- /** Contains [PageMap](https://developers.google.com/custom-search/docs/structured_data#pagemaps) information for this search result. */
138
- pagemap?:
139
- { [P in string]: any };
140
- /** The snippet of the search result, in plain text. */
141
- snippet?:
142
- string;
143
- /** The title of the search result, in plain text. */
144
- title?:
145
- string;
146
- }
147
- interface Search {
148
- /**
149
- * 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
150
- * objects](https://developers.google.com/custom-search/docs/refinements#create) (refinements) you can use for refining a search.
151
- */
152
- context?:
153
- { [P in string]: any };
154
- /** The current set of custom search results. */
155
- items?:
156
- Result[];
157
- /** Unique identifier for the type of current object. For this API, it is customsearch#search. */
158
- kind?:
159
- string;
160
- /**
161
- * 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
162
- * given query.
163
- */
164
- promotions?:
165
- Promotion[];
166
- /** Query metadata for the previous, current, and next pages of results. */
167
- queries?:
168
- {
169
- /** Metadata representing the next page of results, if applicable. */
170
- nextPage?:
171
- Array<{
172
- /** Number of search results returned in this set. */
173
- count?:
174
- number;
175
- /**
176
- * Restricts search results to documents originating in a particular country. You may use [Boolean
177
- * operators](https://developers.google.com/custom-search/docs/json_api_reference#BooleanOrSearch) in the `cr` parameter's value. Google WebSearch determines the
178
- * 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
179
- * [Country (cr) Parameter Values](https://developers.google.com/custom-search/docs/json_api_reference#countryCollections) for a list of valid values for this
180
- * parameter.
181
- */
182
- cr?:
183
- string;
184
- /**
185
- * The identifier of an engine created using the Programmable Search Engine [Control Panel](https://programmablesearchengine.google.com/). This is a custom property not
186
- * defined in the OpenSearch spec. This parameter is **required**.
187
- */
188
- cx?:
189
- string;
190
- /**
191
- * Restricts results to URLs based on date. Supported values include: * `d[number]`: requests results from the specified number of past days. * `w[number]`: requests
192
- * 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
193
- * specified number of past years.
194
- */
195
- dateRestrict?:
196
- string;
197
- /**
198
- * Enables or disables the [Simplified and Traditional Chinese Search](https://developers.google.com/custom-search/docs/json_api_reference#chineseSearch) feature.
199
- * Supported values are: * `0`: enabled (default) * `1`: disabled
200
- */
201
- disableCnTwTranslation?:
202
- string;
203
- /** Identifies a phrase that all documents in the search results must contain. */
204
- exactTerms?:
205
- string;
206
- /** Identifies a word or phrase that should not appear in any documents in the search results. */
207
- excludeTerms?:
208
- string;
209
- /**
210
- * Restricts results to files of a specified extension. Filetypes supported by Google include: * Adobe Portable Document Format (`pdf`) * Adobe PostScript (`ps`) *
211
- * Lotus 1-2-3 (`wk1`, `wk2`, `wk3`, `wk4`, `wk5`, `wki`, `wks`, `wku`) * Lotus WordPro (`lwp`) * Macwrite (`mw`) * Microsoft Excel (`xls`) * Microsoft PowerPoint
212
- * (`ppt`) * Microsoft Word (`doc`) * Microsoft Works (`wks`, `wps`, `wdb`) * Microsoft Write (`wri`) * Rich Text Format (`rtf`) * Shockwave Flash (`swf`) * Text
213
- * (`ans`, `txt`). Additional filetypes may be added in the future. An up-to-date list can always be found in Google's [file type
214
- * FAQ](https://support.google.com/webmasters/answer/35287).
215
- */
216
- fileType?:
217
- string;
218
- /**
219
- * Activates or deactivates the automatic filtering of Google search results. See [Automatic
220
- * Filtering](https://developers.google.com/custom-search/docs/json_api_reference#automaticFiltering) for more information about Google's search results filters. Valid
221
- * values for this parameter are: * `0`: Disabled * `1`: Enabled (default) **Note**: By default, Google applies filtering to all search results to improve the quality
222
- * of those results.
223
- */
224
- filter?:
225
- string;
226
- /**
227
- * Boosts search results whose country of origin matches the parameter value. See [Country
228
- * Codes](https://developers.google.com/custom-search/docs/json_api_reference#countryCodes) for a list of valid values. Specifying a `gl` parameter value in WebSearch
229
- * requests should improve the relevance of results. This is particularly true for international customers and, even more specifically, for customers in
230
- * English-speaking countries other than the United States.
231
- */
232
- gl?:
233
- string;
234
- /** Specifies the Google domain (for example, google.com, google.de, or google.fr) to which the search should be limited. */
235
- googleHost?:
236
- string;
237
- /** 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. */
238
- highRange?:
239
- string;
240
- /**
241
- * Specifies the interface language (host language) of your user interface. Explicitly setting this parameter improves the performance and the quality of your search
242
- * results. See the [Interface Languages](https://developers.google.com/custom-search/docs/json_api_reference#wsInterfaceLanguages) section of [Internationalizing
243
- * Queries and Results Presentation](https://developers.google.com/custom-search/docs/json_api_reference#wsInternationalizing) for more information, and [Supported
244
- * Interface Languages](https://developers.google.com/custom-search/docs/json_api_reference#interfaceLanguages) for a list of supported languages.
245
- */
246
- hl?:
247
- string;
248
- /** Appends the specified query terms to the query, as if they were combined with a logical `AND` operator. */
249
- hq?:
250
- string;
251
- /** Restricts results to images of a specified color type. Supported values are: * `mono` (black and white) * `gray` (grayscale) * `color` (color) */
252
- imgColorType?:
253
- string;
254
- /**
255
- * Restricts results to images with a specific dominant color. Supported values are: * `red` * `orange` * `yellow` * `green` * `teal` * `blue` * `purple` * `pink` *
256
- * `white` * `gray` * `black` * `brown`
257
- */
258
- imgDominantColor?:
259
- string;
260
- /**
261
- * Restricts results to images of a specified size. Supported values are: * `icon` (small) * `small | medium | large | xlarge` (medium) * `xxlarge` (large) * `huge`
262
- * (extra-large)
263
- */
264
- imgSize?:
265
- string;
266
- /**
267
- * Restricts results to images of a specified type. Supported values are: * `clipart` (Clip art) * `face` (Face) * `lineart` (Line drawing) * `photo` (Photo) *
268
- * `animated` (Animated) * `stock` (Stock)
269
- */
270
- imgType?:
271
- string;
272
- /** The character encoding supported for search requests. */
273
- inputEncoding?:
274
- string;
275
- /** The language of the search results. */
276
- language?:
277
- string;
278
- /** Specifies that all results should contain a link to a specific URL. */
279
- linkSite?:
280
- string;
281
- /** 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. */
282
- lowRange?:
283
- string;
284
- /**
285
- * 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
286
- * can also use the [Boolean OR](https://developers.google.com/custom-search/docs/json_api_reference#BooleanOrSearch) query term for this type of query.
287
- */
288
- orTerms?:
289
- string;
290
- /** The character encoding supported for search results. */
291
- outputEncoding?:
292
- string;
293
- /** Specifies that all search results should be pages that are related to the specified URL. The parameter value should be a URL. */
294
- relatedSite?:
295
- string;
296
- /** Filters based on licensing. Supported values include: * `cc_publicdomain` * `cc_attribute` * `cc_sharealike` * `cc_noncommercial` * `cc_nonderived` */
297
- rights?:
298
- string;
299
- /**
300
- * Specifies the [SafeSearch level](https://developers.google.com/custom-search/docs/json_api_reference#safeSearchLevels) used for filtering out adult results. This is
301
- * a custom property not defined in the OpenSearch spec. Valid parameter values are: * `"off"`: Disable SafeSearch * `"active"`: Enable SafeSearch
302
- */
303
- safe?:
304
- string;
305
- /** The search terms entered by the user. */
306
- searchTerms?:
307
- string;
308
- /** Allowed values are `web` or `image`. If unspecified, results are limited to webpages. */
309
- searchType?:
310
- string;
311
- /** Restricts results to URLs from a specified site. */
312
- siteSearch?:
313
- string;
314
- /**
315
- * Specifies whether to include or exclude results from the site named in the `sitesearch` parameter. Supported values are: * `i`: include content from site * `e`:
316
- * exclude content from site
317
- */
318
- siteSearchFilter?:
319
- string;
320
- /** Specifies that results should be sorted according to the specified expression. For example, sort by date. */
321
- sort?:
322
- string;
323
- /** The index of the current set of search results into the total set of results, where the index of the first result is 1. */
324
- startIndex?:
325
- number;
326
- /** The page number of this set of results, where the page length is set by the `count` property. */
327
- startPage?:
328
- number;
329
- /** A description of the query. */
330
- title?:
331
- string;
332
- /** Estimated number of total search results. May not be accurate. */
333
- totalResults?:
334
- string;
335
- }>;
336
- /** Metadata representing the previous page of results, if applicable. */
337
- previousPage?:
338
- Array<{
339
- /** Number of search results returned in this set. */
340
- count?:
341
- number;
342
- /**
343
- * Restricts search results to documents originating in a particular country. You may use [Boolean
344
- * operators](https://developers.google.com/custom-search/docs/json_api_reference#BooleanOrSearch) in the `cr` parameter's value. Google WebSearch determines the
345
- * 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
346
- * [Country (cr) Parameter Values](https://developers.google.com/custom-search/docs/json_api_reference#countryCollections) for a list of valid values for this
347
- * parameter.
348
- */
349
- cr?:
350
- string;
351
- /**
352
- * The identifier of an engine created using the Programmable Search Engine [Control Panel](https://programmablesearchengine.google.com/). This is a custom property not
353
- * defined in the OpenSearch spec. This parameter is **required**.
354
- */
355
- cx?:
356
- string;
357
- /**
358
- * Restricts results to URLs based on date. Supported values include: * `d[number]`: requests results from the specified number of past days. * `w[number]`: requests
359
- * 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
360
- * specified number of past years.
361
- */
362
- dateRestrict?:
363
- string;
364
- /**
365
- * Enables or disables the [Simplified and Traditional Chinese Search](https://developers.google.com/custom-search/docs/json_api_reference#chineseSearch) feature.
366
- * Supported values are: * `0`: enabled (default) * `1`: disabled
367
- */
368
- disableCnTwTranslation?:
369
- string;
370
- /** Identifies a phrase that all documents in the search results must contain. */
371
- exactTerms?:
372
- string;
373
- /** Identifies a word or phrase that should not appear in any documents in the search results. */
374
- excludeTerms?:
375
- string;
376
- /**
377
- * Restricts results to files of a specified extension. Filetypes supported by Google include: * Adobe Portable Document Format (`pdf`) * Adobe PostScript (`ps`) *
378
- * Lotus 1-2-3 (`wk1`, `wk2`, `wk3`, `wk4`, `wk5`, `wki`, `wks`, `wku`) * Lotus WordPro (`lwp`) * Macwrite (`mw`) * Microsoft Excel (`xls`) * Microsoft PowerPoint
379
- * (`ppt`) * Microsoft Word (`doc`) * Microsoft Works (`wks`, `wps`, `wdb`) * Microsoft Write (`wri`) * Rich Text Format (`rtf`) * Shockwave Flash (`swf`) * Text
380
- * (`ans`, `txt`). Additional filetypes may be added in the future. An up-to-date list can always be found in Google's [file type
381
- * FAQ](https://support.google.com/webmasters/answer/35287).
382
- */
383
- fileType?:
384
- string;
385
- /**
386
- * Activates or deactivates the automatic filtering of Google search results. See [Automatic
387
- * Filtering](https://developers.google.com/custom-search/docs/json_api_reference#automaticFiltering) for more information about Google's search results filters. Valid
388
- * values for this parameter are: * `0`: Disabled * `1`: Enabled (default) **Note**: By default, Google applies filtering to all search results to improve the quality
389
- * of those results.
390
- */
391
- filter?:
392
- string;
393
- /**
394
- * Boosts search results whose country of origin matches the parameter value. See [Country
395
- * Codes](https://developers.google.com/custom-search/docs/json_api_reference#countryCodes) for a list of valid values. Specifying a `gl` parameter value in WebSearch
396
- * requests should improve the relevance of results. This is particularly true for international customers and, even more specifically, for customers in
397
- * English-speaking countries other than the United States.
398
- */
399
- gl?:
400
- string;
401
- /** Specifies the Google domain (for example, google.com, google.de, or google.fr) to which the search should be limited. */
402
- googleHost?:
403
- string;
404
- /** 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. */
405
- highRange?:
406
- string;
407
- /**
408
- * Specifies the interface language (host language) of your user interface. Explicitly setting this parameter improves the performance and the quality of your search
409
- * results. See the [Interface Languages](https://developers.google.com/custom-search/docs/json_api_reference#wsInterfaceLanguages) section of [Internationalizing
410
- * Queries and Results Presentation](https://developers.google.com/custom-search/docs/json_api_reference#wsInternationalizing) for more information, and [Supported
411
- * Interface Languages](https://developers.google.com/custom-search/docs/json_api_reference#interfaceLanguages) for a list of supported languages.
412
- */
413
- hl?:
414
- string;
415
- /** Appends the specified query terms to the query, as if they were combined with a logical `AND` operator. */
416
- hq?:
417
- string;
418
- /** Restricts results to images of a specified color type. Supported values are: * `mono` (black and white) * `gray` (grayscale) * `color` (color) */
419
- imgColorType?:
420
- string;
421
- /**
422
- * Restricts results to images with a specific dominant color. Supported values are: * `red` * `orange` * `yellow` * `green` * `teal` * `blue` * `purple` * `pink` *
423
- * `white` * `gray` * `black` * `brown`
424
- */
425
- imgDominantColor?:
426
- string;
427
- /**
428
- * Restricts results to images of a specified size. Supported values are: * `icon` (small) * `small | medium | large | xlarge` (medium) * `xxlarge` (large) * `huge`
429
- * (extra-large)
430
- */
431
- imgSize?:
432
- string;
433
- /**
434
- * Restricts results to images of a specified type. Supported values are: * `clipart` (Clip art) * `face` (Face) * `lineart` (Line drawing) * `photo` (Photo) *
435
- * `animated` (Animated) * `stock` (Stock)
436
- */
437
- imgType?:
438
- string;
439
- /** The character encoding supported for search requests. */
440
- inputEncoding?:
441
- string;
442
- /** The language of the search results. */
443
- language?:
444
- string;
445
- /** Specifies that all results should contain a link to a specific URL. */
446
- linkSite?:
447
- string;
448
- /** 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. */
449
- lowRange?:
450
- string;
451
- /**
452
- * 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
453
- * can also use the [Boolean OR](https://developers.google.com/custom-search/docs/json_api_reference#BooleanOrSearch) query term for this type of query.
454
- */
455
- orTerms?:
456
- string;
457
- /** The character encoding supported for search results. */
458
- outputEncoding?:
459
- string;
460
- /** Specifies that all search results should be pages that are related to the specified URL. The parameter value should be a URL. */
461
- relatedSite?:
462
- string;
463
- /** Filters based on licensing. Supported values include: * `cc_publicdomain` * `cc_attribute` * `cc_sharealike` * `cc_noncommercial` * `cc_nonderived` */
464
- rights?:
465
- string;
466
- /**
467
- * Specifies the [SafeSearch level](https://developers.google.com/custom-search/docs/json_api_reference#safeSearchLevels) used for filtering out adult results. This is
468
- * a custom property not defined in the OpenSearch spec. Valid parameter values are: * `"off"`: Disable SafeSearch * `"active"`: Enable SafeSearch
469
- */
470
- safe?:
471
- string;
472
- /** The search terms entered by the user. */
473
- searchTerms?:
474
- string;
475
- /** Allowed values are `web` or `image`. If unspecified, results are limited to webpages. */
476
- searchType?:
477
- string;
478
- /** Restricts results to URLs from a specified site. */
479
- siteSearch?:
480
- string;
481
- /**
482
- * Specifies whether to include or exclude results from the site named in the `sitesearch` parameter. Supported values are: * `i`: include content from site * `e`:
483
- * exclude content from site
484
- */
485
- siteSearchFilter?:
486
- string;
487
- /** Specifies that results should be sorted according to the specified expression. For example, sort by date. */
488
- sort?:
489
- string;
490
- /** The index of the current set of search results into the total set of results, where the index of the first result is 1. */
491
- startIndex?:
492
- number;
493
- /** The page number of this set of results, where the page length is set by the `count` property. */
494
- startPage?:
495
- number;
496
- /** A description of the query. */
497
- title?:
498
- string;
499
- /** Estimated number of total search results. May not be accurate. */
500
- totalResults?:
501
- string;
502
- }>;
503
- /** Metadata representing the current request. */
504
- request?:
505
- Array<{
506
- /** Number of search results returned in this set. */
507
- count?:
508
- number;
509
- /**
510
- * Restricts search results to documents originating in a particular country. You may use [Boolean
511
- * operators](https://developers.google.com/custom-search/docs/json_api_reference#BooleanOrSearch) in the `cr` parameter's value. Google WebSearch determines the
512
- * 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
513
- * [Country (cr) Parameter Values](https://developers.google.com/custom-search/docs/json_api_reference#countryCollections) for a list of valid values for this
514
- * parameter.
515
- */
516
- cr?:
517
- string;
518
- /**
519
- * The identifier of an engine created using the Programmable Search Engine [Control Panel](https://programmablesearchengine.google.com/). This is a custom property not
520
- * defined in the OpenSearch spec. This parameter is **required**.
521
- */
522
- cx?:
523
- string;
524
- /**
525
- * Restricts results to URLs based on date. Supported values include: * `d[number]`: requests results from the specified number of past days. * `w[number]`: requests
526
- * 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
527
- * specified number of past years.
528
- */
529
- dateRestrict?:
530
- string;
531
- /**
532
- * Enables or disables the [Simplified and Traditional Chinese Search](https://developers.google.com/custom-search/docs/json_api_reference#chineseSearch) feature.
533
- * Supported values are: * `0`: enabled (default) * `1`: disabled
534
- */
535
- disableCnTwTranslation?:
536
- string;
537
- /** Identifies a phrase that all documents in the search results must contain. */
538
- exactTerms?:
539
- string;
540
- /** Identifies a word or phrase that should not appear in any documents in the search results. */
541
- excludeTerms?:
542
- string;
543
- /**
544
- * Restricts results to files of a specified extension. Filetypes supported by Google include: * Adobe Portable Document Format (`pdf`) * Adobe PostScript (`ps`) *
545
- * Lotus 1-2-3 (`wk1`, `wk2`, `wk3`, `wk4`, `wk5`, `wki`, `wks`, `wku`) * Lotus WordPro (`lwp`) * Macwrite (`mw`) * Microsoft Excel (`xls`) * Microsoft PowerPoint
546
- * (`ppt`) * Microsoft Word (`doc`) * Microsoft Works (`wks`, `wps`, `wdb`) * Microsoft Write (`wri`) * Rich Text Format (`rtf`) * Shockwave Flash (`swf`) * Text
547
- * (`ans`, `txt`). Additional filetypes may be added in the future. An up-to-date list can always be found in Google's [file type
548
- * FAQ](https://support.google.com/webmasters/answer/35287).
549
- */
550
- fileType?:
551
- string;
552
- /**
553
- * Activates or deactivates the automatic filtering of Google search results. See [Automatic
554
- * Filtering](https://developers.google.com/custom-search/docs/json_api_reference#automaticFiltering) for more information about Google's search results filters. Valid
555
- * values for this parameter are: * `0`: Disabled * `1`: Enabled (default) **Note**: By default, Google applies filtering to all search results to improve the quality
556
- * of those results.
557
- */
558
- filter?:
559
- string;
560
- /**
561
- * Boosts search results whose country of origin matches the parameter value. See [Country
562
- * Codes](https://developers.google.com/custom-search/docs/json_api_reference#countryCodes) for a list of valid values. Specifying a `gl` parameter value in WebSearch
563
- * requests should improve the relevance of results. This is particularly true for international customers and, even more specifically, for customers in
564
- * English-speaking countries other than the United States.
565
- */
566
- gl?:
567
- string;
568
- /** Specifies the Google domain (for example, google.com, google.de, or google.fr) to which the search should be limited. */
569
- googleHost?:
570
- string;
571
- /** 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. */
572
- highRange?:
573
- string;
574
- /**
575
- * Specifies the interface language (host language) of your user interface. Explicitly setting this parameter improves the performance and the quality of your search
576
- * results. See the [Interface Languages](https://developers.google.com/custom-search/docs/json_api_reference#wsInterfaceLanguages) section of [Internationalizing
577
- * Queries and Results Presentation](https://developers.google.com/custom-search/docs/json_api_reference#wsInternationalizing) for more information, and [Supported
578
- * Interface Languages](https://developers.google.com/custom-search/docs/json_api_reference#interfaceLanguages) for a list of supported languages.
579
- */
580
- hl?:
581
- string;
582
- /** Appends the specified query terms to the query, as if they were combined with a logical `AND` operator. */
583
- hq?:
584
- string;
585
- /** Restricts results to images of a specified color type. Supported values are: * `mono` (black and white) * `gray` (grayscale) * `color` (color) */
586
- imgColorType?:
587
- string;
588
- /**
589
- * Restricts results to images with a specific dominant color. Supported values are: * `red` * `orange` * `yellow` * `green` * `teal` * `blue` * `purple` * `pink` *
590
- * `white` * `gray` * `black` * `brown`
591
- */
592
- imgDominantColor?:
593
- string;
594
- /**
595
- * Restricts results to images of a specified size. Supported values are: * `icon` (small) * `small | medium | large | xlarge` (medium) * `xxlarge` (large) * `huge`
596
- * (extra-large)
597
- */
598
- imgSize?:
599
- string;
600
- /**
601
- * Restricts results to images of a specified type. Supported values are: * `clipart` (Clip art) * `face` (Face) * `lineart` (Line drawing) * `photo` (Photo) *
602
- * `animated` (Animated) * `stock` (Stock)
603
- */
604
- imgType?:
605
- string;
606
- /** The character encoding supported for search requests. */
607
- inputEncoding?:
608
- string;
609
- /** The language of the search results. */
610
- language?:
611
- string;
612
- /** Specifies that all results should contain a link to a specific URL. */
613
- linkSite?:
614
- string;
615
- /** 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. */
616
- lowRange?:
617
- string;
618
- /**
619
- * 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
620
- * can also use the [Boolean OR](https://developers.google.com/custom-search/docs/json_api_reference#BooleanOrSearch) query term for this type of query.
621
- */
622
- orTerms?:
623
- string;
624
- /** The character encoding supported for search results. */
625
- outputEncoding?:
626
- string;
627
- /** Specifies that all search results should be pages that are related to the specified URL. The parameter value should be a URL. */
628
- relatedSite?:
629
- string;
630
- /** Filters based on licensing. Supported values include: * `cc_publicdomain` * `cc_attribute` * `cc_sharealike` * `cc_noncommercial` * `cc_nonderived` */
631
- rights?:
632
- string;
633
- /**
634
- * Specifies the [SafeSearch level](https://developers.google.com/custom-search/docs/json_api_reference#safeSearchLevels) used for filtering out adult results. This is
635
- * a custom property not defined in the OpenSearch spec. Valid parameter values are: * `"off"`: Disable SafeSearch * `"active"`: Enable SafeSearch
636
- */
637
- safe?:
638
- string;
639
- /** The search terms entered by the user. */
640
- searchTerms?:
641
- string;
642
- /** Allowed values are `web` or `image`. If unspecified, results are limited to webpages. */
643
- searchType?:
644
- string;
645
- /** Restricts results to URLs from a specified site. */
646
- siteSearch?:
647
- string;
648
- /**
649
- * Specifies whether to include or exclude results from the site named in the `sitesearch` parameter. Supported values are: * `i`: include content from site * `e`:
650
- * exclude content from site
651
- */
652
- siteSearchFilter?:
653
- string;
654
- /** Specifies that results should be sorted according to the specified expression. For example, sort by date. */
655
- sort?:
656
- string;
657
- /** The index of the current set of search results into the total set of results, where the index of the first result is 1. */
658
- startIndex?:
659
- number;
660
- /** The page number of this set of results, where the page length is set by the `count` property. */
661
- startPage?:
662
- number;
663
- /** A description of the query. */
664
- title?:
665
- string;
666
- /** Estimated number of total search results. May not be accurate. */
667
- totalResults?:
668
- string;
669
- }>;
670
- };
671
- /** Metadata about a search operation. */
672
- searchInformation?:
673
- {
674
- /** The time taken for the server to return search results, formatted according to locale style. */
675
- formattedSearchTime?:
676
- string;
677
- /** The total number of search results, formatted according to locale style. */
678
- formattedTotalResults?:
679
- string;
680
- /** The time taken for the server to return search results. */
681
- searchTime?:
682
- number;
683
- /** The total number of search results returned by the query. */
684
- totalResults?:
685
- string;
686
- };
687
- /** Spell correction information for a query. */
688
- spelling?:
689
- {
690
- /** The corrected query. */
691
- correctedQuery?:
692
- string;
693
- /** The corrected query, formatted in HTML. */
694
- htmlCorrectedQuery?:
695
- string;
696
- };
697
- /** OpenSearch template and URL. */
698
- url?:
699
- {
700
- /** The actual [OpenSearch template](http://www.opensearch.org/specifications/opensearch/1.1#opensearch_url_template_syntax) for this API. */
701
- template?:
702
- string;
703
- /** The MIME type of the OpenSearch URL template for the Custom Search JSON API. */
704
- type?:
705
- string;
706
- };
707
- }
708
- interface SiterestrictResource {
709
- /** Returns metadata about the search performed, metadata about the engine used for the search, and the search results. Uses a small set of url patterns. */
710
- list(request?: {
711
- /** V1 error format. */
712
- "$.xgafv"?:
713
- string;
714
- /** OAuth access token. */
715
- access_token?:
716
- string;
717
- /** Data format for response. */
718
- alt?:
719
- string;
720
- /**
721
- * Enables or disables [Simplified and Traditional Chinese Search](https://developers.google.com/custom-search/docs/json_api_reference#chineseSearch). The default value for this
722
- * parameter is 0 (zero), meaning that the feature is enabled. Supported values are: * `1`: Disabled * `0`: Enabled (default)
723
- */
724
- c2coff?:
725
- string;
726
- /** JSONP */
727
- callback?:
728
- string;
729
- /**
730
- * Restricts search results to documents originating in a particular country. You may use [Boolean
731
- * operators](https://developers.google.com/custom-search/docs/json_api_reference#booleanOperators) in the cr parameter's value. Google Search determines the country of a document
732
- * 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
733
- * Values](https://developers.google.com/custom-search/docs/json_api_reference#countryCollections) page for a list of valid values for this parameter.
734
- */
735
- cr?:
736
- string;
737
- /** The Programmable Search Engine ID to use for this request. */
738
- cx?:
739
- string;
740
- /**
741
- * 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
742
- * 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
743
- * years.
744
- */
745
- dateRestrict?:
746
- string;
747
- /** Identifies a phrase that all documents in the search results must contain. */
748
- exactTerms?:
749
- string;
750
- /** Identifies a word or phrase that should not appear in any documents in the search results. */
751
- excludeTerms?:
752
- string;
753
- /** Selector specifying which fields to include in a partial response. */
754
- fields?:
755
- string;
756
- /**
757
- * Restricts results to files of a specified extension. A list of file types indexable by Google can be found in Search Console [Help
758
- * Center](https://support.google.com/webmasters/answer/35287).
759
- */
760
- fileType?:
761
- string;
762
- /**
763
- * Controls turning on or off the duplicate content filter. * See [Automatic Filtering](https://developers.google.com/custom-search/docs/json_api_reference#automaticFiltering) for
764
- * 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
765
- * search results to improve the quality of those results. Acceptable values are: * `0`: Turns off duplicate content filter. * `1`: Turns on duplicate content filter.
766
- */
767
- filter?:
768
- string;
769
- /**
770
- * 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.
771
- * See the [Country Codes](https://developers.google.com/custom-search/docs/json_api_reference#countryCodes) page for a list of valid values. * Specifying a `gl` parameter value
772
- * 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
773
- * the United States.
774
- */
775
- gl?:
776
- string;
777
- /** **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. */
778
- googlehost?:
779
- string;
780
- /** Specifies the ending value for a search range. * Use `lowRange` and `highRange` to append an inclusive search range of `lowRange...highRange` to the query. */
781
- highRange?:
782
- string;
783
- /**
784
- * Sets the user interface language. * Explicitly setting this parameter improves the performance and the quality of your search results. * See the [Interface
785
- * Languages](https://developers.google.com/custom-search/docs/json_api_reference#wsInterfaceLanguages) section of [Internationalizing Queries and Results
786
- * Presentation](https://developers.google.com/custom-search/docs/json_api_reference#wsInternationalizing) for more information, and [Supported Interface
787
- * Languages](https://developers.google.com/custom-search/docs/json_api_reference#interfaceLanguages) for a list of supported languages.
788
- */
789
- hl?:
790
- string;
791
- /** Appends the specified query terms to the query, as if they were combined with a logical AND operator. */
792
- hq?:
793
- string;
794
- /** Returns black and white, grayscale, transparent, or color images. Acceptable values are: * `"color"` * `"gray"` * `"mono"`: black and white * `"trans"`: transparent background */
795
- imgColorType?:
796
- string;
797
- /**
798
- * Returns images of a specific dominant color. Acceptable values are: * `"black"` * `"blue"` * `"brown"` * `"gray"` * `"green"` * `"orange"` * `"pink"` * `"purple"` * `"red"` *
799
- * `"teal"` * `"white"` * `"yellow"`
800
- */
801
- imgDominantColor?:
802
- string;
803
- /** Returns images of a specified size. Acceptable values are: * `"huge"` * `"icon"` * `"large"` * `"medium"` * `"small"` * `"xlarge"` * `"xxlarge"` */
804
- imgSize?:
805
- string;
806
- /** Returns images of a type. Acceptable values are: * `"clipart"` * `"face"` * `"lineart"` * `"stock"` * `"photo"` * `"animated"` */
807
- imgType?:
808
- string;
809
- /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
810
- key?:
811
- string;
812
- /** Specifies that all search results should contain a link to a particular URL. */
813
- linkSite?:
814
- string;
815
- /** Specifies the starting value for a search range. Use `lowRange` and `highRange` to append an inclusive search range of `lowRange...highRange` to the query. */
816
- lowRange?:
817
- string;
818
- /**
819
- * 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"`:
820
- * Catalan * `"lang_cs"`: Czech * `"lang_da"`: Danish * `"lang_de"`: German * `"lang_el"`: Greek * `"lang_en"`: English * `"lang_es"`: Spanish * `"lang_et"`: Estonian *
821
- * `"lang_fi"`: Finnish * `"lang_fr"`: French * `"lang_hr"`: Croatian * `"lang_hu"`: Hungarian * `"lang_id"`: Indonesian * `"lang_is"`: Icelandic * `"lang_it"`: Italian *
822
- * `"lang_iw"`: Hebrew * `"lang_ja"`: Japanese * `"lang_ko"`: Korean * `"lang_lt"`: Lithuanian * `"lang_lv"`: Latvian * `"lang_nl"`: Dutch * `"lang_no"`: Norwegian * `"lang_pl"`:
823
- * Polish * `"lang_pt"`: Portuguese * `"lang_ro"`: Romanian * `"lang_ru"`: Russian * `"lang_sk"`: Slovak * `"lang_sl"`: Slovenian * `"lang_sr"`: Serbian * `"lang_sv"`: Swedish *
824
- * `"lang_tr"`: Turkish * `"lang_zh-CN"`: Chinese (Simplified) * `"lang_zh-TW"`: Chinese (Traditional)
825
- */
826
- lr?:
827
- string;
828
- /** Number of search results to return. * Valid values are integers between 1 and 10, inclusive. */
829
- num?:
830
- number;
831
- /** OAuth 2.0 token for the current user. */
832
- oauth_token?:
833
- string;
834
- /** 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. */
835
- orTerms?:
836
- string;
837
- /** Returns response with indentations and line breaks. */
838
- prettyPrint?:
839
- boolean;
840
- /** Query */
841
- q?:
842
- string;
843
- /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
844
- quotaUser?:
845
- string;
846
- /** Specifies that all search results should be pages that are related to the specified URL. */
847
- relatedSite?:
848
- string;
849
- /**
850
- * Filters based on licensing. Supported values include: `cc_publicdomain`, `cc_attribute`, `cc_sharealike`, `cc_noncommercial`, `cc_nonderived` and combinations of these. See
851
- * [typical combinations](https://wiki.creativecommons.org/wiki/CC_Search_integration).
852
- */
853
- rights?:
854
- string;
855
- /** Search safety level. Acceptable values are: * `"active"`: Enables SafeSearch filtering. * `"off"`: Disables SafeSearch filtering. (default) */
856
- safe?:
857
- string;
858
- /** Specifies the search type: `image`. If unspecified, results are limited to webpages. Acceptable values are: * `"image"`: custom image search. */
859
- searchType?:
860
- string;
861
- /** Specifies a given site which should always be included or excluded from results (see `siteSearchFilter` parameter, below). */
862
- siteSearch?:
863
- string;
864
- /** Controls whether to include or exclude results from the site named in the `siteSearch` parameter. Acceptable values are: * `"e"`: exclude * `"i"`: include */
865
- siteSearchFilter?:
866
- string;
867
- /**
868
- * 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:
869
- * sort=date](https://developers.google.com/custom-search/docs/structured_search#sort-by-attribute).
870
- */
871
- sort?:
872
- string;
873
- /**
874
- * 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
875
- * 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
876
- * error. Also note that the maximum value for `num` is 10.
877
- */
878
- start?:
879
- number;
880
- /** Upload protocol for media (e.g. "raw", "multipart"). */
881
- upload_protocol?:
882
- string;
883
- /** Legacy upload protocol for media (e.g. "media", "multipart"). */
884
- uploadType?:
885
- string;
886
- }): Request<Search>;
887
- }
888
- interface CseResource {
889
- /** Returns metadata about the search performed, metadata about the engine used for the search, and the search results. */
890
- list(request?: {
891
- /** V1 error format. */
892
- "$.xgafv"?:
893
- string;
894
- /** OAuth access token. */
895
- access_token?:
896
- string;
897
- /** Data format for response. */
898
- alt?:
899
- string;
900
- /**
901
- * Enables or disables [Simplified and Traditional Chinese Search](https://developers.google.com/custom-search/docs/json_api_reference#chineseSearch). The default value for this
902
- * parameter is 0 (zero), meaning that the feature is enabled. Supported values are: * `1`: Disabled * `0`: Enabled (default)
903
- */
904
- c2coff?:
905
- string;
906
- /** JSONP */
907
- callback?:
908
- string;
909
- /**
910
- * Restricts search results to documents originating in a particular country. You may use [Boolean
911
- * operators](https://developers.google.com/custom-search/docs/json_api_reference#booleanOperators) in the cr parameter's value. Google Search determines the country of a document
912
- * 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
913
- * Values](https://developers.google.com/custom-search/docs/json_api_reference#countryCollections) page for a list of valid values for this parameter.
914
- */
915
- cr?:
916
- string;
917
- /** The Programmable Search Engine ID to use for this request. */
918
- cx?:
919
- string;
920
- /**
921
- * 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
922
- * 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
923
- * years.
924
- */
925
- dateRestrict?:
926
- string;
927
- /** Identifies a phrase that all documents in the search results must contain. */
928
- exactTerms?:
929
- string;
930
- /** Identifies a word or phrase that should not appear in any documents in the search results. */
931
- excludeTerms?:
932
- string;
933
- /** Selector specifying which fields to include in a partial response. */
934
- fields?:
935
- string;
936
- /**
937
- * Restricts results to files of a specified extension. A list of file types indexable by Google can be found in Search Console [Help
938
- * Center](https://support.google.com/webmasters/answer/35287).
939
- */
940
- fileType?:
941
- string;
942
- /**
943
- * Controls turning on or off the duplicate content filter. * See [Automatic Filtering](https://developers.google.com/custom-search/docs/json_api_reference#automaticFiltering) for
944
- * 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
945
- * search results to improve the quality of those results. Acceptable values are: * `0`: Turns off duplicate content filter. * `1`: Turns on duplicate content filter.
946
- */
947
- filter?:
948
- string;
949
- /**
950
- * 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.
951
- * See the [Country Codes](https://developers.google.com/custom-search/docs/json_api_reference#countryCodes) page for a list of valid values. * Specifying a `gl` parameter value
952
- * 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
953
- * the United States.
954
- */
955
- gl?:
956
- string;
957
- /** **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. */
958
- googlehost?:
959
- string;
960
- /** Specifies the ending value for a search range. * Use `lowRange` and `highRange` to append an inclusive search range of `lowRange...highRange` to the query. */
961
- highRange?:
962
- string;
963
- /**
964
- * Sets the user interface language. * Explicitly setting this parameter improves the performance and the quality of your search results. * See the [Interface
965
- * Languages](https://developers.google.com/custom-search/docs/json_api_reference#wsInterfaceLanguages) section of [Internationalizing Queries and Results
966
- * Presentation](https://developers.google.com/custom-search/docs/json_api_reference#wsInternationalizing) for more information, and [Supported Interface
967
- * Languages](https://developers.google.com/custom-search/docs/json_api_reference#interfaceLanguages) for a list of supported languages.
968
- */
969
- hl?:
970
- string;
971
- /** Appends the specified query terms to the query, as if they were combined with a logical AND operator. */
972
- hq?:
973
- string;
974
- /** Returns black and white, grayscale, transparent, or color images. Acceptable values are: * `"color"` * `"gray"` * `"mono"`: black and white * `"trans"`: transparent background */
975
- imgColorType?:
976
- string;
977
- /**
978
- * Returns images of a specific dominant color. Acceptable values are: * `"black"` * `"blue"` * `"brown"` * `"gray"` * `"green"` * `"orange"` * `"pink"` * `"purple"` * `"red"` *
979
- * `"teal"` * `"white"` * `"yellow"`
980
- */
981
- imgDominantColor?:
982
- string;
983
- /** Returns images of a specified size. Acceptable values are: * `"huge"` * `"icon"` * `"large"` * `"medium"` * `"small"` * `"xlarge"` * `"xxlarge"` */
984
- imgSize?:
985
- string;
986
- /** Returns images of a type. Acceptable values are: * `"clipart"` * `"face"` * `"lineart"` * `"stock"` * `"photo"` * `"animated"` */
987
- imgType?:
988
- string;
989
- /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
990
- key?:
991
- string;
992
- /** Specifies that all search results should contain a link to a particular URL. */
993
- linkSite?:
994
- string;
995
- /** Specifies the starting value for a search range. Use `lowRange` and `highRange` to append an inclusive search range of `lowRange...highRange` to the query. */
996
- lowRange?:
997
- string;
998
- /**
999
- * 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"`:
1000
- * Catalan * `"lang_cs"`: Czech * `"lang_da"`: Danish * `"lang_de"`: German * `"lang_el"`: Greek * `"lang_en"`: English * `"lang_es"`: Spanish * `"lang_et"`: Estonian *
1001
- * `"lang_fi"`: Finnish * `"lang_fr"`: French * `"lang_hr"`: Croatian * `"lang_hu"`: Hungarian * `"lang_id"`: Indonesian * `"lang_is"`: Icelandic * `"lang_it"`: Italian *
1002
- * `"lang_iw"`: Hebrew * `"lang_ja"`: Japanese * `"lang_ko"`: Korean * `"lang_lt"`: Lithuanian * `"lang_lv"`: Latvian * `"lang_nl"`: Dutch * `"lang_no"`: Norwegian * `"lang_pl"`:
1003
- * Polish * `"lang_pt"`: Portuguese * `"lang_ro"`: Romanian * `"lang_ru"`: Russian * `"lang_sk"`: Slovak * `"lang_sl"`: Slovenian * `"lang_sr"`: Serbian * `"lang_sv"`: Swedish *
1004
- * `"lang_tr"`: Turkish * `"lang_zh-CN"`: Chinese (Simplified) * `"lang_zh-TW"`: Chinese (Traditional)
1005
- */
1006
- lr?:
1007
- string;
1008
- /** Number of search results to return. * Valid values are integers between 1 and 10, inclusive. */
1009
- num?:
1010
- number;
1011
- /** OAuth 2.0 token for the current user. */
1012
- oauth_token?:
1013
- string;
1014
- /** 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. */
1015
- orTerms?:
1016
- string;
1017
- /** Returns response with indentations and line breaks. */
1018
- prettyPrint?:
1019
- boolean;
1020
- /** Query */
1021
- q?:
1022
- string;
1023
- /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
1024
- quotaUser?:
1025
- string;
1026
- /** Specifies that all search results should be pages that are related to the specified URL. */
1027
- relatedSite?:
1028
- string;
1029
- /**
1030
- * Filters based on licensing. Supported values include: `cc_publicdomain`, `cc_attribute`, `cc_sharealike`, `cc_noncommercial`, `cc_nonderived` and combinations of these. See
1031
- * [typical combinations](https://wiki.creativecommons.org/wiki/CC_Search_integration).
1032
- */
1033
- rights?:
1034
- string;
1035
- /** Search safety level. Acceptable values are: * `"active"`: Enables SafeSearch filtering. * `"off"`: Disables SafeSearch filtering. (default) */
1036
- safe?:
1037
- string;
1038
- /** Specifies the search type: `image`. If unspecified, results are limited to webpages. Acceptable values are: * `"image"`: custom image search. */
1039
- searchType?:
1040
- string;
1041
- /** Specifies a given site which should always be included or excluded from results (see `siteSearchFilter` parameter, below). */
1042
- siteSearch?:
1043
- string;
1044
- /** Controls whether to include or exclude results from the site named in the `siteSearch` parameter. Acceptable values are: * `"e"`: exclude * `"i"`: include */
1045
- siteSearchFilter?:
1046
- string;
1047
- /**
1048
- * 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:
1049
- * sort=date](https://developers.google.com/custom-search/docs/structured_search#sort-by-attribute).
1050
- */
1051
- sort?:
1052
- string;
1053
- /**
1054
- * 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
1055
- * 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
1056
- * error. Also note that the maximum value for `num` is 10.
1057
- */
1058
- start?:
1059
- number;
1060
- /** Upload protocol for media (e.g. "raw", "multipart"). */
1061
- upload_protocol?:
1062
- string;
1063
- /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1064
- uploadType?:
1065
- string;
1066
- }): Request<Search>;
1067
- siterestrict:
1068
- SiterestrictResource;
1069
- }
1070
-
1071
- const cse: CseResource;
26
+ namespace search {
27
+ interface Promotion {
28
+ /** An array of block objects for this promotion. */
29
+ bodyLines?: Array<{
30
+ /** The block object's text in HTML, if it has text. */
31
+ htmlTitle?: string;
32
+ /** The anchor text of the block object's link, if it has a link. */
33
+ link?: string;
34
+ /** The block object's text, if it has text. */
35
+ title?: string;
36
+ /** The URL of the block object's link, if it has one. */
37
+ url?: string;
38
+ }>;
39
+ /** An abridged version of this search's result URL, e.g. www.example.com. */
40
+ displayLink?: string;
41
+ /** The title of the promotion, in HTML. */
42
+ htmlTitle?: string;
43
+ /** Image belonging to a promotion. */
44
+ image?: {
45
+ /** Image height in pixels. */
46
+ height?: number;
47
+ /** URL of the image for this promotion link. */
48
+ source?: string;
49
+ /** Image width in pixels. */
50
+ width?: number;
51
+ };
52
+ /** The URL of the promotion. */
53
+ link?: string;
54
+ /** The title of the promotion. */
55
+ title?: string;
56
+ }
57
+ interface Result {
58
+ /** Indicates the ID of Google's cached version of the search result. */
59
+ cacheId?: string;
60
+ /** An abridged version of this search result’s URL, e.g. www.example.com. */
61
+ displayLink?: string;
62
+ /** The file format of the search result. */
63
+ fileFormat?: string;
64
+ /** The URL displayed after the snippet for each search result. */
65
+ formattedUrl?: string;
66
+ /** The HTML-formatted URL displayed after the snippet for each search result. */
67
+ htmlFormattedUrl?: string;
68
+ /** The snippet of the search result, in HTML. */
69
+ htmlSnippet?: string;
70
+ /** The title of the search result, in HTML. */
71
+ htmlTitle?: string;
72
+ /** Image belonging to a custom search result. */
73
+ image?: {
74
+ /** The size of the image, in bytes. */
75
+ byteSize?: number;
76
+ /** A URL pointing to the webpage hosting the image. */
77
+ contextLink?: string;
78
+ /** The height of the image, in pixels. */
79
+ height?: number;
80
+ /** The height of the thumbnail image, in pixels. */
81
+ thumbnailHeight?: number;
82
+ /** A URL to the thumbnail image. */
83
+ thumbnailLink?: string;
84
+ /** The width of the thumbnail image, in pixels. */
85
+ thumbnailWidth?: number;
86
+ /** The width of the image, in pixels. */
87
+ width?: number;
88
+ };
89
+ /** A unique identifier for the type of current object. For this API, it is `customsearch#result.` */
90
+ kind?: string;
91
+ /** Encapsulates all information about refinement labels. */
92
+ labels?: Array<{
93
+ /** The display name of a refinement label. This is the name you should display in your user interface. */
94
+ displayName?: string;
95
+ /** Refinement label and the associated refinement operation. */
96
+ label_with_op?: string;
97
+ /** The name of a refinement label, which you can use to refine searches. Don't display this in your user interface; instead, use displayName. */
98
+ name?: string;
99
+ }>;
100
+ /** The full URL to which the search result is pointing, e.g. http://www.example.com/foo/bar. */
101
+ link?: string;
102
+ /** The MIME type of the search result. */
103
+ mime?: string;
104
+ /** Contains [PageMap](https://developers.google.com/custom-search/docs/structured_data#pagemaps) information for this search result. */
105
+ pagemap?: {[P in string]: any};
106
+ /** The snippet of the search result, in plain text. */
107
+ snippet?: string;
108
+ /** The title of the search result, in plain text. */
109
+ title?: string;
110
+ }
111
+ interface Search {
112
+ /** 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. */
113
+ context?: {[P in string]: any};
114
+ /** The current set of custom search results. */
115
+ items?: Result[];
116
+ /** Unique identifier for the type of current object. For this API, it is customsearch#search. */
117
+ kind?: string;
118
+ /** 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. */
119
+ promotions?: Promotion[];
120
+ /** Query metadata for the previous, current, and next pages of results. */
121
+ queries?: {
122
+ /** Metadata representing the next page of results, if applicable. */
123
+ nextPage?: Array<{
124
+ /** Number of search results returned in this set. */
125
+ count?: number;
126
+ /** Restricts search results to documents originating in a particular country. You may use [Boolean operators](https://developers.google.com/custom-search/docs/json_api_reference#BooleanOrSearch) 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/json_api_reference#countryCollections) for a list of valid values for this parameter. */
127
+ cr?: string;
128
+ /** 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**. */
129
+ cx?: string;
130
+ /** 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. */
131
+ dateRestrict?: string;
132
+ /** Enables or disables the [Simplified and Traditional Chinese Search](https://developers.google.com/custom-search/docs/json_api_reference#chineseSearch) feature. Supported values are: * `0`: enabled (default) * `1`: disabled */
133
+ disableCnTwTranslation?: string;
134
+ /** Identifies a phrase that all documents in the search results must contain. */
135
+ exactTerms?: string;
136
+ /** Identifies a word or phrase that should not appear in any documents in the search results. */
137
+ excludeTerms?: string;
138
+ /** 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). */
139
+ fileType?: string;
140
+ /** Activates or deactivates the automatic filtering of Google search results. See [Automatic Filtering](https://developers.google.com/custom-search/docs/json_api_reference#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. */
141
+ filter?: string;
142
+ /** Boosts search results whose country of origin matches the parameter value. See [Country Codes](https://developers.google.com/custom-search/docs/json_api_reference#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. */
143
+ gl?: string;
144
+ /** Specifies the Google domain (for example, google.com, google.de, or google.fr) to which the search should be limited. */
145
+ googleHost?: string;
146
+ /** 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. */
147
+ highRange?: string;
148
+ /** 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/json_api_reference#wsInterfaceLanguages) section of [Internationalizing Queries and Results Presentation](https://developers.google.com/custom-search/docs/json_api_reference#wsInternationalizing) for more information, and [Supported Interface Languages](https://developers.google.com/custom-search/docs/json_api_reference#interfaceLanguages) for a list of supported languages. */
149
+ hl?: string;
150
+ /** Appends the specified query terms to the query, as if they were combined with a logical `AND` operator. */
151
+ hq?: string;
152
+ /** Restricts results to images of a specified color type. Supported values are: * `mono` (black and white) * `gray` (grayscale) * `color` (color) */
153
+ imgColorType?: string;
154
+ /** Restricts results to images with a specific dominant color. Supported values are: * `red` * `orange` * `yellow` * `green` * `teal` * `blue` * `purple` * `pink` * `white` * `gray` * `black` * `brown` */
155
+ imgDominantColor?: string;
156
+ /** Restricts results to images of a specified size. Supported values are: * `icon` (small) * `small | medium | large | xlarge` (medium) * `xxlarge` (large) * `huge` (extra-large) */
157
+ imgSize?: string;
158
+ /** 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) */
159
+ imgType?: string;
160
+ /** The character encoding supported for search requests. */
161
+ inputEncoding?: string;
162
+ /** The language of the search results. */
163
+ language?: string;
164
+ /** Specifies that all results should contain a link to a specific URL. */
165
+ linkSite?: string;
166
+ /** 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. */
167
+ lowRange?: string;
168
+ /** 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/json_api_reference#BooleanOrSearch) query term for this type of query. */
169
+ orTerms?: string;
170
+ /** The character encoding supported for search results. */
171
+ outputEncoding?: string;
172
+ /** Specifies that all search results should be pages that are related to the specified URL. The parameter value should be a URL. */
173
+ relatedSite?: string;
174
+ /** Filters based on licensing. Supported values include: * `cc_publicdomain` * `cc_attribute` * `cc_sharealike` * `cc_noncommercial` * `cc_nonderived` */
175
+ rights?: string;
176
+ /** Specifies the [SafeSearch level](https://developers.google.com/custom-search/docs/json_api_reference#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 */
177
+ safe?: string;
178
+ /** The search terms entered by the user. */
179
+ searchTerms?: string;
180
+ /** Allowed values are `web` or `image`. If unspecified, results are limited to webpages. */
181
+ searchType?: string;
182
+ /** Restricts results to URLs from a specified site. */
183
+ siteSearch?: string;
184
+ /** 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 */
185
+ siteSearchFilter?: string;
186
+ /** Specifies that results should be sorted according to the specified expression. For example, sort by date. */
187
+ sort?: string;
188
+ /** The index of the current set of search results into the total set of results, where the index of the first result is 1. */
189
+ startIndex?: number;
190
+ /** The page number of this set of results, where the page length is set by the `count` property. */
191
+ startPage?: number;
192
+ /** A description of the query. */
193
+ title?: string;
194
+ /** Estimated number of total search results. May not be accurate. */
195
+ totalResults?: string;
196
+ }>;
197
+ /** Metadata representing the previous page of results, if applicable. */
198
+ previousPage?: Array<{
199
+ /** Number of search results returned in this set. */
200
+ count?: number;
201
+ /** Restricts search results to documents originating in a particular country. You may use [Boolean operators](https://developers.google.com/custom-search/docs/json_api_reference#BooleanOrSearch) 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/json_api_reference#countryCollections) for a list of valid values for this parameter. */
202
+ cr?: string;
203
+ /** 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**. */
204
+ cx?: string;
205
+ /** 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. */
206
+ dateRestrict?: string;
207
+ /** Enables or disables the [Simplified and Traditional Chinese Search](https://developers.google.com/custom-search/docs/json_api_reference#chineseSearch) feature. Supported values are: * `0`: enabled (default) * `1`: disabled */
208
+ disableCnTwTranslation?: string;
209
+ /** Identifies a phrase that all documents in the search results must contain. */
210
+ exactTerms?: string;
211
+ /** Identifies a word or phrase that should not appear in any documents in the search results. */
212
+ excludeTerms?: string;
213
+ /** 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). */
214
+ fileType?: string;
215
+ /** Activates or deactivates the automatic filtering of Google search results. See [Automatic Filtering](https://developers.google.com/custom-search/docs/json_api_reference#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. */
216
+ filter?: string;
217
+ /** Boosts search results whose country of origin matches the parameter value. See [Country Codes](https://developers.google.com/custom-search/docs/json_api_reference#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. */
218
+ gl?: string;
219
+ /** Specifies the Google domain (for example, google.com, google.de, or google.fr) to which the search should be limited. */
220
+ googleHost?: string;
221
+ /** 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. */
222
+ highRange?: string;
223
+ /** 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/json_api_reference#wsInterfaceLanguages) section of [Internationalizing Queries and Results Presentation](https://developers.google.com/custom-search/docs/json_api_reference#wsInternationalizing) for more information, and [Supported Interface Languages](https://developers.google.com/custom-search/docs/json_api_reference#interfaceLanguages) for a list of supported languages. */
224
+ hl?: string;
225
+ /** Appends the specified query terms to the query, as if they were combined with a logical `AND` operator. */
226
+ hq?: string;
227
+ /** Restricts results to images of a specified color type. Supported values are: * `mono` (black and white) * `gray` (grayscale) * `color` (color) */
228
+ imgColorType?: string;
229
+ /** Restricts results to images with a specific dominant color. Supported values are: * `red` * `orange` * `yellow` * `green` * `teal` * `blue` * `purple` * `pink` * `white` * `gray` * `black` * `brown` */
230
+ imgDominantColor?: string;
231
+ /** Restricts results to images of a specified size. Supported values are: * `icon` (small) * `small | medium | large | xlarge` (medium) * `xxlarge` (large) * `huge` (extra-large) */
232
+ imgSize?: string;
233
+ /** 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) */
234
+ imgType?: string;
235
+ /** The character encoding supported for search requests. */
236
+ inputEncoding?: string;
237
+ /** The language of the search results. */
238
+ language?: string;
239
+ /** Specifies that all results should contain a link to a specific URL. */
240
+ linkSite?: string;
241
+ /** 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. */
242
+ lowRange?: string;
243
+ /** 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/json_api_reference#BooleanOrSearch) query term for this type of query. */
244
+ orTerms?: string;
245
+ /** The character encoding supported for search results. */
246
+ outputEncoding?: string;
247
+ /** Specifies that all search results should be pages that are related to the specified URL. The parameter value should be a URL. */
248
+ relatedSite?: string;
249
+ /** Filters based on licensing. Supported values include: * `cc_publicdomain` * `cc_attribute` * `cc_sharealike` * `cc_noncommercial` * `cc_nonderived` */
250
+ rights?: string;
251
+ /** Specifies the [SafeSearch level](https://developers.google.com/custom-search/docs/json_api_reference#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 */
252
+ safe?: string;
253
+ /** The search terms entered by the user. */
254
+ searchTerms?: string;
255
+ /** Allowed values are `web` or `image`. If unspecified, results are limited to webpages. */
256
+ searchType?: string;
257
+ /** Restricts results to URLs from a specified site. */
258
+ siteSearch?: string;
259
+ /** 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 */
260
+ siteSearchFilter?: string;
261
+ /** Specifies that results should be sorted according to the specified expression. For example, sort by date. */
262
+ sort?: string;
263
+ /** The index of the current set of search results into the total set of results, where the index of the first result is 1. */
264
+ startIndex?: number;
265
+ /** The page number of this set of results, where the page length is set by the `count` property. */
266
+ startPage?: number;
267
+ /** A description of the query. */
268
+ title?: string;
269
+ /** Estimated number of total search results. May not be accurate. */
270
+ totalResults?: string;
271
+ }>;
272
+ /** Metadata representing the current request. */
273
+ request?: Array<{
274
+ /** Number of search results returned in this set. */
275
+ count?: number;
276
+ /** Restricts search results to documents originating in a particular country. You may use [Boolean operators](https://developers.google.com/custom-search/docs/json_api_reference#BooleanOrSearch) 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/json_api_reference#countryCollections) for a list of valid values for this parameter. */
277
+ cr?: string;
278
+ /** 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**. */
279
+ cx?: string;
280
+ /** 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. */
281
+ dateRestrict?: string;
282
+ /** Enables or disables the [Simplified and Traditional Chinese Search](https://developers.google.com/custom-search/docs/json_api_reference#chineseSearch) feature. Supported values are: * `0`: enabled (default) * `1`: disabled */
283
+ disableCnTwTranslation?: string;
284
+ /** Identifies a phrase that all documents in the search results must contain. */
285
+ exactTerms?: string;
286
+ /** Identifies a word or phrase that should not appear in any documents in the search results. */
287
+ excludeTerms?: string;
288
+ /** 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). */
289
+ fileType?: string;
290
+ /** Activates or deactivates the automatic filtering of Google search results. See [Automatic Filtering](https://developers.google.com/custom-search/docs/json_api_reference#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. */
291
+ filter?: string;
292
+ /** Boosts search results whose country of origin matches the parameter value. See [Country Codes](https://developers.google.com/custom-search/docs/json_api_reference#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. */
293
+ gl?: string;
294
+ /** Specifies the Google domain (for example, google.com, google.de, or google.fr) to which the search should be limited. */
295
+ googleHost?: string;
296
+ /** 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. */
297
+ highRange?: string;
298
+ /** 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/json_api_reference#wsInterfaceLanguages) section of [Internationalizing Queries and Results Presentation](https://developers.google.com/custom-search/docs/json_api_reference#wsInternationalizing) for more information, and [Supported Interface Languages](https://developers.google.com/custom-search/docs/json_api_reference#interfaceLanguages) for a list of supported languages. */
299
+ hl?: string;
300
+ /** Appends the specified query terms to the query, as if they were combined with a logical `AND` operator. */
301
+ hq?: string;
302
+ /** Restricts results to images of a specified color type. Supported values are: * `mono` (black and white) * `gray` (grayscale) * `color` (color) */
303
+ imgColorType?: string;
304
+ /** Restricts results to images with a specific dominant color. Supported values are: * `red` * `orange` * `yellow` * `green` * `teal` * `blue` * `purple` * `pink` * `white` * `gray` * `black` * `brown` */
305
+ imgDominantColor?: string;
306
+ /** Restricts results to images of a specified size. Supported values are: * `icon` (small) * `small | medium | large | xlarge` (medium) * `xxlarge` (large) * `huge` (extra-large) */
307
+ imgSize?: string;
308
+ /** 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) */
309
+ imgType?: string;
310
+ /** The character encoding supported for search requests. */
311
+ inputEncoding?: string;
312
+ /** The language of the search results. */
313
+ language?: string;
314
+ /** Specifies that all results should contain a link to a specific URL. */
315
+ linkSite?: string;
316
+ /** 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. */
317
+ lowRange?: string;
318
+ /** 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/json_api_reference#BooleanOrSearch) query term for this type of query. */
319
+ orTerms?: string;
320
+ /** The character encoding supported for search results. */
321
+ outputEncoding?: string;
322
+ /** Specifies that all search results should be pages that are related to the specified URL. The parameter value should be a URL. */
323
+ relatedSite?: string;
324
+ /** Filters based on licensing. Supported values include: * `cc_publicdomain` * `cc_attribute` * `cc_sharealike` * `cc_noncommercial` * `cc_nonderived` */
325
+ rights?: string;
326
+ /** Specifies the [SafeSearch level](https://developers.google.com/custom-search/docs/json_api_reference#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 */
327
+ safe?: string;
328
+ /** The search terms entered by the user. */
329
+ searchTerms?: string;
330
+ /** Allowed values are `web` or `image`. If unspecified, results are limited to webpages. */
331
+ searchType?: string;
332
+ /** Restricts results to URLs from a specified site. */
333
+ siteSearch?: string;
334
+ /** 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 */
335
+ siteSearchFilter?: string;
336
+ /** Specifies that results should be sorted according to the specified expression. For example, sort by date. */
337
+ sort?: string;
338
+ /** The index of the current set of search results into the total set of results, where the index of the first result is 1. */
339
+ startIndex?: number;
340
+ /** The page number of this set of results, where the page length is set by the `count` property. */
341
+ startPage?: number;
342
+ /** A description of the query. */
343
+ title?: string;
344
+ /** Estimated number of total search results. May not be accurate. */
345
+ totalResults?: string;
346
+ }>;
347
+ };
348
+ /** Metadata about a search operation. */
349
+ searchInformation?: {
350
+ /** The time taken for the server to return search results, formatted according to locale style. */
351
+ formattedSearchTime?: string;
352
+ /** The total number of search results, formatted according to locale style. */
353
+ formattedTotalResults?: string;
354
+ /** The time taken for the server to return search results. */
355
+ searchTime?: number;
356
+ /** The total number of search results returned by the query. */
357
+ totalResults?: string;
358
+ };
359
+ /** Spell correction information for a query. */
360
+ spelling?: {
361
+ /** The corrected query. */
362
+ correctedQuery?: string;
363
+ /** The corrected query, formatted in HTML. */
364
+ htmlCorrectedQuery?: string;
365
+ };
366
+ /** OpenSearch template and URL. */
367
+ url?: {
368
+ /** The actual [OpenSearch template](http://www.opensearch.org/specifications/opensearch/1.1#opensearch_url_template_syntax) for this API. */
369
+ template?: string;
370
+ /** The MIME type of the OpenSearch URL template for the Custom Search JSON API. */
371
+ type?: string;
372
+ };
1072
373
  }
374
+ interface SiterestrictResource {
375
+ /** Returns metadata about the search performed, metadata about the engine used for the search, and the search results. Uses a small set of url patterns. */
376
+ list(request?: {
377
+ /** V1 error format. */
378
+ '$.xgafv'?: string;
379
+ /** OAuth access token. */
380
+ access_token?: string;
381
+ /** Data format for response. */
382
+ alt?: string;
383
+ /** Enables or disables [Simplified and Traditional Chinese Search](https://developers.google.com/custom-search/docs/json_api_reference#chineseSearch). The default value for this parameter is 0 (zero), meaning that the feature is enabled. Supported values are: * `1`: Disabled * `0`: Enabled (default) */
384
+ c2coff?: string;
385
+ /** JSONP */
386
+ callback?: string;
387
+ /** Restricts search results to documents originating in a particular country. You may use [Boolean operators](https://developers.google.com/custom-search/docs/json_api_reference#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/json_api_reference#countryCollections) page for a list of valid values for this parameter. */
388
+ cr?: string;
389
+ /** The Programmable Search Engine ID to use for this request. */
390
+ cx?: string;
391
+ /** 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. */
392
+ dateRestrict?: string;
393
+ /** Identifies a phrase that all documents in the search results must contain. */
394
+ exactTerms?: string;
395
+ /** Identifies a word or phrase that should not appear in any documents in the search results. */
396
+ excludeTerms?: string;
397
+ /** Selector specifying which fields to include in a partial response. */
398
+ fields?: string;
399
+ /** 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). */
400
+ fileType?: string;
401
+ /** Controls turning on or off the duplicate content filter. * See [Automatic Filtering](https://developers.google.com/custom-search/docs/json_api_reference#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. */
402
+ filter?: string;
403
+ /** 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/json_api_reference#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. */
404
+ gl?: string;
405
+ /** **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. */
406
+ googlehost?: string;
407
+ /** Specifies the ending value for a search range. * Use `lowRange` and `highRange` to append an inclusive search range of `lowRange...highRange` to the query. */
408
+ highRange?: string;
409
+ /** 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/json_api_reference#wsInterfaceLanguages) section of [Internationalizing Queries and Results Presentation](https://developers.google.com/custom-search/docs/json_api_reference#wsInternationalizing) for more information, and [Supported Interface Languages](https://developers.google.com/custom-search/docs/json_api_reference#interfaceLanguages) for a list of supported languages. */
410
+ hl?: string;
411
+ /** Appends the specified query terms to the query, as if they were combined with a logical AND operator. */
412
+ hq?: string;
413
+ /** Returns black and white, grayscale, transparent, or color images. Acceptable values are: * `"color"` * `"gray"` * `"mono"`: black and white * `"trans"`: transparent background */
414
+ imgColorType?: string;
415
+ /** Returns images of a specific dominant color. Acceptable values are: * `"black"` * `"blue"` * `"brown"` * `"gray"` * `"green"` * `"orange"` * `"pink"` * `"purple"` * `"red"` * `"teal"` * `"white"` * `"yellow"` */
416
+ imgDominantColor?: string;
417
+ /** Returns images of a specified size. Acceptable values are: * `"huge"` * `"icon"` * `"large"` * `"medium"` * `"small"` * `"xlarge"` * `"xxlarge"` */
418
+ imgSize?: string;
419
+ /** Returns images of a type. Acceptable values are: * `"clipart"` * `"face"` * `"lineart"` * `"stock"` * `"photo"` * `"animated"` */
420
+ imgType?: string;
421
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
422
+ key?: string;
423
+ /** Specifies that all search results should contain a link to a particular URL. */
424
+ linkSite?: string;
425
+ /** Specifies the starting value for a search range. Use `lowRange` and `highRange` to append an inclusive search range of `lowRange...highRange` to the query. */
426
+ lowRange?: string;
427
+ /** 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) */
428
+ lr?: string;
429
+ /** Number of search results to return. * Valid values are integers between 1 and 10, inclusive. */
430
+ num?: number;
431
+ /** OAuth 2.0 token for the current user. */
432
+ oauth_token?: string;
433
+ /** 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. */
434
+ orTerms?: string;
435
+ /** Returns response with indentations and line breaks. */
436
+ prettyPrint?: boolean;
437
+ /** Query */
438
+ q?: string;
439
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
440
+ quotaUser?: string;
441
+ /** Specifies that all search results should be pages that are related to the specified URL. */
442
+ relatedSite?: string;
443
+ /** 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). */
444
+ rights?: string;
445
+ /** Search safety level. Acceptable values are: * `"active"`: Enables SafeSearch filtering. * `"off"`: Disables SafeSearch filtering. (default) */
446
+ safe?: string;
447
+ /** Specifies the search type: `image`. If unspecified, results are limited to webpages. Acceptable values are: * `"image"`: custom image search. */
448
+ searchType?: string;
449
+ /** Specifies a given site which should always be included or excluded from results (see `siteSearchFilter` parameter, below). */
450
+ siteSearch?: string;
451
+ /** Controls whether to include or exclude results from the site named in the `siteSearch` parameter. Acceptable values are: * `"e"`: exclude * `"i"`: include */
452
+ siteSearchFilter?: string;
453
+ /** 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). */
454
+ sort?: string;
455
+ /** 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. */
456
+ start?: number;
457
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
458
+ upload_protocol?: string;
459
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
460
+ uploadType?: string;
461
+ }): Request<Search>;
462
+ }
463
+ interface CseResource {
464
+ /** Returns metadata about the search performed, metadata about the engine used for the search, and the search results. */
465
+ list(request?: {
466
+ /** V1 error format. */
467
+ '$.xgafv'?: string;
468
+ /** OAuth access token. */
469
+ access_token?: string;
470
+ /** Data format for response. */
471
+ alt?: string;
472
+ /** Enables or disables [Simplified and Traditional Chinese Search](https://developers.google.com/custom-search/docs/json_api_reference#chineseSearch). The default value for this parameter is 0 (zero), meaning that the feature is enabled. Supported values are: * `1`: Disabled * `0`: Enabled (default) */
473
+ c2coff?: string;
474
+ /** JSONP */
475
+ callback?: string;
476
+ /** Restricts search results to documents originating in a particular country. You may use [Boolean operators](https://developers.google.com/custom-search/docs/json_api_reference#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/json_api_reference#countryCollections) page for a list of valid values for this parameter. */
477
+ cr?: string;
478
+ /** The Programmable Search Engine ID to use for this request. */
479
+ cx?: string;
480
+ /** 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. */
481
+ dateRestrict?: string;
482
+ /** Identifies a phrase that all documents in the search results must contain. */
483
+ exactTerms?: string;
484
+ /** Identifies a word or phrase that should not appear in any documents in the search results. */
485
+ excludeTerms?: string;
486
+ /** Selector specifying which fields to include in a partial response. */
487
+ fields?: string;
488
+ /** 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). */
489
+ fileType?: string;
490
+ /** Controls turning on or off the duplicate content filter. * See [Automatic Filtering](https://developers.google.com/custom-search/docs/json_api_reference#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. */
491
+ filter?: string;
492
+ /** 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/json_api_reference#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. */
493
+ gl?: string;
494
+ /** **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. */
495
+ googlehost?: string;
496
+ /** Specifies the ending value for a search range. * Use `lowRange` and `highRange` to append an inclusive search range of `lowRange...highRange` to the query. */
497
+ highRange?: string;
498
+ /** 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/json_api_reference#wsInterfaceLanguages) section of [Internationalizing Queries and Results Presentation](https://developers.google.com/custom-search/docs/json_api_reference#wsInternationalizing) for more information, and [Supported Interface Languages](https://developers.google.com/custom-search/docs/json_api_reference#interfaceLanguages) for a list of supported languages. */
499
+ hl?: string;
500
+ /** Appends the specified query terms to the query, as if they were combined with a logical AND operator. */
501
+ hq?: string;
502
+ /** Returns black and white, grayscale, transparent, or color images. Acceptable values are: * `"color"` * `"gray"` * `"mono"`: black and white * `"trans"`: transparent background */
503
+ imgColorType?: string;
504
+ /** Returns images of a specific dominant color. Acceptable values are: * `"black"` * `"blue"` * `"brown"` * `"gray"` * `"green"` * `"orange"` * `"pink"` * `"purple"` * `"red"` * `"teal"` * `"white"` * `"yellow"` */
505
+ imgDominantColor?: string;
506
+ /** Returns images of a specified size. Acceptable values are: * `"huge"` * `"icon"` * `"large"` * `"medium"` * `"small"` * `"xlarge"` * `"xxlarge"` */
507
+ imgSize?: string;
508
+ /** Returns images of a type. Acceptable values are: * `"clipart"` * `"face"` * `"lineart"` * `"stock"` * `"photo"` * `"animated"` */
509
+ imgType?: string;
510
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
511
+ key?: string;
512
+ /** Specifies that all search results should contain a link to a particular URL. */
513
+ linkSite?: string;
514
+ /** Specifies the starting value for a search range. Use `lowRange` and `highRange` to append an inclusive search range of `lowRange...highRange` to the query. */
515
+ lowRange?: string;
516
+ /** 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) */
517
+ lr?: string;
518
+ /** Number of search results to return. * Valid values are integers between 1 and 10, inclusive. */
519
+ num?: number;
520
+ /** OAuth 2.0 token for the current user. */
521
+ oauth_token?: string;
522
+ /** 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. */
523
+ orTerms?: string;
524
+ /** Returns response with indentations and line breaks. */
525
+ prettyPrint?: boolean;
526
+ /** Query */
527
+ q?: string;
528
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
529
+ quotaUser?: string;
530
+ /** Specifies that all search results should be pages that are related to the specified URL. */
531
+ relatedSite?: string;
532
+ /** 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). */
533
+ rights?: string;
534
+ /** Search safety level. Acceptable values are: * `"active"`: Enables SafeSearch filtering. * `"off"`: Disables SafeSearch filtering. (default) */
535
+ safe?: string;
536
+ /** Specifies the search type: `image`. If unspecified, results are limited to webpages. Acceptable values are: * `"image"`: custom image search. */
537
+ searchType?: string;
538
+ /** Specifies a given site which should always be included or excluded from results (see `siteSearchFilter` parameter, below). */
539
+ siteSearch?: string;
540
+ /** Controls whether to include or exclude results from the site named in the `siteSearch` parameter. Acceptable values are: * `"e"`: exclude * `"i"`: include */
541
+ siteSearchFilter?: string;
542
+ /** 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). */
543
+ sort?: string;
544
+ /** 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. */
545
+ start?: number;
546
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
547
+ upload_protocol?: string;
548
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
549
+ uploadType?: string;
550
+ }): Request<Search>;
551
+ siterestrict: SiterestrictResource;
552
+ }
553
+
554
+ const cse: CseResource;
555
+ }
1073
556
  }