Objects - Charter Docs

Model tree

FormsCreateBody

The body of a create-form request.

Field	Type	Description
`info` *	Info	Required. The title and description of the form. Only the title and the document title are copied to the new form.

Info

The general information for a form.

Field	Type	Description
`title` *	`string`	Required. The title of the form which is visible to responders.
`documentTitle`	`string` create	Output only. The title of the document which is visible in Drive. If `Info.title` is empty, `documentTitle` may appear in its place in the Google Forms UI and be visible to responders. `documentTitle` can be set on create, but cannot be modified by a batchUpdate request. Please use the Google Drive API if you need to programmatically update `documentTitle`.

BatchUpdateFormBody

The body of a batch-update request.

Field	Type	Description
`includeFormInResponse`	`boolean`	Whether to return an updated version of the model in the response.
`requests` *	Request[]	Required. The update requests of this batch. Each entry sets exactly one kind of request, and they apply in order against a form that shifts as they do: a create_item at index 2 moves every later item down, so order several insertions back-to-front, or state each location against the form as it will be by then.
`writeControl`	WriteControl	Provides control over how write requests are executed.

Request

The kinds of update requests that can be made.

Field	Type	Description
`updateFormInfo`	UpdateFormInfoRequest	Update Form’s Info.
`updateSettings`	UpdateSettingsRequest	Updates the Form’s settings.
`createItem`	CreateItemRequest	Create a new item.
`moveItem`	MoveItemRequest	Move an item to a specified location.
`deleteItem`	DeleteItemRequest	Delete an item.
`updateItem`	UpdateItemRequest	Update an item.

UpdateFormInfoRequest

Update Form’s Info.

Field	Type	Description
`info`	UpdateFormInfo	The info to update.
`updateMask` *	FieldMask field_mask	Required. Only values named in this mask are changed. At least one field must be specified. The root `info` is implied and should not be specified. A single `"*"` can be used as short-hand for updating every field.

UpdateFormInfo

Info, with every field optional.

Field	Type	Description
`title`	`string`	Required. The title of the form which is visible to responders.
`description`	`string` update	The description of the form.

FieldMask

FieldMask represents a set of symbolic field paths.

Field	Type	Description
`paths` *	`string`[]	The set of field mask paths. Each path is a dot-separated sequence of camelCase field names, e.g. ‘userEnteredValue’ or ‘userEnteredFormat.horizontalAlignment’.

UpdateSettingsRequest

Update Form’s FormSettings.

Field	Type	Description
`settings` *	FormSettings	Required. The settings to update with.
`updateMask` *	FieldMask field_mask	Required. Only values named in this mask are changed. At least one field must be specified. The root `settings` is implied and should not be specified. A single `"*"` can be used as short-hand for updating every field.

FormSettings

A form’s settings.

Field	Type	Description
`quizSettings`	QuizSettings	Settings related to quiz forms and grading.
`emailCollectionType`	EmailCollectionType	Optional. The setting that determines whether the form collects email addresses from respondents. If the form collects email addresses, the values are populated in the `formResponse.respondentEmail` field.

QuizSettings

Settings related to quiz forms and grading.

Field	Type	Description
`isQuiz`	`boolean`	Whether this form is a quiz or not. When true, responses are graded based on question `Grading`. Upon setting to false, all question `Grading` is deleted.

CreateItemRequest

Create an item in a form.

Field	Type	Description
`item` *	Item	Required. The item to create.
`location` *	Location	Required. Where to place the new item.

Item

A single item of the form. kind defines which kind of item it is.

Field	Type	Description
`itemId`	`string`	The item ID. On creation, it can be provided but the ID must not be already used in the form. If not provided, a new ID is assigned.
`title`	`string`	The title of the item.
`description`	`string`	The description of the item.
`questionItem`	QuestionItem	Poses a question to the user.
`questionGroupItem`	QuestionGroupItem	Poses one or more questions to the user with a single major prompt.
`pageBreakItem`	PageBreakItem	Starts a new page with a title.
`textItem`	TextItem	Displays a title and description on the page.
`imageItem`	ImageItem	Displays an image on the page.
`videoItem`	VideoItem	Displays a video on the page.

QuestionItem

A form item containing a single question.

Field	Type	Description
`question` *	Question	Required. The displayed question.
`image`	Image	The image displayed within the question.

Question

Any question. The specific type of question is known by its kind.

