google-api-client 0.13.0 → 0.13.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +3 -0
- data/README.md +6 -2
- data/generated/google/apis/acceleratedmobilepageurl_v1/classes.rb +46 -46
- data/generated/google/apis/acceleratedmobilepageurl_v1/representations.rb +15 -15
- data/generated/google/apis/acceleratedmobilepageurl_v1/service.rb +4 -4
- data/generated/google/apis/adexchangebuyer2_v2beta1.rb +1 -1
- data/generated/google/apis/adexchangebuyer2_v2beta1/classes.rb +404 -435
- data/generated/google/apis/adexchangebuyer2_v2beta1/representations.rb +107 -121
- data/generated/google/apis/adexchangebuyer2_v2beta1/service.rb +657 -713
- data/generated/google/apis/admin_directory_v1.rb +1 -1
- data/generated/google/apis/admin_directory_v1/classes.rb +45 -5
- data/generated/google/apis/admin_directory_v1/representations.rb +16 -0
- data/generated/google/apis/admin_directory_v1/service.rb +4 -1
- data/generated/google/apis/admin_reports_v1.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/analyticsreporting_v4.rb +1 -1
- data/generated/google/apis/analyticsreporting_v4/classes.rb +399 -399
- data/generated/google/apis/analyticsreporting_v4/representations.rb +101 -101
- data/generated/google/apis/analyticsreporting_v4/service.rb +10 -10
- data/generated/google/apis/androidenterprise_v1.rb +1 -1
- data/generated/google/apis/appengine_v1.rb +4 -4
- data/generated/google/apis/appengine_v1/classes.rb +747 -747
- data/generated/google/apis/appengine_v1/representations.rb +158 -158
- data/generated/google/apis/appengine_v1/service.rb +214 -214
- data/generated/google/apis/appsactivity_v1.rb +1 -1
- data/generated/google/apis/appstate_v1.rb +1 -1
- data/generated/google/apis/bigquery_v2.rb +1 -1
- data/generated/google/apis/bigquery_v2/classes.rb +6 -0
- data/generated/google/apis/bigquery_v2/representations.rb +2 -0
- data/generated/google/apis/calendar_v3.rb +1 -1
- data/generated/google/apis/classroom_v1.rb +7 -7
- data/generated/google/apis/classroom_v1/classes.rb +517 -515
- data/generated/google/apis/classroom_v1/representations.rb +147 -147
- data/generated/google/apis/classroom_v1/service.rb +1144 -1143
- data/generated/google/apis/cloudbuild_v1.rb +1 -1
- data/generated/google/apis/cloudbuild_v1/classes.rb +435 -386
- data/generated/google/apis/cloudbuild_v1/representations.rb +133 -115
- data/generated/google/apis/cloudbuild_v1/service.rb +148 -148
- data/generated/google/apis/clouddebugger_v2.rb +1 -1
- data/generated/google/apis/clouddebugger_v2/classes.rb +708 -708
- data/generated/google/apis/clouddebugger_v2/representations.rb +146 -146
- data/generated/google/apis/clouddebugger_v2/service.rb +124 -124
- data/generated/google/apis/clouderrorreporting_v1beta1.rb +1 -1
- data/generated/google/apis/clouderrorreporting_v1beta1/classes.rb +142 -142
- data/generated/google/apis/clouderrorreporting_v1beta1/representations.rb +29 -29
- data/generated/google/apis/clouderrorreporting_v1beta1/service.rb +87 -87
- data/generated/google/apis/cloudfunctions_v1.rb +1 -1
- data/generated/google/apis/cloudfunctions_v1/service.rb +6 -6
- data/generated/google/apis/cloudkms_v1.rb +1 -1
- data/generated/google/apis/cloudkms_v1/classes.rb +692 -675
- data/generated/google/apis/cloudkms_v1/representations.rb +144 -144
- data/generated/google/apis/cloudkms_v1/service.rb +276 -276
- data/generated/google/apis/cloudresourcemanager_v1.rb +1 -1
- data/generated/google/apis/cloudresourcemanager_v1/classes.rb +1168 -1168
- data/generated/google/apis/cloudresourcemanager_v1/representations.rb +190 -190
- data/generated/google/apis/cloudresourcemanager_v1/service.rb +311 -288
- data/generated/google/apis/cloudresourcemanager_v1beta1.rb +4 -4
- data/generated/google/apis/cloudresourcemanager_v1beta1/classes.rb +406 -406
- data/generated/google/apis/cloudresourcemanager_v1beta1/representations.rb +95 -95
- data/generated/google/apis/cloudresourcemanager_v1beta1/service.rb +242 -234
- data/generated/google/apis/cloudtrace_v1.rb +4 -4
- data/generated/google/apis/cloudtrace_v1/classes.rb +68 -68
- data/generated/google/apis/cloudtrace_v1/representations.rb +22 -22
- data/generated/google/apis/cloudtrace_v1/service.rb +48 -48
- data/generated/google/apis/compute_beta.rb +1 -1
- data/generated/google/apis/compute_beta/classes.rb +82 -6
- data/generated/google/apis/compute_beta/representations.rb +4 -0
- data/generated/google/apis/compute_beta/service.rb +1177 -834
- data/generated/google/apis/compute_v1.rb +1 -1
- data/generated/google/apis/compute_v1/classes.rb +371 -1
- data/generated/google/apis/compute_v1/representations.rb +139 -0
- data/generated/google/apis/compute_v1/service.rb +257 -9
- data/generated/google/apis/container_v1.rb +1 -1
- data/generated/google/apis/container_v1/classes.rb +1122 -826
- data/generated/google/apis/container_v1/representations.rb +279 -135
- data/generated/google/apis/container_v1/service.rb +440 -98
- data/generated/google/apis/content_v2.rb +1 -1
- data/generated/google/apis/content_v2/service.rb +3 -1
- data/generated/google/apis/customsearch_v1.rb +1 -1
- data/generated/google/apis/dataflow_v1b3.rb +4 -4
- data/generated/google/apis/dataflow_v1b3/classes.rb +3423 -3423
- data/generated/google/apis/dataflow_v1b3/representations.rb +813 -813
- data/generated/google/apis/dataflow_v1b3/service.rb +410 -410
- data/generated/google/apis/dataproc_v1.rb +1 -1
- data/generated/google/apis/dataproc_v1/classes.rb +450 -431
- data/generated/google/apis/dataproc_v1/representations.rb +92 -92
- data/generated/google/apis/dataproc_v1/service.rb +200 -200
- data/generated/google/apis/datastore_v1.rb +4 -4
- data/generated/google/apis/datastore_v1/classes.rb +397 -397
- data/generated/google/apis/datastore_v1/representations.rb +100 -100
- data/generated/google/apis/datastore_v1/service.rb +62 -62
- data/generated/google/apis/deploymentmanager_v2.rb +1 -1
- data/generated/google/apis/deploymentmanager_v2/classes.rb +79 -3
- data/generated/google/apis/deploymentmanager_v2/representations.rb +33 -0
- data/generated/google/apis/deploymentmanager_v2/service.rb +15 -20
- data/generated/google/apis/dns_v1.rb +1 -1
- data/generated/google/apis/dns_v2beta1.rb +1 -1
- data/generated/google/apis/doubleclickbidmanager_v1.rb +1 -1
- data/generated/google/apis/doubleclickbidmanager_v1/classes.rb +2 -2
- data/generated/google/apis/doubleclicksearch_v2.rb +1 -1
- data/generated/google/apis/drive_v2.rb +1 -1
- data/generated/google/apis/drive_v2/service.rb +1 -1
- data/generated/google/apis/drive_v3.rb +1 -1
- data/generated/google/apis/drive_v3/service.rb +1 -1
- data/generated/google/apis/firebasedynamiclinks_v1.rb +1 -1
- data/generated/google/apis/firebasedynamiclinks_v1/classes.rb +87 -87
- data/generated/google/apis/firebasedynamiclinks_v1/representations.rb +27 -27
- data/generated/google/apis/firebaserules_v1/classes.rb +271 -271
- data/generated/google/apis/firebaserules_v1/representations.rb +82 -82
- data/generated/google/apis/firebaserules_v1/service.rb +151 -151
- 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/genomics_v1.rb +9 -9
- data/generated/google/apis/genomics_v1/classes.rb +2242 -2242
- data/generated/google/apis/genomics_v1/representations.rb +306 -306
- data/generated/google/apis/genomics_v1/service.rb +1172 -1172
- data/generated/google/apis/gmail_v1.rb +1 -1
- data/generated/google/apis/iam_v1.rb +1 -1
- data/generated/google/apis/iam_v1/classes.rb +243 -243
- data/generated/google/apis/iam_v1/representations.rb +79 -79
- data/generated/google/apis/iam_v1/service.rb +137 -137
- data/generated/google/apis/identitytoolkit_v3.rb +1 -1
- data/generated/google/apis/identitytoolkit_v3/classes.rb +18 -0
- data/generated/google/apis/identitytoolkit_v3/representations.rb +3 -0
- data/generated/google/apis/kgsearch_v1/classes.rb +9 -9
- data/generated/google/apis/kgsearch_v1/representations.rb +2 -2
- data/generated/google/apis/kgsearch_v1/service.rb +4 -4
- data/generated/google/apis/language_v1.rb +1 -1
- data/generated/google/apis/language_v1/classes.rb +451 -451
- data/generated/google/apis/language_v1/representations.rb +103 -103
- data/generated/google/apis/language_v1/service.rb +49 -49
- data/generated/google/apis/language_v1beta1.rb +1 -1
- data/generated/google/apis/language_v1beta1/classes.rb +459 -459
- data/generated/google/apis/language_v1beta1/representations.rb +110 -110
- data/generated/google/apis/language_v1beta1/service.rb +43 -43
- data/generated/google/apis/logging_v2.rb +8 -8
- data/generated/google/apis/logging_v2/classes.rb +915 -915
- data/generated/google/apis/logging_v2/representations.rb +142 -142
- data/generated/google/apis/logging_v2/service.rb +415 -415
- data/generated/google/apis/logging_v2beta1.rb +8 -8
- data/generated/google/apis/logging_v2beta1/classes.rb +905 -905
- data/generated/google/apis/logging_v2beta1/representations.rb +150 -150
- data/generated/google/apis/logging_v2beta1/service.rb +221 -221
- data/generated/google/apis/manufacturers_v1.rb +1 -1
- data/generated/google/apis/manufacturers_v1/classes.rb +334 -315
- data/generated/google/apis/manufacturers_v1/representations.rb +99 -87
- data/generated/google/apis/manufacturers_v1/service.rb +101 -4
- data/generated/google/apis/ml_v1.rb +1 -1
- data/generated/google/apis/ml_v1/classes.rb +709 -673
- data/generated/google/apis/ml_v1/representations.rb +154 -151
- data/generated/google/apis/ml_v1/service.rb +341 -354
- data/generated/google/apis/monitoring_v3.rb +6 -6
- data/generated/google/apis/monitoring_v3/classes.rb +869 -869
- data/generated/google/apis/monitoring_v3/representations.rb +171 -171
- data/generated/google/apis/monitoring_v3/service.rb +340 -340
- data/generated/google/apis/partners_v2.rb +1 -1
- data/generated/google/apis/partners_v2/classes.rb +1569 -1569
- data/generated/google/apis/partners_v2/representations.rb +256 -256
- data/generated/google/apis/partners_v2/service.rb +530 -530
- data/generated/google/apis/people_v1.rb +7 -7
- data/generated/google/apis/people_v1/classes.rb +1287 -946
- data/generated/google/apis/people_v1/representations.rb +355 -203
- data/generated/google/apis/people_v1/service.rb +409 -32
- data/generated/google/apis/plus_domains_v1.rb +1 -1
- data/generated/google/apis/plus_v1.rb +1 -1
- data/generated/google/apis/proximitybeacon_v1beta1.rb +1 -1
- data/generated/google/apis/proximitybeacon_v1beta1/classes.rb +445 -445
- data/generated/google/apis/proximitybeacon_v1beta1/representations.rb +104 -104
- data/generated/google/apis/proximitybeacon_v1beta1/service.rb +241 -241
- data/generated/google/apis/pubsub_v1.rb +4 -4
- data/generated/google/apis/pubsub_v1/classes.rb +286 -287
- data/generated/google/apis/pubsub_v1/representations.rb +80 -80
- data/generated/google/apis/pubsub_v1/service.rb +178 -178
- data/generated/google/apis/runtimeconfig_v1.rb +1 -1
- data/generated/google/apis/runtimeconfig_v1/classes.rb +52 -52
- data/generated/google/apis/runtimeconfig_v1/representations.rb +15 -15
- data/generated/google/apis/runtimeconfig_v1/service.rb +21 -21
- data/generated/google/apis/script_v1.rb +4 -4
- data/generated/google/apis/script_v1/classes.rb +172 -172
- data/generated/google/apis/script_v1/representations.rb +41 -41
- data/generated/google/apis/script_v1/service.rb +6 -6
- data/generated/google/apis/searchconsole_v1.rb +1 -1
- data/generated/google/apis/searchconsole_v1/classes.rb +6 -6
- data/generated/google/apis/searchconsole_v1/representations.rb +1 -1
- data/generated/google/apis/servicecontrol_v1.rb +1 -1
- data/generated/google/apis/servicecontrol_v1/classes.rb +1110 -1110
- data/generated/google/apis/servicecontrol_v1/representations.rb +215 -215
- data/generated/google/apis/servicecontrol_v1/service.rb +65 -65
- data/generated/google/apis/servicemanagement_v1.rb +6 -6
- data/generated/google/apis/servicemanagement_v1/classes.rb +3594 -3562
- data/generated/google/apis/servicemanagement_v1/representations.rb +564 -562
- data/generated/google/apis/servicemanagement_v1/service.rb +253 -253
- data/generated/google/apis/serviceuser_v1.rb +1 -1
- data/generated/google/apis/serviceuser_v1/classes.rb +2678 -2670
- data/generated/google/apis/serviceuser_v1/representations.rb +269 -268
- data/generated/google/apis/serviceuser_v1/service.rb +59 -59
- data/generated/google/apis/sheets_v4.rb +5 -5
- data/generated/google/apis/sheets_v4/classes.rb +5155 -5104
- data/generated/google/apis/sheets_v4/representations.rb +957 -940
- data/generated/google/apis/sheets_v4/service.rb +175 -175
- data/generated/google/apis/slides_v1.rb +1 -1
- data/generated/google/apis/slides_v1/classes.rb +2932 -2905
- data/generated/google/apis/slides_v1/representations.rb +709 -694
- data/generated/google/apis/slides_v1/service.rb +50 -50
- data/generated/google/apis/sourcerepo_v1/classes.rb +139 -139
- data/generated/google/apis/sourcerepo_v1/representations.rb +40 -40
- data/generated/google/apis/sourcerepo_v1/service.rb +61 -61
- data/generated/google/apis/spanner_v1.rb +7 -1
- data/generated/google/apis/spanner_v1/classes.rb +2362 -2299
- data/generated/google/apis/spanner_v1/representations.rb +342 -323
- data/generated/google/apis/spanner_v1/service.rb +502 -492
- data/generated/google/apis/speech_v1beta1.rb +1 -1
- data/generated/google/apis/speech_v1beta1/classes.rb +244 -244
- data/generated/google/apis/speech_v1beta1/representations.rb +52 -52
- data/generated/google/apis/speech_v1beta1/service.rb +91 -91
- data/generated/google/apis/storage_v1.rb +1 -1
- data/generated/google/apis/storagetransfer_v1.rb +1 -1
- data/generated/google/apis/storagetransfer_v1/classes.rb +784 -781
- data/generated/google/apis/storagetransfer_v1/representations.rb +88 -88
- data/generated/google/apis/storagetransfer_v1/service.rb +154 -154
- data/generated/google/apis/toolresults_v1beta3.rb +1 -1
- data/generated/google/apis/toolresults_v1beta3/classes.rb +90 -1
- data/generated/google/apis/toolresults_v1beta3/representations.rb +18 -0
- data/generated/google/apis/translate_v2/classes.rb +107 -107
- data/generated/google/apis/translate_v2/representations.rb +49 -49
- data/generated/google/apis/translate_v2/service.rb +81 -81
- data/generated/google/apis/vision_v1.rb +4 -1
- data/generated/google/apis/vision_v1/classes.rb +527 -527
- data/generated/google/apis/vision_v1/representations.rb +115 -115
- 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 +124 -124
- data/generated/google/apis/youtubereporting_v1/representations.rb +30 -30
- data/generated/google/apis/youtubereporting_v1/service.rb +113 -113
- data/lib/google/apis/version.rb +1 -1
- data/samples/cli/lib/samples/analytics.rb +2 -2
- metadata +2 -2
|
@@ -65,16 +65,16 @@ module Google
|
|
|
65
65
|
# ranges. Ranges are specified using A1 notation.
|
|
66
66
|
# @param [String] spreadsheet_id
|
|
67
67
|
# The spreadsheet to request.
|
|
68
|
-
# @param [Array<String>, String] ranges
|
|
69
|
-
# The ranges to retrieve from the spreadsheet.
|
|
70
68
|
# @param [Boolean] include_grid_data
|
|
71
69
|
# True if grid data should be returned.
|
|
72
70
|
# This parameter is ignored if a field mask was set in the request.
|
|
73
|
-
# @param [String]
|
|
74
|
-
#
|
|
71
|
+
# @param [Array<String>, String] ranges
|
|
72
|
+
# The ranges to retrieve from the spreadsheet.
|
|
75
73
|
# @param [String] quota_user
|
|
76
74
|
# Available to use for quota purposes for server-side applications. Can be any
|
|
77
75
|
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
76
|
+
# @param [String] fields
|
|
77
|
+
# Selector specifying which fields to include in a partial response.
|
|
78
78
|
# @param [Google::Apis::RequestOptions] options
|
|
79
79
|
# Request-specific options
|
|
80
80
|
#
|
|
@@ -87,45 +87,15 @@ module Google
|
|
|
87
87
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
88
88
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
89
89
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
90
|
-
def get_spreadsheet(spreadsheet_id,
|
|
90
|
+
def get_spreadsheet(spreadsheet_id, include_grid_data: nil, ranges: nil, quota_user: nil, fields: nil, options: nil, &block)
|
|
91
91
|
command = make_simple_command(:get, 'v4/spreadsheets/{spreadsheetId}', options)
|
|
92
92
|
command.response_representation = Google::Apis::SheetsV4::Spreadsheet::Representation
|
|
93
93
|
command.response_class = Google::Apis::SheetsV4::Spreadsheet
|
|
94
94
|
command.params['spreadsheetId'] = spreadsheet_id unless spreadsheet_id.nil?
|
|
95
|
-
command.query['ranges'] = ranges unless ranges.nil?
|
|
96
95
|
command.query['includeGridData'] = include_grid_data unless include_grid_data.nil?
|
|
97
|
-
command.query['
|
|
96
|
+
command.query['ranges'] = ranges unless ranges.nil?
|
|
98
97
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
99
|
-
execute_or_queue_command(command, &block)
|
|
100
|
-
end
|
|
101
|
-
|
|
102
|
-
# Creates a spreadsheet, returning the newly created spreadsheet.
|
|
103
|
-
# @param [Google::Apis::SheetsV4::Spreadsheet] spreadsheet_object
|
|
104
|
-
# @param [String] fields
|
|
105
|
-
# Selector specifying which fields to include in a partial response.
|
|
106
|
-
# @param [String] quota_user
|
|
107
|
-
# Available to use for quota purposes for server-side applications. Can be any
|
|
108
|
-
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
109
|
-
# @param [Google::Apis::RequestOptions] options
|
|
110
|
-
# Request-specific options
|
|
111
|
-
#
|
|
112
|
-
# @yield [result, err] Result & error if block supplied
|
|
113
|
-
# @yieldparam result [Google::Apis::SheetsV4::Spreadsheet] parsed result object
|
|
114
|
-
# @yieldparam err [StandardError] error object if request failed
|
|
115
|
-
#
|
|
116
|
-
# @return [Google::Apis::SheetsV4::Spreadsheet]
|
|
117
|
-
#
|
|
118
|
-
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
119
|
-
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
120
|
-
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
121
|
-
def create_spreadsheet(spreadsheet_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
122
|
-
command = make_simple_command(:post, 'v4/spreadsheets', options)
|
|
123
|
-
command.request_representation = Google::Apis::SheetsV4::Spreadsheet::Representation
|
|
124
|
-
command.request_object = spreadsheet_object
|
|
125
|
-
command.response_representation = Google::Apis::SheetsV4::Spreadsheet::Representation
|
|
126
|
-
command.response_class = Google::Apis::SheetsV4::Spreadsheet
|
|
127
98
|
command.query['fields'] = fields unless fields.nil?
|
|
128
|
-
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
129
99
|
execute_or_queue_command(command, &block)
|
|
130
100
|
end
|
|
131
101
|
|
|
@@ -148,11 +118,11 @@ module Google
|
|
|
148
118
|
# @param [String] spreadsheet_id
|
|
149
119
|
# The spreadsheet to apply the updates to.
|
|
150
120
|
# @param [Google::Apis::SheetsV4::BatchUpdateSpreadsheetRequest] batch_update_spreadsheet_request_object
|
|
151
|
-
# @param [String] fields
|
|
152
|
-
# Selector specifying which fields to include in a partial response.
|
|
153
121
|
# @param [String] quota_user
|
|
154
122
|
# Available to use for quota purposes for server-side applications. Can be any
|
|
155
123
|
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
124
|
+
# @param [String] fields
|
|
125
|
+
# Selector specifying which fields to include in a partial response.
|
|
156
126
|
# @param [Google::Apis::RequestOptions] options
|
|
157
127
|
# Request-specific options
|
|
158
128
|
#
|
|
@@ -165,62 +135,53 @@ module Google
|
|
|
165
135
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
166
136
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
167
137
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
168
|
-
def batch_update_spreadsheet(spreadsheet_id, batch_update_spreadsheet_request_object = nil,
|
|
138
|
+
def batch_update_spreadsheet(spreadsheet_id, batch_update_spreadsheet_request_object = nil, quota_user: nil, fields: nil, options: nil, &block)
|
|
169
139
|
command = make_simple_command(:post, 'v4/spreadsheets/{spreadsheetId}:batchUpdate', options)
|
|
170
140
|
command.request_representation = Google::Apis::SheetsV4::BatchUpdateSpreadsheetRequest::Representation
|
|
171
141
|
command.request_object = batch_update_spreadsheet_request_object
|
|
172
142
|
command.response_representation = Google::Apis::SheetsV4::BatchUpdateSpreadsheetResponse::Representation
|
|
173
143
|
command.response_class = Google::Apis::SheetsV4::BatchUpdateSpreadsheetResponse
|
|
174
144
|
command.params['spreadsheetId'] = spreadsheet_id unless spreadsheet_id.nil?
|
|
175
|
-
command.query['fields'] = fields unless fields.nil?
|
|
176
145
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
146
|
+
command.query['fields'] = fields unless fields.nil?
|
|
177
147
|
execute_or_queue_command(command, &block)
|
|
178
148
|
end
|
|
179
149
|
|
|
180
|
-
#
|
|
181
|
-
#
|
|
182
|
-
# Only values are cleared -- all other properties of the cell (such as
|
|
183
|
-
# formatting, data validation, etc..) are kept.
|
|
184
|
-
# @param [String] spreadsheet_id
|
|
185
|
-
# The ID of the spreadsheet to update.
|
|
186
|
-
# @param [String] range
|
|
187
|
-
# The A1 notation of the values to clear.
|
|
188
|
-
# @param [Google::Apis::SheetsV4::ClearValuesRequest] clear_values_request_object
|
|
189
|
-
# @param [String] fields
|
|
190
|
-
# Selector specifying which fields to include in a partial response.
|
|
150
|
+
# Creates a spreadsheet, returning the newly created spreadsheet.
|
|
151
|
+
# @param [Google::Apis::SheetsV4::Spreadsheet] spreadsheet_object
|
|
191
152
|
# @param [String] quota_user
|
|
192
153
|
# Available to use for quota purposes for server-side applications. Can be any
|
|
193
154
|
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
155
|
+
# @param [String] fields
|
|
156
|
+
# Selector specifying which fields to include in a partial response.
|
|
194
157
|
# @param [Google::Apis::RequestOptions] options
|
|
195
158
|
# Request-specific options
|
|
196
159
|
#
|
|
197
160
|
# @yield [result, err] Result & error if block supplied
|
|
198
|
-
# @yieldparam result [Google::Apis::SheetsV4::
|
|
161
|
+
# @yieldparam result [Google::Apis::SheetsV4::Spreadsheet] parsed result object
|
|
199
162
|
# @yieldparam err [StandardError] error object if request failed
|
|
200
163
|
#
|
|
201
|
-
# @return [Google::Apis::SheetsV4::
|
|
164
|
+
# @return [Google::Apis::SheetsV4::Spreadsheet]
|
|
202
165
|
#
|
|
203
166
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
204
167
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
205
168
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
206
|
-
def
|
|
207
|
-
command = make_simple_command(:post, 'v4/spreadsheets
|
|
208
|
-
command.request_representation = Google::Apis::SheetsV4::
|
|
209
|
-
command.request_object =
|
|
210
|
-
command.response_representation = Google::Apis::SheetsV4::
|
|
211
|
-
command.response_class = Google::Apis::SheetsV4::
|
|
212
|
-
command.params['spreadsheetId'] = spreadsheet_id unless spreadsheet_id.nil?
|
|
213
|
-
command.params['range'] = range unless range.nil?
|
|
214
|
-
command.query['fields'] = fields unless fields.nil?
|
|
169
|
+
def create_spreadsheet(spreadsheet_object = nil, quota_user: nil, fields: nil, options: nil, &block)
|
|
170
|
+
command = make_simple_command(:post, 'v4/spreadsheets', options)
|
|
171
|
+
command.request_representation = Google::Apis::SheetsV4::Spreadsheet::Representation
|
|
172
|
+
command.request_object = spreadsheet_object
|
|
173
|
+
command.response_representation = Google::Apis::SheetsV4::Spreadsheet::Representation
|
|
174
|
+
command.response_class = Google::Apis::SheetsV4::Spreadsheet
|
|
215
175
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
176
|
+
command.query['fields'] = fields unless fields.nil?
|
|
216
177
|
execute_or_queue_command(command, &block)
|
|
217
178
|
end
|
|
218
179
|
|
|
219
|
-
# Returns
|
|
220
|
-
# The caller must specify the spreadsheet ID and
|
|
180
|
+
# Returns a range of values from a spreadsheet.
|
|
181
|
+
# The caller must specify the spreadsheet ID and a range.
|
|
221
182
|
# @param [String] spreadsheet_id
|
|
222
183
|
# The ID of the spreadsheet to retrieve data from.
|
|
223
|
-
# @param [
|
|
184
|
+
# @param [String] range
|
|
224
185
|
# The A1 notation of the values to retrieve.
|
|
225
186
|
# @param [String] major_dimension
|
|
226
187
|
# The major dimension that results should use.
|
|
@@ -229,69 +190,56 @@ module Google
|
|
|
229
190
|
# `[[1,2],[3,4]]`,
|
|
230
191
|
# whereas requesting `range=A1:B2,majorDimension=COLUMNS` will return
|
|
231
192
|
# `[[1,3],[2,4]]`.
|
|
232
|
-
# @param [String] value_render_option
|
|
233
|
-
# How values should be represented in the output.
|
|
234
|
-
# The default render option is ValueRenderOption.FORMATTED_VALUE.
|
|
235
193
|
# @param [String] date_time_render_option
|
|
236
194
|
# How dates, times, and durations should be represented in the output.
|
|
237
195
|
# This is ignored if value_render_option is
|
|
238
196
|
# FORMATTED_VALUE.
|
|
239
197
|
# The default dateTime render option is [DateTimeRenderOption.SERIAL_NUMBER].
|
|
240
|
-
# @param [String]
|
|
241
|
-
#
|
|
198
|
+
# @param [String] value_render_option
|
|
199
|
+
# How values should be represented in the output.
|
|
200
|
+
# The default render option is ValueRenderOption.FORMATTED_VALUE.
|
|
242
201
|
# @param [String] quota_user
|
|
243
202
|
# Available to use for quota purposes for server-side applications. Can be any
|
|
244
203
|
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
204
|
+
# @param [String] fields
|
|
205
|
+
# Selector specifying which fields to include in a partial response.
|
|
245
206
|
# @param [Google::Apis::RequestOptions] options
|
|
246
207
|
# Request-specific options
|
|
247
208
|
#
|
|
248
209
|
# @yield [result, err] Result & error if block supplied
|
|
249
|
-
# @yieldparam result [Google::Apis::SheetsV4::
|
|
210
|
+
# @yieldparam result [Google::Apis::SheetsV4::ValueRange] parsed result object
|
|
250
211
|
# @yieldparam err [StandardError] error object if request failed
|
|
251
212
|
#
|
|
252
|
-
# @return [Google::Apis::SheetsV4::
|
|
213
|
+
# @return [Google::Apis::SheetsV4::ValueRange]
|
|
253
214
|
#
|
|
254
215
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
255
216
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
256
217
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
257
|
-
def
|
|
258
|
-
command = make_simple_command(:get, 'v4/spreadsheets/{spreadsheetId}/values
|
|
259
|
-
command.response_representation = Google::Apis::SheetsV4::
|
|
260
|
-
command.response_class = Google::Apis::SheetsV4::
|
|
218
|
+
def get_spreadsheet_values(spreadsheet_id, range, major_dimension: nil, date_time_render_option: nil, value_render_option: nil, quota_user: nil, fields: nil, options: nil, &block)
|
|
219
|
+
command = make_simple_command(:get, 'v4/spreadsheets/{spreadsheetId}/values/{range}', options)
|
|
220
|
+
command.response_representation = Google::Apis::SheetsV4::ValueRange::Representation
|
|
221
|
+
command.response_class = Google::Apis::SheetsV4::ValueRange
|
|
261
222
|
command.params['spreadsheetId'] = spreadsheet_id unless spreadsheet_id.nil?
|
|
262
|
-
command.
|
|
223
|
+
command.params['range'] = range unless range.nil?
|
|
263
224
|
command.query['majorDimension'] = major_dimension unless major_dimension.nil?
|
|
264
|
-
command.query['valueRenderOption'] = value_render_option unless value_render_option.nil?
|
|
265
225
|
command.query['dateTimeRenderOption'] = date_time_render_option unless date_time_render_option.nil?
|
|
266
|
-
command.query['
|
|
226
|
+
command.query['valueRenderOption'] = value_render_option unless value_render_option.nil?
|
|
267
227
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
228
|
+
command.query['fields'] = fields unless fields.nil?
|
|
268
229
|
execute_or_queue_command(command, &block)
|
|
269
230
|
end
|
|
270
231
|
|
|
271
|
-
#
|
|
272
|
-
# existing data and find a "table" within that range. Values will be
|
|
273
|
-
# appended to the next row of the table, starting with the first column of
|
|
274
|
-
# the table. See the
|
|
275
|
-
# [guide](/sheets/api/guides/values#appending_values)
|
|
276
|
-
# and
|
|
277
|
-
# [sample code](/sheets/api/samples/writing#append_values)
|
|
278
|
-
# for specific details of how tables are detected and data is appended.
|
|
232
|
+
# Sets values in a range of a spreadsheet.
|
|
279
233
|
# The caller must specify the spreadsheet ID, range, and
|
|
280
|
-
# a valueInputOption.
|
|
281
|
-
# controls how the input data will be added to the sheet (column-wise or
|
|
282
|
-
# row-wise), it does not influence what cell the data starts being written
|
|
283
|
-
# to.
|
|
234
|
+
# a valueInputOption.
|
|
284
235
|
# @param [String] spreadsheet_id
|
|
285
236
|
# The ID of the spreadsheet to update.
|
|
286
237
|
# @param [String] range
|
|
287
|
-
# The A1 notation of
|
|
288
|
-
# Values will be appended after the last row of the table.
|
|
238
|
+
# The A1 notation of the values to update.
|
|
289
239
|
# @param [Google::Apis::SheetsV4::ValueRange] value_range_object
|
|
290
240
|
# @param [String] response_value_render_option
|
|
291
241
|
# Determines how values in the response should be rendered.
|
|
292
242
|
# The default render option is ValueRenderOption.FORMATTED_VALUE.
|
|
293
|
-
# @param [String] insert_data_option
|
|
294
|
-
# How the input data should be inserted.
|
|
295
243
|
# @param [String] value_input_option
|
|
296
244
|
# How the input data should be interpreted.
|
|
297
245
|
# @param [String] response_date_time_render_option
|
|
@@ -301,85 +249,85 @@ module Google
|
|
|
301
249
|
# The default dateTime render option is [DateTimeRenderOption.SERIAL_NUMBER].
|
|
302
250
|
# @param [Boolean] include_values_in_response
|
|
303
251
|
# Determines if the update response should include the values
|
|
304
|
-
# of the cells that were
|
|
252
|
+
# of the cells that were updated. By default, responses
|
|
305
253
|
# do not include the updated values.
|
|
306
|
-
#
|
|
307
|
-
#
|
|
254
|
+
# If the range to write was larger than than the range actually written,
|
|
255
|
+
# the response will include all values in the requested range (excluding
|
|
256
|
+
# trailing empty rows and columns).
|
|
308
257
|
# @param [String] quota_user
|
|
309
258
|
# Available to use for quota purposes for server-side applications. Can be any
|
|
310
259
|
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
260
|
+
# @param [String] fields
|
|
261
|
+
# Selector specifying which fields to include in a partial response.
|
|
311
262
|
# @param [Google::Apis::RequestOptions] options
|
|
312
263
|
# Request-specific options
|
|
313
264
|
#
|
|
314
265
|
# @yield [result, err] Result & error if block supplied
|
|
315
|
-
# @yieldparam result [Google::Apis::SheetsV4::
|
|
266
|
+
# @yieldparam result [Google::Apis::SheetsV4::UpdateValuesResponse] parsed result object
|
|
316
267
|
# @yieldparam err [StandardError] error object if request failed
|
|
317
268
|
#
|
|
318
|
-
# @return [Google::Apis::SheetsV4::
|
|
269
|
+
# @return [Google::Apis::SheetsV4::UpdateValuesResponse]
|
|
319
270
|
#
|
|
320
271
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
321
272
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
322
273
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
323
|
-
def
|
|
324
|
-
command = make_simple_command(:
|
|
274
|
+
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)
|
|
275
|
+
command = make_simple_command(:put, 'v4/spreadsheets/{spreadsheetId}/values/{range}', options)
|
|
325
276
|
command.request_representation = Google::Apis::SheetsV4::ValueRange::Representation
|
|
326
277
|
command.request_object = value_range_object
|
|
327
|
-
command.response_representation = Google::Apis::SheetsV4::
|
|
328
|
-
command.response_class = Google::Apis::SheetsV4::
|
|
278
|
+
command.response_representation = Google::Apis::SheetsV4::UpdateValuesResponse::Representation
|
|
279
|
+
command.response_class = Google::Apis::SheetsV4::UpdateValuesResponse
|
|
329
280
|
command.params['spreadsheetId'] = spreadsheet_id unless spreadsheet_id.nil?
|
|
330
281
|
command.params['range'] = range unless range.nil?
|
|
331
282
|
command.query['responseValueRenderOption'] = response_value_render_option unless response_value_render_option.nil?
|
|
332
|
-
command.query['insertDataOption'] = insert_data_option unless insert_data_option.nil?
|
|
333
283
|
command.query['valueInputOption'] = value_input_option unless value_input_option.nil?
|
|
334
284
|
command.query['responseDateTimeRenderOption'] = response_date_time_render_option unless response_date_time_render_option.nil?
|
|
335
285
|
command.query['includeValuesInResponse'] = include_values_in_response unless include_values_in_response.nil?
|
|
336
|
-
command.query['fields'] = fields unless fields.nil?
|
|
337
286
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
287
|
+
command.query['fields'] = fields unless fields.nil?
|
|
338
288
|
execute_or_queue_command(command, &block)
|
|
339
289
|
end
|
|
340
290
|
|
|
341
|
-
#
|
|
342
|
-
# The caller must specify the spreadsheet ID
|
|
343
|
-
#
|
|
344
|
-
#
|
|
291
|
+
# Sets values in one or more ranges of a spreadsheet.
|
|
292
|
+
# The caller must specify the spreadsheet ID,
|
|
293
|
+
# a valueInputOption, and one or more
|
|
294
|
+
# ValueRanges.
|
|
345
295
|
# @param [String] spreadsheet_id
|
|
346
296
|
# The ID of the spreadsheet to update.
|
|
347
|
-
# @param [Google::Apis::SheetsV4::
|
|
348
|
-
# @param [String] fields
|
|
349
|
-
# Selector specifying which fields to include in a partial response.
|
|
297
|
+
# @param [Google::Apis::SheetsV4::BatchUpdateValuesRequest] batch_update_values_request_object
|
|
350
298
|
# @param [String] quota_user
|
|
351
299
|
# Available to use for quota purposes for server-side applications. Can be any
|
|
352
300
|
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
301
|
+
# @param [String] fields
|
|
302
|
+
# Selector specifying which fields to include in a partial response.
|
|
353
303
|
# @param [Google::Apis::RequestOptions] options
|
|
354
304
|
# Request-specific options
|
|
355
305
|
#
|
|
356
306
|
# @yield [result, err] Result & error if block supplied
|
|
357
|
-
# @yieldparam result [Google::Apis::SheetsV4::
|
|
307
|
+
# @yieldparam result [Google::Apis::SheetsV4::BatchUpdateValuesResponse] parsed result object
|
|
358
308
|
# @yieldparam err [StandardError] error object if request failed
|
|
359
309
|
#
|
|
360
|
-
# @return [Google::Apis::SheetsV4::
|
|
310
|
+
# @return [Google::Apis::SheetsV4::BatchUpdateValuesResponse]
|
|
361
311
|
#
|
|
362
312
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
363
313
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
364
314
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
365
|
-
def
|
|
366
|
-
command = make_simple_command(:post, 'v4/spreadsheets/{spreadsheetId}/values:
|
|
367
|
-
command.request_representation = Google::Apis::SheetsV4::
|
|
368
|
-
command.request_object =
|
|
369
|
-
command.response_representation = Google::Apis::SheetsV4::
|
|
370
|
-
command.response_class = Google::Apis::SheetsV4::
|
|
315
|
+
def batch_update_values(spreadsheet_id, batch_update_values_request_object = nil, quota_user: nil, fields: nil, options: nil, &block)
|
|
316
|
+
command = make_simple_command(:post, 'v4/spreadsheets/{spreadsheetId}/values:batchUpdate', options)
|
|
317
|
+
command.request_representation = Google::Apis::SheetsV4::BatchUpdateValuesRequest::Representation
|
|
318
|
+
command.request_object = batch_update_values_request_object
|
|
319
|
+
command.response_representation = Google::Apis::SheetsV4::BatchUpdateValuesResponse::Representation
|
|
320
|
+
command.response_class = Google::Apis::SheetsV4::BatchUpdateValuesResponse
|
|
371
321
|
command.params['spreadsheetId'] = spreadsheet_id unless spreadsheet_id.nil?
|
|
372
|
-
command.query['fields'] = fields unless fields.nil?
|
|
373
322
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
323
|
+
command.query['fields'] = fields unless fields.nil?
|
|
374
324
|
execute_or_queue_command(command, &block)
|
|
375
325
|
end
|
|
376
326
|
|
|
377
|
-
# Returns
|
|
378
|
-
# The caller must specify the spreadsheet ID and
|
|
327
|
+
# Returns one or more ranges of values from a spreadsheet.
|
|
328
|
+
# The caller must specify the spreadsheet ID and one or more ranges.
|
|
379
329
|
# @param [String] spreadsheet_id
|
|
380
330
|
# The ID of the spreadsheet to retrieve data from.
|
|
381
|
-
# @param [String] range
|
|
382
|
-
# The A1 notation of the values to retrieve.
|
|
383
331
|
# @param [String] major_dimension
|
|
384
332
|
# The major dimension that results should use.
|
|
385
333
|
# For example, if the spreadsheet data is: `A1=1,B1=2,A2=3,B2=4`,
|
|
@@ -387,56 +335,110 @@ module Google
|
|
|
387
335
|
# `[[1,2],[3,4]]`,
|
|
388
336
|
# whereas requesting `range=A1:B2,majorDimension=COLUMNS` will return
|
|
389
337
|
# `[[1,3],[2,4]]`.
|
|
390
|
-
# @param [String]
|
|
391
|
-
#
|
|
392
|
-
# The default render option is ValueRenderOption.FORMATTED_VALUE.
|
|
338
|
+
# @param [Array<String>, String] ranges
|
|
339
|
+
# The A1 notation of the values to retrieve.
|
|
393
340
|
# @param [String] date_time_render_option
|
|
394
341
|
# How dates, times, and durations should be represented in the output.
|
|
395
342
|
# This is ignored if value_render_option is
|
|
396
343
|
# FORMATTED_VALUE.
|
|
397
344
|
# The default dateTime render option is [DateTimeRenderOption.SERIAL_NUMBER].
|
|
398
|
-
# @param [String]
|
|
399
|
-
#
|
|
345
|
+
# @param [String] value_render_option
|
|
346
|
+
# How values should be represented in the output.
|
|
347
|
+
# The default render option is ValueRenderOption.FORMATTED_VALUE.
|
|
400
348
|
# @param [String] quota_user
|
|
401
349
|
# Available to use for quota purposes for server-side applications. Can be any
|
|
402
350
|
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
351
|
+
# @param [String] fields
|
|
352
|
+
# Selector specifying which fields to include in a partial response.
|
|
403
353
|
# @param [Google::Apis::RequestOptions] options
|
|
404
354
|
# Request-specific options
|
|
405
355
|
#
|
|
406
356
|
# @yield [result, err] Result & error if block supplied
|
|
407
|
-
# @yieldparam result [Google::Apis::SheetsV4::
|
|
357
|
+
# @yieldparam result [Google::Apis::SheetsV4::BatchGetValuesResponse] parsed result object
|
|
408
358
|
# @yieldparam err [StandardError] error object if request failed
|
|
409
359
|
#
|
|
410
|
-
# @return [Google::Apis::SheetsV4::
|
|
360
|
+
# @return [Google::Apis::SheetsV4::BatchGetValuesResponse]
|
|
411
361
|
#
|
|
412
362
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
413
363
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
414
364
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
415
|
-
def
|
|
416
|
-
command = make_simple_command(:get, 'v4/spreadsheets/{spreadsheetId}/values
|
|
417
|
-
command.response_representation = Google::Apis::SheetsV4::
|
|
418
|
-
command.response_class = Google::Apis::SheetsV4::
|
|
365
|
+
def batch_get_spreadsheet_values(spreadsheet_id, major_dimension: nil, ranges: nil, date_time_render_option: nil, value_render_option: nil, quota_user: nil, fields: nil, options: nil, &block)
|
|
366
|
+
command = make_simple_command(:get, 'v4/spreadsheets/{spreadsheetId}/values:batchGet', options)
|
|
367
|
+
command.response_representation = Google::Apis::SheetsV4::BatchGetValuesResponse::Representation
|
|
368
|
+
command.response_class = Google::Apis::SheetsV4::BatchGetValuesResponse
|
|
419
369
|
command.params['spreadsheetId'] = spreadsheet_id unless spreadsheet_id.nil?
|
|
420
|
-
command.params['range'] = range unless range.nil?
|
|
421
370
|
command.query['majorDimension'] = major_dimension unless major_dimension.nil?
|
|
422
|
-
command.query['
|
|
371
|
+
command.query['ranges'] = ranges unless ranges.nil?
|
|
423
372
|
command.query['dateTimeRenderOption'] = date_time_render_option unless date_time_render_option.nil?
|
|
373
|
+
command.query['valueRenderOption'] = value_render_option unless value_render_option.nil?
|
|
374
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
424
375
|
command.query['fields'] = fields unless fields.nil?
|
|
376
|
+
execute_or_queue_command(command, &block)
|
|
377
|
+
end
|
|
378
|
+
|
|
379
|
+
# Clears values from a spreadsheet.
|
|
380
|
+
# The caller must specify the spreadsheet ID and range.
|
|
381
|
+
# Only values are cleared -- all other properties of the cell (such as
|
|
382
|
+
# formatting, data validation, etc..) are kept.
|
|
383
|
+
# @param [String] spreadsheet_id
|
|
384
|
+
# The ID of the spreadsheet to update.
|
|
385
|
+
# @param [String] range
|
|
386
|
+
# The A1 notation of the values to clear.
|
|
387
|
+
# @param [Google::Apis::SheetsV4::ClearValuesRequest] clear_values_request_object
|
|
388
|
+
# @param [String] quota_user
|
|
389
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
390
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
391
|
+
# @param [String] fields
|
|
392
|
+
# Selector specifying which fields to include in a partial response.
|
|
393
|
+
# @param [Google::Apis::RequestOptions] options
|
|
394
|
+
# Request-specific options
|
|
395
|
+
#
|
|
396
|
+
# @yield [result, err] Result & error if block supplied
|
|
397
|
+
# @yieldparam result [Google::Apis::SheetsV4::ClearValuesResponse] parsed result object
|
|
398
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
399
|
+
#
|
|
400
|
+
# @return [Google::Apis::SheetsV4::ClearValuesResponse]
|
|
401
|
+
#
|
|
402
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
403
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
404
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
405
|
+
def clear_values(spreadsheet_id, range, clear_values_request_object = nil, quota_user: nil, fields: nil, options: nil, &block)
|
|
406
|
+
command = make_simple_command(:post, 'v4/spreadsheets/{spreadsheetId}/values/{range}:clear', options)
|
|
407
|
+
command.request_representation = Google::Apis::SheetsV4::ClearValuesRequest::Representation
|
|
408
|
+
command.request_object = clear_values_request_object
|
|
409
|
+
command.response_representation = Google::Apis::SheetsV4::ClearValuesResponse::Representation
|
|
410
|
+
command.response_class = Google::Apis::SheetsV4::ClearValuesResponse
|
|
411
|
+
command.params['spreadsheetId'] = spreadsheet_id unless spreadsheet_id.nil?
|
|
412
|
+
command.params['range'] = range unless range.nil?
|
|
425
413
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
414
|
+
command.query['fields'] = fields unless fields.nil?
|
|
426
415
|
execute_or_queue_command(command, &block)
|
|
427
416
|
end
|
|
428
417
|
|
|
429
|
-
#
|
|
418
|
+
# Appends values to a spreadsheet. The input range is used to search for
|
|
419
|
+
# existing data and find a "table" within that range. Values will be
|
|
420
|
+
# appended to the next row of the table, starting with the first column of
|
|
421
|
+
# the table. See the
|
|
422
|
+
# [guide](/sheets/api/guides/values#appending_values)
|
|
423
|
+
# and
|
|
424
|
+
# [sample code](/sheets/api/samples/writing#append_values)
|
|
425
|
+
# for specific details of how tables are detected and data is appended.
|
|
430
426
|
# The caller must specify the spreadsheet ID, range, and
|
|
431
|
-
# a valueInputOption.
|
|
427
|
+
# a valueInputOption. The `valueInputOption` only
|
|
428
|
+
# controls how the input data will be added to the sheet (column-wise or
|
|
429
|
+
# row-wise), it does not influence what cell the data starts being written
|
|
430
|
+
# to.
|
|
432
431
|
# @param [String] spreadsheet_id
|
|
433
432
|
# The ID of the spreadsheet to update.
|
|
434
433
|
# @param [String] range
|
|
435
|
-
# The A1 notation of
|
|
434
|
+
# The A1 notation of a range to search for a logical table of data.
|
|
435
|
+
# Values will be appended after the last row of the table.
|
|
436
436
|
# @param [Google::Apis::SheetsV4::ValueRange] value_range_object
|
|
437
437
|
# @param [String] response_value_render_option
|
|
438
438
|
# Determines how values in the response should be rendered.
|
|
439
439
|
# The default render option is ValueRenderOption.FORMATTED_VALUE.
|
|
440
|
+
# @param [String] insert_data_option
|
|
441
|
+
# How the input data should be inserted.
|
|
440
442
|
# @param [String] value_input_option
|
|
441
443
|
# How the input data should be interpreted.
|
|
442
444
|
# @param [String] response_date_time_render_option
|
|
@@ -446,78 +448,76 @@ module Google
|
|
|
446
448
|
# The default dateTime render option is [DateTimeRenderOption.SERIAL_NUMBER].
|
|
447
449
|
# @param [Boolean] include_values_in_response
|
|
448
450
|
# Determines if the update response should include the values
|
|
449
|
-
# of the cells that were
|
|
451
|
+
# of the cells that were appended. By default, responses
|
|
450
452
|
# do not include the updated values.
|
|
451
|
-
# If the range to write was larger than than the range actually written,
|
|
452
|
-
# the response will include all values in the requested range (excluding
|
|
453
|
-
# trailing empty rows and columns).
|
|
454
|
-
# @param [String] fields
|
|
455
|
-
# Selector specifying which fields to include in a partial response.
|
|
456
453
|
# @param [String] quota_user
|
|
457
454
|
# Available to use for quota purposes for server-side applications. Can be any
|
|
458
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.
|
|
459
458
|
# @param [Google::Apis::RequestOptions] options
|
|
460
459
|
# Request-specific options
|
|
461
460
|
#
|
|
462
461
|
# @yield [result, err] Result & error if block supplied
|
|
463
|
-
# @yieldparam result [Google::Apis::SheetsV4::
|
|
462
|
+
# @yieldparam result [Google::Apis::SheetsV4::AppendValuesResponse] parsed result object
|
|
464
463
|
# @yieldparam err [StandardError] error object if request failed
|
|
465
464
|
#
|
|
466
|
-
# @return [Google::Apis::SheetsV4::
|
|
465
|
+
# @return [Google::Apis::SheetsV4::AppendValuesResponse]
|
|
467
466
|
#
|
|
468
467
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
469
468
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
470
469
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
471
|
-
def
|
|
472
|
-
command = make_simple_command(:
|
|
470
|
+
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, quota_user: nil, fields: nil, options: nil, &block)
|
|
471
|
+
command = make_simple_command(:post, 'v4/spreadsheets/{spreadsheetId}/values/{range}:append', options)
|
|
473
472
|
command.request_representation = Google::Apis::SheetsV4::ValueRange::Representation
|
|
474
473
|
command.request_object = value_range_object
|
|
475
|
-
command.response_representation = Google::Apis::SheetsV4::
|
|
476
|
-
command.response_class = Google::Apis::SheetsV4::
|
|
474
|
+
command.response_representation = Google::Apis::SheetsV4::AppendValuesResponse::Representation
|
|
475
|
+
command.response_class = Google::Apis::SheetsV4::AppendValuesResponse
|
|
477
476
|
command.params['spreadsheetId'] = spreadsheet_id unless spreadsheet_id.nil?
|
|
478
477
|
command.params['range'] = range unless range.nil?
|
|
479
478
|
command.query['responseValueRenderOption'] = response_value_render_option unless response_value_render_option.nil?
|
|
479
|
+
command.query['insertDataOption'] = insert_data_option unless insert_data_option.nil?
|
|
480
480
|
command.query['valueInputOption'] = value_input_option unless value_input_option.nil?
|
|
481
481
|
command.query['responseDateTimeRenderOption'] = response_date_time_render_option unless response_date_time_render_option.nil?
|
|
482
482
|
command.query['includeValuesInResponse'] = include_values_in_response unless include_values_in_response.nil?
|
|
483
|
-
command.query['fields'] = fields unless fields.nil?
|
|
484
483
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
484
|
+
command.query['fields'] = fields unless fields.nil?
|
|
485
485
|
execute_or_queue_command(command, &block)
|
|
486
486
|
end
|
|
487
487
|
|
|
488
|
-
#
|
|
489
|
-
# The caller must specify the spreadsheet ID
|
|
490
|
-
#
|
|
491
|
-
#
|
|
488
|
+
# Clears one or more ranges of values from a spreadsheet.
|
|
489
|
+
# The caller must specify the spreadsheet ID and one or more ranges.
|
|
490
|
+
# Only values are cleared -- all other properties of the cell (such as
|
|
491
|
+
# formatting, data validation, etc..) are kept.
|
|
492
492
|
# @param [String] spreadsheet_id
|
|
493
493
|
# The ID of the spreadsheet to update.
|
|
494
|
-
# @param [Google::Apis::SheetsV4::
|
|
495
|
-
# @param [String] fields
|
|
496
|
-
# Selector specifying which fields to include in a partial response.
|
|
494
|
+
# @param [Google::Apis::SheetsV4::BatchClearValuesRequest] batch_clear_values_request_object
|
|
497
495
|
# @param [String] quota_user
|
|
498
496
|
# Available to use for quota purposes for server-side applications. Can be any
|
|
499
497
|
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
498
|
+
# @param [String] fields
|
|
499
|
+
# Selector specifying which fields to include in a partial response.
|
|
500
500
|
# @param [Google::Apis::RequestOptions] options
|
|
501
501
|
# Request-specific options
|
|
502
502
|
#
|
|
503
503
|
# @yield [result, err] Result & error if block supplied
|
|
504
|
-
# @yieldparam result [Google::Apis::SheetsV4::
|
|
504
|
+
# @yieldparam result [Google::Apis::SheetsV4::BatchClearValuesResponse] parsed result object
|
|
505
505
|
# @yieldparam err [StandardError] error object if request failed
|
|
506
506
|
#
|
|
507
|
-
# @return [Google::Apis::SheetsV4::
|
|
507
|
+
# @return [Google::Apis::SheetsV4::BatchClearValuesResponse]
|
|
508
508
|
#
|
|
509
509
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
510
510
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
511
511
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
512
|
-
def
|
|
513
|
-
command = make_simple_command(:post, 'v4/spreadsheets/{spreadsheetId}/values:
|
|
514
|
-
command.request_representation = Google::Apis::SheetsV4::
|
|
515
|
-
command.request_object =
|
|
516
|
-
command.response_representation = Google::Apis::SheetsV4::
|
|
517
|
-
command.response_class = Google::Apis::SheetsV4::
|
|
512
|
+
def batch_clear_values(spreadsheet_id, batch_clear_values_request_object = nil, quota_user: nil, fields: nil, options: nil, &block)
|
|
513
|
+
command = make_simple_command(:post, 'v4/spreadsheets/{spreadsheetId}/values:batchClear', options)
|
|
514
|
+
command.request_representation = Google::Apis::SheetsV4::BatchClearValuesRequest::Representation
|
|
515
|
+
command.request_object = batch_clear_values_request_object
|
|
516
|
+
command.response_representation = Google::Apis::SheetsV4::BatchClearValuesResponse::Representation
|
|
517
|
+
command.response_class = Google::Apis::SheetsV4::BatchClearValuesResponse
|
|
518
518
|
command.params['spreadsheetId'] = spreadsheet_id unless spreadsheet_id.nil?
|
|
519
|
-
command.query['fields'] = fields unless fields.nil?
|
|
520
519
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
520
|
+
command.query['fields'] = fields unless fields.nil?
|
|
521
521
|
execute_or_queue_command(command, &block)
|
|
522
522
|
end
|
|
523
523
|
|
|
@@ -528,11 +528,11 @@ module Google
|
|
|
528
528
|
# @param [Fixnum] sheet_id
|
|
529
529
|
# The ID of the sheet to copy.
|
|
530
530
|
# @param [Google::Apis::SheetsV4::CopySheetToAnotherSpreadsheetRequest] copy_sheet_to_another_spreadsheet_request_object
|
|
531
|
-
# @param [String] fields
|
|
532
|
-
# Selector specifying which fields to include in a partial response.
|
|
533
531
|
# @param [String] quota_user
|
|
534
532
|
# Available to use for quota purposes for server-side applications. Can be any
|
|
535
533
|
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
534
|
+
# @param [String] fields
|
|
535
|
+
# Selector specifying which fields to include in a partial response.
|
|
536
536
|
# @param [Google::Apis::RequestOptions] options
|
|
537
537
|
# Request-specific options
|
|
538
538
|
#
|
|
@@ -545,7 +545,7 @@ module Google
|
|
|
545
545
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
546
546
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
547
547
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
548
|
-
def copy_spreadsheet(spreadsheet_id, sheet_id, copy_sheet_to_another_spreadsheet_request_object = nil,
|
|
548
|
+
def copy_spreadsheet(spreadsheet_id, sheet_id, copy_sheet_to_another_spreadsheet_request_object = nil, quota_user: nil, fields: nil, options: nil, &block)
|
|
549
549
|
command = make_simple_command(:post, 'v4/spreadsheets/{spreadsheetId}/sheets/{sheetId}:copyTo', options)
|
|
550
550
|
command.request_representation = Google::Apis::SheetsV4::CopySheetToAnotherSpreadsheetRequest::Representation
|
|
551
551
|
command.request_object = copy_sheet_to_another_spreadsheet_request_object
|
|
@@ -553,8 +553,8 @@ module Google
|
|
|
553
553
|
command.response_class = Google::Apis::SheetsV4::SheetProperties
|
|
554
554
|
command.params['spreadsheetId'] = spreadsheet_id unless spreadsheet_id.nil?
|
|
555
555
|
command.params['sheetId'] = sheet_id unless sheet_id.nil?
|
|
556
|
-
command.query['fields'] = fields unless fields.nil?
|
|
557
556
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
557
|
+
command.query['fields'] = fields unless fields.nil?
|
|
558
558
|
execute_or_queue_command(command, &block)
|
|
559
559
|
end
|
|
560
560
|
|