docs: update generated docs (#1053)
Updates for both discovery docs and epydoc API Documentation
Fixes: #1049
diff --git a/docs/dyn/customsearch_v1.cse.siterestrict.html b/docs/dyn/customsearch_v1.cse.siterestrict.html
index 2d3a042..a02dde5 100644
--- a/docs/dyn/customsearch_v1.cse.siterestrict.html
+++ b/docs/dyn/customsearch_v1.cse.siterestrict.html
@@ -75,291 +75,103 @@
<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>
<h2>Instance Methods</h2>
<p class="toc_element">
- <code><a href="#list">list(cr=None, googlehost=None, c2coff=None, cx=None, sort=None, searchType=None, filter=None, siteSearchFilter=None, lr=None, imgSize=None, linkSite=None, imgDominantColor=None, siteSearch=None, q=None, rights=None, gl=None, highRange=None, imgType=None, relatedSite=None, num=None, hl=None, excludeTerms=None, safe=None, exactTerms=None, lowRange=None, fileType=None, hq=None, orTerms=None, start=None, imgColorType=None, dateRestrict=None, x__xgafv=None)</a></code></p>
-<p class="firstline">Returns metadata about the search performed, metadata about the custom</p>
+ <code><a href="#close">close()</a></code></p>
+<p class="firstline">Close httplib2 connections.</p>
+<p class="toc_element">
+ <code><a href="#list">list(rights=None, imgSize=None, c2coff=None, imgColorType=None, highRange=None, imgType=None, dateRestrict=None, lr=None, fileType=None, start=None, safe=None, relatedSite=None, orTerms=None, cx=None, siteSearchFilter=None, siteSearch=None, linkSite=None, gl=None, num=None, q=None, hl=None, hq=None, googlehost=None, imgDominantColor=None, exactTerms=None, sort=None, searchType=None, cr=None, filter=None, lowRange=None, excludeTerms=None, x__xgafv=None)</a></code></p>
+<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>
<h3>Method Details</h3>
<div class="method">
- <code class="details" id="list">list(cr=None, googlehost=None, c2coff=None, cx=None, sort=None, searchType=None, filter=None, siteSearchFilter=None, lr=None, imgSize=None, linkSite=None, imgDominantColor=None, siteSearch=None, q=None, rights=None, gl=None, highRange=None, imgType=None, relatedSite=None, num=None, hl=None, excludeTerms=None, safe=None, exactTerms=None, lowRange=None, fileType=None, hq=None, orTerms=None, start=None, imgColorType=None, dateRestrict=None, x__xgafv=None)</code>
- <pre>Returns metadata about the search performed, metadata about the custom
-search engine used for the search, and the search results. Uses a small set
-of url patterns.
+ <code class="details" id="close">close()</code>
+ <pre>Close httplib2 connections.</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="list">list(rights=None, imgSize=None, c2coff=None, imgColorType=None, highRange=None, imgType=None, dateRestrict=None, lr=None, fileType=None, start=None, safe=None, relatedSite=None, orTerms=None, cx=None, siteSearchFilter=None, siteSearch=None, linkSite=None, gl=None, num=None, q=None, hl=None, hq=None, googlehost=None, imgDominantColor=None, exactTerms=None, sort=None, searchType=None, cr=None, filter=None, lowRange=None, excludeTerms=None, x__xgafv=None)</code>
+ <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.
Args:
- 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.
- 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.
- 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)
- cx: string, The custom search engine ID to use for this request.
- 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).
- searchType: string, Specifies the search type: `image`. If unspecified, results are limited to
-webpages.
-
-Acceptable values are:
-
-* `"image"`: custom image search.
- 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.
- siteSearchFilter: string, Controls whether to include or exclude results from the site named in the
-`siteSearch` parameter.
-
-Acceptable values are:
-
-* `"e"`: exclude
-
-* `"i"`: include
- 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)
- imgSize: string, Returns images of a specified size. Acceptable values are:
-
-* `"huge"`
-
-* `"icon"`
-
-* `"large"`
-
-* `"medium"`
-
-* `"small"`
-
-* `"xlarge"`
-
-* `"xxlarge"`
- linkSite: string, Specifies that all search results should contain a link to a particular
-URL.
- imgDominantColor: string, Returns images of a specific dominant color. Acceptable values are:
-
-* `"black"`
-
-* `"blue"`
-
-* `"brown"`
-
-* `"gray"`
-
-* `"green"`
-
-* `"orange"`
-
-* `"pink"`
-
-* `"purple"`
-
-* `"red"`
-
-* `"teal"`
-
-* `"white"`
-
-* `"yellow"`
- siteSearch: string, Specifies a given site which should always be included or excluded from
-results (see `siteSearchFilter` parameter, below).
+ 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).
+ imgSize: string, Returns images of a specified size. Acceptable values are: * `"huge"` * `"icon"` * `"large"` * `"medium"` * `"small"` * `"xlarge"` * `"xxlarge"`
+ Allowed values
+ imgSizeUndefined - No image size specified.
+ HUGE - Only the largest possible images.
+ ICON - Only very small icon-sized images.
+ LARGE - Only large images.
+ MEDIUM - Only medium images.
+ SMALL - Only small images.
+ XLARGE - Only very large images.
+ XXLARGE - Only extremely large images.
+ 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)
+ imgColorType: string, Returns black and white, grayscale, transparent, or color images. Acceptable values are: * `"color"` * `"gray"` * `"mono"`: black and white * `"trans"`: transparent background
+ Allowed values
+ imgColorTypeUndefined - No image color type specified.
+ mono - Black and white images only.
+ gray - Grayscale images only.
+ color - Color images only.
+ trans - Images with transparent background
+ 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.
+ imgType: string, Returns images of a type. Acceptable values are: * `"clipart"` * `"face"` * `"lineart"` * `"stock"` * `"photo"` * `"animated"`
+ Allowed values
+ imgTypeUndefined - No image type specified.
+ clipart - Clipart-style images only.
+ face - Images of faces only.
+ lineart - Line art images only.
+ stock - Stock images only.
+ photo - Photo images only.
+ animated - Animated images only.
+ 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.
+ 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)
+ 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).
+ 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.
+ safe: string, Search safety level. Acceptable values are: * `"active"`: Enables SafeSearch filtering. * `"off"`: Disables SafeSearch filtering. (default)
+ Allowed values
+ safeUndefined - SafeSearch mode unspecified. (Falls back to engine's configuration.)
+ active - Turn SafeSearch on.
+ high - Deprecated, equivalent to "active".
+ medium - Deprecated, equivalent to "active".
+ off - Turn SafeSearch off.
+ relatedSite: string, Specifies that all search results should be pages that are related to the specified URL.
+ 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.
+ cx: string, The Programmable Search Engine ID to use for this request.
+ siteSearchFilter: string, Controls whether to include or exclude results from the site named in the `siteSearch` parameter. Acceptable values are: * `"e"`: exclude * `"i"`: include
+ Allowed values
+ siteSearchFilterUndefined - Filter mode unspecified.
+ e - Exclude results from the listed sites.
+ i - Include only results from the listed sites.
+ siteSearch: string, Specifies a given site which should always be included or excluded from results (see `siteSearchFilter` parameter, below).
+ linkSite: string, Specifies that all search results should contain a link to a particular URL.
+ 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.
+ num: integer, Number of search results to return. * Valid values are integers between 1 and 10, inclusive.
q: string, Query
- 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).
- 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.
- 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.
- 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.
- num: integer, Number of search results to return.
-
-* Valid values are integers between 1 and 10, inclusive.
- 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.
- excludeTerms: string, Identifies a word or phrase that should not appear in any documents in the
-search results.
- safe: string, Search safety level. Acceptable values are:
-
-* `"active"`: Enables SafeSearch filtering.
-
-* `"off"`: Disables SafeSearch filtering. (default)
+ 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.
+ hq: string, Appends the specified query terms to the query, as if they were combined with a logical AND operator.
+ 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.
+ imgDominantColor: string, Returns images of a specific dominant color. Acceptable values are: * `"black"` * `"blue"` * `"brown"` * `"gray"` * `"green"` * `"orange"` * `"pink"` * `"purple"` * `"red"` * `"teal"` * `"white"` * `"yellow"`
+ Allowed values
+ imgDominantColorUndefined - No dominant color specified.
+ black - Predominantly black images only.
+ blue - Predominantly blue images only.
+ brown - Predominantly brown images only.
+ gray - Predominantly gray images only.
+ green - Predominantly green images only.
+ orange - Predominantly orange images only.
+ pink - Predominantly pink images only.
+ purple - Predominantly purple images only.
+ red - Predominantly red images only.
+ teal - Predominantly teal images only.
+ white - Predominantly white images only.
+ yellow - Predominantly yellow images only.
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.
- 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).
- hq: string, Appends the specified query terms to the query, as if they were combined
-with a logical AND operator.
- 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.
- 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.
- imgColorType: string, Returns black and white, grayscale, transparent, or color images.
-Acceptable values are:
-
-* `"color"`
-
-* `"gray"`
-
-* `"mono"`: black and white
-
-* `"trans"`: transparent background
- 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.
+ 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).
+ searchType: string, Specifies the search type: `image`. If unspecified, results are limited to webpages. Acceptable values are: * `"image"`: custom image search.
+ Allowed values
+ searchTypeUndefined - Search type unspecified (defaults to web search).
+ image - Image search.
+ 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.
+ 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.
+ 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.
+ excludeTerms: string, Identifies a word or phrase that should not appear in any documents in the search results.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -369,775 +181,202 @@
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.
+ "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.
- "height": 42, # Image height in pixels.
- "source": "A String", # URL of the image for this promotion link.
- "width": 42, # Image width in pixels.
- },
+ "title": "A String", # The title of the promotion.
"htmlTitle": "A String", # The title of the promotion, in HTML.
"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.
+ "image": { # Image belonging to a promotion.
+ "source": "A String", # URL of the image for this promotion link.
+ "width": 42, # Image width in pixels.
+ "height": 42, # Image height in pixels.
+ },
+ "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.
- "title": "A String", # The block object's text, if it has text.
- "link": "A String", # The anchor text of the block object's link, if it has a link.
- "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.
+ "title": "A String", # The block object's text, if it has text.
+ "url": "A String", # The URL of the block object's link, if it has one.
+ "link": "A String", # The anchor text of the block object's link, if it has a link.
},
],
},
],
- "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.
- },
- "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.
- "nextPage": [ # Metadata representing the next page of results, if applicable.
- { # Custom search request metadata.
- "imgColorType": "A String", # Restricts results to images of a specified color type. Supported values
- # are:
- #
- # * `mono` (black and white)
- #
- # * `gray` (grayscale)
- #
- # * `color` (color)
- "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.
- "language": "A String", # The language of the search results.
- "exactTerms": "A String", # Identifies a phrase that all documents in the search results must
- # contain.
- "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.
- "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
- "title": "A String", # A description of the query.
- "searchTerms": "A String", # The search terms entered by the user.
- "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.
- "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)
- "linkSite": "A String", # Specifies that all results should contain a link to a specific URL.
- "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.
- "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.
- "searchType": "A String", # Allowed values are `web` or `image`. If unspecified, results are limited
- # to webpages.
- "sort": "A String", # Specifies that results should be sorted according to the specified
- # expression. For example, sort by date.
- "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.
- "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`
- "hq": "A String", # Appends the specified query terms to the query, as if they were combined
- # with a logical `AND` operator.
- "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.
- "inputEncoding": "A String", # The character encoding supported for search requests.
- "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
- "startPage": 42, # The page number of this set of results, where the page length is set by
- # the `count` property.
- "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.
- "googleHost": "A String", # Specifies the Google domain (for example, google.com, google.de, or
- # google.fr) to which the search should be limited.
- "count": 42, # Number of search results returned in this set.
- "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
- "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)
- "rights": "A String", # Filters based on licensing. Supported values include:
- #
- # * `cc_publicdomain`
- #
- # * `cc_attribute`
- #
- # * `cc_sharealike`
- #
- # * `cc_noncommercial`
- #
- # * `cc_nonderived`
- "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.
- "totalResults": "A String", # Estimated number of total search results. May not be accurate.
- "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).
- "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**.
- "siteSearch": "A String", # Restricts results to URLs from a specified site.
- "outputEncoding": "A String", # The character encoding supported for search results.
- "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.
- },
- ],
- "previousPage": [ # Metadata representing the previous page of results, if applicable.
- { # Custom search request metadata.
- "excludeTerms": "A String", # Identifies a word or phrase that should not appear in any documents in
- # the search results.
- "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).
- "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
- "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
- "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`
- "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.
- "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`
- "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.
- "searchType": "A String", # Allowed values are `web` or `image`. If unspecified, results are limited
- # to webpages.
- "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.
- "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
- "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.
- "exactTerms": "A String", # Identifies a phrase that all documents in the search results must
- # contain.
- "count": 42, # Number of search results returned in this set.
- "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.
- "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.
- "googleHost": "A String", # Specifies the Google domain (for example, google.com, google.de, or
- # google.fr) to which the search should be limited.
- "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**.
- "hq": "A String", # Appends the specified query terms to the query, as if they were combined
- # with a logical `AND` operator.
- "title": "A String", # A description of the query.
- "outputEncoding": "A String", # The character encoding supported for 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.
- "totalResults": "A String", # Estimated number of total search results. May not be accurate.
- "searchTerms": "A String", # The search terms entered by the user.
- "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)
- "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.
- "startPage": 42, # The page number of this set of results, where the page length is set by
- # the `count` property.
- "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.
- "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.
- },
- ],
- "request": [ # Metadata representing the current request.
- { # Custom search request metadata.
- "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**.
- "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
- "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.
- "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.
- "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.
- "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
- "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).
- "inputEncoding": "A String", # The character encoding supported for search requests.
- "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
- "siteSearch": "A String", # Restricts results to URLs from a specified site.
- "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.
- "imgColorType": "A String", # Restricts results to images of a specified color type. Supported values
- # are:
- #
- # * `mono` (black and white)
- #
- # * `gray` (grayscale)
- #
- # * `color` (color)
- "count": 42, # Number of search results returned in this set.
- "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)
- "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.
- "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.
- "searchTerms": "A String", # The search terms entered by the user.
- "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.
- "title": "A String", # A description of the query.
- "totalResults": "A String", # Estimated number of total search results. May not be accurate.
- "linkSite": "A String", # Specifies that all results should contain a link to a specific URL.
- "sort": "A String", # Specifies that results should be sorted according to the specified
- # expression. For example, sort by date.
- "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.
- "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)
- "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`
- "startPage": 42, # The page number of this set of results, where the page length is set by
- # the `count` property.
- "searchType": "A String", # Allowed values are `web` or `image`. If unspecified, results are limited
- # to webpages.
- "hq": "A String", # Appends the specified query terms to the query, as if they were combined
- # with a logical `AND` operator.
- "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.
- "outputEncoding": "A String", # The character encoding supported for search results.
- "language": "A String", # The language of the search results.
- "exactTerms": "A String", # Identifies a phrase that all documents in the search results must
- # contain.
- "rights": "A String", # Filters based on licensing. Supported values include:
- #
- # * `cc_publicdomain`
- #
- # * `cc_attribute`
- #
- # * `cc_sharealike`
- #
- # * `cc_noncommercial`
- #
- # * `cc_nonderived`
- "googleHost": "A String", # Specifies the Google domain (for example, google.com, google.de, or
- # google.fr) to which the search should be limited.
- "excludeTerms": "A String", # Identifies a word or phrase that should not appear in any documents in
- # the search results.
- "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.
- },
- ],
- },
- "searchInformation": { # Metadata about a search operation.
- "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.
- "formattedSearchTime": "A String", # The time taken for the server to return search results, formatted
- # according to locale style.
- },
"spelling": { # Spell correction information for a query.
"htmlCorrectedQuery": "A String", # The corrected query, formatted in HTML.
"correctedQuery": "A String", # The corrected query.
},
+ "searchInformation": { # Metadata about a search operation.
+ "formattedTotalResults": "A String", # The total number of search results, formatted according to locale style.
+ "formattedSearchTime": "A String", # The time taken for the server to return search results, formatted according to locale style.
+ "searchTime": 3.14, # The time taken for the server to return search results.
+ "totalResults": "A String", # The total number of search results returned by the query.
+ },
+ "queries": { # Query metadata for the previous, current, and next pages of results.
+ "previousPage": [ # Metadata representing the previous page of results, if applicable.
+ { # Custom search request metadata.
+ "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`
+ "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.
+ "language": "A String", # The language of the search results.
+ "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**.
+ "hq": "A String", # Appends the specified query terms to the query, as if they were combined with a logical `AND` operator.
+ "searchTerms": "A String", # The search terms entered by the user.
+ "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
+ "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.
+ "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.
+ "searchType": "A String", # Allowed values are `web` or `image`. If unspecified, results are limited to webpages.
+ "rights": "A String", # Filters based on licensing. Supported values include: * `cc_publicdomain` * `cc_attribute` * `cc_sharealike` * `cc_noncommercial` * `cc_nonderived`
+ "startPage": 42, # The page number of this set of results, where the page length is set by the `count` property.
+ "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)
+ "inputEncoding": "A String", # The character encoding supported for search requests.
+ "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).
+ "outputEncoding": "A String", # The character encoding supported for search results.
+ "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.
+ "exactTerms": "A String", # Identifies a phrase that all documents in the search results must contain.
+ "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.
+ "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.
+ "excludeTerms": "A String", # Identifies a word or phrase that should not appear in any documents in the search results.
+ "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.
+ "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.
+ "count": 42, # Number of search results returned in this set.
+ "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
+ "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
+ "sort": "A String", # Specifies that results should be sorted according to the specified expression. For example, sort by date.
+ "totalResults": "A String", # Estimated number of total search results. May not be accurate.
+ "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.
+ "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)
+ "siteSearch": "A String", # Restricts results to URLs from a specified site.
+ "imgColorType": "A String", # Restricts results to images of a specified color type. Supported values are: * `mono` (black and white) * `gray` (grayscale) * `color` (color)
+ "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.
+ },
+ ],
+ "request": [ # Metadata representing the current request.
+ { # Custom search request metadata.
+ "searchTerms": "A String", # The search terms entered by the user.
+ "inputEncoding": "A String", # The character encoding supported for search requests.
+ "excludeTerms": "A String", # Identifies a word or phrase that should not appear in any documents in the search results.
+ "totalResults": "A String", # Estimated number of total search results. May not be accurate.
+ "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.
+ "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
+ "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)
+ "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.
+ "count": 42, # Number of search results returned in this set.
+ "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**.
+ "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`
+ "googleHost": "A String", # Specifies the Google domain (for example, google.com, google.de, or google.fr) to which the search should be limited.
+ "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.
+ "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.
+ "rights": "A String", # Filters based on licensing. Supported values include: * `cc_publicdomain` * `cc_attribute` * `cc_sharealike` * `cc_noncommercial` * `cc_nonderived`
+ "siteSearch": "A String", # Restricts results to URLs from a specified site.
+ "exactTerms": "A String", # Identifies a phrase that all documents in the search results must contain.
+ "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.
+ "title": "A String", # A description of the query.
+ "imgColorType": "A String", # Restricts results to images of a specified color type. Supported values are: * `mono` (black and white) * `gray` (grayscale) * `color` (color)
+ "outputEncoding": "A String", # The character encoding supported for search results.
+ "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
+ "searchType": "A String", # Allowed values are `web` or `image`. If unspecified, results are limited to webpages.
+ "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.
+ "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).
+ "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.
+ "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.
+ "hq": "A String", # Appends the specified query terms to the query, as if they were combined with a logical `AND` operator.
+ "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)
+ "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.
+ "startPage": 42, # The page number of this set of results, where the page length is set by the `count` property.
+ "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.
+ "language": "A String", # The language of the search results.
+ "sort": "A String", # Specifies that results should be sorted according to the specified expression. For example, sort by date.
+ "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.
+ "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)
+ "startPage": 42, # The page number of this set of results, where the page length is set by the `count` property.
+ "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.
+ "hq": "A String", # Appends the specified query terms to the query, as if they were combined with a logical `AND` operator.
+ "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.
+ "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
+ "outputEncoding": "A String", # The character encoding supported for search results.
+ "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.
+ "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**.
+ "excludeTerms": "A String", # Identifies a word or phrase that should not appear in any documents in the search results.
+ "searchTerms": "A String", # The search terms entered by the user.
+ "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`
+ "totalResults": "A String", # Estimated number of total search results. May not be accurate.
+ "searchType": "A String", # Allowed values are `web` or `image`. If unspecified, results are limited to webpages.
+ "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)
+ "exactTerms": "A String", # Identifies a phrase that all documents in the search results must contain.
+ "language": "A String", # The language of the search results.
+ "siteSearch": "A String", # Restricts results to URLs from a specified site.
+ "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.
+ "title": "A String", # A description of the query.
+ "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).
+ "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.
+ "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.
+ "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
+ "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
+ "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.
+ "googleHost": "A String", # Specifies the Google domain (for example, google.com, google.de, or google.fr) to which the search should be limited.
+ "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.
+ "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.
+ "sort": "A String", # Specifies that results should be sorted according to the specified expression. For example, sort by date.
+ "rights": "A String", # Filters based on licensing. Supported values include: * `cc_publicdomain` * `cc_attribute` * `cc_sharealike` * `cc_noncommercial` * `cc_nonderived`
+ "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.
+ "linkSite": "A String", # Specifies that all results should contain a link to a specific URL.
+ "imgColorType": "A String", # Restricts results to images of a specified color type. Supported values are: * `mono` (black and white) * `gray` (grayscale) * `color` (color)
+ },
+ ],
+ },
+ "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.
+ },
+ "url": { # OpenSearch template and URL.
+ "type": "A String", # The MIME type of the OpenSearch URL template for the Custom Search JSON 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).
+ "displayLink": "A String", # An abridged version of this search result’s URL, e.g. www.example.com.
+ "htmlSnippet": "A String", # The snippet of the search result, in HTML.
+ "kind": "A String", # A unique identifier for the type of current object. For this API, it is `customsearch#result.`
+ "cacheId": "A String", # Indicates the ID of Google's cached version of the search result.
+ "fileFormat": "A String", # The file format of the search result.
+ "formattedUrl": "A String", # The URL displayed after the snippet for each search result.
+ "snippet": "A String", # The snippet of the search result, in plain text.
+ "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.
- "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.
- "displayName": "A String", # The display name of a refinement label. This is the name you should
- # display in your user interface.
+ "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.
},
],
- "mime": "A String", # The MIME type of the search result.
- "displayLink": "A String", # An abridged version of this search result’s URL, e.g. www.example.com.
- "snippet": "A String", # The snippet of the search result, in plain text.
+ "htmlFormattedUrl": "A String", # The HTML-formatted URL displayed after the snippet for each search result.
"image": { # Image belonging to a custom search result.
- "thumbnailHeight": 42, # The height of the thumbnail image, in pixels.
- "thumbnailWidth": 42, # The width of the thumbnail image, in pixels.
"byteSize": 42, # The size of the image, in pixels.
- "height": 42, # The height of the image, in pixels.
- "thumbnailLink": "A String", # A URL to the thumbnail image.
- "width": 42, # The width of the image, in pixels.
"contextLink": "A String", # A URL pointing to the webpage hosting the image.
+ "thumbnailLink": "A String", # A URL to the thumbnail image.
+ "thumbnailWidth": 42, # The width of the thumbnail image, in pixels.
+ "height": 42, # The height of the image, in pixels.
+ "width": 42, # The width of the image, in pixels.
+ "thumbnailHeight": 42, # The height of the thumbnail image, in pixels.
},
- "fileFormat": "A String", # The file format of the search result.
"title": "A String", # The title of the search result, in plain text.
- "pagemap": { # Contains
- # [PageMap](https://developers.google.com/custom-search/docs/structured_data#pagemaps)
- # information for this search result.
+ "htmlTitle": "A String", # The title of the search result, in HTML.
+ "pagemap": { # Contains [PageMap](https://developers.google.com/custom-search/docs/structured_data#pagemaps) information for this search result.
"a_key": "", # Properties of the object.
},
- "htmlFormattedUrl": "A String", # The HTML-formatted URL displayed after the snippet for each search result.
- "htmlTitle": "A String", # The title 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.
- "htmlSnippet": "A String", # The snippet of the search result, in HTML.
- "formattedUrl": "A String", # The URL displayed after the snippet for each search result.
- "cacheId": "A String", # Indicates the ID of Google's cached version of the search result.
+ "link": "A String", # The full URL to which the search result is pointing, e.g. http://www.example.com/foo/bar.
+ "mime": "A String", # The MIME type of the search result.
},
],
+ "kind": "A String", # Unique identifier for the type of current object. For this API, it is customsearch#search.
}</pre>
</div>