happygapi.sheets.spreadsheets — happygapi 0.4.2

Google Sheets API: spreadsheets. Reads and writes Google Sheets. See: https://developers.google.com/sheets/api/reference/rest/v4/spreadsheets

batchUpdate$ clj

(batchUpdate$ auth parameters body)

https://developers.google.com/sheets/api/reference/rest/v4/spreadsheets/batchUpdate

Required parameters: spreadsheetId

Optional parameters: none

Body:

{:includeSpreadsheetInResponse boolean, :responseRanges [string], :responseIncludeGridData boolean, :requests [{:moveDimension MoveDimensionRequest, :repeatCell RepeatCellRequest, :updateFilterView UpdateFilterViewRequest, :addSlicer AddSlicerRequest, :deleteEmbeddedObject DeleteEmbeddedObjectRequest, :deleteBanding DeleteBandingRequest, :addDimensionGroup AddDimensionGroupRequest, :addConditionalFormatRule AddConditionalFormatRuleRequest, :updateDimensionGroup UpdateDimensionGroupRequest, :updateCells UpdateCellsRequest, :updateProtectedRange UpdateProtectedRangeRequest, :addFilterView AddFilterViewRequest, :autoResizeDimensions AutoResizeDimensionsRequest, :insertDimension InsertDimensionRequest, :updateChartSpec UpdateChartSpecRequest, :duplicateSheet DuplicateSheetRequest, :trimWhitespace TrimWhitespaceRequest, :pasteData PasteDataRequest, :updateSpreadsheetProperties UpdateSpreadsheetPropertiesRequest, :addBanding AddBandingRequest, :updateBanding UpdateBandingRequest, :deleteDuplicates DeleteDuplicatesRequest, :deleteSheet DeleteSheetRequest, :deleteProtectedRange DeleteProtectedRangeRequest, :updateDeveloperMetadata UpdateDeveloperMetadataRequest, :updateSheetProperties UpdateSheetPropertiesRequest, :duplicateFilterView DuplicateFilterViewRequest, :updateDimensionProperties UpdateDimensionPropertiesRequest, :deleteDeveloperMetadata DeleteDeveloperMetadataRequest, :unmergeCells UnmergeCellsRequest, :createDeveloperMetadata CreateDeveloperMetadataRequest, :cutPaste CutPasteRequest, :appendDimension AppendDimensionRequest, :deleteFilterView DeleteFilterViewRequest, :deleteRange DeleteRangeRequest, :setDataValidation SetDataValidationRequest, :deleteConditionalFormatRule DeleteConditionalFormatRuleRequest, :appendCells AppendCellsRequest, :textToColumns TextToColumnsRequest, :deleteDimensionGroup DeleteDimensionGroupRequest, :mergeCells MergeCellsRequest, :randomizeRange RandomizeRangeRequest, :insertRange InsertRangeRequest, :deleteNamedRange DeleteNamedRangeRequest, :updateNamedRange UpdateNamedRangeRequest, :findReplace FindReplaceRequest, :updateEmbeddedObjectPosition UpdateEmbeddedObjectPositionRequest, :addSheet AddSheetRequest, :updateBorders UpdateBordersRequest, :addNamedRange AddNamedRangeRequest, :addChart AddChartRequest, :addProtectedRange AddProtectedRangeRequest, :setBasicFilter SetBasicFilterRequest, :clearBasicFilter ClearBasicFilterRequest, :sortRange SortRangeRequest, :deleteDimension DeleteDimensionRequest, :updateSlicerSpec UpdateSlicerSpecRequest, :autoFill AutoFillRequest, :copyPaste CopyPasteRequest, :updateConditionalFormatRule UpdateConditionalFormatRuleRequest}]}

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.

create$ clj

(create$ auth parameters body)

https://developers.google.com/sheets/api/reference/rest/v4/spreadsheets/create

Required parameters: none

Optional parameters: none

Body:

