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