feat(sheets): update the API

#### sheets:v4 The following keys were added: - schemas.CancelDataSourceRefreshRequest.description - schemas.CancelDataSourceRefreshRequest.id - schemas.CancelDataSourceRefreshRequest.properties.dataSourceId.description - schemas.CancelDataSourceRefreshRequest.properties.dataSourceId.type - schemas.CancelDataSourceRefreshRequest.properties.isAll.description - schemas.CancelDataSourceRefreshRequest.properties.isAll.type - schemas.CancelDataSourceRefreshRequest.properties.references.$ref - schemas.CancelDataSourceRefreshRequest.properties.references.description - schemas.CancelDataSourceRefreshRequest.type - schemas.CancelDataSourceRefreshResponse.description - schemas.CancelDataSourceRefreshResponse.id - schemas.CancelDataSourceRefreshResponse.properties.statuses.description - schemas.CancelDataSourceRefreshResponse.properties.statuses.items.$ref - schemas.CancelDataSourceRefreshResponse.properties.statuses.type - schemas.CancelDataSourceRefreshResponse.type - schemas.CancelDataSourceRefreshStatus.description - schemas.CancelDataSourceRefreshStatus.id - schemas.CancelDataSourceRefreshStatus.properties.reference.$ref - schemas.CancelDataSourceRefreshStatus.properties.reference.description - schemas.CancelDataSourceRefreshStatus.properties.refreshCancellationStatus.$ref - schemas.CancelDataSourceRefreshStatus.properties.refreshCancellationStatus.description - schemas.CancelDataSourceRefreshStatus.type - schemas.RefreshCancellationStatus.description - schemas.RefreshCancellationStatus.id - schemas.RefreshCancellationStatus.properties.errorCode.description - schemas.RefreshCancellationStatus.properties.errorCode.enum - schemas.RefreshCancellationStatus.properties.errorCode.enumDescriptions - schemas.RefreshCancellationStatus.properties.errorCode.type - schemas.RefreshCancellationStatus.properties.state.description - schemas.RefreshCancellationStatus.properties.state.enum - schemas.RefreshCancellationStatus.properties.state.enumDescriptions - schemas.RefreshCancellationStatus.properties.state.type - schemas.RefreshCancellationStatus.type - schemas.Request.properties.cancelDataSourceRefresh.$ref - schemas.Request.properties.cancelDataSourceRefresh.description - schemas.Response.properties.cancelDataSourceRefresh.$ref - schemas.Response.properties.cancelDataSourceRefresh.description The following keys were changed: - schemas.DataExecutionStatus.properties.errorCode.enum - schemas.DataExecutionStatus.properties.errorCode.enumDescriptions - schemas.DataExecutionStatus.properties.state.enum - schemas.DataExecutionStatus.properties.state.enumDescriptions - schemas.PivotValue.properties.summarizeFunction.enum - schemas.PivotValue.properties.summarizeFunction.enumDescriptions - schemas.SpreadsheetProperties.properties.importFunctionsExternalUrlAccessAllowed.description
googleapis · May 2, 2024 · 74b2d05 · 74b2d05
1 parent 41b76ee
commit 74b2d05
Show file tree

Hide file tree

Showing 2 changed files with 187 additions and 7 deletions.
diff --git a/discovery/sheets-v4.json b/discovery/sheets-v4.json
@@ -870,7 +870,7 @@
       }
     }
   },
-  "revision": "20240318",
+  "revision": "20240430",
   "rootUrl": "https://sheets.googleapis.com/",
   "schemas": {
     "AddBandingRequest": {
@@ -2329,6 +2329,54 @@
       },
       "type": "object"
     },
+    "CancelDataSourceRefreshRequest": {
+      "description": "Cancels one or multiple refreshes of data source objects in the spreadsheet by the specified references.",
+      "id": "CancelDataSourceRefreshRequest",
+      "properties": {
+        "dataSourceId": {
+          "description": "Reference to a DataSource. If specified, cancels all associated data source object refreshes for this data source.",
+          "type": "string"
+        },
+        "isAll": {
+          "description": "Cancels all existing data source object refreshes for all data sources in the spreadsheet.",
+          "type": "boolean"
+        },
+        "references": {
+          "$ref": "DataSourceObjectReferences",
+          "description": "References to data source objects whose refreshes are to be cancelled."
+        }
+      },
+      "type": "object"
+    },
+    "CancelDataSourceRefreshResponse": {
+      "description": "The response from cancelling one or multiple data source object refreshes.",
+      "id": "CancelDataSourceRefreshResponse",
+      "properties": {
+        "statuses": {
+          "description": "The cancellation statuses of refreshes of all data source objects specified in the request. If is_all is specified, the field contains only those in failure status. Refreshing and canceling refresh the same data source object is also not allowed in the same `batchUpdate`.",
+          "items": {
+            "$ref": "CancelDataSourceRefreshStatus"
+          },
+          "type": "array"
+        }
+      },
+      "type": "object"
+    },
+    "CancelDataSourceRefreshStatus": {
+      "description": "The status of cancelling a single data source object refresh.",
+      "id": "CancelDataSourceRefreshStatus",
+      "properties": {
+        "reference": {
+          "$ref": "DataSourceObjectReference",
+          "description": "Reference to the data source object whose refresh is being cancelled."
+        },
+        "refreshCancellationStatus": {
+          "$ref": "RefreshCancellationStatus",
+          "description": "The cancellation status."
+        }
+      },
+      "type": "object"
+    },
     "CandlestickChartSpec": {
       "description": "A candlestick chart.",
       "id": "CandlestickChartSpec",
@@ -3178,7 +3226,8 @@
             "MISSING_COLUMN_ALIAS",
             "OBJECT_NOT_FOUND",
             "OBJECT_IN_ERROR_STATE",
-            "OBJECT_SPEC_INVALID"
+            "OBJECT_SPEC_INVALID",
+            "DATA_EXECUTION_CANCELLED"
           ],
           "enumDescriptions": [
             "Default value, do not use.",
@@ -3199,7 +3248,8 @@
             "The data execution returns columns with missing aliases.",
             "The data source object does not exist.",
             "The data source object is currently in error state. To force refresh, set force in RefreshDataSourceRequest.",
-            "The data source object specification is invalid."
+            "The data source object specification is invalid.",
+            "The data execution has been cancelled."
           ],
           "type": "string"
         },
