google-api-python-client 2.181.0__py3-none-any.whl → 2.182.0__py3-none-any.whl
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.
- {google_api_python_client-2.181.0.dist-info → google_api_python_client-2.182.0.dist-info}/METADATA +1 -1
- {google_api_python_client-2.181.0.dist-info → google_api_python_client-2.182.0.dist-info}/RECORD +142 -141
- googleapiclient/discovery_cache/documents/aiplatform.v1.json +1442 -6
- googleapiclient/discovery_cache/documents/aiplatform.v1beta1.json +44 -28
- googleapiclient/discovery_cache/documents/alloydb.v1.json +77 -6
- googleapiclient/discovery_cache/documents/alloydb.v1alpha.json +77 -6
- googleapiclient/discovery_cache/documents/alloydb.v1beta.json +77 -6
- googleapiclient/discovery_cache/documents/analyticshub.v1.json +63 -1
- googleapiclient/discovery_cache/documents/analyticshub.v1beta1.json +8 -1
- googleapiclient/discovery_cache/documents/androidmanagement.v1.json +3 -3
- googleapiclient/discovery_cache/documents/androidpublisher.v3.json +110 -1
- googleapiclient/discovery_cache/documents/apigee.v1.json +280 -4
- googleapiclient/discovery_cache/documents/apihub.v1.json +86 -4
- googleapiclient/discovery_cache/documents/authorizedbuyersmarketplace.v1alpha.json +2 -2
- googleapiclient/discovery_cache/documents/authorizedbuyersmarketplace.v1beta.json +2 -2
- googleapiclient/discovery_cache/documents/backupdr.v1.json +27 -6
- googleapiclient/discovery_cache/documents/bigquerydatatransfer.v1.json +2 -2
- googleapiclient/discovery_cache/documents/bigqueryreservation.v1.json +11 -5
- googleapiclient/discovery_cache/documents/bigtableadmin.v2.json +6 -6
- googleapiclient/discovery_cache/documents/chat.v1.json +5 -5
- googleapiclient/discovery_cache/documents/classroom.v1.json +3 -3
- googleapiclient/discovery_cache/documents/cloudbuild.v1.json +2 -2
- googleapiclient/discovery_cache/documents/cloudbuild.v2.json +2 -2
- googleapiclient/discovery_cache/documents/cloudcommerceprocurement.v1.json +928 -880
- googleapiclient/discovery_cache/documents/cloudfunctions.v1.json +2 -2
- googleapiclient/discovery_cache/documents/cloudfunctions.v2.json +5 -3
- googleapiclient/discovery_cache/documents/cloudfunctions.v2alpha.json +5 -3
- googleapiclient/discovery_cache/documents/cloudfunctions.v2beta.json +5 -3
- googleapiclient/discovery_cache/documents/cloudlocationfinder.v1.json +472 -0
- googleapiclient/discovery_cache/documents/cloudlocationfinder.v1alpha.json +2 -2
- googleapiclient/discovery_cache/documents/compute.alpha.json +3886 -695
- googleapiclient/discovery_cache/documents/compute.beta.json +182 -6
- googleapiclient/discovery_cache/documents/compute.v1.json +559 -5
- googleapiclient/discovery_cache/documents/connectors.v1.json +2 -2
- googleapiclient/discovery_cache/documents/connectors.v2.json +8 -1
- googleapiclient/discovery_cache/documents/contactcenterinsights.v1.json +10 -6
- googleapiclient/discovery_cache/documents/containeranalysis.v1.json +2 -2
- googleapiclient/discovery_cache/documents/containeranalysis.v1alpha1.json +2 -2
- googleapiclient/discovery_cache/documents/containeranalysis.v1beta1.json +117 -8
- googleapiclient/discovery_cache/documents/dataform.v1beta1.json +2 -2
- googleapiclient/discovery_cache/documents/datafusion.v1.json +10 -6
- googleapiclient/discovery_cache/documents/datafusion.v1beta1.json +10 -6
- googleapiclient/discovery_cache/documents/datamigration.v1.json +29 -1
- googleapiclient/discovery_cache/documents/dataplex.v1.json +2 -2
- googleapiclient/discovery_cache/documents/datastore.v1.json +6 -1
- googleapiclient/discovery_cache/documents/datastore.v1beta1.json +6 -1
- googleapiclient/discovery_cache/documents/datastore.v1beta3.json +6 -1
- googleapiclient/discovery_cache/documents/datastream.v1.json +17 -1
- googleapiclient/discovery_cache/documents/deploymentmanager.alpha.json +2 -1
- googleapiclient/discovery_cache/documents/deploymentmanager.v2.json +2 -1
- googleapiclient/discovery_cache/documents/deploymentmanager.v2beta.json +2 -1
- googleapiclient/discovery_cache/documents/developerconnect.v1.json +2 -2
- googleapiclient/discovery_cache/documents/dfareporting.v4.json +108 -1
- googleapiclient/discovery_cache/documents/dfareporting.v5.json +108 -1
- googleapiclient/discovery_cache/documents/dialogflow.v2.json +2 -2
- googleapiclient/discovery_cache/documents/dialogflow.v3.json +2 -2
- googleapiclient/discovery_cache/documents/discoveryengine.v1.json +148 -3
- googleapiclient/discovery_cache/documents/discoveryengine.v1alpha.json +518 -22
- googleapiclient/discovery_cache/documents/discoveryengine.v1beta.json +181 -3
- googleapiclient/discovery_cache/documents/displayvideo.v2.json +5 -3
- googleapiclient/discovery_cache/documents/displayvideo.v3.json +5 -3
- googleapiclient/discovery_cache/documents/displayvideo.v4.json +5 -3
- googleapiclient/discovery_cache/documents/dns.v1.json +11 -11
- googleapiclient/discovery_cache/documents/dns.v1beta2.json +11 -11
- googleapiclient/discovery_cache/documents/documentai.v1.json +2 -2
- googleapiclient/discovery_cache/documents/documentai.v1beta3.json +2 -2
- googleapiclient/discovery_cache/documents/drive.v2.json +3 -3
- googleapiclient/discovery_cache/documents/drive.v3.json +84 -82
- googleapiclient/discovery_cache/documents/eventarc.v1.json +5 -5
- googleapiclient/discovery_cache/documents/file.v1.json +24 -3
- googleapiclient/discovery_cache/documents/firebaseappcheck.v1.json +81 -1
- googleapiclient/discovery_cache/documents/firebaseappcheck.v1beta.json +86 -1
- googleapiclient/discovery_cache/documents/firebaseappdistribution.v1alpha.json +18 -6
- googleapiclient/discovery_cache/documents/firebaseapphosting.v1.json +60 -3
- googleapiclient/discovery_cache/documents/firebaseapphosting.v1beta.json +3 -3
- googleapiclient/discovery_cache/documents/firebasedataconnect.v1.json +109 -2
- googleapiclient/discovery_cache/documents/firebasedataconnect.v1beta.json +109 -2
- googleapiclient/discovery_cache/documents/firebaseml.v2beta.json +65 -66
- googleapiclient/discovery_cache/documents/firestore.v1.json +13 -8
- googleapiclient/discovery_cache/documents/firestore.v1beta1.json +6 -1
- googleapiclient/discovery_cache/documents/firestore.v1beta2.json +6 -1
- googleapiclient/discovery_cache/documents/gkehub.v1.json +9 -7
- googleapiclient/discovery_cache/documents/gkehub.v1alpha.json +9 -7
- googleapiclient/discovery_cache/documents/gkehub.v1beta.json +9 -7
- googleapiclient/discovery_cache/documents/gkehub.v1beta1.json +7 -3
- googleapiclient/discovery_cache/documents/gkehub.v2.json +4 -6
- googleapiclient/discovery_cache/documents/gkehub.v2alpha.json +4 -6
- googleapiclient/discovery_cache/documents/gkehub.v2beta.json +4 -6
- googleapiclient/discovery_cache/documents/gkeonprem.v1.json +21 -2
- googleapiclient/discovery_cache/documents/groupsmigration.v1.json +1 -1
- googleapiclient/discovery_cache/documents/healthcare.v1.json +4 -4
- googleapiclient/discovery_cache/documents/healthcare.v1beta1.json +202 -5
- googleapiclient/discovery_cache/documents/iam.v1.json +2 -2
- googleapiclient/discovery_cache/documents/logging.v2.json +166 -16
- googleapiclient/discovery_cache/documents/managedkafka.v1.json +16 -1
- googleapiclient/discovery_cache/documents/merchantapi.accounts_v1.json +30 -4
- googleapiclient/discovery_cache/documents/merchantapi.accounts_v1beta.json +28 -2
- googleapiclient/discovery_cache/documents/merchantapi.issueresolution_v1beta.json +5 -3
- googleapiclient/discovery_cache/documents/migrationcenter.v1.json +2 -2
- googleapiclient/discovery_cache/documents/migrationcenter.v1alpha1.json +302 -2
- googleapiclient/discovery_cache/documents/ml.v1.json +2 -2
- googleapiclient/discovery_cache/documents/netapp.v1.json +41 -2
- googleapiclient/discovery_cache/documents/netapp.v1beta1.json +42 -3
- googleapiclient/discovery_cache/documents/networkmanagement.v1.json +521 -8
- googleapiclient/discovery_cache/documents/networkmanagement.v1beta1.json +270 -8
- googleapiclient/discovery_cache/documents/networksecurity.v1beta1.json +60 -3
- googleapiclient/discovery_cache/documents/observability.v1.json +2 -2
- googleapiclient/discovery_cache/documents/oracledatabase.v1.json +1756 -179
- googleapiclient/discovery_cache/documents/privateca.v1.json +17 -33
- googleapiclient/discovery_cache/documents/privateca.v1beta1.json +2 -33
- googleapiclient/discovery_cache/documents/recommender.v1beta1.json +5 -5
- googleapiclient/discovery_cache/documents/redis.v1.json +88 -8
- googleapiclient/discovery_cache/documents/redis.v1beta1.json +88 -8
- googleapiclient/discovery_cache/documents/retail.v2alpha.json +4 -4
- googleapiclient/discovery_cache/documents/run.v1.json +18 -3
- googleapiclient/discovery_cache/documents/run.v2.json +18 -3
- googleapiclient/discovery_cache/documents/saasservicemgmt.v1beta1.json +3 -3
- googleapiclient/discovery_cache/documents/secretmanager.v1.json +2 -2
- googleapiclient/discovery_cache/documents/secretmanager.v1beta1.json +2 -2
- googleapiclient/discovery_cache/documents/secretmanager.v1beta2.json +2 -2
- googleapiclient/discovery_cache/documents/securitycenter.v1.json +17 -2
- googleapiclient/discovery_cache/documents/securitycenter.v1beta1.json +17 -2
- googleapiclient/discovery_cache/documents/securitycenter.v1beta2.json +17 -2
- googleapiclient/discovery_cache/documents/servicecontrol.v1.json +44 -2
- googleapiclient/discovery_cache/documents/servicecontrol.v2.json +40 -2
- googleapiclient/discovery_cache/documents/sts.v1.json +3 -3
- googleapiclient/discovery_cache/documents/texttospeech.v1.json +5 -1
- googleapiclient/discovery_cache/documents/texttospeech.v1beta1.json +5 -1
- googleapiclient/discovery_cache/documents/tpu.v1.json +2 -2
- googleapiclient/discovery_cache/documents/tpu.v1alpha1.json +2 -2
- googleapiclient/discovery_cache/documents/tpu.v2.json +28 -2
- googleapiclient/discovery_cache/documents/tpu.v2alpha1.json +6 -2
- googleapiclient/discovery_cache/documents/trafficdirector.v2.json +2 -2
- googleapiclient/discovery_cache/documents/trafficdirector.v3.json +3 -3
- googleapiclient/discovery_cache/documents/vmmigration.v1.json +39 -3
- googleapiclient/discovery_cache/documents/vmmigration.v1alpha1.json +39 -3
- googleapiclient/discovery_cache/documents/walletobjects.v1.json +6 -1
- googleapiclient/discovery_cache/documents/workloadmanager.v1.json +4 -4
- googleapiclient/version.py +1 -1
- {google_api_python_client-2.181.0.dist-info → google_api_python_client-2.182.0.dist-info}/WHEEL +0 -0
- {google_api_python_client-2.181.0.dist-info → google_api_python_client-2.182.0.dist-info}/licenses/LICENSE +0 -0
- {google_api_python_client-2.181.0.dist-info → google_api_python_client-2.182.0.dist-info}/top_level.txt +0 -0
|
@@ -1047,7 +1047,7 @@
|
|
|
1047
1047
|
"files": {
|
|
1048
1048
|
"methods": {
|
|
1049
1049
|
"copy": {
|
|
1050
|
-
"description": "Creates a copy of a file and applies any requested updates with patch semantics.",
|
|
1050
|
+
"description": "Creates a copy of a file and applies any requested updates with patch semantics. For more information, see [Create and manage files](https://developers.google.com/workspace/drive/api/guides/create-file).",
|
|
1051
1051
|
"flatPath": "files/{fileId}/copy",
|
|
1052
1052
|
"httpMethod": "POST",
|
|
1053
1053
|
"id": "drive.files.copy",
|
|
@@ -1057,7 +1057,8 @@
|
|
|
1057
1057
|
"parameters": {
|
|
1058
1058
|
"enforceSingleParent": {
|
|
1059
1059
|
"default": "false",
|
|
1060
|
-
"
|
|
1060
|
+
"deprecated": true,
|
|
1061
|
+
"description": "Deprecated: Copying files into multiple folders is no longer supported. Use shortcuts instead.",
|
|
1061
1062
|
"location": "query",
|
|
1062
1063
|
"type": "boolean"
|
|
1063
1064
|
},
|
|
@@ -1079,13 +1080,13 @@
|
|
|
1079
1080
|
"type": "string"
|
|
1080
1081
|
},
|
|
1081
1082
|
"includePermissionsForView": {
|
|
1082
|
-
"description": "Specifies which additional view's permissions to include in the response. Only
|
|
1083
|
+
"description": "Specifies which additional view's permissions to include in the response. Only `published` is supported.",
|
|
1083
1084
|
"location": "query",
|
|
1084
1085
|
"type": "string"
|
|
1085
1086
|
},
|
|
1086
1087
|
"keepRevisionForever": {
|
|
1087
1088
|
"default": "false",
|
|
1088
|
-
"description": "Whether to set the
|
|
1089
|
+
"description": "Whether to set the `keepForever` field in the new head revision. This is only applicable to files with binary content in Google Drive. Only 200 revisions for the file can be kept forever. If the limit is reached, try deleting pinned revisions.",
|
|
1089
1090
|
"location": "query",
|
|
1090
1091
|
"type": "boolean"
|
|
1091
1092
|
},
|
|
@@ -1123,7 +1124,7 @@
|
|
|
1123
1124
|
]
|
|
1124
1125
|
},
|
|
1125
1126
|
"create": {
|
|
1126
|
-
"description": " Creates a
|
|
1127
|
+
"description": " Creates a file. For more information, see [Create and manage files](/workspace/drive/api/guides/create-file). This method supports an */upload* URI and accepts uploaded media with the following characteristics: - *Maximum file size:* 5,120 GB - *Accepted Media MIME types:* `*/*` (Specify a valid MIME type, rather than the literal `*/*` value. The literal `*/*` is only used to indicate that any valid MIME type can be uploaded. For more information, see [Google Workspace and Google Drive supported MIME types](/workspace/drive/api/guides/mime-types).) For more information on uploading files, see [Upload file data](/workspace/drive/api/guides/manage-uploads). Apps creating shortcuts with the `create` method must specify the MIME type `application/vnd.google-apps.shortcut`. Apps should specify a file extension in the `name` property when inserting files with the API. For example, an operation to insert a JPEG file should specify something like `\"name\": \"cat.jpg\"` in the metadata. Subsequent `GET` requests include the read-only `fileExtension` property populated with the extension originally specified in the `name` property. When a Google Drive user requests to download a file, or when the file is downloaded through the sync client, Drive builds a full filename (with extension) based on the name. In cases where the extension is missing, Drive attempts to determine the extension based on the file's MIME type.",
|
|
1127
1128
|
"flatPath": "files",
|
|
1128
1129
|
"httpMethod": "POST",
|
|
1129
1130
|
"id": "drive.files.create",
|
|
@@ -1147,7 +1148,8 @@
|
|
|
1147
1148
|
"parameters": {
|
|
1148
1149
|
"enforceSingleParent": {
|
|
1149
1150
|
"default": "false",
|
|
1150
|
-
"
|
|
1151
|
+
"deprecated": true,
|
|
1152
|
+
"description": "Deprecated: Creating files in multiple folders is no longer supported.",
|
|
1151
1153
|
"location": "query",
|
|
1152
1154
|
"type": "boolean"
|
|
1153
1155
|
},
|
|
@@ -1163,13 +1165,13 @@
|
|
|
1163
1165
|
"type": "string"
|
|
1164
1166
|
},
|
|
1165
1167
|
"includePermissionsForView": {
|
|
1166
|
-
"description": "Specifies which additional view's permissions to include in the response. Only
|
|
1168
|
+
"description": "Specifies which additional view's permissions to include in the response. Only `published` is supported.",
|
|
1167
1169
|
"location": "query",
|
|
1168
1170
|
"type": "string"
|
|
1169
1171
|
},
|
|
1170
1172
|
"keepRevisionForever": {
|
|
1171
1173
|
"default": "false",
|
|
1172
|
-
"description": "Whether to set the
|
|
1174
|
+
"description": "Whether to set the `keepForever` field in the new head revision. This is only applicable to files with binary content in Google Drive. Only 200 revisions for the file can be kept forever. If the limit is reached, try deleting pinned revisions.",
|
|
1173
1175
|
"location": "query",
|
|
1174
1176
|
"type": "boolean"
|
|
1175
1177
|
},
|
|
@@ -1213,7 +1215,7 @@
|
|
|
1213
1215
|
"supportsMediaUpload": true
|
|
1214
1216
|
},
|
|
1215
1217
|
"delete": {
|
|
1216
|
-
"description": "Permanently deletes a file owned by the user without moving it to the trash. If the file belongs to a shared drive, the user must be an `organizer` on the parent folder. If the target is a folder, all descendants owned by the user are also deleted.",
|
|
1218
|
+
"description": "Permanently deletes a file owned by the user without moving it to the trash. For more information, see [Trash or delete files and folders](https://developers.google.com/workspace/drive/api/guides/delete). If the file belongs to a shared drive, the user must be an `organizer` on the parent folder. If the target is a folder, all descendants owned by the user are also deleted.",
|
|
1217
1219
|
"flatPath": "files/{fileId}",
|
|
1218
1220
|
"httpMethod": "DELETE",
|
|
1219
1221
|
"id": "drive.files.delete",
|
|
@@ -1224,7 +1226,7 @@
|
|
|
1224
1226
|
"enforceSingleParent": {
|
|
1225
1227
|
"default": "false",
|
|
1226
1228
|
"deprecated": true,
|
|
1227
|
-
"description": "Deprecated: If an item
|
|
1229
|
+
"description": "Deprecated: If an item isn't in a shared drive and its last parent is deleted but the item itself isn't, the item will be placed under its owner's root.",
|
|
1228
1230
|
"location": "query",
|
|
1229
1231
|
"type": "boolean"
|
|
1230
1232
|
},
|
|
@@ -1256,7 +1258,7 @@
|
|
|
1256
1258
|
]
|
|
1257
1259
|
},
|
|
1258
1260
|
"download": {
|
|
1259
|
-
"description": "Downloads content of a file. Operations are valid for 24 hours from the time of creation.",
|
|
1261
|
+
"description": "Downloads the content of a file. For more information, see [Download and export files](https://developers.google.com/workspace/drive/api/guides/manage-downloads). Operations are valid for 24 hours from the time of creation.",
|
|
1260
1262
|
"flatPath": "files/{fileId}/download",
|
|
1261
1263
|
"httpMethod": "POST",
|
|
1262
1264
|
"id": "drive.files.download",
|
|
@@ -1271,7 +1273,7 @@
|
|
|
1271
1273
|
"type": "string"
|
|
1272
1274
|
},
|
|
1273
1275
|
"mimeType": {
|
|
1274
|
-
"description": "Optional. The MIME type the file should be downloaded as. This field can only be set when downloading Google Workspace documents.
|
|
1276
|
+
"description": "Optional. The MIME type the file should be downloaded as. This field can only be set when downloading Google Workspace documents. For a list of supported MIME types, see [Export MIME types for Google Workspace documents](/workspace/drive/api/guides/ref-export-formats). If not set, a Google Workspace document is downloaded with a default MIME type. The default MIME type might change in the future.",
|
|
1275
1277
|
"location": "query",
|
|
1276
1278
|
"type": "string"
|
|
1277
1279
|
},
|
|
@@ -1292,7 +1294,7 @@
|
|
|
1292
1294
|
]
|
|
1293
1295
|
},
|
|
1294
1296
|
"emptyTrash": {
|
|
1295
|
-
"description": "Permanently deletes all of the user's trashed files.",
|
|
1297
|
+
"description": "Permanently deletes all of the user's trashed files. For more information, see [Trash or delete files and folders](https://developers.google.com/workspace/drive/api/guides/delete).",
|
|
1296
1298
|
"flatPath": "files/trash",
|
|
1297
1299
|
"httpMethod": "DELETE",
|
|
1298
1300
|
"id": "drive.files.emptyTrash",
|
|
@@ -1306,7 +1308,7 @@
|
|
|
1306
1308
|
"enforceSingleParent": {
|
|
1307
1309
|
"default": "false",
|
|
1308
1310
|
"deprecated": true,
|
|
1309
|
-
"description": "Deprecated: If an item
|
|
1311
|
+
"description": "Deprecated: If an item isn't in a shared drive and its last parent is deleted but the item itself isn't, the item will be placed under its owner's root.",
|
|
1310
1312
|
"location": "query",
|
|
1311
1313
|
"type": "boolean"
|
|
1312
1314
|
}
|
|
@@ -1317,7 +1319,7 @@
|
|
|
1317
1319
|
]
|
|
1318
1320
|
},
|
|
1319
1321
|
"export": {
|
|
1320
|
-
"description": "Exports a Google Workspace document to the requested MIME type and returns exported byte content. Note that the exported content is limited to
|
|
1322
|
+
"description": "Exports a Google Workspace document to the requested MIME type and returns exported byte content. For more information, see [Download and export files](https://developers.google.com/workspace/drive/api/guides/manage-downloads). Note that the exported content is limited to 10 MB.",
|
|
1321
1323
|
"flatPath": "files/{fileId}/export",
|
|
1322
1324
|
"httpMethod": "GET",
|
|
1323
1325
|
"id": "drive.files.export",
|
|
@@ -1333,7 +1335,7 @@
|
|
|
1333
1335
|
"type": "string"
|
|
1334
1336
|
},
|
|
1335
1337
|
"mimeType": {
|
|
1336
|
-
"description": "Required. The MIME type of the format requested for this export.",
|
|
1338
|
+
"description": "Required. The MIME type of the format requested for this export. For a list of supported MIME types, see [Export MIME types for Google Workspace documents](/workspace/drive/api/guides/ref-export-formats).",
|
|
1337
1339
|
"location": "query",
|
|
1338
1340
|
"required": true,
|
|
1339
1341
|
"type": "string"
|
|
@@ -1350,7 +1352,7 @@
|
|
|
1350
1352
|
"useMediaDownloadService": true
|
|
1351
1353
|
},
|
|
1352
1354
|
"generateIds": {
|
|
1353
|
-
"description": "Generates a set of file IDs which can be provided in create or copy requests.",
|
|
1355
|
+
"description": "Generates a set of file IDs which can be provided in create or copy requests. For more information, see [Create and manage files](https://developers.google.com/workspace/drive/api/guides/create-file).",
|
|
1354
1356
|
"flatPath": "files/generateIds",
|
|
1355
1357
|
"httpMethod": "GET",
|
|
1356
1358
|
"id": "drive.files.generateIds",
|
|
@@ -1367,13 +1369,13 @@
|
|
|
1367
1369
|
},
|
|
1368
1370
|
"space": {
|
|
1369
1371
|
"default": "drive",
|
|
1370
|
-
"description": "The space in which the IDs can be used to create
|
|
1372
|
+
"description": "The space in which the IDs can be used to create files. Supported values are `drive` and `appDataFolder`. (Default: `drive`.) For more information, see [File organization](https://developers.google.com/workspace/drive/api/guides/about-files#file-organization).",
|
|
1371
1373
|
"location": "query",
|
|
1372
1374
|
"type": "string"
|
|
1373
1375
|
},
|
|
1374
1376
|
"type": {
|
|
1375
1377
|
"default": "files",
|
|
1376
|
-
"description": "The type of items which the IDs can be used for. Supported values are
|
|
1378
|
+
"description": "The type of items which the IDs can be used for. Supported values are `files` and `shortcuts`. Note that `shortcuts` are only supported in the `drive` `space`. (Default: `files`.) For more information, see [File organization](https://developers.google.com/workspace/drive/api/guides/about-files#file-organization).",
|
|
1377
1379
|
"location": "query",
|
|
1378
1380
|
"type": "string"
|
|
1379
1381
|
}
|
|
@@ -1389,7 +1391,7 @@
|
|
|
1389
1391
|
]
|
|
1390
1392
|
},
|
|
1391
1393
|
"get": {
|
|
1392
|
-
"description": " Gets a file's metadata or content by ID. If you provide the URL parameter `alt=media`, then the response includes the file contents in the response body. Downloading content with `alt=media` only works if the file is stored in Drive. To download Google Docs, Sheets, and Slides use [`files.export`](/workspace/drive/api/reference/rest/v3/files/export) instead. For more information, see [Download
|
|
1394
|
+
"description": " Gets a file's metadata or content by ID. For more information, see [Search for files and folders](/workspace/drive/api/guides/search-files). If you provide the URL parameter `alt=media`, then the response includes the file contents in the response body. Downloading content with `alt=media` only works if the file is stored in Drive. To download Google Docs, Sheets, and Slides use [`files.export`](/workspace/drive/api/reference/rest/v3/files/export) instead. For more information, see [Download and export files](/workspace/drive/api/guides/manage-downloads).",
|
|
1393
1395
|
"flatPath": "files/{fileId}",
|
|
1394
1396
|
"httpMethod": "GET",
|
|
1395
1397
|
"id": "drive.files.get",
|
|
@@ -1415,7 +1417,7 @@
|
|
|
1415
1417
|
"type": "string"
|
|
1416
1418
|
},
|
|
1417
1419
|
"includePermissionsForView": {
|
|
1418
|
-
"description": "Specifies which additional view's permissions to include in the response. Only
|
|
1420
|
+
"description": "Specifies which additional view's permissions to include in the response. Only `published` is supported.",
|
|
1419
1421
|
"location": "query",
|
|
1420
1422
|
"type": "string"
|
|
1421
1423
|
},
|
|
@@ -1452,20 +1454,20 @@
|
|
|
1452
1454
|
"useMediaDownloadService": true
|
|
1453
1455
|
},
|
|
1454
1456
|
"list": {
|
|
1455
|
-
"description": " Lists the user's files. This method accepts the `q` parameter, which is a search query combining one or more search terms.
|
|
1457
|
+
"description": " Lists the user's files. For more information, see [Search for files and folders](/workspace/drive/api/guides/search-files). This method accepts the `q` parameter, which is a search query combining one or more search terms. This method returns *all* files by default, including trashed files. If you don't want trashed files to appear in the list, use the `trashed=false` query parameter to remove trashed files from the results.",
|
|
1456
1458
|
"flatPath": "files",
|
|
1457
1459
|
"httpMethod": "GET",
|
|
1458
1460
|
"id": "drive.files.list",
|
|
1459
1461
|
"parameterOrder": [],
|
|
1460
1462
|
"parameters": {
|
|
1461
1463
|
"corpora": {
|
|
1462
|
-
"description": "Bodies of items (files
|
|
1464
|
+
"description": "Bodies of items (files or documents) to which the query applies. Supported bodies are: * `user` * `domain` * `drive` * `allDrives` Prefer `user` or `drive` to `allDrives` for efficiency. By default, corpora is set to `user`. However, this can change depending on the filter set through the `q` parameter. For more information, see [File organization](https://developers.google.com/workspace/drive/api/guides/about-files#file-organization).",
|
|
1463
1465
|
"location": "query",
|
|
1464
1466
|
"type": "string"
|
|
1465
1467
|
},
|
|
1466
1468
|
"corpus": {
|
|
1467
1469
|
"deprecated": true,
|
|
1468
|
-
"description": "Deprecated: The source of files to list. Use
|
|
1470
|
+
"description": "Deprecated: The source of files to list. Use `corpora` instead.",
|
|
1469
1471
|
"enum": [
|
|
1470
1472
|
"domain",
|
|
1471
1473
|
"user"
|
|
@@ -1494,7 +1496,7 @@
|
|
|
1494
1496
|
"type": "string"
|
|
1495
1497
|
},
|
|
1496
1498
|
"includePermissionsForView": {
|
|
1497
|
-
"description": "Specifies which additional view's permissions to include in the response. Only
|
|
1499
|
+
"description": "Specifies which additional view's permissions to include in the response. Only `published` is supported.",
|
|
1498
1500
|
"location": "query",
|
|
1499
1501
|
"type": "string"
|
|
1500
1502
|
},
|
|
@@ -1506,7 +1508,7 @@
|
|
|
1506
1508
|
"type": "boolean"
|
|
1507
1509
|
},
|
|
1508
1510
|
"orderBy": {
|
|
1509
|
-
"description": "A comma-separated list of sort keys. Valid keys are: * `createdTime`: When the file was created. * `folder`: The folder ID. This field is sorted using alphabetical ordering. * `modifiedByMeTime`: The last time the file was modified by the user. * `modifiedTime`: The last time the file was modified by anyone. * `name`: The name of the file. This field is sorted using alphabetical ordering, so 1, 12, 2, 22. * `name_natural`: The name of the file. This field is sorted using natural sort ordering, so 1, 2, 12, 22. * `quotaBytesUsed`: The number of storage quota bytes used by the file. * `recency`: The most recent timestamp from the file's date-time fields. * `sharedWithMeTime`: When the file was shared with the user, if applicable. * `starred`: Whether the user has starred the file. * `viewedByMeTime`: The last time the file was viewed by the user. Each key sorts ascending by default, but can be reversed with the
|
|
1511
|
+
"description": "A comma-separated list of sort keys. Valid keys are: * `createdTime`: When the file was created. * `folder`: The folder ID. This field is sorted using alphabetical ordering. * `modifiedByMeTime`: The last time the file was modified by the user. * `modifiedTime`: The last time the file was modified by anyone. * `name`: The name of the file. This field is sorted using alphabetical ordering, so 1, 12, 2, 22. * `name_natural`: The name of the file. This field is sorted using natural sort ordering, so 1, 2, 12, 22. * `quotaBytesUsed`: The number of storage quota bytes used by the file. * `recency`: The most recent timestamp from the file's date-time fields. * `sharedWithMeTime`: When the file was shared with the user, if applicable. * `starred`: Whether the user has starred the file. * `viewedByMeTime`: The last time the file was viewed by the user. Each key sorts ascending by default, but can be reversed with the `desc` modifier. Example usage: `?orderBy=folder,modifiedTime desc,name`.",
|
|
1510
1512
|
"location": "query",
|
|
1511
1513
|
"type": "string"
|
|
1512
1514
|
},
|
|
@@ -1520,18 +1522,18 @@
|
|
|
1520
1522
|
"type": "integer"
|
|
1521
1523
|
},
|
|
1522
1524
|
"pageToken": {
|
|
1523
|
-
"description": "The token for continuing a previous list request on the next page. This should be set to the value of
|
|
1525
|
+
"description": "The token for continuing a previous list request on the next page. This should be set to the value of `nextPageToken` from the previous response.",
|
|
1524
1526
|
"location": "query",
|
|
1525
1527
|
"type": "string"
|
|
1526
1528
|
},
|
|
1527
1529
|
"q": {
|
|
1528
|
-
"description": "A query for filtering the file results.
|
|
1530
|
+
"description": "A query for filtering the file results. For supported syntax, see [Search for files and folders](/workspace/drive/api/guides/search-files).",
|
|
1529
1531
|
"location": "query",
|
|
1530
1532
|
"type": "string"
|
|
1531
1533
|
},
|
|
1532
1534
|
"spaces": {
|
|
1533
1535
|
"default": "drive",
|
|
1534
|
-
"description": "A comma-separated list of spaces to query within the corpora. Supported values are
|
|
1536
|
+
"description": "A comma-separated list of spaces to query within the corpora. Supported values are `drive` and `appDataFolder`. For more information, see [File organization](https://developers.google.com/workspace/drive/api/guides/about-files#file-organization).",
|
|
1535
1537
|
"location": "query",
|
|
1536
1538
|
"type": "string"
|
|
1537
1539
|
},
|
|
@@ -1571,7 +1573,7 @@
|
|
|
1571
1573
|
]
|
|
1572
1574
|
},
|
|
1573
1575
|
"listLabels": {
|
|
1574
|
-
"description": "Lists the labels on a file.",
|
|
1576
|
+
"description": "Lists the labels on a file. For more information, see [List labels on a file](https://developers.google.com/workspace/drive/api/guides/list-labels).",
|
|
1575
1577
|
"flatPath": "files/{fileId}/listLabels",
|
|
1576
1578
|
"httpMethod": "GET",
|
|
1577
1579
|
"id": "drive.files.listLabels",
|
|
@@ -1595,7 +1597,7 @@
|
|
|
1595
1597
|
"type": "integer"
|
|
1596
1598
|
},
|
|
1597
1599
|
"pageToken": {
|
|
1598
|
-
"description": "The token for continuing a previous list request on the next page. This should be set to the value of
|
|
1600
|
+
"description": "The token for continuing a previous list request on the next page. This should be set to the value of `nextPageToken` from the previous response.",
|
|
1599
1601
|
"location": "query",
|
|
1600
1602
|
"type": "string"
|
|
1601
1603
|
}
|
|
@@ -1614,7 +1616,7 @@
|
|
|
1614
1616
|
]
|
|
1615
1617
|
},
|
|
1616
1618
|
"modifyLabels": {
|
|
1617
|
-
"description": "Modifies the set of labels applied to a file. Returns a list of the labels that were added or modified.",
|
|
1619
|
+
"description": "Modifies the set of labels applied to a file. For more information, see [Set a label field on a file](https://developers.google.com/workspace/drive/api/guides/set-label). Returns a list of the labels that were added or modified.",
|
|
1618
1620
|
"flatPath": "files/{fileId}/modifyLabels",
|
|
1619
1621
|
"httpMethod": "POST",
|
|
1620
1622
|
"id": "drive.files.modifyLabels",
|
|
@@ -1643,7 +1645,7 @@
|
|
|
1643
1645
|
]
|
|
1644
1646
|
},
|
|
1645
1647
|
"update": {
|
|
1646
|
-
"description": " Updates a file's metadata
|
|
1648
|
+
"description": " Updates a file's metadata, content, or both. When calling this method, only populate fields in the request that you want to modify. When updating fields, some fields might be changed automatically, such as `modifiedDate`. This method supports patch semantics. This method supports an */upload* URI and accepts uploaded media with the following characteristics: - *Maximum file size:* 5,120 GB - *Accepted Media MIME types:* `*/*` (Specify a valid MIME type, rather than the literal `*/*` value. The literal `*/*` is only used to indicate that any valid MIME type can be uploaded. For more information, see [Google Workspace and Google Drive supported MIME types](/workspace/drive/api/guides/mime-types).) For more information on uploading files, see [Upload file data](/workspace/drive/api/guides/manage-uploads).",
|
|
1647
1649
|
"flatPath": "files/{fileId}",
|
|
1648
1650
|
"httpMethod": "PATCH",
|
|
1649
1651
|
"id": "drive.files.update",
|
|
@@ -1691,13 +1693,13 @@
|
|
|
1691
1693
|
"type": "string"
|
|
1692
1694
|
},
|
|
1693
1695
|
"includePermissionsForView": {
|
|
1694
|
-
"description": "Specifies which additional view's permissions to include in the response. Only
|
|
1696
|
+
"description": "Specifies which additional view's permissions to include in the response. Only `published` is supported.",
|
|
1695
1697
|
"location": "query",
|
|
1696
1698
|
"type": "string"
|
|
1697
1699
|
},
|
|
1698
1700
|
"keepRevisionForever": {
|
|
1699
1701
|
"default": "false",
|
|
1700
|
-
"description": "Whether to set the
|
|
1702
|
+
"description": "Whether to set the `keepForever` field in the new head revision. This is only applicable to files with binary content in Google Drive. Only 200 revisions for the file can be kept forever. If the limit is reached, try deleting pinned revisions.",
|
|
1701
1703
|
"location": "query",
|
|
1702
1704
|
"type": "boolean"
|
|
1703
1705
|
},
|
|
@@ -1748,7 +1750,7 @@
|
|
|
1748
1750
|
"supportsMediaUpload": true
|
|
1749
1751
|
},
|
|
1750
1752
|
"watch": {
|
|
1751
|
-
"description": "Subscribes to changes to a file.",
|
|
1753
|
+
"description": "Subscribes to changes to a file. For more information, see [Notifications for resource changes](https://developers.google.com/workspace/drive/api/guides/push).",
|
|
1752
1754
|
"flatPath": "files/{fileId}/watch",
|
|
1753
1755
|
"httpMethod": "POST",
|
|
1754
1756
|
"id": "drive.files.watch",
|
|
@@ -1774,7 +1776,7 @@
|
|
|
1774
1776
|
"type": "string"
|
|
1775
1777
|
},
|
|
1776
1778
|
"includePermissionsForView": {
|
|
1777
|
-
"description": "Specifies which additional view's permissions to include in the response. Only
|
|
1779
|
+
"description": "Specifies which additional view's permissions to include in the response. Only `published` is supported.",
|
|
1778
1780
|
"location": "query",
|
|
1779
1781
|
"type": "string"
|
|
1780
1782
|
},
|
|
@@ -1887,7 +1889,7 @@
|
|
|
1887
1889
|
"type": "boolean"
|
|
1888
1890
|
},
|
|
1889
1891
|
"sendNotificationEmail": {
|
|
1890
|
-
"description": "Whether to send a notification email when sharing to users or groups. This defaults to true for users and groups, and is not allowed for other requests. It must not be disabled for ownership transfers.",
|
|
1892
|
+
"description": "Whether to send a notification email when sharing to users or groups. This defaults to `true` for users and groups, and is not allowed for other requests. It must not be disabled for ownership transfers.",
|
|
1891
1893
|
"location": "query",
|
|
1892
1894
|
"type": "boolean"
|
|
1893
1895
|
},
|
|
@@ -2718,7 +2720,7 @@
|
|
|
2718
2720
|
}
|
|
2719
2721
|
}
|
|
2720
2722
|
},
|
|
2721
|
-
"revision": "
|
|
2723
|
+
"revision": "20250829",
|
|
2722
2724
|
"rootUrl": "https://www.googleapis.com/",
|
|
2723
2725
|
"schemas": {
|
|
2724
2726
|
"About": {
|
|
@@ -3337,7 +3339,7 @@
|
|
|
3337
3339
|
},
|
|
3338
3340
|
"restrictingUser": {
|
|
3339
3341
|
"$ref": "User",
|
|
3340
|
-
"description": "Output only. The user who set the content restriction. Only populated if `readOnly
|
|
3342
|
+
"description": "Output only. The user who set the content restriction. Only populated if `readOnly=true`."
|
|
3341
3343
|
},
|
|
3342
3344
|
"restrictionTime": {
|
|
3343
3345
|
"description": "The time at which the content restriction was set (formatted RFC 3339 timestamp). Only populated if readOnly is true.",
|
|
@@ -3364,7 +3366,7 @@
|
|
|
3364
3366
|
"type": "boolean"
|
|
3365
3367
|
},
|
|
3366
3368
|
"restrictedForWriters": {
|
|
3367
|
-
"description": "Whether download and copy is restricted for writers. If true
|
|
3369
|
+
"description": "Whether download and copy is restricted for writers. If `true`, download is also restricted for readers.",
|
|
3368
3370
|
"type": "boolean"
|
|
3369
3371
|
}
|
|
3370
3372
|
},
|
|
@@ -3380,7 +3382,7 @@
|
|
|
3380
3382
|
},
|
|
3381
3383
|
"itemDownloadRestriction": {
|
|
3382
3384
|
"$ref": "DownloadRestriction",
|
|
3383
|
-
"description": "The download restriction of the file applied directly by the owner or organizer. This
|
|
3385
|
+
"description": "The download restriction of the file applied directly by the owner or organizer. This doesn't take into account shared drive settings or DLP rules."
|
|
3384
3386
|
}
|
|
3385
3387
|
},
|
|
3386
3388
|
"type": "object"
|
|
@@ -3610,18 +3612,18 @@
|
|
|
3610
3612
|
"type": "object"
|
|
3611
3613
|
},
|
|
3612
3614
|
"capabilities": {
|
|
3613
|
-
"description": "Output only. Capabilities the current user has on this file. Each capability corresponds to a fine-grained action that a user may take.",
|
|
3615
|
+
"description": "Output only. Capabilities the current user has on this file. Each capability corresponds to a fine-grained action that a user may take. For more information, see [Understand file capabilities](https://developers.google.com/workspace/drive/api/guides/manage-sharing#capabilities).",
|
|
3614
3616
|
"properties": {
|
|
3615
3617
|
"canAcceptOwnership": {
|
|
3616
3618
|
"description": "Output only. Whether the current user is the pending owner of the file. Not populated for shared drive files.",
|
|
3617
3619
|
"type": "boolean"
|
|
3618
3620
|
},
|
|
3619
3621
|
"canAddChildren": {
|
|
3620
|
-
"description": "Output only. Whether the current user can add children to this folder. This is always false when the item
|
|
3622
|
+
"description": "Output only. Whether the current user can add children to this folder. This is always `false` when the item isn't a folder.",
|
|
3621
3623
|
"type": "boolean"
|
|
3622
3624
|
},
|
|
3623
3625
|
"canAddFolderFromAnotherDrive": {
|
|
3624
|
-
"description": "Output only. Whether the current user can add a folder from another drive (different shared drive or My Drive) to this folder. This is false when the item
|
|
3626
|
+
"description": "Output only. Whether the current user can add a folder from another drive (different shared drive or My Drive) to this folder. This is `false` when the item isn't a folder. Only populated for items in shared drives.",
|
|
3625
3627
|
"type": "boolean"
|
|
3626
3628
|
},
|
|
3627
3629
|
"canAddMyDriveParent": {
|
|
@@ -3637,7 +3639,7 @@
|
|
|
3637
3639
|
"type": "boolean"
|
|
3638
3640
|
},
|
|
3639
3641
|
"canChangeSecurityUpdateEnabled": {
|
|
3640
|
-
"description": "Output only. Whether the current user can change the securityUpdateEnabled field on link share metadata.",
|
|
3642
|
+
"description": "Output only. Whether the current user can change the `securityUpdateEnabled` field on link share metadata.",
|
|
3641
3643
|
"type": "boolean"
|
|
3642
3644
|
},
|
|
3643
3645
|
"canChangeViewersCanCopyContent": {
|
|
@@ -3650,7 +3652,7 @@
|
|
|
3650
3652
|
"type": "boolean"
|
|
3651
3653
|
},
|
|
3652
3654
|
"canCopy": {
|
|
3653
|
-
"description": "Output only. Whether the current user can copy this file. For an item in a shared drive, whether the current user can copy non-folder descendants of this item, or this item
|
|
3655
|
+
"description": "Output only. Whether the current user can copy this file. For an item in a shared drive, whether the current user can copy non-folder descendants of this item, or this item if it's not a folder.",
|
|
3654
3656
|
"type": "boolean"
|
|
3655
3657
|
},
|
|
3656
3658
|
"canDelete": {
|
|
@@ -3658,7 +3660,7 @@
|
|
|
3658
3660
|
"type": "boolean"
|
|
3659
3661
|
},
|
|
3660
3662
|
"canDeleteChildren": {
|
|
3661
|
-
"description": "Output only. Whether the current user can delete children of this folder. This is false when the item
|
|
3663
|
+
"description": "Output only. Whether the current user can delete children of this folder. This is `false` when the item isn't a folder. Only populated for items in shared drives.",
|
|
3662
3664
|
"type": "boolean"
|
|
3663
3665
|
},
|
|
3664
3666
|
"canDisableInheritedPermissions": {
|
|
@@ -3678,7 +3680,7 @@
|
|
|
3678
3680
|
"type": "boolean"
|
|
3679
3681
|
},
|
|
3680
3682
|
"canListChildren": {
|
|
3681
|
-
"description": "Output only. Whether the current user can list the children of this folder. This is always false when the item
|
|
3683
|
+
"description": "Output only. Whether the current user can list the children of this folder. This is always `false` when the item isn't a folder.",
|
|
3682
3684
|
"type": "boolean"
|
|
3683
3685
|
},
|
|
3684
3686
|
"canModifyContent": {
|
|
@@ -3687,7 +3689,7 @@
|
|
|
3687
3689
|
},
|
|
3688
3690
|
"canModifyContentRestriction": {
|
|
3689
3691
|
"deprecated": true,
|
|
3690
|
-
"description": "Deprecated: Output only. Use one of `canModifyEditorContentRestriction`, `canModifyOwnerContentRestriction
|
|
3692
|
+
"description": "Deprecated: Output only. Use one of `canModifyEditorContentRestriction`, `canModifyOwnerContentRestriction`, or `canRemoveContentRestriction`.",
|
|
3691
3693
|
"type": "boolean"
|
|
3692
3694
|
},
|
|
3693
3695
|
"canModifyEditorContentRestriction": {
|
|
@@ -3703,7 +3705,7 @@
|
|
|
3703
3705
|
"type": "boolean"
|
|
3704
3706
|
},
|
|
3705
3707
|
"canMoveChildrenOutOfDrive": {
|
|
3706
|
-
"description": "Output only. Whether the current user can move children of this folder outside of the shared drive. This is false when the item
|
|
3708
|
+
"description": "Output only. Whether the current user can move children of this folder outside of the shared drive. This is `false` when the item isn't a folder. Only populated for items in shared drives.",
|
|
3707
3709
|
"type": "boolean"
|
|
3708
3710
|
},
|
|
3709
3711
|
"canMoveChildrenOutOfTeamDrive": {
|
|
@@ -3712,7 +3714,7 @@
|
|
|
3712
3714
|
"type": "boolean"
|
|
3713
3715
|
},
|
|
3714
3716
|
"canMoveChildrenWithinDrive": {
|
|
3715
|
-
"description": "Output only. Whether the current user can move children of this folder within this drive. This is false when the item
|
|
3717
|
+
"description": "Output only. Whether the current user can move children of this folder within this drive. This is `false` when the item isn't a folder. Note that a request to move the child may still fail depending on the current user's access to the child and to the destination folder.",
|
|
3716
3718
|
"type": "boolean"
|
|
3717
3719
|
},
|
|
3718
3720
|
"canMoveChildrenWithinTeamDrive": {
|
|
@@ -3726,7 +3728,7 @@
|
|
|
3726
3728
|
"type": "boolean"
|
|
3727
3729
|
},
|
|
3728
3730
|
"canMoveItemOutOfDrive": {
|
|
3729
|
-
"description": "Output only. Whether the current user can move this item outside of this drive by changing its parent. Note that a request to change the parent of the item may still fail depending on the new parent that
|
|
3731
|
+
"description": "Output only. Whether the current user can move this item outside of this drive by changing its parent. Note that a request to change the parent of the item may still fail depending on the new parent that's being added.",
|
|
3730
3732
|
"type": "boolean"
|
|
3731
3733
|
},
|
|
3732
3734
|
"canMoveItemOutOfTeamDrive": {
|
|
@@ -3735,7 +3737,7 @@
|
|
|
3735
3737
|
"type": "boolean"
|
|
3736
3738
|
},
|
|
3737
3739
|
"canMoveItemWithinDrive": {
|
|
3738
|
-
"description": "Output only. Whether the current user can move this item within this drive. Note that a request to change the parent of the item may still fail depending on the new parent that
|
|
3740
|
+
"description": "Output only. Whether the current user can move this item within this drive. Note that a request to change the parent of the item may still fail depending on the new parent that's being added and the parent that is being removed.",
|
|
3739
3741
|
"type": "boolean"
|
|
3740
3742
|
},
|
|
3741
3743
|
"canMoveItemWithinTeamDrive": {
|
|
@@ -3757,7 +3759,7 @@
|
|
|
3757
3759
|
"type": "boolean"
|
|
3758
3760
|
},
|
|
3759
3761
|
"canReadRevisions": {
|
|
3760
|
-
"description": "Output only. Whether the current user can read the revisions resource of this file. For a shared drive item, whether revisions of non-folder descendants of this item, or this item
|
|
3762
|
+
"description": "Output only. Whether the current user can read the revisions resource of this file. For a shared drive item, whether revisions of non-folder descendants of this item, or this item if it's not a folder, can be read.",
|
|
3761
3763
|
"type": "boolean"
|
|
3762
3764
|
},
|
|
3763
3765
|
"canReadTeamDrive": {
|
|
@@ -3766,11 +3768,11 @@
|
|
|
3766
3768
|
"type": "boolean"
|
|
3767
3769
|
},
|
|
3768
3770
|
"canRemoveChildren": {
|
|
3769
|
-
"description": "Output only. Whether the current user can remove children from this folder. This is always false when the item
|
|
3771
|
+
"description": "Output only. Whether the current user can remove children from this folder. This is always `false` when the item isn't a folder. For a folder in a shared drive, use `canDeleteChildren` or `canTrashChildren` instead.",
|
|
3770
3772
|
"type": "boolean"
|
|
3771
3773
|
},
|
|
3772
3774
|
"canRemoveContentRestriction": {
|
|
3773
|
-
"description": "Output only. Whether there
|
|
3775
|
+
"description": "Output only. Whether there's a content restriction on the file that can be removed by the current user.",
|
|
3774
3776
|
"type": "boolean"
|
|
3775
3777
|
},
|
|
3776
3778
|
"canRemoveMyDriveParent": {
|
|
@@ -3790,7 +3792,7 @@
|
|
|
3790
3792
|
"type": "boolean"
|
|
3791
3793
|
},
|
|
3792
3794
|
"canTrashChildren": {
|
|
3793
|
-
"description": "Output only. Whether the current user can trash children of this folder. This is false when the item
|
|
3795
|
+
"description": "Output only. Whether the current user can trash children of this folder. This is `false` when the item isn't a folder. Only populated for items in shared drives.",
|
|
3794
3796
|
"type": "boolean"
|
|
3795
3797
|
},
|
|
3796
3798
|
"canUntrash": {
|
|
@@ -3804,14 +3806,14 @@
|
|
|
3804
3806
|
"description": "Additional information about the content of the file. These fields are never populated in responses.",
|
|
3805
3807
|
"properties": {
|
|
3806
3808
|
"indexableText": {
|
|
3807
|
-
"description": "Text to be indexed for the file to improve fullText queries. This is limited to
|
|
3809
|
+
"description": "Text to be indexed for the file to improve fullText queries. This is limited to 128 KB in length and may contain HTML elements.",
|
|
3808
3810
|
"type": "string"
|
|
3809
3811
|
},
|
|
3810
3812
|
"thumbnail": {
|
|
3811
3813
|
"description": "A thumbnail for the file. This will only be used if Google Drive cannot generate a standard thumbnail.",
|
|
3812
3814
|
"properties": {
|
|
3813
3815
|
"image": {
|
|
3814
|
-
"description": "The thumbnail data encoded with URL-safe Base64 (RFC 4648 section 5).",
|
|
3816
|
+
"description": "The thumbnail data encoded with URL-safe Base64 ([RFC 4648 section 5](https://datatracker.ietf.org/doc/html/rfc4648#section-5)).",
|
|
3815
3817
|
"format": "byte",
|
|
3816
3818
|
"type": "string"
|
|
3817
3819
|
},
|
|
@@ -3833,7 +3835,7 @@
|
|
|
3833
3835
|
"type": "array"
|
|
3834
3836
|
},
|
|
3835
3837
|
"copyRequiresWriterPermission": {
|
|
3836
|
-
"description": "Whether the options to copy, print, or download this file
|
|
3838
|
+
"description": "Whether the options to copy, print, or download this file should be disabled for readers and commenters.",
|
|
3837
3839
|
"type": "boolean"
|
|
3838
3840
|
},
|
|
3839
3841
|
"createdTime": {
|
|
@@ -3870,11 +3872,11 @@
|
|
|
3870
3872
|
"type": "string"
|
|
3871
3873
|
},
|
|
3872
3874
|
"folderColorRgb": {
|
|
3873
|
-
"description": "The color for a folder or a shortcut to a folder as an RGB hex string. The supported colors are published in the `folderColorPalette` field of the
|
|
3875
|
+
"description": "The color for a folder or a shortcut to a folder as an RGB hex string. The supported colors are published in the `folderColorPalette` field of the [`about`](/workspace/drive/api/reference/rest/v3/about) resource. If an unsupported color is specified, the closest color in the palette is used instead.",
|
|
3874
3876
|
"type": "string"
|
|
3875
3877
|
},
|
|
3876
3878
|
"fullFileExtension": {
|
|
3877
|
-
"description": "Output only. The full file extension extracted from the `name` field. May contain multiple concatenated extensions, such as \"tar.gz\". This is only available for files with binary content in Google Drive. This is automatically updated when the `name` field changes, however it
|
|
3879
|
+
"description": "Output only. The full file extension extracted from the `name` field. May contain multiple concatenated extensions, such as \"tar.gz\". This is only available for files with binary content in Google Drive. This is automatically updated when the `name` field changes, however it's not cleared if the new name doesn't contain a valid extension.",
|
|
3878
3880
|
"type": "string"
|
|
3879
3881
|
},
|
|
3880
3882
|
"hasAugmentedPermissions": {
|
|
@@ -3882,7 +3884,7 @@
|
|
|
3882
3884
|
"type": "boolean"
|
|
3883
3885
|
},
|
|
3884
3886
|
"hasThumbnail": {
|
|
3885
|
-
"description": "Output only. Whether this file has a thumbnail. This
|
|
3887
|
+
"description": "Output only. Whether this file has a thumbnail. This doesn't indicate whether the requesting app has access to the thumbnail. To check access, look for the presence of the thumbnailLink field.",
|
|
3886
3888
|
"type": "boolean"
|
|
3887
3889
|
},
|
|
3888
3890
|
"headRevisionId": {
|
|
@@ -4063,7 +4065,7 @@
|
|
|
4063
4065
|
"type": "string"
|
|
4064
4066
|
},
|
|
4065
4067
|
"mimeType": {
|
|
4066
|
-
"description": "The MIME type of the file. Google Drive attempts to automatically detect an appropriate value from uploaded content, if no value is provided. The value cannot be changed unless a new revision is uploaded. If a file is created with a Google Doc MIME type, the uploaded content is imported, if possible. The supported import formats are published in the
|
|
4068
|
+
"description": "The MIME type of the file. Google Drive attempts to automatically detect an appropriate value from uploaded content, if no value is provided. The value cannot be changed unless a new revision is uploaded. If a file is created with a Google Doc MIME type, the uploaded content is imported, if possible. The supported import formats are published in the [`about`](/workspace/drive/api/reference/rest/v3/about) resource.",
|
|
4067
4069
|
"type": "string"
|
|
4068
4070
|
},
|
|
4069
4071
|
"modifiedByMe": {
|
|
@@ -4081,7 +4083,7 @@
|
|
|
4081
4083
|
"type": "string"
|
|
4082
4084
|
},
|
|
4083
4085
|
"name": {
|
|
4084
|
-
"description": "The name of the file. This
|
|
4086
|
+
"description": "The name of the file. This isn't necessarily unique within a folder. Note that for immutable items such as the top-level folders of shared drives, the My Drive root folder, and the Application Data folder, the name is constant.",
|
|
4085
4087
|
"type": "string"
|
|
4086
4088
|
},
|
|
4087
4089
|
"originalFilename": {
|
|
@@ -4137,11 +4139,11 @@
|
|
|
4137
4139
|
"type": "string"
|
|
4138
4140
|
},
|
|
4139
4141
|
"sha1Checksum": {
|
|
4140
|
-
"description": "Output only. The SHA1 checksum associated with this file, if available. This field is only populated for files with content stored in Google Drive; it
|
|
4142
|
+
"description": "Output only. The SHA1 checksum associated with this file, if available. This field is only populated for files with content stored in Google Drive; it's not populated for Docs Editors or shortcut files.",
|
|
4141
4143
|
"type": "string"
|
|
4142
4144
|
},
|
|
4143
4145
|
"sha256Checksum": {
|
|
4144
|
-
"description": "Output only. The SHA256 checksum associated with this file, if available. This field is only populated for files with content stored in Google Drive; it
|
|
4146
|
+
"description": "Output only. The SHA256 checksum associated with this file, if available. This field is only populated for files with content stored in Google Drive; it's not populated for Docs Editors or shortcut files.",
|
|
4145
4147
|
"type": "string"
|
|
4146
4148
|
},
|
|
4147
4149
|
"shared": {
|
|
@@ -4169,19 +4171,19 @@
|
|
|
4169
4171
|
"type": "string"
|
|
4170
4172
|
},
|
|
4171
4173
|
"targetResourceKey": {
|
|
4172
|
-
"description": "Output only. The
|
|
4174
|
+
"description": "Output only. The `resourceKey` for the target file.",
|
|
4173
4175
|
"type": "string"
|
|
4174
4176
|
}
|
|
4175
4177
|
},
|
|
4176
4178
|
"type": "object"
|
|
4177
4179
|
},
|
|
4178
4180
|
"size": {
|
|
4179
|
-
"description": "Output only. Size in bytes of blobs and
|
|
4181
|
+
"description": "Output only. Size in bytes of blobs and Google Workspace editor files. Won't be populated for files that have no size, like shortcuts and folders.",
|
|
4180
4182
|
"format": "int64",
|
|
4181
4183
|
"type": "string"
|
|
4182
4184
|
},
|
|
4183
4185
|
"spaces": {
|
|
4184
|
-
"description": "Output only. The list of spaces which contain the file. The currently supported values are
|
|
4186
|
+
"description": "Output only. The list of spaces which contain the file. The currently supported values are `drive`, `appDataFolder`, and `photos`.",
|
|
4185
4187
|
"items": {
|
|
4186
4188
|
"type": "string"
|
|
4187
4189
|
},
|
|
@@ -4197,7 +4199,7 @@
|
|
|
4197
4199
|
"type": "string"
|
|
4198
4200
|
},
|
|
4199
4201
|
"thumbnailLink": {
|
|
4200
|
-
"description": "Output only. A short-lived link to the file's thumbnail, if available. Typically lasts on the order of hours. Not intended for direct usage on web applications due to [Cross-Origin Resource Sharing (CORS)](https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS) policies
|
|
4202
|
+
"description": "Output only. A short-lived link to the file's thumbnail, if available. Typically lasts on the order of hours. Not intended for direct usage on web applications due to [Cross-Origin Resource Sharing (CORS)](https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS) policies. Consider using a proxy server. Only populated when the requesting app can access the file's content. If the file isn't shared publicly, the URL returned in `files.thumbnailLink` must be fetched using a credentialed request.",
|
|
4201
4203
|
"type": "string"
|
|
4202
4204
|
},
|
|
4203
4205
|
"thumbnailVersion": {
|
|
@@ -4278,14 +4280,14 @@
|
|
|
4278
4280
|
"id": "FileList",
|
|
4279
4281
|
"properties": {
|
|
4280
4282
|
"files": {
|
|
4281
|
-
"description": "The list of files. If nextPageToken is populated, then this list may be incomplete and an additional page of results should be fetched.",
|
|
4283
|
+
"description": "The list of files. If `nextPageToken` is populated, then this list may be incomplete and an additional page of results should be fetched.",
|
|
4282
4284
|
"items": {
|
|
4283
4285
|
"$ref": "File"
|
|
4284
4286
|
},
|
|
4285
4287
|
"type": "array"
|
|
4286
4288
|
},
|
|
4287
4289
|
"incompleteSearch": {
|
|
4288
|
-
"description": "Whether the search process was incomplete. If true, then some search results might be missing, since all documents were not searched. This can occur when searching multiple drives with the
|
|
4290
|
+
"description": "Whether the search process was incomplete. If true, then some search results might be missing, since all documents were not searched. This can occur when searching multiple drives with the `allDrives` corpora, but all corpora couldn't be searched. When this happens, it's suggested that clients narrow their query by choosing a different corpus such as `user` or `drive`.",
|
|
4289
4291
|
"type": "boolean"
|
|
4290
4292
|
},
|
|
4291
4293
|
"kind": {
|
|
@@ -4414,7 +4416,7 @@
|
|
|
4414
4416
|
"type": "string"
|
|
4415
4417
|
},
|
|
4416
4418
|
"kind": {
|
|
4417
|
-
"description": "This is always drive#labelFieldModification
|
|
4419
|
+
"description": "This is always `\"drive#labelFieldModification\"`.",
|
|
4418
4420
|
"type": "string"
|
|
4419
4421
|
},
|
|
4420
4422
|
"setDateValues": {
|
|
@@ -4448,7 +4450,7 @@
|
|
|
4448
4450
|
"type": "array"
|
|
4449
4451
|
},
|
|
4450
4452
|
"setUserValues": {
|
|
4451
|
-
"description": "Replaces a `user` field with these new values. The values must be valid email addresses.",
|
|
4453
|
+
"description": "Replaces a `user` field with these new values. The values must be a valid email addresses.",
|
|
4452
4454
|
"items": {
|
|
4453
4455
|
"type": "string"
|
|
4454
4456
|
},
|
|
@@ -4466,7 +4468,7 @@
|
|
|
4466
4468
|
"id": "LabelList",
|
|
4467
4469
|
"properties": {
|
|
4468
4470
|
"kind": {
|
|
4469
|
-
"description": "This is always drive#labelList",
|
|
4471
|
+
"description": "This is always `\"drive#labelList\"`.",
|
|
4470
4472
|
"type": "string"
|
|
4471
4473
|
},
|
|
4472
4474
|
"labels": {
|
|
@@ -4484,7 +4486,7 @@
|
|
|
4484
4486
|
"type": "object"
|
|
4485
4487
|
},
|
|
4486
4488
|
"LabelModification": {
|
|
4487
|
-
"description": "A modification to a label on a file. A LabelModification can be used to apply a label to a file, update an existing label on a file, or remove a label from a file.",
|
|
4489
|
+
"description": "A modification to a label on a file. A `LabelModification` can be used to apply a label to a file, update an existing label on a file, or remove a label from a file.",
|
|
4488
4490
|
"id": "LabelModification",
|
|
4489
4491
|
"properties": {
|
|
4490
4492
|
"fieldModifications": {
|
|
@@ -4495,7 +4497,7 @@
|
|
|
4495
4497
|
"type": "array"
|
|
4496
4498
|
},
|
|
4497
4499
|
"kind": {
|
|
4498
|
-
"description": "This is always drive#labelModification
|
|
4500
|
+
"description": "This is always `\"drive#labelModification\"`.",
|
|
4499
4501
|
"type": "string"
|
|
4500
4502
|
},
|
|
4501
4503
|
"labelId": {
|
|
@@ -4537,7 +4539,7 @@
|
|
|
4537
4539
|
"id": "ModifyLabelsRequest",
|
|
4538
4540
|
"properties": {
|
|
4539
4541
|
"kind": {
|
|
4540
|
-
"description": "This is always drive#modifyLabelsRequest
|
|
4542
|
+
"description": "This is always `\"drive#modifyLabelsRequest\"`.",
|
|
4541
4543
|
"type": "string"
|
|
4542
4544
|
},
|
|
4543
4545
|
"labelModifications": {
|
|
@@ -4551,11 +4553,11 @@
|
|
|
4551
4553
|
"type": "object"
|
|
4552
4554
|
},
|
|
4553
4555
|
"ModifyLabelsResponse": {
|
|
4554
|
-
"description": "Response to a ModifyLabels request. This contains only those labels which were added or updated by the request.",
|
|
4556
|
+
"description": "Response to a `ModifyLabels` request. This contains only those labels which were added or updated by the request.",
|
|
4555
4557
|
"id": "ModifyLabelsResponse",
|
|
4556
4558
|
"properties": {
|
|
4557
4559
|
"kind": {
|
|
4558
|
-
"description": "This is always drive#modifyLabelsResponse",
|
|
4560
|
+
"description": "This is always `\"drive#modifyLabelsResponse\"`.",
|
|
4559
4561
|
"type": "string"
|
|
4560
4562
|
},
|
|
4561
4563
|
"modifiedLabels": {
|