docs: update docs (#916)
* fix: re-run script
* test: fix noxfile
diff --git a/docs/dyn/customsearch_v1.cse.siterestrict.html b/docs/dyn/customsearch_v1.cse.siterestrict.html
index 87bd3fa..c8356bf 100644
--- a/docs/dyn/customsearch_v1.cse.siterestrict.html
+++ b/docs/dyn/customsearch_v1.cse.siterestrict.html
@@ -75,18 +75,54 @@
<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(siteSearch=None, lr=None, gl=None, rights=None, imgDominantColor=None, lowRange=None, searchType=None, imgType=None, c2coff=None, excludeTerms=None, cx=None, siteSearchFilter=None, imgColorType=None, highRange=None, linkSite=None, fileType=None, hq=None, orTerms=None, relatedSite=None, hl=None, num=None, dateRestrict=None, safe=None, imgSize=None, exactTerms=None, cr=None, filter=None, sort=None, q=None, start=None, googlehost=None, x__xgafv=None)</a></code></p>
+ <code><a href="#list">list(highRange=None, q=None, cr=None, siteSearch=None, dateRestrict=None, siteSearchFilter=None, lr=None, exactTerms=None, relatedSite=None, imgType=None, num=None, safe=None, imgColorType=None, imgSize=None, gl=None, imgDominantColor=None, linkSite=None, excludeTerms=None, googlehost=None, rights=None, cx=None, start=None, filter=None, orTerms=None, hq=None, searchType=None, hl=None, sort=None, fileType=None, lowRange=None, c2coff=None, x__xgafv=None)</a></code></p>
<p class="firstline">Returns metadata about the search performed, metadata about the custom</p>
<h3>Method Details</h3>
<div class="method">
- <code class="details" id="list">list(siteSearch=None, lr=None, gl=None, rights=None, imgDominantColor=None, lowRange=None, searchType=None, imgType=None, c2coff=None, excludeTerms=None, cx=None, siteSearchFilter=None, imgColorType=None, highRange=None, linkSite=None, fileType=None, hq=None, orTerms=None, relatedSite=None, hl=None, num=None, dateRestrict=None, safe=None, imgSize=None, exactTerms=None, cr=None, filter=None, sort=None, q=None, start=None, googlehost=None, x__xgafv=None)</code>
+ <code class="details" id="list">list(highRange=None, q=None, cr=None, siteSearch=None, dateRestrict=None, siteSearchFilter=None, lr=None, exactTerms=None, relatedSite=None, imgType=None, num=None, safe=None, imgColorType=None, imgSize=None, gl=None, imgDominantColor=None, linkSite=None, excludeTerms=None, googlehost=None, rights=None, cx=None, start=None, filter=None, orTerms=None, hq=None, searchType=None, hl=None, sort=None, fileType=None, lowRange=None, c2coff=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.
Args:
+ 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.
+ q: string, Query
+ 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.
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.
+ 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`).
@@ -161,6 +197,55 @@
* `"lang_zh-CN"`: Chinese (Simplified)
* `"lang_zh-TW"`: Chinese (Traditional)
+ exactTerms: string, Identifies a phrase that all documents in the search results must contain.
+ relatedSite: string, Specifies that all search results should be pages that are related to the
+specified URL.
+ imgType: string, Returns images of a type. Acceptable values are:
+
+* `"clipart"`
+
+* `"face"`
+
+* `"lineart"`
+
+* `"stock"`
+
+* `"photo"`
+
+* `"animated"`
+ num: integer, Number of search results to return.
+
+* Valid values are integers between 1 and 10, inclusive.
+ safe: string, Search safety level. Acceptable values are:
+
+* `"active"`: Enables SafeSearch filtering.
+
+* `"off"`: Disables SafeSearch filtering. (default)
+ imgColorType: string, Returns black and white, grayscale, transparent, or color images.
+Acceptable values are:
+
+* `"color"`
+
+* `"gray"`
+
+* `"mono"`: black and white
+
+* `"trans"`: transparent background
+ imgSize: string, Returns images of a specified size. Acceptable values are:
+
+* `"huge"`
+
+* `"icon"`
+
+* `"large"`
+
+* `"medium"`
+
+* `"small"`
+
+* `"xlarge"`
+
+* `"xxlarge"`
gl: string, Geolocation of end user.
* The `gl` parameter value is a two-letter country code. The `gl` parameter
@@ -173,10 +258,6 @@
This is particularly true for international customers and, even more
specifically, for customers in English- speaking countries other than the
United States.
- 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).
imgDominantColor: string, Returns images of a specific dominant color. Acceptable values are:
* `"black"`
@@ -202,133 +283,25 @@
* `"white"`
* `"yellow"`
- 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.
- searchType: string, Specifies the search type: `image`. If unspecified, results are limited to
-webpages.
-
-Acceptable values are:
-
-* `"image"`: custom image search.
- imgType: string, Returns images of a type. Acceptable values are:
-
-* `"clipart"`
-
-* `"face"`
-
-* `"lineart"`
-
-* `"stock"`
-
-* `"photo"`
-
-* `"animated"`
- 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)
- excludeTerms: string, Identifies a word or phrase that should not appear in any documents in the
-search results.
- cx: string, The custom 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
- imgColorType: string, Returns black and white, grayscale, transparent, or color images.
-Acceptable values are:
-
-* `"color"`
-
-* `"gray"`
-
-* `"mono"`: black and white
-
-* `"trans"`: 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.
linkSite: string, Specifies that all search results should contain a link to a particular
URL.
- 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.
- relatedSite: string, Specifies that all search results should be pages that are related to the
-specified URL.
- hl: string, Sets the user interface language.
+ excludeTerms: string, Identifies a word or phrase that should not appear in any documents in the
+search results.
+ googlehost: string, **Deprecated**. Use the `gl` parameter for a similar effect.
-* 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.
- num: integer, Number of search results to return.
-
-* Valid values are integers between 1 and 10, inclusive.
- 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)
- imgSize: string, Returns images of a specified size. Acceptable values are:
-
-* `"huge"`
-
-* `"icon"`
-
-* `"large"`
-
-* `"medium"`
-
-* `"small"`
-
-* `"xlarge"`
-
-* `"xxlarge"`
- exactTerms: string, Identifies a phrase that all documents in the search results must contain.
- 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.
+The local Google domain (for example, google.com, google.de, or
+google.fr) to use to perform the search.
+ 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).
+ cx: string, The custom search engine ID to use for this request.
+ 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.
filter: string, Controls turning on or off the duplicate content filter.
* See [Automatic
@@ -344,18 +317,45 @@
* `0`: Turns off duplicate content filter.
* `1`: Turns on duplicate content filter.
- sort: string, The sort expression to apply to the results.
- q: string, Query
- 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.
- googlehost: string, **Deprecated**. Use the `gl` parameter for a similar effect.
+ 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.
+ hq: string, Appends the specified query terms to the query, as if they were combined
+with a logical AND operator.
+ searchType: string, Specifies the search type: `image`. If unspecified, results are limited to
+webpages.
-The local Google domain (for example, google.com, google.de, or
-google.fr) to use to perform the search.
+Acceptable values are:
+
+* `"image"`: custom image search.
+ 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.
+ sort: string, The sort expression to apply to the results.
+ 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).
+ 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.
+ 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)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -366,232 +366,59 @@
{ # Response to a custom search request.
"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.
- "searchType": "A String", # Allowed values are `web` or `image`. If unspecified, results are limited
- # to webpages.
- "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.
- "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.
- "startPage": 42, # The page number of this set of results, where the page length is set by
- # the `count` property.
- "googleHost": "A String", # Specifies the Google domain (for example, google.com, google.de, or
- # google.fr) to which the search should be limited.
- "title": "A String", # A description of the query.
- "count": 42, # Number of search results returned in this set.
- "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.
- "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
- "linkSite": "A String", # Specifies that all results should contain a link to a specific URL.
- "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)
- "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.
- "totalResults": "A String", # Estimated number of total search results. May not be accurate.
- "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.
- "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.
- "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`
- "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.
- "searchTerms": "A String", # The search terms entered by the user.
- "imgColorType": "A String", # Restricts results to images of a specified color type. Supported values
- # are:
- #
- # * `mono` (black and white)
- #
- # * `gray` (grayscale)
- #
- # * `color` (color)
- "exactTerms": "A String", # Identifies a phrase that all documents in the search results must
- # contain.
- "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
- "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.
- "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
- "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.
- "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**.
- "sort": "A String", # Specifies that results should be sorted according to the specified
- # expression. For example, sort by date.
- "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.
- "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.
- },
- ],
"request": [ # Metadata representing the current request.
{ # Custom search request metadata.
- "searchTerms": "A String", # The search terms entered by the user.
+ "language": "A String", # The language of the search results.
+ "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)
+ "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.
+ "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`
+ "title": "A String", # A description of the query.
"disableCnTwTranslation": "A String", # Enables or disables the [Simplified and Traditional Chinese
# Search](https://developers.google.com/custom-search/docs/xml_results#chineseSearch)
# feature.
@@ -601,6 +428,99 @@
# * `0`: enabled (default)
#
# * `1`: disabled
+ "sort": "A String", # Specifies that results should be sorted according to the specified
+ # expression. For example, sort by date.
+ "startPage": 42, # The page number of this set of results, where the page length is set by
+ # the `count` property.
+ "inputEncoding": "A String", # The character encoding supported for search requests.
+ "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**.
+ "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.
+ "excludeTerms": "A String", # Identifies a word or phrase that should not appear in any documents in
+ # the search results.
+ "outputEncoding": "A String", # The character encoding supported for search results.
+ "searchTerms": "A String", # The search terms entered by the user.
+ "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.
+ "siteSearch": "A String", # Restricts results to URLs from a specified site.
+ "hq": "A String", # Appends the specified query terms to the query, as if they were combined
+ # with a logical `AND` operator.
+ "count": 42, # Number of search results returned in this set.
+ "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.
+ "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.
+ "rights": "A String", # Filters based on licensing. Supported values include:
+ #
+ # * `cc_publicdomain`
+ #
+ # * `cc_attribute`
+ #
+ # * `cc_sharealike`
+ #
+ # * `cc_noncommercial`
+ #
+ # * `cc_nonderived`
+ "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.
+ "imgColorType": "A String", # Restricts results to images of a specified color type. Supported values
+ # are:
+ #
+ # * `mono` (black and white)
+ #
+ # * `gray` (grayscale)
+ #
+ # * `color` (color)
+ "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
+ "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.
"fileType": "A String", # Restricts results to files of a specified extension. Filetypes supported
# by Google include:
#
@@ -633,24 +553,44 @@
# 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.
+ "searchType": "A String", # Allowed values are `web` or `image`. If unspecified, results are limited
+ # to webpages.
+ "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)
+ "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
- "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)
+ "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.
+ "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.
+ "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.
+ },
+ ],
+ "nextPage": [ # Metadata representing the next page of results, if applicable.
+ { # Custom search request metadata.
"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)
@@ -660,10 +600,6 @@
# 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.
- "exactTerms": "A String", # Identifies a phrase that all documents in the search results must
- # contain.
- "startPage": 42, # The page number of this set of results, where the page length is set by
- # the `count` property.
"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
@@ -672,35 +608,7 @@
# * `"off"`: Disable SafeSearch
#
# * `"active"`: Enable SafeSearch
- "siteSearch": "A String", # Restricts results to URLs from a specified site.
- "searchType": "A String", # Allowed values are `web` or `image`. If unspecified, results are limited
- # to webpages.
- "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**.
- "rights": "A String", # Filters based on licensing. Supported values include:
- #
- # * `cc_publicdomain`
- #
- # * `cc_attribute`
- #
- # * `cc_sharealike`
- #
- # * `cc_noncommercial`
- #
- # * `cc_nonderived`
- "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.
- "excludeTerms": "A String", # Identifies a word or phrase that should not appear in any documents in
- # the search results.
+ "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.
@@ -712,25 +620,8 @@
# for more information, and [Supported Interface
# Languages](https://developers.google.com/custom-search/docs/xml_results_appendices#interfaceLanguages)
# for a list of supported languages.
- "title": "A String", # A description of the query.
- "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.
- "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.
- "googleHost": "A String", # Specifies the Google domain (for example, google.com, google.de, or
- # google.fr) to which the search should be limited.
- "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)
@@ -743,26 +634,43 @@
#
# **Note**: By default, Google applies filtering to all search results to
# improve the quality of those results.
- "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.
+ "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.
+ "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.
"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.
- "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.
+ "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.
+ "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.
+ "searchTerms": "A String", # The search terms entered by the user.
+ "outputEncoding": "A String", # The character encoding supported for search results.
+ "imgType": "A String", # Restricts results to images of a specified type. Supported values are:
#
- # Google WebSearch determines the country of a document by analyzing the
- # following:
+ # * `clipart` (Clip art)
#
- # * The top-level domain (TLD) of the document's URL.
+ # * `face` (Face)
#
- # * The geographic location of the web server's IP address.
+ # * `lineart` (Line drawing)
#
- # See [Country (cr) Parameter
- # Values](https://developers.google.com/custom-search/docs/xml_results#countryCollections)
- # for a list of valid values for this parameter.
+ # * `photo` (Photo)
+ #
+ # * `animated` (Animated)
+ #
+ # * `stock` (Stock)
"imgDominantColor": "A String", # Restricts results to images with a specific dominant color. Supported
# values are:
#
@@ -789,136 +697,157 @@
# * `black`
#
# * `brown`
- "count": 42, # Number of search results returned in this set.
- "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.
- "imgType": "A String", # Restricts results to images of a specified type. Supported values are:
+ "count": 42, # Number of search results returned in this set.
+ "startPage": 42, # The page number of this set of results, where the page length is set by
+ # the `count` property.
+ "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**.
+ "exactTerms": "A String", # Identifies a phrase that all documents in the search results must
+ # contain.
+ "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:
#
- # * `clipart` (Clip art)
+ # * `mono` (black and white)
#
- # * `face` (Face)
+ # * `gray` (grayscale)
#
- # * `lineart` (Line drawing)
+ # * `color` (color)
+ "siteSearchFilter": "A String", # Specifies whether to include or exclude results from the site named in
+ # the `sitesearch` parameter. Supported values are:
#
- # * `photo` (Photo)
+ # * `i`: include content from site
#
- # * `animated` (Animated)
+ # * `e`: exclude content from site
+ "inputEncoding": "A String", # The character encoding supported for search requests.
+ "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.
#
- # * `stock` (Stock)
- "outputEncoding": "A String", # The character encoding supported for search results.
- "language": "A String", # The language of the search results.
+ # 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.
+ "rights": "A String", # Filters based on licensing. Supported values include:
+ #
+ # * `cc_publicdomain`
+ #
+ # * `cc_attribute`
+ #
+ # * `cc_sharealike`
+ #
+ # * `cc_noncommercial`
+ #
+ # * `cc_nonderived`
+ "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.
+ "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.
+ "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.
+ "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).
"totalResults": "A String", # Estimated number of total search results. May not be accurate.
},
],
"previousPage": [ # Metadata representing the previous page of results, if applicable.
{ # Custom search request metadata.
- "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.
+ "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:
#
- # 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.
- "inputEncoding": "A String", # The character encoding supported for search requests.
- "disableCnTwTranslation": "A String", # Enables or disables the [Simplified and Traditional Chinese
- # Search](https://developers.google.com/custom-search/docs/xml_results#chineseSearch)
- # feature.
+ # * `"off"`: Disable SafeSearch
#
- # Supported values are:
+ # * `"active"`: Enable SafeSearch
+ "rights": "A String", # Filters based on licensing. Supported values include:
#
- # * `0`: enabled (default)
+ # * `cc_publicdomain`
#
- # * `1`: disabled
- "imgDominantColor": "A String", # Restricts results to images with a specific dominant color. Supported
- # values are:
+ # * `cc_attribute`
#
- # * `red`
+ # * `cc_sharealike`
#
- # * `orange`
+ # * `cc_noncommercial`
#
- # * `yellow`
- #
- # * `green`
- #
- # * `teal`
- #
- # * `blue`
- #
- # * `purple`
- #
- # * `pink`
- #
- # * `white`
- #
- # * `gray`
- #
- # * `black`
- #
- # * `brown`
- "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)
+ # * `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.
- "searchTerms": "A String", # The search terms entered by the user.
- "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.
- "linkSite": "A String", # Specifies that all results should contain a link to a specific URL.
- "startPage": 42, # The page number of this set of results, where the page length is set by
- # the `count` property.
- "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**.
+ "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.
"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.
- "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.
- "imgColorType": "A String", # Restricts results to images of a specified color type. Supported values
- # are:
- #
- # * `mono` (black and white)
- #
- # * `gray` (grayscale)
- #
- # * `color` (color)
- "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.
- "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.
- "language": "A String", # The language of the search results.
- "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.
- "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.
+ "searchType": "A String", # Allowed values are `web` or `image`. If unspecified, results are limited
+ # to webpages.
"fileType": "A String", # Restricts results to files of a specified extension. Filetypes supported
# by Google include:
#
@@ -951,73 +880,15 @@
# 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).
- "siteSearchFilter": "A String", # Specifies whether to include or exclude results from the site named in
- # the `sitesearch` parameter. Supported values are:
+ "imgSize": "A String", # Restricts results to images of a specified size. Supported values are:
#
- # * `i`: include content from site
+ # * `icon` (small)
#
- # * `e`: exclude content from site
- "rights": "A String", # Filters based on licensing. Supported values include:
+ # * `small | medium | large | xlarge` (medium)
#
- # * `cc_publicdomain`
+ # * `xxlarge` (large)
#
- # * `cc_attribute`
- #
- # * `cc_sharealike`
- #
- # * `cc_noncommercial`
- #
- # * `cc_nonderived`
- "exactTerms": "A String", # Identifies a phrase that all documents in the search results must
- # contain.
- "excludeTerms": "A String", # Identifies a word or phrase that should not appear in any documents in
- # the 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
- "sort": "A String", # Specifies that results should be sorted according to the specified
- # expression. For example, sort by date.
- "searchType": "A String", # Allowed values are `web` or `image`. If unspecified, results are limited
- # to webpages.
- "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.
- "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.
- "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)
- "siteSearch": "A String", # Restricts results to URLs from a specified site.
- "totalResults": "A String", # Estimated number of total search results. May not be accurate.
- "outputEncoding": "A String", # The character encoding supported for search results.
+ # * `huge` (extra-large)
"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)
@@ -1033,88 +904,143 @@
# See [Country (cr) Parameter
# Values](https://developers.google.com/custom-search/docs/xml_results#countryCollections)
# for a list of valid values for this parameter.
+ "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
+ "imgColorType": "A String", # Restricts results to images of a specified color type. Supported values
+ # are:
+ #
+ # * `mono` (black and white)
+ #
+ # * `gray` (grayscale)
+ #
+ # * `color` (color)
+ "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.
+ "count": 42, # Number of search results returned in this set.
+ "title": "A String", # A description of the query.
+ "searchTerms": "A String", # The search terms entered by the user.
+ "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.
+ "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.
+ "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.
+ "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.
+ "siteSearch": "A String", # Restricts results to URLs from a specified site.
+ "hq": "A String", # Appends the specified query terms to the query, as if they were combined
+ # with a logical `AND` operator.
+ "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
+ "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.
+ "totalResults": "A String", # Estimated number of total search results. May not be accurate.
+ "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.
+ "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`
+ "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.
+ "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**.
},
],
},
- "spelling": { # Spell correction information for a query.
- "htmlCorrectedQuery": "A String", # The corrected query, formatted in HTML.
- "correctedQuery": "A String", # The corrected 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.
- "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.
- },
- "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.
- "link": "A String", # The anchor text of the block object's link, if it has a link.
- "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.
- },
- ],
- "displayLink": "A String", # An abridged version of this search's result URL, e.g. www.example.com.
- "title": "A String", # The title of the promotion.
- "link": "A String", # The URL of the promotion.
- "htmlTitle": "A String", # The title of the promotion, in HTML.
- },
- ],
- "items": [ # The current set of custom search results.
- { # A custom search result.
- "displayLink": "A String", # An abridged version of this search result’s URL, e.g. www.example.com.
- "kind": "A String", # A unique identifier for the type of current object. For this API, it is
- # `customsearch#result.`
- "link": "A String", # The full URL to which the search result is pointing, e.g.
- # http://www.example.com/foo/bar.
- "fileFormat": "A String", # The file format of the search result.
- "htmlFormattedUrl": "A String", # The HTML-formatted URL displayed after the snippet for each search result.
- "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.
- "htmlTitle": "A String", # The title of the search result, in HTML.
- "image": { # Image belonging to a custom search result.
- "byteSize": 42, # The size of the image, in pixels.
- "width": 42, # The width of the image, in pixels.
- "thumbnailWidth": 42, # The width of the thumbnail image, in pixels.
- "contextLink": "A String", # A URL pointing to the webpage hosting the image.
- "height": 42, # The height of the image, in pixels.
- "thumbnailLink": "A String", # A URL to the thumbnail image.
- "thumbnailHeight": 42, # The height of the thumbnail image, in pixels.
- },
- "pagemap": { # Contains
- # [PageMap](https://developers.google.com/custom-search/docs/structured_data#pagemaps)
- # information for this search result.
- "a_key": "", # Properties of the object.
- },
- "title": "A String", # The title 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.
- "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.
- "label_with_op": "A String", # Refinement label and the associated refinement operation.
- },
- ],
- "snippet": "A String", # The snippet of the search result, in plain text.
- "mime": "A String", # The MIME type of the search result.
- },
- ],
- "searchInformation": { # Metadata about a search operation.
- "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.
- "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.
+ "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:
@@ -1126,14 +1052,88 @@
# (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 API.
- "template": "A String", # The actual [OpenSearch
- # template](http://www.opensearch.org/specifications/opensearch/1.1#opensearch_url_template_syntax)
- # for this API.
- },
"kind": "A String", # Unique identifier for the type of current object. For this API, it is
# customsearch#search.
+ "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.
+ "htmlTitle": "A String", # The title of the promotion, in HTML.
+ "link": "A String", # The URL of the promotion.
+ "displayLink": "A String", # An abridged version of this search's result URL, e.g. www.example.com.
+ "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.
+ "htmlTitle": "A String", # The block object's text in HTML, 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.
+ },
+ ],
+ "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.
+ },
+ },
+ ],
+ "searchInformation": { # Metadata about a search operation.
+ "totalResults": "A String", # The total number of search results returned by the query.
+ "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.
+ },
+ "items": [ # The current set of custom search results.
+ { # A custom search result.
+ "fileFormat": "A String", # The file format of the search result.
+ "image": { # Image belonging to a custom search result.
+ "thumbnailWidth": 42, # The width of the thumbnail 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.
+ "height": 42, # The height of the image, in pixels.
+ "thumbnailLink": "A String", # A URL to the thumbnail image.
+ },
+ "formattedUrl": "A String", # The URL displayed after the snippet for each search result.
+ "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.
+ "cacheId": "A String", # Indicates the ID of Google's cached version of the search result.
+ "htmlTitle": "A String", # The title of the search result, in HTML.
+ "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.
+ "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.
+ "label_with_op": "A String", # Refinement label and the associated refinement operation.
+ },
+ ],
+ "title": "A String", # The title of the search result, in plain text.
+ "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.
+ "htmlFormattedUrl": "A String", # The HTML-formatted URL displayed after the snippet for each search result.
+ "kind": "A String", # A unique identifier for the type of current object. For this API, it is
+ # `customsearch#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.
+ },
+ },
+ ],
+ "spelling": { # Spell correction information for a query.
+ "correctedQuery": "A String", # The corrected query.
+ "htmlCorrectedQuery": "A String", # The corrected query, formatted in HTML.
+ },
}</pre>
</div>