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 |
- Service Configuration
- OAuth Scopes
- API Declaration
- Resources
- consumersurveys.mobileapppanels.get
- consumersurveys.mobileapppanels.list
- consumersurveys.mobileapppanels.update
- consumersurveys.results.get
- consumersurveys.surveys.delete
- consumersurveys.surveys.get
- consumersurveys.surveys.insert
- consumersurveys.surveys.list
- consumersurveys.surveys.start
- consumersurveys.surveys.stop
- consumersurveys.surveys.update
- Types
Creates and conducts surveys, lists the surveys that an authenticated user owns, and retrieves survey results and information about specified surveys.
Synopsis
- consumerSurveysService :: ServiceConfig
- userInfoEmailScope :: Proxy '["https://www.googleapis.com/auth/userinfo.email"]
- consumerSurveysReadOnlyScope :: Proxy '["https://www.googleapis.com/auth/consumersurveys.readonly"]
- consumerSurveysScope :: Proxy '["https://www.googleapis.com/auth/consumersurveys"]
- type ConsumerSurveysAPI = MobileApppanelsListResource :<|> (MobileApppanelsGetResource :<|> (MobileApppanelsUpdateResource :<|> (ResultsGetResource :<|> (SurveysInsertResource :<|> (SurveysListResource :<|> (SurveysStartResource :<|> (SurveysGetResource :<|> (SurveysStopResource :<|> (SurveysDeleteResource :<|> SurveysUpdateResource)))))))))
- module Network.Google.Resource.ConsumerSurveys.MobileApppanels.Get
- module Network.Google.Resource.ConsumerSurveys.MobileApppanels.List
- module Network.Google.Resource.ConsumerSurveys.MobileApppanels.Update
- module Network.Google.Resource.ConsumerSurveys.Results.Get
- module Network.Google.Resource.ConsumerSurveys.Surveys.Delete
- module Network.Google.Resource.ConsumerSurveys.Surveys.Get
- module Network.Google.Resource.ConsumerSurveys.Surveys.Insert
- module Network.Google.Resource.ConsumerSurveys.Surveys.List
- module Network.Google.Resource.ConsumerSurveys.Surveys.Start
- module Network.Google.Resource.ConsumerSurveys.Surveys.Stop
- module Network.Google.Resource.ConsumerSurveys.Surveys.Update
- data SurveysListResponse
- surveysListResponse :: SurveysListResponse
- slrRequestId :: Lens' SurveysListResponse (Maybe Text)
- slrTokenPagination :: Lens' SurveysListResponse (Maybe TokenPagination)
- slrPageInfo :: Lens' SurveysListResponse (Maybe PageInfo)
- slrResources :: Lens' SurveysListResponse [Survey]
- data MobileAppPanel
- mobileAppPanel :: MobileAppPanel
- mapOwners :: Lens' MobileAppPanel [Text]
- mapCountry :: Lens' MobileAppPanel (Maybe Text)
- mapName :: Lens' MobileAppPanel (Maybe Text)
- mapMobileAppPanelId :: Lens' MobileAppPanel (Maybe Text)
- mapLanguage :: Lens' MobileAppPanel (Maybe Text)
- mapIsPublicPanel :: Lens' MobileAppPanel (Maybe Bool)
- data TokenPagination
- tokenPagination :: TokenPagination
- tpNextPageToken :: Lens' TokenPagination (Maybe Text)
- tpPreviousPageToken :: Lens' TokenPagination (Maybe Text)
- data ResultsGetRequest
- resultsGetRequest :: ResultsGetRequest
- rgrResultMask :: Lens' ResultsGetRequest (Maybe ResultsMask)
- data MobileAppPanelsListResponse
- mobileAppPanelsListResponse :: MobileAppPanelsListResponse
- maplrRequestId :: Lens' MobileAppPanelsListResponse (Maybe Text)
- maplrTokenPagination :: Lens' MobileAppPanelsListResponse (Maybe TokenPagination)
- maplrPageInfo :: Lens' MobileAppPanelsListResponse (Maybe PageInfo)
- maplrResources :: Lens' MobileAppPanelsListResponse [MobileAppPanel]
- data PageInfo
- pageInfo :: PageInfo
- piResultPerPage :: Lens' PageInfo (Maybe Int32)
- piTotalResults :: Lens' PageInfo (Maybe Int32)
- piStartIndex :: Lens' PageInfo (Maybe Int32)
- data FieldMask
- fieldMask :: FieldMask
- fmId :: Lens' FieldMask (Maybe Int32)
- fmFields :: Lens' FieldMask [FieldMask]
- data Survey
- survey :: Survey
- sAudience :: Lens' Survey (Maybe SurveyAudience)
- sState :: Lens' Survey (Maybe Text)
- sOwners :: Lens' Survey [Text]
- sWantedResponseCount :: Lens' Survey (Maybe Int32)
- sSurveyURLId :: Lens' Survey (Maybe Text)
- sCost :: Lens' Survey (Maybe SurveyCost)
- sRejectionReason :: Lens' Survey (Maybe SurveyRejection)
- sCustomerData :: Lens' Survey (Maybe ByteString)
- sQuestions :: Lens' Survey [SurveyQuestion]
- sTitle :: Lens' Survey (Maybe Text)
- sDescription :: Lens' Survey (Maybe Text)
- data SurveysStartResponse
- surveysStartResponse :: SurveysStartResponse
- ssrRequestId :: Lens' SurveysStartResponse (Maybe Text)
- data SurveysStopResponse
- surveysStopResponse :: SurveysStopResponse
- sRequestId :: Lens' SurveysStopResponse (Maybe Text)
- data ResultsMask
- resultsMask :: ResultsMask
- rmProjection :: Lens' ResultsMask (Maybe Text)
- rmFields :: Lens' ResultsMask [FieldMask]
- data SurveyRejection
- surveyRejection :: SurveyRejection
- srExplanation :: Lens' SurveyRejection (Maybe Text)
- srType :: Lens' SurveyRejection (Maybe Text)
- data SurveyResults
- surveyResults :: SurveyResults
- srStatus :: Lens' SurveyResults (Maybe Text)
- srSurveyURLId :: Lens' SurveyResults (Maybe Text)
- data SurveysStartRequest
- surveysStartRequest :: SurveysStartRequest
- ssrMaxCostPerResponseNanos :: Lens' SurveysStartRequest (Maybe Int64)
- data SurveysDeleteResponse
- surveysDeleteResponse :: SurveysDeleteResponse
- sdrRequestId :: Lens' SurveysDeleteResponse (Maybe Text)
- data SurveyQuestionImage
- surveyQuestionImage :: SurveyQuestionImage
- sqiData :: Lens' SurveyQuestionImage (Maybe ByteString)
- sqiURL :: Lens' SurveyQuestionImage (Maybe Text)
- sqiAltText :: Lens' SurveyQuestionImage (Maybe Text)
- data SurveyAudience
- surveyAudience :: SurveyAudience
- saCountry :: Lens' SurveyAudience (Maybe Text)
- saAges :: Lens' SurveyAudience [Text]
- saLanguages :: Lens' SurveyAudience [Text]
- saGender :: Lens' SurveyAudience (Maybe Text)
- saMobileAppPanelId :: Lens' SurveyAudience (Maybe Text)
- saCountrySubdivision :: Lens' SurveyAudience (Maybe Text)
- saPopulationSource :: Lens' SurveyAudience (Maybe Text)
- data SurveyCost
- surveyCost :: SurveyCost
- scCurrencyCode :: Lens' SurveyCost (Maybe Text)
- scNanos :: Lens' SurveyCost (Maybe Int64)
- scMaxCostPerResponseNanos :: Lens' SurveyCost (Maybe Int64)
- scCostPerResponseNanos :: Lens' SurveyCost (Maybe Int64)
- data SurveyQuestion
- surveyQuestion :: SurveyQuestion
- sqImages :: Lens' SurveyQuestion [SurveyQuestionImage]
- sqAnswers :: Lens' SurveyQuestion [Text]
- sqSingleLineResponse :: Lens' SurveyQuestion (Maybe Bool)
- sqMustPickSuggestion :: Lens' SurveyQuestion (Maybe Bool)
- sqSentimentText :: Lens' SurveyQuestion (Maybe Text)
- sqThresholdAnswers :: Lens' SurveyQuestion [Text]
- sqHasOther :: Lens' SurveyQuestion (Maybe Bool)
- sqOpenTextSuggestions :: Lens' SurveyQuestion [Text]
- sqVideoId :: Lens' SurveyQuestion (Maybe Text)
- sqLastAnswerPositionPinned :: Lens' SurveyQuestion (Maybe Bool)
- sqAnswerOrder :: Lens' SurveyQuestion (Maybe Text)
- sqOpenTextPlaceholder :: Lens' SurveyQuestion (Maybe Text)
- sqType :: Lens' SurveyQuestion (Maybe Text)
- sqUnitOfMeasurementLabel :: Lens' SurveyQuestion (Maybe Text)
- sqHighValueLabel :: Lens' SurveyQuestion (Maybe Text)
- sqQuestion :: Lens' SurveyQuestion (Maybe Text)
- sqNumStars :: Lens' SurveyQuestion (Maybe Text)
- sqLowValueLabel :: Lens' SurveyQuestion (Maybe Text)
Service Configuration
consumerSurveysService :: ServiceConfig Source #
Default request referring to version v2
of the Consumer Surveys API. This contains the host and root path used as a starting point for constructing service requests.
OAuth Scopes
userInfoEmailScope :: Proxy '["https://www.googleapis.com/auth/userinfo.email"] Source #
View your email address
consumerSurveysReadOnlyScope :: Proxy '["https://www.googleapis.com/auth/consumersurveys.readonly"] Source #
View the results for your surveys
consumerSurveysScope :: Proxy '["https://www.googleapis.com/auth/consumersurveys"] Source #
View and edit your surveys and results
API Declaration
type ConsumerSurveysAPI = MobileApppanelsListResource :<|> (MobileApppanelsGetResource :<|> (MobileApppanelsUpdateResource :<|> (ResultsGetResource :<|> (SurveysInsertResource :<|> (SurveysListResource :<|> (SurveysStartResource :<|> (SurveysGetResource :<|> (SurveysStopResource :<|> (SurveysDeleteResource :<|> SurveysUpdateResource))))))))) Source #
Represents the entirety of the methods and resources available for the Consumer Surveys API service.
Resources
consumersurveys.mobileapppanels.get
consumersurveys.mobileapppanels.list
consumersurveys.mobileapppanels.update
consumersurveys.results.get
consumersurveys.surveys.delete
consumersurveys.surveys.get
consumersurveys.surveys.insert
consumersurveys.surveys.list
consumersurveys.surveys.start
consumersurveys.surveys.stop
consumersurveys.surveys.update
Types
SurveysListResponse
data SurveysListResponse Source #
Instances
surveysListResponse :: SurveysListResponse Source #
Creates a value of SurveysListResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
slrRequestId :: Lens' SurveysListResponse (Maybe Text) Source #
Unique request ID used for logging and debugging. Please include in any error reporting or troubleshooting requests.
slrResources :: Lens' SurveysListResponse [Survey] Source #
An individual survey resource.
MobileAppPanel
data MobileAppPanel Source #
Instances
mobileAppPanel :: MobileAppPanel Source #
Creates a value of MobileAppPanel
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
TokenPagination
data TokenPagination Source #
Instances
tokenPagination :: TokenPagination Source #
Creates a value of TokenPagination
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
ResultsGetRequest
data ResultsGetRequest Source #
Instances
resultsGetRequest :: ResultsGetRequest Source #
Creates a value of ResultsGetRequest
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
MobileAppPanelsListResponse
data MobileAppPanelsListResponse Source #
Instances
mobileAppPanelsListResponse :: MobileAppPanelsListResponse Source #
Creates a value of MobileAppPanelsListResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
maplrRequestId :: Lens' MobileAppPanelsListResponse (Maybe Text) Source #
Unique request ID used for logging and debugging. Please include in any error reporting or troubleshooting requests.
maplrResources :: Lens' MobileAppPanelsListResponse [MobileAppPanel] Source #
An individual predefined panel of Opinion Rewards mobile users.
PageInfo
Instances
Eq PageInfo Source # | |
Data PageInfo Source # | |
Defined in Network.Google.ConsumerSurveys.Types.Product gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> PageInfo -> c PageInfo # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c PageInfo # toConstr :: PageInfo -> Constr # dataTypeOf :: PageInfo -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c PageInfo) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c PageInfo) # gmapT :: (forall b. Data b => b -> b) -> PageInfo -> PageInfo # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> PageInfo -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> PageInfo -> r # gmapQ :: (forall d. Data d => d -> u) -> PageInfo -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> PageInfo -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> PageInfo -> m PageInfo # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> PageInfo -> m PageInfo # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> PageInfo -> m PageInfo # | |
Show PageInfo Source # | |
Generic PageInfo Source # | |
ToJSON PageInfo Source # | |
Defined in Network.Google.ConsumerSurveys.Types.Product | |
FromJSON PageInfo Source # | |
type Rep PageInfo Source # | |
Defined in Network.Google.ConsumerSurveys.Types.Product type Rep PageInfo = D1 (MetaData "PageInfo" "Network.Google.ConsumerSurveys.Types.Product" "gogol-consumersurveys-0.4.0-EOGkJcqKdGTLcleyAq4x9I" False) (C1 (MetaCons "PageInfo'" PrefixI True) (S1 (MetaSel (Just "_piResultPerPage") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Textual Int32))) :*: (S1 (MetaSel (Just "_piTotalResults") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Textual Int32))) :*: S1 (MetaSel (Just "_piStartIndex") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Textual Int32)))))) |
Creates a value of PageInfo
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
FieldMask
Instances
Eq FieldMask Source # | |
Data FieldMask Source # | |
Defined in Network.Google.ConsumerSurveys.Types.Product gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> FieldMask -> c FieldMask # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c FieldMask # toConstr :: FieldMask -> Constr # dataTypeOf :: FieldMask -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c FieldMask) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c FieldMask) # gmapT :: (forall b. Data b => b -> b) -> FieldMask -> FieldMask # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> FieldMask -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> FieldMask -> r # gmapQ :: (forall d. Data d => d -> u) -> FieldMask -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> FieldMask -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> FieldMask -> m FieldMask # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> FieldMask -> m FieldMask # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> FieldMask -> m FieldMask # | |
Show FieldMask Source # | |
Generic FieldMask Source # | |
ToJSON FieldMask Source # | |
Defined in Network.Google.ConsumerSurveys.Types.Product | |
FromJSON FieldMask Source # | |
type Rep FieldMask Source # | |
Defined in Network.Google.ConsumerSurveys.Types.Product type Rep FieldMask = D1 (MetaData "FieldMask" "Network.Google.ConsumerSurveys.Types.Product" "gogol-consumersurveys-0.4.0-EOGkJcqKdGTLcleyAq4x9I" False) (C1 (MetaCons "FieldMask'" PrefixI True) (S1 (MetaSel (Just "_fmId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Textual Int32))) :*: S1 (MetaSel (Just "_fmFields") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [FieldMask])))) |
Survey
Instances
Creates a value of Survey
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
SurveysStartResponse
data SurveysStartResponse Source #
Instances
surveysStartResponse :: SurveysStartResponse Source #
Creates a value of SurveysStartResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
ssrRequestId :: Lens' SurveysStartResponse (Maybe Text) Source #
Unique request ID used for logging and debugging. Please include in any error reporting or troubleshooting requests.
SurveysStopResponse
data SurveysStopResponse Source #
Instances
surveysStopResponse :: SurveysStopResponse Source #
Creates a value of SurveysStopResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
sRequestId :: Lens' SurveysStopResponse (Maybe Text) Source #
Unique request ID used for logging and debugging. Please include in any error reporting or troubleshooting requests.
ResultsMask
data ResultsMask Source #
Instances
resultsMask :: ResultsMask Source #
Creates a value of ResultsMask
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
rmProjection :: Lens' ResultsMask (Maybe Text) Source #
SurveyRejection
data SurveyRejection Source #
Instances
surveyRejection :: SurveyRejection Source #
Creates a value of SurveyRejection
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
SurveyResults
data SurveyResults Source #
Instances
surveyResults :: SurveyResults Source #
Creates a value of SurveyResults
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
SurveysStartRequest
data SurveysStartRequest Source #
Instances
surveysStartRequest :: SurveysStartRequest Source #
Creates a value of SurveysStartRequest
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
ssrMaxCostPerResponseNanos :: Lens' SurveysStartRequest (Maybe Int64) Source #
Threshold to start a survey automically if the quoted prices is less than or equal to this value. See Survey.Cost for more details.
SurveysDeleteResponse
data SurveysDeleteResponse Source #
Instances
surveysDeleteResponse :: SurveysDeleteResponse Source #
Creates a value of SurveysDeleteResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
sdrRequestId :: Lens' SurveysDeleteResponse (Maybe Text) Source #
Unique request ID used for logging and debugging. Please include in any error reporting or troubleshooting requests.
SurveyQuestionImage
data SurveyQuestionImage Source #
Instances
surveyQuestionImage :: SurveyQuestionImage Source #
Creates a value of SurveyQuestionImage
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
SurveyAudience
data SurveyAudience Source #
Instances
surveyAudience :: SurveyAudience Source #
Creates a value of SurveyAudience
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
SurveyCost
data SurveyCost Source #
Instances
surveyCost :: SurveyCost Source #
Creates a value of SurveyCost
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
SurveyQuestion
data SurveyQuestion Source #
Instances
surveyQuestion :: SurveyQuestion Source #
Creates a value of SurveyQuestion
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired: