google-api-client 0.9.25 → 0.9.26
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +3 -0
- data/api_names.yaml +279 -0
- data/generated/google/apis/adexchangebuyer2_v2beta1.rb +1 -1
- data/generated/google/apis/adexchangebuyer2_v2beta1/classes.rb +110 -110
- data/generated/google/apis/adexchangebuyer2_v2beta1/representations.rb +25 -25
- data/generated/google/apis/adexchangebuyer2_v2beta1/service.rb +145 -145
- data/generated/google/apis/adsense_v1_4.rb +1 -1
- data/generated/google/apis/adsensehost_v4_1.rb +1 -1
- data/generated/google/apis/calendar_v3.rb +1 -1
- data/generated/google/apis/cloudbuild_v1.rb +1 -1
- data/generated/google/apis/cloudbuild_v1/classes.rb +419 -419
- data/generated/google/apis/cloudbuild_v1/representations.rb +73 -73
- data/generated/google/apis/cloudbuild_v1/service.rb +86 -86
- data/generated/google/apis/cloudkms_v1beta1.rb +34 -0
- data/generated/google/apis/cloudkms_v1beta1/classes.rb +999 -0
- data/generated/google/apis/cloudkms_v1beta1/representations.rb +448 -0
- data/generated/google/apis/cloudkms_v1beta1/service.rb +932 -0
- data/generated/google/apis/cloudresourcemanager_v1.rb +4 -4
- data/generated/google/apis/cloudresourcemanager_v1/classes.rb +478 -478
- data/generated/google/apis/cloudresourcemanager_v1/representations.rb +96 -96
- data/generated/google/apis/cloudresourcemanager_v1/service.rb +271 -271
- data/generated/google/apis/cloudresourcemanager_v1beta1.rb +4 -4
- data/generated/google/apis/cloudresourcemanager_v1beta1/classes.rb +353 -353
- data/generated/google/apis/cloudresourcemanager_v1beta1/representations.rb +81 -81
- data/generated/google/apis/cloudresourcemanager_v1beta1/service.rb +299 -299
- data/generated/google/apis/container_v1.rb +1 -1
- data/generated/google/apis/container_v1/classes.rb +287 -16
- data/generated/google/apis/container_v1/representations.rb +113 -2
- data/generated/google/apis/container_v1/service.rb +130 -0
- data/generated/google/apis/doubleclicksearch_v2.rb +1 -1
- data/generated/google/apis/drive_v2.rb +1 -1
- data/generated/google/apis/drive_v3.rb +1 -1
- data/generated/google/apis/genomics_v1.rb +8 -8
- data/generated/google/apis/genomics_v1/classes.rb +2259 -2257
- data/generated/google/apis/genomics_v1/representations.rb +461 -526
- data/generated/google/apis/genomics_v1/service.rb +1203 -1105
- data/generated/google/apis/gmail_v1.rb +1 -1
- data/generated/google/apis/logging_v2beta1.rb +1 -1
- data/generated/google/apis/logging_v2beta1/classes.rb +852 -852
- data/generated/google/apis/logging_v2beta1/representations.rb +168 -168
- data/generated/google/apis/logging_v2beta1/service.rb +230 -230
- data/generated/google/apis/manufacturers_v1.rb +34 -0
- data/generated/google/apis/manufacturers_v1/classes.rb +258 -0
- data/generated/google/apis/manufacturers_v1/representations.rb +103 -0
- data/generated/google/apis/manufacturers_v1/service.rb +138 -0
- data/generated/google/apis/monitoring_v3.rb +7 -7
- data/generated/google/apis/monitoring_v3/classes.rb +744 -744
- data/generated/google/apis/monitoring_v3/representations.rb +164 -164
- data/generated/google/apis/monitoring_v3/service.rb +335 -335
- data/generated/google/apis/plus_domains_v1.rb +1 -1
- data/generated/google/apis/plus_v1.rb +1 -1
- data/generated/google/apis/pubsub_v1.rb +3 -3
- data/generated/google/apis/pubsub_v1/classes.rb +325 -325
- data/generated/google/apis/pubsub_v1/representations.rb +80 -80
- data/generated/google/apis/pubsub_v1/service.rb +256 -256
- data/generated/google/apis/sheets_v4.rb +3 -3
- data/generated/google/apis/sheets_v4/classes.rb +4283 -4283
- data/generated/google/apis/sheets_v4/representations.rb +833 -833
- data/generated/google/apis/sheets_v4/service.rb +184 -184
- data/generated/google/apis/speech_v1beta1.rb +1 -1
- data/generated/google/apis/speech_v1beta1/classes.rb +213 -211
- data/generated/google/apis/speech_v1beta1/representations.rb +49 -49
- data/generated/google/apis/speech_v1beta1/service.rb +71 -71
- data/generated/google/apis/sqladmin_v1beta4.rb +1 -1
- data/generated/google/apis/sqladmin_v1beta4/classes.rb +20 -0
- data/generated/google/apis/sqladmin_v1beta4/representations.rb +2 -0
- data/generated/google/apis/vision_v1.rb +1 -1
- data/generated/google/apis/vision_v1/classes.rb +861 -859
- data/generated/google/apis/vision_v1/representations.rb +140 -140
- data/generated/google/apis/vision_v1/service.rb +4 -4
- data/generated/google/apis/youtube_analytics_v1.rb +1 -1
- data/generated/google/apis/youtube_partner_v1.rb +1 -1
- data/generated/google/apis/youtubereporting_v1.rb +1 -1
- data/generated/google/apis/youtubereporting_v1/classes.rb +139 -139
- data/generated/google/apis/youtubereporting_v1/representations.rb +36 -36
- data/generated/google/apis/youtubereporting_v1/service.rb +152 -152
- data/lib/google/apis/version.rb +1 -1
- metadata +9 -1
@@ -46,36 +46,6 @@ module Google
|
|
46
46
|
super('https://sheets.googleapis.com/', '')
|
47
47
|
end
|
48
48
|
|
49
|
-
# Creates a spreadsheet, returning the newly created spreadsheet.
|
50
|
-
# @param [Google::Apis::SheetsV4::Spreadsheet] spreadsheet_object
|
51
|
-
# @param [String] quota_user
|
52
|
-
# Available to use for quota purposes for server-side applications. Can be any
|
53
|
-
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
54
|
-
# @param [String] fields
|
55
|
-
# Selector specifying which fields to include in a partial response.
|
56
|
-
# @param [Google::Apis::RequestOptions] options
|
57
|
-
# Request-specific options
|
58
|
-
#
|
59
|
-
# @yield [result, err] Result & error if block supplied
|
60
|
-
# @yieldparam result [Google::Apis::SheetsV4::Spreadsheet] parsed result object
|
61
|
-
# @yieldparam err [StandardError] error object if request failed
|
62
|
-
#
|
63
|
-
# @return [Google::Apis::SheetsV4::Spreadsheet]
|
64
|
-
#
|
65
|
-
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
66
|
-
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
67
|
-
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
68
|
-
def create_spreadsheet(spreadsheet_object = nil, quota_user: nil, fields: nil, options: nil, &block)
|
69
|
-
command = make_simple_command(:post, 'v4/spreadsheets', options)
|
70
|
-
command.request_representation = Google::Apis::SheetsV4::Spreadsheet::Representation
|
71
|
-
command.request_object = spreadsheet_object
|
72
|
-
command.response_representation = Google::Apis::SheetsV4::Spreadsheet::Representation
|
73
|
-
command.response_class = Google::Apis::SheetsV4::Spreadsheet
|
74
|
-
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
75
|
-
command.query['fields'] = fields unless fields.nil?
|
76
|
-
execute_or_queue_command(command, &block)
|
77
|
-
end
|
78
|
-
|
79
49
|
# Returns the spreadsheet at the given ID.
|
80
50
|
# The caller must specify the spreadsheet ID.
|
81
51
|
# By default, data within grids will not be returned.
|
@@ -99,11 +69,11 @@ module Google
|
|
99
69
|
# @param [Boolean] include_grid_data
|
100
70
|
# True if grid data should be returned.
|
101
71
|
# This parameter is ignored if a field mask was set in the request.
|
72
|
+
# @param [String] fields
|
73
|
+
# Selector specifying which fields to include in a partial response.
|
102
74
|
# @param [String] quota_user
|
103
75
|
# Available to use for quota purposes for server-side applications. Can be any
|
104
76
|
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
105
|
-
# @param [String] fields
|
106
|
-
# Selector specifying which fields to include in a partial response.
|
107
77
|
# @param [Google::Apis::RequestOptions] options
|
108
78
|
# Request-specific options
|
109
79
|
#
|
@@ -116,15 +86,45 @@ module Google
|
|
116
86
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
117
87
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
118
88
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
119
|
-
def get_spreadsheet(spreadsheet_id, ranges: nil, include_grid_data: nil,
|
89
|
+
def get_spreadsheet(spreadsheet_id, ranges: nil, include_grid_data: nil, fields: nil, quota_user: nil, options: nil, &block)
|
120
90
|
command = make_simple_command(:get, 'v4/spreadsheets/{spreadsheetId}', options)
|
121
91
|
command.response_representation = Google::Apis::SheetsV4::Spreadsheet::Representation
|
122
92
|
command.response_class = Google::Apis::SheetsV4::Spreadsheet
|
123
93
|
command.params['spreadsheetId'] = spreadsheet_id unless spreadsheet_id.nil?
|
124
94
|
command.query['ranges'] = ranges unless ranges.nil?
|
125
95
|
command.query['includeGridData'] = include_grid_data unless include_grid_data.nil?
|
96
|
+
command.query['fields'] = fields unless fields.nil?
|
126
97
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
98
|
+
execute_or_queue_command(command, &block)
|
99
|
+
end
|
100
|
+
|
101
|
+
# Creates a spreadsheet, returning the newly created spreadsheet.
|
102
|
+
# @param [Google::Apis::SheetsV4::Spreadsheet] spreadsheet_object
|
103
|
+
# @param [String] fields
|
104
|
+
# Selector specifying which fields to include in a partial response.
|
105
|
+
# @param [String] quota_user
|
106
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
107
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
108
|
+
# @param [Google::Apis::RequestOptions] options
|
109
|
+
# Request-specific options
|
110
|
+
#
|
111
|
+
# @yield [result, err] Result & error if block supplied
|
112
|
+
# @yieldparam result [Google::Apis::SheetsV4::Spreadsheet] parsed result object
|
113
|
+
# @yieldparam err [StandardError] error object if request failed
|
114
|
+
#
|
115
|
+
# @return [Google::Apis::SheetsV4::Spreadsheet]
|
116
|
+
#
|
117
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
118
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
119
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
120
|
+
def create_spreadsheet(spreadsheet_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
121
|
+
command = make_simple_command(:post, 'v4/spreadsheets', options)
|
122
|
+
command.request_representation = Google::Apis::SheetsV4::Spreadsheet::Representation
|
123
|
+
command.request_object = spreadsheet_object
|
124
|
+
command.response_representation = Google::Apis::SheetsV4::Spreadsheet::Representation
|
125
|
+
command.response_class = Google::Apis::SheetsV4::Spreadsheet
|
127
126
|
command.query['fields'] = fields unless fields.nil?
|
127
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
128
128
|
execute_or_queue_command(command, &block)
|
129
129
|
end
|
130
130
|
|
@@ -147,11 +147,11 @@ module Google
|
|
147
147
|
# @param [String] spreadsheet_id
|
148
148
|
# The spreadsheet to apply the updates to.
|
149
149
|
# @param [Google::Apis::SheetsV4::BatchUpdateSpreadsheetRequest] batch_update_spreadsheet_request_object
|
150
|
+
# @param [String] fields
|
151
|
+
# Selector specifying which fields to include in a partial response.
|
150
152
|
# @param [String] quota_user
|
151
153
|
# Available to use for quota purposes for server-side applications. Can be any
|
152
154
|
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
153
|
-
# @param [String] fields
|
154
|
-
# Selector specifying which fields to include in a partial response.
|
155
155
|
# @param [Google::Apis::RequestOptions] options
|
156
156
|
# Request-specific options
|
157
157
|
#
|
@@ -164,151 +164,156 @@ module Google
|
|
164
164
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
165
165
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
166
166
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
167
|
-
def batch_update_spreadsheet(spreadsheet_id, batch_update_spreadsheet_request_object = nil,
|
167
|
+
def batch_update_spreadsheet(spreadsheet_id, batch_update_spreadsheet_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
168
168
|
command = make_simple_command(:post, 'v4/spreadsheets/{spreadsheetId}:batchUpdate', options)
|
169
169
|
command.request_representation = Google::Apis::SheetsV4::BatchUpdateSpreadsheetRequest::Representation
|
170
170
|
command.request_object = batch_update_spreadsheet_request_object
|
171
171
|
command.response_representation = Google::Apis::SheetsV4::BatchUpdateSpreadsheetResponse::Representation
|
172
172
|
command.response_class = Google::Apis::SheetsV4::BatchUpdateSpreadsheetResponse
|
173
173
|
command.params['spreadsheetId'] = spreadsheet_id unless spreadsheet_id.nil?
|
174
|
-
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
175
174
|
command.query['fields'] = fields unless fields.nil?
|
175
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
176
176
|
execute_or_queue_command(command, &block)
|
177
177
|
end
|
178
178
|
|
179
|
-
#
|
180
|
-
# The caller must specify the spreadsheet ID and
|
181
|
-
#
|
182
|
-
# formatting, data validation, etc..) are kept.
|
179
|
+
# Sets values in a range of a spreadsheet.
|
180
|
+
# The caller must specify the spreadsheet ID, range, and
|
181
|
+
# a valueInputOption.
|
183
182
|
# @param [String] spreadsheet_id
|
184
183
|
# The ID of the spreadsheet to update.
|
185
184
|
# @param [String] range
|
186
|
-
# The A1 notation of the values to
|
187
|
-
# @param [Google::Apis::SheetsV4::
|
185
|
+
# The A1 notation of the values to update.
|
186
|
+
# @param [Google::Apis::SheetsV4::ValueRange] value_range_object
|
187
|
+
# @param [String] value_input_option
|
188
|
+
# How the input data should be interpreted.
|
189
|
+
# @param [String] response_date_time_render_option
|
190
|
+
# Determines how dates, times, and durations in the response should be
|
191
|
+
# rendered. This is ignored if response_value_render_option is
|
192
|
+
# FORMATTED_VALUE.
|
193
|
+
# The default dateTime render option is [DateTimeRenderOption.SERIAL_NUMBER].
|
194
|
+
# @param [Boolean] include_values_in_response
|
195
|
+
# Determines if the update response should include the values
|
196
|
+
# of the cells that were updated. By default, responses
|
197
|
+
# do not include the updated values.
|
198
|
+
# If the range to write was larger than than the range actually written,
|
199
|
+
# the response will include all values in the requested range (excluding
|
200
|
+
# trailing empty rows and columns).
|
201
|
+
# @param [String] response_value_render_option
|
202
|
+
# Determines how values in the response should be rendered.
|
203
|
+
# The default render option is ValueRenderOption.FORMATTED_VALUE.
|
204
|
+
# @param [String] fields
|
205
|
+
# Selector specifying which fields to include in a partial response.
|
188
206
|
# @param [String] quota_user
|
189
207
|
# Available to use for quota purposes for server-side applications. Can be any
|
190
208
|
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
191
|
-
# @param [String] fields
|
192
|
-
# Selector specifying which fields to include in a partial response.
|
193
209
|
# @param [Google::Apis::RequestOptions] options
|
194
210
|
# Request-specific options
|
195
211
|
#
|
196
212
|
# @yield [result, err] Result & error if block supplied
|
197
|
-
# @yieldparam result [Google::Apis::SheetsV4::
|
213
|
+
# @yieldparam result [Google::Apis::SheetsV4::UpdateValuesResponse] parsed result object
|
198
214
|
# @yieldparam err [StandardError] error object if request failed
|
199
215
|
#
|
200
|
-
# @return [Google::Apis::SheetsV4::
|
216
|
+
# @return [Google::Apis::SheetsV4::UpdateValuesResponse]
|
201
217
|
#
|
202
218
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
203
219
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
204
220
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
205
|
-
def
|
206
|
-
command = make_simple_command(:
|
207
|
-
command.request_representation = Google::Apis::SheetsV4::
|
208
|
-
command.request_object =
|
209
|
-
command.response_representation = Google::Apis::SheetsV4::
|
210
|
-
command.response_class = Google::Apis::SheetsV4::
|
221
|
+
def update_spreadsheet_value(spreadsheet_id, range, value_range_object = nil, value_input_option: nil, response_date_time_render_option: nil, include_values_in_response: nil, response_value_render_option: nil, fields: nil, quota_user: nil, options: nil, &block)
|
222
|
+
command = make_simple_command(:put, 'v4/spreadsheets/{spreadsheetId}/values/{range}', options)
|
223
|
+
command.request_representation = Google::Apis::SheetsV4::ValueRange::Representation
|
224
|
+
command.request_object = value_range_object
|
225
|
+
command.response_representation = Google::Apis::SheetsV4::UpdateValuesResponse::Representation
|
226
|
+
command.response_class = Google::Apis::SheetsV4::UpdateValuesResponse
|
211
227
|
command.params['spreadsheetId'] = spreadsheet_id unless spreadsheet_id.nil?
|
212
228
|
command.params['range'] = range unless range.nil?
|
213
|
-
command.query['
|
229
|
+
command.query['valueInputOption'] = value_input_option unless value_input_option.nil?
|
230
|
+
command.query['responseDateTimeRenderOption'] = response_date_time_render_option unless response_date_time_render_option.nil?
|
231
|
+
command.query['includeValuesInResponse'] = include_values_in_response unless include_values_in_response.nil?
|
232
|
+
command.query['responseValueRenderOption'] = response_value_render_option unless response_value_render_option.nil?
|
214
233
|
command.query['fields'] = fields unless fields.nil?
|
234
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
215
235
|
execute_or_queue_command(command, &block)
|
216
236
|
end
|
217
237
|
|
218
|
-
#
|
219
|
-
# The caller must specify the spreadsheet ID
|
238
|
+
# Sets values in one or more ranges of a spreadsheet.
|
239
|
+
# The caller must specify the spreadsheet ID,
|
240
|
+
# a valueInputOption, and one or more
|
241
|
+
# ValueRanges.
|
220
242
|
# @param [String] spreadsheet_id
|
221
|
-
# The ID of the spreadsheet to
|
222
|
-
# @param [
|
223
|
-
#
|
224
|
-
#
|
225
|
-
# How values should be represented in the output.
|
226
|
-
# The default render option is ValueRenderOption.FORMATTED_VALUE.
|
227
|
-
# @param [String] date_time_render_option
|
228
|
-
# How dates, times, and durations should be represented in the output.
|
229
|
-
# This is ignored if value_render_option is
|
230
|
-
# FORMATTED_VALUE.
|
231
|
-
# The default dateTime render option is [DateTimeRenderOption.SERIAL_NUMBER].
|
232
|
-
# @param [String] major_dimension
|
233
|
-
# The major dimension that results should use.
|
234
|
-
# For example, if the spreadsheet data is: `A1=1,B1=2,A2=3,B2=4`,
|
235
|
-
# then requesting `range=A1:B2,majorDimension=ROWS` will return
|
236
|
-
# `[[1,2],[3,4]]`,
|
237
|
-
# whereas requesting `range=A1:B2,majorDimension=COLUMNS` will return
|
238
|
-
# `[[1,3],[2,4]]`.
|
243
|
+
# The ID of the spreadsheet to update.
|
244
|
+
# @param [Google::Apis::SheetsV4::BatchUpdateValuesRequest] batch_update_values_request_object
|
245
|
+
# @param [String] fields
|
246
|
+
# Selector specifying which fields to include in a partial response.
|
239
247
|
# @param [String] quota_user
|
240
248
|
# Available to use for quota purposes for server-side applications. Can be any
|
241
249
|
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
242
|
-
# @param [String] fields
|
243
|
-
# Selector specifying which fields to include in a partial response.
|
244
250
|
# @param [Google::Apis::RequestOptions] options
|
245
251
|
# Request-specific options
|
246
252
|
#
|
247
253
|
# @yield [result, err] Result & error if block supplied
|
248
|
-
# @yieldparam result [Google::Apis::SheetsV4::
|
254
|
+
# @yieldparam result [Google::Apis::SheetsV4::BatchUpdateValuesResponse] parsed result object
|
249
255
|
# @yieldparam err [StandardError] error object if request failed
|
250
256
|
#
|
251
|
-
# @return [Google::Apis::SheetsV4::
|
257
|
+
# @return [Google::Apis::SheetsV4::BatchUpdateValuesResponse]
|
252
258
|
#
|
253
259
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
254
260
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
255
261
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
256
|
-
def
|
257
|
-
command = make_simple_command(:
|
258
|
-
command.
|
259
|
-
command.
|
262
|
+
def batch_update_values(spreadsheet_id, batch_update_values_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
263
|
+
command = make_simple_command(:post, 'v4/spreadsheets/{spreadsheetId}/values:batchUpdate', options)
|
264
|
+
command.request_representation = Google::Apis::SheetsV4::BatchUpdateValuesRequest::Representation
|
265
|
+
command.request_object = batch_update_values_request_object
|
266
|
+
command.response_representation = Google::Apis::SheetsV4::BatchUpdateValuesResponse::Representation
|
267
|
+
command.response_class = Google::Apis::SheetsV4::BatchUpdateValuesResponse
|
260
268
|
command.params['spreadsheetId'] = spreadsheet_id unless spreadsheet_id.nil?
|
261
|
-
command.query['ranges'] = ranges unless ranges.nil?
|
262
|
-
command.query['valueRenderOption'] = value_render_option unless value_render_option.nil?
|
263
|
-
command.query['dateTimeRenderOption'] = date_time_render_option unless date_time_render_option.nil?
|
264
|
-
command.query['majorDimension'] = major_dimension unless major_dimension.nil?
|
265
|
-
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
266
269
|
command.query['fields'] = fields unless fields.nil?
|
270
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
267
271
|
execute_or_queue_command(command, &block)
|
268
272
|
end
|
269
273
|
|
270
|
-
#
|
271
|
-
# The caller must specify the spreadsheet ID
|
272
|
-
#
|
273
|
-
#
|
274
|
+
# Clears values from a spreadsheet.
|
275
|
+
# The caller must specify the spreadsheet ID and range.
|
276
|
+
# Only values are cleared -- all other properties of the cell (such as
|
277
|
+
# formatting, data validation, etc..) are kept.
|
274
278
|
# @param [String] spreadsheet_id
|
275
279
|
# The ID of the spreadsheet to update.
|
276
|
-
# @param [
|
280
|
+
# @param [String] range
|
281
|
+
# The A1 notation of the values to clear.
|
282
|
+
# @param [Google::Apis::SheetsV4::ClearValuesRequest] clear_values_request_object
|
283
|
+
# @param [String] fields
|
284
|
+
# Selector specifying which fields to include in a partial response.
|
277
285
|
# @param [String] quota_user
|
278
286
|
# Available to use for quota purposes for server-side applications. Can be any
|
279
287
|
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
280
|
-
# @param [String] fields
|
281
|
-
# Selector specifying which fields to include in a partial response.
|
282
288
|
# @param [Google::Apis::RequestOptions] options
|
283
289
|
# Request-specific options
|
284
290
|
#
|
285
291
|
# @yield [result, err] Result & error if block supplied
|
286
|
-
# @yieldparam result [Google::Apis::SheetsV4::
|
292
|
+
# @yieldparam result [Google::Apis::SheetsV4::ClearValuesResponse] parsed result object
|
287
293
|
# @yieldparam err [StandardError] error object if request failed
|
288
294
|
#
|
289
|
-
# @return [Google::Apis::SheetsV4::
|
295
|
+
# @return [Google::Apis::SheetsV4::ClearValuesResponse]
|
290
296
|
#
|
291
297
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
292
298
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
293
299
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
294
|
-
def
|
295
|
-
command = make_simple_command(:post, 'v4/spreadsheets/{spreadsheetId}/values:
|
296
|
-
command.request_representation = Google::Apis::SheetsV4::
|
297
|
-
command.request_object =
|
298
|
-
command.response_representation = Google::Apis::SheetsV4::
|
299
|
-
command.response_class = Google::Apis::SheetsV4::
|
300
|
+
def clear_values(spreadsheet_id, range, clear_values_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
301
|
+
command = make_simple_command(:post, 'v4/spreadsheets/{spreadsheetId}/values/{range}:clear', options)
|
302
|
+
command.request_representation = Google::Apis::SheetsV4::ClearValuesRequest::Representation
|
303
|
+
command.request_object = clear_values_request_object
|
304
|
+
command.response_representation = Google::Apis::SheetsV4::ClearValuesResponse::Representation
|
305
|
+
command.response_class = Google::Apis::SheetsV4::ClearValuesResponse
|
300
306
|
command.params['spreadsheetId'] = spreadsheet_id unless spreadsheet_id.nil?
|
301
|
-
command.
|
307
|
+
command.params['range'] = range unless range.nil?
|
302
308
|
command.query['fields'] = fields unless fields.nil?
|
309
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
303
310
|
execute_or_queue_command(command, &block)
|
304
311
|
end
|
305
312
|
|
306
|
-
# Returns
|
307
|
-
# The caller must specify the spreadsheet ID and
|
313
|
+
# Returns one or more ranges of values from a spreadsheet.
|
314
|
+
# The caller must specify the spreadsheet ID and one or more ranges.
|
308
315
|
# @param [String] spreadsheet_id
|
309
316
|
# The ID of the spreadsheet to retrieve data from.
|
310
|
-
# @param [String] range
|
311
|
-
# The A1 notation of the values to retrieve.
|
312
317
|
# @param [String] value_render_option
|
313
318
|
# How values should be represented in the output.
|
314
319
|
# The default render option is ValueRenderOption.FORMATTED_VALUE.
|
@@ -317,6 +322,8 @@ module Google
|
|
317
322
|
# This is ignored if value_render_option is
|
318
323
|
# FORMATTED_VALUE.
|
319
324
|
# The default dateTime render option is [DateTimeRenderOption.SERIAL_NUMBER].
|
325
|
+
# @param [Array<String>, String] ranges
|
326
|
+
# The A1 notation of the values to retrieve.
|
320
327
|
# @param [String] major_dimension
|
321
328
|
# The major dimension that results should use.
|
322
329
|
# For example, if the spreadsheet data is: `A1=1,B1=2,A2=3,B2=4`,
|
@@ -324,34 +331,34 @@ module Google
|
|
324
331
|
# `[[1,2],[3,4]]`,
|
325
332
|
# whereas requesting `range=A1:B2,majorDimension=COLUMNS` will return
|
326
333
|
# `[[1,3],[2,4]]`.
|
334
|
+
# @param [String] fields
|
335
|
+
# Selector specifying which fields to include in a partial response.
|
327
336
|
# @param [String] quota_user
|
328
337
|
# Available to use for quota purposes for server-side applications. Can be any
|
329
338
|
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
330
|
-
# @param [String] fields
|
331
|
-
# Selector specifying which fields to include in a partial response.
|
332
339
|
# @param [Google::Apis::RequestOptions] options
|
333
340
|
# Request-specific options
|
334
341
|
#
|
335
342
|
# @yield [result, err] Result & error if block supplied
|
336
|
-
# @yieldparam result [Google::Apis::SheetsV4::
|
343
|
+
# @yieldparam result [Google::Apis::SheetsV4::BatchGetValuesResponse] parsed result object
|
337
344
|
# @yieldparam err [StandardError] error object if request failed
|
338
345
|
#
|
339
|
-
# @return [Google::Apis::SheetsV4::
|
346
|
+
# @return [Google::Apis::SheetsV4::BatchGetValuesResponse]
|
340
347
|
#
|
341
348
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
342
349
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
343
350
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
344
|
-
def
|
345
|
-
command = make_simple_command(:get, 'v4/spreadsheets/{spreadsheetId}/values
|
346
|
-
command.response_representation = Google::Apis::SheetsV4::
|
347
|
-
command.response_class = Google::Apis::SheetsV4::
|
351
|
+
def batch_get_spreadsheet_values(spreadsheet_id, value_render_option: nil, date_time_render_option: nil, ranges: nil, major_dimension: nil, fields: nil, quota_user: nil, options: nil, &block)
|
352
|
+
command = make_simple_command(:get, 'v4/spreadsheets/{spreadsheetId}/values:batchGet', options)
|
353
|
+
command.response_representation = Google::Apis::SheetsV4::BatchGetValuesResponse::Representation
|
354
|
+
command.response_class = Google::Apis::SheetsV4::BatchGetValuesResponse
|
348
355
|
command.params['spreadsheetId'] = spreadsheet_id unless spreadsheet_id.nil?
|
349
|
-
command.params['range'] = range unless range.nil?
|
350
356
|
command.query['valueRenderOption'] = value_render_option unless value_render_option.nil?
|
351
357
|
command.query['dateTimeRenderOption'] = date_time_render_option unless date_time_render_option.nil?
|
358
|
+
command.query['ranges'] = ranges unless ranges.nil?
|
352
359
|
command.query['majorDimension'] = major_dimension unless major_dimension.nil?
|
353
|
-
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
354
360
|
command.query['fields'] = fields unless fields.nil?
|
361
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
355
362
|
execute_or_queue_command(command, &block)
|
356
363
|
end
|
357
364
|
|
@@ -377,6 +384,8 @@ module Google
|
|
377
384
|
# @param [String] response_value_render_option
|
378
385
|
# Determines how values in the response should be rendered.
|
379
386
|
# The default render option is ValueRenderOption.FORMATTED_VALUE.
|
387
|
+
# @param [String] insert_data_option
|
388
|
+
# How the input data should be inserted.
|
380
389
|
# @param [String] value_input_option
|
381
390
|
# How the input data should be interpreted.
|
382
391
|
# @param [String] response_date_time_render_option
|
@@ -388,13 +397,11 @@ module Google
|
|
388
397
|
# Determines if the update response should include the values
|
389
398
|
# of the cells that were appended. By default, responses
|
390
399
|
# do not include the updated values.
|
391
|
-
# @param [String]
|
392
|
-
#
|
400
|
+
# @param [String] fields
|
401
|
+
# Selector specifying which fields to include in a partial response.
|
393
402
|
# @param [String] quota_user
|
394
403
|
# Available to use for quota purposes for server-side applications. Can be any
|
395
404
|
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
396
|
-
# @param [String] fields
|
397
|
-
# Selector specifying which fields to include in a partial response.
|
398
405
|
# @param [Google::Apis::RequestOptions] options
|
399
406
|
# Request-specific options
|
400
407
|
#
|
@@ -407,7 +414,7 @@ module Google
|
|
407
414
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
408
415
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
409
416
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
410
|
-
def append_spreadsheet_value(spreadsheet_id, range, value_range_object = nil, response_value_render_option: nil,
|
417
|
+
def append_spreadsheet_value(spreadsheet_id, range, value_range_object = nil, response_value_render_option: nil, insert_data_option: nil, value_input_option: nil, response_date_time_render_option: nil, include_values_in_response: nil, fields: nil, quota_user: nil, options: nil, &block)
|
411
418
|
command = make_simple_command(:post, 'v4/spreadsheets/{spreadsheetId}/values/{range}:append', options)
|
412
419
|
command.request_representation = Google::Apis::SheetsV4::ValueRange::Representation
|
413
420
|
command.request_object = value_range_object
|
@@ -416,107 +423,100 @@ module Google
|
|
416
423
|
command.params['spreadsheetId'] = spreadsheet_id unless spreadsheet_id.nil?
|
417
424
|
command.params['range'] = range unless range.nil?
|
418
425
|
command.query['responseValueRenderOption'] = response_value_render_option unless response_value_render_option.nil?
|
426
|
+
command.query['insertDataOption'] = insert_data_option unless insert_data_option.nil?
|
419
427
|
command.query['valueInputOption'] = value_input_option unless value_input_option.nil?
|
420
428
|
command.query['responseDateTimeRenderOption'] = response_date_time_render_option unless response_date_time_render_option.nil?
|
421
429
|
command.query['includeValuesInResponse'] = include_values_in_response unless include_values_in_response.nil?
|
422
|
-
command.query['insertDataOption'] = insert_data_option unless insert_data_option.nil?
|
423
|
-
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
424
430
|
command.query['fields'] = fields unless fields.nil?
|
431
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
425
432
|
execute_or_queue_command(command, &block)
|
426
433
|
end
|
427
434
|
|
428
|
-
#
|
429
|
-
# The caller must specify the spreadsheet ID
|
430
|
-
#
|
435
|
+
# Clears one or more ranges of values from a spreadsheet.
|
436
|
+
# The caller must specify the spreadsheet ID and one or more ranges.
|
437
|
+
# Only values are cleared -- all other properties of the cell (such as
|
438
|
+
# formatting, data validation, etc..) are kept.
|
431
439
|
# @param [String] spreadsheet_id
|
432
440
|
# The ID of the spreadsheet to update.
|
433
|
-
# @param [
|
434
|
-
#
|
435
|
-
#
|
436
|
-
# @param [String] response_value_render_option
|
437
|
-
# Determines how values in the response should be rendered.
|
438
|
-
# The default render option is ValueRenderOption.FORMATTED_VALUE.
|
439
|
-
# @param [String] value_input_option
|
440
|
-
# How the input data should be interpreted.
|
441
|
-
# @param [String] response_date_time_render_option
|
442
|
-
# Determines how dates, times, and durations in the response should be
|
443
|
-
# rendered. This is ignored if response_value_render_option is
|
444
|
-
# FORMATTED_VALUE.
|
445
|
-
# The default dateTime render option is [DateTimeRenderOption.SERIAL_NUMBER].
|
446
|
-
# @param [Boolean] include_values_in_response
|
447
|
-
# Determines if the update response should include the values
|
448
|
-
# of the cells that were updated. By default, responses
|
449
|
-
# do not include the updated values.
|
450
|
-
# If the range to write was larger than than the range actually written,
|
451
|
-
# the response will include all values in the requested range (excluding
|
452
|
-
# trailing empty rows and columns).
|
441
|
+
# @param [Google::Apis::SheetsV4::BatchClearValuesRequest] batch_clear_values_request_object
|
442
|
+
# @param [String] fields
|
443
|
+
# Selector specifying which fields to include in a partial response.
|
453
444
|
# @param [String] quota_user
|
454
445
|
# Available to use for quota purposes for server-side applications. Can be any
|
455
446
|
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
456
|
-
# @param [String] fields
|
457
|
-
# Selector specifying which fields to include in a partial response.
|
458
447
|
# @param [Google::Apis::RequestOptions] options
|
459
448
|
# Request-specific options
|
460
449
|
#
|
461
450
|
# @yield [result, err] Result & error if block supplied
|
462
|
-
# @yieldparam result [Google::Apis::SheetsV4::
|
451
|
+
# @yieldparam result [Google::Apis::SheetsV4::BatchClearValuesResponse] parsed result object
|
463
452
|
# @yieldparam err [StandardError] error object if request failed
|
464
453
|
#
|
465
|
-
# @return [Google::Apis::SheetsV4::
|
454
|
+
# @return [Google::Apis::SheetsV4::BatchClearValuesResponse]
|
466
455
|
#
|
467
456
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
468
457
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
469
458
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
470
|
-
def
|
471
|
-
command = make_simple_command(:
|
472
|
-
command.request_representation = Google::Apis::SheetsV4::
|
473
|
-
command.request_object =
|
474
|
-
command.response_representation = Google::Apis::SheetsV4::
|
475
|
-
command.response_class = Google::Apis::SheetsV4::
|
459
|
+
def batch_clear_values(spreadsheet_id, batch_clear_values_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
460
|
+
command = make_simple_command(:post, 'v4/spreadsheets/{spreadsheetId}/values:batchClear', options)
|
461
|
+
command.request_representation = Google::Apis::SheetsV4::BatchClearValuesRequest::Representation
|
462
|
+
command.request_object = batch_clear_values_request_object
|
463
|
+
command.response_representation = Google::Apis::SheetsV4::BatchClearValuesResponse::Representation
|
464
|
+
command.response_class = Google::Apis::SheetsV4::BatchClearValuesResponse
|
476
465
|
command.params['spreadsheetId'] = spreadsheet_id unless spreadsheet_id.nil?
|
477
|
-
command.params['range'] = range unless range.nil?
|
478
|
-
command.query['responseValueRenderOption'] = response_value_render_option unless response_value_render_option.nil?
|
479
|
-
command.query['valueInputOption'] = value_input_option unless value_input_option.nil?
|
480
|
-
command.query['responseDateTimeRenderOption'] = response_date_time_render_option unless response_date_time_render_option.nil?
|
481
|
-
command.query['includeValuesInResponse'] = include_values_in_response unless include_values_in_response.nil?
|
482
|
-
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
483
466
|
command.query['fields'] = fields unless fields.nil?
|
467
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
484
468
|
execute_or_queue_command(command, &block)
|
485
469
|
end
|
486
470
|
|
487
|
-
#
|
488
|
-
# The caller must specify the spreadsheet ID and
|
489
|
-
# Only values are cleared -- all other properties of the cell (such as
|
490
|
-
# formatting, data validation, etc..) are kept.
|
471
|
+
# Returns a range of values from a spreadsheet.
|
472
|
+
# The caller must specify the spreadsheet ID and a range.
|
491
473
|
# @param [String] spreadsheet_id
|
492
|
-
# The ID of the spreadsheet to
|
493
|
-
# @param [
|
474
|
+
# The ID of the spreadsheet to retrieve data from.
|
475
|
+
# @param [String] range
|
476
|
+
# The A1 notation of the values to retrieve.
|
477
|
+
# @param [String] value_render_option
|
478
|
+
# How values should be represented in the output.
|
479
|
+
# The default render option is ValueRenderOption.FORMATTED_VALUE.
|
480
|
+
# @param [String] date_time_render_option
|
481
|
+
# How dates, times, and durations should be represented in the output.
|
482
|
+
# This is ignored if value_render_option is
|
483
|
+
# FORMATTED_VALUE.
|
484
|
+
# The default dateTime render option is [DateTimeRenderOption.SERIAL_NUMBER].
|
485
|
+
# @param [String] major_dimension
|
486
|
+
# The major dimension that results should use.
|
487
|
+
# For example, if the spreadsheet data is: `A1=1,B1=2,A2=3,B2=4`,
|
488
|
+
# then requesting `range=A1:B2,majorDimension=ROWS` will return
|
489
|
+
# `[[1,2],[3,4]]`,
|
490
|
+
# whereas requesting `range=A1:B2,majorDimension=COLUMNS` will return
|
491
|
+
# `[[1,3],[2,4]]`.
|
492
|
+
# @param [String] fields
|
493
|
+
# Selector specifying which fields to include in a partial response.
|
494
494
|
# @param [String] quota_user
|
495
495
|
# Available to use for quota purposes for server-side applications. Can be any
|
496
496
|
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
497
|
-
# @param [String] fields
|
498
|
-
# Selector specifying which fields to include in a partial response.
|
499
497
|
# @param [Google::Apis::RequestOptions] options
|
500
498
|
# Request-specific options
|
501
499
|
#
|
502
500
|
# @yield [result, err] Result & error if block supplied
|
503
|
-
# @yieldparam result [Google::Apis::SheetsV4::
|
501
|
+
# @yieldparam result [Google::Apis::SheetsV4::ValueRange] parsed result object
|
504
502
|
# @yieldparam err [StandardError] error object if request failed
|
505
503
|
#
|
506
|
-
# @return [Google::Apis::SheetsV4::
|
504
|
+
# @return [Google::Apis::SheetsV4::ValueRange]
|
507
505
|
#
|
508
506
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
509
507
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
510
508
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
511
|
-
def
|
512
|
-
command = make_simple_command(:
|
513
|
-
command.
|
514
|
-
command.
|
515
|
-
command.response_representation = Google::Apis::SheetsV4::BatchClearValuesResponse::Representation
|
516
|
-
command.response_class = Google::Apis::SheetsV4::BatchClearValuesResponse
|
509
|
+
def get_spreadsheet_values(spreadsheet_id, range, value_render_option: nil, date_time_render_option: nil, major_dimension: nil, fields: nil, quota_user: nil, options: nil, &block)
|
510
|
+
command = make_simple_command(:get, 'v4/spreadsheets/{spreadsheetId}/values/{range}', options)
|
511
|
+
command.response_representation = Google::Apis::SheetsV4::ValueRange::Representation
|
512
|
+
command.response_class = Google::Apis::SheetsV4::ValueRange
|
517
513
|
command.params['spreadsheetId'] = spreadsheet_id unless spreadsheet_id.nil?
|
518
|
-
command.
|
514
|
+
command.params['range'] = range unless range.nil?
|
515
|
+
command.query['valueRenderOption'] = value_render_option unless value_render_option.nil?
|
516
|
+
command.query['dateTimeRenderOption'] = date_time_render_option unless date_time_render_option.nil?
|
517
|
+
command.query['majorDimension'] = major_dimension unless major_dimension.nil?
|
519
518
|
command.query['fields'] = fields unless fields.nil?
|
519
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
520
520
|
execute_or_queue_command(command, &block)
|
521
521
|
end
|
522
522
|
|
@@ -527,11 +527,11 @@ module Google
|
|
527
527
|
# @param [Fixnum] sheet_id
|
528
528
|
# The ID of the sheet to copy.
|
529
529
|
# @param [Google::Apis::SheetsV4::CopySheetToAnotherSpreadsheetRequest] copy_sheet_to_another_spreadsheet_request_object
|
530
|
+
# @param [String] fields
|
531
|
+
# Selector specifying which fields to include in a partial response.
|
530
532
|
# @param [String] quota_user
|
531
533
|
# Available to use for quota purposes for server-side applications. Can be any
|
532
534
|
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
533
|
-
# @param [String] fields
|
534
|
-
# Selector specifying which fields to include in a partial response.
|
535
535
|
# @param [Google::Apis::RequestOptions] options
|
536
536
|
# Request-specific options
|
537
537
|
#
|
@@ -544,7 +544,7 @@ module Google
|
|
544
544
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
545
545
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
546
546
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
547
|
-
def copy_spreadsheet(spreadsheet_id, sheet_id, copy_sheet_to_another_spreadsheet_request_object = nil,
|
547
|
+
def copy_spreadsheet(spreadsheet_id, sheet_id, copy_sheet_to_another_spreadsheet_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
548
548
|
command = make_simple_command(:post, 'v4/spreadsheets/{spreadsheetId}/sheets/{sheetId}:copyTo', options)
|
549
549
|
command.request_representation = Google::Apis::SheetsV4::CopySheetToAnotherSpreadsheetRequest::Representation
|
550
550
|
command.request_object = copy_sheet_to_another_spreadsheet_request_object
|
@@ -552,8 +552,8 @@ module Google
|
|
552
552
|
command.response_class = Google::Apis::SheetsV4::SheetProperties
|
553
553
|
command.params['spreadsheetId'] = spreadsheet_id unless spreadsheet_id.nil?
|
554
554
|
command.params['sheetId'] = sheet_id unless sheet_id.nil?
|
555
|
-
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
556
555
|
command.query['fields'] = fields unless fields.nil?
|
556
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
557
557
|
execute_or_queue_command(command, &block)
|
558
558
|
end
|
559
559
|
|