"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.",
"description":"Returns metadata about the search performed, metadata about the custom search engine used for the search, and the search results.",
"httpMethod":"GET",
"id":"search.cse.list",
"parameterOrder":[
"q"
],
"parameters":{
"c2coff":{
"description":"Turns off the translation between zh-CN and zh-TW.",
"location":"query",
"type":"string"
},
"cr":{
"description":"Country restrict(s).",
"location":"query",
"type":"string"
},
"cx":{
"description":"The custom search engine ID to scope this search query",
"location":"query",
"type":"string"
},
"dateRestrict":{
"description":"Specifies all search results are from a time period",
"location":"query",
"type":"string"
},
"exactTerms":{
"description":"Identifies a phrase that all documents in the search results must contain",
"location":"query",
"type":"string"
},
"excludeTerms":{
"description":"Identifies a word or phrase that should not appear in any documents in the search results",
"location":"query",
"type":"string"
},
"fileType":{
"description":"Returns images of a specified type. Some of the allowed values are: bmp, gif, png, jpg, svg, pdf, ...",
"location":"query",
"type":"string"
},
"filter":{
"description":"Controls turning on or off the duplicate content filter.",
"enum":[
"0",
"1"
],
"enumDescriptions":[
"Turns off duplicate content filter.",
"Turns on duplicate content filter."
],
"location":"query",
"type":"string"
},
"gl":{
"description":"Geolocation of end user.",
"location":"query",
"type":"string"
},
"googlehost":{
"description":"The local Google domain to use to perform the search.",
"location":"query",
"type":"string"
},
"highRange":{
"description":"Creates a range in form as_nlo value..as_nhi value and attempts to append it to query",
"location":"query",
"type":"string"
},
"hl":{
"description":"Sets the user interface language.",
"location":"query",
"type":"string"
},
"hq":{
"description":"Appends the extra query terms to the query.",
"location":"query",
"type":"string"
},
"imgColorType":{
"description":"Returns black and white, grayscale, or color images: mono, gray, and color.",
"enum":[
"color",
"gray",
"mono"
],
"enumDescriptions":[
"color",
"gray",
"mono"
],
"location":"query",
"type":"string"
},
"imgDominantColor":{
"description":"Returns images of a specific dominant color: yellow, green, teal, blue, purple, pink, white, gray, black and brown.",
"enum":[
"black",
"blue",
"brown",
"gray",
"green",
"pink",
"purple",
"teal",
"white",
"yellow"
],
"enumDescriptions":[
"black",
"blue",
"brown",
"gray",
"green",
"pink",
"purple",
"teal",
"white",
"yellow"
],
"location":"query",
"type":"string"
},
"imgSize":{
"description":"Returns images of a specified size, where size can be one of: icon, small, medium, large, xlarge, xxlarge, and huge.",
"enum":[
"huge",
"icon",
"large",
"medium",
"small",
"xlarge",
"xxlarge"
],
"enumDescriptions":[
"huge",
"icon",
"large",
"medium",
"small",
"xlarge",
"xxlarge"
],
"location":"query",
"type":"string"
},
"imgType":{
"description":"Returns images of a type, which can be one of: clipart, face, lineart, news, and photo.",
"enum":[
"clipart",
"face",
"lineart",
"news",
"photo"
],
"enumDescriptions":[
"clipart",
"face",
"lineart",
"news",
"photo"
],
"location":"query",
"type":"string"
},
"linkSite":{
"description":"Specifies that all search results should contain a link to a particular URL",
"location":"query",
"type":"string"
},
"lowRange":{
"description":"Creates a range in form as_nlo value..as_nhi value and attempts to append it to query",
"location":"query",
"type":"string"
},
"lr":{
"description":"The language restriction for the search results",
"enum":[
"lang_ar",
"lang_bg",
"lang_ca",
"lang_cs",
"lang_da",
"lang_de",
"lang_el",
"lang_en",
"lang_es",
"lang_et",
"lang_fi",
"lang_fr",
"lang_hr",
"lang_hu",
"lang_id",
"lang_is",
"lang_it",
"lang_iw",
"lang_ja",
"lang_ko",
"lang_lt",
"lang_lv",
"lang_nl",
"lang_no",
"lang_pl",
"lang_pt",
"lang_ro",
"lang_ru",
"lang_sk",
"lang_sl",
"lang_sr",
"lang_sv",
"lang_tr",
"lang_zh-CN",
"lang_zh-TW"
],
"enumDescriptions":[
"Arabic",
"Bulgarian",
"Catalan",
"Czech",
"Danish",
"German",
"Greek",
"English",
"Spanish",
"Estonian",
"Finnish",
"French",
"Croatian",
"Hungarian",
"Indonesian",
"Icelandic",
"Italian",
"Hebrew",
"Japanese",
"Korean",
"Lithuanian",
"Latvian",
"Dutch",
"Norwegian",
"Polish",
"Portuguese",
"Romanian",
"Russian",
"Slovak",
"Slovenian",
"Serbian",
"Swedish",
"Turkish",
"Chinese (Simplified)",
"Chinese (Traditional)"
],
"location":"query",
"type":"string"
},
"num":{
"default":"10",
"description":"Number of search results to return",
"format":"uint32",
"location":"query",
"type":"integer"
},
"orTerms":{
"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"
},
"q":{
"description":"Query",
"location":"query",
"required":true,
"type":"string"
},
"relatedSite":{
"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, cc_attribute, cc_sharealike, cc_noncommercial, cc_nonderived and combinations of these.",
"location":"query",
"type":"string"
},
"safe":{
"default":"off",
"description":"Search safety level",
"enum":[
"high",
"medium",
"off"
],
"enumDescriptions":[
"Enables highest level of safe search filtering.",
"Enables moderate safe search filtering.",
"Disables safe search filtering."
],
"location":"query",
"type":"string"
},
"searchType":{
"description":"Specifies the search type: image.",
"enum":[
"image"
],
"enumDescriptions":[
"custom image search"
],
"location":"query",
"type":"string"
},
"siteSearch":{
"description":"Specifies all search results should be pages from a given site",
"location":"query",
"type":"string"
},
"siteSearchFilter":{
"description":"Controls whether to include or exclude results from the site named in the as_sitesearch parameter",
"enum":[
"e",
"i"
],
"enumDescriptions":[
"exclude",
"include"
],
"location":"query",
"type":"string"
},
"sort":{
"description":"The sort expression to apply to the results",
"location":"query",
"type":"string"
},
"start":{
"description":"The index of the first result to return",
"description":"(Closed Beta API) Returns metadata about the search performed, metadata about the custom search engine used for the search, and the search results only for site-restrict cses.",
"httpMethod":"GET",
"id":"search.cse.siterestrict.list",
"parameterOrder":[
"q"
],
"parameters":{
"c2coff":{
"description":"Turns off the translation between zh-CN and zh-TW.",
"location":"query",
"type":"string"
},
"cr":{
"description":"Country restrict(s).",
"location":"query",
"type":"string"
},
"cx":{
"description":"The custom search engine ID to scope this search query",
"location":"query",
"type":"string"
},
"dateRestrict":{
"description":"Specifies all search results are from a time period",
"location":"query",
"type":"string"
},
"exactTerms":{
"description":"Identifies a phrase that all documents in the search results must contain",
"location":"query",
"type":"string"
},
"excludeTerms":{
"description":"Identifies a word or phrase that should not appear in any documents in the search results",
"location":"query",
"type":"string"
},
"fileType":{
"description":"Returns images of a specified type. Some of the allowed values are: bmp, gif, png, jpg, svg, pdf, ...",
"location":"query",
"type":"string"
},
"filter":{
"description":"Controls turning on or off the duplicate content filter.",
"enum":[
"0",
"1"
],
"enumDescriptions":[
"Turns off duplicate content filter.",
"Turns on duplicate content filter."
],
"location":"query",
"type":"string"
},
"gl":{
"description":"Geolocation of end user.",
"location":"query",
"type":"string"
},
"googlehost":{
"description":"The local Google domain to use to perform the search.",
"location":"query",
"type":"string"
},
"highRange":{
"description":"Creates a range in form as_nlo value..as_nhi value and attempts to append it to query",
"location":"query",
"type":"string"
},
"hl":{
"description":"Sets the user interface language.",
"location":"query",
"type":"string"
},
"hq":{
"description":"Appends the extra query terms to the query.",
"location":"query",
"type":"string"
},
"imgColorType":{
"description":"Returns black and white, grayscale, or color images: mono, gray, and color.",
"enum":[
"color",
"gray",
"mono"
],
"enumDescriptions":[
"color",
"gray",
"mono"
],
"location":"query",
"type":"string"
},
"imgDominantColor":{
"description":"Returns images of a specific dominant color: yellow, green, teal, blue, purple, pink, white, gray, black and brown.",
"enum":[
"black",
"blue",
"brown",
"gray",
"green",
"pink",
"purple",
"teal",
"white",
"yellow"
],
"enumDescriptions":[
"black",
"blue",
"brown",
"gray",
"green",
"pink",
"purple",
"teal",
"white",
"yellow"
],
"location":"query",
"type":"string"
},
"imgSize":{
"description":"Returns images of a specified size, where size can be one of: icon, small, medium, large, xlarge, xxlarge, and huge.",
"enum":[
"huge",
"icon",
"large",
"medium",
"small",
"xlarge",
"xxlarge"
],
"enumDescriptions":[
"huge",
"icon",
"large",
"medium",
"small",
"xlarge",
"xxlarge"
],
"location":"query",
"type":"string"
},
"imgType":{
"description":"Returns images of a type, which can be one of: clipart, face, lineart, news, and photo.",
"enum":[
"clipart",
"face",
"lineart",
"news",
"photo"
],
"enumDescriptions":[
"clipart",
"face",
"lineart",
"news",
"photo"
],
"location":"query",
"type":"string"
},
"linkSite":{
"description":"Specifies that all search results should contain a link to a particular URL",
"location":"query",
"type":"string"
},
"lowRange":{
"description":"Creates a range in form as_nlo value..as_nhi value and attempts to append it to query",
"location":"query",
"type":"string"
},
"lr":{
"description":"The language restriction for the search results",
"enum":[
"lang_ar",
"lang_bg",
"lang_ca",
"lang_cs",
"lang_da",
"lang_de",
"lang_el",
"lang_en",
"lang_es",
"lang_et",
"lang_fi",
"lang_fr",
"lang_hr",
"lang_hu",
"lang_id",
"lang_is",
"lang_it",
"lang_iw",
"lang_ja",
"lang_ko",
"lang_lt",
"lang_lv",
"lang_nl",
"lang_no",
"lang_pl",
"lang_pt",
"lang_ro",
"lang_ru",
"lang_sk",
"lang_sl",
"lang_sr",
"lang_sv",
"lang_tr",
"lang_zh-CN",
"lang_zh-TW"
],
"enumDescriptions":[
"Arabic",
"Bulgarian",
"Catalan",
"Czech",
"Danish",
"German",
"Greek",
"English",
"Spanish",
"Estonian",
"Finnish",
"French",
"Croatian",
"Hungarian",
"Indonesian",
"Icelandic",
"Italian",
"Hebrew",
"Japanese",
"Korean",
"Lithuanian",
"Latvian",
"Dutch",
"Norwegian",
"Polish",
"Portuguese",
"Romanian",
"Russian",
"Slovak",
"Slovenian",
"Serbian",
"Swedish",
"Turkish",
"Chinese (Simplified)",
"Chinese (Traditional)"
],
"location":"query",
"type":"string"
},
"num":{
"default":"10",
"description":"Number of search results to return",
"format":"uint32",
"location":"query",
"type":"integer"
},
"orTerms":{
"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"
},
"q":{
"description":"Query",
"location":"query",
"required":true,
"type":"string"
},
"relatedSite":{
"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, cc_attribute, cc_sharealike, cc_noncommercial, cc_nonderived and combinations of these.",
"location":"query",
"type":"string"
},
"safe":{
"default":"off",
"description":"Search safety level",
"enum":[
"high",
"medium",
"off"
],
"enumDescriptions":[
"Enables highest level of safe search filtering.",
"Enables moderate safe search filtering.",
"Disables safe search filtering."
],
"location":"query",
"type":"string"
},
"searchType":{
"description":"Specifies the search type: image.",
"enum":[
"image"
],
"enumDescriptions":[
"custom image search"
],
"location":"query",
"type":"string"
},
"siteSearch":{
"description":"Specifies all search results should be pages from a given site",
"location":"query",
"type":"string"
},
"siteSearchFilter":{
"description":"Controls whether to include or exclude results from the site named in the as_sitesearch parameter",
"enum":[
"e",
"i"
],
"enumDescriptions":[
"exclude",
"include"
],
"location":"query",
"type":"string"
},
"sort":{
"description":"The sort expression to apply to the results",
"location":"query",
"type":"string"
},
"start":{
"description":"The index of the first result to return",