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