@maxim_mazurok/gapi.client.customsearch-v1 0.0.20230425 → 0.0.20230429
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.
- package/index.d.ts +813 -557
- package/package.json +1 -1
- package/tests.ts +1 -1
package/index.d.ts
CHANGED
|
@@ -9,7 +9,7 @@
|
|
|
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:
|
|
12
|
+
// Revision: 20230429
|
|
13
13
|
|
|
14
14
|
/// <reference types="gapi.client" />
|
|
15
15
|
|
|
@@ -24,601 +24,797 @@ declare namespace gapi.client {
|
|
|
24
24
|
namespace search {
|
|
25
25
|
interface Promotion {
|
|
26
26
|
/** An array of block objects for this promotion. */
|
|
27
|
-
bodyLines?:
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
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
|
+
}>;
|
|
37
42
|
/** An abridged version of this search's result URL, e.g. www.example.com. */
|
|
38
|
-
displayLink?:
|
|
43
|
+
displayLink?:
|
|
44
|
+
string;
|
|
39
45
|
/** The title of the promotion, in HTML. */
|
|
40
|
-
htmlTitle?:
|
|
46
|
+
htmlTitle?:
|
|
47
|
+
string;
|
|
41
48
|
/** Image belonging to a promotion. */
|
|
42
|
-
image?:
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
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
|
+
};
|
|
50
61
|
/** The URL of the promotion. */
|
|
51
|
-
link?:
|
|
62
|
+
link?:
|
|
63
|
+
string;
|
|
52
64
|
/** The title of the promotion. */
|
|
53
|
-
title?:
|
|
65
|
+
title?:
|
|
66
|
+
string;
|
|
54
67
|
}
|
|
55
68
|
interface Result {
|
|
56
69
|
/** Indicates the ID of Google's cached version of the search result. */
|
|
57
|
-
cacheId?:
|
|
70
|
+
cacheId?:
|
|
71
|
+
string;
|
|
58
72
|
/** An abridged version of this search result’s URL, e.g. www.example.com. */
|
|
59
|
-
displayLink?:
|
|
73
|
+
displayLink?:
|
|
74
|
+
string;
|
|
60
75
|
/** The file format of the search result. */
|
|
61
|
-
fileFormat?:
|
|
76
|
+
fileFormat?:
|
|
77
|
+
string;
|
|
62
78
|
/** The URL displayed after the snippet for each search result. */
|
|
63
|
-
formattedUrl?:
|
|
79
|
+
formattedUrl?:
|
|
80
|
+
string;
|
|
64
81
|
/** The HTML-formatted URL displayed after the snippet for each search result. */
|
|
65
|
-
htmlFormattedUrl?:
|
|
82
|
+
htmlFormattedUrl?:
|
|
83
|
+
string;
|
|
66
84
|
/** The snippet of the search result, in HTML. */
|
|
67
|
-
htmlSnippet?:
|
|
85
|
+
htmlSnippet?:
|
|
86
|
+
string;
|
|
68
87
|
/** The title of the search result, in HTML. */
|
|
69
|
-
htmlTitle?:
|
|
88
|
+
htmlTitle?:
|
|
89
|
+
string;
|
|
70
90
|
/** Image belonging to a custom search result. */
|
|
71
|
-
image?:
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
|
|
75
|
-
|
|
76
|
-
|
|
77
|
-
|
|
78
|
-
|
|
79
|
-
|
|
80
|
-
|
|
81
|
-
|
|
82
|
-
|
|
83
|
-
|
|
84
|
-
|
|
85
|
-
|
|
86
|
-
|
|
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
|
+
};
|
|
87
115
|
/** A unique identifier for the type of current object. For this API, it is `customsearch#result.` */
|
|
88
|
-
kind?:
|
|
116
|
+
kind?:
|
|
117
|
+
string;
|
|
89
118
|
/** Encapsulates all information about refinement labels. */
|
|
90
|
-
labels?:
|
|
91
|
-
|
|
92
|
-
|
|
93
|
-
|
|
94
|
-
|
|
95
|
-
|
|
96
|
-
|
|
97
|
-
|
|
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
|
+
}>;
|
|
98
131
|
/** The full URL to which the search result is pointing, e.g. http://www.example.com/foo/bar. */
|
|
99
|
-
link?:
|
|
132
|
+
link?:
|
|
133
|
+
string;
|
|
100
134
|
/** The MIME type of the search result. */
|
|
101
|
-
mime?:
|
|
135
|
+
mime?:
|
|
136
|
+
string;
|
|
102
137
|
/** Contains [PageMap](https://developers.google.com/custom-search/docs/structured_data#pagemaps) information for this search result. */
|
|
103
|
-
pagemap?:
|
|
138
|
+
pagemap?:
|
|
139
|
+
{ [P in string]: any };
|
|
104
140
|
/** The snippet of the search result, in plain text. */
|
|
105
|
-
snippet?:
|
|
141
|
+
snippet?:
|
|
142
|
+
string;
|
|
106
143
|
/** The title of the search result, in plain text. */
|
|
107
|
-
title?:
|
|
144
|
+
title?:
|
|
145
|
+
string;
|
|
108
146
|
}
|
|
109
147
|
interface Search {
|
|
110
148
|
/**
|
|
111
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
|
|
112
150
|
* objects](https://developers.google.com/custom-search/docs/refinements#create) (refinements) you can use for refining a search.
|
|
113
151
|
*/
|
|
114
|
-
context?:
|
|
152
|
+
context?:
|
|
153
|
+
{ [P in string]: any };
|
|
115
154
|
/** The current set of custom search results. */
|
|
116
|
-
items?:
|
|
155
|
+
items?:
|
|
156
|
+
Result[];
|
|
117
157
|
/** Unique identifier for the type of current object. For this API, it is customsearch#search. */
|
|
118
|
-
kind?:
|
|
158
|
+
kind?:
|
|
159
|
+
string;
|
|
119
160
|
/**
|
|
120
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
|
|
121
162
|
* given query.
|
|
122
163
|
*/
|
|
123
|
-
promotions?:
|
|
164
|
+
promotions?:
|
|
165
|
+
Promotion[];
|
|
124
166
|
/** Query metadata for the previous, current, and next pages of results. */
|
|
125
|
-
queries?:
|
|
126
|
-
|
|
127
|
-
|
|
128
|
-
|
|
129
|
-
|
|
130
|
-
|
|
131
|
-
|
|
132
|
-
|
|
133
|
-
|
|
134
|
-
|
|
135
|
-
|
|
136
|
-
|
|
137
|
-
|
|
138
|
-
|
|
139
|
-
|
|
140
|
-
|
|
141
|
-
|
|
142
|
-
|
|
143
|
-
|
|
144
|
-
|
|
145
|
-
|
|
146
|
-
|
|
147
|
-
|
|
148
|
-
|
|
149
|
-
|
|
150
|
-
|
|
151
|
-
|
|
152
|
-
|
|
153
|
-
|
|
154
|
-
|
|
155
|
-
|
|
156
|
-
|
|
157
|
-
|
|
158
|
-
|
|
159
|
-
|
|
160
|
-
|
|
161
|
-
|
|
162
|
-
|
|
163
|
-
|
|
164
|
-
|
|
165
|
-
|
|
166
|
-
|
|
167
|
-
|
|
168
|
-
|
|
169
|
-
|
|
170
|
-
|
|
171
|
-
|
|
172
|
-
|
|
173
|
-
|
|
174
|
-
|
|
175
|
-
|
|
176
|
-
|
|
177
|
-
|
|
178
|
-
|
|
179
|
-
|
|
180
|
-
|
|
181
|
-
|
|
182
|
-
|
|
183
|
-
|
|
184
|
-
|
|
185
|
-
|
|
186
|
-
|
|
187
|
-
|
|
188
|
-
|
|
189
|
-
|
|
190
|
-
|
|
191
|
-
|
|
192
|
-
|
|
193
|
-
|
|
194
|
-
|
|
195
|
-
|
|
196
|
-
|
|
197
|
-
|
|
198
|
-
|
|
199
|
-
|
|
200
|
-
|
|
201
|
-
|
|
202
|
-
|
|
203
|
-
|
|
204
|
-
|
|
205
|
-
|
|
206
|
-
|
|
207
|
-
|
|
208
|
-
|
|
209
|
-
|
|
210
|
-
|
|
211
|
-
|
|
212
|
-
|
|
213
|
-
|
|
214
|
-
|
|
215
|
-
|
|
216
|
-
|
|
217
|
-
|
|
218
|
-
|
|
219
|
-
|
|
220
|
-
|
|
221
|
-
|
|
222
|
-
|
|
223
|
-
|
|
224
|
-
|
|
225
|
-
|
|
226
|
-
|
|
227
|
-
|
|
228
|
-
|
|
229
|
-
|
|
230
|
-
|
|
231
|
-
|
|
232
|
-
|
|
233
|
-
|
|
234
|
-
|
|
235
|
-
|
|
236
|
-
|
|
237
|
-
|
|
238
|
-
|
|
239
|
-
|
|
240
|
-
|
|
241
|
-
|
|
242
|
-
|
|
243
|
-
|
|
244
|
-
|
|
245
|
-
|
|
246
|
-
|
|
247
|
-
|
|
248
|
-
|
|
249
|
-
|
|
250
|
-
|
|
251
|
-
|
|
252
|
-
|
|
253
|
-
|
|
254
|
-
|
|
255
|
-
|
|
256
|
-
|
|
257
|
-
|
|
258
|
-
|
|
259
|
-
|
|
260
|
-
|
|
261
|
-
|
|
262
|
-
|
|
263
|
-
|
|
264
|
-
|
|
265
|
-
|
|
266
|
-
|
|
267
|
-
|
|
268
|
-
|
|
269
|
-
|
|
270
|
-
|
|
271
|
-
|
|
272
|
-
|
|
273
|
-
|
|
274
|
-
|
|
275
|
-
|
|
276
|
-
|
|
277
|
-
|
|
278
|
-
|
|
279
|
-
|
|
280
|
-
|
|
281
|
-
|
|
282
|
-
|
|
283
|
-
|
|
284
|
-
|
|
285
|
-
|
|
286
|
-
|
|
287
|
-
|
|
288
|
-
|
|
289
|
-
|
|
290
|
-
|
|
291
|
-
|
|
292
|
-
|
|
293
|
-
|
|
294
|
-
|
|
295
|
-
|
|
296
|
-
|
|
297
|
-
|
|
298
|
-
|
|
299
|
-
|
|
300
|
-
|
|
301
|
-
|
|
302
|
-
|
|
303
|
-
|
|
304
|
-
|
|
305
|
-
|
|
306
|
-
|
|
307
|
-
|
|
308
|
-
|
|
309
|
-
|
|
310
|
-
|
|
311
|
-
|
|
312
|
-
|
|
313
|
-
|
|
314
|
-
|
|
315
|
-
|
|
316
|
-
|
|
317
|
-
|
|
318
|
-
|
|
319
|
-
|
|
320
|
-
|
|
321
|
-
|
|
322
|
-
|
|
323
|
-
|
|
324
|
-
|
|
325
|
-
|
|
326
|
-
|
|
327
|
-
|
|
328
|
-
|
|
329
|
-
|
|
330
|
-
|
|
331
|
-
|
|
332
|
-
|
|
333
|
-
|
|
334
|
-
|
|
335
|
-
|
|
336
|
-
|
|
337
|
-
|
|
338
|
-
|
|
339
|
-
|
|
340
|
-
|
|
341
|
-
|
|
342
|
-
|
|
343
|
-
|
|
344
|
-
|
|
345
|
-
|
|
346
|
-
|
|
347
|
-
|
|
348
|
-
|
|
349
|
-
|
|
350
|
-
|
|
351
|
-
|
|
352
|
-
|
|
353
|
-
|
|
354
|
-
|
|
355
|
-
|
|
356
|
-
|
|
357
|
-
|
|
358
|
-
|
|
359
|
-
|
|
360
|
-
|
|
361
|
-
|
|
362
|
-
|
|
363
|
-
|
|
364
|
-
|
|
365
|
-
|
|
366
|
-
|
|
367
|
-
|
|
368
|
-
|
|
369
|
-
|
|
370
|
-
|
|
371
|
-
|
|
372
|
-
|
|
373
|
-
|
|
374
|
-
|
|
375
|
-
|
|
376
|
-
|
|
377
|
-
|
|
378
|
-
|
|
379
|
-
|
|
380
|
-
|
|
381
|
-
|
|
382
|
-
|
|
383
|
-
|
|
384
|
-
|
|
385
|
-
|
|
386
|
-
|
|
387
|
-
|
|
388
|
-
|
|
389
|
-
|
|
390
|
-
|
|
391
|
-
|
|
392
|
-
|
|
393
|
-
|
|
394
|
-
|
|
395
|
-
|
|
396
|
-
|
|
397
|
-
|
|
398
|
-
|
|
399
|
-
|
|
400
|
-
|
|
401
|
-
|
|
402
|
-
|
|
403
|
-
|
|
404
|
-
|
|
405
|
-
|
|
406
|
-
|
|
407
|
-
|
|
408
|
-
|
|
409
|
-
|
|
410
|
-
|
|
411
|
-
|
|
412
|
-
|
|
413
|
-
|
|
414
|
-
|
|
415
|
-
|
|
416
|
-
|
|
417
|
-
|
|
418
|
-
|
|
419
|
-
|
|
420
|
-
|
|
421
|
-
|
|
422
|
-
|
|
423
|
-
|
|
424
|
-
|
|
425
|
-
|
|
426
|
-
|
|
427
|
-
|
|
428
|
-
|
|
429
|
-
|
|
430
|
-
|
|
431
|
-
|
|
432
|
-
|
|
433
|
-
|
|
434
|
-
|
|
435
|
-
|
|
436
|
-
|
|
437
|
-
|
|
438
|
-
|
|
439
|
-
|
|
440
|
-
|
|
441
|
-
|
|
442
|
-
|
|
443
|
-
|
|
444
|
-
|
|
445
|
-
|
|
446
|
-
|
|
447
|
-
|
|
448
|
-
|
|
449
|
-
|
|
450
|
-
|
|
451
|
-
|
|
452
|
-
|
|
453
|
-
|
|
454
|
-
|
|
455
|
-
|
|
456
|
-
|
|
457
|
-
|
|
458
|
-
|
|
459
|
-
|
|
460
|
-
|
|
461
|
-
|
|
462
|
-
|
|
463
|
-
|
|
464
|
-
|
|
465
|
-
|
|
466
|
-
|
|
467
|
-
|
|
468
|
-
|
|
469
|
-
|
|
470
|
-
|
|
471
|
-
|
|
472
|
-
|
|
473
|
-
|
|
474
|
-
|
|
475
|
-
|
|
476
|
-
|
|
477
|
-
|
|
478
|
-
|
|
479
|
-
|
|
480
|
-
|
|
481
|
-
|
|
482
|
-
|
|
483
|
-
|
|
484
|
-
|
|
485
|
-
|
|
486
|
-
|
|
487
|
-
|
|
488
|
-
|
|
489
|
-
|
|
490
|
-
|
|
491
|
-
|
|
492
|
-
|
|
493
|
-
|
|
494
|
-
|
|
495
|
-
|
|
496
|
-
|
|
497
|
-
|
|
498
|
-
|
|
499
|
-
|
|
500
|
-
|
|
501
|
-
|
|
502
|
-
|
|
503
|
-
|
|
504
|
-
|
|
505
|
-
|
|
506
|
-
|
|
507
|
-
|
|
508
|
-
|
|
509
|
-
|
|
510
|
-
|
|
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
|
+
};
|
|
511
671
|
/** Metadata about a search operation. */
|
|
512
|
-
searchInformation?:
|
|
513
|
-
|
|
514
|
-
|
|
515
|
-
|
|
516
|
-
|
|
517
|
-
|
|
518
|
-
|
|
519
|
-
|
|
520
|
-
|
|
521
|
-
|
|
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
|
+
};
|
|
522
687
|
/** Spell correction information for a query. */
|
|
523
|
-
spelling?:
|
|
524
|
-
|
|
525
|
-
|
|
526
|
-
|
|
527
|
-
|
|
528
|
-
|
|
688
|
+
spelling?:
|
|
689
|
+
{
|
|
690
|
+
/** The corrected query. */
|
|
691
|
+
correctedQuery?:
|
|
692
|
+
string;
|
|
693
|
+
/** The corrected query, formatted in HTML. */
|
|
694
|
+
htmlCorrectedQuery?:
|
|
695
|
+
string;
|
|
696
|
+
};
|
|
529
697
|
/** OpenSearch template and URL. */
|
|
530
|
-
url?:
|
|
531
|
-
|
|
532
|
-
|
|
533
|
-
|
|
534
|
-
|
|
535
|
-
|
|
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
|
+
};
|
|
536
707
|
}
|
|
537
708
|
interface SiterestrictResource {
|
|
538
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. */
|
|
539
710
|
list(request?: {
|
|
540
711
|
/** V1 error format. */
|
|
541
|
-
"$.xgafv"?:
|
|
712
|
+
"$.xgafv"?:
|
|
713
|
+
string;
|
|
542
714
|
/** OAuth access token. */
|
|
543
|
-
access_token?:
|
|
715
|
+
access_token?:
|
|
716
|
+
string;
|
|
544
717
|
/** Data format for response. */
|
|
545
|
-
alt?:
|
|
718
|
+
alt?:
|
|
719
|
+
string;
|
|
546
720
|
/**
|
|
547
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
|
|
548
722
|
* parameter is 0 (zero), meaning that the feature is enabled. Supported values are: * `1`: Disabled * `0`: Enabled (default)
|
|
549
723
|
*/
|
|
550
|
-
c2coff?:
|
|
724
|
+
c2coff?:
|
|
725
|
+
string;
|
|
551
726
|
/** JSONP */
|
|
552
|
-
callback?:
|
|
727
|
+
callback?:
|
|
728
|
+
string;
|
|
553
729
|
/**
|
|
554
730
|
* Restricts search results to documents originating in a particular country. You may use [Boolean
|
|
555
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
|
|
556
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
|
|
557
733
|
* Values](https://developers.google.com/custom-search/docs/json_api_reference#countryCollections) page for a list of valid values for this parameter.
|
|
558
734
|
*/
|
|
559
|
-
cr?:
|
|
735
|
+
cr?:
|
|
736
|
+
string;
|
|
560
737
|
/** The Programmable Search Engine ID to use for this request. */
|
|
561
|
-
cx?:
|
|
738
|
+
cx?:
|
|
739
|
+
string;
|
|
562
740
|
/**
|
|
563
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
|
|
564
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
|
|
565
743
|
* years.
|
|
566
744
|
*/
|
|
567
|
-
dateRestrict?:
|
|
745
|
+
dateRestrict?:
|
|
746
|
+
string;
|
|
568
747
|
/** Identifies a phrase that all documents in the search results must contain. */
|
|
569
|
-
exactTerms?:
|
|
748
|
+
exactTerms?:
|
|
749
|
+
string;
|
|
570
750
|
/** Identifies a word or phrase that should not appear in any documents in the search results. */
|
|
571
|
-
excludeTerms?:
|
|
751
|
+
excludeTerms?:
|
|
752
|
+
string;
|
|
572
753
|
/** Selector specifying which fields to include in a partial response. */
|
|
573
|
-
fields?:
|
|
754
|
+
fields?:
|
|
755
|
+
string;
|
|
574
756
|
/**
|
|
575
757
|
* Restricts results to files of a specified extension. A list of file types indexable by Google can be found in Search Console [Help
|
|
576
758
|
* Center](https://support.google.com/webmasters/answer/35287).
|
|
577
759
|
*/
|
|
578
|
-
fileType?:
|
|
760
|
+
fileType?:
|
|
761
|
+
string;
|
|
579
762
|
/**
|
|
580
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
|
|
581
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
|
|
582
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.
|
|
583
766
|
*/
|
|
584
|
-
filter?:
|
|
767
|
+
filter?:
|
|
768
|
+
string;
|
|
585
769
|
/**
|
|
586
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.
|
|
587
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
|
|
588
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
|
|
589
773
|
* the United States.
|
|
590
774
|
*/
|
|
591
|
-
gl?:
|
|
775
|
+
gl?:
|
|
776
|
+
string;
|
|
592
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. */
|
|
593
|
-
googlehost?:
|
|
778
|
+
googlehost?:
|
|
779
|
+
string;
|
|
594
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. */
|
|
595
|
-
highRange?:
|
|
781
|
+
highRange?:
|
|
782
|
+
string;
|
|
596
783
|
/**
|
|
597
784
|
* Sets the user interface language. * Explicitly setting this parameter improves the performance and the quality of your search results. * See the [Interface
|
|
598
785
|
* Languages](https://developers.google.com/custom-search/docs/json_api_reference#wsInterfaceLanguages) section of [Internationalizing Queries and Results
|
|
599
786
|
* Presentation](https://developers.google.com/custom-search/docs/json_api_reference#wsInternationalizing) for more information, and [Supported Interface
|
|
600
787
|
* Languages](https://developers.google.com/custom-search/docs/json_api_reference#interfaceLanguages) for a list of supported languages.
|
|
601
788
|
*/
|
|
602
|
-
hl?:
|
|
789
|
+
hl?:
|
|
790
|
+
string;
|
|
603
791
|
/** Appends the specified query terms to the query, as if they were combined with a logical AND operator. */
|
|
604
|
-
hq?:
|
|
792
|
+
hq?:
|
|
793
|
+
string;
|
|
605
794
|
/** Returns black and white, grayscale, transparent, or color images. Acceptable values are: * `"color"` * `"gray"` * `"mono"`: black and white * `"trans"`: transparent background */
|
|
606
|
-
imgColorType?:
|
|
795
|
+
imgColorType?:
|
|
796
|
+
string;
|
|
607
797
|
/**
|
|
608
798
|
* Returns images of a specific dominant color. Acceptable values are: * `"black"` * `"blue"` * `"brown"` * `"gray"` * `"green"` * `"orange"` * `"pink"` * `"purple"` * `"red"` *
|
|
609
799
|
* `"teal"` * `"white"` * `"yellow"`
|
|
610
800
|
*/
|
|
611
|
-
imgDominantColor?:
|
|
801
|
+
imgDominantColor?:
|
|
802
|
+
string;
|
|
612
803
|
/** Returns images of a specified size. Acceptable values are: * `"huge"` * `"icon"` * `"large"` * `"medium"` * `"small"` * `"xlarge"` * `"xxlarge"` */
|
|
613
|
-
imgSize?:
|
|
804
|
+
imgSize?:
|
|
805
|
+
string;
|
|
614
806
|
/** Returns images of a type. Acceptable values are: * `"clipart"` * `"face"` * `"lineart"` * `"stock"` * `"photo"` * `"animated"` */
|
|
615
|
-
imgType?:
|
|
807
|
+
imgType?:
|
|
808
|
+
string;
|
|
616
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. */
|
|
617
|
-
key?:
|
|
810
|
+
key?:
|
|
811
|
+
string;
|
|
618
812
|
/** Specifies that all search results should contain a link to a particular URL. */
|
|
619
|
-
linkSite?:
|
|
813
|
+
linkSite?:
|
|
814
|
+
string;
|
|
620
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. */
|
|
621
|
-
lowRange?:
|
|
816
|
+
lowRange?:
|
|
817
|
+
string;
|
|
622
818
|
/**
|
|
623
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"`:
|
|
624
820
|
* Catalan * `"lang_cs"`: Czech * `"lang_da"`: Danish * `"lang_de"`: German * `"lang_el"`: Greek * `"lang_en"`: English * `"lang_es"`: Spanish * `"lang_et"`: Estonian *
|
|
@@ -627,136 +823,178 @@ declare namespace gapi.client {
|
|
|
627
823
|
* Polish * `"lang_pt"`: Portuguese * `"lang_ro"`: Romanian * `"lang_ru"`: Russian * `"lang_sk"`: Slovak * `"lang_sl"`: Slovenian * `"lang_sr"`: Serbian * `"lang_sv"`: Swedish *
|
|
628
824
|
* `"lang_tr"`: Turkish * `"lang_zh-CN"`: Chinese (Simplified) * `"lang_zh-TW"`: Chinese (Traditional)
|
|
629
825
|
*/
|
|
630
|
-
lr?:
|
|
826
|
+
lr?:
|
|
827
|
+
string;
|
|
631
828
|
/** Number of search results to return. * Valid values are integers between 1 and 10, inclusive. */
|
|
632
|
-
num?:
|
|
829
|
+
num?:
|
|
830
|
+
number;
|
|
633
831
|
/** OAuth 2.0 token for the current user. */
|
|
634
|
-
oauth_token?:
|
|
832
|
+
oauth_token?:
|
|
833
|
+
string;
|
|
635
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. */
|
|
636
|
-
orTerms?:
|
|
835
|
+
orTerms?:
|
|
836
|
+
string;
|
|
637
837
|
/** Returns response with indentations and line breaks. */
|
|
638
|
-
prettyPrint?:
|
|
838
|
+
prettyPrint?:
|
|
839
|
+
boolean;
|
|
639
840
|
/** Query */
|
|
640
|
-
q?:
|
|
841
|
+
q?:
|
|
842
|
+
string;
|
|
641
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. */
|
|
642
|
-
quotaUser?:
|
|
844
|
+
quotaUser?:
|
|
845
|
+
string;
|
|
643
846
|
/** Specifies that all search results should be pages that are related to the specified URL. */
|
|
644
|
-
relatedSite?:
|
|
847
|
+
relatedSite?:
|
|
848
|
+
string;
|
|
645
849
|
/**
|
|
646
850
|
* Filters based on licensing. Supported values include: `cc_publicdomain`, `cc_attribute`, `cc_sharealike`, `cc_noncommercial`, `cc_nonderived` and combinations of these. See
|
|
647
851
|
* [typical combinations](https://wiki.creativecommons.org/wiki/CC_Search_integration).
|
|
648
852
|
*/
|
|
649
|
-
rights?:
|
|
853
|
+
rights?:
|
|
854
|
+
string;
|
|
650
855
|
/** Search safety level. Acceptable values are: * `"active"`: Enables SafeSearch filtering. * `"off"`: Disables SafeSearch filtering. (default) */
|
|
651
|
-
safe?:
|
|
856
|
+
safe?:
|
|
857
|
+
string;
|
|
652
858
|
/** Specifies the search type: `image`. If unspecified, results are limited to webpages. Acceptable values are: * `"image"`: custom image search. */
|
|
653
|
-
searchType?:
|
|
859
|
+
searchType?:
|
|
860
|
+
string;
|
|
654
861
|
/** Specifies a given site which should always be included or excluded from results (see `siteSearchFilter` parameter, below). */
|
|
655
|
-
siteSearch?:
|
|
862
|
+
siteSearch?:
|
|
863
|
+
string;
|
|
656
864
|
/** Controls whether to include or exclude results from the site named in the `siteSearch` parameter. Acceptable values are: * `"e"`: exclude * `"i"`: include */
|
|
657
|
-
siteSearchFilter?:
|
|
865
|
+
siteSearchFilter?:
|
|
866
|
+
string;
|
|
658
867
|
/**
|
|
659
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:
|
|
660
869
|
* sort=date](https://developers.google.com/custom-search/docs/structured_search#sort-by-attribute).
|
|
661
870
|
*/
|
|
662
|
-
sort?:
|
|
871
|
+
sort?:
|
|
872
|
+
string;
|
|
663
873
|
/**
|
|
664
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
|
|
665
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
|
|
666
876
|
* error. Also note that the maximum value for `num` is 10.
|
|
667
877
|
*/
|
|
668
|
-
start?:
|
|
878
|
+
start?:
|
|
879
|
+
number;
|
|
669
880
|
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
670
|
-
upload_protocol?:
|
|
881
|
+
upload_protocol?:
|
|
882
|
+
string;
|
|
671
883
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
672
|
-
uploadType?:
|
|
884
|
+
uploadType?:
|
|
885
|
+
string;
|
|
673
886
|
}): Request<Search>;
|
|
674
887
|
}
|
|
675
888
|
interface CseResource {
|
|
676
889
|
/** Returns metadata about the search performed, metadata about the engine used for the search, and the search results. */
|
|
677
890
|
list(request?: {
|
|
678
891
|
/** V1 error format. */
|
|
679
|
-
"$.xgafv"?:
|
|
892
|
+
"$.xgafv"?:
|
|
893
|
+
string;
|
|
680
894
|
/** OAuth access token. */
|
|
681
|
-
access_token?:
|
|
895
|
+
access_token?:
|
|
896
|
+
string;
|
|
682
897
|
/** Data format for response. */
|
|
683
|
-
alt?:
|
|
898
|
+
alt?:
|
|
899
|
+
string;
|
|
684
900
|
/**
|
|
685
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
|
|
686
902
|
* parameter is 0 (zero), meaning that the feature is enabled. Supported values are: * `1`: Disabled * `0`: Enabled (default)
|
|
687
903
|
*/
|
|
688
|
-
c2coff?:
|
|
904
|
+
c2coff?:
|
|
905
|
+
string;
|
|
689
906
|
/** JSONP */
|
|
690
|
-
callback?:
|
|
907
|
+
callback?:
|
|
908
|
+
string;
|
|
691
909
|
/**
|
|
692
910
|
* Restricts search results to documents originating in a particular country. You may use [Boolean
|
|
693
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
|
|
694
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
|
|
695
913
|
* Values](https://developers.google.com/custom-search/docs/json_api_reference#countryCollections) page for a list of valid values for this parameter.
|
|
696
914
|
*/
|
|
697
|
-
cr?:
|
|
915
|
+
cr?:
|
|
916
|
+
string;
|
|
698
917
|
/** The Programmable Search Engine ID to use for this request. */
|
|
699
|
-
cx?:
|
|
918
|
+
cx?:
|
|
919
|
+
string;
|
|
700
920
|
/**
|
|
701
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
|
|
702
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
|
|
703
923
|
* years.
|
|
704
924
|
*/
|
|
705
|
-
dateRestrict?:
|
|
925
|
+
dateRestrict?:
|
|
926
|
+
string;
|
|
706
927
|
/** Identifies a phrase that all documents in the search results must contain. */
|
|
707
|
-
exactTerms?:
|
|
928
|
+
exactTerms?:
|
|
929
|
+
string;
|
|
708
930
|
/** Identifies a word or phrase that should not appear in any documents in the search results. */
|
|
709
|
-
excludeTerms?:
|
|
931
|
+
excludeTerms?:
|
|
932
|
+
string;
|
|
710
933
|
/** Selector specifying which fields to include in a partial response. */
|
|
711
|
-
fields?:
|
|
934
|
+
fields?:
|
|
935
|
+
string;
|
|
712
936
|
/**
|
|
713
937
|
* Restricts results to files of a specified extension. A list of file types indexable by Google can be found in Search Console [Help
|
|
714
938
|
* Center](https://support.google.com/webmasters/answer/35287).
|
|
715
939
|
*/
|
|
716
|
-
fileType?:
|
|
940
|
+
fileType?:
|
|
941
|
+
string;
|
|
717
942
|
/**
|
|
718
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
|
|
719
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
|
|
720
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.
|
|
721
946
|
*/
|
|
722
|
-
filter?:
|
|
947
|
+
filter?:
|
|
948
|
+
string;
|
|
723
949
|
/**
|
|
724
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.
|
|
725
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
|
|
726
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
|
|
727
953
|
* the United States.
|
|
728
954
|
*/
|
|
729
|
-
gl?:
|
|
955
|
+
gl?:
|
|
956
|
+
string;
|
|
730
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. */
|
|
731
|
-
googlehost?:
|
|
958
|
+
googlehost?:
|
|
959
|
+
string;
|
|
732
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. */
|
|
733
|
-
highRange?:
|
|
961
|
+
highRange?:
|
|
962
|
+
string;
|
|
734
963
|
/**
|
|
735
964
|
* Sets the user interface language. * Explicitly setting this parameter improves the performance and the quality of your search results. * See the [Interface
|
|
736
965
|
* Languages](https://developers.google.com/custom-search/docs/json_api_reference#wsInterfaceLanguages) section of [Internationalizing Queries and Results
|
|
737
966
|
* Presentation](https://developers.google.com/custom-search/docs/json_api_reference#wsInternationalizing) for more information, and [Supported Interface
|
|
738
967
|
* Languages](https://developers.google.com/custom-search/docs/json_api_reference#interfaceLanguages) for a list of supported languages.
|
|
739
968
|
*/
|
|
740
|
-
hl?:
|
|
969
|
+
hl?:
|
|
970
|
+
string;
|
|
741
971
|
/** Appends the specified query terms to the query, as if they were combined with a logical AND operator. */
|
|
742
|
-
hq?:
|
|
972
|
+
hq?:
|
|
973
|
+
string;
|
|
743
974
|
/** Returns black and white, grayscale, transparent, or color images. Acceptable values are: * `"color"` * `"gray"` * `"mono"`: black and white * `"trans"`: transparent background */
|
|
744
|
-
imgColorType?:
|
|
975
|
+
imgColorType?:
|
|
976
|
+
string;
|
|
745
977
|
/**
|
|
746
978
|
* Returns images of a specific dominant color. Acceptable values are: * `"black"` * `"blue"` * `"brown"` * `"gray"` * `"green"` * `"orange"` * `"pink"` * `"purple"` * `"red"` *
|
|
747
979
|
* `"teal"` * `"white"` * `"yellow"`
|
|
748
980
|
*/
|
|
749
|
-
imgDominantColor?:
|
|
981
|
+
imgDominantColor?:
|
|
982
|
+
string;
|
|
750
983
|
/** Returns images of a specified size. Acceptable values are: * `"huge"` * `"icon"` * `"large"` * `"medium"` * `"small"` * `"xlarge"` * `"xxlarge"` */
|
|
751
|
-
imgSize?:
|
|
984
|
+
imgSize?:
|
|
985
|
+
string;
|
|
752
986
|
/** Returns images of a type. Acceptable values are: * `"clipart"` * `"face"` * `"lineart"` * `"stock"` * `"photo"` * `"animated"` */
|
|
753
|
-
imgType?:
|
|
987
|
+
imgType?:
|
|
988
|
+
string;
|
|
754
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. */
|
|
755
|
-
key?:
|
|
990
|
+
key?:
|
|
991
|
+
string;
|
|
756
992
|
/** Specifies that all search results should contain a link to a particular URL. */
|
|
757
|
-
linkSite?:
|
|
993
|
+
linkSite?:
|
|
994
|
+
string;
|
|
758
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. */
|
|
759
|
-
lowRange?:
|
|
996
|
+
lowRange?:
|
|
997
|
+
string;
|
|
760
998
|
/**
|
|
761
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"`:
|
|
762
1000
|
* Catalan * `"lang_cs"`: Czech * `"lang_da"`: Danish * `"lang_de"`: German * `"lang_el"`: Greek * `"lang_en"`: English * `"lang_es"`: Spanish * `"lang_et"`: Estonian *
|
|
@@ -765,51 +1003,69 @@ declare namespace gapi.client {
|
|
|
765
1003
|
* Polish * `"lang_pt"`: Portuguese * `"lang_ro"`: Romanian * `"lang_ru"`: Russian * `"lang_sk"`: Slovak * `"lang_sl"`: Slovenian * `"lang_sr"`: Serbian * `"lang_sv"`: Swedish *
|
|
766
1004
|
* `"lang_tr"`: Turkish * `"lang_zh-CN"`: Chinese (Simplified) * `"lang_zh-TW"`: Chinese (Traditional)
|
|
767
1005
|
*/
|
|
768
|
-
lr?:
|
|
1006
|
+
lr?:
|
|
1007
|
+
string;
|
|
769
1008
|
/** Number of search results to return. * Valid values are integers between 1 and 10, inclusive. */
|
|
770
|
-
num?:
|
|
1009
|
+
num?:
|
|
1010
|
+
number;
|
|
771
1011
|
/** OAuth 2.0 token for the current user. */
|
|
772
|
-
oauth_token?:
|
|
1012
|
+
oauth_token?:
|
|
1013
|
+
string;
|
|
773
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. */
|
|
774
|
-
orTerms?:
|
|
1015
|
+
orTerms?:
|
|
1016
|
+
string;
|
|
775
1017
|
/** Returns response with indentations and line breaks. */
|
|
776
|
-
prettyPrint?:
|
|
1018
|
+
prettyPrint?:
|
|
1019
|
+
boolean;
|
|
777
1020
|
/** Query */
|
|
778
|
-
q?:
|
|
1021
|
+
q?:
|
|
1022
|
+
string;
|
|
779
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. */
|
|
780
|
-
quotaUser?:
|
|
1024
|
+
quotaUser?:
|
|
1025
|
+
string;
|
|
781
1026
|
/** Specifies that all search results should be pages that are related to the specified URL. */
|
|
782
|
-
relatedSite?:
|
|
1027
|
+
relatedSite?:
|
|
1028
|
+
string;
|
|
783
1029
|
/**
|
|
784
1030
|
* Filters based on licensing. Supported values include: `cc_publicdomain`, `cc_attribute`, `cc_sharealike`, `cc_noncommercial`, `cc_nonderived` and combinations of these. See
|
|
785
1031
|
* [typical combinations](https://wiki.creativecommons.org/wiki/CC_Search_integration).
|
|
786
1032
|
*/
|
|
787
|
-
rights?:
|
|
1033
|
+
rights?:
|
|
1034
|
+
string;
|
|
788
1035
|
/** Search safety level. Acceptable values are: * `"active"`: Enables SafeSearch filtering. * `"off"`: Disables SafeSearch filtering. (default) */
|
|
789
|
-
safe?:
|
|
1036
|
+
safe?:
|
|
1037
|
+
string;
|
|
790
1038
|
/** Specifies the search type: `image`. If unspecified, results are limited to webpages. Acceptable values are: * `"image"`: custom image search. */
|
|
791
|
-
searchType?:
|
|
1039
|
+
searchType?:
|
|
1040
|
+
string;
|
|
792
1041
|
/** Specifies a given site which should always be included or excluded from results (see `siteSearchFilter` parameter, below). */
|
|
793
|
-
siteSearch?:
|
|
1042
|
+
siteSearch?:
|
|
1043
|
+
string;
|
|
794
1044
|
/** Controls whether to include or exclude results from the site named in the `siteSearch` parameter. Acceptable values are: * `"e"`: exclude * `"i"`: include */
|
|
795
|
-
siteSearchFilter?:
|
|
1045
|
+
siteSearchFilter?:
|
|
1046
|
+
string;
|
|
796
1047
|
/**
|
|
797
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:
|
|
798
1049
|
* sort=date](https://developers.google.com/custom-search/docs/structured_search#sort-by-attribute).
|
|
799
1050
|
*/
|
|
800
|
-
sort?:
|
|
1051
|
+
sort?:
|
|
1052
|
+
string;
|
|
801
1053
|
/**
|
|
802
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
|
|
803
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
|
|
804
1056
|
* error. Also note that the maximum value for `num` is 10.
|
|
805
1057
|
*/
|
|
806
|
-
start?:
|
|
1058
|
+
start?:
|
|
1059
|
+
number;
|
|
807
1060
|
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
808
|
-
upload_protocol?:
|
|
1061
|
+
upload_protocol?:
|
|
1062
|
+
string;
|
|
809
1063
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
810
|
-
uploadType?:
|
|
1064
|
+
uploadType?:
|
|
1065
|
+
string;
|
|
811
1066
|
}): Request<Search>;
|
|
812
|
-
siterestrict:
|
|
1067
|
+
siterestrict:
|
|
1068
|
+
SiterestrictResource;
|
|
813
1069
|
}
|
|
814
1070
|
|
|
815
1071
|
const cse: CseResource;
|