-
Notifications
You must be signed in to change notification settings - Fork 1.2k
/
customsearch-api.json
1327 lines (1327 loc) · 77.5 KB
/
customsearch-api.json
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
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
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
{
"basePath": "",
"baseUrl": "https://customsearch.googleapis.com/",
"batchPath": "batch",
"description": "Searches over a website or collection of websites",
"discoveryVersion": "v1",
"documentationLink": "https://developers.google.com/custom-search/v1/introduction",
"icons": {
"x16": "http://www.google.com/images/icons/product/search-16.gif",
"x32": "http://www.google.com/images/icons/product/search-32.gif"
},
"id": "customsearch:v1",
"kind": "discovery#restDescription",
"mtlsRootUrl": "https://customsearch.mtls.googleapis.com/",
"name": "customsearch",
"ownerDomain": "google.com",
"ownerName": "Google",
"parameters": {
"$.xgafv": {
"description": "V1 error format.",
"enum": [
"1",
"2"
],
"enumDescriptions": [
"v1 error format",
"v2 error format"
],
"location": "query",
"type": "string"
},
"access_token": {
"description": "OAuth access token.",
"location": "query",
"type": "string"
},
"alt": {
"default": "json",
"description": "Data format for response.",
"enum": [
"json",
"media",
"proto"
],
"enumDescriptions": [
"Responses with Content-Type of application/json",
"Media download with context-dependent Content-Type",
"Responses with Content-Type of application/x-protobuf"
],
"location": "query",
"type": "string"
},
"callback": {
"description": "JSONP",
"location": "query",
"type": "string"
},
"fields": {
"description": "Selector specifying which fields to include in a partial response.",
"location": "query",
"type": "string"
},
"key": {
"description": "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.",
"location": "query",
"type": "string"
},
"oauth_token": {
"description": "OAuth 2.0 token for the current user.",
"location": "query",
"type": "string"
},
"prettyPrint": {
"default": "true",
"description": "Returns response with indentations and line breaks.",
"location": "query",
"type": "boolean"
},
"quotaUser": {
"description": "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.",
"location": "query",
"type": "string"
},
"uploadType": {
"description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
"location": "query",
"type": "string"
},
"upload_protocol": {
"description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
"location": "query",
"type": "string"
}
},
"protocol": "rest",
"resources": {
"cse": {
"methods": {
"list": {
"description": "Returns metadata about the search performed, metadata about the custom\nsearch engine used for the search, and the search results.",
"flatPath": "customsearch/v1",
"httpMethod": "GET",
"id": "search.cse.list",
"parameterOrder": [],
"parameters": {
"c2coff": {
"description": "Enables or disables [Simplified and Traditional Chinese\nSearch](https://developers.google.com/custom-search/docs/xml_results#chineseSearch).\n\nThe default value for this parameter is 0 (zero), meaning that the feature\nis enabled. Supported values are:\n\n* `1`: Disabled\n\n* `0`: Enabled (default)",
"location": "query",
"type": "string"
},
"cr": {
"description": "Restricts search results to documents originating in a particular country.\nYou may use [Boolean\noperators](https://developers.google.com/custom-search/docs/xml_results_appendices#booleanOperators)\nin the cr parameter's value.\n\nGoogle Search determines the country of a document by analyzing:\n\n* the top-level domain (TLD) of the document's URL\n\n* the geographic location of the Web server's IP address\n\nSee the [Country Parameter\nValues](https://developers.google.com/custom-search/docs/xml_results_appendices#countryCollections)\npage for a list of valid values for this parameter.",
"location": "query",
"type": "string"
},
"cx": {
"description": "The custom search engine ID to use for this request.",
"location": "query",
"type": "string"
},
"dateRestrict": {
"description": "Restricts results to URLs based on date. Supported values include:\n\n* `d[number]`: requests results from the specified number of past days.\n\n* `w[number]`: requests results from the specified number of past weeks.\n\n* `m[number]`: requests results from the specified number of past months.\n\n* `y[number]`: requests results from the specified number of past years.",
"location": "query",
"type": "string"
},
"exactTerms": {
"description": "Identifies a phrase that all documents in the search results must contain.",
"location": "query",
"type": "string"
},
"excludeTerms": {
"description": "Identifies a word or phrase that should not appear in any documents in the\nsearch results.",
"location": "query",
"type": "string"
},
"fileType": {
"description": "Restricts results to files of a specified extension. A list of file types\nindexable by Google can be found in Search Console [Help\nCenter](https://support.google.com/webmasters/answer/35287).",
"location": "query",
"type": "string"
},
"filter": {
"description": "Controls turning on or off the duplicate content filter.\n\n* See [Automatic\nFiltering](https://developers.google.com/custom-search/docs/xml_results#automaticFiltering)\nfor more information about Google's search results filters. Note that host\ncrowding filtering applies only to multi-site searches.\n\n* By default, Google applies filtering to all search results to improve the\nquality of those results.\n\nAcceptable values are:\n\n* `0`: Turns off duplicate content filter.\n\n* `1`: Turns on duplicate content filter.",
"location": "query",
"type": "string"
},
"gl": {
"description": "Geolocation of end user.\n\n* The `gl` parameter value is a two-letter country code. The `gl` parameter\nboosts search results whose country of origin matches the parameter value.\nSee the [Country\nCodes](https://developers.google.com/custom-search/docs/xml_results_appendices#countryCodes)\npage for a list of valid values.\n\n* Specifying a `gl` parameter value should lead to more relevant results.\nThis is particularly true for international customers and, even more\nspecifically, for customers in English- speaking countries other than the\nUnited States.",
"location": "query",
"type": "string"
},
"googlehost": {
"description": "**Deprecated**. Use the `gl` parameter for a similar effect.\n\nThe local Google domain (for example, google.com, google.de, or\ngoogle.fr) to use to perform the search.",
"location": "query",
"type": "string"
},
"highRange": {
"description": "Specifies the ending value for a search range.\n\n* Use `lowRange` and `highRange` to append an inclusive search range of\n`lowRange...highRange` to the query.",
"location": "query",
"type": "string"
},
"hl": {
"description": "Sets the user interface language.\n\n* Explicitly setting this parameter improves the performance and the\nquality of your search results.\n\n* See the [Interface\nLanguages](https://developers.google.com/custom-search/docs/xml_results#wsInterfaceLanguages)\nsection of [Internationalizing Queries and Results\nPresentation](https://developers.google.com/custom-search/docs/xml_results#wsInternationalizing)\nfor more information, and (Supported Interface\nLanguages)[https://developers.google.com/custom-search/docs/xml_results_appendices#interfaceLanguages]\nfor a list of supported languages.",
"location": "query",
"type": "string"
},
"hq": {
"description": "Appends the specified query terms to the query, as if they were combined\nwith a logical AND operator.",
"location": "query",
"type": "string"
},
"imgColorType": {
"description": "Returns black and white, grayscale, transparent, or color images.\nAcceptable values are:\n\n* `\"color\"`\n\n* `\"gray\"`\n\n* `\"mono\"`: black and white\n\n* `\"trans\"`: transparent background",
"enum": [
"imgColorTypeUndefined",
"mono",
"gray",
"color",
"trans"
],
"location": "query",
"type": "string"
},
"imgDominantColor": {
"description": "Returns images of a specific dominant color. Acceptable values are:\n\n* `\"black\"`\n\n* `\"blue\"`\n\n* `\"brown\"`\n\n* `\"gray\"`\n\n* `\"green\"`\n\n* `\"orange\"`\n\n* `\"pink\"`\n\n* `\"purple\"`\n\n* `\"red\"`\n\n* `\"teal\"`\n\n* `\"white\"`\n\n* `\"yellow\"`",
"enum": [
"imgDominantColorUndefined",
"black",
"blue",
"brown",
"gray",
"green",
"orange",
"pink",
"purple",
"red",
"teal",
"white",
"yellow"
],
"location": "query",
"type": "string"
},
"imgSize": {
"description": "Returns images of a specified size. Acceptable values are:\n\n* `\"huge\"`\n\n* `\"icon\"`\n\n* `\"large\"`\n\n* `\"medium\"`\n\n* `\"small\"`\n\n* `\"xlarge\"`\n\n* `\"xxlarge\"`",
"enum": [
"imgSizeUndefined",
"HUGE",
"ICON",
"LARGE",
"MEDIUM",
"SMALL",
"XLARGE",
"XXLARGE"
],
"location": "query",
"type": "string"
},
"imgType": {
"description": "Returns images of a type. Acceptable values are:\n\n* `\"clipart\"`\n\n* `\"face\"`\n\n* `\"lineart\"`\n\n* `\"stock\"`\n\n* `\"photo\"`\n\n* `\"animated\"`",
"enum": [
"imgTypeUndefined",
"clipart",
"face",
"lineart",
"stock",
"photo",
"animated"
],
"location": "query",
"type": "string"
},
"linkSite": {
"description": "Specifies that all search results should contain a link to a particular\nURL.",
"location": "query",
"type": "string"
},
"lowRange": {
"description": "Specifies the starting value for a search range. Use `lowRange` and\n`highRange` to append an inclusive search range of `lowRange...highRange`\nto the query.",
"location": "query",
"type": "string"
},
"lr": {
"description": "Restricts the search to documents written in a particular language (e.g.,\n`lr=lang_ja`).\n\nAcceptable values are:\n\n* `\"lang_ar\"`: Arabic\n\n* `\"lang_bg\"`: Bulgarian\n\n* `\"lang_ca\"`: Catalan\n\n* `\"lang_cs\"`: Czech\n\n* `\"lang_da\"`: Danish\n\n* `\"lang_de\"`: German\n\n* `\"lang_el\"`: Greek\n\n* `\"lang_en\"`: English\n\n* `\"lang_es\"`: Spanish\n\n* `\"lang_et\"`: Estonian\n\n* `\"lang_fi\"`: Finnish\n\n* `\"lang_fr\"`: French\n\n* `\"lang_hr\"`: Croatian\n\n* `\"lang_hu\"`: Hungarian\n\n* `\"lang_id\"`: Indonesian\n\n* `\"lang_is\"`: Icelandic\n\n* `\"lang_it\"`: Italian\n\n* `\"lang_iw\"`: Hebrew\n\n* `\"lang_ja\"`: Japanese\n\n* `\"lang_ko\"`: Korean\n\n* `\"lang_lt\"`: Lithuanian\n\n* `\"lang_lv\"`: Latvian\n\n* `\"lang_nl\"`: Dutch\n\n* `\"lang_no\"`: Norwegian\n\n* `\"lang_pl\"`: Polish\n\n* `\"lang_pt\"`: Portuguese\n\n* `\"lang_ro\"`: Romanian\n\n* `\"lang_ru\"`: Russian\n\n* `\"lang_sk\"`: Slovak\n\n* `\"lang_sl\"`: Slovenian\n\n* `\"lang_sr\"`: Serbian\n\n* `\"lang_sv\"`: Swedish\n\n* `\"lang_tr\"`: Turkish\n\n* `\"lang_zh-CN\"`: Chinese (Simplified)\n\n* `\"lang_zh-TW\"`: Chinese (Traditional)",
"location": "query",
"type": "string"
},
"num": {
"description": "Number of search results to return.\n\n* Valid values are integers between 1 and 10, inclusive.",
"format": "int32",
"location": "query",
"type": "integer"
},
"orTerms": {
"description": "Provides additional search terms to check for in a document, where each\ndocument in the search results must contain at least one of the additional\nsearch terms.",
"location": "query",
"type": "string"
},
"q": {
"description": "Query",
"location": "query",
"type": "string"
},
"relatedSite": {
"description": "Specifies that all search results should be pages that are related to the\nspecified URL.",
"location": "query",
"type": "string"
},
"rights": {
"description": "Filters based on licensing. Supported values include: `cc_publicdomain`,\n`cc_attribute`, `cc_sharealike`, `cc_noncommercial`, `cc_nonderived` and\ncombinations of these. See [typical\ncombinations](https://wiki.creativecommons.org/wiki/CC_Search_integration).",
"location": "query",
"type": "string"
},
"safe": {
"description": "Search safety level. Acceptable values are:\n\n* `\"active\"`: Enables SafeSearch filtering.\n\n* `\"off\"`: Disables SafeSearch filtering. (default)",
"enum": [
"safeUndefined",
"active",
"high",
"medium",
"off"
],
"location": "query",
"type": "string"
},
"searchType": {
"description": "Specifies the search type: `image`. If unspecified, results are limited to\nwebpages.\n\nAcceptable values are:\n\n* `\"image\"`: custom image search.",
"enum": [
"searchTypeUndefined",
"image"
],
"location": "query",
"type": "string"
},
"siteSearch": {
"description": "Specifies a given site which should always be included or excluded from\nresults (see `siteSearchFilter` parameter, below).",
"location": "query",
"type": "string"
},
"siteSearchFilter": {
"description": "Controls whether to include or exclude results from the site named in the\n`siteSearch` parameter.\n\nAcceptable values are:\n\n* `\"e\"`: exclude\n\n* `\"i\"`: include",
"enum": [
"siteSearchFilterUndefined",
"e",
"i"
],
"location": "query",
"type": "string"
},
"sort": {
"description": "The sort expression to apply to the results.",
"location": "query",
"type": "string"
},
"start": {
"description": "The index of the first result to return. The default number of results per\npage is 10, so `\u0026start=11` would start at the top of the second page of\nresults. **Note**: The JSON API will never return more than 100 results,\neven if more than 100 documents match the query, so setting the sum of\n`start + num` to a number greater than 100 will produce an error. Also note\nthat the maximum value for `num` is 10.",
"format": "uint32",
"location": "query",
"type": "integer"
}
},
"path": "customsearch/v1",
"response": {
"$ref": "Search"
}
}
},
"resources": {
"siterestrict": {
"methods": {
"list": {
"description": "Returns metadata about the search performed, metadata about the custom\nsearch engine used for the search, and the search results. Uses a small set\nof url patterns.",
"flatPath": "customsearch/v1/siterestrict",
"httpMethod": "GET",
"id": "search.cse.siterestrict.list",
"parameterOrder": [],
"parameters": {
"c2coff": {
"description": "Enables or disables [Simplified and Traditional Chinese\nSearch](https://developers.google.com/custom-search/docs/xml_results#chineseSearch).\n\nThe default value for this parameter is 0 (zero), meaning that the feature\nis enabled. Supported values are:\n\n* `1`: Disabled\n\n* `0`: Enabled (default)",
"location": "query",
"type": "string"
},
"cr": {
"description": "Restricts search results to documents originating in a particular country.\nYou may use [Boolean\noperators](https://developers.google.com/custom-search/docs/xml_results_appendices#booleanOperators)\nin the cr parameter's value.\n\nGoogle Search determines the country of a document by analyzing:\n\n* the top-level domain (TLD) of the document's URL\n\n* the geographic location of the Web server's IP address\n\nSee the [Country Parameter\nValues](https://developers.google.com/custom-search/docs/xml_results_appendices#countryCollections)\npage for a list of valid values for this parameter.",
"location": "query",
"type": "string"
},
"cx": {
"description": "The custom search engine ID to use for this request.",
"location": "query",
"type": "string"
},
"dateRestrict": {
"description": "Restricts results to URLs based on date. Supported values include:\n\n* `d[number]`: requests results from the specified number of past days.\n\n* `w[number]`: requests results from the specified number of past weeks.\n\n* `m[number]`: requests results from the specified number of past months.\n\n* `y[number]`: requests results from the specified number of past years.",
"location": "query",
"type": "string"
},
"exactTerms": {
"description": "Identifies a phrase that all documents in the search results must contain.",
"location": "query",
"type": "string"
},
"excludeTerms": {
"description": "Identifies a word or phrase that should not appear in any documents in the\nsearch results.",
"location": "query",
"type": "string"
},
"fileType": {
"description": "Restricts results to files of a specified extension. A list of file types\nindexable by Google can be found in Search Console [Help\nCenter](https://support.google.com/webmasters/answer/35287).",
"location": "query",
"type": "string"
},
"filter": {
"description": "Controls turning on or off the duplicate content filter.\n\n* See [Automatic\nFiltering](https://developers.google.com/custom-search/docs/xml_results#automaticFiltering)\nfor more information about Google's search results filters. Note that host\ncrowding filtering applies only to multi-site searches.\n\n* By default, Google applies filtering to all search results to improve the\nquality of those results.\n\nAcceptable values are:\n\n* `0`: Turns off duplicate content filter.\n\n* `1`: Turns on duplicate content filter.",
"location": "query",
"type": "string"
},
"gl": {
"description": "Geolocation of end user.\n\n* The `gl` parameter value is a two-letter country code. The `gl` parameter\nboosts search results whose country of origin matches the parameter value.\nSee the [Country\nCodes](https://developers.google.com/custom-search/docs/xml_results_appendices#countryCodes)\npage for a list of valid values.\n\n* Specifying a `gl` parameter value should lead to more relevant results.\nThis is particularly true for international customers and, even more\nspecifically, for customers in English- speaking countries other than the\nUnited States.",
"location": "query",
"type": "string"
},
"googlehost": {
"description": "**Deprecated**. Use the `gl` parameter for a similar effect.\n\nThe local Google domain (for example, google.com, google.de, or\ngoogle.fr) to use to perform the search.",
"location": "query",
"type": "string"
},
"highRange": {
"description": "Specifies the ending value for a search range.\n\n* Use `lowRange` and `highRange` to append an inclusive search range of\n`lowRange...highRange` to the query.",
"location": "query",
"type": "string"
},
"hl": {
"description": "Sets the user interface language.\n\n* Explicitly setting this parameter improves the performance and the\nquality of your search results.\n\n* See the [Interface\nLanguages](https://developers.google.com/custom-search/docs/xml_results#wsInterfaceLanguages)\nsection of [Internationalizing Queries and Results\nPresentation](https://developers.google.com/custom-search/docs/xml_results#wsInternationalizing)\nfor more information, and (Supported Interface\nLanguages)[https://developers.google.com/custom-search/docs/xml_results_appendices#interfaceLanguages]\nfor a list of supported languages.",
"location": "query",
"type": "string"
},
"hq": {
"description": "Appends the specified query terms to the query, as if they were combined\nwith a logical AND operator.",
"location": "query",
"type": "string"
},
"imgColorType": {
"description": "Returns black and white, grayscale, transparent, or color images.\nAcceptable values are:\n\n* `\"color\"`\n\n* `\"gray\"`\n\n* `\"mono\"`: black and white\n\n* `\"trans\"`: transparent background",
"enum": [
"imgColorTypeUndefined",
"mono",
"gray",
"color",
"trans"
],
"location": "query",
"type": "string"
},
"imgDominantColor": {
"description": "Returns images of a specific dominant color. Acceptable values are:\n\n* `\"black\"`\n\n* `\"blue\"`\n\n* `\"brown\"`\n\n* `\"gray\"`\n\n* `\"green\"`\n\n* `\"orange\"`\n\n* `\"pink\"`\n\n* `\"purple\"`\n\n* `\"red\"`\n\n* `\"teal\"`\n\n* `\"white\"`\n\n* `\"yellow\"`",
"enum": [
"imgDominantColorUndefined",
"black",
"blue",
"brown",
"gray",
"green",
"orange",
"pink",
"purple",
"red",
"teal",
"white",
"yellow"
],
"location": "query",
"type": "string"
},
"imgSize": {
"description": "Returns images of a specified size. Acceptable values are:\n\n* `\"huge\"`\n\n* `\"icon\"`\n\n* `\"large\"`\n\n* `\"medium\"`\n\n* `\"small\"`\n\n* `\"xlarge\"`\n\n* `\"xxlarge\"`",
"enum": [
"imgSizeUndefined",
"HUGE",
"ICON",
"LARGE",
"MEDIUM",
"SMALL",
"XLARGE",
"XXLARGE"
],
"location": "query",
"type": "string"
},
"imgType": {
"description": "Returns images of a type. Acceptable values are:\n\n* `\"clipart\"`\n\n* `\"face\"`\n\n* `\"lineart\"`\n\n* `\"stock\"`\n\n* `\"photo\"`\n\n* `\"animated\"`",
"enum": [
"imgTypeUndefined",
"clipart",
"face",
"lineart",
"stock",
"photo",
"animated"
],
"location": "query",
"type": "string"
},
"linkSite": {
"description": "Specifies that all search results should contain a link to a particular\nURL.",
"location": "query",
"type": "string"
},
"lowRange": {
"description": "Specifies the starting value for a search range. Use `lowRange` and\n`highRange` to append an inclusive search range of `lowRange...highRange`\nto the query.",
"location": "query",
"type": "string"
},
"lr": {
"description": "Restricts the search to documents written in a particular language (e.g.,\n`lr=lang_ja`).\n\nAcceptable values are:\n\n* `\"lang_ar\"`: Arabic\n\n* `\"lang_bg\"`: Bulgarian\n\n* `\"lang_ca\"`: Catalan\n\n* `\"lang_cs\"`: Czech\n\n* `\"lang_da\"`: Danish\n\n* `\"lang_de\"`: German\n\n* `\"lang_el\"`: Greek\n\n* `\"lang_en\"`: English\n\n* `\"lang_es\"`: Spanish\n\n* `\"lang_et\"`: Estonian\n\n* `\"lang_fi\"`: Finnish\n\n* `\"lang_fr\"`: French\n\n* `\"lang_hr\"`: Croatian\n\n* `\"lang_hu\"`: Hungarian\n\n* `\"lang_id\"`: Indonesian\n\n* `\"lang_is\"`: Icelandic\n\n* `\"lang_it\"`: Italian\n\n* `\"lang_iw\"`: Hebrew\n\n* `\"lang_ja\"`: Japanese\n\n* `\"lang_ko\"`: Korean\n\n* `\"lang_lt\"`: Lithuanian\n\n* `\"lang_lv\"`: Latvian\n\n* `\"lang_nl\"`: Dutch\n\n* `\"lang_no\"`: Norwegian\n\n* `\"lang_pl\"`: Polish\n\n* `\"lang_pt\"`: Portuguese\n\n* `\"lang_ro\"`: Romanian\n\n* `\"lang_ru\"`: Russian\n\n* `\"lang_sk\"`: Slovak\n\n* `\"lang_sl\"`: Slovenian\n\n* `\"lang_sr\"`: Serbian\n\n* `\"lang_sv\"`: Swedish\n\n* `\"lang_tr\"`: Turkish\n\n* `\"lang_zh-CN\"`: Chinese (Simplified)\n\n* `\"lang_zh-TW\"`: Chinese (Traditional)",
"location": "query",
"type": "string"
},
"num": {
"description": "Number of search results to return.\n\n* Valid values are integers between 1 and 10, inclusive.",
"format": "int32",
"location": "query",
"type": "integer"
},
"orTerms": {
"description": "Provides additional search terms to check for in a document, where each\ndocument in the search results must contain at least one of the additional\nsearch terms.",
"location": "query",
"type": "string"
},
"q": {
"description": "Query",
"location": "query",
"type": "string"
},
"relatedSite": {
"description": "Specifies that all search results should be pages that are related to the\nspecified URL.",
"location": "query",
"type": "string"
},
"rights": {
"description": "Filters based on licensing. Supported values include: `cc_publicdomain`,\n`cc_attribute`, `cc_sharealike`, `cc_noncommercial`, `cc_nonderived` and\ncombinations of these. See [typical\ncombinations](https://wiki.creativecommons.org/wiki/CC_Search_integration).",
"location": "query",
"type": "string"
},
"safe": {
"description": "Search safety level. Acceptable values are:\n\n* `\"active\"`: Enables SafeSearch filtering.\n\n* `\"off\"`: Disables SafeSearch filtering. (default)",
"enum": [
"safeUndefined",
"active",
"high",
"medium",
"off"
],
"location": "query",
"type": "string"
},
"searchType": {
"description": "Specifies the search type: `image`. If unspecified, results are limited to\nwebpages.\n\nAcceptable values are:\n\n* `\"image\"`: custom image search.",
"enum": [
"searchTypeUndefined",
"image"
],
"location": "query",
"type": "string"
},
"siteSearch": {
"description": "Specifies a given site which should always be included or excluded from\nresults (see `siteSearchFilter` parameter, below).",
"location": "query",
"type": "string"
},
"siteSearchFilter": {
"description": "Controls whether to include or exclude results from the site named in the\n`siteSearch` parameter.\n\nAcceptable values are:\n\n* `\"e\"`: exclude\n\n* `\"i\"`: include",
"enum": [
"siteSearchFilterUndefined",
"e",
"i"
],
"location": "query",
"type": "string"
},
"sort": {
"description": "The sort expression to apply to the results.",
"location": "query",
"type": "string"
},
"start": {
"description": "The index of the first result to return. The default number of results per\npage is 10, so `\u0026start=11` would start at the top of the second page of\nresults. **Note**: The JSON API will never return more than 100 results,\neven if more than 100 documents match the query, so setting the sum of\n`start + num` to a number greater than 100 will produce an error. Also note\nthat the maximum value for `num` is 10.",
"format": "uint32",
"location": "query",
"type": "integer"
}
},
"path": "customsearch/v1/siterestrict",
"response": {
"$ref": "Search"
}
}
}
}
}
}
},
"revision": "20200528",
"rootUrl": "https://customsearch.googleapis.com/",
"schemas": {
"Promotion": {
"description": "Promotion result.",
"id": "Promotion",
"properties": {
"bodyLines": {
"description": "An array of block objects for this promotion. See [Google WebSearch\nProtocol\nreference](https://developers.google.com/custom-search/docs/xml_results)\nfor more information.",
"items": {
"description": "Block object belonging to a promotion.",
"properties": {
"htmlTitle": {
"description": "The block object's text in HTML, if it has text.",
"type": "string"
},
"link": {
"description": "The anchor text of the block object's link, if it has a link.",
"type": "string"
},
"title": {
"description": "The block object's text, if it has text.",
"type": "string"
},
"url": {
"description": "The URL of the block object's link, if it has one.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"displayLink": {
"description": "An abridged version of this search's result URL, e.g. www.example.com.",
"type": "string"
},
"htmlTitle": {
"description": "The title of the promotion, in HTML.",
"type": "string"
},
"image": {
"description": "Image belonging to a promotion.",
"properties": {
"height": {
"description": "Image height in pixels.",
"format": "int32",
"type": "integer"
},
"source": {
"description": "URL of the image for this promotion link.",
"type": "string"
},
"width": {
"description": "Image width in pixels.",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"link": {
"description": "The URL of the promotion.",
"type": "string"
},
"title": {
"description": "The title of the promotion.",
"type": "string"
}
},
"type": "object"
},
"Result": {
"description": "A custom search result.",
"id": "Result",
"properties": {
"cacheId": {
"description": "Indicates the ID of Google's cached version of the search result.",
"type": "string"
},
"displayLink": {
"description": "An abridged version of this search result’s URL, e.g. www.example.com.",
"type": "string"
},
"fileFormat": {
"description": "The file format of the search result.",
"type": "string"
},
"formattedUrl": {
"description": "The URL displayed after the snippet for each search result.",
"type": "string"
},
"htmlFormattedUrl": {
"description": "The HTML-formatted URL displayed after the snippet for each search result.",
"type": "string"
},
"htmlSnippet": {
"description": "The snippet of the search result, in HTML.",
"type": "string"
},
"htmlTitle": {
"description": "The title of the search result, in HTML.",
"type": "string"
},
"image": {
"description": "Image belonging to a custom search result.",
"properties": {
"byteSize": {
"description": "The size of the image, in pixels.",
"format": "int32",
"type": "integer"
},
"contextLink": {
"description": "A URL pointing to the webpage hosting the image.",
"type": "string"
},
"height": {
"description": "The height of the image, in pixels.",
"format": "int32",
"type": "integer"
},
"thumbnailHeight": {
"description": "The height of the thumbnail image, in pixels.",
"format": "int32",
"type": "integer"
},
"thumbnailLink": {
"description": "A URL to the thumbnail image.",
"type": "string"
},
"thumbnailWidth": {
"description": "The width of the thumbnail image, in pixels.",
"format": "int32",
"type": "integer"
},
"width": {
"description": "The width of the image, in pixels.",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"kind": {
"description": "A unique identifier for the type of current object. For this API, it is\n`customsearch#result.`",
"type": "string"
},
"labels": {
"description": "Encapsulates all information about [refinement\nlabels](https://developers.google.com/custom-search/docs/xml_results).",
"items": {
"description": "Refinement label associated with a custom search result.",
"properties": {
"displayName": {
"description": "The display name of a refinement label. This is the name you should\ndisplay in your user interface.",
"type": "string"
},
"label_with_op": {
"description": "Refinement label and the associated refinement operation.",
"type": "string"
},
"name": {
"description": "The name of a refinement label, which you can use to refine searches.\nDon't display this in your user interface; instead, use displayName.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"link": {
"description": "The full URL to which the search result is pointing, e.g.\nhttp://www.example.com/foo/bar.",
"type": "string"
},
"mime": {
"description": "The MIME type of the search result.",
"type": "string"
},
"pagemap": {
"additionalProperties": {
"description": "Properties of the object.",
"type": "any"
},
"description": "Contains\n[PageMap](https://developers.google.com/custom-search/docs/structured_data#pagemaps)\ninformation for this search result.",
"type": "object"
},
"snippet": {
"description": "The snippet of the search result, in plain text.",
"type": "string"
},
"title": {
"description": "The title of the search result, in plain text.",
"type": "string"
}
},
"type": "object"
},
"Search": {
"description": "Response to a custom search request.",
"id": "Search",
"properties": {
"context": {
"additionalProperties": {
"description": "Properties of the object.",
"type": "any"
},
"description": "Metadata and refinements associated with the given search engine,\nincluding:\n\n* The name of the search engine that was used for the query.\n\n* A set of [facet\nobjects](https://developers.google.com/custom-search/docs/refinements#create)\n(refinements) you can use for refining a search.",
"type": "object"
},
"items": {
"description": "The current set of custom search results.",
"items": {
"$ref": "Result"
},
"type": "array"
},
"kind": {
"description": "Unique identifier for the type of current object. For this API, it is\ncustomsearch#search.",
"type": "string"
},
"promotions": {
"description": "The set of\n[promotions](https://developers.google.com/custom-search/docs/promotions).\nPresent only if the custom search engine's configuration files define any\npromotions for the given query.",
"items": {
"$ref": "Promotion"
},
"type": "array"
},
"queries": {
"description": "Query metadata for the previous, current, and next pages of results.",
"properties": {
"nextPage": {
"description": "Metadata representing the next page of results, if applicable.",
"items": {
"description": "Custom search request metadata.",
"properties": {
"count": {
"description": "Number of search results returned in this set.",
"format": "int32",
"type": "integer"
},
"cr": {
"description": "Restricts search results to documents originating in a particular\ncountry. You may use [Boolean\noperators](https://developers.google.com/custom-search/docs/xml_results#booleanOperators)\nin the `cr` parameter's value.\n\nGoogle WebSearch determines the country of a document by analyzing the\nfollowing:\n\n* The top-level domain (TLD) of the document's URL.\n\n* The geographic location of the web server's IP address.\n\nSee [Country (cr) Parameter\nValues](https://developers.google.com/custom-search/docs/xml_results#countryCollections)\nfor a list of valid values for this parameter.",
"type": "string"
},
"cx": {
"description": "The identifier of a custom search engine created using the Custom Search\n[Control Panel](https://cse.google.com/). This is a custom property not\ndefined in the OpenSearch spec. This parameter is **required**.",
"type": "string"
},
"dateRestrict": {
"description": "Restricts results to URLs based on date. Supported values include:\n\n* `d[number]`: requests results from the specified number of past days.\n\n* `w[number]`: requests results from the specified number of past weeks.\n\n* `m[number]`: requests results from the specified number of past months.\n\n* `y[number]`: requests results from the specified number of past years.",
"type": "string"
},
"disableCnTwTranslation": {
"description": "Enables or disables the [Simplified and Traditional Chinese\nSearch](https://developers.google.com/custom-search/docs/xml_results#chineseSearch)\nfeature.\n\nSupported values are:\n\n* `0`: enabled (default)\n\n* `1`: disabled",
"type": "string"
},
"exactTerms": {
"description": "Identifies a phrase that all documents in the search results must\ncontain.",
"type": "string"
},
"excludeTerms": {
"description": "Identifies a word or phrase that should not appear in any documents in\nthe search results.",
"type": "string"
},
"fileType": {
"description": "Restricts results to files of a specified extension. Filetypes supported\nby Google include:\n\n* Adobe Portable Document Format (`pdf`)\n\n* Adobe PostScript (`ps`)\n\n* Lotus 1-2-3 (`wk1`, `wk2`, `wk3`, `wk4`, `wk5`, `wki`, `wks`, `wku`)\n\n* Lotus WordPro (`lwp`)\n\n* Macwrite (`mw`)\n\n* Microsoft Excel (`xls`)\n\n* Microsoft PowerPoint (`ppt`)\n\n* Microsoft Word (`doc`)\n\n* Microsoft Works (`wks`, `wps`, `wdb`)\n\n* Microsoft Write (`wri`)\n\n* Rich Text Format (`rtf`)\n\n* Shockwave Flash (`swf`)\n\n* Text (`ans`, `txt`).\n\nAdditional filetypes may be added in the future. An up-to-date list can\nalways be found in Google's [file type\nFAQ](https://support.google.com/webmasters/answer/35287).",
"type": "string"
},
"filter": {
"description": "Activates or deactivates the automatic filtering of Google search\nresults. See [Automatic\nFiltering](https://developers.google.com/custom-search/docs/xml_results#automaticFiltering)\nfor more information about Google's search results filters. Valid values\nfor this parameter are:\n\n* `0`: Disabled\n\n* `1`: Enabled (default)\n\n**Note**: By default, Google applies filtering to all search results to\nimprove the quality of those results.",
"type": "string"
},
"gl": {
"description": "Boosts search results whose country of origin matches the parameter\nvalue. See [Country\nCodes](https://developers.google.com/custom-search/docs/xml_results#countryCodes)\nfor a list of valid values.\n\nSpecifying a `gl` parameter value in WebSearch requests should improve\nthe relevance of results. This is particularly true for international\ncustomers and, even more specifically, for customers in English-speaking\ncountries other than the United States.",
"type": "string"
},
"googleHost": {
"description": "Specifies the Google domain (for example, google.com, google.de, or\ngoogle.fr) to which the search should be limited.",
"type": "string"
},
"highRange": {
"description": "Specifies the ending value for a search range. Use `cse:lowRange` and\n`cse:highrange` to append an inclusive search range of\n`lowRange...highRange` to the query.",
"type": "string"
},
"hl": {
"description": "Specifies the interface language (host language) of your user interface.\nExplicitly setting this parameter improves the performance and the\nquality of your search results.\n\nSee the [Interface\nLanguages](https://developers.google.com/custom-search/docs/xml_results#wsInterfaceLanguages)\nsection of [Internationalizing Queries and Results\nPresentation](https://developers.google.com/custom-search/docs/xml_results#wsInternationalizing)\nfor more information, and [Supported Interface\nLanguages](https://developers.google.com/custom-search/docs/xml_results_appendices#interfaceLanguages)\nfor a list of supported languages.",
"type": "string"
},
"hq": {
"description": "Appends the specified query terms to the query, as if they were combined\nwith a logical `AND` operator.",
"type": "string"
},
"imgColorType": {
"description": "Restricts results to images of a specified color type. Supported values\n are:\n\n* `mono` (black and white)\n\n* `gray` (grayscale)\n\n* `color` (color)",
"type": "string"
},
"imgDominantColor": {
"description": "Restricts results to images with a specific dominant color. Supported\nvalues are:\n\n* `red`\n\n* `orange`\n\n* `yellow`\n\n* `green`\n\n* `teal`\n\n* `blue`\n\n* `purple`\n\n* `pink`\n\n* `white`\n\n* `gray`\n\n* `black`\n\n* `brown`",
"type": "string"
},
"imgSize": {
"description": "Restricts results to images of a specified size. Supported values are:\n\n* `icon` (small)\n\n* `small | medium | large | xlarge` (medium)\n\n* `xxlarge` (large)\n\n* `huge` (extra-large)",
"type": "string"
},
"imgType": {
"description": "Restricts results to images of a specified type. Supported values are:\n\n* `clipart` (Clip art)\n\n* `face` (Face)\n\n* `lineart` (Line drawing)\n\n* `photo` (Photo)\n\n* `animated` (Animated)\n\n* `stock` (Stock)",
"type": "string"
},
"inputEncoding": {
"description": "The character encoding supported for search requests.",
"type": "string"
},
"language": {
"description": "The language of the search results.",
"type": "string"
},
"linkSite": {
"description": "Specifies that all results should contain a link to a specific URL.",
"type": "string"
},
"lowRange": {
"description": "Specifies the starting value for a search range. Use `cse:lowRange` and\n`cse:highrange` to append an inclusive search range of\n`lowRange...highRange` to the query.",
"type": "string"
},
"orTerms": {
"description": "Provides additional search terms to check for in a document, where each\ndocument in the search results must contain at least one of the\nadditional search terms. You can also use the [Boolean\nOR](https://developers.google.com/custom-search/docs/xml_results#BooleanOrqt)\nquery term for this type of query.",
"type": "string"
},
"outputEncoding": {
"description": "The character encoding supported for search results.",
"type": "string"
},
"relatedSite": {
"description": "Specifies that all search results should be pages that are related to the\nspecified URL. The parameter value should be a URL.",
"type": "string"
},
"rights": {
"description": "Filters based on licensing. Supported values include:\n\n* `cc_publicdomain`\n\n* `cc_attribute`\n\n* `cc_sharealike`\n\n* `cc_noncommercial`\n\n* `cc_nonderived`",
"type": "string"
},
"safe": {
"description": "Specifies the [SafeSearch\nlevel](https://developers.google.com/custom-search/docs/xml_results#safeSearchLevels)\nused for filtering out adult results. This is a custom property not\ndefined in the OpenSearch spec. Valid parameter values are:\n\n* `\"off\"`: Disable SafeSearch\n\n* `\"active\"`: Enable SafeSearch",
"type": "string"
},
"searchTerms": {
"description": "The search terms entered by the user.",
"type": "string"
},
"searchType": {
"description": "Allowed values are `web` or `image`. If unspecified, results are limited\nto webpages.",
"type": "string"
},
"siteSearch": {
"description": "Restricts results to URLs from a specified site.",
"type": "string"
},
"siteSearchFilter": {
"description": "Specifies whether to include or exclude results from the site named in\nthe `sitesearch` parameter. Supported values are:\n\n* `i`: include content from site\n\n* `e`: exclude content from site",
"type": "string"
},
"sort": {
"description": "Specifies that results should be sorted according to the specified\nexpression. For example, sort by date.",
"type": "string"
},
"startIndex": {
"description": "The index of the current set of search results into the total set of\nresults, where the index of the first result is 1.",
"format": "int32",
"type": "integer"
},
"startPage": {
"description": "The page number of this set of results, where the page length is set by\nthe `count` property.",
"format": "int32",
"type": "integer"
},
"title": {
"description": "A description of the query.",
"type": "string"
},
"totalResults": {
"description": "Estimated number of total search results. May not be accurate.",
"format": "int64",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"previousPage": {
"description": "Metadata representing the previous page of results, if applicable.",
"items": {
"description": "Custom search request metadata.",
"properties": {
"count": {
"description": "Number of search results returned in this set.",
"format": "int32",
"type": "integer"
},
"cr": {
"description": "Restricts search results to documents originating in a particular\ncountry. You may use [Boolean\noperators](https://developers.google.com/custom-search/docs/xml_results#booleanOperators)\nin the `cr` parameter's value.\n\nGoogle WebSearch determines the country of a document by analyzing the\nfollowing:\n\n* The top-level domain (TLD) of the document's URL.\n\n* The geographic location of the web server's IP address.\n\nSee [Country (cr) Parameter\nValues](https://developers.google.com/custom-search/docs/xml_results#countryCollections)\nfor a list of valid values for this parameter.",
"type": "string"
},
"cx": {
"description": "The identifier of a custom search engine created using the Custom Search\n[Control Panel](https://cse.google.com/). This is a custom property not\ndefined in the OpenSearch spec. This parameter is **required**.",
"type": "string"
},
"dateRestrict": {
"description": "Restricts results to URLs based on date. Supported values include:\n\n* `d[number]`: requests results from the specified number of past days.\n\n* `w[number]`: requests results from the specified number of past weeks.\n\n* `m[number]`: requests results from the specified number of past months.\n\n* `y[number]`: requests results from the specified number of past years.",
"type": "string"
},
"disableCnTwTranslation": {
"description": "Enables or disables the [Simplified and Traditional Chinese\nSearch](https://developers.google.com/custom-search/docs/xml_results#chineseSearch)\nfeature.\n\nSupported values are:\n\n* `0`: enabled (default)\n\n* `1`: disabled",
"type": "string"
},
"exactTerms": {
"description": "Identifies a phrase that all documents in the search results must\ncontain.",
"type": "string"
},
"excludeTerms": {
"description": "Identifies a word or phrase that should not appear in any documents in\nthe search results.",
"type": "string"
},
"fileType": {
"description": "Restricts results to files of a specified extension. Filetypes supported\nby Google include:\n\n* Adobe Portable Document Format (`pdf`)\n\n* Adobe PostScript (`ps`)\n\n* Lotus 1-2-3 (`wk1`, `wk2`, `wk3`, `wk4`, `wk5`, `wki`, `wks`, `wku`)\n\n* Lotus WordPro (`lwp`)\n\n* Macwrite (`mw`)\n\n* Microsoft Excel (`xls`)\n\n* Microsoft PowerPoint (`ppt`)\n\n* Microsoft Word (`doc`)\n\n* Microsoft Works (`wks`, `wps`, `wdb`)\n\n* Microsoft Write (`wri`)\n\n* Rich Text Format (`rtf`)\n\n* Shockwave Flash (`swf`)\n\n* Text (`ans`, `txt`).\n\nAdditional filetypes may be added in the future. An up-to-date list can\nalways be found in Google's [file type\nFAQ](https://support.google.com/webmasters/answer/35287).",
"type": "string"
},
"filter": {
"description": "Activates or deactivates the automatic filtering of Google search\nresults. See [Automatic\nFiltering](https://developers.google.com/custom-search/docs/xml_results#automaticFiltering)\nfor more information about Google's search results filters. Valid values\nfor this parameter are:\n\n* `0`: Disabled\n\n* `1`: Enabled (default)\n\n**Note**: By default, Google applies filtering to all search results to\nimprove the quality of those results.",
"type": "string"
},
"gl": {
"description": "Boosts search results whose country of origin matches the parameter\nvalue. See [Country\nCodes](https://developers.google.com/custom-search/docs/xml_results#countryCodes)\nfor a list of valid values.\n\nSpecifying a `gl` parameter value in WebSearch requests should improve\nthe relevance of results. This is particularly true for international\ncustomers and, even more specifically, for customers in English-speaking\ncountries other than the United States.",
"type": "string"
},
"googleHost": {
"description": "Specifies the Google domain (for example, google.com, google.de, or\ngoogle.fr) to which the search should be limited.",
"type": "string"
},
"highRange": {
"description": "Specifies the ending value for a search range. Use `cse:lowRange` and\n`cse:highrange` to append an inclusive search range of\n`lowRange...highRange` to the query.",