{:properties {:locale string, :spreadsheetTheme SpreadsheetTheme, :iterativeCalculationSettings IterativeCalculationSettings, :autoRecalc string, :defaultFormat CellFormat, :title string, :timeZone string}, :spreadsheetId string, :namedRanges [{:name string, :namedRangeId string, :range GridRange}], :developerMetadata [{:metadataValue string, :metadataKey string, :metadataId integer, :location DeveloperMetadataLocation, :visibility string}], :sheets [{:properties SheetProperties, :filterViews [FilterView], :slicers [Slicer], :columnGroups [DimensionGroup], :developerMetadata [DeveloperMetadata], :protectedRanges [ProtectedRange], :rowGroups [DimensionGroup], :bandedRanges [BandedRange], :basicFilter BasicFilter, :merges [GridRange], :charts [EmbeddedChart], :conditionalFormats [ConditionalFormatRule], :data [GridData]}], :spreadsheetUrl string}

Creates a spreadsheet, returning the newly created spreadsheet.

developerMetadata-get$ clj

(developerMetadata-get$ auth parameters)

https://developers.google.com/sheets/api/reference/rest/v4/spreadsheets/developerMetadata/get

Required parameters: spreadsheetId, metadataId

Optional parameters: none

Returns the developer metadata with the specified ID. The caller must specify the spreadsheet ID and the developer metadata's unique metadataId.

developerMetadata-search$ clj

(developerMetadata-search$ auth parameters body)

https://developers.google.com/sheets/api/reference/rest/v4/spreadsheets/developerMetadata/search

Required parameters: spreadsheetId

Optional parameters: none

Body:

{:dataFilters [{:gridRange GridRange, :developerMetadataLookup DeveloperMetadataLookup, :a1Range string}]}

Returns all developer metadata matching the specified DataFilter. 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.

get$ clj

(get$ auth parameters)

https://developers.google.com/sheets/api/reference/rest/v4/spreadsheets/get

Required parameters: spreadsheetId

Optional parameters: ranges, includeGridData

Returns the spreadsheet at the given ID. The caller must specify the spreadsheet ID.

By default, data within grids will not be returned. You can include grid data one of two ways:

• Specify a field mask 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, it is recommended to retrieve only the specific fields of the spreadsheet that you want.

To retrieve only subsets of the spreadsheet, use the ranges URL parameter. Multiple ranges can be specified. Limiting the range will return only the portions of the spreadsheet that intersect the requested ranges. Ranges are specified using A1 notation.

getByDataFilter$ clj

(getByDataFilter$ auth parameters body)

https://developers.google.com/sheets/api/reference/rest/v4/spreadsheets/getByDataFilter

Required parameters: spreadsheetId

Optional parameters: none

Body:

{:includeGridData boolean, :dataFilters [{:gridRange GridRange, :developerMetadataLookup DeveloperMetadataLookup, :a1Range string}]}

Returns the spreadsheet at the given ID. The caller must specify the spreadsheet ID.

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 will return the portions of the spreadsheet that intersect ranges matched by any of the filters.

By default, data within grids will not be returned. You can include grid data one of two ways:

• Specify a field mask 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, it is recommended to retrieve only the specific fields of the spreadsheet that you want.

sheets-copyTo$ clj

(sheets-copyTo$ auth parameters body)

https://developers.google.com/sheets/api/reference/rest/v4/spreadsheets/sheets/copyTo

Required parameters: sheetId, spreadsheetId

Optional parameters: none

Body:

{:destinationSpreadsheetId string}

Copies a single sheet from a spreadsheet to another spreadsheet. Returns the properties of the newly created sheet.

values-append$ clj

(values-append$ auth parameters body)

https://developers.google.com/sheets/api/reference/rest/v4/spreadsheets/values/append

Required parameters: range, spreadsheetId

Optional parameters: insertDataOption, valueInputOption, responseDateTimeRenderOption, includeValuesInResponse, responseValueRenderOption

Body:

{:majorDimension string, :values [[any]], :range string}

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 and sample code 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.

values-batchClear$ clj