@@ -3218,13 +3268,15 @@
             "DATA_EXECUTION_STATE_UNSPECIFIED",
             "NOT_STARTED",
             "RUNNING",
+            "CANCELLING",
             "SUCCEEDED",
             "FAILED"
           ],
           "enumDescriptions": [
             "Default value, do not use.",
             "The data execution has not started.",
             "The data execution has started and is running.",
+            "The data execution is currently being cancelled.",
             "The data execution has completed successfully.",
             "The data execution has completed with errors."
           ],
@@ -5733,7 +5785,8 @@
             "STDEVP",
             "VAR",
             "VARP",
-            "CUSTOM"
+            "CUSTOM",
+            "NONE"
           ],
           "enumDescriptions": [
             "The default, do not use.",
@@ -5750,7 +5803,8 @@
             "Corresponds to the `STDEVP` function.",
             "Corresponds to the `VAR` function.",
             "Corresponds to the `VARP` function.",
-            "Indicates the formula should be used as-is. Only valid if PivotValue.formula was set."
+            "Indicates the formula should be used as-is. Only valid if PivotValue.formula was set.",
+            "Indicates that the value is already summarized, and the summarization function is not explicitly specified. Used for Looker data source pivot tables where the value is already summarized."
           ],
           "type": "string"
         }
@@ -5849,6 +5903,47 @@
       },
       "type": "object"
     },
+    "RefreshCancellationStatus": {
+      "description": "The status of a refresh cancellation. You can send cancel request to explicitly cancel one or multiple data source object refreshes.",
+      "id": "RefreshCancellationStatus",
+      "properties": {
+        "errorCode": {
+          "description": "The error code.",
+          "enum": [
+            "REFRESH_CANCELLATION_ERROR_CODE_UNSPECIFIED",
+            "EXECUTION_NOT_FOUND",
+            "CANCEL_PERMISSION_DENIED",
+            "QUERY_EXECUTION_COMPLETED",
+            "CONCURRENT_CANCELLATION",
+            "CANCEL_OTHER_ERROR"
+          ],
+          "enumDescriptions": [
+            "Default value, do not use.",
+            "Execution to be cancelled not found in the query engine or in Sheets.",
+            "The user does not have permission to cancel the query.",
+            "The query execution has already completed and thus could not be cancelled.",
+            "There is already another cancellation in process.",
+            "All other errors."
+          ],
+          "type": "string"
+        },
+        "state": {
+          "description": "The state of a call to cancel a refresh in Sheets.",
+          "enum": [
+            "REFRESH_CANCELLATION_STATE_UNSPECIFIED",
+            "CANCEL_SUCCEEDED",
+            "CANCEL_FAILED"
+          ],
+          "enumDescriptions": [
+            "Default value, do not use.",
+            "The API call to Sheets to cancel a refresh has succeeded. This does not mean that the cancel happened successfully, but that the call has been made successfully.",
+            "The API call to Sheets to cancel a refresh has failed."
+          ],
+          "type": "string"
+        }
+      },
+      "type": "object"
+    },
     "RefreshDataSourceObjectExecutionStatus": {
       "description": "The execution status of refreshing one data source object.",
       "id": "RefreshDataSourceObjectExecutionStatus",
@@ -5981,6 +6076,10 @@
           "$ref": "AutoResizeDimensionsRequest",
           "description": "Automatically resizes one or more dimensions based on the contents of the cells in that dimension."
         },
+        "cancelDataSourceRefresh": {
+          "$ref": "CancelDataSourceRefreshRequest",
+          "description": "Cancels refreshes of one or multiple data sources and associated dbobjects."
+        },
         "clearBasicFilter": {
           "$ref": "ClearBasicFilterRequest",
           "description": "Clears the basic filter on a sheet."
@@ -6228,6 +6327,10 @@
           "$ref": "AddSlicerResponse",
           "description": "A reply from adding a slicer."
         },
+        "cancelDataSourceRefresh": {
+          "$ref": "CancelDataSourceRefreshResponse",
+          "description": "A reply from cancelling data source object refreshes."
+        },
         "createDeveloperMetadata": {
           "$ref": "CreateDeveloperMetadataResponse",
           "description": "A reply from creating a developer metadata entry."
@@ -6831,7 +6934,7 @@
           "description": "The default format of all cells in the spreadsheet. CellData.effectiveFormat will not be set if the cell's format is equal to this default format. This field is read-only."
         },
         "importFunctionsExternalUrlAccessAllowed": {
-          "description": "Whether to allow external url access for image and import functions. Read only when true. When false, you can set to true.",
+          "description": "Whether to allow external URL access for image and import functions. Read only when true. When false, you can set to true.",
           "type": "boolean"
         },
         "iterativeCalculationSettings": {