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