{"kind":"discovery#restDescription","rootUrl":"https://customsearch.googleapis.com/","parameters":{"callback":{"location":"query","type":"string","description":"JSONP"},"quotaUser":{"type":"string","location":"query","description":"Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters."},"key":{"description":"API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.","location":"query","type":"string"},"alt":{"default":"json","enumDescriptions":["Responses with Content-Type of application/json","Media download with context-dependent Content-Type","Responses with Content-Type of application/x-protobuf"],"description":"Data format for response.","type":"string","enum":["json","media","proto"],"location":"query"},"$.xgafv":{"description":"V1 error format.","enumDescriptions":["v1 error format","v2 error format"],"type":"string","enum":["1","2"],"location":"query"},"oauth_token":{"description":"OAuth 2.0 token for the current user.","type":"string","location":"query"},"access_token":{"description":"OAuth access token.","type":"string","location":"query"},"prettyPrint":{"type":"boolean","location":"query","description":"Returns response with indentations and line breaks.","default":"true"},"upload_protocol":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","type":"string","location":"query"},"fields":{"description":"Selector specifying which fields to include in a partial response.","type":"string","location":"query"},"uploadType":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","type":"string","location":"query"}},"version":"v1","batchPath":"batch","resources":{"cse":{"resources":{"siterestrict":{"methods":{"list":{"parameterOrder":[],"parameters":{"snippetLength":{"description":"Optional. Maximum length of snippet text, in characters, to be returned with results. Note: this feature is limited to specific engines. * Valid values are integers between 161 and 1000, inclusive.","format":"int32","type":"integer","location":"query"},"dateRestrict":{"location":"query","type":"string","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."},"searchType":{"location":"query","enum":["searchTypeUndefined","image"],"enumDescriptions":["Search type unspecified (defaults to web search).","Image search."],"description":"Specifies the search type: `image`. If unspecified, results are limited to webpages. Acceptable values are: * `\"image\"`: custom image search.","type":"string"},"num":{"description":"Number of search results to return. * Valid values are integers between 1 and 10, inclusive.","format":"int32","type":"integer","location":"query"},"safe":{"description":"Search safety level. Acceptable values are: * `\"active\"`: Enables SafeSearch filtering. * `\"off\"`: Disables SafeSearch filtering. (default)","enumDescriptions":["SafeSearch mode unspecified. (Falls back to engine's configuration.)","Turn SafeSearch on.","Deprecated, equivalent to \"active\".","Deprecated, equivalent to \"active\".","Turn SafeSearch off."],"type":"string","enumDeprecated":[false,false,true,true,false],"location":"query","enum":["safeUndefined","active","high","medium","off"]},"enableAlternateSearchHandler":{"location":"query","type":"boolean","description":"Optional. Enables routing of Programmable Search Engine requests to an alternate search handler."},"lr":{"type":"string","location":"query","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)"},"imgType":{"location":"query","enum":["imgTypeUndefined","clipart","face","lineart","stock","photo","animated"],"type":"string","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."],"description":"Returns images of a type. Acceptable values are: * `\"clipart\"` * `\"face\"` * `\"lineart\"` * `\"stock\"` * `\"photo\"` * `\"animated\"`"},"excludeTerms":{"location":"query","type":"string","description":"Identifies a word or phrase that should not appear in any documents in the search results."},"highRange":{"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.","type":"string","location":"query"},"linkSite":{"description":"Specifies that all search results should contain a link to a particular URL.","type":"string","location":"query"},"siteSearch":{"description":"Specifies a given site which should always be included or excluded from results (see `siteSearchFilter` parameter, below).","type":"string","location":"query"},"exactTerms":{"description":"Identifies a phrase that all documents in the search results must contain.","type":"string","location":"query"},"imgColorType":{"location":"query","enum":["imgColorTypeUndefined","mono","gray","color","trans"],"enumDescriptions":["No image color type specified.","Black and white images only.","Grayscale images only.","Color images only.","Images with transparent background"],"description":"Returns black and white, grayscale, transparent, or color images. Acceptable values are: * `\"color\"` * `\"gray\"` * `\"mono\"`: black and white * `\"trans\"`: transparent background","type":"string"},"cr":{"type":"string","location":"query","description":"Restricts search results to documents originating in a particular country. You may use [Boolean operators](https://developers.google.com/custom-search/docs/json_api_reference#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/json_api_reference#countryCollections) page for a list of valid values for this parameter."},"relatedSite":{"description":"Deprecated.","location":"query","deprecated":true,"type":"string"},"lowRange":{"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.","type":"string","location":"query"},"orTerms":{"location":"query","type":"string","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."},"gl":{"location":"query","type":"string","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/json_api_reference#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."},"siteSearchFilter":{"location":"query","enum":["siteSearchFilterUndefined","e","i"],"type":"string","enumDescriptions":["Filter mode unspecified.","Exclude results from the listed sites.","Include only results from the listed sites."],"description":"Controls whether to include or exclude results from the site named in the `siteSearch` parameter. Acceptable values are: * `\"e\"`: exclude * `\"i\"`: include"},"q":{"description":"Query","type":"string","location":"query"},"filter":{"description":"Controls turning on or off the duplicate content filter. * See [Automatic Filtering](https://developers.google.com/custom-search/docs/json_api_reference#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"},"c2coff":{"type":"string","location":"query","description":"Enables or disables [Simplified and Traditional Chinese Search](https://developers.google.com/custom-search/docs/json_api_reference#chineseSearch). The default value for this parameter is 0 (zero), meaning that the feature is enabled. Supported values are: * `1`: Disabled * `0`: Enabled (default)"},"googlehost":{"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"},"rights":{"location":"query","type":"string","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)."},"imgDominantColor":{"location":"query","enum":["imgDominantColorUndefined","black","blue","brown","gray","green","orange","pink","purple","red","teal","white","yellow"],"type":"string","description":"Returns images of a specific dominant color. Acceptable values are: * `\"black\"` * `\"blue\"` * `\"brown\"` * `\"gray\"` * `\"green\"` * `\"orange\"` * `\"pink\"` * `\"purple\"` * `\"red\"` * `\"teal\"` * `\"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."]},"imgSize":{"location":"query","enum":["imgSizeUndefined","HUGE","ICON","LARGE","MEDIUM","SMALL","XLARGE","XXLARGE"],"description":"Returns images of a specified size. Acceptable values are: * `\"huge\"` * `\"icon\"` * `\"large\"` * `\"medium\"` * `\"small\"` * `\"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."],"type":"string"},"start":{"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","type":"integer","location":"query"},"sort":{"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).","type":"string","location":"query"},"hl":{"location":"query","type":"string","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/json_api_reference#wsInterfaceLanguages) section of [Internationalizing Queries and Results Presentation](https://developers.google.com/custom-search/docs/json_api_reference#wsInternationalizing) for more information, and [Supported Interface Languages](https://developers.google.com/custom-search/docs/json_api_reference#interfaceLanguages) for a list of supported languages."},"hq":{"location":"query","type":"string","description":"Appends the specified query terms to the query, as if they were combined with a logical AND operator."},"cx":{"location":"query","type":"string","description":"The Programmable Search Engine ID to use for this request."},"fileType":{"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"}},"path":"customsearch/v1/siterestrict","id":"search.cse.siterestrict.list","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.","response":{"$ref":"Search"},"flatPath":"customsearch/v1/siterestrict","httpMethod":"GET"}}}},"methods":{"list":{"path":"customsearch/v1","id":"search.cse.list","description":"Returns metadata about the search performed, metadata about the engine used for the search, and the search results.","parameterOrder":[],"parameters":{"siteSearchFilter":{"location":"query","enum":["siteSearchFilterUndefined","e","i"],"type":"string","description":"Controls whether to include or exclude results from the site named in the `siteSearch` parameter. Acceptable values are: * `\"e\"`: exclude * `\"i\"`: include","enumDescriptions":["Filter mode unspecified.","Exclude results from the listed sites.","Include only results from the listed sites."]},"q":{"description":"Query","type":"string","location":"query"},"relatedSite":{"location":"query","deprecated":true,"type":"string","description":"Deprecated."},"lowRange":{"location":"query","type":"string","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."},"orTerms":{"location":"query","type":"string","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."},"gl":{"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/json_api_reference#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.","type":"string","location":"query"},"cr":{"description":"Restricts search results to documents originating in a particular country. You may use [Boolean operators](https://developers.google.com/custom-search/docs/json_api_reference#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/json_api_reference#countryCollections) page for a list of valid values for this parameter.","location":"query","type":"string"},"imgType":{"location":"query","enum":["imgTypeUndefined","clipart","face","lineart","stock","photo","animated"],"type":"string","description":"Returns images of a type. Acceptable values are: * `\"clipart\"` * `\"face\"` * `\"lineart\"` * `\"stock\"` * `\"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."]},"excludeTerms":{"location":"query","type":"string","description":"Identifies a word or phrase that should not appear in any documents in the search results."},"highRange":{"type":"string","location":"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."},"linkSite":{"description":"Specifies that all search results should contain a link to a particular URL.","location":"query","type":"string"},"siteSearch":{"location":"query","type":"string","description":"Specifies a given site which should always be included or excluded from results (see `siteSearchFilter` parameter, below)."},"exactTerms":{"description":"Identifies a phrase that all documents in the search results must contain.","location":"query","type":"string"},"imgColorType":{"location":"query","enum":["imgColorTypeUndefined","mono","gray","color","trans"],"type":"string","description":"Returns black and white, grayscale, transparent, or color images. Acceptable values are: * `\"color\"` * `\"gray\"` * `\"mono\"`: black and white * `\"trans\"`: transparent background","enumDescriptions":["No image color type specified.","Black and white images only.","Grayscale images only.","Color images only.","Images with transparent background"]},"enableAlternateSearchHandler":{"description":"Optional. Enables routing of Programmable Search Engine requests to an alternate search handler.","location":"query","type":"boolean"},"lr":{"type":"string","location":"query","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)"},"num":{"location":"query","type":"integer","format":"int32","description":"Number of search results to return. * Valid values are integers between 1 and 10, inclusive."},"safe":{"location":"query","enum":["safeUndefined","active","high","medium","off"],"enumDeprecated":[false,false,true,true,false],"enumDescriptions":["SafeSearch mode unspecified. (Falls back to engine's configuration.)","Turn SafeSearch on.","Deprecated, equivalent to \"active\".","Deprecated, equivalent to \"active\".","Turn SafeSearch off."],"description":"Search safety level. Acceptable values are: * `\"active\"`: Enables SafeSearch filtering. * `\"off\"`: Disables SafeSearch filtering. (default)","type":"string"},"dateRestrict":{"type":"string","location":"query","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."},"searchType":{"location":"query","enum":["searchTypeUndefined","image"],"enumDescriptions":["Search type unspecified (defaults to web search).","Image search."],"description":"Specifies the search type: `image`. If unspecified, results are limited to webpages. Acceptable values are: * `\"image\"`: custom image search.","type":"string"},"snippetLength":{"type":"integer","location":"query","description":"Optional. Maximum length of snippet text, in characters, to be returned with results. Note: this feature is limited to specific engines. * Valid values are integers between 161 and 1000, inclusive.","format":"int32"},"fileType":{"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).","type":"string","location":"query"},"cx":{"description":"The Programmable Search Engine ID to use for this request.","type":"string","location":"query"},"hq":{"type":"string","location":"query","description":"Appends the specified query terms to the query, as if they were combined with a logical AND operator."},"hl":{"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/json_api_reference#wsInterfaceLanguages) section of [Internationalizing Queries and Results Presentation](https://developers.google.com/custom-search/docs/json_api_reference#wsInternationalizing) for more information, and [Supported Interface Languages](https://developers.google.com/custom-search/docs/json_api_reference#interfaceLanguages) for a list of supported languages.","type":"string","location":"query"},"sort":{"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"},"rights":{"type":"string","location":"query","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)."},"imgDominantColor":{"location":"query","enum":["imgDominantColorUndefined","black","blue","brown","gray","green","orange","pink","purple","red","teal","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."],"description":"Returns images of a specific dominant color. Acceptable values are: * `\"black\"` * `\"blue\"` * `\"brown\"` * `\"gray\"` * `\"green\"` * `\"orange\"` * `\"pink\"` * `\"purple\"` * `\"red\"` * `\"teal\"` * `\"white\"` * `\"yellow\"`","type":"string"},"imgSize":{"location":"query","enum":["imgSizeUndefined","HUGE","ICON","LARGE","MEDIUM","SMALL","XLARGE","XXLARGE"],"type":"string","description":"Returns images of a specified size. Acceptable values are: * `\"huge\"` * `\"icon\"` * `\"large\"` * `\"medium\"` * `\"small\"` * `\"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."]},"start":{"format":"uint32","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.","location":"query","type":"integer"},"filter":{"description":"Controls turning on or off the duplicate content filter. * See [Automatic Filtering](https://developers.google.com/custom-search/docs/json_api_reference#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.","type":"string","location":"query"},"c2coff":{"type":"string","location":"query","description":"Enables or disables [Simplified and Traditional Chinese Search](https://developers.google.com/custom-search/docs/json_api_reference#chineseSearch). The default value for this parameter is 0 (zero), meaning that the feature is enabled. Supported values are: * `1`: Disabled * `0`: Enabled (default)"},"googlehost":{"location":"query","type":"string","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."}},"httpMethod":"GET","response":{"$ref":"Search"},"flatPath":"customsearch/v1"}}}},"id":"customsearch:v1","name":"customsearch","servicePath":""}