diff --git a/discovery/customsearch-v1.json b/discovery/customsearch-v1.json index 9e9b669d1a..d921d684cc 100644 --- a/discovery/customsearch-v1.json +++ b/discovery/customsearch-v1.json @@ -97,19 +97,19 @@ "cse": { "methods": { "list": { - "description": "Returns metadata about the search performed, metadata about the\nengine used for the search, and the search results.", + "description": "Returns metadata about the search performed, metadata about the engine used for the search, and the search results.", "flatPath": "customsearch/v1", "httpMethod": "GET", "id": "search.cse.list", "parameterOrder": [], "parameters": { "c2coff": { - "description": "Enables or disables [Simplified and Traditional Chinese\nSearch](https://developers.google.com/custom-search/docs/xml_results#chineseSearch).\n\nThe default value for this parameter is 0 (zero), meaning that the feature\nis enabled. Supported values are:\n\n* `1`: Disabled\n\n* `0`: Enabled (default)", + "description": "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)", "location": "query", "type": "string" }, "cr": { - "description": "Restricts search results to documents originating in a particular country.\nYou may use [Boolean\noperators](https://developers.google.com/custom-search/docs/xml_results_appendices#booleanOperators)\nin the cr parameter's value.\n\nGoogle Search determines the country of a document by analyzing:\n\n* the top-level domain (TLD) of the document's URL\n\n* the geographic location of the Web server's IP address\n\nSee the [Country Parameter\nValues](https://developers.google.com/custom-search/docs/xml_results_appendices#countryCollections)\npage for a list of valid values for this parameter.", + "description": "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.", "location": "query", "type": "string" }, @@ -119,7 +119,7 @@ "type": "string" }, "dateRestrict": { - "description": "Restricts results to URLs based on date. Supported values include:\n\n* `d[number]`: requests results from the specified number of past days.\n\n* `w[number]`: requests results from the specified number of past weeks.\n\n* `m[number]`: requests results from the specified number of past months.\n\n* `y[number]`: requests results from the specified number of past years.", + "description": "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.", "location": "query", "type": "string" }, @@ -129,47 +129,47 @@ "type": "string" }, "excludeTerms": { - "description": "Identifies a word or phrase that should not appear in any documents in the\nsearch results.", + "description": "Identifies a word or phrase that should not appear in any documents in the search results.", "location": "query", "type": "string" }, "fileType": { - "description": "Restricts results to files of a specified extension. A list of file types\nindexable by Google can be found in Search Console [Help\nCenter](https://support.google.com/webmasters/answer/35287).", + "description": "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).", "location": "query", "type": "string" }, "filter": { - "description": "Controls turning on or off the duplicate content filter.\n\n* See [Automatic\nFiltering](https://developers.google.com/custom-search/docs/xml_results#automaticFiltering)\nfor more information about Google's search results filters. Note that host\ncrowding filtering applies only to multi-site searches.\n\n* By default, Google applies filtering to all search results to improve the\nquality of those results.\n\nAcceptable values are:\n\n* `0`: Turns off duplicate content filter.\n\n* `1`: Turns on duplicate content filter.", + "description": "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.", "location": "query", "type": "string" }, "gl": { - "description": "Geolocation of end user.\n\n* The `gl` parameter value is a two-letter country code. The `gl` parameter\nboosts search results whose country of origin matches the parameter value.\nSee the [Country\nCodes](https://developers.google.com/custom-search/docs/xml_results_appendices#countryCodes)\npage for a list of valid values.\n\n* Specifying a `gl` parameter value should lead to more relevant results.\nThis is particularly true for international customers and, even more\nspecifically, for customers in English- speaking countries other than the\nUnited States.", + "description": "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.", "location": "query", "type": "string" }, "googlehost": { - "description": "**Deprecated**. Use the `gl` parameter for a similar effect.\n\nThe local Google domain (for example, google.com, google.de, or\ngoogle.fr) to use to perform the search.", + "description": "**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.", "location": "query", "type": "string" }, "highRange": { - "description": "Specifies the ending value for a search range.\n\n* Use `lowRange` and `highRange` to append an inclusive search range of\n`lowRange...highRange` to the query.", + "description": "Specifies the ending value for a search range. * Use `lowRange` and `highRange` to append an inclusive search range of `lowRange...highRange` to the query.", "location": "query", "type": "string" }, "hl": { - "description": "Sets the user interface language.\n\n* Explicitly setting this parameter improves the performance and the\nquality of your search results.\n\n* See the [Interface\nLanguages](https://developers.google.com/custom-search/docs/xml_results#wsInterfaceLanguages)\nsection of [Internationalizing Queries and Results\nPresentation](https://developers.google.com/custom-search/docs/xml_results#wsInternationalizing)\nfor more information, and (Supported Interface\nLanguages)[https://developers.google.com/custom-search/docs/xml_results_appendices#interfaceLanguages]\nfor a list of supported languages.", + "description": "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.", "location": "query", "type": "string" }, "hq": { - "description": "Appends the specified query terms to the query, as if they were combined\nwith a logical AND operator.", + "description": "Appends the specified query terms to the query, as if they were combined with a logical AND operator.", "location": "query", "type": "string" }, "imgColorType": { - "description": "Returns black and white, grayscale, transparent, or color images.\nAcceptable values are:\n\n* `\"color\"`\n\n* `\"gray\"`\n\n* `\"mono\"`: black and white\n\n* `\"trans\"`: transparent background", + "description": "Returns black and white, grayscale, transparent, or color images. Acceptable values are: * `\"color\"` * `\"gray\"` * `\"mono\"`: black and white * `\"trans\"`: transparent background", "enum": [ "imgColorTypeUndefined", "mono", @@ -177,11 +177,18 @@ "color", "trans" ], + "enumDescriptions": [ + "No image color type specified.", + "Black and white images only.", + "Grayscale images only.", + "Color images only.", + "Images with transparent background" + ], "location": "query", "type": "string" }, "imgDominantColor": { - "description": "Returns images of a specific dominant color. Acceptable values are:\n\n* `\"black\"`\n\n* `\"blue\"`\n\n* `\"brown\"`\n\n* `\"gray\"`\n\n* `\"green\"`\n\n* `\"orange\"`\n\n* `\"pink\"`\n\n* `\"purple\"`\n\n* `\"red\"`\n\n* `\"teal\"`\n\n* `\"white\"`\n\n* `\"yellow\"`", + "description": "Returns images of a specific dominant color. Acceptable values are: * `\"black\"` * `\"blue\"` * `\"brown\"` * `\"gray\"` * `\"green\"` * `\"orange\"` * `\"pink\"` * `\"purple\"` * `\"red\"` * `\"teal\"` * `\"white\"` * `\"yellow\"`", "enum": [ "imgDominantColorUndefined", "black", @@ -197,11 +204,26 @@ "white", "yellow" ], + "enumDescriptions": [ + "No dominant color specified.", + "Predominantly black images only.", + "Predominantly blue images only.", + "Predominantly brown images only.", + "Predominantly gray images only.", + "Predominantly green images only.", + "Predominantly orange images only.", + "Predominantly pink images only.", + "Predominantly purple images only.", + "Predominantly red images only.", + "Predominantly teal images only.", + "Predominantly white images only.", + "Predominantly yellow images only." + ], "location": "query", "type": "string" }, "imgSize": { - "description": "Returns images of a specified size. Acceptable values are:\n\n* `\"huge\"`\n\n* `\"icon\"`\n\n* `\"large\"`\n\n* `\"medium\"`\n\n* `\"small\"`\n\n* `\"xlarge\"`\n\n* `\"xxlarge\"`", + "description": "Returns images of a specified size. Acceptable values are: * `\"huge\"` * `\"icon\"` * `\"large\"` * `\"medium\"` * `\"small\"` * `\"xlarge\"` * `\"xxlarge\"`", "enum": [ "imgSizeUndefined", "HUGE", @@ -212,11 +234,21 @@ "XLARGE", "XXLARGE" ], + "enumDescriptions": [ + "No image size specified.", + "Only the largest possible images.", + "Only very small icon-sized images.", + "Only large images.", + "Only medium images.", + "Only small images.", + "Only very large images.", + "Only extremely large images." + ], "location": "query", "type": "string" }, "imgType": { - "description": "Returns images of a type. Acceptable values are:\n\n* `\"clipart\"`\n\n* `\"face\"`\n\n* `\"lineart\"`\n\n* `\"stock\"`\n\n* `\"photo\"`\n\n* `\"animated\"`", + "description": "Returns images of a type. Acceptable values are: * `\"clipart\"` * `\"face\"` * `\"lineart\"` * `\"stock\"` * `\"photo\"` * `\"animated\"`", "enum": [ "imgTypeUndefined", "clipart", @@ -226,32 +258,41 @@ "photo", "animated" ], + "enumDescriptions": [ + "No image type specified.", + "Clipart-style images only.", + "Images of faces only.", + "Line art images only.", + "Stock images only.", + "Photo images only.", + "Animated images only." + ], "location": "query", "type": "string" }, "linkSite": { - "description": "Specifies that all search results should contain a link to a particular\nURL.", + "description": "Specifies that all search results should contain a link to a particular URL.", "location": "query", "type": "string" }, "lowRange": { - "description": "Specifies the starting value for a search range. Use `lowRange` and\n`highRange` to append an inclusive search range of `lowRange...highRange`\nto the query.", + "description": "Specifies the starting value for a search range. Use `lowRange` and `highRange` to append an inclusive search range of `lowRange...highRange` to the query.", "location": "query", "type": "string" }, "lr": { - "description": "Restricts the search to documents written in a particular language (e.g.,\n`lr=lang_ja`).\n\nAcceptable values are:\n\n* `\"lang_ar\"`: Arabic\n\n* `\"lang_bg\"`: Bulgarian\n\n* `\"lang_ca\"`: Catalan\n\n* `\"lang_cs\"`: Czech\n\n* `\"lang_da\"`: Danish\n\n* `\"lang_de\"`: German\n\n* `\"lang_el\"`: Greek\n\n* `\"lang_en\"`: English\n\n* `\"lang_es\"`: Spanish\n\n* `\"lang_et\"`: Estonian\n\n* `\"lang_fi\"`: Finnish\n\n* `\"lang_fr\"`: French\n\n* `\"lang_hr\"`: Croatian\n\n* `\"lang_hu\"`: Hungarian\n\n* `\"lang_id\"`: Indonesian\n\n* `\"lang_is\"`: Icelandic\n\n* `\"lang_it\"`: Italian\n\n* `\"lang_iw\"`: Hebrew\n\n* `\"lang_ja\"`: Japanese\n\n* `\"lang_ko\"`: Korean\n\n* `\"lang_lt\"`: Lithuanian\n\n* `\"lang_lv\"`: Latvian\n\n* `\"lang_nl\"`: Dutch\n\n* `\"lang_no\"`: Norwegian\n\n* `\"lang_pl\"`: Polish\n\n* `\"lang_pt\"`: Portuguese\n\n* `\"lang_ro\"`: Romanian\n\n* `\"lang_ru\"`: Russian\n\n* `\"lang_sk\"`: Slovak\n\n* `\"lang_sl\"`: Slovenian\n\n* `\"lang_sr\"`: Serbian\n\n* `\"lang_sv\"`: Swedish\n\n* `\"lang_tr\"`: Turkish\n\n* `\"lang_zh-CN\"`: Chinese (Simplified)\n\n* `\"lang_zh-TW\"`: Chinese (Traditional)", + "description": "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)", "location": "query", "type": "string" }, "num": { - "description": "Number of search results to return.\n\n* Valid values are integers between 1 and 10, inclusive.", + "description": "Number of search results to return. * Valid values are integers between 1 and 10, inclusive.", "format": "int32", "location": "query", "type": "integer" }, "orTerms": { - "description": "Provides additional search terms to check for in a document, where each\ndocument in the search results must contain at least one of the additional\nsearch terms.", + "description": "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.", "location": "query", "type": "string" }, @@ -261,17 +302,17 @@ "type": "string" }, "relatedSite": { - "description": "Specifies that all search results should be pages that are related to the\nspecified URL.", + "description": "Specifies that all search results should be pages that are related to the specified URL.", "location": "query", "type": "string" }, "rights": { - "description": "Filters based on licensing. Supported values include: `cc_publicdomain`,\n`cc_attribute`, `cc_sharealike`, `cc_noncommercial`, `cc_nonderived` and\ncombinations of these. See [typical\ncombinations](https://wiki.creativecommons.org/wiki/CC_Search_integration).", + "description": "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).", "location": "query", "type": "string" }, "safe": { - "description": "Search safety level. Acceptable values are:\n\n* `\"active\"`: Enables SafeSearch filtering.\n\n* `\"off\"`: Disables SafeSearch filtering. (default)", + "description": "Search safety level. Acceptable values are: * `\"active\"`: Enables SafeSearch filtering. * `\"off\"`: Disables SafeSearch filtering. (default)", "enum": [ "safeUndefined", "active", @@ -279,40 +320,56 @@ "medium", "off" ], + "enumDescriptions": [ + "SafeSearch mode unspecified. (Falls back to engine's configuration.)", + "Turn SafeSearch on.", + "Deprecated, equivalent to \"active\".", + "Deprecated, equivalent to \"active\".", + "Turn SafeSearch off." + ], "location": "query", "type": "string" }, "searchType": { - "description": "Specifies the search type: `image`. If unspecified, results are limited to\nwebpages.\n\nAcceptable values are:\n\n* `\"image\"`: custom image search.", + "description": "Specifies the search type: `image`. If unspecified, results are limited to webpages. Acceptable values are: * `\"image\"`: custom image search.", "enum": [ "searchTypeUndefined", "image" ], + "enumDescriptions": [ + "Search type unspecified (defaults to web search).", + "Image search." + ], "location": "query", "type": "string" }, "siteSearch": { - "description": "Specifies a given site which should always be included or excluded from\nresults (see `siteSearchFilter` parameter, below).", + "description": "Specifies a given site which should always be included or excluded from results (see `siteSearchFilter` parameter, below).", "location": "query", "type": "string" }, "siteSearchFilter": { - "description": "Controls whether to include or exclude results from the site named in the\n`siteSearch` parameter.\n\nAcceptable values are:\n\n* `\"e\"`: exclude\n\n* `\"i\"`: include", + "description": "Controls whether to include or exclude results from the site named in the `siteSearch` parameter. Acceptable values are: * `\"e\"`: exclude * `\"i\"`: include", "enum": [ "siteSearchFilterUndefined", "e", "i" ], + "enumDescriptions": [ + "Filter mode unspecified.", + "Exclude results from the listed sites.", + "Include only results from the listed sites." + ], "location": "query", "type": "string" }, "sort": { - "description": "The sort expression to apply to the results. The sort parameter specifies\nthat the results be sorted according to the specified expression i.e. sort\nby date.\n[Example:\nsort=date](https://developers.google.com/custom-search/docs/structured_search#sort-by-attribute).", + "description": "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).", "location": "query", "type": "string" }, "start": { - "description": "The index of the first result to return. The default number of results per\npage is 10, so `&start=11` would start at the top of the second page of\nresults. **Note**: The JSON API will never return more than 100 results,\neven if more than 100 documents match the query, so setting the sum of\n`start + num` to a number greater than 100 will produce an error. Also note\nthat the maximum value for `num` is 10.", + "description": "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.", "format": "uint32", "location": "query", "type": "integer" @@ -328,19 +385,19 @@ "siterestrict": { "methods": { "list": { - "description": "Returns metadata about the search performed, metadata about the\nengine used for the search, and the search results. Uses a small set\nof url patterns.", + "description": "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.", "flatPath": "customsearch/v1/siterestrict", "httpMethod": "GET", "id": "search.cse.siterestrict.list", "parameterOrder": [], "parameters": { "c2coff": { - "description": "Enables or disables [Simplified and Traditional Chinese\nSearch](https://developers.google.com/custom-search/docs/xml_results#chineseSearch).\n\nThe default value for this parameter is 0 (zero), meaning that the feature\nis enabled. Supported values are:\n\n* `1`: Disabled\n\n* `0`: Enabled (default)", + "description": "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)", "location": "query", "type": "string" }, "cr": { - "description": "Restricts search results to documents originating in a particular country.\nYou may use [Boolean\noperators](https://developers.google.com/custom-search/docs/xml_results_appendices#booleanOperators)\nin the cr parameter's value.\n\nGoogle Search determines the country of a document by analyzing:\n\n* the top-level domain (TLD) of the document's URL\n\n* the geographic location of the Web server's IP address\n\nSee the [Country Parameter\nValues](https://developers.google.com/custom-search/docs/xml_results_appendices#countryCollections)\npage for a list of valid values for this parameter.", + "description": "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.", "location": "query", "type": "string" }, @@ -350,7 +407,7 @@ "type": "string" }, "dateRestrict": { - "description": "Restricts results to URLs based on date. Supported values include:\n\n* `d[number]`: requests results from the specified number of past days.\n\n* `w[number]`: requests results from the specified number of past weeks.\n\n* `m[number]`: requests results from the specified number of past months.\n\n* `y[number]`: requests results from the specified number of past years.", + "description": "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.", "location": "query", "type": "string" }, @@ -360,47 +417,47 @@ "type": "string" }, "excludeTerms": { - "description": "Identifies a word or phrase that should not appear in any documents in the\nsearch results.", + "description": "Identifies a word or phrase that should not appear in any documents in the search results.", "location": "query", "type": "string" }, "fileType": { - "description": "Restricts results to files of a specified extension. A list of file types\nindexable by Google can be found in Search Console [Help\nCenter](https://support.google.com/webmasters/answer/35287).", + "description": "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).", "location": "query", "type": "string" }, "filter": { - "description": "Controls turning on or off the duplicate content filter.\n\n* See [Automatic\nFiltering](https://developers.google.com/custom-search/docs/xml_results#automaticFiltering)\nfor more information about Google's search results filters. Note that host\ncrowding filtering applies only to multi-site searches.\n\n* By default, Google applies filtering to all search results to improve the\nquality of those results.\n\nAcceptable values are:\n\n* `0`: Turns off duplicate content filter.\n\n* `1`: Turns on duplicate content filter.", + "description": "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.", "location": "query", "type": "string" }, "gl": { - "description": "Geolocation of end user.\n\n* The `gl` parameter value is a two-letter country code. The `gl` parameter\nboosts search results whose country of origin matches the parameter value.\nSee the [Country\nCodes](https://developers.google.com/custom-search/docs/xml_results_appendices#countryCodes)\npage for a list of valid values.\n\n* Specifying a `gl` parameter value should lead to more relevant results.\nThis is particularly true for international customers and, even more\nspecifically, for customers in English- speaking countries other than the\nUnited States.", + "description": "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.", "location": "query", "type": "string" }, "googlehost": { - "description": "**Deprecated**. Use the `gl` parameter for a similar effect.\n\nThe local Google domain (for example, google.com, google.de, or\ngoogle.fr) to use to perform the search.", + "description": "**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.", "location": "query", "type": "string" }, "highRange": { - "description": "Specifies the ending value for a search range.\n\n* Use `lowRange` and `highRange` to append an inclusive search range of\n`lowRange...highRange` to the query.", + "description": "Specifies the ending value for a search range. * Use `lowRange` and `highRange` to append an inclusive search range of `lowRange...highRange` to the query.", "location": "query", "type": "string" }, "hl": { - "description": "Sets the user interface language.\n\n* Explicitly setting this parameter improves the performance and the\nquality of your search results.\n\n* See the [Interface\nLanguages](https://developers.google.com/custom-search/docs/xml_results#wsInterfaceLanguages)\nsection of [Internationalizing Queries and Results\nPresentation](https://developers.google.com/custom-search/docs/xml_results#wsInternationalizing)\nfor more information, and (Supported Interface\nLanguages)[https://developers.google.com/custom-search/docs/xml_results_appendices#interfaceLanguages]\nfor a list of supported languages.", + "description": "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.", "location": "query", "type": "string" }, "hq": { - "description": "Appends the specified query terms to the query, as if they were combined\nwith a logical AND operator.", + "description": "Appends the specified query terms to the query, as if they were combined with a logical AND operator.", "location": "query", "type": "string" }, "imgColorType": { - "description": "Returns black and white, grayscale, transparent, or color images.\nAcceptable values are:\n\n* `\"color\"`\n\n* `\"gray\"`\n\n* `\"mono\"`: black and white\n\n* `\"trans\"`: transparent background", + "description": "Returns black and white, grayscale, transparent, or color images. Acceptable values are: * `\"color\"` * `\"gray\"` * `\"mono\"`: black and white * `\"trans\"`: transparent background", "enum": [ "imgColorTypeUndefined", "mono", @@ -408,11 +465,18 @@ "color", "trans" ], + "enumDescriptions": [ + "No image color type specified.", + "Black and white images only.", + "Grayscale images only.", + "Color images only.", + "Images with transparent background" + ], "location": "query", "type": "string" }, "imgDominantColor": { - "description": "Returns images of a specific dominant color. Acceptable values are:\n\n* `\"black\"`\n\n* `\"blue\"`\n\n* `\"brown\"`\n\n* `\"gray\"`\n\n* `\"green\"`\n\n* `\"orange\"`\n\n* `\"pink\"`\n\n* `\"purple\"`\n\n* `\"red\"`\n\n* `\"teal\"`\n\n* `\"white\"`\n\n* `\"yellow\"`", + "description": "Returns images of a specific dominant color. Acceptable values are: * `\"black\"` * `\"blue\"` * `\"brown\"` * `\"gray\"` * `\"green\"` * `\"orange\"` * `\"pink\"` * `\"purple\"` * `\"red\"` * `\"teal\"` * `\"white\"` * `\"yellow\"`", "enum": [ "imgDominantColorUndefined", "black", @@ -428,11 +492,26 @@ "white", "yellow" ], + "enumDescriptions": [ + "No dominant color specified.", + "Predominantly black images only.", + "Predominantly blue images only.", + "Predominantly brown images only.", + "Predominantly gray images only.", + "Predominantly green images only.", + "Predominantly orange images only.", + "Predominantly pink images only.", + "Predominantly purple images only.", + "Predominantly red images only.", + "Predominantly teal images only.", + "Predominantly white images only.", + "Predominantly yellow images only." + ], "location": "query", "type": "string" }, "imgSize": { - "description": "Returns images of a specified size. Acceptable values are:\n\n* `\"huge\"`\n\n* `\"icon\"`\n\n* `\"large\"`\n\n* `\"medium\"`\n\n* `\"small\"`\n\n* `\"xlarge\"`\n\n* `\"xxlarge\"`", + "description": "Returns images of a specified size. Acceptable values are: * `\"huge\"` * `\"icon\"` * `\"large\"` * `\"medium\"` * `\"small\"` * `\"xlarge\"` * `\"xxlarge\"`", "enum": [ "imgSizeUndefined", "HUGE", @@ -443,11 +522,21 @@ "XLARGE", "XXLARGE" ], + "enumDescriptions": [ + "No image size specified.", + "Only the largest possible images.", + "Only very small icon-sized images.", + "Only large images.", + "Only medium images.", + "Only small images.", + "Only very large images.", + "Only extremely large images." + ], "location": "query", "type": "string" }, "imgType": { - "description": "Returns images of a type. Acceptable values are:\n\n* `\"clipart\"`\n\n* `\"face\"`\n\n* `\"lineart\"`\n\n* `\"stock\"`\n\n* `\"photo\"`\n\n* `\"animated\"`", + "description": "Returns images of a type. Acceptable values are: * `\"clipart\"` * `\"face\"` * `\"lineart\"` * `\"stock\"` * `\"photo\"` * `\"animated\"`", "enum": [ "imgTypeUndefined", "clipart", @@ -457,32 +546,41 @@ "photo", "animated" ], + "enumDescriptions": [ + "No image type specified.", + "Clipart-style images only.", + "Images of faces only.", + "Line art images only.", + "Stock images only.", + "Photo images only.", + "Animated images only." + ], "location": "query", "type": "string" }, "linkSite": { - "description": "Specifies that all search results should contain a link to a particular\nURL.", + "description": "Specifies that all search results should contain a link to a particular URL.", "location": "query", "type": "string" }, "lowRange": { - "description": "Specifies the starting value for a search range. Use `lowRange` and\n`highRange` to append an inclusive search range of `lowRange...highRange`\nto the query.", + "description": "Specifies the starting value for a search range. Use `lowRange` and `highRange` to append an inclusive search range of `lowRange...highRange` to the query.", "location": "query", "type": "string" }, "lr": { - "description": "Restricts the search to documents written in a particular language (e.g.,\n`lr=lang_ja`).\n\nAcceptable values are:\n\n* `\"lang_ar\"`: Arabic\n\n* `\"lang_bg\"`: Bulgarian\n\n* `\"lang_ca\"`: Catalan\n\n* `\"lang_cs\"`: Czech\n\n* `\"lang_da\"`: Danish\n\n* `\"lang_de\"`: German\n\n* `\"lang_el\"`: Greek\n\n* `\"lang_en\"`: English\n\n* `\"lang_es\"`: Spanish\n\n* `\"lang_et\"`: Estonian\n\n* `\"lang_fi\"`: Finnish\n\n* `\"lang_fr\"`: French\n\n* `\"lang_hr\"`: Croatian\n\n* `\"lang_hu\"`: Hungarian\n\n* `\"lang_id\"`: Indonesian\n\n* `\"lang_is\"`: Icelandic\n\n* `\"lang_it\"`: Italian\n\n* `\"lang_iw\"`: Hebrew\n\n* `\"lang_ja\"`: Japanese\n\n* `\"lang_ko\"`: Korean\n\n* `\"lang_lt\"`: Lithuanian\n\n* `\"lang_lv\"`: Latvian\n\n* `\"lang_nl\"`: Dutch\n\n* `\"lang_no\"`: Norwegian\n\n* `\"lang_pl\"`: Polish\n\n* `\"lang_pt\"`: Portuguese\n\n* `\"lang_ro\"`: Romanian\n\n* `\"lang_ru\"`: Russian\n\n* `\"lang_sk\"`: Slovak\n\n* `\"lang_sl\"`: Slovenian\n\n* `\"lang_sr\"`: Serbian\n\n* `\"lang_sv\"`: Swedish\n\n* `\"lang_tr\"`: Turkish\n\n* `\"lang_zh-CN\"`: Chinese (Simplified)\n\n* `\"lang_zh-TW\"`: Chinese (Traditional)", + "description": "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)", "location": "query", "type": "string" }, "num": { - "description": "Number of search results to return.\n\n* Valid values are integers between 1 and 10, inclusive.", + "description": "Number of search results to return. * Valid values are integers between 1 and 10, inclusive.", "format": "int32", "location": "query", "type": "integer" }, "orTerms": { - "description": "Provides additional search terms to check for in a document, where each\ndocument in the search results must contain at least one of the additional\nsearch terms.", + "description": "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.", "location": "query", "type": "string" }, @@ -492,17 +590,17 @@ "type": "string" }, "relatedSite": { - "description": "Specifies that all search results should be pages that are related to the\nspecified URL.", + "description": "Specifies that all search results should be pages that are related to the specified URL.", "location": "query", "type": "string" }, "rights": { - "description": "Filters based on licensing. Supported values include: `cc_publicdomain`,\n`cc_attribute`, `cc_sharealike`, `cc_noncommercial`, `cc_nonderived` and\ncombinations of these. See [typical\ncombinations](https://wiki.creativecommons.org/wiki/CC_Search_integration).", + "description": "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).", "location": "query", "type": "string" }, "safe": { - "description": "Search safety level. Acceptable values are:\n\n* `\"active\"`: Enables SafeSearch filtering.\n\n* `\"off\"`: Disables SafeSearch filtering. (default)", + "description": "Search safety level. Acceptable values are: * `\"active\"`: Enables SafeSearch filtering. * `\"off\"`: Disables SafeSearch filtering. (default)", "enum": [ "safeUndefined", "active", @@ -510,40 +608,56 @@ "medium", "off" ], + "enumDescriptions": [ + "SafeSearch mode unspecified. (Falls back to engine's configuration.)", + "Turn SafeSearch on.", + "Deprecated, equivalent to \"active\".", + "Deprecated, equivalent to \"active\".", + "Turn SafeSearch off." + ], "location": "query", "type": "string" }, "searchType": { - "description": "Specifies the search type: `image`. If unspecified, results are limited to\nwebpages.\n\nAcceptable values are:\n\n* `\"image\"`: custom image search.", + "description": "Specifies the search type: `image`. If unspecified, results are limited to webpages. Acceptable values are: * `\"image\"`: custom image search.", "enum": [ "searchTypeUndefined", "image" ], + "enumDescriptions": [ + "Search type unspecified (defaults to web search).", + "Image search." + ], "location": "query", "type": "string" }, "siteSearch": { - "description": "Specifies a given site which should always be included or excluded from\nresults (see `siteSearchFilter` parameter, below).", + "description": "Specifies a given site which should always be included or excluded from results (see `siteSearchFilter` parameter, below).", "location": "query", "type": "string" }, "siteSearchFilter": { - "description": "Controls whether to include or exclude results from the site named in the\n`siteSearch` parameter.\n\nAcceptable values are:\n\n* `\"e\"`: exclude\n\n* `\"i\"`: include", + "description": "Controls whether to include or exclude results from the site named in the `siteSearch` parameter. Acceptable values are: * `\"e\"`: exclude * `\"i\"`: include", "enum": [ "siteSearchFilterUndefined", "e", "i" ], + "enumDescriptions": [ + "Filter mode unspecified.", + "Exclude results from the listed sites.", + "Include only results from the listed sites." + ], "location": "query", "type": "string" }, "sort": { - "description": "The sort expression to apply to the results. The sort parameter specifies\nthat the results be sorted according to the specified expression i.e. sort\nby date.\n[Example:\nsort=date](https://developers.google.com/custom-search/docs/structured_search#sort-by-attribute).", + "description": "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).", "location": "query", "type": "string" }, "start": { - "description": "The index of the first result to return. The default number of results per\npage is 10, so `&start=11` would start at the top of the second page of\nresults. **Note**: The JSON API will never return more than 100 results,\neven if more than 100 documents match the query, so setting the sum of\n`start + num` to a number greater than 100 will produce an error. Also note\nthat the maximum value for `num` is 10.", + "description": "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.", "format": "uint32", "location": "query", "type": "integer" @@ -559,7 +673,7 @@ } } }, - "revision": "20200723", + "revision": "20200801", "rootUrl": "https://customsearch.googleapis.com/", "schemas": { "Promotion": { @@ -567,7 +681,7 @@ "id": "Promotion", "properties": { "bodyLines": { - "description": "An array of block objects for this promotion. See [Google WebSearch\nProtocol\nreference](https://developers.google.com/custom-search/docs/xml_results)\nfor more information.", + "description": "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.", "items": { "description": "Block object belonging to a promotion.", "properties": { @@ -703,16 +817,16 @@ "type": "object" }, "kind": { - "description": "A unique identifier for the type of current object. For this API, it is\n`customsearch#result.`", + "description": "A unique identifier for the type of current object. For this API, it is `customsearch#result.`", "type": "string" }, "labels": { - "description": "Encapsulates all information about [refinement\nlabels](https://developers.google.com/custom-search/docs/xml_results).", + "description": "Encapsulates all information about [refinement labels](https://developers.google.com/custom-search/docs/xml_results).", "items": { "description": "Refinement label associated with a custom search result.", "properties": { "displayName": { - "description": "The display name of a refinement label. This is the name you should\ndisplay in your user interface.", + "description": "The display name of a refinement label. This is the name you should display in your user interface.", "type": "string" }, "label_with_op": { @@ -720,7 +834,7 @@ "type": "string" }, "name": { - "description": "The name of a refinement label, which you can use to refine searches.\nDon't display this in your user interface; instead, use displayName.", + "description": "The name of a refinement label, which you can use to refine searches. Don't display this in your user interface; instead, use displayName.", "type": "string" } }, @@ -729,7 +843,7 @@ "type": "array" }, "link": { - "description": "The full URL to which the search result is pointing, e.g.\nhttp://www.example.com/foo/bar.", + "description": "The full URL to which the search result is pointing, e.g. http://www.example.com/foo/bar.", "type": "string" }, "mime": { @@ -741,7 +855,7 @@ "description": "Properties of the object.", "type": "any" }, - "description": "Contains\n[PageMap](https://developers.google.com/custom-search/docs/structured_data#pagemaps)\ninformation for this search result.", + "description": "Contains [PageMap](https://developers.google.com/custom-search/docs/structured_data#pagemaps) information for this search result.", "type": "object" }, "snippet": { @@ -764,7 +878,7 @@ "description": "Properties of the object.", "type": "any" }, - "description": "Metadata and refinements associated with the given search engine,\nincluding:\n\n* The name of the search engine that was used for the query.\n\n* A set of [facet\nobjects](https://developers.google.com/custom-search/docs/refinements#create)\n(refinements) you can use for refining a search.", + "description": "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.", "type": "object" }, "items": { @@ -775,11 +889,11 @@ "type": "array" }, "kind": { - "description": "Unique identifier for the type of current object. For this API, it is\ncustomsearch#search.", + "description": "Unique identifier for the type of current object. For this API, it is customsearch#search.", "type": "string" }, "promotions": { - "description": "The set of\n[promotions](https://developers.google.com/custom-search/docs/promotions).\nPresent only if the custom search engine's configuration files define any\npromotions for the given query.", + "description": "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.", "items": { "$ref": "Promotion" }, @@ -799,71 +913,71 @@ "type": "integer" }, "cr": { - "description": "Restricts search results to documents originating in a particular\ncountry. You may use [Boolean\noperators](https://developers.google.com/custom-search/docs/xml_results#booleanOperators)\nin the `cr` parameter's value.\n\nGoogle WebSearch determines the country of a document by analyzing the\nfollowing:\n\n* The top-level domain (TLD) of the document's URL.\n\n* The geographic location of the web server's IP address.\n\nSee [Country (cr) Parameter\nValues](https://developers.google.com/custom-search/docs/xml_results#countryCollections)\nfor a list of valid values for this parameter.", + "description": "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.", "type": "string" }, "cx": { - "description": "The identifier of an engine created using the Programmable Search Engine\n[Control Panel](https://programmablesearchengine.google.com/). This is a\ncustom property not defined in the OpenSearch spec. This parameter is\n**required**.", + "description": "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**.", "type": "string" }, "dateRestrict": { - "description": "Restricts results to URLs based on date. Supported values include:\n\n* `d[number]`: requests results from the specified number of past days.\n\n* `w[number]`: requests results from the specified number of past weeks.\n\n* `m[number]`: requests results from the specified number of past months.\n\n* `y[number]`: requests results from the specified number of past years.", + "description": "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.", "type": "string" }, "disableCnTwTranslation": { - "description": "Enables or disables the [Simplified and Traditional Chinese\nSearch](https://developers.google.com/custom-search/docs/xml_results#chineseSearch)\nfeature.\n\nSupported values are:\n\n* `0`: enabled (default)\n\n* `1`: disabled", + "description": "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", "type": "string" }, "exactTerms": { - "description": "Identifies a phrase that all documents in the search results must\ncontain.", + "description": "Identifies a phrase that all documents in the search results must contain.", "type": "string" }, "excludeTerms": { - "description": "Identifies a word or phrase that should not appear in any documents in\nthe search results.", + "description": "Identifies a word or phrase that should not appear in any documents in the search results.", "type": "string" }, "fileType": { - "description": "Restricts results to files of a specified extension. Filetypes supported\nby Google include:\n\n* Adobe Portable Document Format (`pdf`)\n\n* Adobe PostScript (`ps`)\n\n* Lotus 1-2-3 (`wk1`, `wk2`, `wk3`, `wk4`, `wk5`, `wki`, `wks`, `wku`)\n\n* Lotus WordPro (`lwp`)\n\n* Macwrite (`mw`)\n\n* Microsoft Excel (`xls`)\n\n* Microsoft PowerPoint (`ppt`)\n\n* Microsoft Word (`doc`)\n\n* Microsoft Works (`wks`, `wps`, `wdb`)\n\n* Microsoft Write (`wri`)\n\n* Rich Text Format (`rtf`)\n\n* Shockwave Flash (`swf`)\n\n* Text (`ans`, `txt`).\n\nAdditional filetypes may be added in the future. An up-to-date list can\nalways be found in Google's [file type\nFAQ](https://support.google.com/webmasters/answer/35287).", + "description": "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).", "type": "string" }, "filter": { - "description": "Activates or deactivates the automatic filtering of Google search\nresults. See [Automatic\nFiltering](https://developers.google.com/custom-search/docs/xml_results#automaticFiltering)\nfor more information about Google's search results filters. Valid values\nfor this parameter are:\n\n* `0`: Disabled\n\n* `1`: Enabled (default)\n\n**Note**: By default, Google applies filtering to all search results to\nimprove the quality of those results.", + "description": "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.", "type": "string" }, "gl": { - "description": "Boosts search results whose country of origin matches the parameter\nvalue. See [Country\nCodes](https://developers.google.com/custom-search/docs/xml_results#countryCodes)\nfor a list of valid values.\n\nSpecifying a `gl` parameter value in WebSearch requests should improve\nthe relevance of results. This is particularly true for international\ncustomers and, even more specifically, for customers in English-speaking\ncountries other than the United States.", + "description": "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.", "type": "string" }, "googleHost": { - "description": "Specifies the Google domain (for example, google.com, google.de, or\ngoogle.fr) to which the search should be limited.", + "description": "Specifies the Google domain (for example, google.com, google.de, or google.fr) to which the search should be limited.", "type": "string" }, "highRange": { - "description": "Specifies the ending value for a search range. Use `cse:lowRange` and\n`cse:highrange` to append an inclusive search range of\n`lowRange...highRange` to the query.", + "description": "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.", "type": "string" }, "hl": { - "description": "Specifies the interface language (host language) of your user interface.\nExplicitly setting this parameter improves the performance and the\nquality of your search results.\n\nSee the [Interface\nLanguages](https://developers.google.com/custom-search/docs/xml_results#wsInterfaceLanguages)\nsection of [Internationalizing Queries and Results\nPresentation](https://developers.google.com/custom-search/docs/xml_results#wsInternationalizing)\nfor more information, and [Supported Interface\nLanguages](https://developers.google.com/custom-search/docs/xml_results_appendices#interfaceLanguages)\nfor a list of supported languages.", + "description": "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.", "type": "string" }, "hq": { - "description": "Appends the specified query terms to the query, as if they were combined\nwith a logical `AND` operator.", + "description": "Appends the specified query terms to the query, as if they were combined with a logical `AND` operator.", "type": "string" }, "imgColorType": { - "description": "Restricts results to images of a specified color type. Supported values\n are:\n\n* `mono` (black and white)\n\n* `gray` (grayscale)\n\n* `color` (color)", + "description": "Restricts results to images of a specified color type. Supported values are: * `mono` (black and white) * `gray` (grayscale) * `color` (color)", "type": "string" }, "imgDominantColor": { - "description": "Restricts results to images with a specific dominant color. Supported\nvalues are:\n\n* `red`\n\n* `orange`\n\n* `yellow`\n\n* `green`\n\n* `teal`\n\n* `blue`\n\n* `purple`\n\n* `pink`\n\n* `white`\n\n* `gray`\n\n* `black`\n\n* `brown`", + "description": "Restricts results to images with a specific dominant color. Supported values are: * `red` * `orange` * `yellow` * `green` * `teal` * `blue` * `purple` * `pink` * `white` * `gray` * `black` * `brown`", "type": "string" }, "imgSize": { - "description": "Restricts results to images of a specified size. Supported values are:\n\n* `icon` (small)\n\n* `small | medium | large | xlarge` (medium)\n\n* `xxlarge` (large)\n\n* `huge` (extra-large)", + "description": "Restricts results to images of a specified size. Supported values are: * `icon` (small) * `small | medium | large | xlarge` (medium) * `xxlarge` (large) * `huge` (extra-large)", "type": "string" }, "imgType": { - "description": "Restricts results to images of a specified type. Supported values are:\n\n* `clipart` (Clip art)\n\n* `face` (Face)\n\n* `lineart` (Line drawing)\n\n* `photo` (Photo)\n\n* `animated` (Animated)\n\n* `stock` (Stock)", + "description": "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)", "type": "string" }, "inputEncoding": { @@ -879,11 +993,11 @@ "type": "string" }, "lowRange": { - "description": "Specifies the starting value for a search range. Use `cse:lowRange` and\n`cse:highrange` to append an inclusive search range of\n`lowRange...highRange` to the query.", + "description": "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.", "type": "string" }, "orTerms": { - "description": "Provides additional search terms to check for in a document, where each\ndocument in the search results must contain at least one of the\nadditional search terms. You can also use the [Boolean\nOR](https://developers.google.com/custom-search/docs/xml_results#BooleanOrqt)\nquery term for this type of query.", + "description": "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.", "type": "string" }, "outputEncoding": { @@ -891,15 +1005,15 @@ "type": "string" }, "relatedSite": { - "description": "Specifies that all search results should be pages that are related to the\nspecified URL. The parameter value should be a URL.", + "description": "Specifies that all search results should be pages that are related to the specified URL. The parameter value should be a URL.", "type": "string" }, "rights": { - "description": "Filters based on licensing. Supported values include:\n\n* `cc_publicdomain`\n\n* `cc_attribute`\n\n* `cc_sharealike`\n\n* `cc_noncommercial`\n\n* `cc_nonderived`", + "description": "Filters based on licensing. Supported values include: * `cc_publicdomain` * `cc_attribute` * `cc_sharealike` * `cc_noncommercial` * `cc_nonderived`", "type": "string" }, "safe": { - "description": "Specifies the [SafeSearch\nlevel](https://developers.google.com/custom-search/docs/xml_results#safeSearchLevels)\nused for filtering out adult results. This is a custom property not\ndefined in the OpenSearch spec. Valid parameter values are:\n\n* `\"off\"`: Disable SafeSearch\n\n* `\"active\"`: Enable SafeSearch", + "description": "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", "type": "string" }, "searchTerms": { @@ -907,7 +1021,7 @@ "type": "string" }, "searchType": { - "description": "Allowed values are `web` or `image`. If unspecified, results are limited\nto webpages.", + "description": "Allowed values are `web` or `image`. If unspecified, results are limited to webpages.", "type": "string" }, "siteSearch": { @@ -915,20 +1029,20 @@ "type": "string" }, "siteSearchFilter": { - "description": "Specifies whether to include or exclude results from the site named in\nthe `sitesearch` parameter. Supported values are:\n\n* `i`: include content from site\n\n* `e`: exclude content from site", + "description": "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", "type": "string" }, "sort": { - "description": "Specifies that results should be sorted according to the specified\nexpression. For example, sort by date.", + "description": "Specifies that results should be sorted according to the specified expression. For example, sort by date.", "type": "string" }, "startIndex": { - "description": "The index of the current set of search results into the total set of\nresults, where the index of the first result is 1.", + "description": "The index of the current set of search results into the total set of results, where the index of the first result is 1.", "format": "int32", "type": "integer" }, "startPage": { - "description": "The page number of this set of results, where the page length is set by\nthe `count` property.", + "description": "The page number of this set of results, where the page length is set by the `count` property.", "format": "int32", "type": "integer" }, @@ -957,71 +1071,71 @@ "type": "integer" }, "cr": { - "description": "Restricts search results to documents originating in a particular\ncountry. You may use [Boolean\noperators](https://developers.google.com/custom-search/docs/xml_results#booleanOperators)\nin the `cr` parameter's value.\n\nGoogle WebSearch determines the country of a document by analyzing the\nfollowing:\n\n* The top-level domain (TLD) of the document's URL.\n\n* The geographic location of the web server's IP address.\n\nSee [Country (cr) Parameter\nValues](https://developers.google.com/custom-search/docs/xml_results#countryCollections)\nfor a list of valid values for this parameter.", + "description": "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.", "type": "string" }, "cx": { - "description": "The identifier of an engine created using the Programmable Search Engine\n[Control Panel](https://programmablesearchengine.google.com/). This is a\ncustom property not defined in the OpenSearch spec. This parameter is\n**required**.", + "description": "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**.", "type": "string" }, "dateRestrict": { - "description": "Restricts results to URLs based on date. Supported values include:\n\n* `d[number]`: requests results from the specified number of past days.\n\n* `w[number]`: requests results from the specified number of past weeks.\n\n* `m[number]`: requests results from the specified number of past months.\n\n* `y[number]`: requests results from the specified number of past years.", + "description": "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.", "type": "string" }, "disableCnTwTranslation": { - "description": "Enables or disables the [Simplified and Traditional Chinese\nSearch](https://developers.google.com/custom-search/docs/xml_results#chineseSearch)\nfeature.\n\nSupported values are:\n\n* `0`: enabled (default)\n\n* `1`: disabled", + "description": "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", "type": "string" }, "exactTerms": { - "description": "Identifies a phrase that all documents in the search results must\ncontain.", + "description": "Identifies a phrase that all documents in the search results must contain.", "type": "string" }, "excludeTerms": { - "description": "Identifies a word or phrase that should not appear in any documents in\nthe search results.", + "description": "Identifies a word or phrase that should not appear in any documents in the search results.", "type": "string" }, "fileType": { - "description": "Restricts results to files of a specified extension. Filetypes supported\nby Google include:\n\n* Adobe Portable Document Format (`pdf`)\n\n* Adobe PostScript (`ps`)\n\n* Lotus 1-2-3 (`wk1`, `wk2`, `wk3`, `wk4`, `wk5`, `wki`, `wks`, `wku`)\n\n* Lotus WordPro (`lwp`)\n\n* Macwrite (`mw`)\n\n* Microsoft Excel (`xls`)\n\n* Microsoft PowerPoint (`ppt`)\n\n* Microsoft Word (`doc`)\n\n* Microsoft Works (`wks`, `wps`, `wdb`)\n\n* Microsoft Write (`wri`)\n\n* Rich Text Format (`rtf`)\n\n* Shockwave Flash (`swf`)\n\n* Text (`ans`, `txt`).\n\nAdditional filetypes may be added in the future. An up-to-date list can\nalways be found in Google's [file type\nFAQ](https://support.google.com/webmasters/answer/35287).", + "description": "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).", "type": "string" }, "filter": { - "description": "Activates or deactivates the automatic filtering of Google search\nresults. See [Automatic\nFiltering](https://developers.google.com/custom-search/docs/xml_results#automaticFiltering)\nfor more information about Google's search results filters. Valid values\nfor this parameter are:\n\n* `0`: Disabled\n\n* `1`: Enabled (default)\n\n**Note**: By default, Google applies filtering to all search results to\nimprove the quality of those results.", + "description": "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.", "type": "string" }, "gl": { - "description": "Boosts search results whose country of origin matches the parameter\nvalue. See [Country\nCodes](https://developers.google.com/custom-search/docs/xml_results#countryCodes)\nfor a list of valid values.\n\nSpecifying a `gl` parameter value in WebSearch requests should improve\nthe relevance of results. This is particularly true for international\ncustomers and, even more specifically, for customers in English-speaking\ncountries other than the United States.", + "description": "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.", "type": "string" }, "googleHost": { - "description": "Specifies the Google domain (for example, google.com, google.de, or\ngoogle.fr) to which the search should be limited.", + "description": "Specifies the Google domain (for example, google.com, google.de, or google.fr) to which the search should be limited.", "type": "string" }, "highRange": { - "description": "Specifies the ending value for a search range. Use `cse:lowRange` and\n`cse:highrange` to append an inclusive search range of\n`lowRange...highRange` to the query.", + "description": "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.", "type": "string" }, "hl": { - "description": "Specifies the interface language (host language) of your user interface.\nExplicitly setting this parameter improves the performance and the\nquality of your search results.\n\nSee the [Interface\nLanguages](https://developers.google.com/custom-search/docs/xml_results#wsInterfaceLanguages)\nsection of [Internationalizing Queries and Results\nPresentation](https://developers.google.com/custom-search/docs/xml_results#wsInternationalizing)\nfor more information, and [Supported Interface\nLanguages](https://developers.google.com/custom-search/docs/xml_results_appendices#interfaceLanguages)\nfor a list of supported languages.", + "description": "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.", "type": "string" }, "hq": { - "description": "Appends the specified query terms to the query, as if they were combined\nwith a logical `AND` operator.", + "description": "Appends the specified query terms to the query, as if they were combined with a logical `AND` operator.", "type": "string" }, "imgColorType": { - "description": "Restricts results to images of a specified color type. Supported values\n are:\n\n* `mono` (black and white)\n\n* `gray` (grayscale)\n\n* `color` (color)", + "description": "Restricts results to images of a specified color type. Supported values are: * `mono` (black and white) * `gray` (grayscale) * `color` (color)", "type": "string" }, "imgDominantColor": { - "description": "Restricts results to images with a specific dominant color. Supported\nvalues are:\n\n* `red`\n\n* `orange`\n\n* `yellow`\n\n* `green`\n\n* `teal`\n\n* `blue`\n\n* `purple`\n\n* `pink`\n\n* `white`\n\n* `gray`\n\n* `black`\n\n* `brown`", + "description": "Restricts results to images with a specific dominant color. Supported values are: * `red` * `orange` * `yellow` * `green` * `teal` * `blue` * `purple` * `pink` * `white` * `gray` * `black` * `brown`", "type": "string" }, "imgSize": { - "description": "Restricts results to images of a specified size. Supported values are:\n\n* `icon` (small)\n\n* `small | medium | large | xlarge` (medium)\n\n* `xxlarge` (large)\n\n* `huge` (extra-large)", + "description": "Restricts results to images of a specified size. Supported values are: * `icon` (small) * `small | medium | large | xlarge` (medium) * `xxlarge` (large) * `huge` (extra-large)", "type": "string" }, "imgType": { - "description": "Restricts results to images of a specified type. Supported values are:\n\n* `clipart` (Clip art)\n\n* `face` (Face)\n\n* `lineart` (Line drawing)\n\n* `photo` (Photo)\n\n* `animated` (Animated)\n\n* `stock` (Stock)", + "description": "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)", "type": "string" }, "inputEncoding": { @@ -1037,11 +1151,11 @@ "type": "string" }, "lowRange": { - "description": "Specifies the starting value for a search range. Use `cse:lowRange` and\n`cse:highrange` to append an inclusive search range of\n`lowRange...highRange` to the query.", + "description": "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.", "type": "string" }, "orTerms": { - "description": "Provides additional search terms to check for in a document, where each\ndocument in the search results must contain at least one of the\nadditional search terms. You can also use the [Boolean\nOR](https://developers.google.com/custom-search/docs/xml_results#BooleanOrqt)\nquery term for this type of query.", + "description": "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.", "type": "string" }, "outputEncoding": { @@ -1049,15 +1163,15 @@ "type": "string" }, "relatedSite": { - "description": "Specifies that all search results should be pages that are related to the\nspecified URL. The parameter value should be a URL.", + "description": "Specifies that all search results should be pages that are related to the specified URL. The parameter value should be a URL.", "type": "string" }, "rights": { - "description": "Filters based on licensing. Supported values include:\n\n* `cc_publicdomain`\n\n* `cc_attribute`\n\n* `cc_sharealike`\n\n* `cc_noncommercial`\n\n* `cc_nonderived`", + "description": "Filters based on licensing. Supported values include: * `cc_publicdomain` * `cc_attribute` * `cc_sharealike` * `cc_noncommercial` * `cc_nonderived`", "type": "string" }, "safe": { - "description": "Specifies the [SafeSearch\nlevel](https://developers.google.com/custom-search/docs/xml_results#safeSearchLevels)\nused for filtering out adult results. This is a custom property not\ndefined in the OpenSearch spec. Valid parameter values are:\n\n* `\"off\"`: Disable SafeSearch\n\n* `\"active\"`: Enable SafeSearch", + "description": "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", "type": "string" }, "searchTerms": { @@ -1065,7 +1179,7 @@ "type": "string" }, "searchType": { - "description": "Allowed values are `web` or `image`. If unspecified, results are limited\nto webpages.", + "description": "Allowed values are `web` or `image`. If unspecified, results are limited to webpages.", "type": "string" }, "siteSearch": { @@ -1073,20 +1187,20 @@ "type": "string" }, "siteSearchFilter": { - "description": "Specifies whether to include or exclude results from the site named in\nthe `sitesearch` parameter. Supported values are:\n\n* `i`: include content from site\n\n* `e`: exclude content from site", + "description": "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", "type": "string" }, "sort": { - "description": "Specifies that results should be sorted according to the specified\nexpression. For example, sort by date.", + "description": "Specifies that results should be sorted according to the specified expression. For example, sort by date.", "type": "string" }, "startIndex": { - "description": "The index of the current set of search results into the total set of\nresults, where the index of the first result is 1.", + "description": "The index of the current set of search results into the total set of results, where the index of the first result is 1.", "format": "int32", "type": "integer" }, "startPage": { - "description": "The page number of this set of results, where the page length is set by\nthe `count` property.", + "description": "The page number of this set of results, where the page length is set by the `count` property.", "format": "int32", "type": "integer" }, @@ -1115,71 +1229,71 @@ "type": "integer" }, "cr": { - "description": "Restricts search results to documents originating in a particular\ncountry. You may use [Boolean\noperators](https://developers.google.com/custom-search/docs/xml_results#booleanOperators)\nin the `cr` parameter's value.\n\nGoogle WebSearch determines the country of a document by analyzing the\nfollowing:\n\n* The top-level domain (TLD) of the document's URL.\n\n* The geographic location of the web server's IP address.\n\nSee [Country (cr) Parameter\nValues](https://developers.google.com/custom-search/docs/xml_results#countryCollections)\nfor a list of valid values for this parameter.", + "description": "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.", "type": "string" }, "cx": { - "description": "The identifier of an engine created using the Programmable Search Engine\n[Control Panel](https://programmablesearchengine.google.com/). This is a\ncustom property not defined in the OpenSearch spec. This parameter is\n**required**.", + "description": "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**.", "type": "string" }, "dateRestrict": { - "description": "Restricts results to URLs based on date. Supported values include:\n\n* `d[number]`: requests results from the specified number of past days.\n\n* `w[number]`: requests results from the specified number of past weeks.\n\n* `m[number]`: requests results from the specified number of past months.\n\n* `y[number]`: requests results from the specified number of past years.", + "description": "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.", "type": "string" }, "disableCnTwTranslation": { - "description": "Enables or disables the [Simplified and Traditional Chinese\nSearch](https://developers.google.com/custom-search/docs/xml_results#chineseSearch)\nfeature.\n\nSupported values are:\n\n* `0`: enabled (default)\n\n* `1`: disabled", + "description": "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", "type": "string" }, "exactTerms": { - "description": "Identifies a phrase that all documents in the search results must\ncontain.", + "description": "Identifies a phrase that all documents in the search results must contain.", "type": "string" }, "excludeTerms": { - "description": "Identifies a word or phrase that should not appear in any documents in\nthe search results.", + "description": "Identifies a word or phrase that should not appear in any documents in the search results.", "type": "string" }, "fileType": { - "description": "Restricts results to files of a specified extension. Filetypes supported\nby Google include:\n\n* Adobe Portable Document Format (`pdf`)\n\n* Adobe PostScript (`ps`)\n\n* Lotus 1-2-3 (`wk1`, `wk2`, `wk3`, `wk4`, `wk5`, `wki`, `wks`, `wku`)\n\n* Lotus WordPro (`lwp`)\n\n* Macwrite (`mw`)\n\n* Microsoft Excel (`xls`)\n\n* Microsoft PowerPoint (`ppt`)\n\n* Microsoft Word (`doc`)\n\n* Microsoft Works (`wks`, `wps`, `wdb`)\n\n* Microsoft Write (`wri`)\n\n* Rich Text Format (`rtf`)\n\n* Shockwave Flash (`swf`)\n\n* Text (`ans`, `txt`).\n\nAdditional filetypes may be added in the future. An up-to-date list can\nalways be found in Google's [file type\nFAQ](https://support.google.com/webmasters/answer/35287).", + "description": "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).", "type": "string" }, "filter": { - "description": "Activates or deactivates the automatic filtering of Google search\nresults. See [Automatic\nFiltering](https://developers.google.com/custom-search/docs/xml_results#automaticFiltering)\nfor more information about Google's search results filters. Valid values\nfor this parameter are:\n\n* `0`: Disabled\n\n* `1`: Enabled (default)\n\n**Note**: By default, Google applies filtering to all search results to\nimprove the quality of those results.", + "description": "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.", "type": "string" }, "gl": { - "description": "Boosts search results whose country of origin matches the parameter\nvalue. See [Country\nCodes](https://developers.google.com/custom-search/docs/xml_results#countryCodes)\nfor a list of valid values.\n\nSpecifying a `gl` parameter value in WebSearch requests should improve\nthe relevance of results. This is particularly true for international\ncustomers and, even more specifically, for customers in English-speaking\ncountries other than the United States.", + "description": "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.", "type": "string" }, "googleHost": { - "description": "Specifies the Google domain (for example, google.com, google.de, or\ngoogle.fr) to which the search should be limited.", + "description": "Specifies the Google domain (for example, google.com, google.de, or google.fr) to which the search should be limited.", "type": "string" }, "highRange": { - "description": "Specifies the ending value for a search range. Use `cse:lowRange` and\n`cse:highrange` to append an inclusive search range of\n`lowRange...highRange` to the query.", + "description": "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.", "type": "string" }, "hl": { - "description": "Specifies the interface language (host language) of your user interface.\nExplicitly setting this parameter improves the performance and the\nquality of your search results.\n\nSee the [Interface\nLanguages](https://developers.google.com/custom-search/docs/xml_results#wsInterfaceLanguages)\nsection of [Internationalizing Queries and Results\nPresentation](https://developers.google.com/custom-search/docs/xml_results#wsInternationalizing)\nfor more information, and [Supported Interface\nLanguages](https://developers.google.com/custom-search/docs/xml_results_appendices#interfaceLanguages)\nfor a list of supported languages.", + "description": "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.", "type": "string" }, "hq": { - "description": "Appends the specified query terms to the query, as if they were combined\nwith a logical `AND` operator.", + "description": "Appends the specified query terms to the query, as if they were combined with a logical `AND` operator.", "type": "string" }, "imgColorType": { - "description": "Restricts results to images of a specified color type. Supported values\n are:\n\n* `mono` (black and white)\n\n* `gray` (grayscale)\n\n* `color` (color)", + "description": "Restricts results to images of a specified color type. Supported values are: * `mono` (black and white) * `gray` (grayscale) * `color` (color)", "type": "string" }, "imgDominantColor": { - "description": "Restricts results to images with a specific dominant color. Supported\nvalues are:\n\n* `red`\n\n* `orange`\n\n* `yellow`\n\n* `green`\n\n* `teal`\n\n* `blue`\n\n* `purple`\n\n* `pink`\n\n* `white`\n\n* `gray`\n\n* `black`\n\n* `brown`", + "description": "Restricts results to images with a specific dominant color. Supported values are: * `red` * `orange` * `yellow` * `green` * `teal` * `blue` * `purple` * `pink` * `white` * `gray` * `black` * `brown`", "type": "string" }, "imgSize": { - "description": "Restricts results to images of a specified size. Supported values are:\n\n* `icon` (small)\n\n* `small | medium | large | xlarge` (medium)\n\n* `xxlarge` (large)\n\n* `huge` (extra-large)", + "description": "Restricts results to images of a specified size. Supported values are: * `icon` (small) * `small | medium | large | xlarge` (medium) * `xxlarge` (large) * `huge` (extra-large)", "type": "string" }, "imgType": { - "description": "Restricts results to images of a specified type. Supported values are:\n\n* `clipart` (Clip art)\n\n* `face` (Face)\n\n* `lineart` (Line drawing)\n\n* `photo` (Photo)\n\n* `animated` (Animated)\n\n* `stock` (Stock)", + "description": "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)", "type": "string" }, "inputEncoding": { @@ -1195,11 +1309,11 @@ "type": "string" }, "lowRange": { - "description": "Specifies the starting value for a search range. Use `cse:lowRange` and\n`cse:highrange` to append an inclusive search range of\n`lowRange...highRange` to the query.", + "description": "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.", "type": "string" }, "orTerms": { - "description": "Provides additional search terms to check for in a document, where each\ndocument in the search results must contain at least one of the\nadditional search terms. You can also use the [Boolean\nOR](https://developers.google.com/custom-search/docs/xml_results#BooleanOrqt)\nquery term for this type of query.", + "description": "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.", "type": "string" }, "outputEncoding": { @@ -1207,15 +1321,15 @@ "type": "string" }, "relatedSite": { - "description": "Specifies that all search results should be pages that are related to the\nspecified URL. The parameter value should be a URL.", + "description": "Specifies that all search results should be pages that are related to the specified URL. The parameter value should be a URL.", "type": "string" }, "rights": { - "description": "Filters based on licensing. Supported values include:\n\n* `cc_publicdomain`\n\n* `cc_attribute`\n\n* `cc_sharealike`\n\n* `cc_noncommercial`\n\n* `cc_nonderived`", + "description": "Filters based on licensing. Supported values include: * `cc_publicdomain` * `cc_attribute` * `cc_sharealike` * `cc_noncommercial` * `cc_nonderived`", "type": "string" }, "safe": { - "description": "Specifies the [SafeSearch\nlevel](https://developers.google.com/custom-search/docs/xml_results#safeSearchLevels)\nused for filtering out adult results. This is a custom property not\ndefined in the OpenSearch spec. Valid parameter values are:\n\n* `\"off\"`: Disable SafeSearch\n\n* `\"active\"`: Enable SafeSearch", + "description": "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", "type": "string" }, "searchTerms": { @@ -1223,7 +1337,7 @@ "type": "string" }, "searchType": { - "description": "Allowed values are `web` or `image`. If unspecified, results are limited\nto webpages.", + "description": "Allowed values are `web` or `image`. If unspecified, results are limited to webpages.", "type": "string" }, "siteSearch": { @@ -1231,20 +1345,20 @@ "type": "string" }, "siteSearchFilter": { - "description": "Specifies whether to include or exclude results from the site named in\nthe `sitesearch` parameter. Supported values are:\n\n* `i`: include content from site\n\n* `e`: exclude content from site", + "description": "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", "type": "string" }, "sort": { - "description": "Specifies that results should be sorted according to the specified\nexpression. For example, sort by date.", + "description": "Specifies that results should be sorted according to the specified expression. For example, sort by date.", "type": "string" }, "startIndex": { - "description": "The index of the current set of search results into the total set of\nresults, where the index of the first result is 1.", + "description": "The index of the current set of search results into the total set of results, where the index of the first result is 1.", "format": "int32", "type": "integer" }, "startPage": { - "description": "The page number of this set of results, where the page length is set by\nthe `count` property.", + "description": "The page number of this set of results, where the page length is set by the `count` property.", "format": "int32", "type": "integer" }, @@ -1269,7 +1383,7 @@ "description": "Metadata about a search operation.", "properties": { "formattedSearchTime": { - "description": "The time taken for the server to return search results, formatted\naccording to locale style.", + "description": "The time taken for the server to return search results, formatted according to locale style.", "type": "string" }, "formattedTotalResults": { @@ -1306,11 +1420,11 @@ "description": "OpenSearch template and URL.", "properties": { "template": { - "description": "The actual [OpenSearch\ntemplate](http://www.opensearch.org/specifications/opensearch/1.1#opensearch_url_template_syntax)\nfor this API.", + "description": "The actual [OpenSearch template](http://www.opensearch.org/specifications/opensearch/1.1#opensearch_url_template_syntax) for this API.", "type": "string" }, "type": { - "description": "The MIME type of the OpenSearch URL template for the Custom Search JSON\nAPI.", + "description": "The MIME type of the OpenSearch URL template for the Custom Search JSON API.", "type": "string" } }, diff --git a/src/apis/customsearch/v1.ts b/src/apis/customsearch/v1.ts index c792326418..3bdf776fe5 100644 --- a/src/apis/customsearch/v1.ts +++ b/src/apis/customsearch/v1.ts @@ -243,7 +243,7 @@ export namespace customsearch_v1 { */ export interface Schema$Search { /** - * 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. + * 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. */ context?: {[key: string]: any} | null; /** @@ -431,311 +431,67 @@ export namespace customsearch_v1 { * * // Do the magic * const res = await search.cse.list({ - * // 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) + * // 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) * c2coff: 'placeholder-value', - * // 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. + * // 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. * cr: 'placeholder-value', * // The Programmable Search Engine ID to use for this request. * cx: 'placeholder-value', - * // 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. + * // 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. * dateRestrict: 'placeholder-value', * // Identifies a phrase that all documents in the search results must contain. * exactTerms: 'placeholder-value', - * // Identifies a word or phrase that should not appear in any documents in the - * // search results. + * // Identifies a word or phrase that should not appear in any documents in the search results. * excludeTerms: 'placeholder-value', - * // 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). + * // 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). * fileType: 'placeholder-value', - * // 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. + * // 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. * filter: 'placeholder-value', - * // 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. + * // 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. * gl: 'placeholder-value', - * // **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. + * // **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. * googlehost: 'placeholder-value', - * // Specifies the ending value for a search range. - * // - * // * Use `lowRange` and `highRange` to append an inclusive search range of - * // `lowRange...highRange` to the query. + * // Specifies the ending value for a search range. * Use `lowRange` and `highRange` to append an inclusive search range of `lowRange...highRange` to the query. * highRange: 'placeholder-value', - * // 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. + * // 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. * hl: 'placeholder-value', - * // Appends the specified query terms to the query, as if they were combined - * // with a logical AND operator. + * // Appends the specified query terms to the query, as if they were combined with a logical AND operator. * hq: 'placeholder-value', - * // Returns black and white, grayscale, transparent, or color images. - * // Acceptable values are: - * // - * // * `"color"` - * // - * // * `"gray"` - * // - * // * `"mono"`: black and white - * // - * // * `"trans"`: transparent background + * // Returns black and white, grayscale, transparent, or color images. Acceptable values are: * `"color"` * `"gray"` * `"mono"`: black and white * `"trans"`: transparent background * imgColorType: 'placeholder-value', - * // Returns images of a specific dominant color. Acceptable values are: - * // - * // * `"black"` - * // - * // * `"blue"` - * // - * // * `"brown"` - * // - * // * `"gray"` - * // - * // * `"green"` - * // - * // * `"orange"` - * // - * // * `"pink"` - * // - * // * `"purple"` - * // - * // * `"red"` - * // - * // * `"teal"` - * // - * // * `"white"` - * // - * // * `"yellow"` + * // Returns images of a specific dominant color. Acceptable values are: * `"black"` * `"blue"` * `"brown"` * `"gray"` * `"green"` * `"orange"` * `"pink"` * `"purple"` * `"red"` * `"teal"` * `"white"` * `"yellow"` * imgDominantColor: 'placeholder-value', - * // Returns images of a specified size. Acceptable values are: - * // - * // * `"huge"` - * // - * // * `"icon"` - * // - * // * `"large"` - * // - * // * `"medium"` - * // - * // * `"small"` - * // - * // * `"xlarge"` - * // - * // * `"xxlarge"` + * // Returns images of a specified size. Acceptable values are: * `"huge"` * `"icon"` * `"large"` * `"medium"` * `"small"` * `"xlarge"` * `"xxlarge"` * imgSize: 'placeholder-value', - * // Returns images of a type. Acceptable values are: - * // - * // * `"clipart"` - * // - * // * `"face"` - * // - * // * `"lineart"` - * // - * // * `"stock"` - * // - * // * `"photo"` - * // - * // * `"animated"` + * // Returns images of a type. Acceptable values are: * `"clipart"` * `"face"` * `"lineart"` * `"stock"` * `"photo"` * `"animated"` * imgType: 'placeholder-value', - * // Specifies that all search results should contain a link to a particular - * // URL. + * // Specifies that all search results should contain a link to a particular URL. * linkSite: 'placeholder-value', - * // Specifies the starting value for a search range. Use `lowRange` and - * // `highRange` to append an inclusive search range of `lowRange...highRange` - * // to the query. + * // Specifies the starting value for a search range. Use `lowRange` and `highRange` to append an inclusive search range of `lowRange...highRange` to the query. * lowRange: 'placeholder-value', - * // 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) + * // 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) * lr: 'placeholder-value', - * // Number of search results to return. - * // - * // * Valid values are integers between 1 and 10, inclusive. + * // Number of search results to return. * Valid values are integers between 1 and 10, inclusive. * num: 'placeholder-value', - * // 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. + * // 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. * orTerms: 'placeholder-value', * // Query * q: 'placeholder-value', - * // Specifies that all search results should be pages that are related to the - * // specified URL. + * // Specifies that all search results should be pages that are related to the specified URL. * relatedSite: 'placeholder-value', - * // 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). + * // 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). * rights: 'placeholder-value', - * // Search safety level. Acceptable values are: - * // - * // * `"active"`: Enables SafeSearch filtering. - * // - * // * `"off"`: Disables SafeSearch filtering. (default) + * // Search safety level. Acceptable values are: * `"active"`: Enables SafeSearch filtering. * `"off"`: Disables SafeSearch filtering. (default) * safe: 'placeholder-value', - * // Specifies the search type: `image`. If unspecified, results are limited to - * // webpages. - * // - * // Acceptable values are: - * // - * // * `"image"`: custom image search. + * // Specifies the search type: `image`. If unspecified, results are limited to webpages. Acceptable values are: * `"image"`: custom image search. * searchType: 'placeholder-value', - * // Specifies a given site which should always be included or excluded from - * // results (see `siteSearchFilter` parameter, below). + * // Specifies a given site which should always be included or excluded from results (see `siteSearchFilter` parameter, below). * siteSearch: 'placeholder-value', - * // Controls whether to include or exclude results from the site named in the - * // `siteSearch` parameter. - * // - * // Acceptable values are: - * // - * // * `"e"`: exclude - * // - * // * `"i"`: include + * // Controls whether to include or exclude results from the site named in the `siteSearch` parameter. Acceptable values are: * `"e"`: exclude * `"i"`: include * siteSearchFilter: 'placeholder-value', - * // 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). + * // 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). * sort: 'placeholder-value', - * // 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. + * // 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. * start: 'placeholder-value', * }); * console.log(res.data); @@ -762,35 +518,35 @@ export namespace customsearch_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string=} params.c2coff 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) - * @param {string=} params.cr 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. + * @param {string=} params.c2coff 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) + * @param {string=} params.cr 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. * @param {string=} params.cx The Programmable Search Engine ID to use for this request. - * @param {string=} params.dateRestrict 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. + * @param {string=} params.dateRestrict 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. * @param {string=} params.exactTerms Identifies a phrase that all documents in the search results must contain. * @param {string=} params.excludeTerms Identifies a word or phrase that should not appear in any documents in the search results. * @param {string=} params.fileType 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). - * @param {string=} params.filter 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. - * @param {string=} params.gl 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. - * @param {string=} params.googlehost **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. - * @param {string=} params.highRange Specifies the ending value for a search range. * Use `lowRange` and `highRange` to append an inclusive search range of `lowRange...highRange` to the query. - * @param {string=} params.hl 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. + * @param {string=} params.filter 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. + * @param {string=} params.gl 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. + * @param {string=} params.googlehost **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. + * @param {string=} params.highRange Specifies the ending value for a search range. * Use `lowRange` and `highRange` to append an inclusive search range of `lowRange...highRange` to the query. + * @param {string=} params.hl 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. * @param {string=} params.hq Appends the specified query terms to the query, as if they were combined with a logical AND operator. - * @param {string=} params.imgColorType Returns black and white, grayscale, transparent, or color images. Acceptable values are: * `"color"` * `"gray"` * `"mono"`: black and white * `"trans"`: transparent background - * @param {string=} params.imgDominantColor Returns images of a specific dominant color. Acceptable values are: * `"black"` * `"blue"` * `"brown"` * `"gray"` * `"green"` * `"orange"` * `"pink"` * `"purple"` * `"red"` * `"teal"` * `"white"` * `"yellow"` - * @param {string=} params.imgSize Returns images of a specified size. Acceptable values are: * `"huge"` * `"icon"` * `"large"` * `"medium"` * `"small"` * `"xlarge"` * `"xxlarge"` - * @param {string=} params.imgType Returns images of a type. Acceptable values are: * `"clipart"` * `"face"` * `"lineart"` * `"stock"` * `"photo"` * `"animated"` + * @param {string=} params.imgColorType Returns black and white, grayscale, transparent, or color images. Acceptable values are: * `"color"` * `"gray"` * `"mono"`: black and white * `"trans"`: transparent background + * @param {string=} params.imgDominantColor Returns images of a specific dominant color. Acceptable values are: * `"black"` * `"blue"` * `"brown"` * `"gray"` * `"green"` * `"orange"` * `"pink"` * `"purple"` * `"red"` * `"teal"` * `"white"` * `"yellow"` + * @param {string=} params.imgSize Returns images of a specified size. Acceptable values are: * `"huge"` * `"icon"` * `"large"` * `"medium"` * `"small"` * `"xlarge"` * `"xxlarge"` + * @param {string=} params.imgType Returns images of a type. Acceptable values are: * `"clipart"` * `"face"` * `"lineart"` * `"stock"` * `"photo"` * `"animated"` * @param {string=} params.linkSite Specifies that all search results should contain a link to a particular URL. * @param {string=} params.lowRange Specifies the starting value for a search range. Use `lowRange` and `highRange` to append an inclusive search range of `lowRange...highRange` to the query. - * @param {string=} params.lr 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) - * @param {integer=} params.num Number of search results to return. * Valid values are integers between 1 and 10, inclusive. + * @param {string=} params.lr 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) + * @param {integer=} params.num Number of search results to return. * Valid values are integers between 1 and 10, inclusive. * @param {string=} params.orTerms 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. * @param {string=} params.q Query * @param {string=} params.relatedSite Specifies that all search results should be pages that are related to the specified URL. * @param {string=} params.rights 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). - * @param {string=} params.safe Search safety level. Acceptable values are: * `"active"`: Enables SafeSearch filtering. * `"off"`: Disables SafeSearch filtering. (default) - * @param {string=} params.searchType Specifies the search type: `image`. If unspecified, results are limited to webpages. Acceptable values are: * `"image"`: custom image search. + * @param {string=} params.safe Search safety level. Acceptable values are: * `"active"`: Enables SafeSearch filtering. * `"off"`: Disables SafeSearch filtering. (default) + * @param {string=} params.searchType Specifies the search type: `image`. If unspecified, results are limited to webpages. Acceptable values are: * `"image"`: custom image search. * @param {string=} params.siteSearch Specifies a given site which should always be included or excluded from results (see `siteSearchFilter` parameter, below). - * @param {string=} params.siteSearchFilter Controls whether to include or exclude results from the site named in the `siteSearch` parameter. Acceptable values are: * `"e"`: exclude * `"i"`: include + * @param {string=} params.siteSearchFilter Controls whether to include or exclude results from the site named in the `siteSearch` parameter. Acceptable values are: * `"e"`: exclude * `"i"`: include * @param {string=} params.sort 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). * @param {integer=} params.start 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. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. @@ -875,11 +631,11 @@ export namespace customsearch_v1 { export interface Params$Resource$Cse$List extends StandardParameters { /** - * 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) + * 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) */ c2coff?: 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. + * 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. */ cr?: string; /** @@ -887,7 +643,7 @@ export namespace customsearch_v1 { */ cx?: 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. + * 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. */ dateRestrict?: string; /** @@ -903,23 +659,23 @@ export namespace customsearch_v1 { */ fileType?: 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. + * 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. */ filter?: 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. + * 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. */ gl?: 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. + * **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. */ googlehost?: 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. + * Specifies the ending value for a search range. * Use `lowRange` and `highRange` to append an inclusive search range of `lowRange...highRange` to the query. */ highRange?: 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. + * 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. */ hl?: string; /** @@ -927,19 +683,19 @@ export namespace customsearch_v1 { */ hq?: string; /** - * Returns black and white, grayscale, transparent, or color images. Acceptable values are: * `"color"` * `"gray"` * `"mono"`: black and white * `"trans"`: transparent background + * Returns black and white, grayscale, transparent, or color images. Acceptable values are: * `"color"` * `"gray"` * `"mono"`: black and white * `"trans"`: transparent background */ imgColorType?: string; /** - * Returns images of a specific dominant color. Acceptable values are: * `"black"` * `"blue"` * `"brown"` * `"gray"` * `"green"` * `"orange"` * `"pink"` * `"purple"` * `"red"` * `"teal"` * `"white"` * `"yellow"` + * Returns images of a specific dominant color. Acceptable values are: * `"black"` * `"blue"` * `"brown"` * `"gray"` * `"green"` * `"orange"` * `"pink"` * `"purple"` * `"red"` * `"teal"` * `"white"` * `"yellow"` */ imgDominantColor?: string; /** - * Returns images of a specified size. Acceptable values are: * `"huge"` * `"icon"` * `"large"` * `"medium"` * `"small"` * `"xlarge"` * `"xxlarge"` + * Returns images of a specified size. Acceptable values are: * `"huge"` * `"icon"` * `"large"` * `"medium"` * `"small"` * `"xlarge"` * `"xxlarge"` */ imgSize?: string; /** - * Returns images of a type. Acceptable values are: * `"clipart"` * `"face"` * `"lineart"` * `"stock"` * `"photo"` * `"animated"` + * Returns images of a type. Acceptable values are: * `"clipart"` * `"face"` * `"lineart"` * `"stock"` * `"photo"` * `"animated"` */ imgType?: string; /** @@ -951,11 +707,11 @@ export namespace customsearch_v1 { */ lowRange?: 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) + * 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) */ lr?: string; /** - * Number of search results to return. * Valid values are integers between 1 and 10, inclusive. + * Number of search results to return. * Valid values are integers between 1 and 10, inclusive. */ num?: number; /** @@ -975,11 +731,11 @@ export namespace customsearch_v1 { */ rights?: string; /** - * Search safety level. Acceptable values are: * `"active"`: Enables SafeSearch filtering. * `"off"`: Disables SafeSearch filtering. (default) + * Search safety level. Acceptable values are: * `"active"`: Enables SafeSearch filtering. * `"off"`: Disables SafeSearch filtering. (default) */ safe?: string; /** - * Specifies the search type: `image`. If unspecified, results are limited to webpages. Acceptable values are: * `"image"`: custom image search. + * Specifies the search type: `image`. If unspecified, results are limited to webpages. Acceptable values are: * `"image"`: custom image search. */ searchType?: string; /** @@ -987,7 +743,7 @@ export namespace customsearch_v1 { */ siteSearch?: string; /** - * Controls whether to include or exclude results from the site named in the `siteSearch` parameter. Acceptable values are: * `"e"`: exclude * `"i"`: include + * Controls whether to include or exclude results from the site named in the `siteSearch` parameter. Acceptable values are: * `"e"`: exclude * `"i"`: include */ siteSearchFilter?: string; /** @@ -1033,311 +789,67 @@ export namespace customsearch_v1 { * * // Do the magic * const res = await search.cse.siterestrict.list({ - * // 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) + * // 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) * c2coff: 'placeholder-value', - * // 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. + * // 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. * cr: 'placeholder-value', * // The Programmable Search Engine ID to use for this request. * cx: 'placeholder-value', - * // 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. + * // 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. * dateRestrict: 'placeholder-value', * // Identifies a phrase that all documents in the search results must contain. * exactTerms: 'placeholder-value', - * // Identifies a word or phrase that should not appear in any documents in the - * // search results. + * // Identifies a word or phrase that should not appear in any documents in the search results. * excludeTerms: 'placeholder-value', - * // 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). + * // 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). * fileType: 'placeholder-value', - * // 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. + * // 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. * filter: 'placeholder-value', - * // 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. + * // 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. * gl: 'placeholder-value', - * // **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. + * // **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. * googlehost: 'placeholder-value', - * // Specifies the ending value for a search range. - * // - * // * Use `lowRange` and `highRange` to append an inclusive search range of - * // `lowRange...highRange` to the query. + * // Specifies the ending value for a search range. * Use `lowRange` and `highRange` to append an inclusive search range of `lowRange...highRange` to the query. * highRange: 'placeholder-value', - * // 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. + * // 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. * hl: 'placeholder-value', - * // Appends the specified query terms to the query, as if they were combined - * // with a logical AND operator. + * // Appends the specified query terms to the query, as if they were combined with a logical AND operator. * hq: 'placeholder-value', - * // Returns black and white, grayscale, transparent, or color images. - * // Acceptable values are: - * // - * // * `"color"` - * // - * // * `"gray"` - * // - * // * `"mono"`: black and white - * // - * // * `"trans"`: transparent background + * // Returns black and white, grayscale, transparent, or color images. Acceptable values are: * `"color"` * `"gray"` * `"mono"`: black and white * `"trans"`: transparent background * imgColorType: 'placeholder-value', - * // Returns images of a specific dominant color. Acceptable values are: - * // - * // * `"black"` - * // - * // * `"blue"` - * // - * // * `"brown"` - * // - * // * `"gray"` - * // - * // * `"green"` - * // - * // * `"orange"` - * // - * // * `"pink"` - * // - * // * `"purple"` - * // - * // * `"red"` - * // - * // * `"teal"` - * // - * // * `"white"` - * // - * // * `"yellow"` + * // Returns images of a specific dominant color. Acceptable values are: * `"black"` * `"blue"` * `"brown"` * `"gray"` * `"green"` * `"orange"` * `"pink"` * `"purple"` * `"red"` * `"teal"` * `"white"` * `"yellow"` * imgDominantColor: 'placeholder-value', - * // Returns images of a specified size. Acceptable values are: - * // - * // * `"huge"` - * // - * // * `"icon"` - * // - * // * `"large"` - * // - * // * `"medium"` - * // - * // * `"small"` - * // - * // * `"xlarge"` - * // - * // * `"xxlarge"` + * // Returns images of a specified size. Acceptable values are: * `"huge"` * `"icon"` * `"large"` * `"medium"` * `"small"` * `"xlarge"` * `"xxlarge"` * imgSize: 'placeholder-value', - * // Returns images of a type. Acceptable values are: - * // - * // * `"clipart"` - * // - * // * `"face"` - * // - * // * `"lineart"` - * // - * // * `"stock"` - * // - * // * `"photo"` - * // - * // * `"animated"` + * // Returns images of a type. Acceptable values are: * `"clipart"` * `"face"` * `"lineart"` * `"stock"` * `"photo"` * `"animated"` * imgType: 'placeholder-value', - * // Specifies that all search results should contain a link to a particular - * // URL. + * // Specifies that all search results should contain a link to a particular URL. * linkSite: 'placeholder-value', - * // Specifies the starting value for a search range. Use `lowRange` and - * // `highRange` to append an inclusive search range of `lowRange...highRange` - * // to the query. + * // Specifies the starting value for a search range. Use `lowRange` and `highRange` to append an inclusive search range of `lowRange...highRange` to the query. * lowRange: 'placeholder-value', - * // 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) + * // 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) * lr: 'placeholder-value', - * // Number of search results to return. - * // - * // * Valid values are integers between 1 and 10, inclusive. + * // Number of search results to return. * Valid values are integers between 1 and 10, inclusive. * num: 'placeholder-value', - * // 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. + * // 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. * orTerms: 'placeholder-value', * // Query * q: 'placeholder-value', - * // Specifies that all search results should be pages that are related to the - * // specified URL. + * // Specifies that all search results should be pages that are related to the specified URL. * relatedSite: 'placeholder-value', - * // 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). + * // 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). * rights: 'placeholder-value', - * // Search safety level. Acceptable values are: - * // - * // * `"active"`: Enables SafeSearch filtering. - * // - * // * `"off"`: Disables SafeSearch filtering. (default) + * // Search safety level. Acceptable values are: * `"active"`: Enables SafeSearch filtering. * `"off"`: Disables SafeSearch filtering. (default) * safe: 'placeholder-value', - * // Specifies the search type: `image`. If unspecified, results are limited to - * // webpages. - * // - * // Acceptable values are: - * // - * // * `"image"`: custom image search. + * // Specifies the search type: `image`. If unspecified, results are limited to webpages. Acceptable values are: * `"image"`: custom image search. * searchType: 'placeholder-value', - * // Specifies a given site which should always be included or excluded from - * // results (see `siteSearchFilter` parameter, below). + * // Specifies a given site which should always be included or excluded from results (see `siteSearchFilter` parameter, below). * siteSearch: 'placeholder-value', - * // Controls whether to include or exclude results from the site named in the - * // `siteSearch` parameter. - * // - * // Acceptable values are: - * // - * // * `"e"`: exclude - * // - * // * `"i"`: include + * // Controls whether to include or exclude results from the site named in the `siteSearch` parameter. Acceptable values are: * `"e"`: exclude * `"i"`: include * siteSearchFilter: 'placeholder-value', - * // 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). + * // 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). * sort: 'placeholder-value', - * // 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. + * // 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. * start: 'placeholder-value', * }); * console.log(res.data); @@ -1364,35 +876,35 @@ export namespace customsearch_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string=} params.c2coff 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) - * @param {string=} params.cr 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. + * @param {string=} params.c2coff 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) + * @param {string=} params.cr 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. * @param {string=} params.cx The Programmable Search Engine ID to use for this request. - * @param {string=} params.dateRestrict 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. + * @param {string=} params.dateRestrict 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. * @param {string=} params.exactTerms Identifies a phrase that all documents in the search results must contain. * @param {string=} params.excludeTerms Identifies a word or phrase that should not appear in any documents in the search results. * @param {string=} params.fileType 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). - * @param {string=} params.filter 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. - * @param {string=} params.gl 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. - * @param {string=} params.googlehost **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. - * @param {string=} params.highRange Specifies the ending value for a search range. * Use `lowRange` and `highRange` to append an inclusive search range of `lowRange...highRange` to the query. - * @param {string=} params.hl 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. + * @param {string=} params.filter 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. + * @param {string=} params.gl 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. + * @param {string=} params.googlehost **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. + * @param {string=} params.highRange Specifies the ending value for a search range. * Use `lowRange` and `highRange` to append an inclusive search range of `lowRange...highRange` to the query. + * @param {string=} params.hl 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. * @param {string=} params.hq Appends the specified query terms to the query, as if they were combined with a logical AND operator. - * @param {string=} params.imgColorType Returns black and white, grayscale, transparent, or color images. Acceptable values are: * `"color"` * `"gray"` * `"mono"`: black and white * `"trans"`: transparent background - * @param {string=} params.imgDominantColor Returns images of a specific dominant color. Acceptable values are: * `"black"` * `"blue"` * `"brown"` * `"gray"` * `"green"` * `"orange"` * `"pink"` * `"purple"` * `"red"` * `"teal"` * `"white"` * `"yellow"` - * @param {string=} params.imgSize Returns images of a specified size. Acceptable values are: * `"huge"` * `"icon"` * `"large"` * `"medium"` * `"small"` * `"xlarge"` * `"xxlarge"` - * @param {string=} params.imgType Returns images of a type. Acceptable values are: * `"clipart"` * `"face"` * `"lineart"` * `"stock"` * `"photo"` * `"animated"` + * @param {string=} params.imgColorType Returns black and white, grayscale, transparent, or color images. Acceptable values are: * `"color"` * `"gray"` * `"mono"`: black and white * `"trans"`: transparent background + * @param {string=} params.imgDominantColor Returns images of a specific dominant color. Acceptable values are: * `"black"` * `"blue"` * `"brown"` * `"gray"` * `"green"` * `"orange"` * `"pink"` * `"purple"` * `"red"` * `"teal"` * `"white"` * `"yellow"` + * @param {string=} params.imgSize Returns images of a specified size. Acceptable values are: * `"huge"` * `"icon"` * `"large"` * `"medium"` * `"small"` * `"xlarge"` * `"xxlarge"` + * @param {string=} params.imgType Returns images of a type. Acceptable values are: * `"clipart"` * `"face"` * `"lineart"` * `"stock"` * `"photo"` * `"animated"` * @param {string=} params.linkSite Specifies that all search results should contain a link to a particular URL. * @param {string=} params.lowRange Specifies the starting value for a search range. Use `lowRange` and `highRange` to append an inclusive search range of `lowRange...highRange` to the query. - * @param {string=} params.lr 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) - * @param {integer=} params.num Number of search results to return. * Valid values are integers between 1 and 10, inclusive. + * @param {string=} params.lr 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) + * @param {integer=} params.num Number of search results to return. * Valid values are integers between 1 and 10, inclusive. * @param {string=} params.orTerms 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. * @param {string=} params.q Query * @param {string=} params.relatedSite Specifies that all search results should be pages that are related to the specified URL. * @param {string=} params.rights 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). - * @param {string=} params.safe Search safety level. Acceptable values are: * `"active"`: Enables SafeSearch filtering. * `"off"`: Disables SafeSearch filtering. (default) - * @param {string=} params.searchType Specifies the search type: `image`. If unspecified, results are limited to webpages. Acceptable values are: * `"image"`: custom image search. + * @param {string=} params.safe Search safety level. Acceptable values are: * `"active"`: Enables SafeSearch filtering. * `"off"`: Disables SafeSearch filtering. (default) + * @param {string=} params.searchType Specifies the search type: `image`. If unspecified, results are limited to webpages. Acceptable values are: * `"image"`: custom image search. * @param {string=} params.siteSearch Specifies a given site which should always be included or excluded from results (see `siteSearchFilter` parameter, below). - * @param {string=} params.siteSearchFilter Controls whether to include or exclude results from the site named in the `siteSearch` parameter. Acceptable values are: * `"e"`: exclude * `"i"`: include + * @param {string=} params.siteSearchFilter Controls whether to include or exclude results from the site named in the `siteSearch` parameter. Acceptable values are: * `"e"`: exclude * `"i"`: include * @param {string=} params.sort 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). * @param {integer=} params.start 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. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. @@ -1482,11 +994,11 @@ export namespace customsearch_v1 { export interface Params$Resource$Cse$Siterestrict$List extends StandardParameters { /** - * 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) + * 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) */ c2coff?: 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. + * 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. */ cr?: string; /** @@ -1494,7 +1006,7 @@ export namespace customsearch_v1 { */ cx?: 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. + * 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. */ dateRestrict?: string; /** @@ -1510,23 +1022,23 @@ export namespace customsearch_v1 { */ fileType?: 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. + * 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. */ filter?: 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. + * 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. */ gl?: 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. + * **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. */ googlehost?: 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. + * Specifies the ending value for a search range. * Use `lowRange` and `highRange` to append an inclusive search range of `lowRange...highRange` to the query. */ highRange?: 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. + * 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. */ hl?: string; /** @@ -1534,19 +1046,19 @@ export namespace customsearch_v1 { */ hq?: string; /** - * Returns black and white, grayscale, transparent, or color images. Acceptable values are: * `"color"` * `"gray"` * `"mono"`: black and white * `"trans"`: transparent background + * Returns black and white, grayscale, transparent, or color images. Acceptable values are: * `"color"` * `"gray"` * `"mono"`: black and white * `"trans"`: transparent background */ imgColorType?: string; /** - * Returns images of a specific dominant color. Acceptable values are: * `"black"` * `"blue"` * `"brown"` * `"gray"` * `"green"` * `"orange"` * `"pink"` * `"purple"` * `"red"` * `"teal"` * `"white"` * `"yellow"` + * Returns images of a specific dominant color. Acceptable values are: * `"black"` * `"blue"` * `"brown"` * `"gray"` * `"green"` * `"orange"` * `"pink"` * `"purple"` * `"red"` * `"teal"` * `"white"` * `"yellow"` */ imgDominantColor?: string; /** - * Returns images of a specified size. Acceptable values are: * `"huge"` * `"icon"` * `"large"` * `"medium"` * `"small"` * `"xlarge"` * `"xxlarge"` + * Returns images of a specified size. Acceptable values are: * `"huge"` * `"icon"` * `"large"` * `"medium"` * `"small"` * `"xlarge"` * `"xxlarge"` */ imgSize?: string; /** - * Returns images of a type. Acceptable values are: * `"clipart"` * `"face"` * `"lineart"` * `"stock"` * `"photo"` * `"animated"` + * Returns images of a type. Acceptable values are: * `"clipart"` * `"face"` * `"lineart"` * `"stock"` * `"photo"` * `"animated"` */ imgType?: string; /** @@ -1558,11 +1070,11 @@ export namespace customsearch_v1 { */ lowRange?: 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) + * 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) */ lr?: string; /** - * Number of search results to return. * Valid values are integers between 1 and 10, inclusive. + * Number of search results to return. * Valid values are integers between 1 and 10, inclusive. */ num?: number; /** @@ -1582,11 +1094,11 @@ export namespace customsearch_v1 { */ rights?: string; /** - * Search safety level. Acceptable values are: * `"active"`: Enables SafeSearch filtering. * `"off"`: Disables SafeSearch filtering. (default) + * Search safety level. Acceptable values are: * `"active"`: Enables SafeSearch filtering. * `"off"`: Disables SafeSearch filtering. (default) */ safe?: string; /** - * Specifies the search type: `image`. If unspecified, results are limited to webpages. Acceptable values are: * `"image"`: custom image search. + * Specifies the search type: `image`. If unspecified, results are limited to webpages. Acceptable values are: * `"image"`: custom image search. */ searchType?: string; /** @@ -1594,7 +1106,7 @@ export namespace customsearch_v1 { */ siteSearch?: string; /** - * Controls whether to include or exclude results from the site named in the `siteSearch` parameter. Acceptable values are: * `"e"`: exclude * `"i"`: include + * Controls whether to include or exclude results from the site named in the `siteSearch` parameter. Acceptable values are: * `"e"`: exclude * `"i"`: include */ siteSearchFilter?: string; /**