@maxim_mazurok/gapi.client.sheets-v4 0.3.20261111 → 0.4.20261111
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.
- package/index.d.ts +587 -588
- package/package.json +1 -1
package/index.d.ts
CHANGED
|
@@ -1111,7 +1111,7 @@ declare namespace gapi.client {
|
|
|
1111
1111
|
}
|
|
1112
1112
|
interface DataSourceRefreshWeeklySchedule {
|
|
1113
1113
|
/** Days of the week to refresh. At least one day must be specified. */
|
|
1114
|
-
daysOfWeek?:
|
|
1114
|
+
daysOfWeek?: (
|
|
1115
1115
|
| 'DAY_OF_WEEK_UNSPECIFIED'
|
|
1116
1116
|
| 'MONDAY'
|
|
1117
1117
|
| 'TUESDAY'
|
|
@@ -1119,7 +1119,8 @@ declare namespace gapi.client {
|
|
|
1119
1119
|
| 'THURSDAY'
|
|
1120
1120
|
| 'FRIDAY'
|
|
1121
1121
|
| 'SATURDAY'
|
|
1122
|
-
| 'SUNDAY'
|
|
1122
|
+
| 'SUNDAY'
|
|
1123
|
+
)[];
|
|
1123
1124
|
/** The start time of a time interval in which a data source refresh is scheduled. Only `hours` part is used. The time interval size defaults to that in the Sheets editor. */
|
|
1124
1125
|
startTime?: TimeOfDay;
|
|
1125
1126
|
}
|
|
@@ -2967,38 +2968,10 @@ declare namespace gapi.client {
|
|
|
2967
2968
|
/** Controls whether to display additional data labels on stacked charts which sum the total value of all stacked values at each value along the domain axis. stacked_type must be STACKED and neither CUSTOM nor placement can be set on the total_data_label. */
|
|
2968
2969
|
totalDataLabel?: DataLabel;
|
|
2969
2970
|
}
|
|
2970
|
-
|
|
2971
|
-
|
|
2972
|
-
|
|
2973
|
-
|
|
2974
|
-
'$.xgafv'?: '1' | '2';
|
|
2975
|
-
/** OAuth access token. */
|
|
2976
|
-
access_token?: string;
|
|
2977
|
-
/** Data format for response. */
|
|
2978
|
-
alt?: 'json' | 'media' | 'proto';
|
|
2979
|
-
/** JSONP */
|
|
2980
|
-
callback?: string;
|
|
2981
|
-
/** Selector specifying which fields to include in a partial response. */
|
|
2982
|
-
fields?: string;
|
|
2983
|
-
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
2984
|
-
key?: string;
|
|
2985
|
-
/** The ID of the developer metadata to retrieve. */
|
|
2986
|
-
metadataId: number;
|
|
2987
|
-
/** OAuth 2.0 token for the current user. */
|
|
2988
|
-
oauth_token?: string;
|
|
2989
|
-
/** Returns response with indentations and line breaks. */
|
|
2990
|
-
prettyPrint?: boolean;
|
|
2991
|
-
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
2992
|
-
quotaUser?: string;
|
|
2993
|
-
/** The ID of the spreadsheet to retrieve metadata from. */
|
|
2994
|
-
spreadsheetId: string;
|
|
2995
|
-
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
2996
|
-
upload_protocol?: string;
|
|
2997
|
-
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
2998
|
-
uploadType?: string;
|
|
2999
|
-
}): client.Request<DeveloperMetadata>;
|
|
3000
|
-
/** Returns all developer metadata matching the specified DataFilter. For more information, see [Read, write, and search metadata](https://developers.google.com/workspace/sheets/api/guides/metadata). If the provided DataFilter represents a DeveloperMetadataLookup object, this will return all DeveloperMetadata entries selected by it. If the DataFilter represents a location in a spreadsheet, this will return all developer metadata associated with locations intersecting that region. */
|
|
3001
|
-
search(request: {
|
|
2971
|
+
|
|
2972
|
+
const spreadsheets: {
|
|
2973
|
+
/** Applies one or more updates to the spreadsheet. Each request is validated before being applied. If any request is not valid then the entire request will fail and nothing will be applied. Some requests have replies to give you some information about how they are applied. The replies will mirror the requests. For example, if you applied 4 updates and the 3rd one had a reply, then the response will have 2 empty replies, the actual reply, and another empty reply, in that order. Due to the collaborative nature of spreadsheets, it is not guaranteed that the spreadsheet will reflect exactly your changes after this completes, however it is guaranteed that the updates in the request will be applied together atomically. Your changes may be altered with respect to collaborator changes. If there are no collaborators, the spreadsheet should reflect your changes. */
|
|
2974
|
+
batchUpdate(request: {
|
|
3002
2975
|
/** V1 error format. */
|
|
3003
2976
|
'$.xgafv'?: '1' | '2';
|
|
3004
2977
|
/** OAuth access token. */
|
|
@@ -3017,16 +2990,16 @@ declare namespace gapi.client {
|
|
|
3017
2990
|
prettyPrint?: boolean;
|
|
3018
2991
|
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
3019
2992
|
quotaUser?: string;
|
|
3020
|
-
/** The
|
|
2993
|
+
/** The spreadsheet to apply the updates to. */
|
|
3021
2994
|
spreadsheetId: string;
|
|
3022
2995
|
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
3023
2996
|
upload_protocol?: string;
|
|
3024
2997
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
3025
2998
|
uploadType?: string;
|
|
3026
2999
|
/** Request body */
|
|
3027
|
-
resource:
|
|
3028
|
-
}): client.Request<
|
|
3029
|
-
|
|
3000
|
+
resource: BatchUpdateSpreadsheetRequest;
|
|
3001
|
+
}): client.Request<BatchUpdateSpreadsheetResponse>;
|
|
3002
|
+
batchUpdate(
|
|
3030
3003
|
request: {
|
|
3031
3004
|
/** V1 error format. */
|
|
3032
3005
|
'$.xgafv'?: '1' | '2';
|
|
@@ -3046,19 +3019,17 @@ declare namespace gapi.client {
|
|
|
3046
3019
|
prettyPrint?: boolean;
|
|
3047
3020
|
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
3048
3021
|
quotaUser?: string;
|
|
3049
|
-
/** The
|
|
3022
|
+
/** The spreadsheet to apply the updates to. */
|
|
3050
3023
|
spreadsheetId: string;
|
|
3051
3024
|
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
3052
3025
|
upload_protocol?: string;
|
|
3053
3026
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
3054
3027
|
uploadType?: string;
|
|
3055
3028
|
},
|
|
3056
|
-
body:
|
|
3057
|
-
): client.Request<
|
|
3058
|
-
|
|
3059
|
-
|
|
3060
|
-
/** Copies a single sheet from a spreadsheet to another spreadsheet. Returns the properties of the newly created sheet. */
|
|
3061
|
-
copyTo(request: {
|
|
3029
|
+
body: BatchUpdateSpreadsheetRequest,
|
|
3030
|
+
): client.Request<BatchUpdateSpreadsheetResponse>;
|
|
3031
|
+
/** Creates a spreadsheet, returning the newly created spreadsheet. */
|
|
3032
|
+
create(request: {
|
|
3062
3033
|
/** V1 error format. */
|
|
3063
3034
|
'$.xgafv'?: '1' | '2';
|
|
3064
3035
|
/** OAuth access token. */
|
|
@@ -3077,18 +3048,14 @@ declare namespace gapi.client {
|
|
|
3077
3048
|
prettyPrint?: boolean;
|
|
3078
3049
|
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
3079
3050
|
quotaUser?: string;
|
|
3080
|
-
/** The ID of the sheet to copy. */
|
|
3081
|
-
sheetId: number;
|
|
3082
|
-
/** The ID of the spreadsheet containing the sheet to copy. */
|
|
3083
|
-
spreadsheetId: string;
|
|
3084
3051
|
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
3085
3052
|
upload_protocol?: string;
|
|
3086
3053
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
3087
3054
|
uploadType?: string;
|
|
3088
3055
|
/** Request body */
|
|
3089
|
-
resource:
|
|
3090
|
-
}): client.Request<
|
|
3091
|
-
|
|
3056
|
+
resource: Spreadsheet;
|
|
3057
|
+
}): client.Request<Spreadsheet>;
|
|
3058
|
+
create(
|
|
3092
3059
|
request: {
|
|
3093
3060
|
/** V1 error format. */
|
|
3094
3061
|
'$.xgafv'?: '1' | '2';
|
|
@@ -3108,21 +3075,15 @@ declare namespace gapi.client {
|
|
|
3108
3075
|
prettyPrint?: boolean;
|
|
3109
3076
|
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
3110
3077
|
quotaUser?: string;
|
|
3111
|
-
/** The ID of the sheet to copy. */
|
|
3112
|
-
sheetId: number;
|
|
3113
|
-
/** The ID of the spreadsheet containing the sheet to copy. */
|
|
3114
|
-
spreadsheetId: string;
|
|
3115
3078
|
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
3116
3079
|
upload_protocol?: string;
|
|
3117
3080
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
3118
3081
|
uploadType?: string;
|
|
3119
3082
|
},
|
|
3120
|
-
body:
|
|
3121
|
-
): client.Request<
|
|
3122
|
-
|
|
3123
|
-
|
|
3124
|
-
/** Appends values to a spreadsheet. The input range is used to search for existing data and find a "table" within that range. Values will be appended to the next row of the table, starting with the first column of the table. See the [guide](https://developers.google.com/workspace/sheets/api/guides/values#appending_values) and [sample code](https://developers.google.com/workspace/sheets/api/samples/writing#append_values) for specific details of how tables are detected and data is appended. The caller must specify the spreadsheet ID, range, and a valueInputOption. The `valueInputOption` only controls how the input data will be added to the sheet (column-wise or row-wise), it does not influence what cell the data starts being written to. */
|
|
3125
|
-
append(request: {
|
|
3083
|
+
body: Spreadsheet,
|
|
3084
|
+
): client.Request<Spreadsheet>;
|
|
3085
|
+
/** Returns the spreadsheet at the given ID. The caller must specify the spreadsheet ID. By default, data within grids is not returned. You can include grid data in one of 2 ways: * Specify a [field mask](https://developers.google.com/workspace/sheets/api/guides/field-masks) listing your desired fields using the `fields` URL parameter in HTTP * Set the includeGridData URL parameter to true. If a field mask is set, the `includeGridData` parameter is ignored For large spreadsheets, as a best practice, retrieve only the specific spreadsheet fields that you want. To retrieve only subsets of spreadsheet data, use the ranges URL parameter. Ranges are specified using [A1 notation](https://developers.google.com/workspace/sheets/api/guides/concepts#cell). You can define a single cell (for example, `A1`) or multiple cells (for example, `A1:D5`). You can also get cells from other sheets within the same spreadsheet (for example, `Sheet2!A1:C4`) or retrieve multiple ranges at once (for example, `?ranges=A1:D5&ranges=Sheet2!A1:C4`). Limiting the range returns only the portions of the spreadsheet that intersect the requested ranges. */
|
|
3086
|
+
get(request?: {
|
|
3126
3087
|
/** V1 error format. */
|
|
3127
3088
|
'$.xgafv'?: '1' | '2';
|
|
3128
3089
|
/** OAuth access token. */
|
|
@@ -3131,12 +3092,18 @@ declare namespace gapi.client {
|
|
|
3131
3092
|
alt?: 'json' | 'media' | 'proto';
|
|
3132
3093
|
/** JSONP */
|
|
3133
3094
|
callback?: string;
|
|
3095
|
+
/** The comments view mode to apply to the spreadsheet. This allows viewing the spreadsheet with comments omitted or included. If one is not specified, COMMENTS_VIEW_MODE_OMITTED is used. */
|
|
3096
|
+
commentsViewMode?:
|
|
3097
|
+
| 'COMMENTS_VIEW_MODE_UNSPECIFIED'
|
|
3098
|
+
| 'COMMENTS_VIEW_MODE_DEFAULT_FOR_CURRENT_ACCESS'
|
|
3099
|
+
| 'COMMENTS_VIEW_MODE_OMITTED'
|
|
3100
|
+
| 'COMMENTS_VIEW_MODE_INCLUDED';
|
|
3101
|
+
/** True if tables should be excluded in the banded ranges. False if not set. */
|
|
3102
|
+
excludeTablesInBandedRanges?: boolean;
|
|
3134
3103
|
/** Selector specifying which fields to include in a partial response. */
|
|
3135
3104
|
fields?: string;
|
|
3136
|
-
/**
|
|
3137
|
-
|
|
3138
|
-
/** How the input data should be inserted. */
|
|
3139
|
-
insertDataOption?: 'OVERWRITE' | 'INSERT_ROWS';
|
|
3105
|
+
/** True if grid data should be returned. This parameter is ignored if a field mask was set in the request. */
|
|
3106
|
+
includeGridData?: boolean;
|
|
3140
3107
|
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
3141
3108
|
key?: string;
|
|
3142
3109
|
/** OAuth 2.0 token for the current user. */
|
|
@@ -3145,70 +3112,17 @@ declare namespace gapi.client {
|
|
|
3145
3112
|
prettyPrint?: boolean;
|
|
3146
3113
|
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
3147
3114
|
quotaUser?: string;
|
|
3148
|
-
/** The
|
|
3149
|
-
|
|
3150
|
-
/**
|
|
3151
|
-
responseDateTimeRenderOption?: 'SERIAL_NUMBER' | 'FORMATTED_STRING';
|
|
3152
|
-
/** Determines how values in the response should be rendered. The default render option is FORMATTED_VALUE. */
|
|
3153
|
-
responseValueRenderOption?:
|
|
3154
|
-
'FORMATTED_VALUE' | 'UNFORMATTED_VALUE' | 'FORMULA';
|
|
3155
|
-
/** The ID of the spreadsheet to update. */
|
|
3115
|
+
/** The ranges to retrieve from the spreadsheet. */
|
|
3116
|
+
ranges?: string | string[];
|
|
3117
|
+
/** The spreadsheet to request. */
|
|
3156
3118
|
spreadsheetId: string;
|
|
3157
3119
|
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
3158
3120
|
upload_protocol?: string;
|
|
3159
3121
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
3160
3122
|
uploadType?: string;
|
|
3161
|
-
|
|
3162
|
-
|
|
3163
|
-
|
|
3164
|
-
/** Request body */
|
|
3165
|
-
resource: ValueRange;
|
|
3166
|
-
}): client.Request<AppendValuesResponse>;
|
|
3167
|
-
append(
|
|
3168
|
-
request: {
|
|
3169
|
-
/** V1 error format. */
|
|
3170
|
-
'$.xgafv'?: '1' | '2';
|
|
3171
|
-
/** OAuth access token. */
|
|
3172
|
-
access_token?: string;
|
|
3173
|
-
/** Data format for response. */
|
|
3174
|
-
alt?: 'json' | 'media' | 'proto';
|
|
3175
|
-
/** JSONP */
|
|
3176
|
-
callback?: string;
|
|
3177
|
-
/** Selector specifying which fields to include in a partial response. */
|
|
3178
|
-
fields?: string;
|
|
3179
|
-
/** Determines if the update response should include the values of the cells that were appended. By default, responses do not include the updated values. */
|
|
3180
|
-
includeValuesInResponse?: boolean;
|
|
3181
|
-
/** How the input data should be inserted. */
|
|
3182
|
-
insertDataOption?: 'OVERWRITE' | 'INSERT_ROWS';
|
|
3183
|
-
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
3184
|
-
key?: string;
|
|
3185
|
-
/** OAuth 2.0 token for the current user. */
|
|
3186
|
-
oauth_token?: string;
|
|
3187
|
-
/** Returns response with indentations and line breaks. */
|
|
3188
|
-
prettyPrint?: boolean;
|
|
3189
|
-
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
3190
|
-
quotaUser?: string;
|
|
3191
|
-
/** The [A1 notation](https://developers.google.com/workspace/sheets/api/guides/concepts#cell) of a range to search for a logical table of data. Values are appended after the last row of the table. */
|
|
3192
|
-
range: string;
|
|
3193
|
-
/** Determines how dates, times, and durations in the response should be rendered. This is ignored if response_value_render_option is FORMATTED_VALUE. The default dateTime render option is SERIAL_NUMBER. */
|
|
3194
|
-
responseDateTimeRenderOption?: 'SERIAL_NUMBER' | 'FORMATTED_STRING';
|
|
3195
|
-
/** Determines how values in the response should be rendered. The default render option is FORMATTED_VALUE. */
|
|
3196
|
-
responseValueRenderOption?:
|
|
3197
|
-
'FORMATTED_VALUE' | 'UNFORMATTED_VALUE' | 'FORMULA';
|
|
3198
|
-
/** The ID of the spreadsheet to update. */
|
|
3199
|
-
spreadsheetId: string;
|
|
3200
|
-
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
3201
|
-
upload_protocol?: string;
|
|
3202
|
-
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
3203
|
-
uploadType?: string;
|
|
3204
|
-
/** How the input data should be interpreted. */
|
|
3205
|
-
valueInputOption?:
|
|
3206
|
-
'INPUT_VALUE_OPTION_UNSPECIFIED' | 'RAW' | 'USER_ENTERED';
|
|
3207
|
-
},
|
|
3208
|
-
body: ValueRange,
|
|
3209
|
-
): client.Request<AppendValuesResponse>;
|
|
3210
|
-
/** Clears one or more ranges of values from a spreadsheet. The caller must specify the spreadsheet ID and one or more ranges. Only values are cleared -- all other properties of the cell (such as formatting and data validation) are kept. */
|
|
3211
|
-
batchClear(request: {
|
|
3123
|
+
}): client.Request<Spreadsheet>;
|
|
3124
|
+
/** Returns the spreadsheet at the given ID. The caller must specify the spreadsheet ID. For more information, see [Read, write, and search metadata](https://developers.google.com/workspace/sheets/api/guides/metadata). This method differs from GetSpreadsheet in that it allows selecting which subsets of spreadsheet data to return by specifying a dataFilters parameter. Multiple DataFilters can be specified. Specifying one or more data filters returns the portions of the spreadsheet that intersect ranges matched by any of the filters. By default, data within grids is not returned. You can include grid data in one of two ways: * Specify a [field mask](https://developers.google.com/workspace/sheets/api/guides/field-masks) listing your desired fields using the `fields` URL parameter in HTTP. * Set the includeGridData parameter to `true`. If a field mask is set, the `includeGridData` parameter is ignored. For large spreadsheets, as a best practice, retrieve only the specific spreadsheet fields that you want. */
|
|
3125
|
+
getByDataFilter(request: {
|
|
3212
3126
|
/** V1 error format. */
|
|
3213
3127
|
'$.xgafv'?: '1' | '2';
|
|
3214
3128
|
/** OAuth access token. */
|
|
@@ -3227,16 +3141,16 @@ declare namespace gapi.client {
|
|
|
3227
3141
|
prettyPrint?: boolean;
|
|
3228
3142
|
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
3229
3143
|
quotaUser?: string;
|
|
3230
|
-
/** The
|
|
3144
|
+
/** The spreadsheet to request. */
|
|
3231
3145
|
spreadsheetId: string;
|
|
3232
3146
|
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
3233
3147
|
upload_protocol?: string;
|
|
3234
3148
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
3235
3149
|
uploadType?: string;
|
|
3236
3150
|
/** Request body */
|
|
3237
|
-
resource:
|
|
3238
|
-
}): client.Request<
|
|
3239
|
-
|
|
3151
|
+
resource: GetSpreadsheetByDataFilterRequest;
|
|
3152
|
+
}): client.Request<Spreadsheet>;
|
|
3153
|
+
getByDataFilter(
|
|
3240
3154
|
request: {
|
|
3241
3155
|
/** V1 error format. */
|
|
3242
3156
|
'$.xgafv'?: '1' | '2';
|
|
@@ -3256,46 +3170,18 @@ declare namespace gapi.client {
|
|
|
3256
3170
|
prettyPrint?: boolean;
|
|
3257
3171
|
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
3258
3172
|
quotaUser?: string;
|
|
3259
|
-
/** The
|
|
3173
|
+
/** The spreadsheet to request. */
|
|
3260
3174
|
spreadsheetId: string;
|
|
3261
3175
|
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
3262
3176
|
upload_protocol?: string;
|
|
3263
3177
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
3264
3178
|
uploadType?: string;
|
|
3265
3179
|
},
|
|
3266
|
-
body:
|
|
3267
|
-
): client.Request<
|
|
3268
|
-
|
|
3269
|
-
|
|
3270
|
-
|
|
3271
|
-
'$.xgafv'?: '1' | '2';
|
|
3272
|
-
/** OAuth access token. */
|
|
3273
|
-
access_token?: string;
|
|
3274
|
-
/** Data format for response. */
|
|
3275
|
-
alt?: 'json' | 'media' | 'proto';
|
|
3276
|
-
/** JSONP */
|
|
3277
|
-
callback?: string;
|
|
3278
|
-
/** Selector specifying which fields to include in a partial response. */
|
|
3279
|
-
fields?: string;
|
|
3280
|
-
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
3281
|
-
key?: string;
|
|
3282
|
-
/** OAuth 2.0 token for the current user. */
|
|
3283
|
-
oauth_token?: string;
|
|
3284
|
-
/** Returns response with indentations and line breaks. */
|
|
3285
|
-
prettyPrint?: boolean;
|
|
3286
|
-
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
3287
|
-
quotaUser?: string;
|
|
3288
|
-
/** The ID of the spreadsheet to update. */
|
|
3289
|
-
spreadsheetId: string;
|
|
3290
|
-
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
3291
|
-
upload_protocol?: string;
|
|
3292
|
-
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
3293
|
-
uploadType?: string;
|
|
3294
|
-
/** Request body */
|
|
3295
|
-
resource: BatchClearValuesByDataFilterRequest;
|
|
3296
|
-
}): client.Request<BatchClearValuesByDataFilterResponse>;
|
|
3297
|
-
batchClearByDataFilter(
|
|
3298
|
-
request: {
|
|
3180
|
+
body: GetSpreadsheetByDataFilterRequest,
|
|
3181
|
+
): client.Request<Spreadsheet>;
|
|
3182
|
+
developerMetadata: {
|
|
3183
|
+
/** Returns the developer metadata with the specified ID. The caller must specify the spreadsheet ID and the developer metadata's unique metadataId. For more information, see [Read, write, and search metadata](https://developers.google.com/workspace/sheets/api/guides/metadata). */
|
|
3184
|
+
get(request?: {
|
|
3299
3185
|
/** V1 error format. */
|
|
3300
3186
|
'$.xgafv'?: '1' | '2';
|
|
3301
3187
|
/** OAuth access token. */
|
|
@@ -3308,87 +3194,23 @@ declare namespace gapi.client {
|
|
|
3308
3194
|
fields?: string;
|
|
3309
3195
|
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
3310
3196
|
key?: string;
|
|
3197
|
+
/** The ID of the developer metadata to retrieve. */
|
|
3198
|
+
metadataId: number;
|
|
3311
3199
|
/** OAuth 2.0 token for the current user. */
|
|
3312
3200
|
oauth_token?: string;
|
|
3313
3201
|
/** Returns response with indentations and line breaks. */
|
|
3314
3202
|
prettyPrint?: boolean;
|
|
3315
3203
|
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
3316
3204
|
quotaUser?: string;
|
|
3317
|
-
/** The ID of the spreadsheet to
|
|
3205
|
+
/** The ID of the spreadsheet to retrieve metadata from. */
|
|
3318
3206
|
spreadsheetId: string;
|
|
3319
3207
|
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
3320
3208
|
upload_protocol?: string;
|
|
3321
3209
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
3322
3210
|
uploadType?: string;
|
|
3323
|
-
}
|
|
3324
|
-
|
|
3325
|
-
|
|
3326
|
-
/** Returns one or more ranges of values from a spreadsheet. The caller must specify the spreadsheet ID and one or more ranges. */
|
|
3327
|
-
batchGet(request?: {
|
|
3328
|
-
/** V1 error format. */
|
|
3329
|
-
'$.xgafv'?: '1' | '2';
|
|
3330
|
-
/** OAuth access token. */
|
|
3331
|
-
access_token?: string;
|
|
3332
|
-
/** Data format for response. */
|
|
3333
|
-
alt?: 'json' | 'media' | 'proto';
|
|
3334
|
-
/** JSONP */
|
|
3335
|
-
callback?: string;
|
|
3336
|
-
/** How dates, times, and durations should be represented in the output. This is ignored if value_render_option is FORMATTED_VALUE. The default dateTime render option is SERIAL_NUMBER. */
|
|
3337
|
-
dateTimeRenderOption?: 'SERIAL_NUMBER' | 'FORMATTED_STRING';
|
|
3338
|
-
/** Selector specifying which fields to include in a partial response. */
|
|
3339
|
-
fields?: string;
|
|
3340
|
-
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
3341
|
-
key?: string;
|
|
3342
|
-
/** The major dimension that results should use. For example, if the spreadsheet data is: `A1=1,B1=2,A2=3,B2=4`, then requesting `ranges=["A1:B2"],majorDimension=ROWS` returns `[[1,2],[3,4]]`, whereas requesting `ranges=["A1:B2"],majorDimension=COLUMNS` returns `[[1,3],[2,4]]`. */
|
|
3343
|
-
majorDimension?: 'DIMENSION_UNSPECIFIED' | 'ROWS' | 'COLUMNS';
|
|
3344
|
-
/** OAuth 2.0 token for the current user. */
|
|
3345
|
-
oauth_token?: string;
|
|
3346
|
-
/** Returns response with indentations and line breaks. */
|
|
3347
|
-
prettyPrint?: boolean;
|
|
3348
|
-
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
3349
|
-
quotaUser?: string;
|
|
3350
|
-
/** The [A1 notation or R1C1 notation](https://developers.google.com/workspace/sheets/api/guides/concepts#cell) of the range to retrieve values from. */
|
|
3351
|
-
ranges?: string | string[];
|
|
3352
|
-
/** The ID of the spreadsheet to retrieve data from. */
|
|
3353
|
-
spreadsheetId: string;
|
|
3354
|
-
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
3355
|
-
upload_protocol?: string;
|
|
3356
|
-
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
3357
|
-
uploadType?: string;
|
|
3358
|
-
/** How values should be represented in the output. The default render option is ValueRenderOption.FORMATTED_VALUE. */
|
|
3359
|
-
valueRenderOption?: 'FORMATTED_VALUE' | 'UNFORMATTED_VALUE' | 'FORMULA';
|
|
3360
|
-
}): client.Request<BatchGetValuesResponse>;
|
|
3361
|
-
/** Returns one or more ranges of values that match the specified data filters. For more information, see [Read, write, and search metadata](https://developers.google.com/workspace/sheets/api/guides/metadata). The caller must specify the spreadsheet ID and one or more DataFilters. Ranges that match any of the data filters in the request will be returned. */
|
|
3362
|
-
batchGetByDataFilter(request: {
|
|
3363
|
-
/** V1 error format. */
|
|
3364
|
-
'$.xgafv'?: '1' | '2';
|
|
3365
|
-
/** OAuth access token. */
|
|
3366
|
-
access_token?: string;
|
|
3367
|
-
/** Data format for response. */
|
|
3368
|
-
alt?: 'json' | 'media' | 'proto';
|
|
3369
|
-
/** JSONP */
|
|
3370
|
-
callback?: string;
|
|
3371
|
-
/** Selector specifying which fields to include in a partial response. */
|
|
3372
|
-
fields?: string;
|
|
3373
|
-
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
3374
|
-
key?: string;
|
|
3375
|
-
/** OAuth 2.0 token for the current user. */
|
|
3376
|
-
oauth_token?: string;
|
|
3377
|
-
/** Returns response with indentations and line breaks. */
|
|
3378
|
-
prettyPrint?: boolean;
|
|
3379
|
-
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
3380
|
-
quotaUser?: string;
|
|
3381
|
-
/** The ID of the spreadsheet to retrieve data from. */
|
|
3382
|
-
spreadsheetId: string;
|
|
3383
|
-
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
3384
|
-
upload_protocol?: string;
|
|
3385
|
-
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
3386
|
-
uploadType?: string;
|
|
3387
|
-
/** Request body */
|
|
3388
|
-
resource: BatchGetValuesByDataFilterRequest;
|
|
3389
|
-
}): client.Request<BatchGetValuesByDataFilterResponse>;
|
|
3390
|
-
batchGetByDataFilter(
|
|
3391
|
-
request: {
|
|
3211
|
+
}): client.Request<DeveloperMetadata>;
|
|
3212
|
+
/** Returns all developer metadata matching the specified DataFilter. For more information, see [Read, write, and search metadata](https://developers.google.com/workspace/sheets/api/guides/metadata). If the provided DataFilter represents a DeveloperMetadataLookup object, this will return all DeveloperMetadata entries selected by it. If the DataFilter represents a location in a spreadsheet, this will return all developer metadata associated with locations intersecting that region. */
|
|
3213
|
+
search(request: {
|
|
3392
3214
|
/** V1 error format. */
|
|
3393
3215
|
'$.xgafv'?: '1' | '2';
|
|
3394
3216
|
/** OAuth access token. */
|
|
@@ -3407,46 +3229,48 @@ declare namespace gapi.client {
|
|
|
3407
3229
|
prettyPrint?: boolean;
|
|
3408
3230
|
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
3409
3231
|
quotaUser?: string;
|
|
3410
|
-
/** The ID of the spreadsheet to retrieve
|
|
3232
|
+
/** The ID of the spreadsheet to retrieve metadata from. */
|
|
3411
3233
|
spreadsheetId: string;
|
|
3412
3234
|
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
3413
3235
|
upload_protocol?: string;
|
|
3414
3236
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
3415
3237
|
uploadType?: string;
|
|
3416
|
-
|
|
3417
|
-
|
|
3418
|
-
|
|
3419
|
-
|
|
3420
|
-
|
|
3421
|
-
|
|
3422
|
-
|
|
3423
|
-
|
|
3424
|
-
|
|
3425
|
-
|
|
3426
|
-
|
|
3427
|
-
|
|
3428
|
-
|
|
3429
|
-
|
|
3430
|
-
|
|
3431
|
-
|
|
3432
|
-
|
|
3433
|
-
|
|
3434
|
-
|
|
3435
|
-
|
|
3436
|
-
|
|
3437
|
-
|
|
3438
|
-
|
|
3439
|
-
|
|
3440
|
-
|
|
3441
|
-
|
|
3442
|
-
|
|
3443
|
-
|
|
3444
|
-
|
|
3445
|
-
|
|
3446
|
-
|
|
3447
|
-
|
|
3448
|
-
|
|
3449
|
-
|
|
3238
|
+
/** Request body */
|
|
3239
|
+
resource: SearchDeveloperMetadataRequest;
|
|
3240
|
+
}): client.Request<SearchDeveloperMetadataResponse>;
|
|
3241
|
+
search(
|
|
3242
|
+
request: {
|
|
3243
|
+
/** V1 error format. */
|
|
3244
|
+
'$.xgafv'?: '1' | '2';
|
|
3245
|
+
/** OAuth access token. */
|
|
3246
|
+
access_token?: string;
|
|
3247
|
+
/** Data format for response. */
|
|
3248
|
+
alt?: 'json' | 'media' | 'proto';
|
|
3249
|
+
/** JSONP */
|
|
3250
|
+
callback?: string;
|
|
3251
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
3252
|
+
fields?: string;
|
|
3253
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
3254
|
+
key?: string;
|
|
3255
|
+
/** OAuth 2.0 token for the current user. */
|
|
3256
|
+
oauth_token?: string;
|
|
3257
|
+
/** Returns response with indentations and line breaks. */
|
|
3258
|
+
prettyPrint?: boolean;
|
|
3259
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
3260
|
+
quotaUser?: string;
|
|
3261
|
+
/** The ID of the spreadsheet to retrieve metadata from. */
|
|
3262
|
+
spreadsheetId: string;
|
|
3263
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
3264
|
+
upload_protocol?: string;
|
|
3265
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
3266
|
+
uploadType?: string;
|
|
3267
|
+
},
|
|
3268
|
+
body: SearchDeveloperMetadataRequest,
|
|
3269
|
+
): client.Request<SearchDeveloperMetadataResponse>;
|
|
3270
|
+
};
|
|
3271
|
+
sheets: {
|
|
3272
|
+
/** Copies a single sheet from a spreadsheet to another spreadsheet. Returns the properties of the newly created sheet. */
|
|
3273
|
+
copyTo(request: {
|
|
3450
3274
|
/** V1 error format. */
|
|
3451
3275
|
'$.xgafv'?: '1' | '2';
|
|
3452
3276
|
/** OAuth access token. */
|
|
@@ -3465,46 +3289,52 @@ declare namespace gapi.client {
|
|
|
3465
3289
|
prettyPrint?: boolean;
|
|
3466
3290
|
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
3467
3291
|
quotaUser?: string;
|
|
3468
|
-
/** The ID of the
|
|
3292
|
+
/** The ID of the sheet to copy. */
|
|
3293
|
+
sheetId: number;
|
|
3294
|
+
/** The ID of the spreadsheet containing the sheet to copy. */
|
|
3469
3295
|
spreadsheetId: string;
|
|
3470
3296
|
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
3471
3297
|
upload_protocol?: string;
|
|
3472
3298
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
3473
3299
|
uploadType?: string;
|
|
3474
|
-
|
|
3475
|
-
|
|
3476
|
-
|
|
3477
|
-
|
|
3478
|
-
|
|
3479
|
-
|
|
3480
|
-
|
|
3481
|
-
|
|
3482
|
-
|
|
3483
|
-
|
|
3484
|
-
|
|
3485
|
-
|
|
3486
|
-
|
|
3487
|
-
|
|
3488
|
-
|
|
3489
|
-
|
|
3490
|
-
|
|
3491
|
-
|
|
3492
|
-
|
|
3493
|
-
|
|
3494
|
-
|
|
3495
|
-
|
|
3496
|
-
|
|
3497
|
-
|
|
3498
|
-
|
|
3499
|
-
|
|
3500
|
-
|
|
3501
|
-
|
|
3502
|
-
|
|
3503
|
-
|
|
3504
|
-
|
|
3505
|
-
|
|
3506
|
-
|
|
3507
|
-
|
|
3300
|
+
/** Request body */
|
|
3301
|
+
resource: CopySheetToAnotherSpreadsheetRequest;
|
|
3302
|
+
}): client.Request<SheetProperties>;
|
|
3303
|
+
copyTo(
|
|
3304
|
+
request: {
|
|
3305
|
+
/** V1 error format. */
|
|
3306
|
+
'$.xgafv'?: '1' | '2';
|
|
3307
|
+
/** OAuth access token. */
|
|
3308
|
+
access_token?: string;
|
|
3309
|
+
/** Data format for response. */
|
|
3310
|
+
alt?: 'json' | 'media' | 'proto';
|
|
3311
|
+
/** JSONP */
|
|
3312
|
+
callback?: string;
|
|
3313
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
3314
|
+
fields?: string;
|
|
3315
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
3316
|
+
key?: string;
|
|
3317
|
+
/** OAuth 2.0 token for the current user. */
|
|
3318
|
+
oauth_token?: string;
|
|
3319
|
+
/** Returns response with indentations and line breaks. */
|
|
3320
|
+
prettyPrint?: boolean;
|
|
3321
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
3322
|
+
quotaUser?: string;
|
|
3323
|
+
/** The ID of the sheet to copy. */
|
|
3324
|
+
sheetId: number;
|
|
3325
|
+
/** The ID of the spreadsheet containing the sheet to copy. */
|
|
3326
|
+
spreadsheetId: string;
|
|
3327
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
3328
|
+
upload_protocol?: string;
|
|
3329
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
3330
|
+
uploadType?: string;
|
|
3331
|
+
},
|
|
3332
|
+
body: CopySheetToAnotherSpreadsheetRequest,
|
|
3333
|
+
): client.Request<SheetProperties>;
|
|
3334
|
+
};
|
|
3335
|
+
values: {
|
|
3336
|
+
/** Appends values to a spreadsheet. The input range is used to search for existing data and find a "table" within that range. Values will be appended to the next row of the table, starting with the first column of the table. See the [guide](https://developers.google.com/workspace/sheets/api/guides/values#appending_values) and [sample code](https://developers.google.com/workspace/sheets/api/samples/writing#append_values) for specific details of how tables are detected and data is appended. The caller must specify the spreadsheet ID, range, and a valueInputOption. The `valueInputOption` only controls how the input data will be added to the sheet (column-wise or row-wise), it does not influence what cell the data starts being written to. */
|
|
3337
|
+
append(request: {
|
|
3508
3338
|
/** V1 error format. */
|
|
3509
3339
|
'$.xgafv'?: '1' | '2';
|
|
3510
3340
|
/** OAuth access token. */
|
|
@@ -3515,56 +3345,82 @@ declare namespace gapi.client {
|
|
|
3515
3345
|
callback?: string;
|
|
3516
3346
|
/** Selector specifying which fields to include in a partial response. */
|
|
3517
3347
|
fields?: string;
|
|
3518
|
-
/**
|
|
3519
|
-
|
|
3520
|
-
/**
|
|
3348
|
+
/** Determines if the update response should include the values of the cells that were appended. By default, responses do not include the updated values. */
|
|
3349
|
+
includeValuesInResponse?: boolean;
|
|
3350
|
+
/** How the input data should be inserted. */
|
|
3351
|
+
insertDataOption?: 'OVERWRITE' | 'INSERT_ROWS';
|
|
3352
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
3353
|
+
key?: string;
|
|
3354
|
+
/** OAuth 2.0 token for the current user. */
|
|
3521
3355
|
oauth_token?: string;
|
|
3522
3356
|
/** Returns response with indentations and line breaks. */
|
|
3523
3357
|
prettyPrint?: boolean;
|
|
3524
3358
|
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
3525
3359
|
quotaUser?: string;
|
|
3360
|
+
/** The [A1 notation](https://developers.google.com/workspace/sheets/api/guides/concepts#cell) of a range to search for a logical table of data. Values are appended after the last row of the table. */
|
|
3361
|
+
range: string;
|
|
3362
|
+
/** Determines how dates, times, and durations in the response should be rendered. This is ignored if response_value_render_option is FORMATTED_VALUE. The default dateTime render option is SERIAL_NUMBER. */
|
|
3363
|
+
responseDateTimeRenderOption?: 'SERIAL_NUMBER' | 'FORMATTED_STRING';
|
|
3364
|
+
/** Determines how values in the response should be rendered. The default render option is FORMATTED_VALUE. */
|
|
3365
|
+
responseValueRenderOption?:
|
|
3366
|
+
'FORMATTED_VALUE' | 'UNFORMATTED_VALUE' | 'FORMULA';
|
|
3526
3367
|
/** The ID of the spreadsheet to update. */
|
|
3527
3368
|
spreadsheetId: string;
|
|
3528
3369
|
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
3529
3370
|
upload_protocol?: string;
|
|
3530
3371
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
3531
3372
|
uploadType?: string;
|
|
3532
|
-
|
|
3533
|
-
|
|
3534
|
-
|
|
3535
|
-
|
|
3536
|
-
|
|
3537
|
-
|
|
3538
|
-
|
|
3539
|
-
|
|
3540
|
-
|
|
3541
|
-
|
|
3542
|
-
|
|
3543
|
-
|
|
3544
|
-
|
|
3545
|
-
|
|
3546
|
-
|
|
3547
|
-
|
|
3548
|
-
|
|
3549
|
-
|
|
3550
|
-
|
|
3551
|
-
|
|
3552
|
-
|
|
3553
|
-
|
|
3554
|
-
|
|
3555
|
-
|
|
3556
|
-
|
|
3557
|
-
|
|
3558
|
-
|
|
3559
|
-
|
|
3560
|
-
|
|
3561
|
-
|
|
3562
|
-
|
|
3563
|
-
|
|
3564
|
-
|
|
3565
|
-
|
|
3566
|
-
|
|
3567
|
-
|
|
3373
|
+
/** How the input data should be interpreted. */
|
|
3374
|
+
valueInputOption?:
|
|
3375
|
+
'INPUT_VALUE_OPTION_UNSPECIFIED' | 'RAW' | 'USER_ENTERED';
|
|
3376
|
+
/** Request body */
|
|
3377
|
+
resource: ValueRange;
|
|
3378
|
+
}): client.Request<AppendValuesResponse>;
|
|
3379
|
+
append(
|
|
3380
|
+
request: {
|
|
3381
|
+
/** V1 error format. */
|
|
3382
|
+
'$.xgafv'?: '1' | '2';
|
|
3383
|
+
/** OAuth access token. */
|
|
3384
|
+
access_token?: string;
|
|
3385
|
+
/** Data format for response. */
|
|
3386
|
+
alt?: 'json' | 'media' | 'proto';
|
|
3387
|
+
/** JSONP */
|
|
3388
|
+
callback?: string;
|
|
3389
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
3390
|
+
fields?: string;
|
|
3391
|
+
/** Determines if the update response should include the values of the cells that were appended. By default, responses do not include the updated values. */
|
|
3392
|
+
includeValuesInResponse?: boolean;
|
|
3393
|
+
/** How the input data should be inserted. */
|
|
3394
|
+
insertDataOption?: 'OVERWRITE' | 'INSERT_ROWS';
|
|
3395
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
3396
|
+
key?: string;
|
|
3397
|
+
/** OAuth 2.0 token for the current user. */
|
|
3398
|
+
oauth_token?: string;
|
|
3399
|
+
/** Returns response with indentations and line breaks. */
|
|
3400
|
+
prettyPrint?: boolean;
|
|
3401
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
3402
|
+
quotaUser?: string;
|
|
3403
|
+
/** The [A1 notation](https://developers.google.com/workspace/sheets/api/guides/concepts#cell) of a range to search for a logical table of data. Values are appended after the last row of the table. */
|
|
3404
|
+
range: string;
|
|
3405
|
+
/** Determines how dates, times, and durations in the response should be rendered. This is ignored if response_value_render_option is FORMATTED_VALUE. The default dateTime render option is SERIAL_NUMBER. */
|
|
3406
|
+
responseDateTimeRenderOption?: 'SERIAL_NUMBER' | 'FORMATTED_STRING';
|
|
3407
|
+
/** Determines how values in the response should be rendered. The default render option is FORMATTED_VALUE. */
|
|
3408
|
+
responseValueRenderOption?:
|
|
3409
|
+
'FORMATTED_VALUE' | 'UNFORMATTED_VALUE' | 'FORMULA';
|
|
3410
|
+
/** The ID of the spreadsheet to update. */
|
|
3411
|
+
spreadsheetId: string;
|
|
3412
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
3413
|
+
upload_protocol?: string;
|
|
3414
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
3415
|
+
uploadType?: string;
|
|
3416
|
+
/** How the input data should be interpreted. */
|
|
3417
|
+
valueInputOption?:
|
|
3418
|
+
'INPUT_VALUE_OPTION_UNSPECIFIED' | 'RAW' | 'USER_ENTERED';
|
|
3419
|
+
},
|
|
3420
|
+
body: ValueRange,
|
|
3421
|
+
): client.Request<AppendValuesResponse>;
|
|
3422
|
+
/** Clears one or more ranges of values from a spreadsheet. The caller must specify the spreadsheet ID and one or more ranges. Only values are cleared -- all other properties of the cell (such as formatting and data validation) are kept. */
|
|
3423
|
+
batchClear(request: {
|
|
3568
3424
|
/** V1 error format. */
|
|
3569
3425
|
'$.xgafv'?: '1' | '2';
|
|
3570
3426
|
/** OAuth access token. */
|
|
@@ -3583,95 +3439,46 @@ declare namespace gapi.client {
|
|
|
3583
3439
|
prettyPrint?: boolean;
|
|
3584
3440
|
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
3585
3441
|
quotaUser?: string;
|
|
3586
|
-
/** The [A1 notation or R1C1 notation](https://developers.google.com/workspace/sheets/api/guides/concepts#cell) of the values to clear. */
|
|
3587
|
-
range: string;
|
|
3588
3442
|
/** The ID of the spreadsheet to update. */
|
|
3589
3443
|
spreadsheetId: string;
|
|
3590
3444
|
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
3591
3445
|
upload_protocol?: string;
|
|
3592
3446
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
3593
3447
|
uploadType?: string;
|
|
3594
|
-
|
|
3595
|
-
|
|
3596
|
-
|
|
3597
|
-
|
|
3598
|
-
|
|
3599
|
-
|
|
3600
|
-
|
|
3601
|
-
|
|
3602
|
-
|
|
3603
|
-
|
|
3604
|
-
|
|
3605
|
-
|
|
3606
|
-
|
|
3607
|
-
|
|
3608
|
-
|
|
3609
|
-
|
|
3610
|
-
|
|
3611
|
-
|
|
3612
|
-
|
|
3613
|
-
|
|
3614
|
-
|
|
3615
|
-
|
|
3616
|
-
|
|
3617
|
-
|
|
3618
|
-
|
|
3619
|
-
|
|
3620
|
-
|
|
3621
|
-
|
|
3622
|
-
|
|
3623
|
-
|
|
3624
|
-
|
|
3625
|
-
|
|
3626
|
-
|
|
3627
|
-
|
|
3628
|
-
uploadType?: string;
|
|
3629
|
-
/** How values should be represented in the output. The default render option is FORMATTED_VALUE. */
|
|
3630
|
-
valueRenderOption?: 'FORMATTED_VALUE' | 'UNFORMATTED_VALUE' | 'FORMULA';
|
|
3631
|
-
}): client.Request<ValueRange>;
|
|
3632
|
-
/** Sets values in a range of a spreadsheet. The caller must specify the spreadsheet ID, range, and a valueInputOption. */
|
|
3633
|
-
update(request: {
|
|
3634
|
-
/** V1 error format. */
|
|
3635
|
-
'$.xgafv'?: '1' | '2';
|
|
3636
|
-
/** OAuth access token. */
|
|
3637
|
-
access_token?: string;
|
|
3638
|
-
/** Data format for response. */
|
|
3639
|
-
alt?: 'json' | 'media' | 'proto';
|
|
3640
|
-
/** JSONP */
|
|
3641
|
-
callback?: string;
|
|
3642
|
-
/** Selector specifying which fields to include in a partial response. */
|
|
3643
|
-
fields?: string;
|
|
3644
|
-
/** Determines if the update response should include the values of the cells that were updated. By default, responses do not include the updated values. If the range to write was larger than the range actually written, the response includes all values in the requested range (excluding trailing empty rows and columns). */
|
|
3645
|
-
includeValuesInResponse?: boolean;
|
|
3646
|
-
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
3647
|
-
key?: string;
|
|
3648
|
-
/** OAuth 2.0 token for the current user. */
|
|
3649
|
-
oauth_token?: string;
|
|
3650
|
-
/** Returns response with indentations and line breaks. */
|
|
3651
|
-
prettyPrint?: boolean;
|
|
3652
|
-
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
3653
|
-
quotaUser?: string;
|
|
3654
|
-
/** The [A1 notation](https://developers.google.com/workspace/sheets/api/guides/concepts#cell) of the values to update. */
|
|
3655
|
-
range: string;
|
|
3656
|
-
/** Determines how dates, times, and durations in the response should be rendered. This is ignored if response_value_render_option is FORMATTED_VALUE. The default dateTime render option is SERIAL_NUMBER. */
|
|
3657
|
-
responseDateTimeRenderOption?: 'SERIAL_NUMBER' | 'FORMATTED_STRING';
|
|
3658
|
-
/** Determines how values in the response should be rendered. The default render option is FORMATTED_VALUE. */
|
|
3659
|
-
responseValueRenderOption?:
|
|
3660
|
-
'FORMATTED_VALUE' | 'UNFORMATTED_VALUE' | 'FORMULA';
|
|
3661
|
-
/** The ID of the spreadsheet to update. */
|
|
3662
|
-
spreadsheetId: string;
|
|
3663
|
-
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
3664
|
-
upload_protocol?: string;
|
|
3665
|
-
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
3666
|
-
uploadType?: string;
|
|
3667
|
-
/** How the input data should be interpreted. */
|
|
3668
|
-
valueInputOption?:
|
|
3669
|
-
'INPUT_VALUE_OPTION_UNSPECIFIED' | 'RAW' | 'USER_ENTERED';
|
|
3670
|
-
/** Request body */
|
|
3671
|
-
resource: ValueRange;
|
|
3672
|
-
}): client.Request<UpdateValuesResponse>;
|
|
3673
|
-
update(
|
|
3674
|
-
request: {
|
|
3448
|
+
/** Request body */
|
|
3449
|
+
resource: BatchClearValuesRequest;
|
|
3450
|
+
}): client.Request<BatchClearValuesResponse>;
|
|
3451
|
+
batchClear(
|
|
3452
|
+
request: {
|
|
3453
|
+
/** V1 error format. */
|
|
3454
|
+
'$.xgafv'?: '1' | '2';
|
|
3455
|
+
/** OAuth access token. */
|
|
3456
|
+
access_token?: string;
|
|
3457
|
+
/** Data format for response. */
|
|
3458
|
+
alt?: 'json' | 'media' | 'proto';
|
|
3459
|
+
/** JSONP */
|
|
3460
|
+
callback?: string;
|
|
3461
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
3462
|
+
fields?: string;
|
|
3463
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
3464
|
+
key?: string;
|
|
3465
|
+
/** OAuth 2.0 token for the current user. */
|
|
3466
|
+
oauth_token?: string;
|
|
3467
|
+
/** Returns response with indentations and line breaks. */
|
|
3468
|
+
prettyPrint?: boolean;
|
|
3469
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
3470
|
+
quotaUser?: string;
|
|
3471
|
+
/** The ID of the spreadsheet to update. */
|
|
3472
|
+
spreadsheetId: string;
|
|
3473
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
3474
|
+
upload_protocol?: string;
|
|
3475
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
3476
|
+
uploadType?: string;
|
|
3477
|
+
},
|
|
3478
|
+
body: BatchClearValuesRequest,
|
|
3479
|
+
): client.Request<BatchClearValuesResponse>;
|
|
3480
|
+
/** Clears one or more ranges of values from a spreadsheet. For more information, see [Read, write, and search metadata](https://developers.google.com/workspace/sheets/api/guides/metadata). The caller must specify the spreadsheet ID and one or more DataFilters. Ranges matching any of the specified data filters will be cleared. Only values are cleared -- all other properties of the cell (such as formatting, data validation, etc.) are kept. */
|
|
3481
|
+
batchClearByDataFilter(request: {
|
|
3675
3482
|
/** V1 error format. */
|
|
3676
3483
|
'$.xgafv'?: '1' | '2';
|
|
3677
3484
|
/** OAuth access token. */
|
|
@@ -3682,8 +3489,6 @@ declare namespace gapi.client {
|
|
|
3682
3489
|
callback?: string;
|
|
3683
3490
|
/** Selector specifying which fields to include in a partial response. */
|
|
3684
3491
|
fields?: string;
|
|
3685
|
-
/** Determines if the update response should include the values of the cells that were updated. By default, responses do not include the updated values. If the range to write was larger than the range actually written, the response includes all values in the requested range (excluding trailing empty rows and columns). */
|
|
3686
|
-
includeValuesInResponse?: boolean;
|
|
3687
3492
|
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
3688
3493
|
key?: string;
|
|
3689
3494
|
/** OAuth 2.0 token for the current user. */
|
|
@@ -3692,58 +3497,198 @@ declare namespace gapi.client {
|
|
|
3692
3497
|
prettyPrint?: boolean;
|
|
3693
3498
|
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
3694
3499
|
quotaUser?: string;
|
|
3695
|
-
/** The
|
|
3696
|
-
|
|
3697
|
-
/**
|
|
3698
|
-
|
|
3699
|
-
/**
|
|
3700
|
-
|
|
3500
|
+
/** The ID of the spreadsheet to update. */
|
|
3501
|
+
spreadsheetId: string;
|
|
3502
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
3503
|
+
upload_protocol?: string;
|
|
3504
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
3505
|
+
uploadType?: string;
|
|
3506
|
+
/** Request body */
|
|
3507
|
+
resource: BatchClearValuesByDataFilterRequest;
|
|
3508
|
+
}): client.Request<BatchClearValuesByDataFilterResponse>;
|
|
3509
|
+
batchClearByDataFilter(
|
|
3510
|
+
request: {
|
|
3511
|
+
/** V1 error format. */
|
|
3512
|
+
'$.xgafv'?: '1' | '2';
|
|
3513
|
+
/** OAuth access token. */
|
|
3514
|
+
access_token?: string;
|
|
3515
|
+
/** Data format for response. */
|
|
3516
|
+
alt?: 'json' | 'media' | 'proto';
|
|
3517
|
+
/** JSONP */
|
|
3518
|
+
callback?: string;
|
|
3519
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
3520
|
+
fields?: string;
|
|
3521
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
3522
|
+
key?: string;
|
|
3523
|
+
/** OAuth 2.0 token for the current user. */
|
|
3524
|
+
oauth_token?: string;
|
|
3525
|
+
/** Returns response with indentations and line breaks. */
|
|
3526
|
+
prettyPrint?: boolean;
|
|
3527
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
3528
|
+
quotaUser?: string;
|
|
3529
|
+
/** The ID of the spreadsheet to update. */
|
|
3530
|
+
spreadsheetId: string;
|
|
3531
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
3532
|
+
upload_protocol?: string;
|
|
3533
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
3534
|
+
uploadType?: string;
|
|
3535
|
+
},
|
|
3536
|
+
body: BatchClearValuesByDataFilterRequest,
|
|
3537
|
+
): client.Request<BatchClearValuesByDataFilterResponse>;
|
|
3538
|
+
/** Returns one or more ranges of values from a spreadsheet. The caller must specify the spreadsheet ID and one or more ranges. */
|
|
3539
|
+
batchGet(request?: {
|
|
3540
|
+
/** V1 error format. */
|
|
3541
|
+
'$.xgafv'?: '1' | '2';
|
|
3542
|
+
/** OAuth access token. */
|
|
3543
|
+
access_token?: string;
|
|
3544
|
+
/** Data format for response. */
|
|
3545
|
+
alt?: 'json' | 'media' | 'proto';
|
|
3546
|
+
/** JSONP */
|
|
3547
|
+
callback?: string;
|
|
3548
|
+
/** How dates, times, and durations should be represented in the output. This is ignored if value_render_option is FORMATTED_VALUE. The default dateTime render option is SERIAL_NUMBER. */
|
|
3549
|
+
dateTimeRenderOption?: 'SERIAL_NUMBER' | 'FORMATTED_STRING';
|
|
3550
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
3551
|
+
fields?: string;
|
|
3552
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
3553
|
+
key?: string;
|
|
3554
|
+
/** The major dimension that results should use. For example, if the spreadsheet data is: `A1=1,B1=2,A2=3,B2=4`, then requesting `ranges=["A1:B2"],majorDimension=ROWS` returns `[[1,2],[3,4]]`, whereas requesting `ranges=["A1:B2"],majorDimension=COLUMNS` returns `[[1,3],[2,4]]`. */
|
|
3555
|
+
majorDimension?: 'DIMENSION_UNSPECIFIED' | 'ROWS' | 'COLUMNS';
|
|
3556
|
+
/** OAuth 2.0 token for the current user. */
|
|
3557
|
+
oauth_token?: string;
|
|
3558
|
+
/** Returns response with indentations and line breaks. */
|
|
3559
|
+
prettyPrint?: boolean;
|
|
3560
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
3561
|
+
quotaUser?: string;
|
|
3562
|
+
/** The [A1 notation or R1C1 notation](https://developers.google.com/workspace/sheets/api/guides/concepts#cell) of the range to retrieve values from. */
|
|
3563
|
+
ranges?: string | string[];
|
|
3564
|
+
/** The ID of the spreadsheet to retrieve data from. */
|
|
3565
|
+
spreadsheetId: string;
|
|
3566
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
3567
|
+
upload_protocol?: string;
|
|
3568
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
3569
|
+
uploadType?: string;
|
|
3570
|
+
/** How values should be represented in the output. The default render option is ValueRenderOption.FORMATTED_VALUE. */
|
|
3571
|
+
valueRenderOption?:
|
|
3701
3572
|
'FORMATTED_VALUE' | 'UNFORMATTED_VALUE' | 'FORMULA';
|
|
3573
|
+
}): client.Request<BatchGetValuesResponse>;
|
|
3574
|
+
/** Returns one or more ranges of values that match the specified data filters. For more information, see [Read, write, and search metadata](https://developers.google.com/workspace/sheets/api/guides/metadata). The caller must specify the spreadsheet ID and one or more DataFilters. Ranges that match any of the data filters in the request will be returned. */
|
|
3575
|
+
batchGetByDataFilter(request: {
|
|
3576
|
+
/** V1 error format. */
|
|
3577
|
+
'$.xgafv'?: '1' | '2';
|
|
3578
|
+
/** OAuth access token. */
|
|
3579
|
+
access_token?: string;
|
|
3580
|
+
/** Data format for response. */
|
|
3581
|
+
alt?: 'json' | 'media' | 'proto';
|
|
3582
|
+
/** JSONP */
|
|
3583
|
+
callback?: string;
|
|
3584
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
3585
|
+
fields?: string;
|
|
3586
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
3587
|
+
key?: string;
|
|
3588
|
+
/** OAuth 2.0 token for the current user. */
|
|
3589
|
+
oauth_token?: string;
|
|
3590
|
+
/** Returns response with indentations and line breaks. */
|
|
3591
|
+
prettyPrint?: boolean;
|
|
3592
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
3593
|
+
quotaUser?: string;
|
|
3594
|
+
/** The ID of the spreadsheet to retrieve data from. */
|
|
3595
|
+
spreadsheetId: string;
|
|
3596
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
3597
|
+
upload_protocol?: string;
|
|
3598
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
3599
|
+
uploadType?: string;
|
|
3600
|
+
/** Request body */
|
|
3601
|
+
resource: BatchGetValuesByDataFilterRequest;
|
|
3602
|
+
}): client.Request<BatchGetValuesByDataFilterResponse>;
|
|
3603
|
+
batchGetByDataFilter(
|
|
3604
|
+
request: {
|
|
3605
|
+
/** V1 error format. */
|
|
3606
|
+
'$.xgafv'?: '1' | '2';
|
|
3607
|
+
/** OAuth access token. */
|
|
3608
|
+
access_token?: string;
|
|
3609
|
+
/** Data format for response. */
|
|
3610
|
+
alt?: 'json' | 'media' | 'proto';
|
|
3611
|
+
/** JSONP */
|
|
3612
|
+
callback?: string;
|
|
3613
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
3614
|
+
fields?: string;
|
|
3615
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
3616
|
+
key?: string;
|
|
3617
|
+
/** OAuth 2.0 token for the current user. */
|
|
3618
|
+
oauth_token?: string;
|
|
3619
|
+
/** Returns response with indentations and line breaks. */
|
|
3620
|
+
prettyPrint?: boolean;
|
|
3621
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
3622
|
+
quotaUser?: string;
|
|
3623
|
+
/** The ID of the spreadsheet to retrieve data from. */
|
|
3624
|
+
spreadsheetId: string;
|
|
3625
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
3626
|
+
upload_protocol?: string;
|
|
3627
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
3628
|
+
uploadType?: string;
|
|
3629
|
+
},
|
|
3630
|
+
body: BatchGetValuesByDataFilterRequest,
|
|
3631
|
+
): client.Request<BatchGetValuesByDataFilterResponse>;
|
|
3632
|
+
/** Sets values in one or more ranges of a spreadsheet. The caller must specify the spreadsheet ID, a valueInputOption, and one or more ValueRanges. */
|
|
3633
|
+
batchUpdate(request: {
|
|
3634
|
+
/** V1 error format. */
|
|
3635
|
+
'$.xgafv'?: '1' | '2';
|
|
3636
|
+
/** OAuth access token. */
|
|
3637
|
+
access_token?: string;
|
|
3638
|
+
/** Data format for response. */
|
|
3639
|
+
alt?: 'json' | 'media' | 'proto';
|
|
3640
|
+
/** JSONP */
|
|
3641
|
+
callback?: string;
|
|
3642
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
3643
|
+
fields?: string;
|
|
3644
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
3645
|
+
key?: string;
|
|
3646
|
+
/** OAuth 2.0 token for the current user. */
|
|
3647
|
+
oauth_token?: string;
|
|
3648
|
+
/** Returns response with indentations and line breaks. */
|
|
3649
|
+
prettyPrint?: boolean;
|
|
3650
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
3651
|
+
quotaUser?: string;
|
|
3702
3652
|
/** The ID of the spreadsheet to update. */
|
|
3703
3653
|
spreadsheetId: string;
|
|
3704
3654
|
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
3705
3655
|
upload_protocol?: string;
|
|
3706
3656
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
3707
3657
|
uploadType?: string;
|
|
3708
|
-
/**
|
|
3709
|
-
|
|
3710
|
-
|
|
3711
|
-
|
|
3712
|
-
|
|
3713
|
-
|
|
3714
|
-
|
|
3715
|
-
|
|
3716
|
-
|
|
3717
|
-
|
|
3718
|
-
|
|
3719
|
-
|
|
3720
|
-
|
|
3721
|
-
|
|
3722
|
-
|
|
3723
|
-
|
|
3724
|
-
|
|
3725
|
-
|
|
3726
|
-
|
|
3727
|
-
|
|
3728
|
-
|
|
3729
|
-
|
|
3730
|
-
|
|
3731
|
-
|
|
3732
|
-
|
|
3733
|
-
|
|
3734
|
-
|
|
3735
|
-
|
|
3736
|
-
|
|
3737
|
-
|
|
3738
|
-
|
|
3739
|
-
|
|
3740
|
-
/**
|
|
3741
|
-
|
|
3742
|
-
/** Request body */
|
|
3743
|
-
resource: BatchUpdateSpreadsheetRequest;
|
|
3744
|
-
}): client.Request<BatchUpdateSpreadsheetResponse>;
|
|
3745
|
-
batchUpdate(
|
|
3746
|
-
request: {
|
|
3658
|
+
/** Request body */
|
|
3659
|
+
resource: BatchUpdateValuesRequest;
|
|
3660
|
+
}): client.Request<BatchUpdateValuesResponse>;
|
|
3661
|
+
batchUpdate(
|
|
3662
|
+
request: {
|
|
3663
|
+
/** V1 error format. */
|
|
3664
|
+
'$.xgafv'?: '1' | '2';
|
|
3665
|
+
/** OAuth access token. */
|
|
3666
|
+
access_token?: string;
|
|
3667
|
+
/** Data format for response. */
|
|
3668
|
+
alt?: 'json' | 'media' | 'proto';
|
|
3669
|
+
/** JSONP */
|
|
3670
|
+
callback?: string;
|
|
3671
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
3672
|
+
fields?: string;
|
|
3673
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
3674
|
+
key?: string;
|
|
3675
|
+
/** OAuth 2.0 token for the current user. */
|
|
3676
|
+
oauth_token?: string;
|
|
3677
|
+
/** Returns response with indentations and line breaks. */
|
|
3678
|
+
prettyPrint?: boolean;
|
|
3679
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
3680
|
+
quotaUser?: string;
|
|
3681
|
+
/** The ID of the spreadsheet to update. */
|
|
3682
|
+
spreadsheetId: string;
|
|
3683
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
3684
|
+
upload_protocol?: string;
|
|
3685
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
3686
|
+
uploadType?: string;
|
|
3687
|
+
},
|
|
3688
|
+
body: BatchUpdateValuesRequest,
|
|
3689
|
+
): client.Request<BatchUpdateValuesResponse>;
|
|
3690
|
+
/** Sets values in one or more ranges of a spreadsheet. For more information, see [Read, write, and search metadata](https://developers.google.com/workspace/sheets/api/guides/metadata). The caller must specify the spreadsheet ID, a valueInputOption, and one or more DataFilterValueRanges. */
|
|
3691
|
+
batchUpdateByDataFilter(request: {
|
|
3747
3692
|
/** V1 error format. */
|
|
3748
3693
|
'$.xgafv'?: '1' | '2';
|
|
3749
3694
|
/** OAuth access token. */
|
|
@@ -3762,44 +3707,46 @@ declare namespace gapi.client {
|
|
|
3762
3707
|
prettyPrint?: boolean;
|
|
3763
3708
|
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
3764
3709
|
quotaUser?: string;
|
|
3765
|
-
/** The
|
|
3710
|
+
/** The ID of the spreadsheet to update. */
|
|
3766
3711
|
spreadsheetId: string;
|
|
3767
3712
|
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
3768
3713
|
upload_protocol?: string;
|
|
3769
3714
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
3770
3715
|
uploadType?: string;
|
|
3771
|
-
|
|
3772
|
-
|
|
3773
|
-
|
|
3774
|
-
|
|
3775
|
-
|
|
3776
|
-
|
|
3777
|
-
|
|
3778
|
-
|
|
3779
|
-
|
|
3780
|
-
|
|
3781
|
-
|
|
3782
|
-
|
|
3783
|
-
|
|
3784
|
-
|
|
3785
|
-
|
|
3786
|
-
|
|
3787
|
-
|
|
3788
|
-
|
|
3789
|
-
|
|
3790
|
-
|
|
3791
|
-
|
|
3792
|
-
|
|
3793
|
-
|
|
3794
|
-
|
|
3795
|
-
|
|
3796
|
-
|
|
3797
|
-
|
|
3798
|
-
|
|
3799
|
-
|
|
3800
|
-
|
|
3801
|
-
|
|
3802
|
-
|
|
3716
|
+
/** Request body */
|
|
3717
|
+
resource: BatchUpdateValuesByDataFilterRequest;
|
|
3718
|
+
}): client.Request<BatchUpdateValuesByDataFilterResponse>;
|
|
3719
|
+
batchUpdateByDataFilter(
|
|
3720
|
+
request: {
|
|
3721
|
+
/** V1 error format. */
|
|
3722
|
+
'$.xgafv'?: '1' | '2';
|
|
3723
|
+
/** OAuth access token. */
|
|
3724
|
+
access_token?: string;
|
|
3725
|
+
/** Data format for response. */
|
|
3726
|
+
alt?: 'json' | 'media' | 'proto';
|
|
3727
|
+
/** JSONP */
|
|
3728
|
+
callback?: string;
|
|
3729
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
3730
|
+
fields?: string;
|
|
3731
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
3732
|
+
key?: string;
|
|
3733
|
+
/** OAuth 2.0 token for the current user. */
|
|
3734
|
+
oauth_token?: string;
|
|
3735
|
+
/** Returns response with indentations and line breaks. */
|
|
3736
|
+
prettyPrint?: boolean;
|
|
3737
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
3738
|
+
quotaUser?: string;
|
|
3739
|
+
/** The ID of the spreadsheet to update. */
|
|
3740
|
+
spreadsheetId: string;
|
|
3741
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
3742
|
+
upload_protocol?: string;
|
|
3743
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
3744
|
+
uploadType?: string;
|
|
3745
|
+
},
|
|
3746
|
+
body: BatchUpdateValuesByDataFilterRequest,
|
|
3747
|
+
): client.Request<BatchUpdateValuesByDataFilterResponse>;
|
|
3748
|
+
/** Clears values from a spreadsheet. The caller must specify the spreadsheet ID and range. Only values are cleared -- all other properties of the cell (such as formatting, data validation, etc..) are kept. */
|
|
3749
|
+
clear(request: {
|
|
3803
3750
|
/** V1 error format. */
|
|
3804
3751
|
'$.xgafv'?: '1' | '2';
|
|
3805
3752
|
/** OAuth access token. */
|
|
@@ -3818,83 +3765,50 @@ declare namespace gapi.client {
|
|
|
3818
3765
|
prettyPrint?: boolean;
|
|
3819
3766
|
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
3820
3767
|
quotaUser?: string;
|
|
3768
|
+
/** The [A1 notation or R1C1 notation](https://developers.google.com/workspace/sheets/api/guides/concepts#cell) of the values to clear. */
|
|
3769
|
+
range: string;
|
|
3770
|
+
/** The ID of the spreadsheet to update. */
|
|
3771
|
+
spreadsheetId: string;
|
|
3821
3772
|
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
3822
3773
|
upload_protocol?: string;
|
|
3823
3774
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
3824
3775
|
uploadType?: string;
|
|
3825
|
-
|
|
3826
|
-
|
|
3827
|
-
|
|
3828
|
-
|
|
3829
|
-
|
|
3830
|
-
|
|
3831
|
-
|
|
3832
|
-
|
|
3833
|
-
|
|
3834
|
-
|
|
3835
|
-
|
|
3836
|
-
|
|
3837
|
-
|
|
3838
|
-
|
|
3839
|
-
|
|
3840
|
-
|
|
3841
|
-
|
|
3842
|
-
|
|
3843
|
-
|
|
3844
|
-
|
|
3845
|
-
|
|
3846
|
-
|
|
3847
|
-
|
|
3848
|
-
|
|
3849
|
-
|
|
3850
|
-
|
|
3851
|
-
|
|
3852
|
-
|
|
3853
|
-
|
|
3854
|
-
|
|
3855
|
-
|
|
3856
|
-
|
|
3857
|
-
|
|
3858
|
-
|
|
3859
|
-
|
|
3860
|
-
|
|
3861
|
-
spreadsheetId: string;
|
|
3862
|
-
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
3863
|
-
upload_protocol?: string;
|
|
3864
|
-
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
3865
|
-
uploadType?: string;
|
|
3866
|
-
}): client.Request<Spreadsheet>;
|
|
3867
|
-
/** Returns the spreadsheet at the given ID. The caller must specify the spreadsheet ID. For more information, see [Read, write, and search metadata](https://developers.google.com/workspace/sheets/api/guides/metadata). This method differs from GetSpreadsheet in that it allows selecting which subsets of spreadsheet data to return by specifying a dataFilters parameter. Multiple DataFilters can be specified. Specifying one or more data filters returns the portions of the spreadsheet that intersect ranges matched by any of the filters. By default, data within grids is not returned. You can include grid data in one of two ways: * Specify a [field mask](https://developers.google.com/workspace/sheets/api/guides/field-masks) listing your desired fields using the `fields` URL parameter in HTTP. * Set the includeGridData parameter to `true`. If a field mask is set, the `includeGridData` parameter is ignored. For large spreadsheets, as a best practice, retrieve only the specific spreadsheet fields that you want. */
|
|
3868
|
-
getByDataFilter(request: {
|
|
3869
|
-
/** V1 error format. */
|
|
3870
|
-
'$.xgafv'?: '1' | '2';
|
|
3871
|
-
/** OAuth access token. */
|
|
3872
|
-
access_token?: string;
|
|
3873
|
-
/** Data format for response. */
|
|
3874
|
-
alt?: 'json' | 'media' | 'proto';
|
|
3875
|
-
/** JSONP */
|
|
3876
|
-
callback?: string;
|
|
3877
|
-
/** Selector specifying which fields to include in a partial response. */
|
|
3878
|
-
fields?: string;
|
|
3879
|
-
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
3880
|
-
key?: string;
|
|
3881
|
-
/** OAuth 2.0 token for the current user. */
|
|
3882
|
-
oauth_token?: string;
|
|
3883
|
-
/** Returns response with indentations and line breaks. */
|
|
3884
|
-
prettyPrint?: boolean;
|
|
3885
|
-
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
3886
|
-
quotaUser?: string;
|
|
3887
|
-
/** The spreadsheet to request. */
|
|
3888
|
-
spreadsheetId: string;
|
|
3889
|
-
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
3890
|
-
upload_protocol?: string;
|
|
3891
|
-
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
3892
|
-
uploadType?: string;
|
|
3893
|
-
/** Request body */
|
|
3894
|
-
resource: GetSpreadsheetByDataFilterRequest;
|
|
3895
|
-
}): client.Request<Spreadsheet>;
|
|
3896
|
-
getByDataFilter(
|
|
3897
|
-
request: {
|
|
3776
|
+
/** Request body */
|
|
3777
|
+
resource: ClearValuesRequest;
|
|
3778
|
+
}): client.Request<ClearValuesResponse>;
|
|
3779
|
+
clear(
|
|
3780
|
+
request: {
|
|
3781
|
+
/** V1 error format. */
|
|
3782
|
+
'$.xgafv'?: '1' | '2';
|
|
3783
|
+
/** OAuth access token. */
|
|
3784
|
+
access_token?: string;
|
|
3785
|
+
/** Data format for response. */
|
|
3786
|
+
alt?: 'json' | 'media' | 'proto';
|
|
3787
|
+
/** JSONP */
|
|
3788
|
+
callback?: string;
|
|
3789
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
3790
|
+
fields?: string;
|
|
3791
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
3792
|
+
key?: string;
|
|
3793
|
+
/** OAuth 2.0 token for the current user. */
|
|
3794
|
+
oauth_token?: string;
|
|
3795
|
+
/** Returns response with indentations and line breaks. */
|
|
3796
|
+
prettyPrint?: boolean;
|
|
3797
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
3798
|
+
quotaUser?: string;
|
|
3799
|
+
/** The [A1 notation or R1C1 notation](https://developers.google.com/workspace/sheets/api/guides/concepts#cell) of the values to clear. */
|
|
3800
|
+
range: string;
|
|
3801
|
+
/** The ID of the spreadsheet to update. */
|
|
3802
|
+
spreadsheetId: string;
|
|
3803
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
3804
|
+
upload_protocol?: string;
|
|
3805
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
3806
|
+
uploadType?: string;
|
|
3807
|
+
},
|
|
3808
|
+
body: ClearValuesRequest,
|
|
3809
|
+
): client.Request<ClearValuesResponse>;
|
|
3810
|
+
/** Returns a range of values from a spreadsheet. The caller must specify the spreadsheet ID and a range. */
|
|
3811
|
+
get(request?: {
|
|
3898
3812
|
/** V1 error format. */
|
|
3899
3813
|
'$.xgafv'?: '1' | '2';
|
|
3900
3814
|
/** OAuth access token. */
|
|
@@ -3903,30 +3817,115 @@ declare namespace gapi.client {
|
|
|
3903
3817
|
alt?: 'json' | 'media' | 'proto';
|
|
3904
3818
|
/** JSONP */
|
|
3905
3819
|
callback?: string;
|
|
3820
|
+
/** How dates, times, and durations should be represented in the output. This is ignored if value_render_option is FORMATTED_VALUE. The default dateTime render option is SERIAL_NUMBER. */
|
|
3821
|
+
dateTimeRenderOption?: 'SERIAL_NUMBER' | 'FORMATTED_STRING';
|
|
3906
3822
|
/** Selector specifying which fields to include in a partial response. */
|
|
3907
3823
|
fields?: string;
|
|
3908
3824
|
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
3909
3825
|
key?: string;
|
|
3826
|
+
/** The major dimension that results should use. For example, if the spreadsheet data in Sheet1 is: `A1=1,B1=2,A2=3,B2=4`, then requesting `range=Sheet1!A1:B2?majorDimension=ROWS` returns `[[1,2],[3,4]]`, whereas requesting `range=Sheet1!A1:B2?majorDimension=COLUMNS` returns `[[1,3],[2,4]]`. */
|
|
3827
|
+
majorDimension?: 'DIMENSION_UNSPECIFIED' | 'ROWS' | 'COLUMNS';
|
|
3910
3828
|
/** OAuth 2.0 token for the current user. */
|
|
3911
3829
|
oauth_token?: string;
|
|
3912
3830
|
/** Returns response with indentations and line breaks. */
|
|
3913
3831
|
prettyPrint?: boolean;
|
|
3914
3832
|
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
3915
3833
|
quotaUser?: string;
|
|
3916
|
-
/** The
|
|
3834
|
+
/** The [A1 notation or R1C1 notation](https://developers.google.com/workspace/sheets/api/guides/concepts#cell) of the range to retrieve values from. */
|
|
3835
|
+
range: string;
|
|
3836
|
+
/** The ID of the spreadsheet to retrieve data from. */
|
|
3917
3837
|
spreadsheetId: string;
|
|
3918
3838
|
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
3919
3839
|
upload_protocol?: string;
|
|
3920
3840
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
3921
3841
|
uploadType?: string;
|
|
3922
|
-
|
|
3923
|
-
|
|
3924
|
-
|
|
3925
|
-
|
|
3926
|
-
|
|
3927
|
-
|
|
3928
|
-
|
|
3929
|
-
|
|
3930
|
-
|
|
3842
|
+
/** How values should be represented in the output. The default render option is FORMATTED_VALUE. */
|
|
3843
|
+
valueRenderOption?:
|
|
3844
|
+
'FORMATTED_VALUE' | 'UNFORMATTED_VALUE' | 'FORMULA';
|
|
3845
|
+
}): client.Request<ValueRange>;
|
|
3846
|
+
/** Sets values in a range of a spreadsheet. The caller must specify the spreadsheet ID, range, and a valueInputOption. */
|
|
3847
|
+
update(request: {
|
|
3848
|
+
/** V1 error format. */
|
|
3849
|
+
'$.xgafv'?: '1' | '2';
|
|
3850
|
+
/** OAuth access token. */
|
|
3851
|
+
access_token?: string;
|
|
3852
|
+
/** Data format for response. */
|
|
3853
|
+
alt?: 'json' | 'media' | 'proto';
|
|
3854
|
+
/** JSONP */
|
|
3855
|
+
callback?: string;
|
|
3856
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
3857
|
+
fields?: string;
|
|
3858
|
+
/** Determines if the update response should include the values of the cells that were updated. By default, responses do not include the updated values. If the range to write was larger than the range actually written, the response includes all values in the requested range (excluding trailing empty rows and columns). */
|
|
3859
|
+
includeValuesInResponse?: boolean;
|
|
3860
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
3861
|
+
key?: string;
|
|
3862
|
+
/** OAuth 2.0 token for the current user. */
|
|
3863
|
+
oauth_token?: string;
|
|
3864
|
+
/** Returns response with indentations and line breaks. */
|
|
3865
|
+
prettyPrint?: boolean;
|
|
3866
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
3867
|
+
quotaUser?: string;
|
|
3868
|
+
/** The [A1 notation](https://developers.google.com/workspace/sheets/api/guides/concepts#cell) of the values to update. */
|
|
3869
|
+
range: string;
|
|
3870
|
+
/** Determines how dates, times, and durations in the response should be rendered. This is ignored if response_value_render_option is FORMATTED_VALUE. The default dateTime render option is SERIAL_NUMBER. */
|
|
3871
|
+
responseDateTimeRenderOption?: 'SERIAL_NUMBER' | 'FORMATTED_STRING';
|
|
3872
|
+
/** Determines how values in the response should be rendered. The default render option is FORMATTED_VALUE. */
|
|
3873
|
+
responseValueRenderOption?:
|
|
3874
|
+
'FORMATTED_VALUE' | 'UNFORMATTED_VALUE' | 'FORMULA';
|
|
3875
|
+
/** The ID of the spreadsheet to update. */
|
|
3876
|
+
spreadsheetId: string;
|
|
3877
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
3878
|
+
upload_protocol?: string;
|
|
3879
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
3880
|
+
uploadType?: string;
|
|
3881
|
+
/** How the input data should be interpreted. */
|
|
3882
|
+
valueInputOption?:
|
|
3883
|
+
'INPUT_VALUE_OPTION_UNSPECIFIED' | 'RAW' | 'USER_ENTERED';
|
|
3884
|
+
/** Request body */
|
|
3885
|
+
resource: ValueRange;
|
|
3886
|
+
}): client.Request<UpdateValuesResponse>;
|
|
3887
|
+
update(
|
|
3888
|
+
request: {
|
|
3889
|
+
/** V1 error format. */
|
|
3890
|
+
'$.xgafv'?: '1' | '2';
|
|
3891
|
+
/** OAuth access token. */
|
|
3892
|
+
access_token?: string;
|
|
3893
|
+
/** Data format for response. */
|
|
3894
|
+
alt?: 'json' | 'media' | 'proto';
|
|
3895
|
+
/** JSONP */
|
|
3896
|
+
callback?: string;
|
|
3897
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
3898
|
+
fields?: string;
|
|
3899
|
+
/** Determines if the update response should include the values of the cells that were updated. By default, responses do not include the updated values. If the range to write was larger than the range actually written, the response includes all values in the requested range (excluding trailing empty rows and columns). */
|
|
3900
|
+
includeValuesInResponse?: boolean;
|
|
3901
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
3902
|
+
key?: string;
|
|
3903
|
+
/** OAuth 2.0 token for the current user. */
|
|
3904
|
+
oauth_token?: string;
|
|
3905
|
+
/** Returns response with indentations and line breaks. */
|
|
3906
|
+
prettyPrint?: boolean;
|
|
3907
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
3908
|
+
quotaUser?: string;
|
|
3909
|
+
/** The [A1 notation](https://developers.google.com/workspace/sheets/api/guides/concepts#cell) of the values to update. */
|
|
3910
|
+
range: string;
|
|
3911
|
+
/** Determines how dates, times, and durations in the response should be rendered. This is ignored if response_value_render_option is FORMATTED_VALUE. The default dateTime render option is SERIAL_NUMBER. */
|
|
3912
|
+
responseDateTimeRenderOption?: 'SERIAL_NUMBER' | 'FORMATTED_STRING';
|
|
3913
|
+
/** Determines how values in the response should be rendered. The default render option is FORMATTED_VALUE. */
|
|
3914
|
+
responseValueRenderOption?:
|
|
3915
|
+
'FORMATTED_VALUE' | 'UNFORMATTED_VALUE' | 'FORMULA';
|
|
3916
|
+
/** The ID of the spreadsheet to update. */
|
|
3917
|
+
spreadsheetId: string;
|
|
3918
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
3919
|
+
upload_protocol?: string;
|
|
3920
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
3921
|
+
uploadType?: string;
|
|
3922
|
+
/** How the input data should be interpreted. */
|
|
3923
|
+
valueInputOption?:
|
|
3924
|
+
'INPUT_VALUE_OPTION_UNSPECIFIED' | 'RAW' | 'USER_ENTERED';
|
|
3925
|
+
},
|
|
3926
|
+
body: ValueRange,
|
|
3927
|
+
): client.Request<UpdateValuesResponse>;
|
|
3928
|
+
};
|
|
3929
|
+
};
|
|
3931
3930
|
}
|
|
3932
3931
|
}
|