Class: Google::Apis::FormsV1::FormsService

Inherits:
Core::BaseService
  • Object
show all
Defined in:
lib/google/apis/forms_v1/service.rb

Overview

Google Forms API

Reads and writes Google Forms and responses.

Examples:

require 'google/apis/forms_v1'

Forms = Google::Apis::FormsV1 # Alias the module
service = Forms::FormsService.new

See Also:

Constant Summary collapse

DEFAULT_ENDPOINT_TEMPLATE = 
"https://forms.$UNIVERSE_DOMAIN$/"

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ FormsService

Returns a new instance of FormsService.



47
48
49
50
51
52
 
# File 'lib/google/apis/forms_v1/service.rb', line 47

def initialize
  super(DEFAULT_ENDPOINT_TEMPLATE, '',
        client_name: 'google-apis-forms_v1',
        client_version: Google::Apis::FormsV1::GEM_VERSION)
  @batch_path = 'batch'
end

Instance Attribute Details

#key ⇒ String

Returns API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Returns:

  • (String) —

    API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.



40
41
42
 
# File 'lib/google/apis/forms_v1/service.rb', line 40

def key
  @key
end

#quota_user ⇒ String

Returns Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

Returns:

  • (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.



45
46
47
 
# File 'lib/google/apis/forms_v1/service.rb', line 45

def quota_user
  @quota_user
end

Instance Method Details

#batch_update_form(form_id, batch_update_form_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FormsV1::BatchUpdateFormResponse

Change the form with a batch of updates.

Parameters:

  • form_id (String) —

    Required. The form ID.

  • batch_update_form_request_object (Google::Apis::FormsV1::BatchUpdateFormRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



75
76
77
78
79
80
81
82
83
84
85
 
# File 'lib/google/apis/forms_v1/service.rb', line 75

def batch_update_form(form_id, batch_update_form_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/forms/{formId}:batchUpdate', options)
  command.request_representation = Google::Apis::FormsV1::BatchUpdateFormRequest::Representation
  command.request_object = batch_update_form_request_object
  command.response_representation = Google::Apis::FormsV1::BatchUpdateFormResponse::Representation
  command.response_class = Google::Apis::FormsV1::BatchUpdateFormResponse
  command.params['formId'] = form_id unless form_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_form(form_object = nil, unpublished: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FormsV1::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:

  • form_object (Google::Apis::FormsV1::Form) (defaults to: nil)
  • unpublished (Boolean) (defaults to: nil) —

    Optional. 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.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



115
116
117
118
119
120
121
122
123
124
125
 
# File 'lib/google/apis/forms_v1/service.rb', line 115

def create_form(form_object = nil, unpublished: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/forms', options)
  command.request_representation = Google::Apis::FormsV1::Form::Representation
  command.request_object = form_object
  command.response_representation = Google::Apis::FormsV1::Form::Representation
  command.response_class = Google::Apis::FormsV1::Form
  command.query['unpublished'] = unpublished unless unpublished.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_watch(form_id, create_watch_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FormsV1::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:

  • form_id (String) —

    Required. ID of the Form to watch.

  • create_watch_request_object (Google::Apis::FormsV1::CreateWatchRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



293
294
295
296
297
298
299
300
301
302
303
 
# File 'lib/google/apis/forms_v1/service.rb', line 293

def create_watch(form_id, create_watch_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/forms/{formId}/watches', options)
  command.request_representation = Google::Apis::FormsV1::CreateWatchRequest::Representation
  command.request_object = create_watch_request_object
  command.response_representation = Google::Apis::FormsV1::Watch::Representation
  command.response_class = Google::Apis::FormsV1::Watch
  command.params['formId'] = form_id unless form_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_form_watch(form_id, watch_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FormsV1::Empty

Delete a watch.

Parameters:

  • form_id (String) —

    Required. The ID of the Form.

  • watch_id (String) —

    Required. The ID of the Watch to delete.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



327
328
329
330
331
332
333
334
335
336
 
# File 'lib/google/apis/forms_v1/service.rb', line 327

def delete_form_watch(form_id, watch_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1/forms/{formId}/watches/{watchId}', options)
  command.response_representation = Google::Apis::FormsV1::Empty::Representation
  command.response_class = Google::Apis::FormsV1::Empty
  command.params['formId'] = form_id unless form_id.nil?
  command.params['watchId'] = watch_id unless watch_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_form(form_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FormsV1::Form

Get a form.

Parameters:

  • form_id (String) —

    Required. The form ID.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



147
148
149
150
151
152
153
154
155
 
# File 'lib/google/apis/forms_v1/service.rb', line 147

def get_form(form_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/forms/{formId}', options)
  command.response_representation = Google::Apis::FormsV1::Form::Representation
  command.response_class = Google::Apis::FormsV1::Form
  command.params['formId'] = form_id unless form_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_form_response(form_id, response_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FormsV1::FormResponse

Get one response from the form.

Parameters:

  • form_id (String) —

    Required. The form ID.

  • response_id (String) —

    Required. The response ID within the form.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



213
214
215
216
217
218
219
220
221
222
 
# File 'lib/google/apis/forms_v1/service.rb', line 213

def get_form_response(form_id, response_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/forms/{formId}/responses/{responseId}', options)
  command.response_representation = Google::Apis::FormsV1::FormResponse::Representation
  command.response_class = Google::Apis::FormsV1::FormResponse
  command.params['formId'] = form_id unless form_id.nil?
  command.params['responseId'] = response_id unless response_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_form_responses(form_id, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FormsV1::ListFormResponsesResponse

List a form's responses.

Parameters:

  • form_id (String) —

    Required. ID of the Form whose responses to list.

  • filter (String) (defaults to: nil) —

    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".

  • page_size (Fixnum) (defaults to: nil) —

    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.

  • page_token (String) (defaults to: nil) —

    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.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



257
258
259
260
261
262
263
264
265
266
267
268
 
# File 'lib/google/apis/forms_v1/service.rb', line 257

def list_form_responses(form_id, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/forms/{formId}/responses', options)
  command.response_representation = Google::Apis::FormsV1::ListFormResponsesResponse::Representation
  command.response_class = Google::Apis::FormsV1::ListFormResponsesResponse
  command.params['formId'] = form_id unless form_id.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_form_watches(form_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FormsV1::ListWatchesResponse

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:

  • form_id (String) —

    Required. ID of the Form whose watches to list.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



360
361
362
363
364
365
366
367
368
 
# File 'lib/google/apis/forms_v1/service.rb', line 360

def list_form_watches(form_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/forms/{formId}/watches', options)
  command.response_representation = Google::Apis::FormsV1::ListWatchesResponse::Representation
  command.response_class = Google::Apis::FormsV1::ListWatchesResponse
  command.params['formId'] = form_id unless form_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#renew_watch(form_id, watch_id, renew_watch_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FormsV1::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:

  • form_id (String) —

    Required. The ID of the Form.

  • watch_id (String) —

    Required. The ID of the Watch to renew.

  • renew_watch_request_object (Google::Apis::FormsV1::RenewWatchRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



397
398
399
400
401
402
403
404
405
406
407
408
 
# File 'lib/google/apis/forms_v1/service.rb', line 397

def renew_watch(form_id, watch_id, renew_watch_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/forms/{formId}/watches/{watchId}:renew', options)
  command.request_representation = Google::Apis::FormsV1::RenewWatchRequest::Representation
  command.request_object = renew_watch_request_object
  command.response_representation = Google::Apis::FormsV1::Watch::Representation
  command.response_class = Google::Apis::FormsV1::Watch
  command.params['formId'] = form_id unless form_id.nil?
  command.params['watchId'] = watch_id unless watch_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#set_form_publish_settings(form_id, set_publish_settings_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FormsV1::SetPublishSettingsResponse

Updates the publish settings of a form. Legacy forms aren't supported because they don't have the publish_settings field.

Parameters:

  • form_id (String) —

    Required. The ID of the form. You can get the id from Form.form_id field.

  • set_publish_settings_request_object (Google::Apis::FormsV1::SetPublishSettingsRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



179
180
181
182
183
184
185
186
187
188
189
 
# File 'lib/google/apis/forms_v1/service.rb', line 179

def set_form_publish_settings(form_id, set_publish_settings_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/forms/{formId}:setPublishSettings', options)
  command.request_representation = Google::Apis::FormsV1::SetPublishSettingsRequest::Representation
  command.request_object = set_publish_settings_request_object
  command.response_representation = Google::Apis::FormsV1::SetPublishSettingsResponse::Representation
  command.response_class = Google::Apis::FormsV1::SetPublishSettingsResponse
  command.params['formId'] = form_id unless form_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end