2022-03-10
▼ ▲ forms.forms.get
Parameters:
formId
Location: path
Type: string
Description: Required. The form ID.
Required: Yes
HTTP Method: GET
Parameter Order: formId
Flat Path: v1/forms/{formId}
Path: v1/forms/{formId}
Description: Get a form.
Scopes:
▼ ▲ forms.forms.batchUpdate
Parameters:
formId
Required: Yes
Description: Required. The form ID.
Type: string
Location: path
Parameter Order: formId
HTTP Method: POST
Flat Path: v1/forms/{formId}:batchUpdate
Description: Change the form with a batch of updates.
Scopes:
Path: v1/forms/{formId}:batchUpdate
▼ ▲ forms.forms.create
Scopes:
Flat Path: v1/forms
HTTP Method: POST
Path: v1/forms
Description: 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.
▼ ▲ forms.forms.responses.get
Path: v1/forms/{formId}/responses/{responseId}
Scopes:
Parameters:
responseId
Type: string
Required: Yes
Location: path
Description: Required. The response ID within the form.
formId
Location: path
Description: Required. The form ID.
Type: string
Required: Yes
HTTP Method: GET
Flat Path: v1/forms/{formId}/responses/{responseId}
Description: Get one response from the form.
Parameter Order:
▼ ▲ forms.forms.responses.list
Path: v1/forms/{formId}/responses
Parameters:
formId
Required: Yes
Type: string
Description: Required. ID of the Form whose responses to list.
Location: path
pageSize
Type: integer
Description: The maximum number of responses to return. The service may return fewer than this value. If unspecified or zero, at most 5000 responses are returned.
Location: query
Format: int32
filter
Description: Which 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".
Type: string
Location: query
pageToken
Type: string
Description: A 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.
Location: query
Scopes:
Flat Path: v1/forms/{formId}/responses
Description: List a form's responses.
Parameter Order: formId
HTTP Method: GET
▼ ▲ forms.forms.watches.delete
Parameters:
watchId
Location: path
Type: string
Description: Required. The ID of the Watch to delete.
Required: Yes
formId
Type: string
Location: path
Required: Yes
Description: Required. The ID of the Form.
HTTP Method: DELETE
Description: Delete a watch.
Flat Path: v1/forms/{formId}/watches/{watchId}
Path: v1/forms/{formId}/watches/{watchId}
Scopes:
Parameter Order:
▼ ▲ forms.forms.watches.renew
Path: v1/forms/{formId}/watches/{watchId}:renew
Description: 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:
watchId
Type: string
Description: Required. The ID of the Watch to renew.
Required: Yes
Location: path
formId
Location: path
Description: Required. The ID of the Form.
Required: Yes
Type: string
Flat Path: v1/forms/{formId}/watches/{watchId}:renew
Scopes:
HTTP Method: POST
Parameter Order:
▼ ▲ forms.forms.watches.create
Flat Path: v1/forms/{formId}/watches
HTTP Method: POST
Scopes:
Parameters:
formId
Location: path
Required: Yes
Description: Required. ID of the Form to watch.
Type: string
Parameter Order: formId
Description: 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).
Path: v1/forms/{formId}/watches
▼ ▲ forms.forms.watches.list
Description: 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.
Path: v1/forms/{formId}/watches
Parameters:
formId
Description: Required. ID of the Form whose watches to list.
Type: string
Location: path
Required: Yes
Parameter Order: formId
Scopes:
HTTP Method: GET
Flat Path: v1/forms/{formId}/watches