Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 1 | { |
Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 2 | "basePath": "", |
Anthonios Partheniou | 10f4b67 | 2021-04-13 14:47:53 -0400 | [diff] [blame] | 3 | "baseUrl": "https://customsearch.googleapis.com/", |
| 4 | "batchPath": "batch", |
| 5 | "canonicalName": "CustomSearch API", |
Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 6 | "description": "Searches over a website or collection of websites", |
Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 7 | "discoveryVersion": "v1", |
Anthonios Partheniou | 10f4b67 | 2021-04-13 14:47:53 -0400 | [diff] [blame] | 8 | "documentationLink": "https://developers.google.com/custom-search/v1/introduction", |
| 9 | "icons": { |
| 10 | "x16": "http://www.google.com/images/icons/product/search-16.gif", |
| 11 | "x32": "http://www.google.com/images/icons/product/search-32.gif" |
| 12 | }, |
| 13 | "id": "customsearch:v1", |
| 14 | "kind": "discovery#restDescription", |
| 15 | "mtlsRootUrl": "https://customsearch.mtls.googleapis.com/", |
| 16 | "name": "customsearch", |
| 17 | "ownerDomain": "google.com", |
| 18 | "ownerName": "Google", |
Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 19 | "parameters": { |
Anthonios Partheniou | 10f4b67 | 2021-04-13 14:47:53 -0400 | [diff] [blame] | 20 | "$.xgafv": { |
| 21 | "description": "V1 error format.", |
Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 22 | "enum": [ |
Anthonios Partheniou | 10f4b67 | 2021-04-13 14:47:53 -0400 | [diff] [blame] | 23 | "1", |
| 24 | "2" |
Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 25 | ], |
Anthonios Partheniou | 10f4b67 | 2021-04-13 14:47:53 -0400 | [diff] [blame] | 26 | "enumDescriptions": [ |
| 27 | "v1 error format", |
| 28 | "v2 error format" |
| 29 | ], |
Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 30 | "location": "query", |
| 31 | "type": "string" |
| 32 | }, |
| 33 | "access_token": { |
| 34 | "description": "OAuth access token.", |
| 35 | "location": "query", |
| 36 | "type": "string" |
| 37 | }, |
Anthonios Partheniou | 10f4b67 | 2021-04-13 14:47:53 -0400 | [diff] [blame] | 38 | "alt": { |
| 39 | "default": "json", |
| 40 | "description": "Data format for response.", |
Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 41 | "enum": [ |
Anthonios Partheniou | 10f4b67 | 2021-04-13 14:47:53 -0400 | [diff] [blame] | 42 | "json", |
| 43 | "media", |
| 44 | "proto" |
| 45 | ], |
| 46 | "enumDescriptions": [ |
| 47 | "Responses with Content-Type of application/json", |
| 48 | "Media download with context-dependent Content-Type", |
| 49 | "Responses with Content-Type of application/x-protobuf" |
Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 50 | ], |
| 51 | "location": "query", |
Anthonios Partheniou | 10f4b67 | 2021-04-13 14:47:53 -0400 | [diff] [blame] | 52 | "type": "string" |
Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 53 | }, |
| 54 | "callback": { |
Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 55 | "description": "JSONP", |
Anthonios Partheniou | 10f4b67 | 2021-04-13 14:47:53 -0400 | [diff] [blame] | 56 | "location": "query", |
| 57 | "type": "string" |
| 58 | }, |
| 59 | "fields": { |
| 60 | "description": "Selector specifying which fields to include in a partial response.", |
| 61 | "location": "query", |
| 62 | "type": "string" |
| 63 | }, |
| 64 | "key": { |
| 65 | "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.", |
| 66 | "location": "query", |
| 67 | "type": "string" |
| 68 | }, |
| 69 | "oauth_token": { |
| 70 | "description": "OAuth 2.0 token for the current user.", |
| 71 | "location": "query", |
| 72 | "type": "string" |
| 73 | }, |
| 74 | "prettyPrint": { |
| 75 | "default": "true", |
| 76 | "description": "Returns response with indentations and line breaks.", |
| 77 | "location": "query", |
| 78 | "type": "boolean" |
| 79 | }, |
| 80 | "quotaUser": { |
| 81 | "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.", |
| 82 | "location": "query", |
| 83 | "type": "string" |
| 84 | }, |
| 85 | "uploadType": { |
| 86 | "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", |
| 87 | "location": "query", |
| 88 | "type": "string" |
| 89 | }, |
| 90 | "upload_protocol": { |
| 91 | "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", |
| 92 | "location": "query", |
Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 93 | "type": "string" |
| 94 | } |
| 95 | }, |
Anthonios Partheniou | 10f4b67 | 2021-04-13 14:47:53 -0400 | [diff] [blame] | 96 | "protocol": "rest", |
Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 97 | "resources": { |
| 98 | "cse": { |
Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 99 | "methods": { |
| 100 | "list": { |
Anthonios Partheniou | 10f4b67 | 2021-04-13 14:47:53 -0400 | [diff] [blame] | 101 | "description": "Returns metadata about the search performed, metadata about the engine used for the search, and the search results.", |
Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 102 | "flatPath": "customsearch/v1", |
| 103 | "httpMethod": "GET", |
Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 104 | "id": "search.cse.list", |
Anthonios Partheniou | 10f4b67 | 2021-04-13 14:47:53 -0400 | [diff] [blame] | 105 | "parameterOrder": [], |
Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 106 | "parameters": { |
Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 107 | "c2coff": { |
Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 108 | "description": "Enables or disables [Simplified and Traditional Chinese Search](https://developers.google.com/custom-search/docs/xml_results#chineseSearch). The default value for this parameter is 0 (zero), meaning that the feature is enabled. Supported values are: * `1`: Disabled * `0`: Enabled (default)", |
Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 109 | "location": "query", |
Anthonios Partheniou | 10f4b67 | 2021-04-13 14:47:53 -0400 | [diff] [blame] | 110 | "type": "string" |
Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 111 | }, |
Anthonios Partheniou | 10f4b67 | 2021-04-13 14:47:53 -0400 | [diff] [blame] | 112 | "cr": { |
| 113 | "description": "Restricts search results to documents originating in a particular country. You may use [Boolean operators](https://developers.google.com/custom-search/docs/xml_results_appendices#booleanOperators) in the cr parameter's value. Google Search determines the country of a document by analyzing: * the top-level domain (TLD) of the document's URL * the geographic location of the Web server's IP address See the [Country Parameter Values](https://developers.google.com/custom-search/docs/xml_results_appendices#countryCollections) page for a list of valid values for this parameter.", |
Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 114 | "location": "query", |
Anthonios Partheniou | 10f4b67 | 2021-04-13 14:47:53 -0400 | [diff] [blame] | 115 | "type": "string" |
| 116 | }, |
| 117 | "cx": { |
| 118 | "description": "The Programmable Search Engine ID to use for this request.", |
| 119 | "location": "query", |
| 120 | "type": "string" |
| 121 | }, |
| 122 | "dateRestrict": { |
| 123 | "description": "Restricts results to URLs based on date. Supported values include: * `d[number]`: requests results from the specified number of past days. * `w[number]`: requests results from the specified number of past weeks. * `m[number]`: requests results from the specified number of past months. * `y[number]`: requests results from the specified number of past years.", |
| 124 | "location": "query", |
| 125 | "type": "string" |
| 126 | }, |
| 127 | "exactTerms": { |
| 128 | "description": "Identifies a phrase that all documents in the search results must contain.", |
| 129 | "location": "query", |
| 130 | "type": "string" |
Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 131 | }, |
| 132 | "excludeTerms": { |
Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 133 | "description": "Identifies a word or phrase that should not appear in any documents in the search results.", |
Anthonios Partheniou | 10f4b67 | 2021-04-13 14:47:53 -0400 | [diff] [blame] | 134 | "location": "query", |
| 135 | "type": "string" |
| 136 | }, |
| 137 | "fileType": { |
| 138 | "description": "Restricts results to files of a specified extension. A list of file types indexable by Google can be found in Search Console [Help Center](https://support.google.com/webmasters/answer/35287).", |
| 139 | "location": "query", |
| 140 | "type": "string" |
| 141 | }, |
| 142 | "filter": { |
| 143 | "description": "Controls turning on or off the duplicate content filter. * See [Automatic Filtering](https://developers.google.com/custom-search/docs/xml_results#automaticFiltering) for more information about Google's search results filters. Note that host crowding filtering applies only to multi-site searches. * By default, Google applies filtering to all search results to improve the quality of those results. Acceptable values are: * `0`: Turns off duplicate content filter. * `1`: Turns on duplicate content filter.", |
| 144 | "location": "query", |
| 145 | "type": "string" |
| 146 | }, |
| 147 | "gl": { |
| 148 | "description": "Geolocation of end user. * The `gl` parameter value is a two-letter country code. The `gl` parameter boosts search results whose country of origin matches the parameter value. See the [Country Codes](https://developers.google.com/custom-search/docs/xml_results_appendices#countryCodes) page for a list of valid values. * Specifying a `gl` parameter value should lead to more relevant results. This is particularly true for international customers and, even more specifically, for customers in English- speaking countries other than the United States.", |
| 149 | "location": "query", |
| 150 | "type": "string" |
| 151 | }, |
| 152 | "googlehost": { |
| 153 | "description": "**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.", |
| 154 | "location": "query", |
| 155 | "type": "string" |
| 156 | }, |
| 157 | "highRange": { |
| 158 | "description": "Specifies the ending value for a search range. * Use `lowRange` and `highRange` to append an inclusive search range of `lowRange...highRange` to the query.", |
| 159 | "location": "query", |
| 160 | "type": "string" |
| 161 | }, |
| 162 | "hl": { |
| 163 | "description": "Sets the user interface language. * Explicitly setting this parameter improves the performance and the quality of your search results. * See the [Interface Languages](https://developers.google.com/custom-search/docs/xml_results#wsInterfaceLanguages) section of [Internationalizing Queries and Results Presentation](https://developers.google.com/custom-search/docs/xml_results#wsInternationalizing) for more information, and (Supported Interface Languages)[https://developers.google.com/custom-search/docs/xml_results_appendices#interfaceLanguages] for a list of supported languages.", |
| 164 | "location": "query", |
| 165 | "type": "string" |
| 166 | }, |
| 167 | "hq": { |
| 168 | "description": "Appends the specified query terms to the query, as if they were combined with a logical AND operator.", |
| 169 | "location": "query", |
Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 170 | "type": "string" |
| 171 | }, |
| 172 | "imgColorType": { |
Anthonios Partheniou | 10f4b67 | 2021-04-13 14:47:53 -0400 | [diff] [blame] | 173 | "description": "Returns black and white, grayscale, transparent, or color images. Acceptable values are: * `\"color\"` * `\"gray\"` * `\"mono\"`: black and white * `\"trans\"`: transparent background", |
| 174 | "enum": [ |
| 175 | "imgColorTypeUndefined", |
| 176 | "mono", |
| 177 | "gray", |
| 178 | "color", |
| 179 | "trans" |
| 180 | ], |
Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 181 | "enumDescriptions": [ |
| 182 | "No image color type specified.", |
| 183 | "Black and white images only.", |
| 184 | "Grayscale images only.", |
| 185 | "Color images only.", |
| 186 | "Images with transparent background" |
| 187 | ], |
| 188 | "location": "query", |
Anthonios Partheniou | 10f4b67 | 2021-04-13 14:47:53 -0400 | [diff] [blame] | 189 | "type": "string" |
Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 190 | }, |
| 191 | "imgDominantColor": { |
Anthonios Partheniou | 10f4b67 | 2021-04-13 14:47:53 -0400 | [diff] [blame] | 192 | "description": "Returns images of a specific dominant color. Acceptable values are: * `\"black\"` * `\"blue\"` * `\"brown\"` * `\"gray\"` * `\"green\"` * `\"orange\"` * `\"pink\"` * `\"purple\"` * `\"red\"` * `\"teal\"` * `\"white\"` * `\"yellow\"`", |
Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 193 | "enum": [ |
| 194 | "imgDominantColorUndefined", |
| 195 | "black", |
| 196 | "blue", |
| 197 | "brown", |
| 198 | "gray", |
| 199 | "green", |
| 200 | "orange", |
| 201 | "pink", |
| 202 | "purple", |
| 203 | "red", |
| 204 | "teal", |
| 205 | "white", |
| 206 | "yellow" |
| 207 | ], |
| 208 | "enumDescriptions": [ |
| 209 | "No dominant color specified.", |
| 210 | "Predominantly black images only.", |
| 211 | "Predominantly blue images only.", |
| 212 | "Predominantly brown images only.", |
| 213 | "Predominantly gray images only.", |
| 214 | "Predominantly green images only.", |
| 215 | "Predominantly orange images only.", |
| 216 | "Predominantly pink images only.", |
| 217 | "Predominantly purple images only.", |
| 218 | "Predominantly red images only.", |
| 219 | "Predominantly teal images only.", |
| 220 | "Predominantly white images only.", |
| 221 | "Predominantly yellow images only." |
| 222 | ], |
| 223 | "location": "query", |
Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 224 | "type": "string" |
| 225 | }, |
Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 226 | "imgSize": { |
Anthonios Partheniou | 10f4b67 | 2021-04-13 14:47:53 -0400 | [diff] [blame] | 227 | "description": "Returns images of a specified size. Acceptable values are: * `\"huge\"` * `\"icon\"` * `\"large\"` * `\"medium\"` * `\"small\"` * `\"xlarge\"` * `\"xxlarge\"`", |
Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 228 | "enum": [ |
| 229 | "imgSizeUndefined", |
| 230 | "HUGE", |
| 231 | "ICON", |
| 232 | "LARGE", |
| 233 | "MEDIUM", |
| 234 | "SMALL", |
| 235 | "XLARGE", |
| 236 | "XXLARGE" |
| 237 | ], |
Anthonios Partheniou | 10f4b67 | 2021-04-13 14:47:53 -0400 | [diff] [blame] | 238 | "enumDescriptions": [ |
| 239 | "No image size specified.", |
| 240 | "Only the largest possible images.", |
| 241 | "Only very small icon-sized images.", |
| 242 | "Only large images.", |
| 243 | "Only medium images.", |
| 244 | "Only small images.", |
| 245 | "Only very large images.", |
| 246 | "Only extremely large images." |
| 247 | ], |
Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 248 | "location": "query", |
Anthonios Partheniou | 10f4b67 | 2021-04-13 14:47:53 -0400 | [diff] [blame] | 249 | "type": "string" |
| 250 | }, |
| 251 | "imgType": { |
| 252 | "description": "Returns images of a type. Acceptable values are: * `\"clipart\"` * `\"face\"` * `\"lineart\"` * `\"stock\"` * `\"photo\"` * `\"animated\"`", |
| 253 | "enum": [ |
| 254 | "imgTypeUndefined", |
| 255 | "clipart", |
| 256 | "face", |
| 257 | "lineart", |
| 258 | "stock", |
| 259 | "photo", |
| 260 | "animated" |
| 261 | ], |
| 262 | "enumDescriptions": [ |
| 263 | "No image type specified.", |
| 264 | "Clipart-style images only.", |
| 265 | "Images of faces only.", |
| 266 | "Line art images only.", |
| 267 | "Stock images only.", |
| 268 | "Photo images only.", |
| 269 | "Animated images only." |
| 270 | ], |
| 271 | "location": "query", |
| 272 | "type": "string" |
| 273 | }, |
| 274 | "linkSite": { |
| 275 | "description": "Specifies that all search results should contain a link to a particular URL.", |
| 276 | "location": "query", |
| 277 | "type": "string" |
| 278 | }, |
| 279 | "lowRange": { |
| 280 | "description": "Specifies the starting value for a search range. Use `lowRange` and `highRange` to append an inclusive search range of `lowRange...highRange` to the query.", |
| 281 | "location": "query", |
| 282 | "type": "string" |
| 283 | }, |
| 284 | "lr": { |
| 285 | "description": "Restricts the search to documents written in a particular language (e.g., `lr=lang_ja`). Acceptable values are: * `\"lang_ar\"`: Arabic * `\"lang_bg\"`: Bulgarian * `\"lang_ca\"`: Catalan * `\"lang_cs\"`: Czech * `\"lang_da\"`: Danish * `\"lang_de\"`: German * `\"lang_el\"`: Greek * `\"lang_en\"`: English * `\"lang_es\"`: Spanish * `\"lang_et\"`: Estonian * `\"lang_fi\"`: Finnish * `\"lang_fr\"`: French * `\"lang_hr\"`: Croatian * `\"lang_hu\"`: Hungarian * `\"lang_id\"`: Indonesian * `\"lang_is\"`: Icelandic * `\"lang_it\"`: Italian * `\"lang_iw\"`: Hebrew * `\"lang_ja\"`: Japanese * `\"lang_ko\"`: Korean * `\"lang_lt\"`: Lithuanian * `\"lang_lv\"`: Latvian * `\"lang_nl\"`: Dutch * `\"lang_no\"`: Norwegian * `\"lang_pl\"`: Polish * `\"lang_pt\"`: Portuguese * `\"lang_ro\"`: Romanian * `\"lang_ru\"`: Russian * `\"lang_sk\"`: Slovak * `\"lang_sl\"`: Slovenian * `\"lang_sr\"`: Serbian * `\"lang_sv\"`: Swedish * `\"lang_tr\"`: Turkish * `\"lang_zh-CN\"`: Chinese (Simplified) * `\"lang_zh-TW\"`: Chinese (Traditional)", |
| 286 | "location": "query", |
| 287 | "type": "string" |
| 288 | }, |
| 289 | "num": { |
| 290 | "description": "Number of search results to return. * Valid values are integers between 1 and 10, inclusive.", |
| 291 | "format": "int32", |
| 292 | "location": "query", |
| 293 | "type": "integer" |
| 294 | }, |
| 295 | "orTerms": { |
| 296 | "description": "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.", |
| 297 | "location": "query", |
| 298 | "type": "string" |
| 299 | }, |
| 300 | "q": { |
| 301 | "description": "Query", |
| 302 | "location": "query", |
| 303 | "type": "string" |
| 304 | }, |
| 305 | "relatedSite": { |
| 306 | "description": "Specifies that all search results should be pages that are related to the specified URL.", |
| 307 | "location": "query", |
| 308 | "type": "string" |
| 309 | }, |
| 310 | "rights": { |
| 311 | "description": "Filters based on licensing. Supported values include: `cc_publicdomain`, `cc_attribute`, `cc_sharealike`, `cc_noncommercial`, `cc_nonderived` and combinations of these. See [typical combinations](https://wiki.creativecommons.org/wiki/CC_Search_integration).", |
| 312 | "location": "query", |
| 313 | "type": "string" |
| 314 | }, |
| 315 | "safe": { |
| 316 | "description": "Search safety level. Acceptable values are: * `\"active\"`: Enables SafeSearch filtering. * `\"off\"`: Disables SafeSearch filtering. (default)", |
| 317 | "enum": [ |
| 318 | "safeUndefined", |
| 319 | "active", |
| 320 | "high", |
| 321 | "medium", |
| 322 | "off" |
| 323 | ], |
| 324 | "enumDescriptions": [ |
| 325 | "SafeSearch mode unspecified. (Falls back to engine's configuration.)", |
| 326 | "Turn SafeSearch on.", |
| 327 | "Deprecated, equivalent to \"active\".", |
| 328 | "Deprecated, equivalent to \"active\".", |
| 329 | "Turn SafeSearch off." |
| 330 | ], |
| 331 | "location": "query", |
| 332 | "type": "string" |
| 333 | }, |
| 334 | "searchType": { |
| 335 | "description": "Specifies the search type: `image`. If unspecified, results are limited to webpages. Acceptable values are: * `\"image\"`: custom image search.", |
| 336 | "enum": [ |
| 337 | "searchTypeUndefined", |
| 338 | "image" |
| 339 | ], |
| 340 | "enumDescriptions": [ |
| 341 | "Search type unspecified (defaults to web search).", |
| 342 | "Image search." |
| 343 | ], |
| 344 | "location": "query", |
| 345 | "type": "string" |
| 346 | }, |
| 347 | "siteSearch": { |
| 348 | "description": "Specifies a given site which should always be included or excluded from results (see `siteSearchFilter` parameter, below).", |
| 349 | "location": "query", |
| 350 | "type": "string" |
| 351 | }, |
| 352 | "siteSearchFilter": { |
| 353 | "description": "Controls whether to include or exclude results from the site named in the `siteSearch` parameter. Acceptable values are: * `\"e\"`: exclude * `\"i\"`: include", |
| 354 | "enum": [ |
| 355 | "siteSearchFilterUndefined", |
| 356 | "e", |
| 357 | "i" |
| 358 | ], |
| 359 | "enumDescriptions": [ |
| 360 | "Filter mode unspecified.", |
| 361 | "Exclude results from the listed sites.", |
| 362 | "Include only results from the listed sites." |
| 363 | ], |
| 364 | "location": "query", |
| 365 | "type": "string" |
| 366 | }, |
| 367 | "sort": { |
| 368 | "description": "The sort expression to apply to the results. The sort parameter specifies that the results be sorted according to the specified expression i.e. sort by date. [Example: sort=date](https://developers.google.com/custom-search/docs/structured_search#sort-by-attribute).", |
| 369 | "location": "query", |
| 370 | "type": "string" |
| 371 | }, |
| 372 | "start": { |
| 373 | "description": "The index of the first result to return. The default number of results per page is 10, so `&start=11` would start at the top of the second page of results. **Note**: The JSON API will never return more than 100 results, even if more than 100 documents match the query, so setting the sum of `start + num` to a number greater than 100 will produce an error. Also note that the maximum value for `num` is 10.", |
| 374 | "format": "uint32", |
| 375 | "location": "query", |
| 376 | "type": "integer" |
Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 377 | } |
| 378 | }, |
Anthonios Partheniou | 10f4b67 | 2021-04-13 14:47:53 -0400 | [diff] [blame] | 379 | "path": "customsearch/v1", |
| 380 | "response": { |
| 381 | "$ref": "Search" |
| 382 | } |
| 383 | } |
| 384 | }, |
| 385 | "resources": { |
| 386 | "siterestrict": { |
| 387 | "methods": { |
| 388 | "list": { |
| 389 | "description": "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.", |
| 390 | "flatPath": "customsearch/v1/siterestrict", |
| 391 | "httpMethod": "GET", |
| 392 | "id": "search.cse.siterestrict.list", |
| 393 | "parameterOrder": [], |
| 394 | "parameters": { |
| 395 | "c2coff": { |
| 396 | "description": "Enables or disables [Simplified and Traditional Chinese Search](https://developers.google.com/custom-search/docs/xml_results#chineseSearch). The default value for this parameter is 0 (zero), meaning that the feature is enabled. Supported values are: * `1`: Disabled * `0`: Enabled (default)", |
| 397 | "location": "query", |
| 398 | "type": "string" |
| 399 | }, |
| 400 | "cr": { |
| 401 | "description": "Restricts search results to documents originating in a particular country. You may use [Boolean operators](https://developers.google.com/custom-search/docs/xml_results_appendices#booleanOperators) in the cr parameter's value. Google Search determines the country of a document by analyzing: * the top-level domain (TLD) of the document's URL * the geographic location of the Web server's IP address See the [Country Parameter Values](https://developers.google.com/custom-search/docs/xml_results_appendices#countryCollections) page for a list of valid values for this parameter.", |
| 402 | "location": "query", |
| 403 | "type": "string" |
| 404 | }, |
| 405 | "cx": { |
| 406 | "description": "The Programmable Search Engine ID to use for this request.", |
| 407 | "location": "query", |
| 408 | "type": "string" |
| 409 | }, |
| 410 | "dateRestrict": { |
| 411 | "description": "Restricts results to URLs based on date. Supported values include: * `d[number]`: requests results from the specified number of past days. * `w[number]`: requests results from the specified number of past weeks. * `m[number]`: requests results from the specified number of past months. * `y[number]`: requests results from the specified number of past years.", |
| 412 | "location": "query", |
| 413 | "type": "string" |
| 414 | }, |
| 415 | "exactTerms": { |
| 416 | "description": "Identifies a phrase that all documents in the search results must contain.", |
| 417 | "location": "query", |
| 418 | "type": "string" |
| 419 | }, |
| 420 | "excludeTerms": { |
| 421 | "description": "Identifies a word or phrase that should not appear in any documents in the search results.", |
| 422 | "location": "query", |
| 423 | "type": "string" |
| 424 | }, |
| 425 | "fileType": { |
| 426 | "description": "Restricts results to files of a specified extension. A list of file types indexable by Google can be found in Search Console [Help Center](https://support.google.com/webmasters/answer/35287).", |
| 427 | "location": "query", |
| 428 | "type": "string" |
| 429 | }, |
| 430 | "filter": { |
| 431 | "description": "Controls turning on or off the duplicate content filter. * See [Automatic Filtering](https://developers.google.com/custom-search/docs/xml_results#automaticFiltering) for more information about Google's search results filters. Note that host crowding filtering applies only to multi-site searches. * By default, Google applies filtering to all search results to improve the quality of those results. Acceptable values are: * `0`: Turns off duplicate content filter. * `1`: Turns on duplicate content filter.", |
| 432 | "location": "query", |
| 433 | "type": "string" |
| 434 | }, |
| 435 | "gl": { |
| 436 | "description": "Geolocation of end user. * The `gl` parameter value is a two-letter country code. The `gl` parameter boosts search results whose country of origin matches the parameter value. See the [Country Codes](https://developers.google.com/custom-search/docs/xml_results_appendices#countryCodes) page for a list of valid values. * Specifying a `gl` parameter value should lead to more relevant results. This is particularly true for international customers and, even more specifically, for customers in English- speaking countries other than the United States.", |
| 437 | "location": "query", |
| 438 | "type": "string" |
| 439 | }, |
| 440 | "googlehost": { |
| 441 | "description": "**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.", |
| 442 | "location": "query", |
| 443 | "type": "string" |
| 444 | }, |
| 445 | "highRange": { |
| 446 | "description": "Specifies the ending value for a search range. * Use `lowRange` and `highRange` to append an inclusive search range of `lowRange...highRange` to the query.", |
| 447 | "location": "query", |
| 448 | "type": "string" |
| 449 | }, |
| 450 | "hl": { |
| 451 | "description": "Sets the user interface language. * Explicitly setting this parameter improves the performance and the quality of your search results. * See the [Interface Languages](https://developers.google.com/custom-search/docs/xml_results#wsInterfaceLanguages) section of [Internationalizing Queries and Results Presentation](https://developers.google.com/custom-search/docs/xml_results#wsInternationalizing) for more information, and (Supported Interface Languages)[https://developers.google.com/custom-search/docs/xml_results_appendices#interfaceLanguages] for a list of supported languages.", |
| 452 | "location": "query", |
| 453 | "type": "string" |
| 454 | }, |
| 455 | "hq": { |
| 456 | "description": "Appends the specified query terms to the query, as if they were combined with a logical AND operator.", |
| 457 | "location": "query", |
| 458 | "type": "string" |
| 459 | }, |
| 460 | "imgColorType": { |
| 461 | "description": "Returns black and white, grayscale, transparent, or color images. Acceptable values are: * `\"color\"` * `\"gray\"` * `\"mono\"`: black and white * `\"trans\"`: transparent background", |
| 462 | "enum": [ |
| 463 | "imgColorTypeUndefined", |
| 464 | "mono", |
| 465 | "gray", |
| 466 | "color", |
| 467 | "trans" |
| 468 | ], |
| 469 | "enumDescriptions": [ |
| 470 | "No image color type specified.", |
| 471 | "Black and white images only.", |
| 472 | "Grayscale images only.", |
| 473 | "Color images only.", |
| 474 | "Images with transparent background" |
| 475 | ], |
| 476 | "location": "query", |
| 477 | "type": "string" |
| 478 | }, |
| 479 | "imgDominantColor": { |
| 480 | "description": "Returns images of a specific dominant color. Acceptable values are: * `\"black\"` * `\"blue\"` * `\"brown\"` * `\"gray\"` * `\"green\"` * `\"orange\"` * `\"pink\"` * `\"purple\"` * `\"red\"` * `\"teal\"` * `\"white\"` * `\"yellow\"`", |
| 481 | "enum": [ |
| 482 | "imgDominantColorUndefined", |
| 483 | "black", |
| 484 | "blue", |
| 485 | "brown", |
| 486 | "gray", |
| 487 | "green", |
| 488 | "orange", |
| 489 | "pink", |
| 490 | "purple", |
| 491 | "red", |
| 492 | "teal", |
| 493 | "white", |
| 494 | "yellow" |
| 495 | ], |
| 496 | "enumDescriptions": [ |
| 497 | "No dominant color specified.", |
| 498 | "Predominantly black images only.", |
| 499 | "Predominantly blue images only.", |
| 500 | "Predominantly brown images only.", |
| 501 | "Predominantly gray images only.", |
| 502 | "Predominantly green images only.", |
| 503 | "Predominantly orange images only.", |
| 504 | "Predominantly pink images only.", |
| 505 | "Predominantly purple images only.", |
| 506 | "Predominantly red images only.", |
| 507 | "Predominantly teal images only.", |
| 508 | "Predominantly white images only.", |
| 509 | "Predominantly yellow images only." |
| 510 | ], |
| 511 | "location": "query", |
| 512 | "type": "string" |
| 513 | }, |
| 514 | "imgSize": { |
| 515 | "description": "Returns images of a specified size. Acceptable values are: * `\"huge\"` * `\"icon\"` * `\"large\"` * `\"medium\"` * `\"small\"` * `\"xlarge\"` * `\"xxlarge\"`", |
| 516 | "enum": [ |
| 517 | "imgSizeUndefined", |
| 518 | "HUGE", |
| 519 | "ICON", |
| 520 | "LARGE", |
| 521 | "MEDIUM", |
| 522 | "SMALL", |
| 523 | "XLARGE", |
| 524 | "XXLARGE" |
| 525 | ], |
| 526 | "enumDescriptions": [ |
| 527 | "No image size specified.", |
| 528 | "Only the largest possible images.", |
| 529 | "Only very small icon-sized images.", |
| 530 | "Only large images.", |
| 531 | "Only medium images.", |
| 532 | "Only small images.", |
| 533 | "Only very large images.", |
| 534 | "Only extremely large images." |
| 535 | ], |
| 536 | "location": "query", |
| 537 | "type": "string" |
| 538 | }, |
| 539 | "imgType": { |
| 540 | "description": "Returns images of a type. Acceptable values are: * `\"clipart\"` * `\"face\"` * `\"lineart\"` * `\"stock\"` * `\"photo\"` * `\"animated\"`", |
| 541 | "enum": [ |
| 542 | "imgTypeUndefined", |
| 543 | "clipart", |
| 544 | "face", |
| 545 | "lineart", |
| 546 | "stock", |
| 547 | "photo", |
| 548 | "animated" |
| 549 | ], |
| 550 | "enumDescriptions": [ |
| 551 | "No image type specified.", |
| 552 | "Clipart-style images only.", |
| 553 | "Images of faces only.", |
| 554 | "Line art images only.", |
| 555 | "Stock images only.", |
| 556 | "Photo images only.", |
| 557 | "Animated images only." |
| 558 | ], |
| 559 | "location": "query", |
| 560 | "type": "string" |
| 561 | }, |
| 562 | "linkSite": { |
| 563 | "description": "Specifies that all search results should contain a link to a particular URL.", |
| 564 | "location": "query", |
| 565 | "type": "string" |
| 566 | }, |
| 567 | "lowRange": { |
| 568 | "description": "Specifies the starting value for a search range. Use `lowRange` and `highRange` to append an inclusive search range of `lowRange...highRange` to the query.", |
| 569 | "location": "query", |
| 570 | "type": "string" |
| 571 | }, |
| 572 | "lr": { |
| 573 | "description": "Restricts the search to documents written in a particular language (e.g., `lr=lang_ja`). Acceptable values are: * `\"lang_ar\"`: Arabic * `\"lang_bg\"`: Bulgarian * `\"lang_ca\"`: Catalan * `\"lang_cs\"`: Czech * `\"lang_da\"`: Danish * `\"lang_de\"`: German * `\"lang_el\"`: Greek * `\"lang_en\"`: English * `\"lang_es\"`: Spanish * `\"lang_et\"`: Estonian * `\"lang_fi\"`: Finnish * `\"lang_fr\"`: French * `\"lang_hr\"`: Croatian * `\"lang_hu\"`: Hungarian * `\"lang_id\"`: Indonesian * `\"lang_is\"`: Icelandic * `\"lang_it\"`: Italian * `\"lang_iw\"`: Hebrew * `\"lang_ja\"`: Japanese * `\"lang_ko\"`: Korean * `\"lang_lt\"`: Lithuanian * `\"lang_lv\"`: Latvian * `\"lang_nl\"`: Dutch * `\"lang_no\"`: Norwegian * `\"lang_pl\"`: Polish * `\"lang_pt\"`: Portuguese * `\"lang_ro\"`: Romanian * `\"lang_ru\"`: Russian * `\"lang_sk\"`: Slovak * `\"lang_sl\"`: Slovenian * `\"lang_sr\"`: Serbian * `\"lang_sv\"`: Swedish * `\"lang_tr\"`: Turkish * `\"lang_zh-CN\"`: Chinese (Simplified) * `\"lang_zh-TW\"`: Chinese (Traditional)", |
| 574 | "location": "query", |
| 575 | "type": "string" |
| 576 | }, |
| 577 | "num": { |
| 578 | "description": "Number of search results to return. * Valid values are integers between 1 and 10, inclusive.", |
| 579 | "format": "int32", |
| 580 | "location": "query", |
| 581 | "type": "integer" |
| 582 | }, |
| 583 | "orTerms": { |
| 584 | "description": "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.", |
| 585 | "location": "query", |
| 586 | "type": "string" |
| 587 | }, |
| 588 | "q": { |
| 589 | "description": "Query", |
| 590 | "location": "query", |
| 591 | "type": "string" |
| 592 | }, |
| 593 | "relatedSite": { |
| 594 | "description": "Specifies that all search results should be pages that are related to the specified URL.", |
| 595 | "location": "query", |
| 596 | "type": "string" |
| 597 | }, |
| 598 | "rights": { |
| 599 | "description": "Filters based on licensing. Supported values include: `cc_publicdomain`, `cc_attribute`, `cc_sharealike`, `cc_noncommercial`, `cc_nonderived` and combinations of these. See [typical combinations](https://wiki.creativecommons.org/wiki/CC_Search_integration).", |
| 600 | "location": "query", |
| 601 | "type": "string" |
| 602 | }, |
| 603 | "safe": { |
| 604 | "description": "Search safety level. Acceptable values are: * `\"active\"`: Enables SafeSearch filtering. * `\"off\"`: Disables SafeSearch filtering. (default)", |
| 605 | "enum": [ |
| 606 | "safeUndefined", |
| 607 | "active", |
| 608 | "high", |
| 609 | "medium", |
| 610 | "off" |
| 611 | ], |
| 612 | "enumDescriptions": [ |
| 613 | "SafeSearch mode unspecified. (Falls back to engine's configuration.)", |
| 614 | "Turn SafeSearch on.", |
| 615 | "Deprecated, equivalent to \"active\".", |
| 616 | "Deprecated, equivalent to \"active\".", |
| 617 | "Turn SafeSearch off." |
| 618 | ], |
| 619 | "location": "query", |
| 620 | "type": "string" |
| 621 | }, |
| 622 | "searchType": { |
| 623 | "description": "Specifies the search type: `image`. If unspecified, results are limited to webpages. Acceptable values are: * `\"image\"`: custom image search.", |
| 624 | "enum": [ |
| 625 | "searchTypeUndefined", |
| 626 | "image" |
| 627 | ], |
| 628 | "enumDescriptions": [ |
| 629 | "Search type unspecified (defaults to web search).", |
| 630 | "Image search." |
| 631 | ], |
| 632 | "location": "query", |
| 633 | "type": "string" |
| 634 | }, |
| 635 | "siteSearch": { |
| 636 | "description": "Specifies a given site which should always be included or excluded from results (see `siteSearchFilter` parameter, below).", |
| 637 | "location": "query", |
| 638 | "type": "string" |
| 639 | }, |
| 640 | "siteSearchFilter": { |
| 641 | "description": "Controls whether to include or exclude results from the site named in the `siteSearch` parameter. Acceptable values are: * `\"e\"`: exclude * `\"i\"`: include", |
| 642 | "enum": [ |
| 643 | "siteSearchFilterUndefined", |
| 644 | "e", |
| 645 | "i" |
| 646 | ], |
| 647 | "enumDescriptions": [ |
| 648 | "Filter mode unspecified.", |
| 649 | "Exclude results from the listed sites.", |
| 650 | "Include only results from the listed sites." |
| 651 | ], |
| 652 | "location": "query", |
| 653 | "type": "string" |
| 654 | }, |
| 655 | "sort": { |
| 656 | "description": "The sort expression to apply to the results. The sort parameter specifies that the results be sorted according to the specified expression i.e. sort by date. [Example: sort=date](https://developers.google.com/custom-search/docs/structured_search#sort-by-attribute).", |
| 657 | "location": "query", |
| 658 | "type": "string" |
| 659 | }, |
| 660 | "start": { |
| 661 | "description": "The index of the first result to return. The default number of results per page is 10, so `&start=11` would start at the top of the second page of results. **Note**: The JSON API will never return more than 100 results, even if more than 100 documents match the query, so setting the sum of `start + num` to a number greater than 100 will produce an error. Also note that the maximum value for `num` is 10.", |
| 662 | "format": "uint32", |
| 663 | "location": "query", |
| 664 | "type": "integer" |
| 665 | } |
| 666 | }, |
| 667 | "path": "customsearch/v1/siterestrict", |
| 668 | "response": { |
| 669 | "$ref": "Search" |
| 670 | } |
| 671 | } |
| 672 | } |
Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 673 | } |
| 674 | } |
| 675 | } |
| 676 | }, |
yoshi-code-bot | cb945f3 | 2021-06-08 00:36:03 -0700 | [diff] [blame] | 677 | "revision": "20210604", |
Anthonios Partheniou | 10f4b67 | 2021-04-13 14:47:53 -0400 | [diff] [blame] | 678 | "rootUrl": "https://customsearch.googleapis.com/", |
| 679 | "schemas": { |
| 680 | "Promotion": { |
| 681 | "description": "Promotion result.", |
| 682 | "id": "Promotion", |
| 683 | "properties": { |
| 684 | "bodyLines": { |
| 685 | "description": "An array of block objects for this promotion. See [Google WebSearch Protocol reference](https://developers.google.com/custom-search/docs/xml_results) for more information.", |
| 686 | "items": { |
| 687 | "description": "Block object belonging to a promotion.", |
| 688 | "properties": { |
| 689 | "htmlTitle": { |
| 690 | "description": "The block object's text in HTML, if it has text.", |
| 691 | "type": "string" |
| 692 | }, |
| 693 | "link": { |
| 694 | "description": "The anchor text of the block object's link, if it has a link.", |
| 695 | "type": "string" |
| 696 | }, |
| 697 | "title": { |
| 698 | "description": "The block object's text, if it has text.", |
| 699 | "type": "string" |
| 700 | }, |
| 701 | "url": { |
| 702 | "description": "The URL of the block object's link, if it has one.", |
| 703 | "type": "string" |
| 704 | } |
| 705 | }, |
| 706 | "type": "object" |
| 707 | }, |
| 708 | "type": "array" |
| 709 | }, |
| 710 | "displayLink": { |
| 711 | "description": "An abridged version of this search's result URL, e.g. www.example.com.", |
| 712 | "type": "string" |
| 713 | }, |
| 714 | "htmlTitle": { |
| 715 | "description": "The title of the promotion, in HTML.", |
| 716 | "type": "string" |
| 717 | }, |
| 718 | "image": { |
| 719 | "description": "Image belonging to a promotion.", |
| 720 | "properties": { |
| 721 | "height": { |
| 722 | "description": "Image height in pixels.", |
| 723 | "format": "int32", |
| 724 | "type": "integer" |
| 725 | }, |
| 726 | "source": { |
| 727 | "description": "URL of the image for this promotion link.", |
| 728 | "type": "string" |
| 729 | }, |
| 730 | "width": { |
| 731 | "description": "Image width in pixels.", |
| 732 | "format": "int32", |
| 733 | "type": "integer" |
| 734 | } |
| 735 | }, |
| 736 | "type": "object" |
| 737 | }, |
| 738 | "link": { |
| 739 | "description": "The URL of the promotion.", |
| 740 | "type": "string" |
| 741 | }, |
| 742 | "title": { |
| 743 | "description": "The title of the promotion.", |
| 744 | "type": "string" |
| 745 | } |
| 746 | }, |
| 747 | "type": "object" |
| 748 | }, |
| 749 | "Result": { |
| 750 | "description": "A custom search result.", |
| 751 | "id": "Result", |
| 752 | "properties": { |
| 753 | "cacheId": { |
| 754 | "description": "Indicates the ID of Google's cached version of the search result.", |
| 755 | "type": "string" |
| 756 | }, |
| 757 | "displayLink": { |
| 758 | "description": "An abridged version of this search result\u2019s URL, e.g. www.example.com.", |
| 759 | "type": "string" |
| 760 | }, |
| 761 | "fileFormat": { |
| 762 | "description": "The file format of the search result.", |
| 763 | "type": "string" |
| 764 | }, |
| 765 | "formattedUrl": { |
| 766 | "description": "The URL displayed after the snippet for each search result.", |
| 767 | "type": "string" |
| 768 | }, |
| 769 | "htmlFormattedUrl": { |
| 770 | "description": "The HTML-formatted URL displayed after the snippet for each search result.", |
| 771 | "type": "string" |
| 772 | }, |
| 773 | "htmlSnippet": { |
| 774 | "description": "The snippet of the search result, in HTML.", |
| 775 | "type": "string" |
| 776 | }, |
| 777 | "htmlTitle": { |
| 778 | "description": "The title of the search result, in HTML.", |
| 779 | "type": "string" |
| 780 | }, |
| 781 | "image": { |
| 782 | "description": "Image belonging to a custom search result.", |
| 783 | "properties": { |
| 784 | "byteSize": { |
| 785 | "description": "The size of the image, in pixels.", |
| 786 | "format": "int32", |
| 787 | "type": "integer" |
| 788 | }, |
| 789 | "contextLink": { |
| 790 | "description": "A URL pointing to the webpage hosting the image.", |
| 791 | "type": "string" |
| 792 | }, |
| 793 | "height": { |
| 794 | "description": "The height of the image, in pixels.", |
| 795 | "format": "int32", |
| 796 | "type": "integer" |
| 797 | }, |
| 798 | "thumbnailHeight": { |
| 799 | "description": "The height of the thumbnail image, in pixels.", |
| 800 | "format": "int32", |
| 801 | "type": "integer" |
| 802 | }, |
| 803 | "thumbnailLink": { |
| 804 | "description": "A URL to the thumbnail image.", |
| 805 | "type": "string" |
| 806 | }, |
| 807 | "thumbnailWidth": { |
| 808 | "description": "The width of the thumbnail image, in pixels.", |
| 809 | "format": "int32", |
| 810 | "type": "integer" |
| 811 | }, |
| 812 | "width": { |
| 813 | "description": "The width of the image, in pixels.", |
| 814 | "format": "int32", |
| 815 | "type": "integer" |
| 816 | } |
| 817 | }, |
| 818 | "type": "object" |
| 819 | }, |
| 820 | "kind": { |
| 821 | "description": "A unique identifier for the type of current object. For this API, it is `customsearch#result.`", |
| 822 | "type": "string" |
| 823 | }, |
| 824 | "labels": { |
| 825 | "description": "Encapsulates all information about [refinement labels](https://developers.google.com/custom-search/docs/xml_results).", |
| 826 | "items": { |
| 827 | "description": "Refinement label associated with a custom search result.", |
| 828 | "properties": { |
| 829 | "displayName": { |
| 830 | "description": "The display name of a refinement label. This is the name you should display in your user interface.", |
| 831 | "type": "string" |
| 832 | }, |
| 833 | "label_with_op": { |
| 834 | "description": "Refinement label and the associated refinement operation.", |
| 835 | "type": "string" |
| 836 | }, |
| 837 | "name": { |
| 838 | "description": "The name of a refinement label, which you can use to refine searches. Don't display this in your user interface; instead, use displayName.", |
| 839 | "type": "string" |
| 840 | } |
| 841 | }, |
| 842 | "type": "object" |
| 843 | }, |
| 844 | "type": "array" |
| 845 | }, |
| 846 | "link": { |
| 847 | "description": "The full URL to which the search result is pointing, e.g. http://www.example.com/foo/bar.", |
| 848 | "type": "string" |
| 849 | }, |
| 850 | "mime": { |
| 851 | "description": "The MIME type of the search result.", |
| 852 | "type": "string" |
| 853 | }, |
| 854 | "pagemap": { |
| 855 | "additionalProperties": { |
| 856 | "description": "Properties of the object.", |
| 857 | "type": "any" |
| 858 | }, |
| 859 | "description": "Contains [PageMap](https://developers.google.com/custom-search/docs/structured_data#pagemaps) information for this search result.", |
| 860 | "type": "object" |
| 861 | }, |
| 862 | "snippet": { |
| 863 | "description": "The snippet of the search result, in plain text.", |
| 864 | "type": "string" |
| 865 | }, |
| 866 | "title": { |
| 867 | "description": "The title of the search result, in plain text.", |
| 868 | "type": "string" |
| 869 | } |
| 870 | }, |
| 871 | "type": "object" |
| 872 | }, |
| 873 | "Search": { |
| 874 | "description": "Response to a custom search request.", |
| 875 | "id": "Search", |
| 876 | "properties": { |
| 877 | "context": { |
| 878 | "additionalProperties": { |
| 879 | "description": "Properties of the object.", |
| 880 | "type": "any" |
| 881 | }, |
| 882 | "description": "Metadata and refinements associated with the given search engine, including: * The name of the search engine that was used for the query. * A set of [facet objects](https://developers.google.com/custom-search/docs/refinements#create) (refinements) you can use for refining a search.", |
| 883 | "type": "object" |
| 884 | }, |
| 885 | "items": { |
| 886 | "description": "The current set of custom search results.", |
| 887 | "items": { |
| 888 | "$ref": "Result" |
| 889 | }, |
| 890 | "type": "array" |
| 891 | }, |
| 892 | "kind": { |
| 893 | "description": "Unique identifier for the type of current object. For this API, it is customsearch#search.", |
| 894 | "type": "string" |
| 895 | }, |
| 896 | "promotions": { |
| 897 | "description": "The set of [promotions](https://developers.google.com/custom-search/docs/promotions). Present only if the custom search engine's configuration files define any promotions for the given query.", |
| 898 | "items": { |
| 899 | "$ref": "Promotion" |
| 900 | }, |
| 901 | "type": "array" |
| 902 | }, |
| 903 | "queries": { |
| 904 | "description": "Query metadata for the previous, current, and next pages of results.", |
| 905 | "properties": { |
| 906 | "nextPage": { |
| 907 | "description": "Metadata representing the next page of results, if applicable.", |
| 908 | "items": { |
| 909 | "description": "Custom search request metadata.", |
| 910 | "properties": { |
| 911 | "count": { |
| 912 | "description": "Number of search results returned in this set.", |
| 913 | "format": "int32", |
| 914 | "type": "integer" |
| 915 | }, |
| 916 | "cr": { |
| 917 | "description": "Restricts search results to documents originating in a particular country. You may use [Boolean operators](https://developers.google.com/custom-search/docs/xml_results#booleanOperators) in the `cr` parameter's value. Google WebSearch determines the country of a document by analyzing the following: * The top-level domain (TLD) of the document's URL. * The geographic location of the web server's IP address. See [Country (cr) Parameter Values](https://developers.google.com/custom-search/docs/xml_results#countryCollections) for a list of valid values for this parameter.", |
| 918 | "type": "string" |
| 919 | }, |
| 920 | "cx": { |
| 921 | "description": "The identifier of an engine created using the Programmable Search Engine [Control Panel](https://programmablesearchengine.google.com/). This is a custom property not defined in the OpenSearch spec. This parameter is **required**.", |
| 922 | "type": "string" |
| 923 | }, |
| 924 | "dateRestrict": { |
| 925 | "description": "Restricts results to URLs based on date. Supported values include: * `d[number]`: requests results from the specified number of past days. * `w[number]`: requests results from the specified number of past weeks. * `m[number]`: requests results from the specified number of past months. * `y[number]`: requests results from the specified number of past years.", |
| 926 | "type": "string" |
| 927 | }, |
| 928 | "disableCnTwTranslation": { |
| 929 | "description": "Enables or disables the [Simplified and Traditional Chinese Search](https://developers.google.com/custom-search/docs/xml_results#chineseSearch) feature. Supported values are: * `0`: enabled (default) * `1`: disabled", |
| 930 | "type": "string" |
| 931 | }, |
| 932 | "exactTerms": { |
| 933 | "description": "Identifies a phrase that all documents in the search results must contain.", |
| 934 | "type": "string" |
| 935 | }, |
| 936 | "excludeTerms": { |
| 937 | "description": "Identifies a word or phrase that should not appear in any documents in the search results.", |
| 938 | "type": "string" |
| 939 | }, |
| 940 | "fileType": { |
| 941 | "description": "Restricts results to files of a specified extension. Filetypes supported by Google include: * Adobe Portable Document Format (`pdf`) * Adobe PostScript (`ps`) * Lotus 1-2-3 (`wk1`, `wk2`, `wk3`, `wk4`, `wk5`, `wki`, `wks`, `wku`) * Lotus WordPro (`lwp`) * Macwrite (`mw`) * Microsoft Excel (`xls`) * Microsoft PowerPoint (`ppt`) * Microsoft Word (`doc`) * Microsoft Works (`wks`, `wps`, `wdb`) * Microsoft Write (`wri`) * Rich Text Format (`rtf`) * Shockwave Flash (`swf`) * Text (`ans`, `txt`). Additional filetypes may be added in the future. An up-to-date list can always be found in Google's [file type FAQ](https://support.google.com/webmasters/answer/35287).", |
| 942 | "type": "string" |
| 943 | }, |
| 944 | "filter": { |
| 945 | "description": "Activates or deactivates the automatic filtering of Google search results. See [Automatic Filtering](https://developers.google.com/custom-search/docs/xml_results#automaticFiltering) for more information about Google's search results filters. Valid values for this parameter are: * `0`: Disabled * `1`: Enabled (default) **Note**: By default, Google applies filtering to all search results to improve the quality of those results.", |
| 946 | "type": "string" |
| 947 | }, |
| 948 | "gl": { |
| 949 | "description": "Boosts search results whose country of origin matches the parameter value. See [Country Codes](https://developers.google.com/custom-search/docs/xml_results#countryCodes) for a list of valid values. Specifying a `gl` parameter value in WebSearch requests should improve the relevance of results. This is particularly true for international customers and, even more specifically, for customers in English-speaking countries other than the United States.", |
| 950 | "type": "string" |
| 951 | }, |
| 952 | "googleHost": { |
| 953 | "description": "Specifies the Google domain (for example, google.com, google.de, or google.fr) to which the search should be limited.", |
| 954 | "type": "string" |
| 955 | }, |
| 956 | "highRange": { |
| 957 | "description": "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.", |
| 958 | "type": "string" |
| 959 | }, |
| 960 | "hl": { |
| 961 | "description": "Specifies the interface language (host language) of your user interface. Explicitly setting this parameter improves the performance and the quality of your search results. See the [Interface Languages](https://developers.google.com/custom-search/docs/xml_results#wsInterfaceLanguages) section of [Internationalizing Queries and Results Presentation](https://developers.google.com/custom-search/docs/xml_results#wsInternationalizing) for more information, and [Supported Interface Languages](https://developers.google.com/custom-search/docs/xml_results_appendices#interfaceLanguages) for a list of supported languages.", |
| 962 | "type": "string" |
| 963 | }, |
| 964 | "hq": { |
| 965 | "description": "Appends the specified query terms to the query, as if they were combined with a logical `AND` operator.", |
| 966 | "type": "string" |
| 967 | }, |
| 968 | "imgColorType": { |
| 969 | "description": "Restricts results to images of a specified color type. Supported values are: * `mono` (black and white) * `gray` (grayscale) * `color` (color)", |
| 970 | "type": "string" |
| 971 | }, |
| 972 | "imgDominantColor": { |
| 973 | "description": "Restricts results to images with a specific dominant color. Supported values are: * `red` * `orange` * `yellow` * `green` * `teal` * `blue` * `purple` * `pink` * `white` * `gray` * `black` * `brown`", |
| 974 | "type": "string" |
| 975 | }, |
| 976 | "imgSize": { |
| 977 | "description": "Restricts results to images of a specified size. Supported values are: * `icon` (small) * `small | medium | large | xlarge` (medium) * `xxlarge` (large) * `huge` (extra-large)", |
| 978 | "type": "string" |
| 979 | }, |
| 980 | "imgType": { |
| 981 | "description": "Restricts results to images of a specified type. Supported values are: * `clipart` (Clip art) * `face` (Face) * `lineart` (Line drawing) * `photo` (Photo) * `animated` (Animated) * `stock` (Stock)", |
| 982 | "type": "string" |
| 983 | }, |
| 984 | "inputEncoding": { |
| 985 | "description": "The character encoding supported for search requests.", |
| 986 | "type": "string" |
| 987 | }, |
| 988 | "language": { |
| 989 | "description": "The language of the search results.", |
| 990 | "type": "string" |
| 991 | }, |
| 992 | "linkSite": { |
| 993 | "description": "Specifies that all results should contain a link to a specific URL.", |
| 994 | "type": "string" |
| 995 | }, |
| 996 | "lowRange": { |
| 997 | "description": "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.", |
| 998 | "type": "string" |
| 999 | }, |
| 1000 | "orTerms": { |
| 1001 | "description": "Provides additional search terms to check for in a document, where each document in the search results must contain at least one of the additional search terms. You can also use the [Boolean OR](https://developers.google.com/custom-search/docs/xml_results#BooleanOrqt) query term for this type of query.", |
| 1002 | "type": "string" |
| 1003 | }, |
| 1004 | "outputEncoding": { |
| 1005 | "description": "The character encoding supported for search results.", |
| 1006 | "type": "string" |
| 1007 | }, |
| 1008 | "relatedSite": { |
| 1009 | "description": "Specifies that all search results should be pages that are related to the specified URL. The parameter value should be a URL.", |
| 1010 | "type": "string" |
| 1011 | }, |
| 1012 | "rights": { |
| 1013 | "description": "Filters based on licensing. Supported values include: * `cc_publicdomain` * `cc_attribute` * `cc_sharealike` * `cc_noncommercial` * `cc_nonderived`", |
| 1014 | "type": "string" |
| 1015 | }, |
| 1016 | "safe": { |
| 1017 | "description": "Specifies the [SafeSearch level](https://developers.google.com/custom-search/docs/xml_results#safeSearchLevels) used for filtering out adult results. This is a custom property not defined in the OpenSearch spec. Valid parameter values are: * `\"off\"`: Disable SafeSearch * `\"active\"`: Enable SafeSearch", |
| 1018 | "type": "string" |
| 1019 | }, |
| 1020 | "searchTerms": { |
| 1021 | "description": "The search terms entered by the user.", |
| 1022 | "type": "string" |
| 1023 | }, |
| 1024 | "searchType": { |
| 1025 | "description": "Allowed values are `web` or `image`. If unspecified, results are limited to webpages.", |
| 1026 | "type": "string" |
| 1027 | }, |
| 1028 | "siteSearch": { |
| 1029 | "description": "Restricts results to URLs from a specified site.", |
| 1030 | "type": "string" |
| 1031 | }, |
| 1032 | "siteSearchFilter": { |
| 1033 | "description": "Specifies whether to include or exclude results from the site named in the `sitesearch` parameter. Supported values are: * `i`: include content from site * `e`: exclude content from site", |
| 1034 | "type": "string" |
| 1035 | }, |
| 1036 | "sort": { |
| 1037 | "description": "Specifies that results should be sorted according to the specified expression. For example, sort by date.", |
| 1038 | "type": "string" |
| 1039 | }, |
| 1040 | "startIndex": { |
| 1041 | "description": "The index of the current set of search results into the total set of results, where the index of the first result is 1.", |
| 1042 | "format": "int32", |
| 1043 | "type": "integer" |
| 1044 | }, |
| 1045 | "startPage": { |
| 1046 | "description": "The page number of this set of results, where the page length is set by the `count` property.", |
| 1047 | "format": "int32", |
| 1048 | "type": "integer" |
| 1049 | }, |
| 1050 | "title": { |
| 1051 | "description": "A description of the query.", |
| 1052 | "type": "string" |
| 1053 | }, |
| 1054 | "totalResults": { |
| 1055 | "description": "Estimated number of total search results. May not be accurate.", |
| 1056 | "format": "int64", |
| 1057 | "type": "string" |
| 1058 | } |
| 1059 | }, |
| 1060 | "type": "object" |
| 1061 | }, |
| 1062 | "type": "array" |
| 1063 | }, |
| 1064 | "previousPage": { |
| 1065 | "description": "Metadata representing the previous page of results, if applicable.", |
| 1066 | "items": { |
| 1067 | "description": "Custom search request metadata.", |
| 1068 | "properties": { |
| 1069 | "count": { |
| 1070 | "description": "Number of search results returned in this set.", |
| 1071 | "format": "int32", |
| 1072 | "type": "integer" |
| 1073 | }, |
| 1074 | "cr": { |
| 1075 | "description": "Restricts search results to documents originating in a particular country. You may use [Boolean operators](https://developers.google.com/custom-search/docs/xml_results#booleanOperators) in the `cr` parameter's value. Google WebSearch determines the country of a document by analyzing the following: * The top-level domain (TLD) of the document's URL. * The geographic location of the web server's IP address. See [Country (cr) Parameter Values](https://developers.google.com/custom-search/docs/xml_results#countryCollections) for a list of valid values for this parameter.", |
| 1076 | "type": "string" |
| 1077 | }, |
| 1078 | "cx": { |
| 1079 | "description": "The identifier of an engine created using the Programmable Search Engine [Control Panel](https://programmablesearchengine.google.com/). This is a custom property not defined in the OpenSearch spec. This parameter is **required**.", |
| 1080 | "type": "string" |
| 1081 | }, |
| 1082 | "dateRestrict": { |
| 1083 | "description": "Restricts results to URLs based on date. Supported values include: * `d[number]`: requests results from the specified number of past days. * `w[number]`: requests results from the specified number of past weeks. * `m[number]`: requests results from the specified number of past months. * `y[number]`: requests results from the specified number of past years.", |
| 1084 | "type": "string" |
| 1085 | }, |
| 1086 | "disableCnTwTranslation": { |
| 1087 | "description": "Enables or disables the [Simplified and Traditional Chinese Search](https://developers.google.com/custom-search/docs/xml_results#chineseSearch) feature. Supported values are: * `0`: enabled (default) * `1`: disabled", |
| 1088 | "type": "string" |
| 1089 | }, |
| 1090 | "exactTerms": { |
| 1091 | "description": "Identifies a phrase that all documents in the search results must contain.", |
| 1092 | "type": "string" |
| 1093 | }, |
| 1094 | "excludeTerms": { |
| 1095 | "description": "Identifies a word or phrase that should not appear in any documents in the search results.", |
| 1096 | "type": "string" |
| 1097 | }, |
| 1098 | "fileType": { |
| 1099 | "description": "Restricts results to files of a specified extension. Filetypes supported by Google include: * Adobe Portable Document Format (`pdf`) * Adobe PostScript (`ps`) * Lotus 1-2-3 (`wk1`, `wk2`, `wk3`, `wk4`, `wk5`, `wki`, `wks`, `wku`) * Lotus WordPro (`lwp`) * Macwrite (`mw`) * Microsoft Excel (`xls`) * Microsoft PowerPoint (`ppt`) * Microsoft Word (`doc`) * Microsoft Works (`wks`, `wps`, `wdb`) * Microsoft Write (`wri`) * Rich Text Format (`rtf`) * Shockwave Flash (`swf`) * Text (`ans`, `txt`). Additional filetypes may be added in the future. An up-to-date list can always be found in Google's [file type FAQ](https://support.google.com/webmasters/answer/35287).", |
| 1100 | "type": "string" |
| 1101 | }, |
| 1102 | "filter": { |
| 1103 | "description": "Activates or deactivates the automatic filtering of Google search results. See [Automatic Filtering](https://developers.google.com/custom-search/docs/xml_results#automaticFiltering) for more information about Google's search results filters. Valid values for this parameter are: * `0`: Disabled * `1`: Enabled (default) **Note**: By default, Google applies filtering to all search results to improve the quality of those results.", |
| 1104 | "type": "string" |
| 1105 | }, |
| 1106 | "gl": { |
| 1107 | "description": "Boosts search results whose country of origin matches the parameter value. See [Country Codes](https://developers.google.com/custom-search/docs/xml_results#countryCodes) for a list of valid values. Specifying a `gl` parameter value in WebSearch requests should improve the relevance of results. This is particularly true for international customers and, even more specifically, for customers in English-speaking countries other than the United States.", |
| 1108 | "type": "string" |
| 1109 | }, |
| 1110 | "googleHost": { |
| 1111 | "description": "Specifies the Google domain (for example, google.com, google.de, or google.fr) to which the search should be limited.", |
| 1112 | "type": "string" |
| 1113 | }, |
| 1114 | "highRange": { |
| 1115 | "description": "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.", |
| 1116 | "type": "string" |
| 1117 | }, |
| 1118 | "hl": { |
| 1119 | "description": "Specifies the interface language (host language) of your user interface. Explicitly setting this parameter improves the performance and the quality of your search results. See the [Interface Languages](https://developers.google.com/custom-search/docs/xml_results#wsInterfaceLanguages) section of [Internationalizing Queries and Results Presentation](https://developers.google.com/custom-search/docs/xml_results#wsInternationalizing) for more information, and [Supported Interface Languages](https://developers.google.com/custom-search/docs/xml_results_appendices#interfaceLanguages) for a list of supported languages.", |
| 1120 | "type": "string" |
| 1121 | }, |
| 1122 | "hq": { |
| 1123 | "description": "Appends the specified query terms to the query, as if they were combined with a logical `AND` operator.", |
| 1124 | "type": "string" |
| 1125 | }, |
| 1126 | "imgColorType": { |
| 1127 | "description": "Restricts results to images of a specified color type. Supported values are: * `mono` (black and white) * `gray` (grayscale) * `color` (color)", |
| 1128 | "type": "string" |
| 1129 | }, |
| 1130 | "imgDominantColor": { |
| 1131 | "description": "Restricts results to images with a specific dominant color. Supported values are: * `red` * `orange` * `yellow` * `green` * `teal` * `blue` * `purple` * `pink` * `white` * `gray` * `black` * `brown`", |
| 1132 | "type": "string" |
| 1133 | }, |
| 1134 | "imgSize": { |
| 1135 | "description": "Restricts results to images of a specified size. Supported values are: * `icon` (small) * `small | medium | large | xlarge` (medium) * `xxlarge` (large) * `huge` (extra-large)", |
| 1136 | "type": "string" |
| 1137 | }, |
| 1138 | "imgType": { |
| 1139 | "description": "Restricts results to images of a specified type. Supported values are: * `clipart` (Clip art) * `face` (Face) * `lineart` (Line drawing) * `photo` (Photo) * `animated` (Animated) * `stock` (Stock)", |
| 1140 | "type": "string" |
| 1141 | }, |
| 1142 | "inputEncoding": { |
| 1143 | "description": "The character encoding supported for search requests.", |
| 1144 | "type": "string" |
| 1145 | }, |
| 1146 | "language": { |
| 1147 | "description": "The language of the search results.", |
| 1148 | "type": "string" |
| 1149 | }, |
| 1150 | "linkSite": { |
| 1151 | "description": "Specifies that all results should contain a link to a specific URL.", |
| 1152 | "type": "string" |
| 1153 | }, |
| 1154 | "lowRange": { |
| 1155 | "description": "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.", |
| 1156 | "type": "string" |
| 1157 | }, |
| 1158 | "orTerms": { |
| 1159 | "description": "Provides additional search terms to check for in a document, where each document in the search results must contain at least one of the additional search terms. You can also use the [Boolean OR](https://developers.google.com/custom-search/docs/xml_results#BooleanOrqt) query term for this type of query.", |
| 1160 | "type": "string" |
| 1161 | }, |
| 1162 | "outputEncoding": { |
| 1163 | "description": "The character encoding supported for search results.", |
| 1164 | "type": "string" |
| 1165 | }, |
| 1166 | "relatedSite": { |
| 1167 | "description": "Specifies that all search results should be pages that are related to the specified URL. The parameter value should be a URL.", |
| 1168 | "type": "string" |
| 1169 | }, |
| 1170 | "rights": { |
| 1171 | "description": "Filters based on licensing. Supported values include: * `cc_publicdomain` * `cc_attribute` * `cc_sharealike` * `cc_noncommercial` * `cc_nonderived`", |
| 1172 | "type": "string" |
| 1173 | }, |
| 1174 | "safe": { |
| 1175 | "description": "Specifies the [SafeSearch level](https://developers.google.com/custom-search/docs/xml_results#safeSearchLevels) used for filtering out adult results. This is a custom property not defined in the OpenSearch spec. Valid parameter values are: * `\"off\"`: Disable SafeSearch * `\"active\"`: Enable SafeSearch", |
| 1176 | "type": "string" |
| 1177 | }, |
| 1178 | "searchTerms": { |
| 1179 | "description": "The search terms entered by the user.", |
| 1180 | "type": "string" |
| 1181 | }, |
| 1182 | "searchType": { |
| 1183 | "description": "Allowed values are `web` or `image`. If unspecified, results are limited to webpages.", |
| 1184 | "type": "string" |
| 1185 | }, |
| 1186 | "siteSearch": { |
| 1187 | "description": "Restricts results to URLs from a specified site.", |
| 1188 | "type": "string" |
| 1189 | }, |
| 1190 | "siteSearchFilter": { |
| 1191 | "description": "Specifies whether to include or exclude results from the site named in the `sitesearch` parameter. Supported values are: * `i`: include content from site * `e`: exclude content from site", |
| 1192 | "type": "string" |
| 1193 | }, |
| 1194 | "sort": { |
| 1195 | "description": "Specifies that results should be sorted according to the specified expression. For example, sort by date.", |
| 1196 | "type": "string" |
| 1197 | }, |
| 1198 | "startIndex": { |
| 1199 | "description": "The index of the current set of search results into the total set of results, where the index of the first result is 1.", |
| 1200 | "format": "int32", |
| 1201 | "type": "integer" |
| 1202 | }, |
| 1203 | "startPage": { |
| 1204 | "description": "The page number of this set of results, where the page length is set by the `count` property.", |
| 1205 | "format": "int32", |
| 1206 | "type": "integer" |
| 1207 | }, |
| 1208 | "title": { |
| 1209 | "description": "A description of the query.", |
| 1210 | "type": "string" |
| 1211 | }, |
| 1212 | "totalResults": { |
| 1213 | "description": "Estimated number of total search results. May not be accurate.", |
| 1214 | "format": "int64", |
| 1215 | "type": "string" |
| 1216 | } |
| 1217 | }, |
| 1218 | "type": "object" |
| 1219 | }, |
| 1220 | "type": "array" |
| 1221 | }, |
| 1222 | "request": { |
| 1223 | "description": "Metadata representing the current request.", |
| 1224 | "items": { |
| 1225 | "description": "Custom search request metadata.", |
| 1226 | "properties": { |
| 1227 | "count": { |
| 1228 | "description": "Number of search results returned in this set.", |
| 1229 | "format": "int32", |
| 1230 | "type": "integer" |
| 1231 | }, |
| 1232 | "cr": { |
| 1233 | "description": "Restricts search results to documents originating in a particular country. You may use [Boolean operators](https://developers.google.com/custom-search/docs/xml_results#booleanOperators) in the `cr` parameter's value. Google WebSearch determines the country of a document by analyzing the following: * The top-level domain (TLD) of the document's URL. * The geographic location of the web server's IP address. See [Country (cr) Parameter Values](https://developers.google.com/custom-search/docs/xml_results#countryCollections) for a list of valid values for this parameter.", |
| 1234 | "type": "string" |
| 1235 | }, |
| 1236 | "cx": { |
| 1237 | "description": "The identifier of an engine created using the Programmable Search Engine [Control Panel](https://programmablesearchengine.google.com/). This is a custom property not defined in the OpenSearch spec. This parameter is **required**.", |
| 1238 | "type": "string" |
| 1239 | }, |
| 1240 | "dateRestrict": { |
| 1241 | "description": "Restricts results to URLs based on date. Supported values include: * `d[number]`: requests results from the specified number of past days. * `w[number]`: requests results from the specified number of past weeks. * `m[number]`: requests results from the specified number of past months. * `y[number]`: requests results from the specified number of past years.", |
| 1242 | "type": "string" |
| 1243 | }, |
| 1244 | "disableCnTwTranslation": { |
| 1245 | "description": "Enables or disables the [Simplified and Traditional Chinese Search](https://developers.google.com/custom-search/docs/xml_results#chineseSearch) feature. Supported values are: * `0`: enabled (default) * `1`: disabled", |
| 1246 | "type": "string" |
| 1247 | }, |
| 1248 | "exactTerms": { |
| 1249 | "description": "Identifies a phrase that all documents in the search results must contain.", |
| 1250 | "type": "string" |
| 1251 | }, |
| 1252 | "excludeTerms": { |
| 1253 | "description": "Identifies a word or phrase that should not appear in any documents in the search results.", |
| 1254 | "type": "string" |
| 1255 | }, |
| 1256 | "fileType": { |
| 1257 | "description": "Restricts results to files of a specified extension. Filetypes supported by Google include: * Adobe Portable Document Format (`pdf`) * Adobe PostScript (`ps`) * Lotus 1-2-3 (`wk1`, `wk2`, `wk3`, `wk4`, `wk5`, `wki`, `wks`, `wku`) * Lotus WordPro (`lwp`) * Macwrite (`mw`) * Microsoft Excel (`xls`) * Microsoft PowerPoint (`ppt`) * Microsoft Word (`doc`) * Microsoft Works (`wks`, `wps`, `wdb`) * Microsoft Write (`wri`) * Rich Text Format (`rtf`) * Shockwave Flash (`swf`) * Text (`ans`, `txt`). Additional filetypes may be added in the future. An up-to-date list can always be found in Google's [file type FAQ](https://support.google.com/webmasters/answer/35287).", |
| 1258 | "type": "string" |
| 1259 | }, |
| 1260 | "filter": { |
| 1261 | "description": "Activates or deactivates the automatic filtering of Google search results. See [Automatic Filtering](https://developers.google.com/custom-search/docs/xml_results#automaticFiltering) for more information about Google's search results filters. Valid values for this parameter are: * `0`: Disabled * `1`: Enabled (default) **Note**: By default, Google applies filtering to all search results to improve the quality of those results.", |
| 1262 | "type": "string" |
| 1263 | }, |
| 1264 | "gl": { |
| 1265 | "description": "Boosts search results whose country of origin matches the parameter value. See [Country Codes](https://developers.google.com/custom-search/docs/xml_results#countryCodes) for a list of valid values. Specifying a `gl` parameter value in WebSearch requests should improve the relevance of results. This is particularly true for international customers and, even more specifically, for customers in English-speaking countries other than the United States.", |
| 1266 | "type": "string" |
| 1267 | }, |
| 1268 | "googleHost": { |
| 1269 | "description": "Specifies the Google domain (for example, google.com, google.de, or google.fr) to which the search should be limited.", |
| 1270 | "type": "string" |
| 1271 | }, |
| 1272 | "highRange": { |
| 1273 | "description": "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.", |
| 1274 | "type": "string" |
| 1275 | }, |
| 1276 | "hl": { |
| 1277 | "description": "Specifies the interface language (host language) of your user interface. Explicitly setting this parameter improves the performance and the quality of your search results. See the [Interface Languages](https://developers.google.com/custom-search/docs/xml_results#wsInterfaceLanguages) section of [Internationalizing Queries and Results Presentation](https://developers.google.com/custom-search/docs/xml_results#wsInternationalizing) for more information, and [Supported Interface Languages](https://developers.google.com/custom-search/docs/xml_results_appendices#interfaceLanguages) for a list of supported languages.", |
| 1278 | "type": "string" |
| 1279 | }, |
| 1280 | "hq": { |
| 1281 | "description": "Appends the specified query terms to the query, as if they were combined with a logical `AND` operator.", |
| 1282 | "type": "string" |
| 1283 | }, |
| 1284 | "imgColorType": { |
| 1285 | "description": "Restricts results to images of a specified color type. Supported values are: * `mono` (black and white) * `gray` (grayscale) * `color` (color)", |
| 1286 | "type": "string" |
| 1287 | }, |
| 1288 | "imgDominantColor": { |
| 1289 | "description": "Restricts results to images with a specific dominant color. Supported values are: * `red` * `orange` * `yellow` * `green` * `teal` * `blue` * `purple` * `pink` * `white` * `gray` * `black` * `brown`", |
| 1290 | "type": "string" |
| 1291 | }, |
| 1292 | "imgSize": { |
| 1293 | "description": "Restricts results to images of a specified size. Supported values are: * `icon` (small) * `small | medium | large | xlarge` (medium) * `xxlarge` (large) * `huge` (extra-large)", |
| 1294 | "type": "string" |
| 1295 | }, |
| 1296 | "imgType": { |
| 1297 | "description": "Restricts results to images of a specified type. Supported values are: * `clipart` (Clip art) * `face` (Face) * `lineart` (Line drawing) * `photo` (Photo) * `animated` (Animated) * `stock` (Stock)", |
| 1298 | "type": "string" |
| 1299 | }, |
| 1300 | "inputEncoding": { |
| 1301 | "description": "The character encoding supported for search requests.", |
| 1302 | "type": "string" |
| 1303 | }, |
| 1304 | "language": { |
| 1305 | "description": "The language of the search results.", |
| 1306 | "type": "string" |
| 1307 | }, |
| 1308 | "linkSite": { |
| 1309 | "description": "Specifies that all results should contain a link to a specific URL.", |
| 1310 | "type": "string" |
| 1311 | }, |
| 1312 | "lowRange": { |
| 1313 | "description": "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.", |
| 1314 | "type": "string" |
| 1315 | }, |
| 1316 | "orTerms": { |
| 1317 | "description": "Provides additional search terms to check for in a document, where each document in the search results must contain at least one of the additional search terms. You can also use the [Boolean OR](https://developers.google.com/custom-search/docs/xml_results#BooleanOrqt) query term for this type of query.", |
| 1318 | "type": "string" |
| 1319 | }, |
| 1320 | "outputEncoding": { |
| 1321 | "description": "The character encoding supported for search results.", |
| 1322 | "type": "string" |
| 1323 | }, |
| 1324 | "relatedSite": { |
| 1325 | "description": "Specifies that all search results should be pages that are related to the specified URL. The parameter value should be a URL.", |
| 1326 | "type": "string" |
| 1327 | }, |
| 1328 | "rights": { |
| 1329 | "description": "Filters based on licensing. Supported values include: * `cc_publicdomain` * `cc_attribute` * `cc_sharealike` * `cc_noncommercial` * `cc_nonderived`", |
| 1330 | "type": "string" |
| 1331 | }, |
| 1332 | "safe": { |
| 1333 | "description": "Specifies the [SafeSearch level](https://developers.google.com/custom-search/docs/xml_results#safeSearchLevels) used for filtering out adult results. This is a custom property not defined in the OpenSearch spec. Valid parameter values are: * `\"off\"`: Disable SafeSearch * `\"active\"`: Enable SafeSearch", |
| 1334 | "type": "string" |
| 1335 | }, |
| 1336 | "searchTerms": { |
| 1337 | "description": "The search terms entered by the user.", |
| 1338 | "type": "string" |
| 1339 | }, |
| 1340 | "searchType": { |
| 1341 | "description": "Allowed values are `web` or `image`. If unspecified, results are limited to webpages.", |
| 1342 | "type": "string" |
| 1343 | }, |
| 1344 | "siteSearch": { |
| 1345 | "description": "Restricts results to URLs from a specified site.", |
| 1346 | "type": "string" |
| 1347 | }, |
| 1348 | "siteSearchFilter": { |
| 1349 | "description": "Specifies whether to include or exclude results from the site named in the `sitesearch` parameter. Supported values are: * `i`: include content from site * `e`: exclude content from site", |
| 1350 | "type": "string" |
| 1351 | }, |
| 1352 | "sort": { |
| 1353 | "description": "Specifies that results should be sorted according to the specified expression. For example, sort by date.", |
| 1354 | "type": "string" |
| 1355 | }, |
| 1356 | "startIndex": { |
| 1357 | "description": "The index of the current set of search results into the total set of results, where the index of the first result is 1.", |
| 1358 | "format": "int32", |
| 1359 | "type": "integer" |
| 1360 | }, |
| 1361 | "startPage": { |
| 1362 | "description": "The page number of this set of results, where the page length is set by the `count` property.", |
| 1363 | "format": "int32", |
| 1364 | "type": "integer" |
| 1365 | }, |
| 1366 | "title": { |
| 1367 | "description": "A description of the query.", |
| 1368 | "type": "string" |
| 1369 | }, |
| 1370 | "totalResults": { |
| 1371 | "description": "Estimated number of total search results. May not be accurate.", |
| 1372 | "format": "int64", |
| 1373 | "type": "string" |
| 1374 | } |
| 1375 | }, |
| 1376 | "type": "object" |
| 1377 | }, |
| 1378 | "type": "array" |
| 1379 | } |
| 1380 | }, |
| 1381 | "type": "object" |
| 1382 | }, |
| 1383 | "searchInformation": { |
| 1384 | "description": "Metadata about a search operation.", |
| 1385 | "properties": { |
| 1386 | "formattedSearchTime": { |
| 1387 | "description": "The time taken for the server to return search results, formatted according to locale style.", |
| 1388 | "type": "string" |
| 1389 | }, |
| 1390 | "formattedTotalResults": { |
| 1391 | "description": "The total number of search results, formatted according to locale style.", |
| 1392 | "type": "string" |
| 1393 | }, |
| 1394 | "searchTime": { |
| 1395 | "description": "The time taken for the server to return search results.", |
| 1396 | "format": "double", |
| 1397 | "type": "number" |
| 1398 | }, |
| 1399 | "totalResults": { |
| 1400 | "description": "The total number of search results returned by the query.", |
| 1401 | "type": "string" |
| 1402 | } |
| 1403 | }, |
| 1404 | "type": "object" |
| 1405 | }, |
| 1406 | "spelling": { |
| 1407 | "description": "Spell correction information for a query.", |
| 1408 | "properties": { |
| 1409 | "correctedQuery": { |
| 1410 | "description": "The corrected query.", |
| 1411 | "type": "string" |
| 1412 | }, |
| 1413 | "htmlCorrectedQuery": { |
| 1414 | "description": "The corrected query, formatted in HTML.", |
| 1415 | "type": "string" |
| 1416 | } |
| 1417 | }, |
| 1418 | "type": "object" |
| 1419 | }, |
| 1420 | "url": { |
| 1421 | "description": "OpenSearch template and URL.", |
| 1422 | "properties": { |
| 1423 | "template": { |
| 1424 | "description": "The actual [OpenSearch template](http://www.opensearch.org/specifications/opensearch/1.1#opensearch_url_template_syntax) for this API.", |
| 1425 | "type": "string" |
| 1426 | }, |
| 1427 | "type": { |
| 1428 | "description": "The MIME type of the OpenSearch URL template for the Custom Search JSON API.", |
| 1429 | "type": "string" |
| 1430 | } |
| 1431 | }, |
| 1432 | "type": "object" |
| 1433 | } |
| 1434 | }, |
| 1435 | "type": "object" |
| 1436 | } |
| 1437 | }, |
| 1438 | "servicePath": "", |
| 1439 | "title": "Custom Search API", |
| 1440 | "version": "v1", |
| 1441 | "version_module": true |
| 1442 | } |