We will be winding down Google Business Messages on July 31, 2024. Read more
here.
SurveyResponse
Stay organized with collections
Save and categorize content based on your preferences.
| JSON representation |
{
"survey": string,
"rating": enum (SurveyRating),
"feedback": string,
"createTime": string,
"surveyQuestionId": string,
"questionResponseText": string,
"questionResponsePostbackData": string,
"questionType": enum (SurveyQuestionType),
"questionIndex": integer,
"totalQuestionCount": integer,
"surveyTriggerSource": enum (SurveyTriggerSource)
} |
| Fields |
survey |
string
The survey that was sent to the user. Resolves to "conversations/{conversationId}/surveys/{surveyId}", where {conversationId} is the unique ID for the conversation and {surveyId} is the unique ID for the survey.
|
rating |
enum (SurveyRating)
A rating from the user.
|
feedback |
string
Text feedback from the user. Optional.
|
createTime |
string (Timestamp format)
The time that the survey was responded. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
|
surveyQuestionId |
string
The unique identifier of the question.
|
questionResponseText |
string
The text that the user tapped as the question response.
|
questionResponsePostbackData |
string
The postback data for the question response the user tapped
|
questionType |
enum (SurveyQuestionType)
Type of the question.
|
questionIndex |
integer
The index of the question in the survey.
|
totalQuestionCount |
integer
The number of total questions in the survey.
|
surveyTriggerSource |
enum (SurveyTriggerSource)
The trigger source of the survey.
|
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-11-14 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2024-11-14 UTC."],[[["\u003cp\u003eA survey response object contains user's rating, feedback, and response time.\u003c/p\u003e\n"],["\u003cp\u003eIt includes details like survey and question IDs, response text and postback data.\u003c/p\u003e\n"],["\u003cp\u003eQuestion type, index within the survey, and total question count are also provided.\u003c/p\u003e\n"],["\u003cp\u003eThe source that triggered the survey is identified in the \u003ccode\u003esurveyTriggerSource\u003c/code\u003e field.\u003c/p\u003e\n"]]],[],null,["# SurveyResponse\n\nA survey response.\n\n| JSON representation |\n|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"survey\": string, \"rating\": enum (/business-communications/business-messages/reference/rest/v1/SurveyRating), \"feedback\": string, \"createTime\": string, \"surveyQuestionId\": string, \"questionResponseText\": string, \"questionResponsePostbackData\": string, \"questionType\": enum (/business-communications/business-messages/reference/rest/v1/SurveyQuestionType), \"questionIndex\": integer, \"totalQuestionCount\": integer, \"surveyTriggerSource\": enum (/business-communications/business-messages/reference/rest/v1/SurveyTriggerSource) } ``` |\n\n| Fields ||\n|--------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `survey` | `string` The survey that was sent to the user. Resolves to \"conversations/{conversationId}/surveys/{surveyId}\", where {conversationId} is the unique ID for the conversation and {surveyId} is the unique ID for the survey. |\n| `rating` | `enum (`[SurveyRating](/business-communications/business-messages/reference/rest/v1/SurveyRating)`)` A rating from the user. |\n| `feedback` | `string` Text feedback from the user. Optional. |\n| `createTime` | `string (`[Timestamp](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.Timestamp)` format)` The time that the survey was responded. A timestamp in RFC3339 UTC \"Zulu\" format, with nanosecond resolution and up to nine fractional digits. Examples: `\"2014-10-02T15:01:23Z\"` and `\"2014-10-02T15:01:23.045123456Z\"`. |\n| `surveyQuestionId` | `string` The unique identifier of the question. |\n| `questionResponseText` | `string` The text that the user tapped as the question response. |\n| `questionResponsePostbackData` | `string` The postback data for the question response the user tapped |\n| `questionType` | `enum (`[SurveyQuestionType](/business-communications/business-messages/reference/rest/v1/SurveyQuestionType)`)` Type of the question. |\n| `questionIndex` | `integer` The index of the question in the survey. |\n| `totalQuestionCount` | `integer` The number of total questions in the survey. |\n| `surveyTriggerSource` | `enum (`[SurveyTriggerSource](/business-communications/business-messages/reference/rest/v1/SurveyTriggerSource)`)` The trigger source of the survey. |"]]