Copyright	(c) 2015-2016 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None
Language	Haskell2010

Network.Google.Resource.Surveys.Results.Get

Contents

REST Resource
Creating a Request
Request Lenses

Description

Retrieves any survey results that have been produced so far. Results are formatted as an Excel file. You must add "?alt=media" to the URL as an argument to get results.

See: Surveys API Reference for surveys.results.get.

Synopsis

type ResultsGetResource = ("surveys" :> ("v2" :> ("surveys" :> (Capture "surveyUrlId" Text :> ("results" :> (QueryParam "alt" AltJSON :> (ReqBody '[JSON] ResultsGetRequest :> Get '[JSON] SurveyResults))))))) :<|> ("surveys" :> ("v2" :> ("surveys" :> (Capture "surveyUrlId" Text :> ("results" :> (QueryParam "alt" AltMedia :> Get '[OctetStream] Stream))))))
resultsGet :: Text -> ResultsGetRequest -> ResultsGet
data ResultsGet
rgSurveyURLId :: Lens' ResultsGet Text
rgPayload :: Lens' ResultsGet ResultsGetRequest

REST Resource

type ResultsGetResource = ("surveys" :> ("v2" :> ("surveys" :> (Capture "surveyUrlId" Text :> ("results" :> (QueryParam "alt" AltJSON :> (ReqBody '[JSON] ResultsGetRequest :> Get '[JSON] SurveyResults))))))) :<|> ("surveys" :> ("v2" :> ("surveys" :> (Capture "surveyUrlId" Text :> ("results" :> (QueryParam "alt" AltMedia :> Get '[OctetStream] Stream)))))) Source #

A resource alias for surveys.results.get method which the ResultsGet request conforms to.

Creating a Request

resultsGet Source #

Arguments

:: Text	`rgSurveyURLId`
-> ResultsGetRequest	`rgPayload`
-> ResultsGet

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

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

rgSurveyURLId
rgPayload

data ResultsGet Source #

Retrieves any survey results that have been produced so far. Results are formatted as an Excel file. You must add "?alt=media" to the URL as an argument to get results.

See: resultsGet smart constructor.

Instances

Eq ResultsGet Source #
Instance details Defined in Network.Google.Resource.Surveys.Results.Get Methods (==) :: ResultsGet -> ResultsGet -> Bool # (/=) :: ResultsGet -> ResultsGet -> Bool #
Data ResultsGet Source #
Instance details Defined in Network.Google.Resource.Surveys.Results.Get Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ResultsGet -> c ResultsGet # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ResultsGet # toConstr :: ResultsGet -> Constr # dataTypeOf :: ResultsGet -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c ResultsGet) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ResultsGet) # gmapT :: (forall b. Data b => b -> b) -> ResultsGet -> ResultsGet # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ResultsGet -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ResultsGet -> r # gmapQ :: (forall d. Data d => d -> u) -> ResultsGet -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> ResultsGet -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> ResultsGet -> m ResultsGet # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ResultsGet -> m ResultsGet # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ResultsGet -> m ResultsGet #
Show ResultsGet Source #
Instance details Defined in Network.Google.Resource.Surveys.Results.Get Methods showsPrec :: Int -> ResultsGet -> ShowS # show :: ResultsGet -> String # showList :: [ResultsGet] -> ShowS #
Generic ResultsGet Source #
Instance details Defined in Network.Google.Resource.Surveys.Results.Get Associated Types type Rep ResultsGet :: Type -> Type # Methods from :: ResultsGet -> Rep ResultsGet x # to :: Rep ResultsGet x -> ResultsGet #
GoogleRequest ResultsGet Source #
Instance details Defined in Network.Google.Resource.Surveys.Results.Get Associated Types type Rs ResultsGet :: Type # type Scopes ResultsGet :: [Symbol] # Methods requestClient :: ResultsGet -> GClient (Rs ResultsGet) #
GoogleRequest (MediaDownload ResultsGet) Source #
Instance details Defined in Network.Google.Resource.Surveys.Results.Get Associated Types type Rs (MediaDownload ResultsGet) :: Type # type Scopes (MediaDownload ResultsGet) :: [Symbol] # Methods requestClient :: MediaDownload ResultsGet -> GClient (Rs (MediaDownload ResultsGet)) #
type Rep ResultsGet Source #
Instance details Defined in Network.Google.Resource.Surveys.Results.Get type Rep ResultsGet = D1 (MetaData "ResultsGet" "Network.Google.Resource.Surveys.Results.Get" "gogol-surveys-0.4.0-JDdOowllRumLCrJvGPiXO8" False) (C1 (MetaCons "ResultsGet'" PrefixI True) (S1 (MetaSel (Just "_rgSurveyURLId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text) :*: S1 (MetaSel (Just "_rgPayload") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 ResultsGetRequest)))
type Scopes ResultsGet Source #
Instance details Defined in Network.Google.Resource.Surveys.Results.Get type Scopes ResultsGet = "https://www.googleapis.com/auth/surveys" ': ("https://www.googleapis.com/auth/surveys.readonly" ': ("https://www.googleapis.com/auth/userinfo.email" ': ([] :: [Symbol])))
type Rs ResultsGet Source #
Instance details Defined in Network.Google.Resource.Surveys.Results.Get type Rs ResultsGet = SurveyResults
type Scopes (MediaDownload ResultsGet) Source #
Instance details Defined in Network.Google.Resource.Surveys.Results.Get type Scopes (MediaDownload ResultsGet) = Scopes ResultsGet
type Rs (MediaDownload ResultsGet) Source #
Instance details Defined in Network.Google.Resource.Surveys.Results.Get type Rs (MediaDownload ResultsGet) = Stream

Request Lenses

rgSurveyURLId :: Lens' ResultsGet Text Source #

External URL ID for the survey.

rgPayload :: Lens' ResultsGet ResultsGetRequest Source #

Multipart request metadata.