Module GapiCustomsearchV1Service.CseResource
module Siterestrict : sig ... end
module SiteSearchFilter : sig ... end
module SearchType : sig ... end
module Safe : sig ... end
module Lr : sig ... end
module ImgType : sig ... end
module ImgSize : sig ... end
module ImgDominantColor : sig ... end
module ImgColorType : sig ... end
module Filter : sig ... end
val list : ?base_url:string -> ?std_params:GapiService.StandardParameters.t -> ?num:int -> ?safe:Safe.t -> ?c2coff:string -> ?cr:string -> ?cx:string -> ?dateRestrict:string -> ?exactTerms:string -> ?excludeTerms:string -> ?fileType:string -> ?filter:Filter.t -> ?gl:string -> ?googlehost:string -> ?highRange:string -> ?hl:string -> ?hq:string -> ?imgColorType:ImgColorType.t -> ?imgDominantColor:ImgDominantColor.t -> ?imgSize:ImgSize.t -> ?imgType:ImgType.t -> ?linkSite:string -> ?lowRange:string -> ?lr:Lr.t -> ?orTerms:string -> ?relatedSite:string -> ?rights:string -> ?searchType:SearchType.t -> ?siteSearch:string -> ?siteSearchFilter:SiteSearchFilter.t -> ?sort:string -> ?start:int -> q:string -> GapiConversation.Session.t -> GapiCustomsearchV1Model.Search.t * GapiConversation.Session.t
Returns metadata about the search performed, metadata about the custom search engine used for the search, and the search results.
- parameter base_url
Service endpoint base URL (defaults to
"https://www.googleapis.com/customsearch/"
).
- parameter std_params
Optional standard parameters.
- parameter num
Number of search results to return
- parameter safe
Search safety level
- parameter c2coff
Turns off the translation between zh-CN and zh-TW.
- parameter cr
Country restrict(s).
- parameter cx
The custom search engine ID to scope this search query
- parameter dateRestrict
Specifies all search results are from a time period
- parameter exactTerms
Identifies a phrase that all documents in the search results must contain
- parameter excludeTerms
Identifies a word or phrase that should not appear in any documents in the search results
- parameter fileType
Returns images of a specified type. Some of the allowed values are: bmp, gif, png, jpg, svg, pdf, ...
- parameter filter
Controls turning on or off the duplicate content filter.
- parameter gl
Geolocation of end user.
- parameter googlehost
The local Google domain to use to perform the search.
- parameter highRange
Creates a range in form as_nlo value..as_nhi value and attempts to append it to query
- parameter hl
Sets the user interface language.
- parameter hq
Appends the extra query terms to the query.
- parameter imgColorType
Returns black and white, grayscale, or color images: mono, gray, and color.
- parameter imgDominantColor
Returns images of a specific dominant color: red, orange, yellow, green, teal, blue, purple, pink, white, gray, black and brown.
- parameter imgSize
Returns images of a specified size, where size can be one of: icon, small, medium, large, xlarge, xxlarge, and huge.
- parameter imgType
Returns images of a type, which can be one of: clipart, face, lineart, news, and photo.
- parameter linkSite
Specifies that all search results should contain a link to a particular URL
- parameter lowRange
Creates a range in form as_nlo value..as_nhi value and attempts to append it to query
- parameter lr
The language restriction for the search results
- parameter 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
- parameter relatedSite
Specifies that all search results should be pages that are related to the specified URL
- parameter rights
Filters based on licensing. Supported values include: cc_publicdomain, cc_attribute, cc_sharealike, cc_noncommercial, cc_nonderived and combinations of these.
- parameter searchType
Specifies the search type: image.
- parameter siteSearch
Specifies all search results should be pages from a given site
- parameter siteSearchFilter
Controls whether to include or exclude results from the site named in the as_sitesearch parameter
- parameter sort
The sort expression to apply to the results
- parameter start
The index of the first result to return
- parameter q
Query