Returns the siterestrict Resource.
Returns metadata about the search performed, metadata about the custom
list(sort=None, hl=None, orTerms=None, highRange=None, cx=None, cr=None, imgType=None, relatedSite=None, filter=None, gl=None, searchType=None, fileType=None, linkSite=None, start=None, imgDominantColor=None, lr=None, siteSearch=None, dateRestrict=None, safe=None, c2coff=None, googlehost=None, hq=None, exactTerms=None, lowRange=None, imgSize=None, imgColorType=None, rights=None, x__xgafv=None, excludeTerms=None, q=None, num=None, siteSearchFilter=None)
Returns metadata about the search performed, metadata about the custom search engine used for the search, and the search results. Args: sort: string, The sort expression to apply to the results. 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. 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. 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. cx: string, The custom search engine ID to use for this request. 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. imgType: string, Returns images of a type. Acceptable values are: * `"clipart"` * `"face"` * `"lineart"` * `"stock"` * `"photo"` * `"animated"` relatedSite: string, Specifies that all search results should be pages that are related to the specified URL. 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. 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. searchType: string, Specifies the search type: `image`. If unspecified, results are limited to webpages. Acceptable values are: * `"image"`: custom image search. 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). linkSite: string, Specifies that all search results should contain a link to a particular URL. 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. imgDominantColor: string, Returns images of a specific dominant color. Acceptable values are: * `"black"` * `"blue"` * `"brown"` * `"gray"` * `"green"` * `"orange"` * `"pink"` * `"purple"` * `"red"` * `"teal"` * `"white"` * `"yellow"` 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) siteSearch: string, Specifies a given site which should always be included or excluded from results (see `siteSearchFilter` parameter, below). 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. safe: string, Search safety level. Acceptable values are: * `"active"`: Enables SafeSearch filtering. * `"off"`: Disables SafeSearch filtering. (default) 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) 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. hq: string, Appends the specified query terms to the query, as if they were combined with a logical AND operator. exactTerms: string, Identifies a phrase that all documents in the search results must contain. 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. imgSize: string, Returns images of a specified size. Acceptable values are: * `"huge"` * `"icon"` * `"large"` * `"medium"` * `"small"` * `"xlarge"` * `"xxlarge"` imgColorType: string, Returns black and white, grayscale, transparent, or color images. Acceptable values are: * `"color"` * `"gray"` * `"mono"`: black and white * `"trans"`: transparent background 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). x__xgafv: string, V1 error format. Allowed values 1 - v1 error format 2 - v2 error format excludeTerms: string, Identifies a word or phrase that should not appear in any documents in the search results. q: string, Query num: integer, Number of search results to return. * Valid values are integers between 1 and 10, inclusive. siteSearchFilter: string, Controls whether to include or exclude results from the site named in the `siteSearch` parameter. Acceptable values are: * `"e"`: exclude * `"i"`: include Returns: An object of the form: { # Response to a custom search request. "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. { # Promotion result. "title": "A String", # The title of the promotion. "displayLink": "A String", # An abridged version of this search's result URL, e.g. www.example.com. "image": { # Image belonging to a promotion. "source": "A String", # URL of the image for this promotion link. "height": 42, # Image height in pixels. "width": 42, # Image width in pixels. }, "link": "A String", # The URL of the promotion. "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. { # Block object belonging to a promotion. "url": "A String", # The URL of the block object's link, if it has one. "htmlTitle": "A String", # The block object's text in HTML, if it has text. "link": "A String", # The anchor text of the block object's link, if it has a link. "title": "A String", # The block object's text, if it has text. }, ], "htmlTitle": "A String", # The title of the promotion, in HTML. }, ], "kind": "A String", # Unique identifier for the type of current object. For this API, it is # customsearch#search. "url": { # OpenSearch template and URL. "type": "A String", # The MIME type of the OpenSearch URL template for the Custom Search API. "template": "A String", # The actual [OpenSearch # template](http://www.opensearch.org/specifications/opensearch/1.1#opensearch_url_template_syntax) # for this API. }, "items": [ # The current set of custom search results. { # A custom search result. "kind": "A String", # A unique identifier for the type of current object. For this API, it is # `customsearch#result.` "labels": [ # Encapsulates all information about [refinement # labels](https://developers.google.com/custom-search/docs/xml_results). { # Refinement label associated with a custom search result. "label_with_op": "A String", # Refinement label and the associated refinement operation. "displayName": "A String", # The display name of a refinement label. This is the name you should # display in your user interface. "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. }, ], "title": "A String", # The title of the search result, in plain text. "displayLink": "A String", # An abridged version of this search result’s URL, e.g. www.example.com. "htmlTitle": "A String", # The title of the search result, in HTML. "formattedUrl": "A String", # The URL displayed after the snippet for each search result. "htmlFormattedUrl": "A String", # The HTML-formatted URL displayed after the snippet for each search result. "pagemap": { # Contains # [PageMap](https://developers.google.com/custom-search/docs/structured_data#pagemaps) # information for this search result. "a_key": "", # Properties of the object. }, "fileFormat": "A String", # The file format of the search result. "snippet": "A String", # The snippet of the search result, in plain text. "cacheId": "A String", # Indicates the ID of Google's cached version of the search result. "mime": "A String", # The MIME type of the search result. "htmlSnippet": "A String", # The snippet of the search result, in HTML. "link": "A String", # The full URL to which the search result is pointing, e.g. # http://www.example.com/foo/bar. "image": { # Image belonging to a custom search result. "thumbnailWidth": 42, # The width of the thumbnail image, in pixels. "thumbnailLink": "A String", # A URL to the thumbnail image. "height": 42, # The height of the image, in pixels. "width": 42, # The width of the image, in pixels. "contextLink": "A String", # A URL pointing to the webpage hosting the image. "byteSize": 42, # The size of the image, in pixels. "thumbnailHeight": 42, # The height of the thumbnail image, in pixels. }, }, ], "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. "a_key": "", # Properties of the object. }, "queries": { # Query metadata for the previous, current, and next pages of results. "request": [ # Metadata representing the current request. { # Custom search request metadata. "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. "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. "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. "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. "cx": "A String", # The identifier of a custom search engine created using the Custom Search # [Control Panel](https://cse.google.com/). This is a custom property not # defined in the OpenSearch spec. This parameter is **required**. "startPage": 42, # The page number of this set of results, where the page length is set by # the `count` property. "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 "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. "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) "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. "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. "searchType": "A String", # Allowed values are `web` or `image`. If unspecified, results are limited # to webpages. "title": "A String", # A description of the query. "googleHost": "A String", # Specifies the Google domain (for example, google.com, google.de, or # google.fr) to which the search should be limited. "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). "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` "siteSearch": "A String", # Restricts results to URLs from a specified site. "sort": "A String", # Specifies that results should be sorted according to the specified # expression. For example, sort by date. "hq": "A String", # Appends the specified query terms to the query, as if they were combined # with a logical `AND` operator. "outputEncoding": "A String", # The character encoding supported for search results. "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 "searchTerms": "A String", # The search terms entered by the user. "exactTerms": "A String", # Identifies a phrase that all documents in the search results must # contain. "inputEncoding": "A String", # The character encoding supported for search requests. "totalResults": "A String", # Estimated number of total search results. May not be accurate. "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. "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) "count": 42, # Number of search results returned in this set. "imgColorType": "A String", # Restricts results to images of a specified color type. Supported values # are: # # * `mono` (black and white) # # * `gray` (grayscale) # # * `color` (color) "language": "A String", # The language of the search results. "rights": "A String", # Filters based on licensing. Supported values include: # # * `cc_publicdomain` # # * `cc_attribute` # # * `cc_sharealike` # # * `cc_noncommercial` # # * `cc_nonderived` "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. "excludeTerms": "A String", # Identifies a word or phrase that should not appear in any documents in # the search results. "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. "linkSite": "A String", # Specifies that all results should contain a link to a specific URL. "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 }, ], "previousPage": [ # Metadata representing the previous page of results, if applicable. { # Custom search request metadata. "sort": "A String", # Specifies that results should be sorted according to the specified # expression. For example, sort by date. "inputEncoding": "A String", # The character encoding supported for search requests. "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. "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. "cx": "A String", # The identifier of a custom search engine created using the Custom Search # [Control Panel](https://cse.google.com/). This is a custom property not # defined in the OpenSearch spec. This parameter is **required**. "startPage": 42, # The page number of this set of results, where the page length is set by # the `count` property. "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 "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. "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) "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. "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. "searchType": "A String", # Allowed values are `web` or `image`. If unspecified, results are limited # to webpages. "title": "A String", # A description of the query. "googleHost": "A String", # Specifies the Google domain (for example, google.com, google.de, or # google.fr) to which the search should be limited. "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). "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` "siteSearch": "A String", # Restricts results to URLs from a specified site. "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. "hq": "A String", # Appends the specified query terms to the query, as if they were combined # with a logical `AND` operator. "outputEncoding": "A String", # The character encoding supported for search results. "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 "searchTerms": "A String", # The search terms entered by the user. "exactTerms": "A String", # Identifies a phrase that all documents in the search results must # contain. "language": "A String", # The language of the search results. "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. "totalResults": "A String", # Estimated number of total search results. May not be accurate. "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. "count": 42, # Number of search results returned in this set. "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) "imgColorType": "A String", # Restricts results to images of a specified color type. Supported values # are: # # * `mono` (black and white) # # * `gray` (grayscale) # # * `color` (color) "rights": "A String", # Filters based on licensing. Supported values include: # # * `cc_publicdomain` # # * `cc_attribute` # # * `cc_sharealike` # # * `cc_noncommercial` # # * `cc_nonderived` "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. "excludeTerms": "A String", # Identifies a word or phrase that should not appear in any documents in # the search results. "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. "linkSite": "A String", # Specifies that all results should contain a link to a specific URL. "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 }, ], "nextPage": [ # Metadata representing the next page of results, if applicable. { # Custom search request metadata. "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. "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. "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. "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. "cx": "A String", # The identifier of a custom search engine created using the Custom Search # [Control Panel](https://cse.google.com/). This is a custom property not # defined in the OpenSearch spec. This parameter is **required**. "startPage": 42, # The page number of this set of results, where the page length is set by # the `count` property. "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 "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. "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) "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. "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. "searchType": "A String", # Allowed values are `web` or `image`. If unspecified, results are limited # to webpages. "title": "A String", # A description of the query. "googleHost": "A String", # Specifies the Google domain (for example, google.com, google.de, or # google.fr) to which the search should be limited. "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). "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` "siteSearch": "A String", # Restricts results to URLs from a specified site. "sort": "A String", # Specifies that results should be sorted according to the specified # expression. For example, sort by date. "hq": "A String", # Appends the specified query terms to the query, as if they were combined # with a logical `AND` operator. "outputEncoding": "A String", # The character encoding supported for search results. "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 "searchTerms": "A String", # The search terms entered by the user. "exactTerms": "A String", # Identifies a phrase that all documents in the search results must # contain. "language": "A String", # The language of the search results. "inputEncoding": "A String", # The character encoding supported for search requests. "totalResults": "A String", # Estimated number of total search results. May not be accurate. "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. "count": 42, # Number of search results returned in this set. "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) "imgColorType": "A String", # Restricts results to images of a specified color type. Supported values # are: # # * `mono` (black and white) # # * `gray` (grayscale) # # * `color` (color) "rights": "A String", # Filters based on licensing. Supported values include: # # * `cc_publicdomain` # # * `cc_attribute` # # * `cc_sharealike` # # * `cc_noncommercial` # # * `cc_nonderived` "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. "excludeTerms": "A String", # Identifies a word or phrase that should not appear in any documents in # the search results. "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. "linkSite": "A String", # Specifies that all results should contain a link to a specific URL. "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 }, ], }, "spelling": { # Spell correction information for a query. "correctedQuery": "A String", # The corrected query. "htmlCorrectedQuery": "A String", # The corrected query, formatted in HTML. }, "searchInformation": { # Metadata about a search operation. "formattedSearchTime": "A String", # The time taken for the server to return search results, formatted # according to locale style. "formattedTotalResults": "A String", # The total number of search results, formatted according to locale style. "totalResults": "A String", # The total number of search results returned by the query. "searchTime": 3.14, # The time taken for the server to return search results. }, }