Field	Type	Description
`questionId`	`string`	Read only. The question ID. On creation, it can be provided but the ID must not be already used in the form. If not provided, a new ID is assigned.
`required`	`boolean`	Whether the question must be answered in order for a respondent to submit their response.
`grading`	Grading	Grading setup for the question.
`choiceQuestion`	ChoiceQuestion	A respondent can choose from a pre-defined set of options.
`textQuestion`	TextQuestion	A respondent can enter a free text response.
`scaleQuestion`	ScaleQuestion	A respondent can choose a number from a range.
`dateQuestion`	DateQuestion	A respondent can enter a date.
`timeQuestion`	TimeQuestion	A respondent can enter a time.
`fileUploadQuestion`	FileUploadQuestion	A respondent can upload one or more files.
`rowQuestion`	RowQuestion	A row of a `QuestionGroupItem`.
`ratingQuestion`	RatingQuestion	A respondent can choose a rating from a pre-defined set of icons.

Grading

Grading for a single question.

Field	Type	Description
`pointValue` *	`integer`	Required. The maximum number of points a respondent can automatically get for a correct answer. This must not be negative. ≥ 0
`correctAnswers` *	CorrectAnswers	Required. The answer key for the question. Responses are automatically graded based on this field.
`whenRight`	Feedback	The feedback displayed for correct responses. This feedback can only be set for multiple choice questions that have correct answers provided.
`whenWrong`	Feedback	The feedback displayed for incorrect responses. This feedback can only be set for multiple choice questions that have correct answers provided.
`generalFeedback`	Feedback	The feedback displayed for all answers. This is commonly used for short answer questions when a quiz owner wants to quickly give respondents some sense of whether they answered the question correctly before they’ve had a chance to officially grade the response. General feedback cannot be set for automatically graded multiple choice questions.

CorrectAnswers

The answer key for a question.

Field	Type	Description
`answers`	CorrectAnswer[]	A list of correct answers. A quiz response can be automatically graded based on these answers. For single-valued questions, a response is marked correct if it matches any value in this list (in other words, multiple correct answers are possible). For multiple-valued (`CHECKBOX`) questions, a response is marked correct if it contains exactly the values in this list.

CorrectAnswer

A single correct answer for a question.

Field	Type	Description
`value` *	`string`	Required. The correct answer value. See the documentation for `TextAnswer.value` for details on how various value types are formatted.

Feedback

Feedback for a respondent about their response to a question.

Field	Type	Description
`text` *	`string`	Required. The main text of the feedback.
`material`	ExtraMaterial[]	Additional information provided as part of the feedback, often used to point the respondent to more reading and resources.

ExtraMaterial

Supplementary material to the feedback.

Field	Type	Description
`link`	TextLink	Text feedback.
`video`	VideoLink	Video feedback.

TextLink

Link for text.

Field	Type	Description
`uri` *	`string`	Required. The URI.
`displayText` *	`string`	Required. Display text for the URI.

VideoLink

Link to a video.

Field	Type	Description
`displayText` *	`string`	Required. The display text for the link.
`youtubeUri`	`string`	The URI of a YouTube video.

ChoiceQuestion

A radio/checkbox/dropdown question.

Field	Type	Description
`type` *	ChoiceType	Required. The type of choice question.
`options` *	Option[]	Required. List of options that a respondent must choose from.
`shuffle`	`boolean`	Whether the options should be displayed in random order for different instances of the quiz. This is often used to prevent cheating by respondents who might be looking at another respondent’s screen, or to address bias in a survey that might be introduced by always putting the same options first or last.

Option

An option for a Choice question.

Field	Type	Description
`value` *	`string`	Required. The choice as presented to the user.
`image`	Image	Display image as an option.
`isOther`	`boolean`	Whether the option is “other”. Currently only applies to `RADIO` and `CHECKBOX` choice types, but is not allowed in a `QuestionGroupItem`.
`goToAction`	GoToAction	Section navigation type. Which section to go to if this option is selected. Currently only applies to `RADIO` and `SELECT` choice type, but is not allowed in a `QuestionGroupItem`.
`goToSectionId`	`string`	Item ID of section header to go to.

Image

Data representing an image.

Field	Type	Description
`altText`	`string`	A description of the image that is shown on hover and read by screenreaders.
`properties`	MediaProperties	Properties of an image.
`sourceUri`	`string` request_only	Input only. The source URI is the URI used to insert the image. The source URI can be empty when fetched. Exactly one image source field must be set when creating new images.

