1<html><body> 2<style> 3 4body, 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 15body { 16 font-size: 13px; 17 padding: 1em; 18} 19 20h1 { 21 font-size: 26px; 22 margin-bottom: 1em; 23} 24 25h2 { 26 font-size: 24px; 27 margin-bottom: 1em; 28} 29 30h3 { 31 font-size: 20px; 32 margin-bottom: 1em; 33 margin-top: 1em; 34} 35 36pre, code { 37 line-height: 1.5; 38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; 39} 40 41pre { 42 margin-top: 0.5em; 43} 44 45h1, h2, h3, p { 46 font-family: Arial, sans serif; 47} 48 49h1, 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 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> 76<h2>Instance Methods</h2> 77<p class="toc_element"> 78 <code><a href="#close">close()</a></code></p> 79<p class="firstline">Close httplib2 connections.</p> 80<p class="toc_element"> 81 <code><a href="#list">list(c2coff=None, cr=None, cx=None, dateRestrict=None, exactTerms=None, excludeTerms=None, fileType=None, filter=None, gl=None, googlehost=None, highRange=None, hl=None, hq=None, imgColorType=None, imgDominantColor=None, imgSize=None, imgType=None, linkSite=None, lowRange=None, lr=None, num=None, orTerms=None, q=None, relatedSite=None, rights=None, safe=None, searchType=None, siteSearch=None, siteSearchFilter=None, sort=None, start=None, x__xgafv=None)</a></code></p> 82<p class="firstline">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.</p> 83<h3>Method Details</h3> 84<div class="method"> 85 <code class="details" id="close">close()</code> 86 <pre>Close httplib2 connections.</pre> 87</div> 88 89<div class="method"> 90 <code class="details" id="list">list(c2coff=None, cr=None, cx=None, dateRestrict=None, exactTerms=None, excludeTerms=None, fileType=None, filter=None, gl=None, googlehost=None, highRange=None, hl=None, hq=None, imgColorType=None, imgDominantColor=None, imgSize=None, imgType=None, linkSite=None, lowRange=None, lr=None, num=None, orTerms=None, q=None, relatedSite=None, rights=None, safe=None, searchType=None, siteSearch=None, siteSearchFilter=None, sort=None, start=None, x__xgafv=None)</code> 91 <pre>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. 92 93Args: 94 c2coff: string, Enables or disables [Simplified and Traditional Chinese Search](https://developers.google.com/custom-search/docs/json_api_reference#chineseSearch). The default value for this parameter is 0 (zero), meaning that the feature is enabled. Supported values are: * `1`: Disabled * `0`: Enabled (default) 95 cr: string, Restricts search results to documents originating in a particular country. You may use [Boolean operators](https://developers.google.com/custom-search/docs/json_api_reference#booleanOperators) in the cr parameter's value. Google Search determines the country of a document by analyzing: * the top-level domain (TLD) of the document's URL * the geographic location of the Web server's IP address See the [Country Parameter Values](https://developers.google.com/custom-search/docs/json_api_reference#countryCollections) page for a list of valid values for this parameter. 96 cx: string, The Programmable Search Engine ID to use for this request. 97 dateRestrict: string, 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. 98 exactTerms: string, Identifies a phrase that all documents in the search results must contain. 99 excludeTerms: string, Identifies a word or phrase that should not appear in any documents in the search results. 100 fileType: string, 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). 101 filter: string, Controls turning on or off the duplicate content filter. * See [Automatic Filtering](https://developers.google.com/custom-search/docs/json_api_reference#automaticFiltering) for more information about Google's search results filters. Note that host crowding filtering applies only to multi-site searches. * By default, Google applies filtering to all search results to improve the quality of those results. Acceptable values are: * `0`: Turns off duplicate content filter. * `1`: Turns on duplicate content filter. 102 gl: string, Geolocation of end user. * The `gl` parameter value is a two-letter country code. The `gl` parameter boosts search results whose country of origin matches the parameter value. See the [Country Codes](https://developers.google.com/custom-search/docs/json_api_reference#countryCodes) page for a list of valid values. * Specifying a `gl` parameter value should lead to more relevant results. This is particularly true for international customers and, even more specifically, for customers in English- speaking countries other than the United States. 103 googlehost: string, **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. 104 highRange: string, Specifies the ending value for a search range. * Use `lowRange` and `highRange` to append an inclusive search range of `lowRange...highRange` to the query. 105 hl: string, Sets the user interface language. * Explicitly setting this parameter improves the performance and the quality of your search results. * See the [Interface Languages](https://developers.google.com/custom-search/docs/json_api_reference#wsInterfaceLanguages) section of [Internationalizing Queries and Results Presentation](https://developers.google.com/custom-search/docs/json_api_reference#wsInternationalizing) for more information, and [Supported Interface Languages](https://developers.google.com/custom-search/docs/json_api_reference#interfaceLanguages) for a list of supported languages. 106 hq: string, Appends the specified query terms to the query, as if they were combined with a logical AND operator. 107 imgColorType: string, Returns black and white, grayscale, transparent, or color images. Acceptable values are: * `"color"` * `"gray"` * `"mono"`: black and white * `"trans"`: transparent background 108 Allowed values 109 imgColorTypeUndefined - No image color type specified. 110 mono - Black and white images only. 111 gray - Grayscale images only. 112 color - Color images only. 113 trans - Images with transparent background 114 imgDominantColor: string, Returns images of a specific dominant color. Acceptable values are: * `"black"` * `"blue"` * `"brown"` * `"gray"` * `"green"` * `"orange"` * `"pink"` * `"purple"` * `"red"` * `"teal"` * `"white"` * `"yellow"` 115 Allowed values 116 imgDominantColorUndefined - No dominant color specified. 117 black - Predominantly black images only. 118 blue - Predominantly blue images only. 119 brown - Predominantly brown images only. 120 gray - Predominantly gray images only. 121 green - Predominantly green images only. 122 orange - Predominantly orange images only. 123 pink - Predominantly pink images only. 124 purple - Predominantly purple images only. 125 red - Predominantly red images only. 126 teal - Predominantly teal images only. 127 white - Predominantly white images only. 128 yellow - Predominantly yellow images only. 129 imgSize: string, Returns images of a specified size. Acceptable values are: * `"huge"` * `"icon"` * `"large"` * `"medium"` * `"small"` * `"xlarge"` * `"xxlarge"` 130 Allowed values 131 imgSizeUndefined - No image size specified. 132 HUGE - Only the largest possible images. 133 ICON - Only very small icon-sized images. 134 LARGE - Only large images. 135 MEDIUM - Only medium images. 136 SMALL - Only small images. 137 XLARGE - Only very large images. 138 XXLARGE - Only extremely large images. 139 imgType: string, Returns images of a type. Acceptable values are: * `"clipart"` * `"face"` * `"lineart"` * `"stock"` * `"photo"` * `"animated"` 140 Allowed values 141 imgTypeUndefined - No image type specified. 142 clipart - Clipart-style images only. 143 face - Images of faces only. 144 lineart - Line art images only. 145 stock - Stock images only. 146 photo - Photo images only. 147 animated - Animated images only. 148 linkSite: string, Specifies that all search results should contain a link to a particular URL. 149 lowRange: string, Specifies the starting value for a search range. Use `lowRange` and `highRange` to append an inclusive search range of `lowRange...highRange` to the query. 150 lr: string, 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) 151 num: integer, Number of search results to return. * Valid values are integers between 1 and 10, inclusive. 152 orTerms: string, 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. 153 q: string, Query 154 relatedSite: string, Specifies that all search results should be pages that are related to the specified URL. 155 rights: string, 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). 156 safe: string, Search safety level. Acceptable values are: * `"active"`: Enables SafeSearch filtering. * `"off"`: Disables SafeSearch filtering. (default) 157 Allowed values 158 safeUndefined - SafeSearch mode unspecified. (Falls back to engine's configuration.) 159 active - Turn SafeSearch on. 160 high - Deprecated, equivalent to "active". 161 medium - Deprecated, equivalent to "active". 162 off - Turn SafeSearch off. 163 searchType: string, Specifies the search type: `image`. If unspecified, results are limited to webpages. Acceptable values are: * `"image"`: custom image search. 164 Allowed values 165 searchTypeUndefined - Search type unspecified (defaults to web search). 166 image - Image search. 167 siteSearch: string, Specifies a given site which should always be included or excluded from results (see `siteSearchFilter` parameter, below). 168 siteSearchFilter: string, Controls whether to include or exclude results from the site named in the `siteSearch` parameter. Acceptable values are: * `"e"`: exclude * `"i"`: include 169 Allowed values 170 siteSearchFilterUndefined - Filter mode unspecified. 171 e - Exclude results from the listed sites. 172 i - Include only results from the listed sites. 173 sort: string, 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). 174 start: integer, 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. 175 x__xgafv: string, V1 error format. 176 Allowed values 177 1 - v1 error format 178 2 - v2 error format 179 180Returns: 181 An object of the form: 182 183 { # Response to a custom search request. 184 "context": { # 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. 185 "a_key": "", # Properties of the object. 186 }, 187 "items": [ # The current set of custom search results. 188 { # A custom search result. 189 "cacheId": "A String", # Indicates the ID of Google's cached version of the search result. 190 "displayLink": "A String", # An abridged version of this search result’s URL, e.g. www.example.com. 191 "fileFormat": "A String", # The file format of the search result. 192 "formattedUrl": "A String", # The URL displayed after the snippet for each search result. 193 "htmlFormattedUrl": "A String", # The HTML-formatted URL displayed after the snippet for each search result. 194 "htmlSnippet": "A String", # The snippet of the search result, in HTML. 195 "htmlTitle": "A String", # The title of the search result, in HTML. 196 "image": { # Image belonging to a custom search result. 197 "byteSize": 42, # The size of the image, in pixels. 198 "contextLink": "A String", # A URL pointing to the webpage hosting the image. 199 "height": 42, # The height of the image, in pixels. 200 "thumbnailHeight": 42, # The height of the thumbnail image, in pixels. 201 "thumbnailLink": "A String", # A URL to the thumbnail image. 202 "thumbnailWidth": 42, # The width of the thumbnail image, in pixels. 203 "width": 42, # The width of the image, in pixels. 204 }, 205 "kind": "A String", # A unique identifier for the type of current object. For this API, it is `customsearch#result.` 206 "labels": [ # Encapsulates all information about refinement labels. 207 { # Refinement label associated with a custom search result. 208 "displayName": "A String", # The display name of a refinement label. This is the name you should display in your user interface. 209 "label_with_op": "A String", # Refinement label and the associated refinement operation. 210 "name": "A String", # The name of a refinement label, which you can use to refine searches. Don't display this in your user interface; instead, use displayName. 211 }, 212 ], 213 "link": "A String", # The full URL to which the search result is pointing, e.g. http://www.example.com/foo/bar. 214 "mime": "A String", # The MIME type of the search result. 215 "pagemap": { # Contains [PageMap](https://developers.google.com/custom-search/docs/structured_data#pagemaps) information for this search result. 216 "a_key": "", # Properties of the object. 217 }, 218 "snippet": "A String", # The snippet of the search result, in plain text. 219 "title": "A String", # The title of the search result, in plain text. 220 }, 221 ], 222 "kind": "A String", # Unique identifier for the type of current object. For this API, it is customsearch#search. 223 "promotions": [ # 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. 224 { # Promotion result. 225 "bodyLines": [ # An array of block objects for this promotion. 226 { # Block object belonging to a promotion. 227 "htmlTitle": "A String", # The block object's text in HTML, if it has text. 228 "link": "A String", # The anchor text of the block object's link, if it has a link. 229 "title": "A String", # The block object's text, if it has text. 230 "url": "A String", # The URL of the block object's link, if it has one. 231 }, 232 ], 233 "displayLink": "A String", # An abridged version of this search's result URL, e.g. www.example.com. 234 "htmlTitle": "A String", # The title of the promotion, in HTML. 235 "image": { # Image belonging to a promotion. 236 "height": 42, # Image height in pixels. 237 "source": "A String", # URL of the image for this promotion link. 238 "width": 42, # Image width in pixels. 239 }, 240 "link": "A String", # The URL of the promotion. 241 "title": "A String", # The title of the promotion. 242 }, 243 ], 244 "queries": { # Query metadata for the previous, current, and next pages of results. 245 "nextPage": [ # Metadata representing the next page of results, if applicable. 246 { # Custom search request metadata. 247 "count": 42, # Number of search results returned in this set. 248 "cr": "A String", # Restricts search results to documents originating in a particular country. You may use [Boolean operators](https://developers.google.com/custom-search/docs/json_api_reference#BooleanOrSearch) in the `cr` parameter's value. Google WebSearch determines the country of a document by analyzing the following: * The top-level domain (TLD) of the document's URL. * The geographic location of the web server's IP address. See [Country (cr) Parameter Values](https://developers.google.com/custom-search/docs/json_api_reference#countryCollections) for a list of valid values for this parameter. 249 "cx": "A String", # 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**. 250 "dateRestrict": "A String", # 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. 251 "disableCnTwTranslation": "A String", # Enables or disables the [Simplified and Traditional Chinese Search](https://developers.google.com/custom-search/docs/json_api_reference#chineseSearch) feature. Supported values are: * `0`: enabled (default) * `1`: disabled 252 "exactTerms": "A String", # Identifies a phrase that all documents in the search results must contain. 253 "excludeTerms": "A String", # Identifies a word or phrase that should not appear in any documents in the search results. 254 "fileType": "A String", # 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). 255 "filter": "A String", # Activates or deactivates the automatic filtering of Google search results. See [Automatic Filtering](https://developers.google.com/custom-search/docs/json_api_reference#automaticFiltering) for more information about Google's search results filters. Valid values for this parameter are: * `0`: Disabled * `1`: Enabled (default) **Note**: By default, Google applies filtering to all search results to improve the quality of those results. 256 "gl": "A String", # Boosts search results whose country of origin matches the parameter value. See [Country Codes](https://developers.google.com/custom-search/docs/json_api_reference#countryCodes) for a list of valid values. Specifying a `gl` parameter value in WebSearch requests should improve the relevance of results. This is particularly true for international customers and, even more specifically, for customers in English-speaking countries other than the United States. 257 "googleHost": "A String", # Specifies the Google domain (for example, google.com, google.de, or google.fr) to which the search should be limited. 258 "highRange": "A String", # 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. 259 "hl": "A String", # Specifies the interface language (host language) of your user interface. Explicitly setting this parameter improves the performance and the quality of your search results. See the [Interface Languages](https://developers.google.com/custom-search/docs/json_api_reference#wsInterfaceLanguages) section of [Internationalizing Queries and Results Presentation](https://developers.google.com/custom-search/docs/json_api_reference#wsInternationalizing) for more information, and [Supported Interface Languages](https://developers.google.com/custom-search/docs/json_api_reference#interfaceLanguages) for a list of supported languages. 260 "hq": "A String", # Appends the specified query terms to the query, as if they were combined with a logical `AND` operator. 261 "imgColorType": "A String", # Restricts results to images of a specified color type. Supported values are: * `mono` (black and white) * `gray` (grayscale) * `color` (color) 262 "imgDominantColor": "A String", # Restricts results to images with a specific dominant color. Supported values are: * `red` * `orange` * `yellow` * `green` * `teal` * `blue` * `purple` * `pink` * `white` * `gray` * `black` * `brown` 263 "imgSize": "A String", # Restricts results to images of a specified size. Supported values are: * `icon` (small) * `small | medium | large | xlarge` (medium) * `xxlarge` (large) * `huge` (extra-large) 264 "imgType": "A String", # 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) 265 "inputEncoding": "A String", # The character encoding supported for search requests. 266 "language": "A String", # The language of the search results. 267 "linkSite": "A String", # Specifies that all results should contain a link to a specific URL. 268 "lowRange": "A String", # 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. 269 "orTerms": "A String", # Provides additional search terms to check for in a document, where each document in the search results must contain at least one of the additional search terms. You can also use the [Boolean OR](https://developers.google.com/custom-search/docs/json_api_reference#BooleanOrSearch) query term for this type of query. 270 "outputEncoding": "A String", # The character encoding supported for search results. 271 "relatedSite": "A String", # Specifies that all search results should be pages that are related to the specified URL. The parameter value should be a URL. 272 "rights": "A String", # Filters based on licensing. Supported values include: * `cc_publicdomain` * `cc_attribute` * `cc_sharealike` * `cc_noncommercial` * `cc_nonderived` 273 "safe": "A String", # Specifies the [SafeSearch level](https://developers.google.com/custom-search/docs/json_api_reference#safeSearchLevels) used for filtering out adult results. This is a custom property not defined in the OpenSearch spec. Valid parameter values are: * `"off"`: Disable SafeSearch * `"active"`: Enable SafeSearch 274 "searchTerms": "A String", # The search terms entered by the user. 275 "searchType": "A String", # Allowed values are `web` or `image`. If unspecified, results are limited to webpages. 276 "siteSearch": "A String", # Restricts results to URLs from a specified site. 277 "siteSearchFilter": "A String", # 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 278 "sort": "A String", # Specifies that results should be sorted according to the specified expression. For example, sort by date. 279 "startIndex": 42, # The index of the current set of search results into the total set of results, where the index of the first result is 1. 280 "startPage": 42, # The page number of this set of results, where the page length is set by the `count` property. 281 "title": "A String", # A description of the query. 282 "totalResults": "A String", # Estimated number of total search results. May not be accurate. 283 }, 284 ], 285 "previousPage": [ # Metadata representing the previous page of results, if applicable. 286 { # Custom search request metadata. 287 "count": 42, # Number of search results returned in this set. 288 "cr": "A String", # Restricts search results to documents originating in a particular country. You may use [Boolean operators](https://developers.google.com/custom-search/docs/json_api_reference#BooleanOrSearch) in the `cr` parameter's value. Google WebSearch determines the country of a document by analyzing the following: * The top-level domain (TLD) of the document's URL. * The geographic location of the web server's IP address. See [Country (cr) Parameter Values](https://developers.google.com/custom-search/docs/json_api_reference#countryCollections) for a list of valid values for this parameter. 289 "cx": "A String", # 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**. 290 "dateRestrict": "A String", # 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. 291 "disableCnTwTranslation": "A String", # Enables or disables the [Simplified and Traditional Chinese Search](https://developers.google.com/custom-search/docs/json_api_reference#chineseSearch) feature. Supported values are: * `0`: enabled (default) * `1`: disabled 292 "exactTerms": "A String", # Identifies a phrase that all documents in the search results must contain. 293 "excludeTerms": "A String", # Identifies a word or phrase that should not appear in any documents in the search results. 294 "fileType": "A String", # 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). 295 "filter": "A String", # Activates or deactivates the automatic filtering of Google search results. See [Automatic Filtering](https://developers.google.com/custom-search/docs/json_api_reference#automaticFiltering) for more information about Google's search results filters. Valid values for this parameter are: * `0`: Disabled * `1`: Enabled (default) **Note**: By default, Google applies filtering to all search results to improve the quality of those results. 296 "gl": "A String", # Boosts search results whose country of origin matches the parameter value. See [Country Codes](https://developers.google.com/custom-search/docs/json_api_reference#countryCodes) for a list of valid values. Specifying a `gl` parameter value in WebSearch requests should improve the relevance of results. This is particularly true for international customers and, even more specifically, for customers in English-speaking countries other than the United States. 297 "googleHost": "A String", # Specifies the Google domain (for example, google.com, google.de, or google.fr) to which the search should be limited. 298 "highRange": "A String", # 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. 299 "hl": "A String", # Specifies the interface language (host language) of your user interface. Explicitly setting this parameter improves the performance and the quality of your search results. See the [Interface Languages](https://developers.google.com/custom-search/docs/json_api_reference#wsInterfaceLanguages) section of [Internationalizing Queries and Results Presentation](https://developers.google.com/custom-search/docs/json_api_reference#wsInternationalizing) for more information, and [Supported Interface Languages](https://developers.google.com/custom-search/docs/json_api_reference#interfaceLanguages) for a list of supported languages. 300 "hq": "A String", # Appends the specified query terms to the query, as if they were combined with a logical `AND` operator. 301 "imgColorType": "A String", # Restricts results to images of a specified color type. Supported values are: * `mono` (black and white) * `gray` (grayscale) * `color` (color) 302 "imgDominantColor": "A String", # Restricts results to images with a specific dominant color. Supported values are: * `red` * `orange` * `yellow` * `green` * `teal` * `blue` * `purple` * `pink` * `white` * `gray` * `black` * `brown` 303 "imgSize": "A String", # Restricts results to images of a specified size. Supported values are: * `icon` (small) * `small | medium | large | xlarge` (medium) * `xxlarge` (large) * `huge` (extra-large) 304 "imgType": "A String", # 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) 305 "inputEncoding": "A String", # The character encoding supported for search requests. 306 "language": "A String", # The language of the search results. 307 "linkSite": "A String", # Specifies that all results should contain a link to a specific URL. 308 "lowRange": "A String", # 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. 309 "orTerms": "A String", # Provides additional search terms to check for in a document, where each document in the search results must contain at least one of the additional search terms. You can also use the [Boolean OR](https://developers.google.com/custom-search/docs/json_api_reference#BooleanOrSearch) query term for this type of query. 310 "outputEncoding": "A String", # The character encoding supported for search results. 311 "relatedSite": "A String", # Specifies that all search results should be pages that are related to the specified URL. The parameter value should be a URL. 312 "rights": "A String", # Filters based on licensing. Supported values include: * `cc_publicdomain` * `cc_attribute` * `cc_sharealike` * `cc_noncommercial` * `cc_nonderived` 313 "safe": "A String", # Specifies the [SafeSearch level](https://developers.google.com/custom-search/docs/json_api_reference#safeSearchLevels) used for filtering out adult results. This is a custom property not defined in the OpenSearch spec. Valid parameter values are: * `"off"`: Disable SafeSearch * `"active"`: Enable SafeSearch 314 "searchTerms": "A String", # The search terms entered by the user. 315 "searchType": "A String", # Allowed values are `web` or `image`. If unspecified, results are limited to webpages. 316 "siteSearch": "A String", # Restricts results to URLs from a specified site. 317 "siteSearchFilter": "A String", # 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 318 "sort": "A String", # Specifies that results should be sorted according to the specified expression. For example, sort by date. 319 "startIndex": 42, # The index of the current set of search results into the total set of results, where the index of the first result is 1. 320 "startPage": 42, # The page number of this set of results, where the page length is set by the `count` property. 321 "title": "A String", # A description of the query. 322 "totalResults": "A String", # Estimated number of total search results. May not be accurate. 323 }, 324 ], 325 "request": [ # Metadata representing the current request. 326 { # Custom search request metadata. 327 "count": 42, # Number of search results returned in this set. 328 "cr": "A String", # Restricts search results to documents originating in a particular country. You may use [Boolean operators](https://developers.google.com/custom-search/docs/json_api_reference#BooleanOrSearch) in the `cr` parameter's value. Google WebSearch determines the country of a document by analyzing the following: * The top-level domain (TLD) of the document's URL. * The geographic location of the web server's IP address. See [Country (cr) Parameter Values](https://developers.google.com/custom-search/docs/json_api_reference#countryCollections) for a list of valid values for this parameter. 329 "cx": "A String", # 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**. 330 "dateRestrict": "A String", # 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. 331 "disableCnTwTranslation": "A String", # Enables or disables the [Simplified and Traditional Chinese Search](https://developers.google.com/custom-search/docs/json_api_reference#chineseSearch) feature. Supported values are: * `0`: enabled (default) * `1`: disabled 332 "exactTerms": "A String", # Identifies a phrase that all documents in the search results must contain. 333 "excludeTerms": "A String", # Identifies a word or phrase that should not appear in any documents in the search results. 334 "fileType": "A String", # 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). 335 "filter": "A String", # Activates or deactivates the automatic filtering of Google search results. See [Automatic Filtering](https://developers.google.com/custom-search/docs/json_api_reference#automaticFiltering) for more information about Google's search results filters. Valid values for this parameter are: * `0`: Disabled * `1`: Enabled (default) **Note**: By default, Google applies filtering to all search results to improve the quality of those results. 336 "gl": "A String", # Boosts search results whose country of origin matches the parameter value. See [Country Codes](https://developers.google.com/custom-search/docs/json_api_reference#countryCodes) for a list of valid values. Specifying a `gl` parameter value in WebSearch requests should improve the relevance of results. This is particularly true for international customers and, even more specifically, for customers in English-speaking countries other than the United States. 337 "googleHost": "A String", # Specifies the Google domain (for example, google.com, google.de, or google.fr) to which the search should be limited. 338 "highRange": "A String", # 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. 339 "hl": "A String", # Specifies the interface language (host language) of your user interface. Explicitly setting this parameter improves the performance and the quality of your search results. See the [Interface Languages](https://developers.google.com/custom-search/docs/json_api_reference#wsInterfaceLanguages) section of [Internationalizing Queries and Results Presentation](https://developers.google.com/custom-search/docs/json_api_reference#wsInternationalizing) for more information, and [Supported Interface Languages](https://developers.google.com/custom-search/docs/json_api_reference#interfaceLanguages) for a list of supported languages. 340 "hq": "A String", # Appends the specified query terms to the query, as if they were combined with a logical `AND` operator. 341 "imgColorType": "A String", # Restricts results to images of a specified color type. Supported values are: * `mono` (black and white) * `gray` (grayscale) * `color` (color) 342 "imgDominantColor": "A String", # Restricts results to images with a specific dominant color. Supported values are: * `red` * `orange` * `yellow` * `green` * `teal` * `blue` * `purple` * `pink` * `white` * `gray` * `black` * `brown` 343 "imgSize": "A String", # Restricts results to images of a specified size. Supported values are: * `icon` (small) * `small | medium | large | xlarge` (medium) * `xxlarge` (large) * `huge` (extra-large) 344 "imgType": "A String", # 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) 345 "inputEncoding": "A String", # The character encoding supported for search requests. 346 "language": "A String", # The language of the search results. 347 "linkSite": "A String", # Specifies that all results should contain a link to a specific URL. 348 "lowRange": "A String", # 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. 349 "orTerms": "A String", # Provides additional search terms to check for in a document, where each document in the search results must contain at least one of the additional search terms. You can also use the [Boolean OR](https://developers.google.com/custom-search/docs/json_api_reference#BooleanOrSearch) query term for this type of query. 350 "outputEncoding": "A String", # The character encoding supported for search results. 351 "relatedSite": "A String", # Specifies that all search results should be pages that are related to the specified URL. The parameter value should be a URL. 352 "rights": "A String", # Filters based on licensing. Supported values include: * `cc_publicdomain` * `cc_attribute` * `cc_sharealike` * `cc_noncommercial` * `cc_nonderived` 353 "safe": "A String", # Specifies the [SafeSearch level](https://developers.google.com/custom-search/docs/json_api_reference#safeSearchLevels) used for filtering out adult results. This is a custom property not defined in the OpenSearch spec. Valid parameter values are: * `"off"`: Disable SafeSearch * `"active"`: Enable SafeSearch 354 "searchTerms": "A String", # The search terms entered by the user. 355 "searchType": "A String", # Allowed values are `web` or `image`. If unspecified, results are limited to webpages. 356 "siteSearch": "A String", # Restricts results to URLs from a specified site. 357 "siteSearchFilter": "A String", # 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 358 "sort": "A String", # Specifies that results should be sorted according to the specified expression. For example, sort by date. 359 "startIndex": 42, # The index of the current set of search results into the total set of results, where the index of the first result is 1. 360 "startPage": 42, # The page number of this set of results, where the page length is set by the `count` property. 361 "title": "A String", # A description of the query. 362 "totalResults": "A String", # Estimated number of total search results. May not be accurate. 363 }, 364 ], 365 }, 366 "searchInformation": { # Metadata about a search operation. 367 "formattedSearchTime": "A String", # The time taken for the server to return search results, formatted according to locale style. 368 "formattedTotalResults": "A String", # The total number of search results, formatted according to locale style. 369 "searchTime": 3.14, # The time taken for the server to return search results. 370 "totalResults": "A String", # The total number of search results returned by the query. 371 }, 372 "spelling": { # Spell correction information for a query. 373 "correctedQuery": "A String", # The corrected query. 374 "htmlCorrectedQuery": "A String", # The corrected query, formatted in HTML. 375 }, 376 "url": { # OpenSearch template and URL. 377 "template": "A String", # The actual [OpenSearch template](http://www.opensearch.org/specifications/opensearch/1.1#opensearch_url_template_syntax) for this API. 378 "type": "A String", # The MIME type of the OpenSearch URL template for the Custom Search JSON API. 379 }, 380}</pre> 381</div> 382 383</body></html>