Skip to main content
Server path: /google-forms | Type: Application | PCID required: Yes

Tools

ToolDescription
google-forms_batch_updateChange the form with a batch of updates.
google-forms_create_formCreate a new form using the title given in the provided form message in the request. Important: Only the form.info.title and form.info.document_title fields are copied to the new form. All other fields including the form description, items and settings are disallowed. To create a new form and add items, you must first call forms.create to create an empty form with a title and (optional) document title, and then call forms.update to add the items.
google-forms_create_watchCreate a new watch. If a watch ID is provided, it must be unused. For each invoking project, the per form limit is one watch per Watch.EventType. A watch expires seven days after it is created (see Watch.expire_time).
google-forms_delete_watchDelete a watch.
google-forms_get_formGet a form.
google-forms_get_responseGet one response from the form.
google-forms_list_responsesList a form’s responses.
google-forms_list_watchesReturn a list of the watches owned by the invoking project. The maximum number of watches is two: For each invoker, the limit is one for each event type per form.
google-forms_renew_watchRenew an existing watch for seven days. The state of the watch after renewal is ACTIVE, and the expire_time is seven days from the renewal. Renewing a watch in an error state (e.g. SUSPENDED) succeeds if the error is no longer present, but fail otherwise. After a watch has expired, RenewWatch returns NOT_FOUND.
google-forms_set_publish_settingsUpdates the publish settings of a form. Legacy forms aren’t supported because they don’t have the publish_settings field.

google-forms_batch_update

Change the form with a batch of updates. Parameters:
ParameterTypeRequiredDefaultDescription
formIdstringYesRequired. The form ID.
includeFormInResponsebooleanNoWhether to return an updated version of the model in the response.
requestsobject[]YesRequired. The update requests of this batch.
writeControlobjectNoProvides control over how write requests are executed.

google-forms_create_form

Create a new form using the title given in the provided form message in the request. Important: Only the form.info.title and form.info.document_title fields are copied to the new form. All other fields including the form description, items and settings are disallowed. To create a new form and add items, you must first call forms.create to create an empty form with a title and (optional) document title, and then call forms.update to add the items. Parameters:
ParameterTypeRequiredDefaultDescription
unpublishedbooleanNoOptional. Whether the form is unpublished. If set to true, the form doesn’t accept responses. If set to false or unset, the form is published and accepts responses.
infoobjectYesThe general information for a form.

google-forms_create_watch

Create a new watch. If a watch ID is provided, it must be unused. For each invoking project, the per form limit is one watch per Watch.EventType. A watch expires seven days after it is created (see Watch.expire_time). Parameters:
ParameterTypeRequiredDefaultDescription
formIdstringYesRequired. ID of the Form to watch.
watchobjectYesA watch for events for a form. When the designated event happens, a notification will be published to the specified target. The notification’s attributes will include a formId key that has the ID of the watched form and an eventType key that has the string of the type. Messages are sent with at-least-once delivery and are only dropped in extraordinary circumstances. Typically all notifications should be reliably delivered within a few seconds; however, in some situations notifications may be delayed. A watch expires seven days after it is created unless it is renewed with watches.renew
watchIdstringNoThe ID to use for the watch. If specified, the ID must not already be in use. If not specified, an ID is generated. This value should be 4-63 characters, and valid characters are /a-z-/.

google-forms_delete_watch

Delete a watch. Parameters:
ParameterTypeRequiredDefaultDescription
formIdstringYesRequired. The ID of the Form.
watchIdstringYesRequired. The ID of the Watch to delete.

google-forms_get_form

Get a form. Parameters:
ParameterTypeRequiredDefaultDescription
formIdstringYesRequired. The form ID.

google-forms_get_response

Get one response from the form. Parameters:
ParameterTypeRequiredDefaultDescription
formIdstringYesRequired. The form ID.
responseIdstringYesRequired. The response ID within the form.

google-forms_list_responses

List a form’s responses. Parameters:
ParameterTypeRequiredDefaultDescription
formIdstringYesRequired. ID of the Form whose responses to list.
filterstringNoWhich form responses to return. Currently, the only supported filters are: * timestamp > N which means to get all form responses submitted after (but not at) timestamp N. * timestamp >= N which means to get all form responses submitted at and after timestamp N. For both supported filters, timestamp must be formatted in RFC3339 UTC “Zulu” format. Examples: “2014-10-02T15:01:23Z” and “2014-10-02T15:01:23.045123456Z”.
pageSizeintegerNoThe maximum number of responses to return. The service may return fewer than this value. If unspecified or zero, at most 5000 responses are returned.
pageTokenstringNoA page token returned by a previous list response. If this field is set, the form and the values of the filter must be the same as for the original request.

google-forms_list_watches

Return a list of the watches owned by the invoking project. The maximum number of watches is two: For each invoker, the limit is one for each event type per form. Parameters:
ParameterTypeRequiredDefaultDescription
formIdstringYesRequired. ID of the Form whose watches to list.

google-forms_renew_watch

Renew an existing watch for seven days. The state of the watch after renewal is ACTIVE, and the expire_time is seven days from the renewal. Renewing a watch in an error state (e.g. SUSPENDED) succeeds if the error is no longer present, but fail otherwise. After a watch has expired, RenewWatch returns NOT_FOUND. Parameters:
ParameterTypeRequiredDefaultDescription
formIdstringYesRequired. The ID of the Form.
watchIdstringYesRequired. The ID of the Watch to renew.

google-forms_set_publish_settings

Updates the publish settings of a form. Legacy forms aren’t supported because they don’t have the publish_settings field. Parameters:
ParameterTypeRequiredDefaultDescription
formIdstringYesRequired. The ID of the form. You can get the id from Form.form_id field.
publishSettingsobjectYesThe publishing settings of a form.
updateMaskstringNoOptional. The publish_settings fields to update. This field mask accepts the following values: * publish_state: Updates or replaces all publish_state settings. * "*": Updates or replaces all publish_settings fields.