MediaProperties

Properties of the media.

Field	Type	Description
`alignment`	Alignment	Position of the media.
`width`	`integer`	The width of the media in pixels. When the media is displayed, it is scaled to the smaller of this value or the width of the displayed form. The original aspect ratio of the media is preserved. If a width is not specified when the media is added to the form, it is set to the width of the media source. Width must be between 0 and 740, inclusive. Setting width to 0 or unspecified is only permitted when updating the media source. ≥ 0; ≤ 740

TextQuestion

A text-based question.

Field	Type	Description
`paragraph`	`boolean`	Whether the question is a paragraph question or not. If not, the question is a short text question.

ScaleQuestion

A scale question. The user has a range of numeric values to choose from.

Field	Type	Description
`low` *	`integer`	Required. The lowest possible value for the scale.
`high` *	`integer`	Required. The highest possible value for the scale.
`lowLabel`	`string`	The label to display describing the lowest point on the scale.
`highLabel`	`string`	The label to display describing the highest point on the scale.

DateQuestion

A date question. Date questions default to just month + day.

Field	Type	Description
`includeTime`	`boolean`	Whether to include the time as part of the question.
`includeYear`	`boolean`	Whether to include the year as part of the question.

TimeQuestion

A time question.

Field	Type	Description
`duration`	`boolean`	`true` if the question is about an elapsed time. Otherwise it is about a time of day.

FileUploadQuestion

A file upload question.

Field	Type	Description
`folderId` *	`string`	Required. The ID of the Drive folder where uploaded files are stored.
`types`	FileType[]	File types accepted by this question.
`maxFiles`	`integer`	Maximum number of files that can be uploaded for this question in a single response.
`maxFileSize`	`string`	Maximum number of bytes allowed for any single file uploaded to this question. An int64, which this API carries as a string.

RowQuestion

Configuration for a question that is part of a question group.

Field	Type	Description
`title` *	`string`	Required. The title for the single row in the `QuestionGroupItem`.

RatingQuestion

A rating question. The user has a range of icons to choose from.

Field	Type	Description
`ratingScaleLevel` *	`integer`	Required. The rating scale level of the rating question.
`iconType` *	RatingIconType	Required. The icon type to use for the rating.

QuestionGroupItem

Defines a question that comprises multiple questions grouped together.

Field	Type	Description
`questions` *	Question[]	Required. A list of questions that belong in this question group. A question must only belong to one group. The `kind` of the group may affect what types of questions are allowed.
`image`	Image	The image displayed within the question group above the specific questions.
`grid`	Grid	The question group is a grid with rows of multiple choice questions that share the same options. When `grid` is set, all questions in the group must be of kind `row`.

Grid

A grid of choices (radio or check boxes) with each row constituting a separate question. Each row has the same choices, which are shown as the columns.

Field	Type	Description
`columns` *	ChoiceQuestion	Required. The choices shared by each question in the grid. In other words, the values of the columns. Only `CHECK_BOX` and `RADIO` choices are allowed.
`shuffleQuestions`	`boolean`	If `true`, the questions are randomly ordered. In other words, the rows appear in a different order for every respondent.

PageBreakItem

A page break. The title and description of this item are shown at the top of the new page. This object has no settable fields.

TextItem

A text item. This object has no settable fields.

ImageItem

An item containing an image.

Field	Type	Description
`image` *	Image	Required. The image displayed in the item.

VideoItem

An item containing a video.

Field	Type	Description
`video` *	Video	Required. The video displayed in the item.
`caption`	`string`	The text displayed below the video.

Video

Data representing a video.

Field	Type	Description
`youtubeUri` *	`string`	Required. A YouTube URI.
`properties`	MediaProperties	Properties of a video.

Location

A specific location in a form.

Field	Type	Description
`index`	`integer`	The index of an item in the form. This must be in the range `[0..N)`, where N is the number of items in the form. ≥ 0

MoveItemRequest

Move an item in a form.

Field	Type	Description
`originalLocation` *	Location	Required. The location of the item to move.
`newLocation` *	Location	Required. The new location for the item.

DeleteItemRequest

Delete an item in a form.

Field	Type	Description
`location` *	Location	Required. The location of the item to delete.

UpdateItemRequest

Update an item in a form.