(values-batchClear$ auth parameters body)

https://developers.google.com/sheets/api/reference/rest/v4/spreadsheets/values/batchClear

Required parameters: spreadsheetId

Optional parameters: none

Body:

{:ranges [string]}

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, data validation, etc..) are kept.

values-batchClearByDataFilter$ clj

(values-batchClearByDataFilter$ auth parameters body)

https://developers.google.com/sheets/api/reference/rest/v4/spreadsheets/values/batchClearByDataFilter

Required parameters: spreadsheetId

Optional parameters: none

Body:

{:dataFilters [{:gridRange GridRange, :developerMetadataLookup DeveloperMetadataLookup, :a1Range string}]}

Clears one or more ranges of values from a spreadsheet. 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.

values-batchGet$ clj

(values-batchGet$ auth parameters)

https://developers.google.com/sheets/api/reference/rest/v4/spreadsheets/values/batchGet

Required parameters: spreadsheetId

Optional parameters: valueRenderOption, dateTimeRenderOption, ranges, majorDimension

Returns one or more ranges of values from a spreadsheet. The caller must specify the spreadsheet ID and one or more ranges.

values-batchGetByDataFilter$ clj

(values-batchGetByDataFilter$ auth parameters body)

https://developers.google.com/sheets/api/reference/rest/v4/spreadsheets/values/batchGetByDataFilter

Required parameters: spreadsheetId

Optional parameters: none

Body:

{:dataFilters [{:gridRange GridRange, :developerMetadataLookup DeveloperMetadataLookup, :a1Range string}], :valueRenderOption string, :dateTimeRenderOption string, :majorDimension string}

Returns one or more ranges of values that match the specified data filters. 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.

values-batchUpdate$ clj

(values-batchUpdate$ auth parameters body)

https://developers.google.com/sheets/api/reference/rest/v4/spreadsheets/values/batchUpdate

Required parameters: spreadsheetId

Optional parameters: none

Body:

{:responseDateTimeRenderOption string, :responseValueRenderOption string, :includeValuesInResponse boolean, :valueInputOption string, :data [{:majorDimension string, :values [[any]], :range string}]}

Sets values in one or more ranges of a spreadsheet. The caller must specify the spreadsheet ID, a valueInputOption, and one or more ValueRanges.

values-batchUpdateByDataFilter$ clj

(values-batchUpdateByDataFilter$ auth parameters body)

https://developers.google.com/sheets/api/reference/rest/v4/spreadsheets/values/batchUpdateByDataFilter

Required parameters: spreadsheetId

Optional parameters: none

Body:

{:responseDateTimeRenderOption string, :responseValueRenderOption string, :includeValuesInResponse boolean, :valueInputOption string, :data [{:dataFilter DataFilter, :majorDimension string, :values [[any]]}]}

Sets values in one or more ranges of a spreadsheet. The caller must specify the spreadsheet ID, a valueInputOption, and one or more DataFilterValueRanges.

values-clear$ clj

(values-clear$ auth parameters body)

https://developers.google.com/sheets/api/reference/rest/v4/spreadsheets/values/clear

Required parameters: spreadsheetId, range

Optional parameters: none

Body:

{}

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.

values-get$ clj

(values-get$ auth parameters)

https://developers.google.com/sheets/api/reference/rest/v4/spreadsheets/values/get

Required parameters: spreadsheetId, range

Optional parameters: valueRenderOption, dateTimeRenderOption, majorDimension

Returns a range of values from a spreadsheet. The caller must specify the spreadsheet ID and a range.

values-update$ clj

(values-update$ auth parameters body)

https://developers.google.com/sheets/api/reference/rest/v4/spreadsheets/values/update

Required parameters: range, spreadsheetId

Optional parameters: valueInputOption, responseDateTimeRenderOption, includeValuesInResponse, responseValueRenderOption

Body:

{:majorDimension string, :values [[any]], :range string}

Sets values in a range of a spreadsheet. The caller must specify the spreadsheet ID, range, and a valueInputOption.