Public/GSheets/Remove-GSheetsSheet.ps1
|
<#
.SYNOPSIS Remove a Sheet from an existing GoogleSheet .DESCRIPTION Remove a Sheet from an existing GoogleSheet .PARAMETER SpreadsheetId SpreadsheetId file id .PARAMETER SheetId Id of the sheet to be deleted (can be found in url) .PARAMETER SheetName Name of the sheet to be deleted .PARAMETER AccessToken Access Token for request .EXAMPLE Remove-GSheetsSheet -AccessToken $access_token -SpreadsheetId $SpreadsheetId -SheetId "2045344383" .EXAMPLE Remove-GSheetsSheet -AccessToken $access_token -SpreadsheetId $SpreadsheetId -SheetName "Sheet1" .OUTPUTS .NOTES Author: Jan Elhaus .LINK https://developers.google.com/sheets/api/samples/sheet https://developers.google.com/sheets/api/reference/rest/v4/spreadsheets.values/batchUpdate #> function Remove-GSheetsSheet { [CmdletBinding(SupportsShouldProcess, ConfirmImpact='High')] param( [Parameter(Mandatory)] [ValidatePattern('^[a-zA-Z0-9-_]+$')] [Alias('ID')] [string]$SpreadsheetId, [Parameter(ParameterSetName='SheetId', Mandatory=$true)] [string]$SheetId, [Parameter(ParameterSetName='SheetName', Mandatory=$true)] [string]$SheetName, [Parameter(Mandatory)] [string]$AccessToken ) if ($PSCmdlet.ParameterSetName -eq 'SheetName') { $SheetId = Find-GSheetByName -AccessToken $AccessToken -SpreadsheetId $SpreadsheetId -SheetName $SheetName } $Headers = @{ "Authorization" = "Bearer $AccessToken" } $requestParams = @{ Uri = $GDriveSheetsUri + "/" + $SpreadsheetId + ":batchUpdate" Headers = $Headers ContentType = "application/json; charset=utf-8" Body = @{ requests = @( @{ deleteSheet = @{ sheetId = $SheetId } } ) } | ConvertTo-Json -Depth 4 -Compress } Write-Verbose "Webrequest: $($requestParams | ConvertTo-Json -Depth 3)" if ($PSCmdlet.ShouldProcess("Remove Sheet $SheetId")){ Invoke-RestMethod @requestParams -Method POST @GDriveProxySettings | Out-Null } } |