gogol-customsearch-0.4.0: Google CustomSearch SDK.

Copyright(c) 2015-2016 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone
LanguageHaskell2010

Network.Google.Resource.Search.CSE.Siterestrict.List

Contents

Description

Returns metadata about the search performed, metadata about the custom search engine used for the search, and the search results. Uses a small set of url patterns.

See: CustomSearch API Reference for search.cse.siterestrict.list.

Synopsis

REST Resource

type CSESiterestrictListResource = "customsearch" :> ("v1" :> ("siterestrict" :> (QueryParam "q" Text :> (QueryParam "imgDominantColor" CSESiterestrictListImgDominantColor :> (QueryParam "siteSearchFilter" CSESiterestrictListSiteSearchFilter :> (QueryParam "c2coff" Text :> (QueryParam "orTerms" Text :> (QueryParam "start" (Textual Word32) :> (QueryParam "rights" Text :> (QueryParam "excludeTerms" Text :> (QueryParam "num" (Textual Word32) :> (QueryParam "fileType" Text :> (QueryParam "searchType" CSESiterestrictListSearchType :> (QueryParam "lr" CSESiterestrictListLr :> (QueryParam "googlehost" Text :> (QueryParam "relatedSite" Text :> (QueryParam "hl" Text :> (QueryParam "sort" Text :> (QueryParam "siteSearch" Text :> (QueryParam "filter" CSESiterestrictListFilter :> (QueryParam "dateRestrict" Text :> (QueryParam "linkSite" Text :> (QueryParam "lowRange" Text :> (QueryParam "imgType" CSESiterestrictListImgType :> (QueryParam "gl" Text :> (QueryParam "cx" Text :> (QueryParam "imgColorType" CSESiterestrictListImgColorType :> (QueryParam "imgSize" CSESiterestrictListImgSize :> (QueryParam "exactTerms" Text :> (QueryParam "cr" Text :> (QueryParam "safe" CSESiterestrictListSafe :> (QueryParam "hq" Text :> (QueryParam "highRange" Text :> (QueryParam "alt" AltJSON :> Get '[JSON] Search)))))))))))))))))))))))))))))))))) Source #

A resource alias for search.cse.siterestrict.list method which the CSESiterestrictList request conforms to.

Creating a Request

cSESiterestrictList Source #

Arguments

:: Text

cseslQ

-> CSESiterestrictList 

Creates a value of CSESiterestrictList with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

data CSESiterestrictList Source #

Returns metadata about the search performed, metadata about the custom search engine used for the search, and the search results. Uses a small set of url patterns.

See: cSESiterestrictList smart constructor.

Instances
Eq CSESiterestrictList Source # 
Instance details

Defined in Network.Google.Resource.Search.CSE.Siterestrict.List

Methods

(==) :: CSESiterestrictList -> CSESiterestrictList -> Bool #

(/=) :: CSESiterestrictList -> CSESiterestrictList -> Bool #

Data CSESiterestrictList Source # 
Instance details

Defined in Network.Google.Resource.Search.CSE.Siterestrict.List

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> CSESiterestrictList -> c CSESiterestrictList #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c CSESiterestrictList #

toConstr :: CSESiterestrictList -> Constr #

dataTypeOf :: CSESiterestrictList -> DataType #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c CSESiterestrictList) #

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c CSESiterestrictList) #

gmapT :: (forall b. Data b => b -> b) -> CSESiterestrictList -> CSESiterestrictList #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> CSESiterestrictList -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> CSESiterestrictList -> r #

gmapQ :: (forall d. Data d => d -> u) -> CSESiterestrictList -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> CSESiterestrictList -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> CSESiterestrictList -> m CSESiterestrictList #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> CSESiterestrictList -> m CSESiterestrictList #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> CSESiterestrictList -> m CSESiterestrictList #

Show CSESiterestrictList Source # 
Instance details

Defined in Network.Google.Resource.Search.CSE.Siterestrict.List

Methods

showsPrec :: Int -> CSESiterestrictList -> ShowS #

show :: CSESiterestrictList -> String #

showList :: [CSESiterestrictList] -> ShowS #

Generic CSESiterestrictList Source # 
Instance details

Defined in Network.Google.Resource.Search.CSE.Siterestrict.List

Associated Types

type Rep CSESiterestrictList :: Type -> Type #

Methods

from :: CSESiterestrictList -> Rep CSESiterestrictList x #

to :: Rep CSESiterestrictList x -> CSESiterestrictList #

GoogleRequest CSESiterestrictList Source # 
Instance details

Defined in Network.Google.Resource.Search.CSE.Siterestrict.List

Associated Types

type Rs CSESiterestrictList :: Type #

type Scopes CSESiterestrictList :: [Symbol] #

Methods

requestClient :: CSESiterestrictList -> GClient (Rs CSESiterestrictList) #

type Rep CSESiterestrictList Source # 
Instance details

Defined in Network.Google.Resource.Search.CSE.Siterestrict.List

type Rep CSESiterestrictList = D1 (MetaData "CSESiterestrictList" "Network.Google.Resource.Search.CSE.Siterestrict.List" "gogol-customsearch-0.4.0-AJYk0gjb9hHJ6tx06P7CTf" False) (C1 (MetaCons "CSESiterestrictList'" PrefixI True) ((((S1 (MetaSel (Just "_cseslImgDominantColor") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe CSESiterestrictListImgDominantColor)) :*: (S1 (MetaSel (Just "_cseslSiteSearchFilter") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe CSESiterestrictListSiteSearchFilter)) :*: S1 (MetaSel (Just "_cseslC2coff") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 (MetaSel (Just "_cseslOrTerms") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_cseslStart") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Textual Word32)))) :*: (S1 (MetaSel (Just "_cseslRights") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_cseslExcludeTerms") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))) :*: (((S1 (MetaSel (Just "_cseslNum") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Textual Word32)) :*: S1 (MetaSel (Just "_cseslFileType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 (MetaSel (Just "_cseslSearchType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe CSESiterestrictListSearchType)) :*: S1 (MetaSel (Just "_cseslLr") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe CSESiterestrictListLr)))) :*: ((S1 (MetaSel (Just "_cseslQ") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text) :*: S1 (MetaSel (Just "_cseslGooglehost") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 (MetaSel (Just "_cseslRelatedSite") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_cseslHl") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))))) :*: ((((S1 (MetaSel (Just "_cseslSort") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_cseslSiteSearch") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 (MetaSel (Just "_cseslFilter") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe CSESiterestrictListFilter)) :*: S1 (MetaSel (Just "_cseslDateRestrict") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 (MetaSel (Just "_cseslLinkSite") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_cseslLowRange") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 (MetaSel (Just "_cseslImgType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe CSESiterestrictListImgType)) :*: S1 (MetaSel (Just "_cseslGl") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))) :*: (((S1 (MetaSel (Just "_cseslCx") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_cseslImgColorType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe CSESiterestrictListImgColorType))) :*: (S1 (MetaSel (Just "_cseslImgSize") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe CSESiterestrictListImgSize)) :*: S1 (MetaSel (Just "_cseslExactTerms") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 (MetaSel (Just "_cseslCr") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_cseslSafe") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 CSESiterestrictListSafe)) :*: (S1 (MetaSel (Just "_cseslHq") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_cseslHighRange") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))))))
type Scopes CSESiterestrictList Source # 
Instance details

Defined in Network.Google.Resource.Search.CSE.Siterestrict.List

type Scopes CSESiterestrictList = ([] :: [Symbol])
type Rs CSESiterestrictList Source # 
Instance details

Defined in Network.Google.Resource.Search.CSE.Siterestrict.List

type Rs CSESiterestrictList = Search

Request Lenses

cseslImgDominantColor :: Lens' CSESiterestrictList (Maybe CSESiterestrictListImgDominantColor) Source #

Returns images of a specific dominant color: red, orange, yellow, green, teal, blue, purple, pink, white, gray, black and brown.

cseslSiteSearchFilter :: Lens' CSESiterestrictList (Maybe CSESiterestrictListSiteSearchFilter) Source #

Controls whether to include or exclude results from the site named in the as_sitesearch parameter

cseslC2coff :: Lens' CSESiterestrictList (Maybe Text) Source #

Turns off the translation between zh-CN and zh-TW.

cseslOrTerms :: Lens' CSESiterestrictList (Maybe Text) Source #

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

cseslStart :: Lens' CSESiterestrictList (Maybe Word32) Source #

The index of the first result to return

cseslRights :: Lens' CSESiterestrictList (Maybe Text) Source #

Filters based on licensing. Supported values include: cc_publicdomain, cc_attribute, cc_sharealike, cc_noncommercial, cc_nonderived and combinations of these.

cseslExcludeTerms :: Lens' CSESiterestrictList (Maybe Text) Source #

Identifies a word or phrase that should not appear in any documents in the search results

cseslNum :: Lens' CSESiterestrictList Word32 Source #

Number of search results to return

cseslFileType :: Lens' CSESiterestrictList (Maybe Text) Source #

Returns images of a specified type. Some of the allowed values are: bmp, gif, png, jpg, svg, pdf, ...

cseslSearchType :: Lens' CSESiterestrictList (Maybe CSESiterestrictListSearchType) Source #

Specifies the search type: image.

cseslLr :: Lens' CSESiterestrictList (Maybe CSESiterestrictListLr) Source #

The language restriction for the search results

cseslQ :: Lens' CSESiterestrictList Text Source #

Query

cseslGooglehost :: Lens' CSESiterestrictList (Maybe Text) Source #

The local Google domain to use to perform the search.

cseslRelatedSite :: Lens' CSESiterestrictList (Maybe Text) Source #

Specifies that all search results should be pages that are related to the specified URL

cseslHl :: Lens' CSESiterestrictList (Maybe Text) Source #

Sets the user interface language.

cseslSort :: Lens' CSESiterestrictList (Maybe Text) Source #

The sort expression to apply to the results

cseslSiteSearch :: Lens' CSESiterestrictList (Maybe Text) Source #

Specifies all search results should be pages from a given site

cseslFilter :: Lens' CSESiterestrictList (Maybe CSESiterestrictListFilter) Source #

Controls turning on or off the duplicate content filter.

cseslDateRestrict :: Lens' CSESiterestrictList (Maybe Text) Source #

Specifies all search results are from a time period

cseslLinkSite :: Lens' CSESiterestrictList (Maybe Text) Source #

Specifies that all search results should contain a link to a particular URL

cseslLowRange :: Lens' CSESiterestrictList (Maybe Text) Source #

Creates a range in form as_nlo value..as_nhi value and attempts to append it to query

cseslImgType :: Lens' CSESiterestrictList (Maybe CSESiterestrictListImgType) Source #

Returns images of a type, which can be one of: clipart, face, lineart, news, and photo.

cseslGl :: Lens' CSESiterestrictList (Maybe Text) Source #

Geolocation of end user.

cseslCx :: Lens' CSESiterestrictList (Maybe Text) Source #

The custom search engine ID to scope this search query

cseslImgColorType :: Lens' CSESiterestrictList (Maybe CSESiterestrictListImgColorType) Source #

Returns black and white, grayscale, or color images: mono, gray, and color.

cseslImgSize :: Lens' CSESiterestrictList (Maybe CSESiterestrictListImgSize) Source #

Returns images of a specified size, where size can be one of: icon, small, medium, large, xlarge, xxlarge, and huge.

cseslExactTerms :: Lens' CSESiterestrictList (Maybe Text) Source #

Identifies a phrase that all documents in the search results must contain

cseslCr :: Lens' CSESiterestrictList (Maybe Text) Source #

Country restrict(s).

cseslSafe :: Lens' CSESiterestrictList CSESiterestrictListSafe Source #

Search safety level

cseslHq :: Lens' CSESiterestrictList (Maybe Text) Source #

Appends the extra query terms to the query.

cseslHighRange :: Lens' CSESiterestrictList (Maybe Text) Source #

Creates a range in form as_nlo value..as_nhi value and attempts to append it to query