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 |
Creates and conducts surveys, lists the surveys that an authenticated user owns, and retrieves survey results and information about specified surveys.
Synopsis
- surveysService :: ServiceConfig
- surveysScope :: Proxy '["https://www.googleapis.com/auth/surveys"]
- userInfoEmailScope :: Proxy '["https://www.googleapis.com/auth/userinfo.email"]
- surveysReadOnlyScope :: Proxy '["https://www.googleapis.com/auth/surveys.readonly"]
- type SurveysAPI = ResultsGetResource :<|> (SurveysInsertResource :<|> (SurveysListResource :<|> (SurveysStartResource :<|> (SurveysGetResource :<|> (SurveysStopResource :<|> (SurveysDeleteResource :<|> SurveysUpdateResource))))))
- module Network.Google.Resource.Surveys.Results.Get
- module Network.Google.Resource.Surveys.Surveys.Delete
- module Network.Google.Resource.Surveys.Surveys.Get
- module Network.Google.Resource.Surveys.Surveys.Insert
- module Network.Google.Resource.Surveys.Surveys.List
- module Network.Google.Resource.Surveys.Surveys.Start
- module Network.Google.Resource.Surveys.Surveys.Stop
- module Network.Google.Resource.Surveys.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 TokenPagination
- tokenPagination :: TokenPagination
- tpNextPageToken :: Lens' TokenPagination (Maybe Text)
- tpPreviousPageToken :: Lens' TokenPagination (Maybe Text)
- data ResultsGetRequest
- resultsGetRequest :: ResultsGetRequest
- rgrResultMask :: Lens' ResultsGetRequest (Maybe ResultsMask)
- 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)
- 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
surveysService :: ServiceConfig Source #
Default request referring to version v2
of the Surveys API. This contains the host and root path used as a starting point for constructing service requests.
OAuth Scopes
surveysScope :: Proxy '["https://www.googleapis.com/auth/surveys"] Source #
View and manage your surveys and results
userInfoEmailScope :: Proxy '["https://www.googleapis.com/auth/userinfo.email"] Source #
View your email address
surveysReadOnlyScope :: Proxy '["https://www.googleapis.com/auth/surveys.readonly"] Source #
View your surveys and survey results
API Declaration
type SurveysAPI = ResultsGetResource :<|> (SurveysInsertResource :<|> (SurveysListResource :<|> (SurveysStartResource :<|> (SurveysGetResource :<|> (SurveysStopResource :<|> (SurveysDeleteResource :<|> SurveysUpdateResource)))))) Source #
Represents the entirety of the methods and resources available for the Surveys API service.
Resources
surveys.results.get
surveys.surveys.delete
surveys.surveys.get
surveys.surveys.insert
surveys.surveys.list
surveys.surveys.start
surveys.surveys.stop
surveys.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.
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:
PageInfo
Instances
Eq PageInfo Source # | |
Data PageInfo Source # | |
Defined in Network.Google.Surveys.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.Surveys.Types.Product | |
FromJSON PageInfo Source # | |
type Rep PageInfo Source # | |
Defined in Network.Google.Surveys.Types.Product type Rep PageInfo = D1 (MetaData "PageInfo" "Network.Google.Surveys.Types.Product" "gogol-surveys-0.4.0-JDdOowllRumLCrJvGPiXO8" 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.Surveys.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.Surveys.Types.Product | |
FromJSON FieldMask Source # | |
type Rep FieldMask Source # | |
Defined in Network.Google.Surveys.Types.Product type Rep FieldMask = D1 (MetaData "FieldMask" "Network.Google.Surveys.Types.Product" "gogol-surveys-0.4.0-JDdOowllRumLCrJvGPiXO8" 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
Representation of an individual survey object.
See: survey
smart constructor.
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:
sAudience :: Lens' Survey (Maybe SurveyAudience) Source #
Targeting-criteria message containing demographic information
sOwners :: Lens' Survey [Text] Source #
List of email addresses for survey owners. Must contain at least the address of the user making the API call.
sWantedResponseCount :: Lens' Survey (Maybe Int32) Source #
Number of responses desired for the survey.
sSurveyURLId :: Lens' Survey (Maybe Text) Source #
Unique survey ID, that is viewable in the URL of the Survey Creator UI
sCost :: Lens' Survey (Maybe SurveyCost) Source #
Cost to run the survey and collect the necessary number of responses.
sRejectionReason :: Lens' Survey (Maybe SurveyRejection) Source #
Reason for the survey being rejected. Only present if the survey state is rejected.
sCustomerData :: Lens' Survey (Maybe ByteString) Source #
Additional information to store on behalf of the API consumer and associate with this question. This binary blob is treated as opaque. This field is limited to 64K bytes.
sQuestions :: Lens' Survey [SurveyQuestion] Source #
List of questions defining the survey.
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 #
Message representing why the survey was rejected from review, if it was.
See: surveyRejection
smart constructor.
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:
srExplanation :: Lens' SurveyRejection (Maybe Text) Source #
A human-readable explanation of what was wrong with the survey.
srType :: Lens' SurveyRejection (Maybe Text) Source #
Which category of rejection this was. See the Google Surveys Help Center for additional details on each category.
SurveyResults
data SurveyResults Source #
Reference to the current results for a given survey.
See: surveyResults
smart constructor.
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:
srStatus :: Lens' SurveyResults (Maybe Text) Source #
Human readable string describing the status of the request.
srSurveyURLId :: Lens' SurveyResults (Maybe Text) Source #
External survey ID as viewable by survey owners in the editor view.
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 #
- Deprecated* Threshold to start a survey automatically if the quoted prices is less than or equal to this value. See Survey.Cost for more details. This will no longer be available after June 2018.
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 #
Container object for image data and alt_text.
See: surveyQuestionImage
smart constructor.
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:
sqiData :: Lens' SurveyQuestionImage (Maybe ByteString) Source #
Inline jpeg, gif, tiff, bmp, or png image raw bytes for an image question types.
sqiAltText :: Lens' SurveyQuestionImage (Maybe Text) Source #
The alt text property used in image tags is required for all images.
SurveyAudience
data SurveyAudience Source #
Specifications for the target audience of a survey run through the API.
See: surveyAudience
smart constructor.
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:
saCountry :: Lens' SurveyAudience (Maybe Text) Source #
Required country code that surveys should be targeted to. Accepts standard ISO 3166-1 2 character language codes. For instance, 'US' for the United States, and 'GB' for the United Kingdom.
saAges :: Lens' SurveyAudience [Text] Source #
Optional list of age buckets to target. Supported age buckets are: ['18-24', '25-34', '35-44', '45-54', '55-64', '65+']
saLanguages :: Lens' SurveyAudience [Text] Source #
Language code that surveys should be targeted to. For instance, 'en-US'. Surveys may target bilingual users by specifying a list of language codes (for example, 'de' and 'en-US'). In that case, all languages will be used for targeting users but the survey content (which is displayed) must match the first language listed. Accepts standard BCP47 language codes. See specification.
saCountrySubdivision :: Lens' SurveyAudience (Maybe Text) Source #
Country subdivision (states/provinces/etc) that surveys should be targeted to. For all countries except GB, ISO-3166-2 subdivision code is required (eg. 'US-OH' for Ohio, United States). For GB, NUTS 1 statistical region codes for the United Kingdom is required (eg. 'UK-UKC' for North East England).
saPopulationSource :: Lens' SurveyAudience (Maybe Text) Source #
Online population source where the respondents are sampled from.
SurveyCost
data SurveyCost Source #
Message defining the cost to run a given survey through API.
See: surveyCost
smart constructor.
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:
scCurrencyCode :: Lens' SurveyCost (Maybe Text) Source #
Currency code that the cost is given in.
scNanos :: Lens' SurveyCost (Maybe Int64) Source #
Cost of survey in nano units of the given currency. DEPRECATED in favor of cost_per_response_nanos
scMaxCostPerResponseNanos :: Lens' SurveyCost (Maybe Int64) Source #
- Deprecated* Threshold to start a survey automatically if the quoted price is at most this value. When a survey has a Screener (threshold) question, it must go through an incidence pricing test to determine the final cost per response. Typically you will have to make a followup call to start the survey giving the final computed cost per response. If the survey has no threshold_answers, setting this property will return an error. By specifying this property, you indicate the max price per response you are willing to pay in advance of the incidence test. If the price turns out to be lower than the specified value, the survey will begin immediately and you will be charged at the rate determined by the incidence pricing test. If the price turns out to be greater than the specified value the survey will not be started and you will instead be notified what price was determined by the incidence test. At that point, you must raise the value of this property to be greater than or equal to that cost before attempting to start the survey again. This will immediately start the survey as long the incidence test was run within the last 21 days. This will no longer be available after June 2018.
scCostPerResponseNanos :: Lens' SurveyCost (Maybe Int64) Source #
Cost per survey response in nano units of the given currency. To get the total cost for a survey, multiply this value by wanted_response_count.
SurveyQuestion
data SurveyQuestion Source #
Message defining the question specifications.
See: surveyQuestion
smart constructor.
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:
sqSingleLineResponse :: Lens' SurveyQuestion (Maybe Bool) Source #
Option to allow multiple line open text responses instead of a single line response. Note that we don't show auto-complete suggestions with multiple line responses.
sqMustPickSuggestion :: Lens' SurveyQuestion (Maybe Bool) Source #
Option to force the user to pick one of the open text suggestions. This requires that suggestions are provided for this question.
sqSentimentText :: Lens' SurveyQuestion (Maybe Text) Source #
Used by the Rating Scale with Text question type. This text goes along with the question field that is presented to the respondent, and is the actual text that the respondent is asked to rate.
sqThresholdAnswers :: Lens' SurveyQuestion [Text] Source #
The threshold/screener answer options, which will screen a user into the rest of the survey. These will be a subset of the answer option strings.
sqHasOther :: Lens' SurveyQuestion (Maybe Bool) Source #
Option to allow open-ended text box for Single Answer and Multiple Answer question types. This can be used with SINGLE_ANSWER, SINGLE_ANSWER_WITH_IMAGE, MULTIPLE_ANSWERS, and MULTIPLE_ANSWERS_WITH_IMAGE question types.
sqOpenTextSuggestions :: Lens' SurveyQuestion [Text] Source #
A list of suggested answers for open text question auto-complete. This is only valid if single_line_response is true.
sqVideoId :: Lens' SurveyQuestion (Maybe Text) Source #
The YouTube video ID to be show in video questions.
sqLastAnswerPositionPinned :: Lens' SurveyQuestion (Maybe Bool) Source #
Currently only support pinning an answer option to the last position.
sqAnswerOrder :: Lens' SurveyQuestion (Maybe Text) Source #
The randomization option for multiple choice and multi-select questions. If not specified, this option defaults to randomize.
sqOpenTextPlaceholder :: Lens' SurveyQuestion (Maybe Text) Source #
Placeholder text for an open text question.
sqType :: Lens' SurveyQuestion (Maybe Text) Source #
Required field defining the question type. For details about configuring different type of questions, consult the question configuration guide.
sqUnitOfMeasurementLabel :: Lens' SurveyQuestion (Maybe Text) Source #
Optional unit of measurement for display (for example: hours, people, miles).
sqHighValueLabel :: Lens' SurveyQuestion (Maybe Text) Source #
For rating questions, the text for the higher end of the scale, such as 'Best'. For numeric questions, a string representing a floating-point that is the maximum allowed number for a response.
sqQuestion :: Lens' SurveyQuestion (Maybe Text) Source #
Required question text shown to the respondent.
sqNumStars :: Lens' SurveyQuestion (Maybe Text) Source #
Number of stars to use for ratings questions.
sqLowValueLabel :: Lens' SurveyQuestion (Maybe Text) Source #
For rating questions, the text for the lower end of the scale, such as 'Worst'. For numeric questions, a string representing a floating-point that is the minimum allowed number for a response.