Field	Type	Description
`item` *	Item	Required. New values for the item. Note that item and question IDs are used if they are provided (and are in the field mask). If an ID is blank (and in the field mask) a new ID is generated. This means you can modify an item by getting the form via `forms.get`, modifying your local copy of that item to be how you want it, and using `UpdateItemRequest` to write it back, with the IDs being the same (or not in the field mask).
`location` *	Location	Required. The location identifying the item to update.
`updateMask` *	FieldMask field_mask	Required. Only values named in this mask are changed. This is a comma-separated list of fully qualified names of fields. Example: `"user.displayName,photo"`.

WriteControl

Provides control over how write requests are executed.

Field	Type	Description
`requiredRevisionId`	`string`	The revision ID of the form that the write request is applied to. If this is not the latest revision of the form, the request is not processed and returns a 400 bad request error.
`targetRevisionId`	`string`	The target revision ID of the form that the write request is applied to. If changes have occurred after this revision, the changes in this update request are transformed against those changes. This results in a new revision of the form that incorporates both the changes in the request and the intervening changes, with the server resolving conflicting changes. The target revision ID may only be used to write to recent versions of a form. If the target revision is too far behind the latest revision, the request is not processed and returns a 400 (Bad Request Error). The request may be retried after reading the latest version of the form. In most cases a target revision ID remains valid for several minutes after it is read, but for frequently-edited forms this window may be shorter.

SetPublishSettingsBody

The body of a set-publish-settings request.

Field	Type	Description
`publishSettings` *	PublishSettings	Required. The desired publish settings to apply to the form.
`updateMask`	FieldMask field_mask	Optional. The `publishSettings` fields to update. This field mask accepts the following values: `publishState`, which updates or replaces all `publishState` settings, and `"*"`, which updates or replaces all `publishSettings` fields.

PublishSettings

The publishing settings of a form.

Field	Type	Description
`publishState`	PublishState	Optional. The publishing state of a form. When updating `publishState`, both `isPublished` and `isAcceptingResponses` must be set. However, setting `isAcceptingResponses` to `true` and `isPublished` to `false` isn’t supported and returns an error.

PublishState

The publishing state of a form.

Field	Type	Description
`isPublished` *	`boolean`	Required. Whether the form is published and visible to others.
`isAcceptingResponses` *	`boolean`	Required. Whether the form accepts responses. If `isPublished` is set to `false`, this field is forced to `false`.

Alignment

Value
`ALIGNMENT_UNSPECIFIED`
`LEFT`
`RIGHT`
`CENTER`

ChoiceType

Value
`CHOICE_TYPE_UNSPECIFIED`
`RADIO`
`CHECKBOX`
`DROP_DOWN`

EmailCollectionType

Value
`EMAIL_COLLECTION_TYPE_UNSPECIFIED`
`DO_NOT_COLLECT`
`VERIFIED`
`RESPONDER_INPUT`

FileType

Value
`FILE_TYPE_UNSPECIFIED`
`ANY`
`DOCUMENT`
`PRESENTATION`
`SPREADSHEET`
`DRAWING`
`PDF`
`IMAGE`
`VIDEO`
`AUDIO`

GoToAction

Value
`GO_TO_ACTION_UNSPECIFIED`
`NEXT_SECTION`
`RESTART_FORM`
`SUBMIT_FORM`

RatingIconType

Value
`RATING_ICON_TYPE_UNSPECIFIED`
`STAR`
`HEART`
`THUMB_UP`

​Model tree

​FormsCreateBody

​Info

​BatchUpdateFormBody

​Request

​UpdateFormInfoRequest

​UpdateFormInfo

​FieldMask

​UpdateSettingsRequest

​FormSettings

​QuizSettings

​CreateItemRequest

​Item

​QuestionItem

​Question

​Grading

​CorrectAnswers

​CorrectAnswer

​Feedback

​ExtraMaterial

​TextLink

​VideoLink

​ChoiceQuestion

​Option

​Image

​MediaProperties

​TextQuestion

​ScaleQuestion

​DateQuestion

​TimeQuestion

​FileUploadQuestion

​RowQuestion

​RatingQuestion

​QuestionGroupItem

​Grid

​PageBreakItem

​TextItem

​ImageItem

​VideoItem

​Video

​Location

​MoveItemRequest

​DeleteItemRequest

​UpdateItemRequest

​WriteControl

​SetPublishSettingsBody

​PublishSettings

​PublishState

​Alignment

​ChoiceType

​EmailCollectionType

​FileType

​GoToAction

​RatingIconType