{ "id": "@itentialopensource/adapter-google_drive", "type": "Adapter", "export": "GoogleDrive", "title": "Google_drive", "src": "adapter.js", "roles": [ "admin" ], "methods": [ { "name": "iapUpdateAdapterConfiguration", "summary": "Updates the adapter configuration", "description": "Updates the adapter configuration file with the provided changes", "input": [ { "name": "configFile", "type": "string", "info": "The name of the file to change", "required": true, "schema": { "title": "configFile", "type": "string" } }, { "name": "changes", "type": "object", "info": "JSON object containing the configuration changes", "required": true, "schema": { "title": "changes", "type": "object" } }, { "name": "entity", "type": "string", "info": "The entity in which the changes are being made", "required": false, "schema": { "title": "entity", "type": "string" } }, { "name": "type", "type": "string", "info": "The type of file to change - action, schema, or mock", "required": false, "schema": { "title": "type", "type": "string" } }, { "name": "action", "type": "string", "info": "The action to be changed", "required": false, "schema": { "title": "action", "type": "string" } }, { "name" : "replace", "type": "boolean", "info": "True to replace entire mock data, false to merge/append", "required": false, "schema": { "title": "replace", "type" : "boolean" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapUpdateAdapterConfiguration" }, "task": true }, { "name": "iapSuspendAdapter", "summary": "Suspends the adapter", "description": "Suspends the adapter", "input": [ { "name": "mode", "type": "enum", "enumerals": [ "pause", "error" ], "info": "How incoming requests are handled. Defaults to 'pause'", "description": "How incoming requests are handled. Defaults to 'pause'", "schema": { "title": "mode", "type": "string" }, "required": false } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing the adapter suspended status", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapSuspendAdapter" }, "task": true }, { "name": "iapUnsuspendAdapter", "summary": "Unsuspends the adapter", "description": "Unsuspends the adapter", "input": [], "output": { "name": "result", "type": "object", "description": "A JSON Object containing the adapter suspended status", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapUnsuspendAdapter" }, "task": true }, { "name": "iapGetAdapterQueue", "summary": "Return the requests that are waiting in the queue if throttling is enabled", "description": "Return the requests that are waiting in the queue if throttling is enabled", "input": [], "output": { "name": "result", "type": "object", "description": "A JSON Object containing the adapter queue", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapGetAdapterQueue" }, "task": true }, { "name": "iapFindAdapterPath", "summary": "Provides the ability to see if a particular API path is supported by the adapter", "description": "Provides the ability to see if a particular API path is supported by the adapter", "input": [ { "name": "apiPath", "type": "string", "info": "The API Path you want to check - make sure to not include base path and version", "description": "The API Path you want to check - make sure to not include base path and version", "schema": { "title": "apiPath", "type": "string" }, "required": true } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapFindAdapterPath" }, "task": true }, { "name": "iapTroubleshootAdapter", "summary": "Runs troubleshoot script for adapter", "description": "Runs troubleshoot script for adapter", "input": [ { "name": "props", "type": "object", "info": "Object containing configuration, healthcheck and auth properties {'connProps':{'host': 'api.service.com', 'base_path': '/', 'protocol': 'http', 'port': 443, 'version': 'v1'},'healthCheckEndpoint': '/healthcheck', 'auth': {'auth_method': 'no authentication', 'username': 'username', 'password': 'password'}}", "required": true, "schema": { "title": "props", "type": "object" } }, { "name": "persistFlag", "type": "boolean", "info": "Whether the input properties should be saved", "required": true, "schema": { "title": "persistFlag", "type": "boolean" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing the test results", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapTroubleshootAdapter" }, "task": true }, { "name": "iapRunAdapterHealthcheck", "summary": "Runs healthcheck script for adapter", "description": "Runs healthcheck script for adapter", "input": [], "output": { "name": "result", "type": "boolean", "description": "Whether healthcheck passed or failed", "schema": { "title": "result", "type": "boolean" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapRunAdapterHealthcheck" }, "task": true }, { "name": "iapRunAdapterConnectivity", "summary": "Runs connectivity check script for adapter", "description": "Runs connectivity check script for adapter", "input": [], "output": { "name": "result", "type": "object", "description": "A JSON Object containing the test results", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapRunAdapterConnectivity" }, "task": true }, { "name": "iapRunAdapterBasicGet", "summary": "Runs basicGet script for adapter", "description": "Runs basicGet script for adapter", "input": [], "output": { "name": "result", "type": "object", "description": "A JSON Object containing the test results", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapRunAdapterBasicGet" }, "task": true }, { "name": "iapMoveAdapterEntitiesToDB", "summary": "Moves entities from an adapter into the IAP database", "description": "Moves entities from an adapter into the IAP database", "input": [], "output": { "name": "res", "type": "object", "description": "A JSON Object containing status, code and the response from the mongo transaction", "schema": { "title": "res", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapMoveAdapterEntitiesToDB" }, "task": true }, { "name": "iapDeactivateTasks", "summary": "Deactivate the inputted tasks", "description": "Deactivate the inputted tasks", "input": [ { "name": "tasks", "type": "array", "description": "Tasks to deactivate", "schema": { "title": "tasks", "type": "array" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing success status", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapDeactivateTasks" }, "task": true }, { "name": "iapActivateTasks", "summary": "Activate the inputted tasks", "description": "activate the inputted tasks", "input": [ { "name": "tasks", "type": "array", "description": "Tasks to activate", "schema": { "title": "tasks", "type": "array" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing success status", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapActivateTasks" }, "task": true }, { "name": "iapPopulateEntityCache", "summary": "Populate the cache for the given entities", "description": "Populate the cache for the given entities", "input": [ { "name": "entityTypes", "type": "array", "info": "the entity type(s) to populate", "required": true, "schema": { "title": "entityTypes", "type": "array" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapPopulateEntityCache" }, "task": true }, { "name": "iapRetrieveEntitiesCache", "summary": "Retrieves data from cache for specified entity type", "description": "Retrieves data from cache for specified entity type", "input": [ { "name": "entityType", "type": "string", "info": "entity of which to retrieve", "required": true, "schema": { "title": "entityType", "type": "string" } }, { "name": "options", "type": "object", "info": "settings of which data to return and how to return it", "required": false, "schema": { "title": "options", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapRetrieveEntitiesCache" }, "task": true }, { "name": "getDevice", "summary": "Get the Appliance", "description": "Get the Appliance", "input": [ { "name": "deviceName", "type": "string", "info": "An Appliance Device Name", "required": true, "schema": { "title": "deviceName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getDevice" }, "task": false }, { "name": "getDevicesFiltered", "summary": "Get Appliances that match the filter", "description": "Get Appliances that match the filter", "input": [ { "name": "options", "type": "object", "info": "options - e.g. { 'start': 1, 'limit': 20, 'filter': { 'name': 'abc123' } }", "required": true, "schema": { "title": "options", "type": "object" } } ], "output": { "name": "result", "type": "array", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "array" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getDevicesFiltered" }, "task": false }, { "name": "isAlive", "summary": "Checks the status for the provided Appliance", "description": "Checks the status for the provided Appliance", "input": [ { "name": "deviceName", "type": "string", "info": "An Appliance Device Name", "required": true, "schema": { "title": "deviceName", "type": "string" } } ], "output": { "name": "result", "type": "boolean", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "boolean" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/isAlive" }, "task": false }, { "name": "getConfig", "summary": "Gets a config for the provided Appliance", "description": "Gets a config for the provided Appliance", "input": [ { "name": "deviceName", "type": "string", "info": "An Appliance Device Name", "required": true, "schema": { "title": "deviceName", "type": "string" } }, { "name": "format", "type": "string", "info": "The format to be returned - this is ignored as we always return json", "required": false, "schema": { "title": "format", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getConfig" }, "task": false }, { "name": "iapGetDeviceCount", "summary": "Gets a device count from the system", "description": "Gets a device count from the system", "input": [], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapGetDeviceCount" }, "task": false }, { "name": "iapExpandedGenericAdapterRequest", "summary": "Makes the requested generic call with additional options", "description": "Makes the requested generic call with additional options via metadata", "input": [ { "name": "metadata", "type": "object", "info": "metadata for the call (optional)", "description": "metadata for the call - allows for many enhancements (optional)", "schema": { "title": "metadata", "type": "object" }, "required": false }, { "name": "uriPath", "type": "string", "info": "the path of the api call - do not include the host, port, base path or version", "description": "the path of the api call", "schema": { "title": "uriPath", "type": "string" }, "required": false }, { "name": "restMethod", "type": "string", "info": "the rest method (GET, POST, PUT, PATCH, DELETE)", "description": "the rest method (GET, POST, PUT, PATCH, DELETE)", "schema": { "title": "restMethod", "type": "string" }, "required": false }, { "name": "pathVars", "type": "object", "info": "the parameters to be put within the url path (optional)", "description": "the parameters to be put within the url path (optional)", "schema": { "title": "pathVars", "type": "object" }, "required": false }, { "name": "queryData", "type": "object", "info": "the query parameters to be put on the url (optional)", "description": "the query parameters to be put on the url (optional)", "schema": { "title": "queryData", "type": "object" }, "required": false }, { "name": "requestBody", "type": "object", "info": "the payload to be sent with the request (optional)", "description": "the payload to be sent with the request (optional)", "schema": { "title": "requestBody", "type": "object" }, "required": false }, { "name": "addlHeaders", "type": "object", "info": "additional headers to be put on the call (optional)", "description": "additional headers to be put on the call (optional)", "schema": { "title": "addlHeaders", "type": "object" }, "required": false } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapExpandedGenericAdapterRequest" }, "task": true }, { "name": "genericAdapterRequest", "summary": "Makes the requested generic call", "description": "Makes the requested generic call", "input": [ { "name": "uriPath", "type": "string", "info": "the path of the api call - do not include the host, port, base path or version", "description": "the path of the api call", "schema": { "title": "uriPath", "type": "string" }, "required": true }, { "name": "restMethod", "type": "string", "info": "the rest method (GET, POST, PUT, PATCH, DELETE)", "description": "the rest method (GET, POST, PUT, PATCH, DELETE)", "schema": { "title": "restMethod", "type": "string" }, "required": true }, { "name": "queryData", "type": "object", "info": "the query parameters to be put on the url (optional)", "description": "the query parameters to be put on the url (optional)", "schema": { "title": "queryData", "type": "object" }, "required": false }, { "name": "requestBody", "type": "object", "info": "the payload to be sent with the request (optional)", "description": "the payload to be sent with the request (optional)", "schema": { "title": "requestBody", "type": "object" }, "required": false }, { "name": "addlHeaders", "type": "object", "info": "additional headers to be put on the call (optional)", "description": "additional headers to be put on the call (optional)", "schema": { "title": "addlHeaders", "type": "object" }, "required": false } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/genericAdapterRequest" }, "task": true }, { "name": "genericAdapterRequestNoBasePath", "summary": "Makes the requested generic call", "description": "Makes the requested generic call", "input": [ { "name": "uriPath", "type": "string", "info": "the path of the api call - do not include the host, port, base path or version", "description": "the path of the api call", "schema": { "title": "uriPath", "type": "string" }, "required": true }, { "name": "restMethod", "type": "string", "info": "the rest method (GET, POST, PUT, PATCH, DELETE)", "description": "the rest method (GET, POST, PUT, PATCH, DELETE)", "schema": { "title": "restMethod", "type": "string" }, "required": true }, { "name": "queryData", "type": "object", "info": "the query parameters to be put on the url (optional)", "description": "the query parameters to be put on the url (optional)", "schema": { "title": "queryData", "type": "object" }, "required": false }, { "name": "requestBody", "type": "object", "info": "the payload to be sent with the request (optional)", "description": "the payload to be sent with the request (optional)", "schema": { "title": "requestBody", "type": "object" }, "required": false }, { "name": "addlHeaders", "type": "object", "info": "additional headers to be put on the call (optional)", "description": "additional headers to be put on the call (optional)", "schema": { "title": "addlHeaders", "type": "object" }, "required": false } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/genericAdapterRequestNoBasePath" }, "task": true }, { "name": "iapRunAdapterLint", "summary": "Run the adapter lint script to return the results", "description": "Run the adapter lint script to return the results", "input": [], "output": { "name": "result", "type": "string", "description": "A string containing the run results", "schema": { "title": "result", "type": "string" } }, "roles": [ "admin" ], "route": { "verb": "GET", "path": "/iapRunAdapterLint" }, "task": true }, { "name": "iapRunAdapterTests", "summary": "Run the adapter test scripts (baseunit and unit) to return the results", "description": "Run the adapter test scripts (baseunit and unit) to return the results", "input": [], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "GET", "path": "/iapRunAdapterTests" }, "task": true }, { "name": "iapGetAdapterInventory", "summary": "Provide inventory information abbout the adapter", "description": "Provide inventory information abbout the adapter", "input": [], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "GET", "path": "/iapGetAdapterInventory" }, "task": true }, { "name": "driveAboutGet", "summary": "Gets information about the user, the user's Drive, and system capabilities.", "description": "Gets information about the user, the user's Drive, and system capabilities.", "input": [ { "name": "alt", "type": "string", "info": "Data format for the response.: Must be one of [json]", "required": false, "schema": { "title": "alt", "type": "string" } }, { "name": "fields", "type": "string", "info": "Selector specifying which fields to include in a partial response.: string", "required": false, "schema": { "title": "fields", "type": "string" } }, { "name": "key", "type": "string", "info": "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.: string", "required": false, "schema": { "title": "key", "type": "string" } }, { "name": "oauthToken", "type": "string", "info": "OAuth 2.0 token for the current user.: string", "required": false, "schema": { "title": "oauthToken", "type": "string" } }, { "name": "prettyPrint", "type": "boolean", "info": "Returns response with indentations and line breaks.: boolean", "required": false, "schema": { "title": "prettyPrint", "type": "boolean" } }, { "name": "quotaUser", "type": "string", "info": "An opaque string that represents a user for quota purposes. Must not exceed 40 characters.: string", "required": false, "schema": { "title": "quotaUser", "type": "string" } }, { "name": "userIp", "type": "string", "info": "Deprecated. Please use quotaUser instead.: string", "required": false, "schema": { "title": "userIp", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/driveAboutGet" }, "task": true }, { "name": "driveChangesList", "summary": "Lists the changes for a user or shared drive.", "description": "Lists the changes for a user or shared drive.", "input": [ { "name": "alt", "type": "string", "info": "Data format for the response.: Must be one of [json]", "required": false, "schema": { "title": "alt", "type": "string" } }, { "name": "fields", "type": "string", "info": "Selector specifying which fields to include in a partial response.: string", "required": false, "schema": { "title": "fields", "type": "string" } }, { "name": "key", "type": "string", "info": "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.: string", "required": false, "schema": { "title": "key", "type": "string" } }, { "name": "oauthToken", "type": "string", "info": "OAuth 2.0 token for the current user.: string", "required": false, "schema": { "title": "oauthToken", "type": "string" } }, { "name": "prettyPrint", "type": "boolean", "info": "Returns response with indentations and line breaks.: boolean", "required": false, "schema": { "title": "prettyPrint", "type": "boolean" } }, { "name": "quotaUser", "type": "string", "info": "An opaque string that represents a user for quota purposes. Must not exceed 40 characters.: string", "required": false, "schema": { "title": "quotaUser", "type": "string" } }, { "name": "userIp", "type": "string", "info": "Deprecated. Please use quotaUser instead.: string", "required": false, "schema": { "title": "userIp", "type": "string" } }, { "name": "pageToken", "type": "string", "info": "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 or to the response from t...(description truncated): string", "required": true, "schema": { "title": "pageToken", "type": "string" } }, { "name": "driveId", "type": "string", "info": "The shared drive from which changes are returned. If specified the change IDs will be reflective of the shared drive; use the combined drive ID and change ID as an identi...(description truncated): string", "required": false, "schema": { "title": "driveId", "type": "string" } }, { "name": "includeCorpusRemovals", "type": "boolean", "info": "Whether changes should include the file resource if the file is still accessible by the user at the time of the request, even when a file was removed from the list of cha...(description truncated): boolean", "required": false, "schema": { "title": "includeCorpusRemovals", "type": "boolean" } }, { "name": "includeItemsFromAllDrives", "type": "boolean", "info": "Whether both My Drive and shared drive items should be included in results.: boolean", "required": false, "schema": { "title": "includeItemsFromAllDrives", "type": "boolean" } }, { "name": "includePermissionsForView", "type": "string", "info": "Specifies which additional view's permissions to include in the response. Only 'published' is supported.: string", "required": false, "schema": { "title": "includePermissionsForView", "type": "string" } }, { "name": "includeRemoved", "type": "boolean", "info": "Whether to include changes indicating that items have been removed from the list of changes, for example by deletion or loss of access.: boolean", "required": false, "schema": { "title": "includeRemoved", "type": "boolean" } }, { "name": "includeTeamDriveItems", "type": "boolean", "info": "Deprecated use includeItemsFromAllDrives instead.: boolean", "required": false, "schema": { "title": "includeTeamDriveItems", "type": "boolean" } }, { "name": "pageSize", "type": "number", "info": "The maximum number of changes to return per page.: 123", "required": false, "schema": { "title": "pageSize", "type": "number" } }, { "name": "restrictToMyDrive", "type": "boolean", "info": "Whether to restrict the results to changes inside the My Drive hierarchy. This omits changes to files such as those in the Application Data folder or shared files which h...(description truncated): boolean", "required": false, "schema": { "title": "restrictToMyDrive", "type": "boolean" } }, { "name": "spaces", "type": "string", "info": "A comma-separated list of spaces to query within the user corpus. Supported values are 'drive', 'appDataFolder' and 'photos'.: string", "required": false, "schema": { "title": "spaces", "type": "string" } }, { "name": "supportsAllDrives", "type": "boolean", "info": "Whether the requesting application supports both My Drives and shared drives.: boolean", "required": false, "schema": { "title": "supportsAllDrives", "type": "boolean" } }, { "name": "supportsTeamDrives", "type": "boolean", "info": "Deprecated use supportsAllDrives instead.: boolean", "required": false, "schema": { "title": "supportsTeamDrives", "type": "boolean" } }, { "name": "teamDriveId", "type": "string", "info": "Deprecated use driveId instead.: string", "required": false, "schema": { "title": "teamDriveId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/driveChangesList" }, "task": true }, { "name": "driveChangesGetStartPageToken", "summary": "Gets the starting pageToken for listing future changes.", "description": "Gets the starting pageToken for listing future changes.", "input": [ { "name": "alt", "type": "string", "info": "Data format for the response.: Must be one of [json]", "required": false, "schema": { "title": "alt", "type": "string" } }, { "name": "fields", "type": "string", "info": "Selector specifying which fields to include in a partial response.: string", "required": false, "schema": { "title": "fields", "type": "string" } }, { "name": "key", "type": "string", "info": "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.: string", "required": false, "schema": { "title": "key", "type": "string" } }, { "name": "oauthToken", "type": "string", "info": "OAuth 2.0 token for the current user.: string", "required": false, "schema": { "title": "oauthToken", "type": "string" } }, { "name": "prettyPrint", "type": "boolean", "info": "Returns response with indentations and line breaks.: boolean", "required": false, "schema": { "title": "prettyPrint", "type": "boolean" } }, { "name": "quotaUser", "type": "string", "info": "An opaque string that represents a user for quota purposes. Must not exceed 40 characters.: string", "required": false, "schema": { "title": "quotaUser", "type": "string" } }, { "name": "userIp", "type": "string", "info": "Deprecated. Please use quotaUser instead.: string", "required": false, "schema": { "title": "userIp", "type": "string" } }, { "name": "driveId", "type": "string", "info": "The ID of the shared drive for which the starting pageToken for listing future changes from that shared drive is returned.: string", "required": false, "schema": { "title": "driveId", "type": "string" } }, { "name": "supportsAllDrives", "type": "boolean", "info": "Whether the requesting application supports both My Drives and shared drives.: boolean", "required": false, "schema": { "title": "supportsAllDrives", "type": "boolean" } }, { "name": "supportsTeamDrives", "type": "boolean", "info": "Deprecated use supportsAllDrives instead.: boolean", "required": false, "schema": { "title": "supportsTeamDrives", "type": "boolean" } }, { "name": "teamDriveId", "type": "string", "info": "Deprecated use driveId instead.: string", "required": false, "schema": { "title": "teamDriveId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/driveChangesGetStartPageToken" }, "task": true }, { "name": "driveChangesWatch", "summary": "Subscribes to changes for a user.", "description": "Subscribes to changes for a user.", "input": [ { "name": "alt", "type": "string", "info": "Data format for the response.: Must be one of [json]", "required": false, "schema": { "title": "alt", "type": "string" } }, { "name": "fields", "type": "string", "info": "Selector specifying which fields to include in a partial response.: string", "required": false, "schema": { "title": "fields", "type": "string" } }, { "name": "key", "type": "string", "info": "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.: string", "required": false, "schema": { "title": "key", "type": "string" } }, { "name": "oauthToken", "type": "string", "info": "OAuth 2.0 token for the current user.: string", "required": false, "schema": { "title": "oauthToken", "type": "string" } }, { "name": "prettyPrint", "type": "boolean", "info": "Returns response with indentations and line breaks.: boolean", "required": false, "schema": { "title": "prettyPrint", "type": "boolean" } }, { "name": "quotaUser", "type": "string", "info": "An opaque string that represents a user for quota purposes. Must not exceed 40 characters.: string", "required": false, "schema": { "title": "quotaUser", "type": "string" } }, { "name": "userIp", "type": "string", "info": "Deprecated. Please use quotaUser instead.: string", "required": false, "schema": { "title": "userIp", "type": "string" } }, { "name": "pageToken", "type": "string", "info": "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 or to the response from t...(description truncated): string", "required": true, "schema": { "title": "pageToken", "type": "string" } }, { "name": "driveId", "type": "string", "info": "The shared drive from which changes are returned. If specified the change IDs will be reflective of the shared drive; use the combined drive ID and change ID as an identi...(description truncated): string", "required": false, "schema": { "title": "driveId", "type": "string" } }, { "name": "includeCorpusRemovals", "type": "boolean", "info": "Whether changes should include the file resource if the file is still accessible by the user at the time of the request, even when a file was removed from the list of cha...(description truncated): boolean", "required": false, "schema": { "title": "includeCorpusRemovals", "type": "boolean" } }, { "name": "includeItemsFromAllDrives", "type": "boolean", "info": "Whether both My Drive and shared drive items should be included in results.: boolean", "required": false, "schema": { "title": "includeItemsFromAllDrives", "type": "boolean" } }, { "name": "includePermissionsForView", "type": "string", "info": "Specifies which additional view's permissions to include in the response. Only 'published' is supported.: string", "required": false, "schema": { "title": "includePermissionsForView", "type": "string" } }, { "name": "includeRemoved", "type": "boolean", "info": "Whether to include changes indicating that items have been removed from the list of changes, for example by deletion or loss of access.: boolean", "required": false, "schema": { "title": "includeRemoved", "type": "boolean" } }, { "name": "includeTeamDriveItems", "type": "boolean", "info": "Deprecated use includeItemsFromAllDrives instead.: boolean", "required": false, "schema": { "title": "includeTeamDriveItems", "type": "boolean" } }, { "name": "pageSize", "type": "number", "info": "The maximum number of changes to return per page.: 123", "required": false, "schema": { "title": "pageSize", "type": "number" } }, { "name": "restrictToMyDrive", "type": "boolean", "info": "Whether to restrict the results to changes inside the My Drive hierarchy. This omits changes to files such as those in the Application Data folder or shared files which h...(description truncated): boolean", "required": false, "schema": { "title": "restrictToMyDrive", "type": "boolean" } }, { "name": "spaces", "type": "string", "info": "A comma-separated list of spaces to query within the user corpus. Supported values are 'drive', 'appDataFolder' and 'photos'.: string", "required": false, "schema": { "title": "spaces", "type": "string" } }, { "name": "supportsAllDrives", "type": "boolean", "info": "Whether the requesting application supports both My Drives and shared drives.: boolean", "required": false, "schema": { "title": "supportsAllDrives", "type": "boolean" } }, { "name": "supportsTeamDrives", "type": "boolean", "info": "Deprecated use supportsAllDrives instead.: boolean", "required": false, "schema": { "title": "supportsTeamDrives", "type": "boolean" } }, { "name": "teamDriveId", "type": "string", "info": "Deprecated use driveId instead.: string", "required": false, "schema": { "title": "teamDriveId", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"address\": \"string\", \"expiration\": \"string\", \"id\": \"string\", \"kind\": \"string\", \"params\": \"object\", \"payload\": \"boolean\", \"resourceId\": \"string\", \"resourceUri\": \"string\", \"token\": \"string\", \"type\": \"string\"}", "required": false, "schema": { "description": "An notification channel used to watch for resource changes.", "properties": { "address": { "description": "The address where notifications are delivered for this channel.", "type": "string" }, "expiration": { "description": "Date and time of notification channel expiration, expressed as a Unix timestamp, in milliseconds. Optional.", "type": "string" }, "id": { "description": "A UUID or similar unique string that identifies this channel.", "type": "string" }, "kind": { "default": "api#channel", "description": "Identifies this as a notification channel used to watch for changes to a resource, which is \"api#channel\".", "type": "string" }, "params": { "additionalProperties": { "description": "Declares a new parameter by name.", "type": "string" }, "description": "Additional parameters controlling delivery channel behavior. Optional.", "type": "object" }, "payload": { "description": "A Boolean value to indicate whether payload is wanted. Optional.", "type": "boolean" }, "resourceId": { "description": "An opaque ID that identifies the resource being watched on this channel. Stable across different API versions.", "type": "string" }, "resourceUri": { "description": "A version-specific identifier for the watched resource.", "type": "string" }, "token": { "description": "An arbitrary string delivered to the target address with each notification delivered over this channel. Optional.", "type": "string" }, "type": { "description": "The type of delivery mechanism used for this channel. Valid values are \"web_hook\" (or \"webhook\"). Both values refer to a channel where Http requests are used to deliver messages.", "type": "string" } }, "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/driveChangesWatch" }, "task": true }, { "name": "driveChannelsStop", "summary": "Stop watching resources through this channel", "description": "Stop watching resources through this channel", "input": [ { "name": "alt", "type": "string", "info": "Data format for the response.: Must be one of [json]", "required": false, "schema": { "title": "alt", "type": "string" } }, { "name": "fields", "type": "string", "info": "Selector specifying which fields to include in a partial response.: string", "required": false, "schema": { "title": "fields", "type": "string" } }, { "name": "key", "type": "string", "info": "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.: string", "required": false, "schema": { "title": "key", "type": "string" } }, { "name": "oauthToken", "type": "string", "info": "OAuth 2.0 token for the current user.: string", "required": false, "schema": { "title": "oauthToken", "type": "string" } }, { "name": "prettyPrint", "type": "boolean", "info": "Returns response with indentations and line breaks.: boolean", "required": false, "schema": { "title": "prettyPrint", "type": "boolean" } }, { "name": "quotaUser", "type": "string", "info": "An opaque string that represents a user for quota purposes. Must not exceed 40 characters.: string", "required": false, "schema": { "title": "quotaUser", "type": "string" } }, { "name": "userIp", "type": "string", "info": "Deprecated. Please use quotaUser instead.: string", "required": false, "schema": { "title": "userIp", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"address\": \"string\", \"expiration\": \"string\", \"id\": \"string\", \"kind\": \"string\", \"params\": \"object\", \"payload\": \"boolean\", \"resourceId\": \"string\", \"resourceUri\": \"string\", \"token\": \"string\", \"type\": \"string\"}", "required": false, "schema": { "description": "An notification channel used to watch for resource changes.", "properties": { "address": { "description": "The address where notifications are delivered for this channel.", "type": "string" }, "expiration": { "description": "Date and time of notification channel expiration, expressed as a Unix timestamp, in milliseconds. Optional.", "type": "string" }, "id": { "description": "A UUID or similar unique string that identifies this channel.", "type": "string" }, "kind": { "default": "api#channel", "description": "Identifies this as a notification channel used to watch for changes to a resource, which is \"api#channel\".", "type": "string" }, "params": { "additionalProperties": { "description": "Declares a new parameter by name.", "type": "string" }, "description": "Additional parameters controlling delivery channel behavior. Optional.", "type": "object" }, "payload": { "description": "A Boolean value to indicate whether payload is wanted. Optional.", "type": "boolean" }, "resourceId": { "description": "An opaque ID that identifies the resource being watched on this channel. Stable across different API versions.", "type": "string" }, "resourceUri": { "description": "A version-specific identifier for the watched resource.", "type": "string" }, "token": { "description": "An arbitrary string delivered to the target address with each notification delivered over this channel. Optional.", "type": "string" }, "type": { "description": "The type of delivery mechanism used for this channel. Valid values are \"web_hook\" (or \"webhook\"). Both values refer to a channel where Http requests are used to deliver messages.", "type": "string" } }, "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/driveChannelsStop" }, "task": true }, { "name": "driveDrivesList", "summary": "Lists the user's shared drives.", "description": "Lists the user's shared drives.", "input": [ { "name": "alt", "type": "string", "info": "Data format for the response.: Must be one of [json]", "required": false, "schema": { "title": "alt", "type": "string" } }, { "name": "fields", "type": "string", "info": "Selector specifying which fields to include in a partial response.: string", "required": false, "schema": { "title": "fields", "type": "string" } }, { "name": "key", "type": "string", "info": "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.: string", "required": false, "schema": { "title": "key", "type": "string" } }, { "name": "oauthToken", "type": "string", "info": "OAuth 2.0 token for the current user.: string", "required": false, "schema": { "title": "oauthToken", "type": "string" } }, { "name": "prettyPrint", "type": "boolean", "info": "Returns response with indentations and line breaks.: boolean", "required": false, "schema": { "title": "prettyPrint", "type": "boolean" } }, { "name": "quotaUser", "type": "string", "info": "An opaque string that represents a user for quota purposes. Must not exceed 40 characters.: string", "required": false, "schema": { "title": "quotaUser", "type": "string" } }, { "name": "userIp", "type": "string", "info": "Deprecated. Please use quotaUser instead.: string", "required": false, "schema": { "title": "userIp", "type": "string" } }, { "name": "pageSize", "type": "number", "info": "Maximum number of shared drives to return per page.: 123", "required": false, "schema": { "title": "pageSize", "type": "number" } }, { "name": "pageToken", "type": "string", "info": "Page token for shared drives.: string", "required": false, "schema": { "title": "pageToken", "type": "string" } }, { "name": "q", "type": "string", "info": "Query string for searching shared drives.: string", "required": false, "schema": { "title": "q", "type": "string" } }, { "name": "useDomainAdminAccess", "type": "boolean", "info": "Issue the request as a domain administrator; if set to true, then all shared drives of the domain in which the requester is an administrator are returned.: boolean", "required": false, "schema": { "title": "useDomainAdminAccess", "type": "boolean" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/driveDrivesList" }, "task": true }, { "name": "driveDrivesCreate", "summary": "Creates a new shared drive.", "description": "Creates a new shared drive.", "input": [ { "name": "alt", "type": "string", "info": "Data format for the response.: Must be one of [json]", "required": false, "schema": { "title": "alt", "type": "string" } }, { "name": "fields", "type": "string", "info": "Selector specifying which fields to include in a partial response.: string", "required": false, "schema": { "title": "fields", "type": "string" } }, { "name": "key", "type": "string", "info": "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.: string", "required": false, "schema": { "title": "key", "type": "string" } }, { "name": "oauthToken", "type": "string", "info": "OAuth 2.0 token for the current user.: string", "required": false, "schema": { "title": "oauthToken", "type": "string" } }, { "name": "prettyPrint", "type": "boolean", "info": "Returns response with indentations and line breaks.: boolean", "required": false, "schema": { "title": "prettyPrint", "type": "boolean" } }, { "name": "quotaUser", "type": "string", "info": "An opaque string that represents a user for quota purposes. Must not exceed 40 characters.: string", "required": false, "schema": { "title": "quotaUser", "type": "string" } }, { "name": "userIp", "type": "string", "info": "Deprecated. Please use quotaUser instead.: string", "required": false, "schema": { "title": "userIp", "type": "string" } }, { "name": "requestId", "type": "string", "info": "An ID, such as a random UUID, which uniquely identifies this user's request for idempotent creation of a shared drive. A repeated request by the same user and with the sa...(description truncated): string", "required": true, "schema": { "title": "requestId", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"backgroundImageFile\": {\"id\": \"string\", \"width\": 123, \"xCoordinate\": 123, \"yCoordinate\": 123}, \"backgroundImageLink\": \"string\", \"capabilities\": {\"canAddChildren\": \"boolean\", \"canChangeCopyRequiresWriterPermissionRestriction\": \"boolean\", \"canChangeDomainUsersOnlyRestriction\": \"boolean\", \"canChangeDriveBackground\": \"boolean\", \"canChangeDriveMembersOnlyRestriction\": \"boolean\", \"canComment\": \"boolean\", \"canCopy\": \"boolean\", \"canDeleteChildren\": \"boolean\", \"canDeleteDrive\": \"boolean\", \"canDownload\": \"boolean\", \"canEdit\": \"boolean\", \"canListChildren\": \"boolean\", \"canManageMembers\": \"boolean\", \"canReadRevisions\": \"boolean\", \"canRename\": \"boolean\", \"canRenameDrive\": \"boolean\", \"canShare\": \"boolean\", \"canTrashChildren\": \"boolean\"}, \"colorRgb\": \"string\", \"createdTime\": \"string\", \"hidden\": \"boolean\", \"id\": \"string\", \"kind\": \"string\", \"name\": \"string\", \"orgUnitId\": \"string\", \"restrictions\": {\"adminManagedRestrictions\": \"boolean\", \"copyRequiresWriterPermission\": \"boolean\", \"domainUsersOnly\": \"boolean\", \"driveMembersOnly\": \"boolean\"}, \"themeId\": \"string\"}", "required": false, "schema": { "description": "Representation of a shared drive.", "properties": { "backgroundImageFile": { "description": "An image file and cropping parameters from which a background image for this shared drive is set. This is a write only field; it can only be set on drive.drives.update requests that don't set themeId. When specified, all fields of the backgroundImageFile must be set.", "properties": { "id": { "description": "The ID of an image file in Google Drive to use for the background image.", "type": "string" }, "width": { "description": "The width of the cropped image in the closed range of 0 to 1. This value represents the width of the cropped image divided by the width of the entire image. The height is computed by applying a width to height aspect ratio of 80 to 9. The resulting image must be at least 1280 pixels wide and 144 pixels high.", "type": "number" }, "xCoordinate": { "description": "The X coordinate of the upper left corner of the cropping area in the background image. This is a value in the closed range of 0 to 1. This value represents the horizontal distance from the left side of the entire image to the left side of the cropping area divided by the width of the entire image.", "type": "number" }, "yCoordinate": { "description": "The Y coordinate of the upper left corner of the cropping area in the background image. This is a value in the closed range of 0 to 1. This value represents the vertical distance from the top side of the entire image to the top side of the cropping area divided by the height of the entire image.", "type": "number" } }, "type": "object" }, "backgroundImageLink": { "description": "A short-lived link to this shared drive's background image.", "type": "string" }, "capabilities": { "description": "Capabilities the current user has on this shared drive.", "properties": { "canAddChildren": { "description": "Whether the current user can add children to folders in this shared drive.", "type": "boolean" }, "canChangeCopyRequiresWriterPermissionRestriction": { "description": "Whether the current user can change the copyRequiresWriterPermission restriction of this shared drive.", "type": "boolean" }, "canChangeDomainUsersOnlyRestriction": { "description": "Whether the current user can change the domainUsersOnly restriction of this shared drive.", "type": "boolean" }, "canChangeDriveBackground": { "description": "Whether the current user can change the background of this shared drive.", "type": "boolean" }, "canChangeDriveMembersOnlyRestriction": { "description": "Whether the current user can change the driveMembersOnly restriction of this shared drive.", "type": "boolean" }, "canComment": { "description": "Whether the current user can comment on files in this shared drive.", "type": "boolean" }, "canCopy": { "description": "Whether the current user can copy files in this shared drive.", "type": "boolean" }, "canDeleteChildren": { "description": "Whether the current user can delete children from folders in this shared drive.", "type": "boolean" }, "canDeleteDrive": { "description": "Whether the current user can delete this shared drive. Attempting to delete the shared drive may still fail if there are untrashed items inside the shared drive.", "type": "boolean" }, "canDownload": { "description": "Whether the current user can download files in this shared drive.", "type": "boolean" }, "canEdit": { "description": "Whether the current user can edit files in this shared drive", "type": "boolean" }, "canListChildren": { "description": "Whether the current user can list the children of folders in this shared drive.", "type": "boolean" }, "canManageMembers": { "description": "Whether the current user can add members to this shared drive or remove them or change their role.", "type": "boolean" }, "canReadRevisions": { "description": "Whether the current user can read the revisions resource of files in this shared drive.", "type": "boolean" }, "canRename": { "description": "Whether the current user can rename files or folders in this shared drive.", "type": "boolean" }, "canRenameDrive": { "description": "Whether the current user can rename this shared drive.", "type": "boolean" }, "canShare": { "description": "Whether the current user can share files or folders in this shared drive.", "type": "boolean" }, "canTrashChildren": { "description": "Whether the current user can trash children from folders in this shared drive.", "type": "boolean" } }, "type": "object" }, "colorRgb": { "description": "The color of this shared drive as an RGB hex string. It can only be set on a drive.drives.update request that does not set themeId.", "type": "string" }, "createdTime": { "description": "The time at which the shared drive was created (RFC 3339 date-time).", "type": "string" }, "hidden": { "description": "Whether the shared drive is hidden from default view.", "type": "boolean" }, "id": { "description": "The ID of this shared drive which is also the ID of the top level folder of this shared drive.", "type": "string" }, "kind": { "default": "drive#drive", "description": "Identifies what kind of resource this is. Value: the fixed string \"drive#drive\".", "type": "string" }, "name": { "description": "The name of this shared drive.", "type": "string" }, "orgUnitId": { "description": "The organizational unit of this shared drive. This field is only populated on drives.list responses when the useDomainAdminAccess parameter is set to true.", "type": "string" }, "restrictions": { "description": "A set of restrictions that apply to this shared drive or items inside this shared drive.", "properties": { "adminManagedRestrictions": { "description": "Whether administrative privileges on this shared drive are required to modify restrictions.", "type": "boolean" }, "copyRequiresWriterPermission": { "description": "Whether the options to copy, print, or download files inside this shared drive, should be disabled for readers and commenters. When this restriction is set to true, it will override the similarly named field to true for any file inside this shared drive.", "type": "boolean" }, "domainUsersOnly": { "description": "Whether access to this shared drive and items inside this shared drive is restricted to users of the domain to which this shared drive belongs. This restriction may be overridden by other sharing policies controlled outside of this shared drive.", "type": "boolean" }, "driveMembersOnly": { "description": "Whether access to items inside this shared drive is restricted to its members.", "type": "boolean" } }, "type": "object" }, "themeId": { "description": "The ID of the theme from which the background image and color will be set. The set of possible driveThemes can be retrieved from a drive.about.get response. When not specified on a drive.drives.create request, a random theme is chosen from which the background image and color are set. This is a write-only field; it can only be set on requests that don't set colorRgb or backgroundImageFile.", "type": "string" } }, "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/driveDrivesCreate" }, "task": true }, { "name": "driveDrivesDelete", "summary": "Permanently deletes a shared drive for which the user is an organizer. The shared drive cannot cont", "description": "Permanently deletes a shared drive for which the user is an organizer. The shared drive cannot contain any untrashed items.", "input": [ { "name": "alt", "type": "string", "info": "Data format for the response.: Must be one of [json]", "required": false, "schema": { "title": "alt", "type": "string" } }, { "name": "fields", "type": "string", "info": "Selector specifying which fields to include in a partial response.: string", "required": false, "schema": { "title": "fields", "type": "string" } }, { "name": "key", "type": "string", "info": "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.: string", "required": false, "schema": { "title": "key", "type": "string" } }, { "name": "oauthToken", "type": "string", "info": "OAuth 2.0 token for the current user.: string", "required": false, "schema": { "title": "oauthToken", "type": "string" } }, { "name": "prettyPrint", "type": "boolean", "info": "Returns response with indentations and line breaks.: boolean", "required": false, "schema": { "title": "prettyPrint", "type": "boolean" } }, { "name": "quotaUser", "type": "string", "info": "An opaque string that represents a user for quota purposes. Must not exceed 40 characters.: string", "required": false, "schema": { "title": "quotaUser", "type": "string" } }, { "name": "userIp", "type": "string", "info": "Deprecated. Please use quotaUser instead.: string", "required": false, "schema": { "title": "userIp", "type": "string" } }, { "name": "driveId", "type": "string", "info": "The ID of the shared drive.: string", "required": true, "schema": { "title": "driveId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/driveDrivesDelete" }, "task": true }, { "name": "driveDrivesGet", "summary": "Gets a shared drive's metadata by ID.", "description": "Gets a shared drive's metadata by ID.", "input": [ { "name": "alt", "type": "string", "info": "Data format for the response.: Must be one of [json]", "required": false, "schema": { "title": "alt", "type": "string" } }, { "name": "fields", "type": "string", "info": "Selector specifying which fields to include in a partial response.: string", "required": false, "schema": { "title": "fields", "type": "string" } }, { "name": "key", "type": "string", "info": "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.: string", "required": false, "schema": { "title": "key", "type": "string" } }, { "name": "oauthToken", "type": "string", "info": "OAuth 2.0 token for the current user.: string", "required": false, "schema": { "title": "oauthToken", "type": "string" } }, { "name": "prettyPrint", "type": "boolean", "info": "Returns response with indentations and line breaks.: boolean", "required": false, "schema": { "title": "prettyPrint", "type": "boolean" } }, { "name": "quotaUser", "type": "string", "info": "An opaque string that represents a user for quota purposes. Must not exceed 40 characters.: string", "required": false, "schema": { "title": "quotaUser", "type": "string" } }, { "name": "userIp", "type": "string", "info": "Deprecated. Please use quotaUser instead.: string", "required": false, "schema": { "title": "userIp", "type": "string" } }, { "name": "driveId", "type": "string", "info": "The ID of the shared drive.: string", "required": true, "schema": { "title": "driveId", "type": "string" } }, { "name": "useDomainAdminAccess", "type": "boolean", "info": "Issue the request as a domain administrator; if set to true, then the requester will be granted access if they are an administrator of the domain to which the shared driv...(description truncated): boolean", "required": false, "schema": { "title": "useDomainAdminAccess", "type": "boolean" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/driveDrivesGet" }, "task": true }, { "name": "driveDrivesUpdate", "summary": "Updates the metadate for a shared drive.", "description": "Updates the metadate for a shared drive.", "input": [ { "name": "alt", "type": "string", "info": "Data format for the response.: Must be one of [json]", "required": false, "schema": { "title": "alt", "type": "string" } }, { "name": "fields", "type": "string", "info": "Selector specifying which fields to include in a partial response.: string", "required": false, "schema": { "title": "fields", "type": "string" } }, { "name": "key", "type": "string", "info": "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.: string", "required": false, "schema": { "title": "key", "type": "string" } }, { "name": "oauthToken", "type": "string", "info": "OAuth 2.0 token for the current user.: string", "required": false, "schema": { "title": "oauthToken", "type": "string" } }, { "name": "prettyPrint", "type": "boolean", "info": "Returns response with indentations and line breaks.: boolean", "required": false, "schema": { "title": "prettyPrint", "type": "boolean" } }, { "name": "quotaUser", "type": "string", "info": "An opaque string that represents a user for quota purposes. Must not exceed 40 characters.: string", "required": false, "schema": { "title": "quotaUser", "type": "string" } }, { "name": "userIp", "type": "string", "info": "Deprecated. Please use quotaUser instead.: string", "required": false, "schema": { "title": "userIp", "type": "string" } }, { "name": "driveId", "type": "string", "info": "The ID of the shared drive.: string", "required": true, "schema": { "title": "driveId", "type": "string" } }, { "name": "useDomainAdminAccess", "type": "boolean", "info": "Issue the request as a domain administrator; if set to true, then the requester will be granted access if they are an administrator of the domain to which the shared driv...(description truncated): boolean", "required": false, "schema": { "title": "useDomainAdminAccess", "type": "boolean" } }, { "name": "body", "type": "object", "info": ": {\"backgroundImageFile\": {\"id\": \"string\", \"width\": 123, \"xCoordinate\": 123, \"yCoordinate\": 123}, \"backgroundImageLink\": \"string\", \"capabilities\": {\"canAddChildren\": \"boolean\", \"canChangeCopyRequiresWriterPermissionRestriction\": \"boolean\", \"canChangeDomainUsersOnlyRestriction\": \"boolean\", \"canChangeDriveBackground\": \"boolean\", \"canChangeDriveMembersOnlyRestriction\": \"boolean\", \"canComment\": \"boolean\", \"canCopy\": \"boolean\", \"canDeleteChildren\": \"boolean\", \"canDeleteDrive\": \"boolean\", \"canDownload\": \"boolean\", \"canEdit\": \"boolean\", \"canListChildren\": \"boolean\", \"canManageMembers\": \"boolean\", \"canReadRevisions\": \"boolean\", \"canRename\": \"boolean\", \"canRenameDrive\": \"boolean\", \"canShare\": \"boolean\", \"canTrashChildren\": \"boolean\"}, \"colorRgb\": \"string\", \"createdTime\": \"string\", \"hidden\": \"boolean\", \"id\": \"string\", \"kind\": \"string\", \"name\": \"string\", \"orgUnitId\": \"string\", \"restrictions\": {\"adminManagedRestrictions\": \"boolean\", \"copyRequiresWriterPermission\": \"boolean\", \"domainUsersOnly\": \"boolean\", \"driveMembersOnly\": \"boolean\"}, \"themeId\": \"string\"}", "required": false, "schema": { "description": "Representation of a shared drive.", "properties": { "backgroundImageFile": { "description": "An image file and cropping parameters from which a background image for this shared drive is set. This is a write only field; it can only be set on drive.drives.update requests that don't set themeId. When specified, all fields of the backgroundImageFile must be set.", "properties": { "id": { "description": "The ID of an image file in Google Drive to use for the background image.", "type": "string" }, "width": { "description": "The width of the cropped image in the closed range of 0 to 1. This value represents the width of the cropped image divided by the width of the entire image. The height is computed by applying a width to height aspect ratio of 80 to 9. The resulting image must be at least 1280 pixels wide and 144 pixels high.", "type": "number" }, "xCoordinate": { "description": "The X coordinate of the upper left corner of the cropping area in the background image. This is a value in the closed range of 0 to 1. This value represents the horizontal distance from the left side of the entire image to the left side of the cropping area divided by the width of the entire image.", "type": "number" }, "yCoordinate": { "description": "The Y coordinate of the upper left corner of the cropping area in the background image. This is a value in the closed range of 0 to 1. This value represents the vertical distance from the top side of the entire image to the top side of the cropping area divided by the height of the entire image.", "type": "number" } }, "type": "object" }, "backgroundImageLink": { "description": "A short-lived link to this shared drive's background image.", "type": "string" }, "capabilities": { "description": "Capabilities the current user has on this shared drive.", "properties": { "canAddChildren": { "description": "Whether the current user can add children to folders in this shared drive.", "type": "boolean" }, "canChangeCopyRequiresWriterPermissionRestriction": { "description": "Whether the current user can change the copyRequiresWriterPermission restriction of this shared drive.", "type": "boolean" }, "canChangeDomainUsersOnlyRestriction": { "description": "Whether the current user can change the domainUsersOnly restriction of this shared drive.", "type": "boolean" }, "canChangeDriveBackground": { "description": "Whether the current user can change the background of this shared drive.", "type": "boolean" }, "canChangeDriveMembersOnlyRestriction": { "description": "Whether the current user can change the driveMembersOnly restriction of this shared drive.", "type": "boolean" }, "canComment": { "description": "Whether the current user can comment on files in this shared drive.", "type": "boolean" }, "canCopy": { "description": "Whether the current user can copy files in this shared drive.", "type": "boolean" }, "canDeleteChildren": { "description": "Whether the current user can delete children from folders in this shared drive.", "type": "boolean" }, "canDeleteDrive": { "description": "Whether the current user can delete this shared drive. Attempting to delete the shared drive may still fail if there are untrashed items inside the shared drive.", "type": "boolean" }, "canDownload": { "description": "Whether the current user can download files in this shared drive.", "type": "boolean" }, "canEdit": { "description": "Whether the current user can edit files in this shared drive", "type": "boolean" }, "canListChildren": { "description": "Whether the current user can list the children of folders in this shared drive.", "type": "boolean" }, "canManageMembers": { "description": "Whether the current user can add members to this shared drive or remove them or change their role.", "type": "boolean" }, "canReadRevisions": { "description": "Whether the current user can read the revisions resource of files in this shared drive.", "type": "boolean" }, "canRename": { "description": "Whether the current user can rename files or folders in this shared drive.", "type": "boolean" }, "canRenameDrive": { "description": "Whether the current user can rename this shared drive.", "type": "boolean" }, "canShare": { "description": "Whether the current user can share files or folders in this shared drive.", "type": "boolean" }, "canTrashChildren": { "description": "Whether the current user can trash children from folders in this shared drive.", "type": "boolean" } }, "type": "object" }, "colorRgb": { "description": "The color of this shared drive as an RGB hex string. It can only be set on a drive.drives.update request that does not set themeId.", "type": "string" }, "createdTime": { "description": "The time at which the shared drive was created (RFC 3339 date-time).", "type": "string" }, "hidden": { "description": "Whether the shared drive is hidden from default view.", "type": "boolean" }, "id": { "description": "The ID of this shared drive which is also the ID of the top level folder of this shared drive.", "type": "string" }, "kind": { "default": "drive#drive", "description": "Identifies what kind of resource this is. Value: the fixed string \"drive#drive\".", "type": "string" }, "name": { "description": "The name of this shared drive.", "type": "string" }, "orgUnitId": { "description": "The organizational unit of this shared drive. This field is only populated on drives.list responses when the useDomainAdminAccess parameter is set to true.", "type": "string" }, "restrictions": { "description": "A set of restrictions that apply to this shared drive or items inside this shared drive.", "properties": { "adminManagedRestrictions": { "description": "Whether administrative privileges on this shared drive are required to modify restrictions.", "type": "boolean" }, "copyRequiresWriterPermission": { "description": "Whether the options to copy, print, or download files inside this shared drive, should be disabled for readers and commenters. When this restriction is set to true, it will override the similarly named field to true for any file inside this shared drive.", "type": "boolean" }, "domainUsersOnly": { "description": "Whether access to this shared drive and items inside this shared drive is restricted to users of the domain to which this shared drive belongs. This restriction may be overridden by other sharing policies controlled outside of this shared drive.", "type": "boolean" }, "driveMembersOnly": { "description": "Whether access to items inside this shared drive is restricted to its members.", "type": "boolean" } }, "type": "object" }, "themeId": { "description": "The ID of the theme from which the background image and color will be set. The set of possible driveThemes can be retrieved from a drive.about.get response. When not specified on a drive.drives.create request, a random theme is chosen from which the background image and color are set. This is a write-only field; it can only be set on requests that don't set colorRgb or backgroundImageFile.", "type": "string" } }, "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/driveDrivesUpdate" }, "task": true }, { "name": "driveDrivesHide", "summary": "Hides a shared drive from the default view.", "description": "Hides a shared drive from the default view.", "input": [ { "name": "alt", "type": "string", "info": "Data format for the response.: Must be one of [json]", "required": false, "schema": { "title": "alt", "type": "string" } }, { "name": "fields", "type": "string", "info": "Selector specifying which fields to include in a partial response.: string", "required": false, "schema": { "title": "fields", "type": "string" } }, { "name": "key", "type": "string", "info": "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.: string", "required": false, "schema": { "title": "key", "type": "string" } }, { "name": "oauthToken", "type": "string", "info": "OAuth 2.0 token for the current user.: string", "required": false, "schema": { "title": "oauthToken", "type": "string" } }, { "name": "prettyPrint", "type": "boolean", "info": "Returns response with indentations and line breaks.: boolean", "required": false, "schema": { "title": "prettyPrint", "type": "boolean" } }, { "name": "quotaUser", "type": "string", "info": "An opaque string that represents a user for quota purposes. Must not exceed 40 characters.: string", "required": false, "schema": { "title": "quotaUser", "type": "string" } }, { "name": "userIp", "type": "string", "info": "Deprecated. Please use quotaUser instead.: string", "required": false, "schema": { "title": "userIp", "type": "string" } }, { "name": "driveId", "type": "string", "info": "The ID of the shared drive.: string", "required": true, "schema": { "title": "driveId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/driveDrivesHide" }, "task": true }, { "name": "driveDrivesUnhide", "summary": "Restores a shared drive to the default view.", "description": "Restores a shared drive to the default view.", "input": [ { "name": "alt", "type": "string", "info": "Data format for the response.: Must be one of [json]", "required": false, "schema": { "title": "alt", "type": "string" } }, { "name": "fields", "type": "string", "info": "Selector specifying which fields to include in a partial response.: string", "required": false, "schema": { "title": "fields", "type": "string" } }, { "name": "key", "type": "string", "info": "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.: string", "required": false, "schema": { "title": "key", "type": "string" } }, { "name": "oauthToken", "type": "string", "info": "OAuth 2.0 token for the current user.: string", "required": false, "schema": { "title": "oauthToken", "type": "string" } }, { "name": "prettyPrint", "type": "boolean", "info": "Returns response with indentations and line breaks.: boolean", "required": false, "schema": { "title": "prettyPrint", "type": "boolean" } }, { "name": "quotaUser", "type": "string", "info": "An opaque string that represents a user for quota purposes. Must not exceed 40 characters.: string", "required": false, "schema": { "title": "quotaUser", "type": "string" } }, { "name": "userIp", "type": "string", "info": "Deprecated. Please use quotaUser instead.: string", "required": false, "schema": { "title": "userIp", "type": "string" } }, { "name": "driveId", "type": "string", "info": "The ID of the shared drive.: string", "required": true, "schema": { "title": "driveId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/driveDrivesUnhide" }, "task": true }, { "name": "driveFilesList", "summary": "Lists or searches files.", "description": "Lists or searches files.", "input": [ { "name": "alt", "type": "string", "info": "Data format for the response.: Must be one of [json]", "required": false, "schema": { "title": "alt", "type": "string" } }, { "name": "fields", "type": "string", "info": "Selector specifying which fields to include in a partial response.: string", "required": false, "schema": { "title": "fields", "type": "string" } }, { "name": "key", "type": "string", "info": "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.: string", "required": false, "schema": { "title": "key", "type": "string" } }, { "name": "oauthToken", "type": "string", "info": "OAuth 2.0 token for the current user.: string", "required": false, "schema": { "title": "oauthToken", "type": "string" } }, { "name": "prettyPrint", "type": "boolean", "info": "Returns response with indentations and line breaks.: boolean", "required": false, "schema": { "title": "prettyPrint", "type": "boolean" } }, { "name": "quotaUser", "type": "string", "info": "An opaque string that represents a user for quota purposes. Must not exceed 40 characters.: string", "required": false, "schema": { "title": "quotaUser", "type": "string" } }, { "name": "userIp", "type": "string", "info": "Deprecated. Please use quotaUser instead.: string", "required": false, "schema": { "title": "userIp", "type": "string" } }, { "name": "corpora", "type": "string", "info": "Groupings of files to which the query applies. Supported groupings are: 'user' (files created by, opened by, or shared directly with the user), 'drive' (files in the spec...(description truncated): string", "required": false, "schema": { "title": "corpora", "type": "string" } }, { "name": "corpus", "type": "string", "info": "The source of files to list. Deprecated: use 'corpora' instead.: Must be one of [domain, user]", "required": false, "schema": { "title": "corpus", "type": "string" } }, { "name": "driveId", "type": "string", "info": "ID of the shared drive to search.: string", "required": false, "schema": { "title": "driveId", "type": "string" } }, { "name": "includeItemsFromAllDrives", "type": "boolean", "info": "Whether both My Drive and shared drive items should be included in results.: boolean", "required": false, "schema": { "title": "includeItemsFromAllDrives", "type": "boolean" } }, { "name": "includePermissionsForView", "type": "string", "info": "Specifies which additional view's permissions to include in the response. Only 'published' is supported.: string", "required": false, "schema": { "title": "includePermissionsForView", "type": "string" } }, { "name": "includeTeamDriveItems", "type": "boolean", "info": "Deprecated use includeItemsFromAllDrives instead.: boolean", "required": false, "schema": { "title": "includeTeamDriveItems", "type": "boolean" } }, { "name": "orderBy", "type": "string", "info": "A comma-separated list of sort keys. Valid keys are 'createdTime', 'folder', 'modifiedByMeTime', 'modifiedTime', 'name', 'name_natural', 'quotaBytesUsed', 'recency', 'sha...(description truncated): string", "required": false, "schema": { "title": "orderBy", "type": "string" } }, { "name": "pageSize", "type": "number", "info": "The maximum number of files to return per page. Partial or empty result pages are possible even before the end of the files list has been reached.: 123", "required": false, "schema": { "title": "pageSize", "type": "number" } }, { "name": "pageToken", "type": "string", "info": "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.: string", "required": false, "schema": { "title": "pageToken", "type": "string" } }, { "name": "q", "type": "string", "info": "A query for filtering the file results. See the \"Search for Files\" guide for supported syntax.: string", "required": false, "schema": { "title": "q", "type": "string" } }, { "name": "spaces", "type": "string", "info": "A comma-separated list of spaces to query within the corpus. Supported values are 'drive' and 'appDataFolder'.: string", "required": false, "schema": { "title": "spaces", "type": "string" } }, { "name": "supportsAllDrives", "type": "boolean", "info": "Whether the requesting application supports both My Drives and shared drives.: boolean", "required": false, "schema": { "title": "supportsAllDrives", "type": "boolean" } }, { "name": "supportsTeamDrives", "type": "boolean", "info": "Deprecated use supportsAllDrives instead.: boolean", "required": false, "schema": { "title": "supportsTeamDrives", "type": "boolean" } }, { "name": "teamDriveId", "type": "string", "info": "Deprecated use driveId instead.: string", "required": false, "schema": { "title": "teamDriveId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/driveFilesList" }, "task": true }, { "name": "driveFilesCreate", "summary": "Creates a new file.", "description": "Creates a new file.", "input": [ { "name": "alt", "type": "string", "info": "Data format for the response.: Must be one of [json]", "required": false, "schema": { "title": "alt", "type": "string" } }, { "name": "fields", "type": "string", "info": "Selector specifying which fields to include in a partial response.: string", "required": false, "schema": { "title": "fields", "type": "string" } }, { "name": "key", "type": "string", "info": "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.: string", "required": false, "schema": { "title": "key", "type": "string" } }, { "name": "oauthToken", "type": "string", "info": "OAuth 2.0 token for the current user.: string", "required": false, "schema": { "title": "oauthToken", "type": "string" } }, { "name": "prettyPrint", "type": "boolean", "info": "Returns response with indentations and line breaks.: boolean", "required": false, "schema": { "title": "prettyPrint", "type": "boolean" } }, { "name": "quotaUser", "type": "string", "info": "An opaque string that represents a user for quota purposes. Must not exceed 40 characters.: string", "required": false, "schema": { "title": "quotaUser", "type": "string" } }, { "name": "userIp", "type": "string", "info": "Deprecated. Please use quotaUser instead.: string", "required": false, "schema": { "title": "userIp", "type": "string" } }, { "name": "enforceSingleParent", "type": "boolean", "info": "Deprecated. Creating files in multiple folders is no longer supported.: boolean", "required": false, "schema": { "title": "enforceSingleParent", "type": "boolean" } }, { "name": "ignoreDefaultVisibility", "type": "boolean", "info": "Whether to ignore the domain's default visibility settings for the created file. Domain administrators can choose to make all uploaded files visible to the domain by defa...(description truncated): boolean", "required": false, "schema": { "title": "ignoreDefaultVisibility", "type": "boolean" } }, { "name": "includePermissionsForView", "type": "string", "info": "Specifies which additional view's permissions to include in the response. Only 'published' is supported.: string", "required": false, "schema": { "title": "includePermissionsForView", "type": "string" } }, { "name": "keepRevisionForever", "type": "boolean", "info": "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...(description truncated): boolean", "required": false, "schema": { "title": "keepRevisionForever", "type": "boolean" } }, { "name": "ocrLanguage", "type": "string", "info": "A language hint for OCR processing during image import (ISO 639-1 code).: string", "required": false, "schema": { "title": "ocrLanguage", "type": "string" } }, { "name": "supportsAllDrives", "type": "boolean", "info": "Whether the requesting application supports both My Drives and shared drives.: boolean", "required": false, "schema": { "title": "supportsAllDrives", "type": "boolean" } }, { "name": "supportsTeamDrives", "type": "boolean", "info": "Deprecated use supportsAllDrives instead.: boolean", "required": false, "schema": { "title": "supportsTeamDrives", "type": "boolean" } }, { "name": "useContentAsIndexableText", "type": "boolean", "info": "Whether to use the uploaded content as indexable text.: boolean", "required": false, "schema": { "title": "useContentAsIndexableText", "type": "boolean" } }, { "name": "body", "type": "object", "info": ": {\"appProperties\": \"object\", \"capabilities\": {\"canAcceptOwnership\": \"boolean\", \"canAddChildren\": \"boolean\", \"canAddFolderFromAnotherDrive\": \"boolean\", \"canAddMyDriveParent\": \"boolean\", \"canChangeCopyRequiresWriterPermission\": \"boolean\", \"canChangeSecurityUpdateEnabled\": \"boolean\", \"canChangeViewersCanCopyContent\": \"boolean\", \"canComment\": \"boolean\", \"canCopy\": \"boolean\", \"canDelete\": \"boolean\", \"canDeleteChildren\": \"boolean\", \"canDownload\": \"boolean\", \"canEdit\": \"boolean\", \"canListChildren\": \"boolean\", \"canModifyContent\": \"boolean\", \"canModifyContentRestriction\": \"boolean\", \"canMoveChildrenOutOfDrive\": \"boolean\", \"canMoveChildrenOutOfTeamDrive\": \"boolean\", \"canMoveChildrenWithinDrive\": \"boolean\", \"canMoveChildrenWithinTeamDrive\": \"boolean\", \"canMoveItemIntoTeamDrive\": \"boolean\", \"canMoveItemOutOfDrive\": \"boolean\", \"canMoveItemOutOfTeamDrive\": \"boolean\", \"canMoveItemWithinDrive\": \"boolean\", \"canMoveItemWithinTeamDrive\": \"boolean\", \"canMoveTeamDriveItem\": \"boolean\", \"canReadDrive\": \"boolean\", \"canReadRevisions\": \"boolean\", \"canReadTeamDrive\": \"boolean\", \"canRemoveChildren\": \"boolean\", \"canRemoveMyDriveParent\": \"boolean\", \"canRename\": \"boolean\", \"canShare\": \"boolean\", \"canTrash\": \"boolean\", \"canTrashChildren\": \"boolean\", \"canUntrash\": \"boolean\"}, \"contentHints\": {\"indexableText\": \"string\", \"thumbnail\": {\"image\": \"string\", \"mimeType\": \"string\"}}, \"contentRestrictions\": [{\"readOnly\": \"boolean\", \"reason\": \"string\", \"restrictingUser\": {\"displayName\": \"string\", \"emailAddress\": \"string\", \"kind\": \"string\", \"me\": \"boolean\", \"permissionId\": \"string\", \"photoLink\": \"string\"}, \"restrictionTime\": \"string\", \"type\": \"string\"}], \"copyRequiresWriterPermission\": \"boolean\", \"createdTime\": \"string\", \"description\": \"string\", \"driveId\": \"string\", \"explicitlyTrashed\": \"boolean\", \"exportLinks\": \"object\", \"fileExtension\": \"string\", \"folderColorRgb\": \"string\", \"fullFileExtension\": \"string\", \"hasAugmentedPermissions\": \"boolean\", \"hasThumbnail\": \"boolean\", \"headRevisionId\": \"string\", \"iconLink\": \"string\", \"id\": \"string\", \"imageMediaMetadata\": {\"aperture\": 123, \"cameraMake\": \"string\", \"cameraModel\": \"string\", \"colorSpace\": \"string\", \"exposureBias\": 123, \"exposureMode\": \"string\", \"exposureTime\": 123, \"flashUsed\": \"boolean\", \"focalLength\": 123, \"height\": 123, \"isoSpeed\": 123, \"lens\": \"string\", \"location\": {\"altitude\": 123, \"latitude\": 123, \"longitude\": 123}, \"maxApertureValue\": 123, \"meteringMode\": \"string\", \"rotation\": 123, \"sensor\": \"string\", \"subjectDistance\": 123, \"time\": \"string\", \"whiteBalance\": \"string\", \"width\": 123}, \"isAppAuthorized\": \"boolean\", \"kind\": \"string\", \"lastModifyingUser\": {\"displayName\": \"string\", \"emailAddress\": \"string\", \"kind\": \"string\", \"me\": \"boolean\", \"permissionId\": \"string\", \"photoLink\": \"string\"}, \"linkShareMetadata\": {\"securityUpdateEligible\": \"boolean\", \"securityUpdateEnabled\": \"boolean\"}, \"md5Checksum\": \"string\", \"mimeType\": \"string\", \"modifiedByMe\": \"boolean\", \"modifiedByMeTime\": \"string\", \"modifiedTime\": \"string\", \"name\": \"string\", \"originalFilename\": \"string\", \"ownedByMe\": \"boolean\", \"owners\": [{\"displayName\": \"string\", \"emailAddress\": \"string\", \"kind\": \"string\", \"me\": \"boolean\", \"permissionId\": \"string\", \"photoLink\": \"string\"}], \"parents\": \"array\", \"permissionIds\": \"array\", \"permissions\": [{\"allowFileDiscovery\": \"boolean\", \"deleted\": \"boolean\", \"displayName\": \"string\", \"domain\": \"string\", \"emailAddress\": \"string\", \"expirationTime\": \"string\", \"id\": \"string\", \"kind\": \"string\", \"pendingOwner\": \"boolean\", \"permissionDetails\": [{\"inherited\": \"boolean\", \"inheritedFrom\": \"string\", \"permissionType\": \"string\", \"role\": \"string\"}], \"photoLink\": \"string\", \"role\": \"string\", \"teamDrivePermissionDetails\": [{\"inherited\": \"boolean\", \"inheritedFrom\": \"string\", \"role\": \"string\", \"teamDrivePermissionType\": \"string\"}], \"type\": \"string\", \"view\": \"string\"}], \"properties\": \"object\", \"quotaBytesUsed\": \"string\", \"resourceKey\": \"string\", \"shared\": \"boolean\", \"sharedWithMeTime\": \"string\", \"sharingUser\": {\"displayName\": \"string\", \"emailAddress\": \"string\", \"kind\": \"string\", \"me\": \"boolean\", \"permissionId\": \"string\", \"photoLink\": \"string\"}, \"shortcutDetails\": {\"targetId\": \"string\", \"targetMimeType\": \"string\", \"targetResourceKey\": \"string\"}, \"size\": \"string\", \"spaces\": \"array\", \"starred\": \"boolean\", \"teamDriveId\": \"string\", \"thumbnailLink\": \"string\", \"thumbnailVersion\": \"string\", \"trashed\": \"boolean\", \"trashedTime\": \"string\", \"trashingUser\": {\"displayName\": \"string\", \"emailAddress\": \"string\", \"kind\": \"string\", \"me\": \"boolean\", \"permissionId\": \"string\", \"photoLink\": \"string\"}, \"version\": \"string\", \"videoMediaMetadata\": {\"durationMillis\": \"string\", \"height\": 123, \"width\": 123}, \"viewedByMe\": \"boolean\", \"viewedByMeTime\": \"string\", \"viewersCanCopyContent\": \"boolean\", \"webContentLink\": \"string\", \"webViewLink\": \"string\", \"writersCanShare\": \"boolean\"}", "required": false, "schema": { "description": "The metadata for a file.", "properties": { "appProperties": { "additionalProperties": { "type": "string" }, "description": "A collection of arbitrary key-value pairs which are private to the requesting app.\nEntries with null values are cleared in update and copy requests. These properties can only be retrieved using an authenticated request. An authenticated request uses an access token obtained with a OAuth 2 client ID. You cannot use an API key to retrieve private properties.", "type": "object" }, "capabilities": { "description": "Capabilities the current user has on this file. Each capability corresponds to a fine-grained action that a user may take.", "properties": { "canAcceptOwnership": { "description": "Whether the current user is the pending owner of the file. Not populated for shared drive files.", "type": "boolean" }, "canAddChildren": { "description": "Whether the current user can add children to this folder. This is always false when the item is not a folder.", "type": "boolean" }, "canAddFolderFromAnotherDrive": { "description": "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 is not a folder. Only populated for items in shared drives.", "type": "boolean" }, "canAddMyDriveParent": { "description": "Whether the current user can add a parent for the item without removing an existing parent in the same request. Not populated for shared drive files.", "type": "boolean" }, "canChangeCopyRequiresWriterPermission": { "description": "Whether the current user can change the copyRequiresWriterPermission restriction of this file.", "type": "boolean" }, "canChangeSecurityUpdateEnabled": { "description": "Whether the current user can change the securityUpdateEnabled field on link share metadata.", "type": "boolean" }, "canChangeViewersCanCopyContent": { "description": "Deprecated", "type": "boolean" }, "canComment": { "description": "Whether the current user can comment on this file.", "type": "boolean" }, "canCopy": { "description": "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 itself if it is not a folder.", "type": "boolean" }, "canDelete": { "description": "Whether the current user can delete this file.", "type": "boolean" }, "canDeleteChildren": { "description": "Whether the current user can delete children of this folder. This is false when the item is not a folder. Only populated for items in shared drives.", "type": "boolean" }, "canDownload": { "description": "Whether the current user can download this file.", "type": "boolean" }, "canEdit": { "description": "Whether the current user can edit this file. Other factors may limit the type of changes a user can make to a file. For example, see canChangeCopyRequiresWriterPermission or canModifyContent.", "type": "boolean" }, "canListChildren": { "description": "Whether the current user can list the children of this folder. This is always false when the item is not a folder.", "type": "boolean" }, "canModifyContent": { "description": "Whether the current user can modify the content of this file.", "type": "boolean" }, "canModifyContentRestriction": { "description": "Whether the current user can modify restrictions on content of this file.", "type": "boolean" }, "canMoveChildrenOutOfDrive": { "description": "Whether the current user can move children of this folder outside of the shared drive. This is false when the item is not a folder. Only populated for items in shared drives.", "type": "boolean" }, "canMoveChildrenOutOfTeamDrive": { "description": "Deprecated - use canMoveChildrenOutOfDrive instead.", "type": "boolean" }, "canMoveChildrenWithinDrive": { "description": "Whether the current user can move children of this folder within this drive. This is false when the item is not 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.", "type": "boolean" }, "canMoveChildrenWithinTeamDrive": { "description": "Deprecated - use canMoveChildrenWithinDrive instead.", "type": "boolean" }, "canMoveItemIntoTeamDrive": { "description": "Deprecated - use canMoveItemOutOfDrive instead.", "type": "boolean" }, "canMoveItemOutOfDrive": { "description": "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 is being added.", "type": "boolean" }, "canMoveItemOutOfTeamDrive": { "description": "Deprecated - use canMoveItemOutOfDrive instead.", "type": "boolean" }, "canMoveItemWithinDrive": { "description": "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 is being added and the parent that is being removed.", "type": "boolean" }, "canMoveItemWithinTeamDrive": { "description": "Deprecated - use canMoveItemWithinDrive instead.", "type": "boolean" }, "canMoveTeamDriveItem": { "description": "Deprecated - use canMoveItemWithinDrive or canMoveItemOutOfDrive instead.", "type": "boolean" }, "canReadDrive": { "description": "Whether the current user can read the shared drive to which this file belongs. Only populated for items in shared drives.", "type": "boolean" }, "canReadRevisions": { "description": "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 itself if it is not a folder, can be read.", "type": "boolean" }, "canReadTeamDrive": { "description": "Deprecated - use canReadDrive instead.", "type": "boolean" }, "canRemoveChildren": { "description": "Whether the current user can remove children from this folder. This is always false when the item is not a folder. For a folder in a shared drive, use canDeleteChildren or canTrashChildren instead.", "type": "boolean" }, "canRemoveMyDriveParent": { "description": "Whether the current user can remove a parent from the item without adding another parent in the same request. Not populated for shared drive files.", "type": "boolean" }, "canRename": { "description": "Whether the current user can rename this file.", "type": "boolean" }, "canShare": { "description": "Whether the current user can modify the sharing settings for this file.", "type": "boolean" }, "canTrash": { "description": "Whether the current user can move this file to trash.", "type": "boolean" }, "canTrashChildren": { "description": "Whether the current user can trash children of this folder. This is false when the item is not a folder. Only populated for items in shared drives.", "type": "boolean" }, "canUntrash": { "description": "Whether the current user can restore this file from trash.", "type": "boolean" } }, "type": "object" }, "contentHints": { "description": "Additional information about the content of the file. These fields are never populated in responses.", "properties": { "indexableText": { "description": "Text to be indexed for the file to improve fullText queries. This is limited to 128KB in length and may contain HTML elements.", "type": "string" }, "thumbnail": { "description": "A thumbnail for the file. This will only be used if Google Drive cannot generate a standard thumbnail.", "properties": { "image": { "description": "The thumbnail data encoded with URL-safe Base64 (RFC 4648 section 5).", "type": "string" }, "mimeType": { "description": "The MIME type of the thumbnail.", "type": "string" } }, "type": "object" } }, "type": "object" }, "contentRestrictions": { "description": "Restrictions for accessing the content of the file. Only populated if such a restriction exists.", "items": { "description": "A restriction for accessing the content of the file.", "properties": { "readOnly": { "description": "Whether the content of the file is read-only. If a file is read-only, a new revision of the file may not be added, comments may not be added or modified, and the title of the file may not be modified.", "type": "boolean" }, "reason": { "description": "Reason for why the content of the file is restricted. This is only mutable on requests that also set readOnly=true.", "type": "string" }, "restrictingUser": { "description": "Information about a Drive user.", "properties": { "displayName": { "description": "A plain text displayable name for this user.", "type": "string" }, "emailAddress": { "description": "The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.", "type": "string" }, "kind": { "default": "drive#user", "description": "Identifies what kind of resource this is. Value: the fixed string \"drive#user\".", "type": "string" }, "me": { "description": "Whether this user is the requesting user.", "type": "boolean" }, "permissionId": { "description": "The user's ID as visible in Permission resources.", "type": "string" }, "photoLink": { "description": "A link to the user's profile photo, if available.", "type": "string" } }, "type": "object" }, "restrictionTime": { "description": "The time at which the content restriction was set (formatted RFC 3339 timestamp). Only populated if readOnly is true.", "type": "string" }, "type": { "description": "The type of the content restriction. Currently the only possible value is globalContentRestriction.", "type": "string" } }, "type": "object" }, "type": "array" }, "copyRequiresWriterPermission": { "description": "Whether the options to copy, print, or download this file, should be disabled for readers and commenters.", "type": "boolean" }, "createdTime": { "description": "The time at which the file was created (RFC 3339 date-time).", "type": "string" }, "description": { "description": "A short description of the file.", "type": "string" }, "driveId": { "description": "ID of the shared drive the file resides in. Only populated for items in shared drives.", "type": "string" }, "explicitlyTrashed": { "description": "Whether the file has been explicitly trashed, as opposed to recursively trashed from a parent folder.", "type": "boolean" }, "exportLinks": { "additionalProperties": { "description": "A mapping from export format to URL", "type": "string" }, "description": "Links for exporting Docs Editors files to specific formats.", "readOnly": true, "type": "object" }, "fileExtension": { "description": "The final component of fullFileExtension. This is only available for files with binary content in Google Drive.", "type": "string" }, "folderColorRgb": { "description": "The color for a folder or shortcut to a folder as an RGB hex string. The supported colors are published in the folderColorPalette field of the About resource.\nIf an unsupported color is specified, the closest color in the palette will be used instead.", "type": "string" }, "fullFileExtension": { "description": "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.\nThis is automatically updated when the name field changes, however it is not cleared if the new name does not contain a valid extension.", "type": "string" }, "hasAugmentedPermissions": { "description": "Whether there are permissions directly on this file. This field is only populated for items in shared drives.", "type": "boolean" }, "hasThumbnail": { "description": "Whether this file has a thumbnail. This does not indicate whether the requesting app has access to the thumbnail. To check access, look for the presence of the thumbnailLink field.", "type": "boolean" }, "headRevisionId": { "description": "The ID of the file's head revision. This is currently only available for files with binary content in Google Drive.", "type": "string" }, "iconLink": { "description": "A static, unauthenticated link to the file's icon.", "type": "string" }, "id": { "description": "The ID of the file.", "type": "string" }, "imageMediaMetadata": { "description": "Additional metadata about image media, if available.", "properties": { "aperture": { "description": "The aperture used to create the photo (f-number).", "type": "number" }, "cameraMake": { "description": "The make of the camera used to create the photo.", "type": "string" }, "cameraModel": { "description": "The model of the camera used to create the photo.", "type": "string" }, "colorSpace": { "description": "The color space of the photo.", "type": "string" }, "exposureBias": { "description": "The exposure bias of the photo (APEX value).", "type": "number" }, "exposureMode": { "description": "The exposure mode used to create the photo.", "type": "string" }, "exposureTime": { "description": "The length of the exposure, in seconds.", "type": "number" }, "flashUsed": { "description": "Whether a flash was used to create the photo.", "type": "boolean" }, "focalLength": { "description": "The focal length used to create the photo, in millimeters.", "type": "number" }, "height": { "description": "The height of the image in pixels.", "type": "integer" }, "isoSpeed": { "description": "The ISO speed used to create the photo.", "type": "integer" }, "lens": { "description": "The lens used to create the photo.", "type": "string" }, "location": { "description": "Geographic location information stored in the image.", "properties": { "altitude": { "description": "The altitude stored in the image.", "type": "number" }, "latitude": { "description": "The latitude stored in the image.", "type": "number" }, "longitude": { "description": "The longitude stored in the image.", "type": "number" } }, "type": "object" }, "maxApertureValue": { "description": "The smallest f-number of the lens at the focal length used to create the photo (APEX value).", "type": "number" }, "meteringMode": { "description": "The metering mode used to create the photo.", "type": "string" }, "rotation": { "description": "The number of clockwise 90 degree rotations applied from the image's original orientation.", "type": "integer" }, "sensor": { "description": "The type of sensor used to create the photo.", "type": "string" }, "subjectDistance": { "description": "The distance to the subject of the photo, in meters.", "type": "integer" }, "time": { "description": "The date and time the photo was taken (EXIF DateTime).", "type": "string" }, "whiteBalance": { "description": "The white balance mode used to create the photo.", "type": "string" }, "width": { "description": "The width of the image in pixels.", "type": "integer" } }, "type": "object" }, "isAppAuthorized": { "description": "Whether the file was created or opened by the requesting app.", "type": "boolean" }, "kind": { "default": "drive#file", "description": "Identifies what kind of resource this is. Value: the fixed string \"drive#file\".", "type": "string" }, "lastModifyingUser": { "description": "Information about a Drive user.", "properties": { "displayName": { "description": "A plain text displayable name for this user.", "type": "string" }, "emailAddress": { "description": "The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.", "type": "string" }, "kind": { "default": "drive#user", "description": "Identifies what kind of resource this is. Value: the fixed string \"drive#user\".", "type": "string" }, "me": { "description": "Whether this user is the requesting user.", "type": "boolean" }, "permissionId": { "description": "The user's ID as visible in Permission resources.", "type": "string" }, "photoLink": { "description": "A link to the user's profile photo, if available.", "type": "string" } }, "type": "object" }, "linkShareMetadata": { "description": "Contains details about the link URLs that clients are using to refer to this item.", "properties": { "securityUpdateEligible": { "description": "Whether the file is eligible for security update.", "type": "boolean" }, "securityUpdateEnabled": { "description": "Whether the security update is enabled for this file.", "type": "boolean" } }, "type": "object" }, "md5Checksum": { "description": "The MD5 checksum for the content of the file. This is only applicable to files with binary content in Google Drive.", "type": "string" }, "mimeType": { "description": "The MIME type of the file.\nGoogle Drive will attempt 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.\nIf a file is created with a Google Doc MIME type, the uploaded content will be imported if possible. The supported import formats are published in the About resource.", "type": "string" }, "modifiedByMe": { "description": "Whether the file has been modified by this user.", "type": "boolean" }, "modifiedByMeTime": { "description": "The last time the file was modified by the user (RFC 3339 date-time).", "type": "string" }, "modifiedTime": { "description": "The last time the file was modified by anyone (RFC 3339 date-time).\nNote that setting modifiedTime will also update modifiedByMeTime for the user.", "type": "string" }, "name": { "description": "The name of the file. This is not necessarily unique within a folder. Note that for immutable items such as the top level folders of shared drives, My Drive root folder, and Application Data folder the name is constant.", "type": "string" }, "originalFilename": { "description": "The original filename of the uploaded content if available, or else the original value of the name field. This is only available for files with binary content in Google Drive.", "type": "string" }, "ownedByMe": { "description": "Whether the user owns the file. Not populated for items in shared drives.", "type": "boolean" }, "owners": { "description": "The owner of this file. Only certain legacy files may have more than one owner. This field isn't populated for items in shared drives.", "items": { "description": "Information about a Drive user.", "properties": { "displayName": { "description": "A plain text displayable name for this user.", "type": "string" }, "emailAddress": { "description": "The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.", "type": "string" }, "kind": { "default": "drive#user", "description": "Identifies what kind of resource this is. Value: the fixed string \"drive#user\".", "type": "string" }, "me": { "description": "Whether this user is the requesting user.", "type": "boolean" }, "permissionId": { "description": "The user's ID as visible in Permission resources.", "type": "string" }, "photoLink": { "description": "A link to the user's profile photo, if available.", "type": "string" } }, "type": "object" }, "type": "array" }, "parents": { "description": "The IDs of the parent folders which contain the file.\nIf not specified as part of a create request, the file will be placed directly in the user's My Drive folder. If not specified as part of a copy request, the file will inherit any discoverable parents of the source file. Update requests must use the addParents and removeParents parameters to modify the parents list.", "items": { "type": "string" }, "type": "array" }, "permissionIds": { "description": "List of permission IDs for users with access to this file.", "items": { "type": "string" }, "type": "array" }, "permissions": { "description": "The full list of permissions for the file. This is only available if the requesting user can share the file. Not populated for items in shared drives.", "items": { "description": "A permission for a file. A permission grants a user, group, domain or the world access to a file or a folder hierarchy.", "properties": { "allowFileDiscovery": { "description": "Whether the permission allows the file to be discovered through search. This is only applicable for permissions of type domain or anyone.", "type": "boolean" }, "deleted": { "description": "Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions.", "type": "boolean" }, "displayName": { "description": "The \"pretty\" name of the value of the permission. The following is a list of examples for each type of permission: \n- user - User's full name, as defined for their Google account, such as \"Joe Smith.\" \n- group - Name of the Google Group, such as \"The Company Administrators.\" \n- domain - String domain name, such as \"thecompany.com.\" \n- anyone - No displayName is present.", "type": "string" }, "domain": { "description": "The domain to which this permission refers.", "type": "string" }, "emailAddress": { "description": "The email address of the user or group to which this permission refers.", "type": "string" }, "expirationTime": { "description": "The time at which this permission will expire (RFC 3339 date-time). Expiration times have the following restrictions: \n- They can only be set on user and group permissions \n- The time must be in the future \n- The time cannot be more than a year in the future", "type": "string" }, "id": { "description": "The ID of this permission. This is a unique identifier for the grantee, and is published in User resources as permissionId. IDs should be treated as opaque values.", "type": "string" }, "kind": { "default": "drive#permission", "description": "Identifies what kind of resource this is. Value: the fixed string \"drive#permission\".", "type": "string" }, "pendingOwner": { "description": "Whether the account associated with this permission is a pending owner. Only populated for user type permissions for files that are not in a shared drive.", "type": "boolean" }, "permissionDetails": { "description": "Details of whether the permissions on this shared drive item are inherited or directly on this item. This is an output-only field which is present only for shared drive items.", "items": { "properties": { "inherited": { "description": "Whether this permission is inherited. This field is always populated. This is an output-only field.", "type": "boolean" }, "inheritedFrom": { "description": "The ID of the item from which this permission is inherited. This is an output-only field.", "type": "string" }, "permissionType": { "description": "The permission type for this user. While new values may be added in future, the following are currently possible: \n- file \n- member", "type": "string" }, "role": { "description": "The primary role for this user. While new values may be added in the future, the following are currently possible: \n- organizer \n- fileOrganizer \n- writer \n- commenter \n- reader", "type": "string" } }, "type": "object" }, "readOnly": true, "type": "array" }, "photoLink": { "description": "A link to the user's profile photo, if available.", "type": "string" }, "role": { "description": "The role granted by this permission. While new values may be supported in the future, the following are currently allowed: \n- owner \n- organizer \n- fileOrganizer \n- writer \n- commenter \n- reader", "type": "string" }, "teamDrivePermissionDetails": { "description": "Deprecated - use permissionDetails instead.", "items": { "properties": { "inherited": { "description": "Deprecated - use permissionDetails/inherited instead.", "type": "boolean" }, "inheritedFrom": { "description": "Deprecated - use permissionDetails/inheritedFrom instead.", "type": "string" }, "role": { "description": "Deprecated - use permissionDetails/role instead.", "type": "string" }, "teamDrivePermissionType": { "description": "Deprecated - use permissionDetails/permissionType instead.", "type": "string" } }, "type": "object" }, "readOnly": true, "type": "array" }, "type": { "description": "The type of the grantee. Valid values are: \n- user \n- group \n- domain \n- anyone When creating a permission, if type is user or group, you must provide an emailAddress for the user or group. When type is domain, you must provide a domain. There isn't extra information required for a anyone type.", "type": "string" }, "view": { "description": "Indicates the view for this permission. Only populated for permissions that belong to a view. published is the only supported value.", "type": "string" } }, "type": "object" }, "type": "array" }, "properties": { "additionalProperties": { "type": "string" }, "description": "A collection of arbitrary key-value pairs which are visible to all apps.\nEntries with null values are cleared in update and copy requests.", "type": "object" }, "quotaBytesUsed": { "description": "The number of storage quota bytes used by the file. This includes the head revision as well as previous revisions with keepForever enabled.", "type": "string" }, "resourceKey": { "description": "A key needed to access the item via a shared link.", "type": "string" }, "shared": { "description": "Whether the file has been shared. Not populated for items in shared drives.", "type": "boolean" }, "sharedWithMeTime": { "description": "The time at which the file was shared with the user, if applicable (RFC 3339 date-time).", "type": "string" }, "sharingUser": { "description": "Information about a Drive user.", "properties": { "displayName": { "description": "A plain text displayable name for this user.", "type": "string" }, "emailAddress": { "description": "The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.", "type": "string" }, "kind": { "default": "drive#user", "description": "Identifies what kind of resource this is. Value: the fixed string \"drive#user\".", "type": "string" }, "me": { "description": "Whether this user is the requesting user.", "type": "boolean" }, "permissionId": { "description": "The user's ID as visible in Permission resources.", "type": "string" }, "photoLink": { "description": "A link to the user's profile photo, if available.", "type": "string" } }, "type": "object" }, "shortcutDetails": { "description": "Shortcut file details. Only populated for shortcut files, which have the mimeType field set to application/vnd.google-apps.shortcut.", "properties": { "targetId": { "description": "The ID of the file that this shortcut points to.", "type": "string" }, "targetMimeType": { "description": "The MIME type of the file that this shortcut points to. The value of this field is a snapshot of the target's MIME type, captured when the shortcut is created.", "type": "string" }, "targetResourceKey": { "description": "The ResourceKey for the target file.", "type": "string" } }, "type": "object" }, "size": { "description": "The size of the file's content in bytes. This is applicable to binary files in Google Drive and Google Docs files.", "type": "string" }, "spaces": { "description": "The list of spaces which contain the file. The currently supported values are 'drive', 'appDataFolder' and 'photos'.", "items": { "type": "string" }, "type": "array" }, "starred": { "description": "Whether the user has starred the file.", "type": "boolean" }, "teamDriveId": { "description": "Deprecated - use driveId instead.", "type": "string" }, "thumbnailLink": { "description": "A short-lived link to the file's thumbnail, if available. Typically lasts on the order of hours. 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.", "type": "string" }, "thumbnailVersion": { "description": "The thumbnail version for use in thumbnail cache invalidation.", "type": "string" }, "trashed": { "description": "Whether the file has been trashed, either explicitly or from a trashed parent folder. Only the owner may trash a file. The trashed item is excluded from all files.list responses returned for any user who does not own the file. However, all users with access to the file can see the trashed item metadata in an API response. All users with access can copy, download, export, and share the file.", "type": "boolean" }, "trashedTime": { "description": "The time that the item was trashed (RFC 3339 date-time). Only populated for items in shared drives.", "type": "string" }, "trashingUser": { "description": "Information about a Drive user.", "properties": { "displayName": { "description": "A plain text displayable name for this user.", "type": "string" }, "emailAddress": { "description": "The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.", "type": "string" }, "kind": { "default": "drive#user", "description": "Identifies what kind of resource this is. Value: the fixed string \"drive#user\".", "type": "string" }, "me": { "description": "Whether this user is the requesting user.", "type": "boolean" }, "permissionId": { "description": "The user's ID as visible in Permission resources.", "type": "string" }, "photoLink": { "description": "A link to the user's profile photo, if available.", "type": "string" } }, "type": "object" }, "version": { "description": "A monotonically increasing version number for the file. This reflects every change made to the file on the server, even those not visible to the user.", "type": "string" }, "videoMediaMetadata": { "description": "Additional metadata about video media. This may not be available immediately upon upload.", "properties": { "durationMillis": { "description": "The duration of the video in milliseconds.", "type": "string" }, "height": { "description": "The height of the video in pixels.", "type": "integer" }, "width": { "description": "The width of the video in pixels.", "type": "integer" } }, "type": "object" }, "viewedByMe": { "description": "Whether the file has been viewed by this user.", "type": "boolean" }, "viewedByMeTime": { "description": "The last time the file was viewed by the user (RFC 3339 date-time).", "type": "string" }, "viewersCanCopyContent": { "description": "Deprecated - use copyRequiresWriterPermission instead.", "type": "boolean" }, "webContentLink": { "description": "A link for downloading the content of the file in a browser. This is only available for files with binary content in Google Drive.", "type": "string" }, "webViewLink": { "description": "A link for opening the file in a relevant Google editor or viewer in a browser.", "type": "string" }, "writersCanShare": { "description": "Whether users with only writer permission can modify the file's permissions. Not populated for items in shared drives.", "type": "boolean" } }, "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/driveFilesCreate" }, "task": true }, { "name": "driveFilesGenerateIds", "summary": "Generates a set of file IDs which can be provided in create or copy requests.", "description": "Generates a set of file IDs which can be provided in create or copy requests.", "input": [ { "name": "alt", "type": "string", "info": "Data format for the response.: Must be one of [json]", "required": false, "schema": { "title": "alt", "type": "string" } }, { "name": "fields", "type": "string", "info": "Selector specifying which fields to include in a partial response.: string", "required": false, "schema": { "title": "fields", "type": "string" } }, { "name": "key", "type": "string", "info": "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.: string", "required": false, "schema": { "title": "key", "type": "string" } }, { "name": "oauthToken", "type": "string", "info": "OAuth 2.0 token for the current user.: string", "required": false, "schema": { "title": "oauthToken", "type": "string" } }, { "name": "prettyPrint", "type": "boolean", "info": "Returns response with indentations and line breaks.: boolean", "required": false, "schema": { "title": "prettyPrint", "type": "boolean" } }, { "name": "quotaUser", "type": "string", "info": "An opaque string that represents a user for quota purposes. Must not exceed 40 characters.: string", "required": false, "schema": { "title": "quotaUser", "type": "string" } }, { "name": "userIp", "type": "string", "info": "Deprecated. Please use quotaUser instead.: string", "required": false, "schema": { "title": "userIp", "type": "string" } }, { "name": "count", "type": "number", "info": "The number of IDs to return.: 123", "required": false, "schema": { "title": "count", "type": "number" } }, { "name": "space", "type": "string", "info": "The space in which the IDs can be used to create new files. Supported values are 'drive' and 'appDataFolder'. (Default: 'drive'): string", "required": false, "schema": { "title": "space", "type": "string" } }, { "name": "type", "type": "string", "info": "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: 'f...(description truncated): string", "required": false, "schema": { "title": "type", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/driveFilesGenerateIds" }, "task": true }, { "name": "driveFilesEmptyTrash", "summary": "Permanently deletes all of the user's trashed files.", "description": "Permanently deletes all of the user's trashed files.", "input": [ { "name": "alt", "type": "string", "info": "Data format for the response.: Must be one of [json]", "required": false, "schema": { "title": "alt", "type": "string" } }, { "name": "fields", "type": "string", "info": "Selector specifying which fields to include in a partial response.: string", "required": false, "schema": { "title": "fields", "type": "string" } }, { "name": "key", "type": "string", "info": "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.: string", "required": false, "schema": { "title": "key", "type": "string" } }, { "name": "oauthToken", "type": "string", "info": "OAuth 2.0 token for the current user.: string", "required": false, "schema": { "title": "oauthToken", "type": "string" } }, { "name": "prettyPrint", "type": "boolean", "info": "Returns response with indentations and line breaks.: boolean", "required": false, "schema": { "title": "prettyPrint", "type": "boolean" } }, { "name": "quotaUser", "type": "string", "info": "An opaque string that represents a user for quota purposes. Must not exceed 40 characters.: string", "required": false, "schema": { "title": "quotaUser", "type": "string" } }, { "name": "userIp", "type": "string", "info": "Deprecated. Please use quotaUser instead.: string", "required": false, "schema": { "title": "userIp", "type": "string" } }, { "name": "enforceSingleParent", "type": "boolean", "info": "Deprecated. If an item is not in a shared drive and its last parent is deleted but the item itself is not, the item will be placed under its owner's root.: boolean", "required": false, "schema": { "title": "enforceSingleParent", "type": "boolean" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/driveFilesEmptyTrash" }, "task": true }, { "name": "driveFilesDelete", "summary": "Permanently deletes a file owned by the user without moving it to the trash. If the file belongs to", "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. If the target is a folder, all descendants owned by the user are also deleted.", "input": [ { "name": "alt", "type": "string", "info": "Data format for the response.: Must be one of [json]", "required": false, "schema": { "title": "alt", "type": "string" } }, { "name": "fields", "type": "string", "info": "Selector specifying which fields to include in a partial response.: string", "required": false, "schema": { "title": "fields", "type": "string" } }, { "name": "key", "type": "string", "info": "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.: string", "required": false, "schema": { "title": "key", "type": "string" } }, { "name": "oauthToken", "type": "string", "info": "OAuth 2.0 token for the current user.: string", "required": false, "schema": { "title": "oauthToken", "type": "string" } }, { "name": "prettyPrint", "type": "boolean", "info": "Returns response with indentations and line breaks.: boolean", "required": false, "schema": { "title": "prettyPrint", "type": "boolean" } }, { "name": "quotaUser", "type": "string", "info": "An opaque string that represents a user for quota purposes. Must not exceed 40 characters.: string", "required": false, "schema": { "title": "quotaUser", "type": "string" } }, { "name": "userIp", "type": "string", "info": "Deprecated. Please use quotaUser instead.: string", "required": false, "schema": { "title": "userIp", "type": "string" } }, { "name": "fileId", "type": "string", "info": "The ID of the file.: string", "required": true, "schema": { "title": "fileId", "type": "string" } }, { "name": "enforceSingleParent", "type": "boolean", "info": "Deprecated. If an item is not in a shared drive and its last parent is deleted but the item itself is not, the item will be placed under its owner's root.: boolean", "required": false, "schema": { "title": "enforceSingleParent", "type": "boolean" } }, { "name": "supportsAllDrives", "type": "boolean", "info": "Whether the requesting application supports both My Drives and shared drives.: boolean", "required": false, "schema": { "title": "supportsAllDrives", "type": "boolean" } }, { "name": "supportsTeamDrives", "type": "boolean", "info": "Deprecated use supportsAllDrives instead.: boolean", "required": false, "schema": { "title": "supportsTeamDrives", "type": "boolean" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/driveFilesDelete" }, "task": true }, { "name": "driveFilesGet", "summary": "Gets a file's metadata or content by ID.", "description": "Gets a file's metadata or content by ID.", "input": [ { "name": "alt", "type": "string", "info": "Data format for the response.: Must be one of [json]", "required": false, "schema": { "title": "alt", "type": "string" } }, { "name": "fields", "type": "string", "info": "Selector specifying which fields to include in a partial response.: string", "required": false, "schema": { "title": "fields", "type": "string" } }, { "name": "key", "type": "string", "info": "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.: string", "required": false, "schema": { "title": "key", "type": "string" } }, { "name": "oauthToken", "type": "string", "info": "OAuth 2.0 token for the current user.: string", "required": false, "schema": { "title": "oauthToken", "type": "string" } }, { "name": "prettyPrint", "type": "boolean", "info": "Returns response with indentations and line breaks.: boolean", "required": false, "schema": { "title": "prettyPrint", "type": "boolean" } }, { "name": "quotaUser", "type": "string", "info": "An opaque string that represents a user for quota purposes. Must not exceed 40 characters.: string", "required": false, "schema": { "title": "quotaUser", "type": "string" } }, { "name": "userIp", "type": "string", "info": "Deprecated. Please use quotaUser instead.: string", "required": false, "schema": { "title": "userIp", "type": "string" } }, { "name": "fileId", "type": "string", "info": "The ID of the file.: string", "required": true, "schema": { "title": "fileId", "type": "string" } }, { "name": "acknowledgeAbuse", "type": "boolean", "info": "Whether the user is acknowledging the risk of downloading known malware or other abusive files. This is only applicable when alt=media.: boolean", "required": false, "schema": { "title": "acknowledgeAbuse", "type": "boolean" } }, { "name": "includePermissionsForView", "type": "string", "info": "Specifies which additional view's permissions to include in the response. Only 'published' is supported.: string", "required": false, "schema": { "title": "includePermissionsForView", "type": "string" } }, { "name": "supportsAllDrives", "type": "boolean", "info": "Whether the requesting application supports both My Drives and shared drives.: boolean", "required": false, "schema": { "title": "supportsAllDrives", "type": "boolean" } }, { "name": "supportsTeamDrives", "type": "boolean", "info": "Deprecated use supportsAllDrives instead.: boolean", "required": false, "schema": { "title": "supportsTeamDrives", "type": "boolean" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/driveFilesGet" }, "task": true }, { "name": "driveFilesUpdate", "summary": "Updates a file's metadata and/or content. When calling this method, only populate fields in the req", "description": "Updates a file's metadata and/or content. When calling this method, only populate fields in the request that you want to modify. When updating fields, some fields might change automatically, such as modifiedDate. This method supports patch semantics.", "input": [ { "name": "alt", "type": "string", "info": "Data format for the response.: Must be one of [json]", "required": false, "schema": { "title": "alt", "type": "string" } }, { "name": "fields", "type": "string", "info": "Selector specifying which fields to include in a partial response.: string", "required": false, "schema": { "title": "fields", "type": "string" } }, { "name": "key", "type": "string", "info": "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.: string", "required": false, "schema": { "title": "key", "type": "string" } }, { "name": "oauthToken", "type": "string", "info": "OAuth 2.0 token for the current user.: string", "required": false, "schema": { "title": "oauthToken", "type": "string" } }, { "name": "prettyPrint", "type": "boolean", "info": "Returns response with indentations and line breaks.: boolean", "required": false, "schema": { "title": "prettyPrint", "type": "boolean" } }, { "name": "quotaUser", "type": "string", "info": "An opaque string that represents a user for quota purposes. Must not exceed 40 characters.: string", "required": false, "schema": { "title": "quotaUser", "type": "string" } }, { "name": "userIp", "type": "string", "info": "Deprecated. Please use quotaUser instead.: string", "required": false, "schema": { "title": "userIp", "type": "string" } }, { "name": "fileId", "type": "string", "info": "The ID of the file.: string", "required": true, "schema": { "title": "fileId", "type": "string" } }, { "name": "addParents", "type": "string", "info": "A comma-separated list of parent IDs to add.: string", "required": false, "schema": { "title": "addParents", "type": "string" } }, { "name": "enforceSingleParent", "type": "boolean", "info": "Deprecated. Adding files to multiple folders is no longer supported. Use shortcuts instead.: boolean", "required": false, "schema": { "title": "enforceSingleParent", "type": "boolean" } }, { "name": "includePermissionsForView", "type": "string", "info": "Specifies which additional view's permissions to include in the response. Only 'published' is supported.: string", "required": false, "schema": { "title": "includePermissionsForView", "type": "string" } }, { "name": "keepRevisionForever", "type": "boolean", "info": "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...(description truncated): boolean", "required": false, "schema": { "title": "keepRevisionForever", "type": "boolean" } }, { "name": "ocrLanguage", "type": "string", "info": "A language hint for OCR processing during image import (ISO 639-1 code).: string", "required": false, "schema": { "title": "ocrLanguage", "type": "string" } }, { "name": "removeParents", "type": "string", "info": "A comma-separated list of parent IDs to remove.: string", "required": false, "schema": { "title": "removeParents", "type": "string" } }, { "name": "supportsAllDrives", "type": "boolean", "info": "Whether the requesting application supports both My Drives and shared drives.: boolean", "required": false, "schema": { "title": "supportsAllDrives", "type": "boolean" } }, { "name": "supportsTeamDrives", "type": "boolean", "info": "Deprecated use supportsAllDrives instead.: boolean", "required": false, "schema": { "title": "supportsTeamDrives", "type": "boolean" } }, { "name": "useContentAsIndexableText", "type": "boolean", "info": "Whether to use the uploaded content as indexable text.: boolean", "required": false, "schema": { "title": "useContentAsIndexableText", "type": "boolean" } }, { "name": "body", "type": "object", "info": ": {\"appProperties\": \"object\", \"capabilities\": {\"canAcceptOwnership\": \"boolean\", \"canAddChildren\": \"boolean\", \"canAddFolderFromAnotherDrive\": \"boolean\", \"canAddMyDriveParent\": \"boolean\", \"canChangeCopyRequiresWriterPermission\": \"boolean\", \"canChangeSecurityUpdateEnabled\": \"boolean\", \"canChangeViewersCanCopyContent\": \"boolean\", \"canComment\": \"boolean\", \"canCopy\": \"boolean\", \"canDelete\": \"boolean\", \"canDeleteChildren\": \"boolean\", \"canDownload\": \"boolean\", \"canEdit\": \"boolean\", \"canListChildren\": \"boolean\", \"canModifyContent\": \"boolean\", \"canModifyContentRestriction\": \"boolean\", \"canMoveChildrenOutOfDrive\": \"boolean\", \"canMoveChildrenOutOfTeamDrive\": \"boolean\", \"canMoveChildrenWithinDrive\": \"boolean\", \"canMoveChildrenWithinTeamDrive\": \"boolean\", \"canMoveItemIntoTeamDrive\": \"boolean\", \"canMoveItemOutOfDrive\": \"boolean\", \"canMoveItemOutOfTeamDrive\": \"boolean\", \"canMoveItemWithinDrive\": \"boolean\", \"canMoveItemWithinTeamDrive\": \"boolean\", \"canMoveTeamDriveItem\": \"boolean\", \"canReadDrive\": \"boolean\", \"canReadRevisions\": \"boolean\", \"canReadTeamDrive\": \"boolean\", \"canRemoveChildren\": \"boolean\", \"canRemoveMyDriveParent\": \"boolean\", \"canRename\": \"boolean\", \"canShare\": \"boolean\", \"canTrash\": \"boolean\", \"canTrashChildren\": \"boolean\", \"canUntrash\": \"boolean\"}, \"contentHints\": {\"indexableText\": \"string\", \"thumbnail\": {\"image\": \"string\", \"mimeType\": \"string\"}}, \"contentRestrictions\": [{\"readOnly\": \"boolean\", \"reason\": \"string\", \"restrictingUser\": {\"displayName\": \"string\", \"emailAddress\": \"string\", \"kind\": \"string\", \"me\": \"boolean\", \"permissionId\": \"string\", \"photoLink\": \"string\"}, \"restrictionTime\": \"string\", \"type\": \"string\"}], \"copyRequiresWriterPermission\": \"boolean\", \"createdTime\": \"string\", \"description\": \"string\", \"driveId\": \"string\", \"explicitlyTrashed\": \"boolean\", \"exportLinks\": \"object\", \"fileExtension\": \"string\", \"folderColorRgb\": \"string\", \"fullFileExtension\": \"string\", \"hasAugmentedPermissions\": \"boolean\", \"hasThumbnail\": \"boolean\", \"headRevisionId\": \"string\", \"iconLink\": \"string\", \"id\": \"string\", \"imageMediaMetadata\": {\"aperture\": 123, \"cameraMake\": \"string\", \"cameraModel\": \"string\", \"colorSpace\": \"string\", \"exposureBias\": 123, \"exposureMode\": \"string\", \"exposureTime\": 123, \"flashUsed\": \"boolean\", \"focalLength\": 123, \"height\": 123, \"isoSpeed\": 123, \"lens\": \"string\", \"location\": {\"altitude\": 123, \"latitude\": 123, \"longitude\": 123}, \"maxApertureValue\": 123, \"meteringMode\": \"string\", \"rotation\": 123, \"sensor\": \"string\", \"subjectDistance\": 123, \"time\": \"string\", \"whiteBalance\": \"string\", \"width\": 123}, \"isAppAuthorized\": \"boolean\", \"kind\": \"string\", \"lastModifyingUser\": {\"displayName\": \"string\", \"emailAddress\": \"string\", \"kind\": \"string\", \"me\": \"boolean\", \"permissionId\": \"string\", \"photoLink\": \"string\"}, \"linkShareMetadata\": {\"securityUpdateEligible\": \"boolean\", \"securityUpdateEnabled\": \"boolean\"}, \"md5Checksum\": \"string\", \"mimeType\": \"string\", \"modifiedByMe\": \"boolean\", \"modifiedByMeTime\": \"string\", \"modifiedTime\": \"string\", \"name\": \"string\", \"originalFilename\": \"string\", \"ownedByMe\": \"boolean\", \"owners\": [{\"displayName\": \"string\", \"emailAddress\": \"string\", \"kind\": \"string\", \"me\": \"boolean\", \"permissionId\": \"string\", \"photoLink\": \"string\"}], \"parents\": \"array\", \"permissionIds\": \"array\", \"permissions\": [{\"allowFileDiscovery\": \"boolean\", \"deleted\": \"boolean\", \"displayName\": \"string\", \"domain\": \"string\", \"emailAddress\": \"string\", \"expirationTime\": \"string\", \"id\": \"string\", \"kind\": \"string\", \"pendingOwner\": \"boolean\", \"permissionDetails\": [{\"inherited\": \"boolean\", \"inheritedFrom\": \"string\", \"permissionType\": \"string\", \"role\": \"string\"}], \"photoLink\": \"string\", \"role\": \"string\", \"teamDrivePermissionDetails\": [{\"inherited\": \"boolean\", \"inheritedFrom\": \"string\", \"role\": \"string\", \"teamDrivePermissionType\": \"string\"}], \"type\": \"string\", \"view\": \"string\"}], \"properties\": \"object\", \"quotaBytesUsed\": \"string\", \"resourceKey\": \"string\", \"shared\": \"boolean\", \"sharedWithMeTime\": \"string\", \"sharingUser\": {\"displayName\": \"string\", \"emailAddress\": \"string\", \"kind\": \"string\", \"me\": \"boolean\", \"permissionId\": \"string\", \"photoLink\": \"string\"}, \"shortcutDetails\": {\"targetId\": \"string\", \"targetMimeType\": \"string\", \"targetResourceKey\": \"string\"}, \"size\": \"string\", \"spaces\": \"array\", \"starred\": \"boolean\", \"teamDriveId\": \"string\", \"thumbnailLink\": \"string\", \"thumbnailVersion\": \"string\", \"trashed\": \"boolean\", \"trashedTime\": \"string\", \"trashingUser\": {\"displayName\": \"string\", \"emailAddress\": \"string\", \"kind\": \"string\", \"me\": \"boolean\", \"permissionId\": \"string\", \"photoLink\": \"string\"}, \"version\": \"string\", \"videoMediaMetadata\": {\"durationMillis\": \"string\", \"height\": 123, \"width\": 123}, \"viewedByMe\": \"boolean\", \"viewedByMeTime\": \"string\", \"viewersCanCopyContent\": \"boolean\", \"webContentLink\": \"string\", \"webViewLink\": \"string\", \"writersCanShare\": \"boolean\"}", "required": false, "schema": { "description": "The metadata for a file.", "properties": { "appProperties": { "additionalProperties": { "type": "string" }, "description": "A collection of arbitrary key-value pairs which are private to the requesting app.\nEntries with null values are cleared in update and copy requests. These properties can only be retrieved using an authenticated request. An authenticated request uses an access token obtained with a OAuth 2 client ID. You cannot use an API key to retrieve private properties.", "type": "object" }, "capabilities": { "description": "Capabilities the current user has on this file. Each capability corresponds to a fine-grained action that a user may take.", "properties": { "canAcceptOwnership": { "description": "Whether the current user is the pending owner of the file. Not populated for shared drive files.", "type": "boolean" }, "canAddChildren": { "description": "Whether the current user can add children to this folder. This is always false when the item is not a folder.", "type": "boolean" }, "canAddFolderFromAnotherDrive": { "description": "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 is not a folder. Only populated for items in shared drives.", "type": "boolean" }, "canAddMyDriveParent": { "description": "Whether the current user can add a parent for the item without removing an existing parent in the same request. Not populated for shared drive files.", "type": "boolean" }, "canChangeCopyRequiresWriterPermission": { "description": "Whether the current user can change the copyRequiresWriterPermission restriction of this file.", "type": "boolean" }, "canChangeSecurityUpdateEnabled": { "description": "Whether the current user can change the securityUpdateEnabled field on link share metadata.", "type": "boolean" }, "canChangeViewersCanCopyContent": { "description": "Deprecated", "type": "boolean" }, "canComment": { "description": "Whether the current user can comment on this file.", "type": "boolean" }, "canCopy": { "description": "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 itself if it is not a folder.", "type": "boolean" }, "canDelete": { "description": "Whether the current user can delete this file.", "type": "boolean" }, "canDeleteChildren": { "description": "Whether the current user can delete children of this folder. This is false when the item is not a folder. Only populated for items in shared drives.", "type": "boolean" }, "canDownload": { "description": "Whether the current user can download this file.", "type": "boolean" }, "canEdit": { "description": "Whether the current user can edit this file. Other factors may limit the type of changes a user can make to a file. For example, see canChangeCopyRequiresWriterPermission or canModifyContent.", "type": "boolean" }, "canListChildren": { "description": "Whether the current user can list the children of this folder. This is always false when the item is not a folder.", "type": "boolean" }, "canModifyContent": { "description": "Whether the current user can modify the content of this file.", "type": "boolean" }, "canModifyContentRestriction": { "description": "Whether the current user can modify restrictions on content of this file.", "type": "boolean" }, "canMoveChildrenOutOfDrive": { "description": "Whether the current user can move children of this folder outside of the shared drive. This is false when the item is not a folder. Only populated for items in shared drives.", "type": "boolean" }, "canMoveChildrenOutOfTeamDrive": { "description": "Deprecated - use canMoveChildrenOutOfDrive instead.", "type": "boolean" }, "canMoveChildrenWithinDrive": { "description": "Whether the current user can move children of this folder within this drive. This is false when the item is not 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.", "type": "boolean" }, "canMoveChildrenWithinTeamDrive": { "description": "Deprecated - use canMoveChildrenWithinDrive instead.", "type": "boolean" }, "canMoveItemIntoTeamDrive": { "description": "Deprecated - use canMoveItemOutOfDrive instead.", "type": "boolean" }, "canMoveItemOutOfDrive": { "description": "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 is being added.", "type": "boolean" }, "canMoveItemOutOfTeamDrive": { "description": "Deprecated - use canMoveItemOutOfDrive instead.", "type": "boolean" }, "canMoveItemWithinDrive": { "description": "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 is being added and the parent that is being removed.", "type": "boolean" }, "canMoveItemWithinTeamDrive": { "description": "Deprecated - use canMoveItemWithinDrive instead.", "type": "boolean" }, "canMoveTeamDriveItem": { "description": "Deprecated - use canMoveItemWithinDrive or canMoveItemOutOfDrive instead.", "type": "boolean" }, "canReadDrive": { "description": "Whether the current user can read the shared drive to which this file belongs. Only populated for items in shared drives.", "type": "boolean" }, "canReadRevisions": { "description": "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 itself if it is not a folder, can be read.", "type": "boolean" }, "canReadTeamDrive": { "description": "Deprecated - use canReadDrive instead.", "type": "boolean" }, "canRemoveChildren": { "description": "Whether the current user can remove children from this folder. This is always false when the item is not a folder. For a folder in a shared drive, use canDeleteChildren or canTrashChildren instead.", "type": "boolean" }, "canRemoveMyDriveParent": { "description": "Whether the current user can remove a parent from the item without adding another parent in the same request. Not populated for shared drive files.", "type": "boolean" }, "canRename": { "description": "Whether the current user can rename this file.", "type": "boolean" }, "canShare": { "description": "Whether the current user can modify the sharing settings for this file.", "type": "boolean" }, "canTrash": { "description": "Whether the current user can move this file to trash.", "type": "boolean" }, "canTrashChildren": { "description": "Whether the current user can trash children of this folder. This is false when the item is not a folder. Only populated for items in shared drives.", "type": "boolean" }, "canUntrash": { "description": "Whether the current user can restore this file from trash.", "type": "boolean" } }, "type": "object" }, "contentHints": { "description": "Additional information about the content of the file. These fields are never populated in responses.", "properties": { "indexableText": { "description": "Text to be indexed for the file to improve fullText queries. This is limited to 128KB in length and may contain HTML elements.", "type": "string" }, "thumbnail": { "description": "A thumbnail for the file. This will only be used if Google Drive cannot generate a standard thumbnail.", "properties": { "image": { "description": "The thumbnail data encoded with URL-safe Base64 (RFC 4648 section 5).", "type": "string" }, "mimeType": { "description": "The MIME type of the thumbnail.", "type": "string" } }, "type": "object" } }, "type": "object" }, "contentRestrictions": { "description": "Restrictions for accessing the content of the file. Only populated if such a restriction exists.", "items": { "description": "A restriction for accessing the content of the file.", "properties": { "readOnly": { "description": "Whether the content of the file is read-only. If a file is read-only, a new revision of the file may not be added, comments may not be added or modified, and the title of the file may not be modified.", "type": "boolean" }, "reason": { "description": "Reason for why the content of the file is restricted. This is only mutable on requests that also set readOnly=true.", "type": "string" }, "restrictingUser": { "description": "Information about a Drive user.", "properties": { "displayName": { "description": "A plain text displayable name for this user.", "type": "string" }, "emailAddress": { "description": "The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.", "type": "string" }, "kind": { "default": "drive#user", "description": "Identifies what kind of resource this is. Value: the fixed string \"drive#user\".", "type": "string" }, "me": { "description": "Whether this user is the requesting user.", "type": "boolean" }, "permissionId": { "description": "The user's ID as visible in Permission resources.", "type": "string" }, "photoLink": { "description": "A link to the user's profile photo, if available.", "type": "string" } }, "type": "object" }, "restrictionTime": { "description": "The time at which the content restriction was set (formatted RFC 3339 timestamp). Only populated if readOnly is true.", "type": "string" }, "type": { "description": "The type of the content restriction. Currently the only possible value is globalContentRestriction.", "type": "string" } }, "type": "object" }, "type": "array" }, "copyRequiresWriterPermission": { "description": "Whether the options to copy, print, or download this file, should be disabled for readers and commenters.", "type": "boolean" }, "createdTime": { "description": "The time at which the file was created (RFC 3339 date-time).", "type": "string" }, "description": { "description": "A short description of the file.", "type": "string" }, "driveId": { "description": "ID of the shared drive the file resides in. Only populated for items in shared drives.", "type": "string" }, "explicitlyTrashed": { "description": "Whether the file has been explicitly trashed, as opposed to recursively trashed from a parent folder.", "type": "boolean" }, "exportLinks": { "additionalProperties": { "description": "A mapping from export format to URL", "type": "string" }, "description": "Links for exporting Docs Editors files to specific formats.", "readOnly": true, "type": "object" }, "fileExtension": { "description": "The final component of fullFileExtension. This is only available for files with binary content in Google Drive.", "type": "string" }, "folderColorRgb": { "description": "The color for a folder or shortcut to a folder as an RGB hex string. The supported colors are published in the folderColorPalette field of the About resource.\nIf an unsupported color is specified, the closest color in the palette will be used instead.", "type": "string" }, "fullFileExtension": { "description": "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.\nThis is automatically updated when the name field changes, however it is not cleared if the new name does not contain a valid extension.", "type": "string" }, "hasAugmentedPermissions": { "description": "Whether there are permissions directly on this file. This field is only populated for items in shared drives.", "type": "boolean" }, "hasThumbnail": { "description": "Whether this file has a thumbnail. This does not indicate whether the requesting app has access to the thumbnail. To check access, look for the presence of the thumbnailLink field.", "type": "boolean" }, "headRevisionId": { "description": "The ID of the file's head revision. This is currently only available for files with binary content in Google Drive.", "type": "string" }, "iconLink": { "description": "A static, unauthenticated link to the file's icon.", "type": "string" }, "id": { "description": "The ID of the file.", "type": "string" }, "imageMediaMetadata": { "description": "Additional metadata about image media, if available.", "properties": { "aperture": { "description": "The aperture used to create the photo (f-number).", "type": "number" }, "cameraMake": { "description": "The make of the camera used to create the photo.", "type": "string" }, "cameraModel": { "description": "The model of the camera used to create the photo.", "type": "string" }, "colorSpace": { "description": "The color space of the photo.", "type": "string" }, "exposureBias": { "description": "The exposure bias of the photo (APEX value).", "type": "number" }, "exposureMode": { "description": "The exposure mode used to create the photo.", "type": "string" }, "exposureTime": { "description": "The length of the exposure, in seconds.", "type": "number" }, "flashUsed": { "description": "Whether a flash was used to create the photo.", "type": "boolean" }, "focalLength": { "description": "The focal length used to create the photo, in millimeters.", "type": "number" }, "height": { "description": "The height of the image in pixels.", "type": "integer" }, "isoSpeed": { "description": "The ISO speed used to create the photo.", "type": "integer" }, "lens": { "description": "The lens used to create the photo.", "type": "string" }, "location": { "description": "Geographic location information stored in the image.", "properties": { "altitude": { "description": "The altitude stored in the image.", "type": "number" }, "latitude": { "description": "The latitude stored in the image.", "type": "number" }, "longitude": { "description": "The longitude stored in the image.", "type": "number" } }, "type": "object" }, "maxApertureValue": { "description": "The smallest f-number of the lens at the focal length used to create the photo (APEX value).", "type": "number" }, "meteringMode": { "description": "The metering mode used to create the photo.", "type": "string" }, "rotation": { "description": "The number of clockwise 90 degree rotations applied from the image's original orientation.", "type": "integer" }, "sensor": { "description": "The type of sensor used to create the photo.", "type": "string" }, "subjectDistance": { "description": "The distance to the subject of the photo, in meters.", "type": "integer" }, "time": { "description": "The date and time the photo was taken (EXIF DateTime).", "type": "string" }, "whiteBalance": { "description": "The white balance mode used to create the photo.", "type": "string" }, "width": { "description": "The width of the image in pixels.", "type": "integer" } }, "type": "object" }, "isAppAuthorized": { "description": "Whether the file was created or opened by the requesting app.", "type": "boolean" }, "kind": { "default": "drive#file", "description": "Identifies what kind of resource this is. Value: the fixed string \"drive#file\".", "type": "string" }, "lastModifyingUser": { "description": "Information about a Drive user.", "properties": { "displayName": { "description": "A plain text displayable name for this user.", "type": "string" }, "emailAddress": { "description": "The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.", "type": "string" }, "kind": { "default": "drive#user", "description": "Identifies what kind of resource this is. Value: the fixed string \"drive#user\".", "type": "string" }, "me": { "description": "Whether this user is the requesting user.", "type": "boolean" }, "permissionId": { "description": "The user's ID as visible in Permission resources.", "type": "string" }, "photoLink": { "description": "A link to the user's profile photo, if available.", "type": "string" } }, "type": "object" }, "linkShareMetadata": { "description": "Contains details about the link URLs that clients are using to refer to this item.", "properties": { "securityUpdateEligible": { "description": "Whether the file is eligible for security update.", "type": "boolean" }, "securityUpdateEnabled": { "description": "Whether the security update is enabled for this file.", "type": "boolean" } }, "type": "object" }, "md5Checksum": { "description": "The MD5 checksum for the content of the file. This is only applicable to files with binary content in Google Drive.", "type": "string" }, "mimeType": { "description": "The MIME type of the file.\nGoogle Drive will attempt 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.\nIf a file is created with a Google Doc MIME type, the uploaded content will be imported if possible. The supported import formats are published in the About resource.", "type": "string" }, "modifiedByMe": { "description": "Whether the file has been modified by this user.", "type": "boolean" }, "modifiedByMeTime": { "description": "The last time the file was modified by the user (RFC 3339 date-time).", "type": "string" }, "modifiedTime": { "description": "The last time the file was modified by anyone (RFC 3339 date-time).\nNote that setting modifiedTime will also update modifiedByMeTime for the user.", "type": "string" }, "name": { "description": "The name of the file. This is not necessarily unique within a folder. Note that for immutable items such as the top level folders of shared drives, My Drive root folder, and Application Data folder the name is constant.", "type": "string" }, "originalFilename": { "description": "The original filename of the uploaded content if available, or else the original value of the name field. This is only available for files with binary content in Google Drive.", "type": "string" }, "ownedByMe": { "description": "Whether the user owns the file. Not populated for items in shared drives.", "type": "boolean" }, "owners": { "description": "The owner of this file. Only certain legacy files may have more than one owner. This field isn't populated for items in shared drives.", "items": { "description": "Information about a Drive user.", "properties": { "displayName": { "description": "A plain text displayable name for this user.", "type": "string" }, "emailAddress": { "description": "The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.", "type": "string" }, "kind": { "default": "drive#user", "description": "Identifies what kind of resource this is. Value: the fixed string \"drive#user\".", "type": "string" }, "me": { "description": "Whether this user is the requesting user.", "type": "boolean" }, "permissionId": { "description": "The user's ID as visible in Permission resources.", "type": "string" }, "photoLink": { "description": "A link to the user's profile photo, if available.", "type": "string" } }, "type": "object" }, "type": "array" }, "parents": { "description": "The IDs of the parent folders which contain the file.\nIf not specified as part of a create request, the file will be placed directly in the user's My Drive folder. If not specified as part of a copy request, the file will inherit any discoverable parents of the source file. Update requests must use the addParents and removeParents parameters to modify the parents list.", "items": { "type": "string" }, "type": "array" }, "permissionIds": { "description": "List of permission IDs for users with access to this file.", "items": { "type": "string" }, "type": "array" }, "permissions": { "description": "The full list of permissions for the file. This is only available if the requesting user can share the file. Not populated for items in shared drives.", "items": { "description": "A permission for a file. A permission grants a user, group, domain or the world access to a file or a folder hierarchy.", "properties": { "allowFileDiscovery": { "description": "Whether the permission allows the file to be discovered through search. This is only applicable for permissions of type domain or anyone.", "type": "boolean" }, "deleted": { "description": "Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions.", "type": "boolean" }, "displayName": { "description": "The \"pretty\" name of the value of the permission. The following is a list of examples for each type of permission: \n- user - User's full name, as defined for their Google account, such as \"Joe Smith.\" \n- group - Name of the Google Group, such as \"The Company Administrators.\" \n- domain - String domain name, such as \"thecompany.com.\" \n- anyone - No displayName is present.", "type": "string" }, "domain": { "description": "The domain to which this permission refers.", "type": "string" }, "emailAddress": { "description": "The email address of the user or group to which this permission refers.", "type": "string" }, "expirationTime": { "description": "The time at which this permission will expire (RFC 3339 date-time). Expiration times have the following restrictions: \n- They can only be set on user and group permissions \n- The time must be in the future \n- The time cannot be more than a year in the future", "type": "string" }, "id": { "description": "The ID of this permission. This is a unique identifier for the grantee, and is published in User resources as permissionId. IDs should be treated as opaque values.", "type": "string" }, "kind": { "default": "drive#permission", "description": "Identifies what kind of resource this is. Value: the fixed string \"drive#permission\".", "type": "string" }, "pendingOwner": { "description": "Whether the account associated with this permission is a pending owner. Only populated for user type permissions for files that are not in a shared drive.", "type": "boolean" }, "permissionDetails": { "description": "Details of whether the permissions on this shared drive item are inherited or directly on this item. This is an output-only field which is present only for shared drive items.", "items": { "properties": { "inherited": { "description": "Whether this permission is inherited. This field is always populated. This is an output-only field.", "type": "boolean" }, "inheritedFrom": { "description": "The ID of the item from which this permission is inherited. This is an output-only field.", "type": "string" }, "permissionType": { "description": "The permission type for this user. While new values may be added in future, the following are currently possible: \n- file \n- member", "type": "string" }, "role": { "description": "The primary role for this user. While new values may be added in the future, the following are currently possible: \n- organizer \n- fileOrganizer \n- writer \n- commenter \n- reader", "type": "string" } }, "type": "object" }, "readOnly": true, "type": "array" }, "photoLink": { "description": "A link to the user's profile photo, if available.", "type": "string" }, "role": { "description": "The role granted by this permission. While new values may be supported in the future, the following are currently allowed: \n- owner \n- organizer \n- fileOrganizer \n- writer \n- commenter \n- reader", "type": "string" }, "teamDrivePermissionDetails": { "description": "Deprecated - use permissionDetails instead.", "items": { "properties": { "inherited": { "description": "Deprecated - use permissionDetails/inherited instead.", "type": "boolean" }, "inheritedFrom": { "description": "Deprecated - use permissionDetails/inheritedFrom instead.", "type": "string" }, "role": { "description": "Deprecated - use permissionDetails/role instead.", "type": "string" }, "teamDrivePermissionType": { "description": "Deprecated - use permissionDetails/permissionType instead.", "type": "string" } }, "type": "object" }, "readOnly": true, "type": "array" }, "type": { "description": "The type of the grantee. Valid values are: \n- user \n- group \n- domain \n- anyone When creating a permission, if type is user or group, you must provide an emailAddress for the user or group. When type is domain, you must provide a domain. There isn't extra information required for a anyone type.", "type": "string" }, "view": { "description": "Indicates the view for this permission. Only populated for permissions that belong to a view. published is the only supported value.", "type": "string" } }, "type": "object" }, "type": "array" }, "properties": { "additionalProperties": { "type": "string" }, "description": "A collection of arbitrary key-value pairs which are visible to all apps.\nEntries with null values are cleared in update and copy requests.", "type": "object" }, "quotaBytesUsed": { "description": "The number of storage quota bytes used by the file. This includes the head revision as well as previous revisions with keepForever enabled.", "type": "string" }, "resourceKey": { "description": "A key needed to access the item via a shared link.", "type": "string" }, "shared": { "description": "Whether the file has been shared. Not populated for items in shared drives.", "type": "boolean" }, "sharedWithMeTime": { "description": "The time at which the file was shared with the user, if applicable (RFC 3339 date-time).", "type": "string" }, "sharingUser": { "description": "Information about a Drive user.", "properties": { "displayName": { "description": "A plain text displayable name for this user.", "type": "string" }, "emailAddress": { "description": "The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.", "type": "string" }, "kind": { "default": "drive#user", "description": "Identifies what kind of resource this is. Value: the fixed string \"drive#user\".", "type": "string" }, "me": { "description": "Whether this user is the requesting user.", "type": "boolean" }, "permissionId": { "description": "The user's ID as visible in Permission resources.", "type": "string" }, "photoLink": { "description": "A link to the user's profile photo, if available.", "type": "string" } }, "type": "object" }, "shortcutDetails": { "description": "Shortcut file details. Only populated for shortcut files, which have the mimeType field set to application/vnd.google-apps.shortcut.", "properties": { "targetId": { "description": "The ID of the file that this shortcut points to.", "type": "string" }, "targetMimeType": { "description": "The MIME type of the file that this shortcut points to. The value of this field is a snapshot of the target's MIME type, captured when the shortcut is created.", "type": "string" }, "targetResourceKey": { "description": "The ResourceKey for the target file.", "type": "string" } }, "type": "object" }, "size": { "description": "The size of the file's content in bytes. This is applicable to binary files in Google Drive and Google Docs files.", "type": "string" }, "spaces": { "description": "The list of spaces which contain the file. The currently supported values are 'drive', 'appDataFolder' and 'photos'.", "items": { "type": "string" }, "type": "array" }, "starred": { "description": "Whether the user has starred the file.", "type": "boolean" }, "teamDriveId": { "description": "Deprecated - use driveId instead.", "type": "string" }, "thumbnailLink": { "description": "A short-lived link to the file's thumbnail, if available. Typically lasts on the order of hours. 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.", "type": "string" }, "thumbnailVersion": { "description": "The thumbnail version for use in thumbnail cache invalidation.", "type": "string" }, "trashed": { "description": "Whether the file has been trashed, either explicitly or from a trashed parent folder. Only the owner may trash a file. The trashed item is excluded from all files.list responses returned for any user who does not own the file. However, all users with access to the file can see the trashed item metadata in an API response. All users with access can copy, download, export, and share the file.", "type": "boolean" }, "trashedTime": { "description": "The time that the item was trashed (RFC 3339 date-time). Only populated for items in shared drives.", "type": "string" }, "trashingUser": { "description": "Information about a Drive user.", "properties": { "displayName": { "description": "A plain text displayable name for this user.", "type": "string" }, "emailAddress": { "description": "The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.", "type": "string" }, "kind": { "default": "drive#user", "description": "Identifies what kind of resource this is. Value: the fixed string \"drive#user\".", "type": "string" }, "me": { "description": "Whether this user is the requesting user.", "type": "boolean" }, "permissionId": { "description": "The user's ID as visible in Permission resources.", "type": "string" }, "photoLink": { "description": "A link to the user's profile photo, if available.", "type": "string" } }, "type": "object" }, "version": { "description": "A monotonically increasing version number for the file. This reflects every change made to the file on the server, even those not visible to the user.", "type": "string" }, "videoMediaMetadata": { "description": "Additional metadata about video media. This may not be available immediately upon upload.", "properties": { "durationMillis": { "description": "The duration of the video in milliseconds.", "type": "string" }, "height": { "description": "The height of the video in pixels.", "type": "integer" }, "width": { "description": "The width of the video in pixels.", "type": "integer" } }, "type": "object" }, "viewedByMe": { "description": "Whether the file has been viewed by this user.", "type": "boolean" }, "viewedByMeTime": { "description": "The last time the file was viewed by the user (RFC 3339 date-time).", "type": "string" }, "viewersCanCopyContent": { "description": "Deprecated - use copyRequiresWriterPermission instead.", "type": "boolean" }, "webContentLink": { "description": "A link for downloading the content of the file in a browser. This is only available for files with binary content in Google Drive.", "type": "string" }, "webViewLink": { "description": "A link for opening the file in a relevant Google editor or viewer in a browser.", "type": "string" }, "writersCanShare": { "description": "Whether users with only writer permission can modify the file's permissions. Not populated for items in shared drives.", "type": "boolean" } }, "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/driveFilesUpdate" }, "task": true }, { "name": "driveFilesCopy", "summary": "Creates a copy of a file and applies any requested updates with patch semantics. Folders cannot be", "description": "Creates a copy of a file and applies any requested updates with patch semantics. Folders cannot be copied.", "input": [ { "name": "alt", "type": "string", "info": "Data format for the response.: Must be one of [json]", "required": false, "schema": { "title": "alt", "type": "string" } }, { "name": "fields", "type": "string", "info": "Selector specifying which fields to include in a partial response.: string", "required": false, "schema": { "title": "fields", "type": "string" } }, { "name": "key", "type": "string", "info": "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.: string", "required": false, "schema": { "title": "key", "type": "string" } }, { "name": "oauthToken", "type": "string", "info": "OAuth 2.0 token for the current user.: string", "required": false, "schema": { "title": "oauthToken", "type": "string" } }, { "name": "prettyPrint", "type": "boolean", "info": "Returns response with indentations and line breaks.: boolean", "required": false, "schema": { "title": "prettyPrint", "type": "boolean" } }, { "name": "quotaUser", "type": "string", "info": "An opaque string that represents a user for quota purposes. Must not exceed 40 characters.: string", "required": false, "schema": { "title": "quotaUser", "type": "string" } }, { "name": "userIp", "type": "string", "info": "Deprecated. Please use quotaUser instead.: string", "required": false, "schema": { "title": "userIp", "type": "string" } }, { "name": "fileId", "type": "string", "info": "The ID of the file.: string", "required": true, "schema": { "title": "fileId", "type": "string" } }, { "name": "enforceSingleParent", "type": "boolean", "info": "Deprecated. Copying files into multiple folders is no longer supported. Use shortcuts instead.: boolean", "required": false, "schema": { "title": "enforceSingleParent", "type": "boolean" } }, { "name": "ignoreDefaultVisibility", "type": "boolean", "info": "Whether to ignore the domain's default visibility settings for the created file. Domain administrators can choose to make all uploaded files visible to the domain by defa...(description truncated): boolean", "required": false, "schema": { "title": "ignoreDefaultVisibility", "type": "boolean" } }, { "name": "includePermissionsForView", "type": "string", "info": "Specifies which additional view's permissions to include in the response. Only 'published' is supported.: string", "required": false, "schema": { "title": "includePermissionsForView", "type": "string" } }, { "name": "keepRevisionForever", "type": "boolean", "info": "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...(description truncated): boolean", "required": false, "schema": { "title": "keepRevisionForever", "type": "boolean" } }, { "name": "ocrLanguage", "type": "string", "info": "A language hint for OCR processing during image import (ISO 639-1 code).: string", "required": false, "schema": { "title": "ocrLanguage", "type": "string" } }, { "name": "supportsAllDrives", "type": "boolean", "info": "Whether the requesting application supports both My Drives and shared drives.: boolean", "required": false, "schema": { "title": "supportsAllDrives", "type": "boolean" } }, { "name": "supportsTeamDrives", "type": "boolean", "info": "Deprecated use supportsAllDrives instead.: boolean", "required": false, "schema": { "title": "supportsTeamDrives", "type": "boolean" } }, { "name": "body", "type": "object", "info": ": {\"appProperties\": \"object\", \"capabilities\": {\"canAcceptOwnership\": \"boolean\", \"canAddChildren\": \"boolean\", \"canAddFolderFromAnotherDrive\": \"boolean\", \"canAddMyDriveParent\": \"boolean\", \"canChangeCopyRequiresWriterPermission\": \"boolean\", \"canChangeSecurityUpdateEnabled\": \"boolean\", \"canChangeViewersCanCopyContent\": \"boolean\", \"canComment\": \"boolean\", \"canCopy\": \"boolean\", \"canDelete\": \"boolean\", \"canDeleteChildren\": \"boolean\", \"canDownload\": \"boolean\", \"canEdit\": \"boolean\", \"canListChildren\": \"boolean\", \"canModifyContent\": \"boolean\", \"canModifyContentRestriction\": \"boolean\", \"canMoveChildrenOutOfDrive\": \"boolean\", \"canMoveChildrenOutOfTeamDrive\": \"boolean\", \"canMoveChildrenWithinDrive\": \"boolean\", \"canMoveChildrenWithinTeamDrive\": \"boolean\", \"canMoveItemIntoTeamDrive\": \"boolean\", \"canMoveItemOutOfDrive\": \"boolean\", \"canMoveItemOutOfTeamDrive\": \"boolean\", \"canMoveItemWithinDrive\": \"boolean\", \"canMoveItemWithinTeamDrive\": \"boolean\", \"canMoveTeamDriveItem\": \"boolean\", \"canReadDrive\": \"boolean\", \"canReadRevisions\": \"boolean\", \"canReadTeamDrive\": \"boolean\", \"canRemoveChildren\": \"boolean\", \"canRemoveMyDriveParent\": \"boolean\", \"canRename\": \"boolean\", \"canShare\": \"boolean\", \"canTrash\": \"boolean\", \"canTrashChildren\": \"boolean\", \"canUntrash\": \"boolean\"}, \"contentHints\": {\"indexableText\": \"string\", \"thumbnail\": {\"image\": \"string\", \"mimeType\": \"string\"}}, \"contentRestrictions\": [{\"readOnly\": \"boolean\", \"reason\": \"string\", \"restrictingUser\": {\"displayName\": \"string\", \"emailAddress\": \"string\", \"kind\": \"string\", \"me\": \"boolean\", \"permissionId\": \"string\", \"photoLink\": \"string\"}, \"restrictionTime\": \"string\", \"type\": \"string\"}], \"copyRequiresWriterPermission\": \"boolean\", \"createdTime\": \"string\", \"description\": \"string\", \"driveId\": \"string\", \"explicitlyTrashed\": \"boolean\", \"exportLinks\": \"object\", \"fileExtension\": \"string\", \"folderColorRgb\": \"string\", \"fullFileExtension\": \"string\", \"hasAugmentedPermissions\": \"boolean\", \"hasThumbnail\": \"boolean\", \"headRevisionId\": \"string\", \"iconLink\": \"string\", \"id\": \"string\", \"imageMediaMetadata\": {\"aperture\": 123, \"cameraMake\": \"string\", \"cameraModel\": \"string\", \"colorSpace\": \"string\", \"exposureBias\": 123, \"exposureMode\": \"string\", \"exposureTime\": 123, \"flashUsed\": \"boolean\", \"focalLength\": 123, \"height\": 123, \"isoSpeed\": 123, \"lens\": \"string\", \"location\": {\"altitude\": 123, \"latitude\": 123, \"longitude\": 123}, \"maxApertureValue\": 123, \"meteringMode\": \"string\", \"rotation\": 123, \"sensor\": \"string\", \"subjectDistance\": 123, \"time\": \"string\", \"whiteBalance\": \"string\", \"width\": 123}, \"isAppAuthorized\": \"boolean\", \"kind\": \"string\", \"lastModifyingUser\": {\"displayName\": \"string\", \"emailAddress\": \"string\", \"kind\": \"string\", \"me\": \"boolean\", \"permissionId\": \"string\", \"photoLink\": \"string\"}, \"linkShareMetadata\": {\"securityUpdateEligible\": \"boolean\", \"securityUpdateEnabled\": \"boolean\"}, \"md5Checksum\": \"string\", \"mimeType\": \"string\", \"modifiedByMe\": \"boolean\", \"modifiedByMeTime\": \"string\", \"modifiedTime\": \"string\", \"name\": \"string\", \"originalFilename\": \"string\", \"ownedByMe\": \"boolean\", \"owners\": [{\"displayName\": \"string\", \"emailAddress\": \"string\", \"kind\": \"string\", \"me\": \"boolean\", \"permissionId\": \"string\", \"photoLink\": \"string\"}], \"parents\": \"array\", \"permissionIds\": \"array\", \"permissions\": [{\"allowFileDiscovery\": \"boolean\", \"deleted\": \"boolean\", \"displayName\": \"string\", \"domain\": \"string\", \"emailAddress\": \"string\", \"expirationTime\": \"string\", \"id\": \"string\", \"kind\": \"string\", \"pendingOwner\": \"boolean\", \"permissionDetails\": [{\"inherited\": \"boolean\", \"inheritedFrom\": \"string\", \"permissionType\": \"string\", \"role\": \"string\"}], \"photoLink\": \"string\", \"role\": \"string\", \"teamDrivePermissionDetails\": [{\"inherited\": \"boolean\", \"inheritedFrom\": \"string\", \"role\": \"string\", \"teamDrivePermissionType\": \"string\"}], \"type\": \"string\", \"view\": \"string\"}], \"properties\": \"object\", \"quotaBytesUsed\": \"string\", \"resourceKey\": \"string\", \"shared\": \"boolean\", \"sharedWithMeTime\": \"string\", \"sharingUser\": {\"displayName\": \"string\", \"emailAddress\": \"string\", \"kind\": \"string\", \"me\": \"boolean\", \"permissionId\": \"string\", \"photoLink\": \"string\"}, \"shortcutDetails\": {\"targetId\": \"string\", \"targetMimeType\": \"string\", \"targetResourceKey\": \"string\"}, \"size\": \"string\", \"spaces\": \"array\", \"starred\": \"boolean\", \"teamDriveId\": \"string\", \"thumbnailLink\": \"string\", \"thumbnailVersion\": \"string\", \"trashed\": \"boolean\", \"trashedTime\": \"string\", \"trashingUser\": {\"displayName\": \"string\", \"emailAddress\": \"string\", \"kind\": \"string\", \"me\": \"boolean\", \"permissionId\": \"string\", \"photoLink\": \"string\"}, \"version\": \"string\", \"videoMediaMetadata\": {\"durationMillis\": \"string\", \"height\": 123, \"width\": 123}, \"viewedByMe\": \"boolean\", \"viewedByMeTime\": \"string\", \"viewersCanCopyContent\": \"boolean\", \"webContentLink\": \"string\", \"webViewLink\": \"string\", \"writersCanShare\": \"boolean\"}", "required": false, "schema": { "description": "The metadata for a file.", "properties": { "appProperties": { "additionalProperties": { "type": "string" }, "description": "A collection of arbitrary key-value pairs which are private to the requesting app.\nEntries with null values are cleared in update and copy requests. These properties can only be retrieved using an authenticated request. An authenticated request uses an access token obtained with a OAuth 2 client ID. You cannot use an API key to retrieve private properties.", "type": "object" }, "capabilities": { "description": "Capabilities the current user has on this file. Each capability corresponds to a fine-grained action that a user may take.", "properties": { "canAcceptOwnership": { "description": "Whether the current user is the pending owner of the file. Not populated for shared drive files.", "type": "boolean" }, "canAddChildren": { "description": "Whether the current user can add children to this folder. This is always false when the item is not a folder.", "type": "boolean" }, "canAddFolderFromAnotherDrive": { "description": "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 is not a folder. Only populated for items in shared drives.", "type": "boolean" }, "canAddMyDriveParent": { "description": "Whether the current user can add a parent for the item without removing an existing parent in the same request. Not populated for shared drive files.", "type": "boolean" }, "canChangeCopyRequiresWriterPermission": { "description": "Whether the current user can change the copyRequiresWriterPermission restriction of this file.", "type": "boolean" }, "canChangeSecurityUpdateEnabled": { "description": "Whether the current user can change the securityUpdateEnabled field on link share metadata.", "type": "boolean" }, "canChangeViewersCanCopyContent": { "description": "Deprecated", "type": "boolean" }, "canComment": { "description": "Whether the current user can comment on this file.", "type": "boolean" }, "canCopy": { "description": "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 itself if it is not a folder.", "type": "boolean" }, "canDelete": { "description": "Whether the current user can delete this file.", "type": "boolean" }, "canDeleteChildren": { "description": "Whether the current user can delete children of this folder. This is false when the item is not a folder. Only populated for items in shared drives.", "type": "boolean" }, "canDownload": { "description": "Whether the current user can download this file.", "type": "boolean" }, "canEdit": { "description": "Whether the current user can edit this file. Other factors may limit the type of changes a user can make to a file. For example, see canChangeCopyRequiresWriterPermission or canModifyContent.", "type": "boolean" }, "canListChildren": { "description": "Whether the current user can list the children of this folder. This is always false when the item is not a folder.", "type": "boolean" }, "canModifyContent": { "description": "Whether the current user can modify the content of this file.", "type": "boolean" }, "canModifyContentRestriction": { "description": "Whether the current user can modify restrictions on content of this file.", "type": "boolean" }, "canMoveChildrenOutOfDrive": { "description": "Whether the current user can move children of this folder outside of the shared drive. This is false when the item is not a folder. Only populated for items in shared drives.", "type": "boolean" }, "canMoveChildrenOutOfTeamDrive": { "description": "Deprecated - use canMoveChildrenOutOfDrive instead.", "type": "boolean" }, "canMoveChildrenWithinDrive": { "description": "Whether the current user can move children of this folder within this drive. This is false when the item is not 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.", "type": "boolean" }, "canMoveChildrenWithinTeamDrive": { "description": "Deprecated - use canMoveChildrenWithinDrive instead.", "type": "boolean" }, "canMoveItemIntoTeamDrive": { "description": "Deprecated - use canMoveItemOutOfDrive instead.", "type": "boolean" }, "canMoveItemOutOfDrive": { "description": "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 is being added.", "type": "boolean" }, "canMoveItemOutOfTeamDrive": { "description": "Deprecated - use canMoveItemOutOfDrive instead.", "type": "boolean" }, "canMoveItemWithinDrive": { "description": "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 is being added and the parent that is being removed.", "type": "boolean" }, "canMoveItemWithinTeamDrive": { "description": "Deprecated - use canMoveItemWithinDrive instead.", "type": "boolean" }, "canMoveTeamDriveItem": { "description": "Deprecated - use canMoveItemWithinDrive or canMoveItemOutOfDrive instead.", "type": "boolean" }, "canReadDrive": { "description": "Whether the current user can read the shared drive to which this file belongs. Only populated for items in shared drives.", "type": "boolean" }, "canReadRevisions": { "description": "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 itself if it is not a folder, can be read.", "type": "boolean" }, "canReadTeamDrive": { "description": "Deprecated - use canReadDrive instead.", "type": "boolean" }, "canRemoveChildren": { "description": "Whether the current user can remove children from this folder. This is always false when the item is not a folder. For a folder in a shared drive, use canDeleteChildren or canTrashChildren instead.", "type": "boolean" }, "canRemoveMyDriveParent": { "description": "Whether the current user can remove a parent from the item without adding another parent in the same request. Not populated for shared drive files.", "type": "boolean" }, "canRename": { "description": "Whether the current user can rename this file.", "type": "boolean" }, "canShare": { "description": "Whether the current user can modify the sharing settings for this file.", "type": "boolean" }, "canTrash": { "description": "Whether the current user can move this file to trash.", "type": "boolean" }, "canTrashChildren": { "description": "Whether the current user can trash children of this folder. This is false when the item is not a folder. Only populated for items in shared drives.", "type": "boolean" }, "canUntrash": { "description": "Whether the current user can restore this file from trash.", "type": "boolean" } }, "type": "object" }, "contentHints": { "description": "Additional information about the content of the file. These fields are never populated in responses.", "properties": { "indexableText": { "description": "Text to be indexed for the file to improve fullText queries. This is limited to 128KB in length and may contain HTML elements.", "type": "string" }, "thumbnail": { "description": "A thumbnail for the file. This will only be used if Google Drive cannot generate a standard thumbnail.", "properties": { "image": { "description": "The thumbnail data encoded with URL-safe Base64 (RFC 4648 section 5).", "type": "string" }, "mimeType": { "description": "The MIME type of the thumbnail.", "type": "string" } }, "type": "object" } }, "type": "object" }, "contentRestrictions": { "description": "Restrictions for accessing the content of the file. Only populated if such a restriction exists.", "items": { "description": "A restriction for accessing the content of the file.", "properties": { "readOnly": { "description": "Whether the content of the file is read-only. If a file is read-only, a new revision of the file may not be added, comments may not be added or modified, and the title of the file may not be modified.", "type": "boolean" }, "reason": { "description": "Reason for why the content of the file is restricted. This is only mutable on requests that also set readOnly=true.", "type": "string" }, "restrictingUser": { "description": "Information about a Drive user.", "properties": { "displayName": { "description": "A plain text displayable name for this user.", "type": "string" }, "emailAddress": { "description": "The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.", "type": "string" }, "kind": { "default": "drive#user", "description": "Identifies what kind of resource this is. Value: the fixed string \"drive#user\".", "type": "string" }, "me": { "description": "Whether this user is the requesting user.", "type": "boolean" }, "permissionId": { "description": "The user's ID as visible in Permission resources.", "type": "string" }, "photoLink": { "description": "A link to the user's profile photo, if available.", "type": "string" } }, "type": "object" }, "restrictionTime": { "description": "The time at which the content restriction was set (formatted RFC 3339 timestamp). Only populated if readOnly is true.", "type": "string" }, "type": { "description": "The type of the content restriction. Currently the only possible value is globalContentRestriction.", "type": "string" } }, "type": "object" }, "type": "array" }, "copyRequiresWriterPermission": { "description": "Whether the options to copy, print, or download this file, should be disabled for readers and commenters.", "type": "boolean" }, "createdTime": { "description": "The time at which the file was created (RFC 3339 date-time).", "type": "string" }, "description": { "description": "A short description of the file.", "type": "string" }, "driveId": { "description": "ID of the shared drive the file resides in. Only populated for items in shared drives.", "type": "string" }, "explicitlyTrashed": { "description": "Whether the file has been explicitly trashed, as opposed to recursively trashed from a parent folder.", "type": "boolean" }, "exportLinks": { "additionalProperties": { "description": "A mapping from export format to URL", "type": "string" }, "description": "Links for exporting Docs Editors files to specific formats.", "readOnly": true, "type": "object" }, "fileExtension": { "description": "The final component of fullFileExtension. This is only available for files with binary content in Google Drive.", "type": "string" }, "folderColorRgb": { "description": "The color for a folder or shortcut to a folder as an RGB hex string. The supported colors are published in the folderColorPalette field of the About resource.\nIf an unsupported color is specified, the closest color in the palette will be used instead.", "type": "string" }, "fullFileExtension": { "description": "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.\nThis is automatically updated when the name field changes, however it is not cleared if the new name does not contain a valid extension.", "type": "string" }, "hasAugmentedPermissions": { "description": "Whether there are permissions directly on this file. This field is only populated for items in shared drives.", "type": "boolean" }, "hasThumbnail": { "description": "Whether this file has a thumbnail. This does not indicate whether the requesting app has access to the thumbnail. To check access, look for the presence of the thumbnailLink field.", "type": "boolean" }, "headRevisionId": { "description": "The ID of the file's head revision. This is currently only available for files with binary content in Google Drive.", "type": "string" }, "iconLink": { "description": "A static, unauthenticated link to the file's icon.", "type": "string" }, "id": { "description": "The ID of the file.", "type": "string" }, "imageMediaMetadata": { "description": "Additional metadata about image media, if available.", "properties": { "aperture": { "description": "The aperture used to create the photo (f-number).", "type": "number" }, "cameraMake": { "description": "The make of the camera used to create the photo.", "type": "string" }, "cameraModel": { "description": "The model of the camera used to create the photo.", "type": "string" }, "colorSpace": { "description": "The color space of the photo.", "type": "string" }, "exposureBias": { "description": "The exposure bias of the photo (APEX value).", "type": "number" }, "exposureMode": { "description": "The exposure mode used to create the photo.", "type": "string" }, "exposureTime": { "description": "The length of the exposure, in seconds.", "type": "number" }, "flashUsed": { "description": "Whether a flash was used to create the photo.", "type": "boolean" }, "focalLength": { "description": "The focal length used to create the photo, in millimeters.", "type": "number" }, "height": { "description": "The height of the image in pixels.", "type": "integer" }, "isoSpeed": { "description": "The ISO speed used to create the photo.", "type": "integer" }, "lens": { "description": "The lens used to create the photo.", "type": "string" }, "location": { "description": "Geographic location information stored in the image.", "properties": { "altitude": { "description": "The altitude stored in the image.", "type": "number" }, "latitude": { "description": "The latitude stored in the image.", "type": "number" }, "longitude": { "description": "The longitude stored in the image.", "type": "number" } }, "type": "object" }, "maxApertureValue": { "description": "The smallest f-number of the lens at the focal length used to create the photo (APEX value).", "type": "number" }, "meteringMode": { "description": "The metering mode used to create the photo.", "type": "string" }, "rotation": { "description": "The number of clockwise 90 degree rotations applied from the image's original orientation.", "type": "integer" }, "sensor": { "description": "The type of sensor used to create the photo.", "type": "string" }, "subjectDistance": { "description": "The distance to the subject of the photo, in meters.", "type": "integer" }, "time": { "description": "The date and time the photo was taken (EXIF DateTime).", "type": "string" }, "whiteBalance": { "description": "The white balance mode used to create the photo.", "type": "string" }, "width": { "description": "The width of the image in pixels.", "type": "integer" } }, "type": "object" }, "isAppAuthorized": { "description": "Whether the file was created or opened by the requesting app.", "type": "boolean" }, "kind": { "default": "drive#file", "description": "Identifies what kind of resource this is. Value: the fixed string \"drive#file\".", "type": "string" }, "lastModifyingUser": { "description": "Information about a Drive user.", "properties": { "displayName": { "description": "A plain text displayable name for this user.", "type": "string" }, "emailAddress": { "description": "The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.", "type": "string" }, "kind": { "default": "drive#user", "description": "Identifies what kind of resource this is. Value: the fixed string \"drive#user\".", "type": "string" }, "me": { "description": "Whether this user is the requesting user.", "type": "boolean" }, "permissionId": { "description": "The user's ID as visible in Permission resources.", "type": "string" }, "photoLink": { "description": "A link to the user's profile photo, if available.", "type": "string" } }, "type": "object" }, "linkShareMetadata": { "description": "Contains details about the link URLs that clients are using to refer to this item.", "properties": { "securityUpdateEligible": { "description": "Whether the file is eligible for security update.", "type": "boolean" }, "securityUpdateEnabled": { "description": "Whether the security update is enabled for this file.", "type": "boolean" } }, "type": "object" }, "md5Checksum": { "description": "The MD5 checksum for the content of the file. This is only applicable to files with binary content in Google Drive.", "type": "string" }, "mimeType": { "description": "The MIME type of the file.\nGoogle Drive will attempt 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.\nIf a file is created with a Google Doc MIME type, the uploaded content will be imported if possible. The supported import formats are published in the About resource.", "type": "string" }, "modifiedByMe": { "description": "Whether the file has been modified by this user.", "type": "boolean" }, "modifiedByMeTime": { "description": "The last time the file was modified by the user (RFC 3339 date-time).", "type": "string" }, "modifiedTime": { "description": "The last time the file was modified by anyone (RFC 3339 date-time).\nNote that setting modifiedTime will also update modifiedByMeTime for the user.", "type": "string" }, "name": { "description": "The name of the file. This is not necessarily unique within a folder. Note that for immutable items such as the top level folders of shared drives, My Drive root folder, and Application Data folder the name is constant.", "type": "string" }, "originalFilename": { "description": "The original filename of the uploaded content if available, or else the original value of the name field. This is only available for files with binary content in Google Drive.", "type": "string" }, "ownedByMe": { "description": "Whether the user owns the file. Not populated for items in shared drives.", "type": "boolean" }, "owners": { "description": "The owner of this file. Only certain legacy files may have more than one owner. This field isn't populated for items in shared drives.", "items": { "description": "Information about a Drive user.", "properties": { "displayName": { "description": "A plain text displayable name for this user.", "type": "string" }, "emailAddress": { "description": "The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.", "type": "string" }, "kind": { "default": "drive#user", "description": "Identifies what kind of resource this is. Value: the fixed string \"drive#user\".", "type": "string" }, "me": { "description": "Whether this user is the requesting user.", "type": "boolean" }, "permissionId": { "description": "The user's ID as visible in Permission resources.", "type": "string" }, "photoLink": { "description": "A link to the user's profile photo, if available.", "type": "string" } }, "type": "object" }, "type": "array" }, "parents": { "description": "The IDs of the parent folders which contain the file.\nIf not specified as part of a create request, the file will be placed directly in the user's My Drive folder. If not specified as part of a copy request, the file will inherit any discoverable parents of the source file. Update requests must use the addParents and removeParents parameters to modify the parents list.", "items": { "type": "string" }, "type": "array" }, "permissionIds": { "description": "List of permission IDs for users with access to this file.", "items": { "type": "string" }, "type": "array" }, "permissions": { "description": "The full list of permissions for the file. This is only available if the requesting user can share the file. Not populated for items in shared drives.", "items": { "description": "A permission for a file. A permission grants a user, group, domain or the world access to a file or a folder hierarchy.", "properties": { "allowFileDiscovery": { "description": "Whether the permission allows the file to be discovered through search. This is only applicable for permissions of type domain or anyone.", "type": "boolean" }, "deleted": { "description": "Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions.", "type": "boolean" }, "displayName": { "description": "The \"pretty\" name of the value of the permission. The following is a list of examples for each type of permission: \n- user - User's full name, as defined for their Google account, such as \"Joe Smith.\" \n- group - Name of the Google Group, such as \"The Company Administrators.\" \n- domain - String domain name, such as \"thecompany.com.\" \n- anyone - No displayName is present.", "type": "string" }, "domain": { "description": "The domain to which this permission refers.", "type": "string" }, "emailAddress": { "description": "The email address of the user or group to which this permission refers.", "type": "string" }, "expirationTime": { "description": "The time at which this permission will expire (RFC 3339 date-time). Expiration times have the following restrictions: \n- They can only be set on user and group permissions \n- The time must be in the future \n- The time cannot be more than a year in the future", "type": "string" }, "id": { "description": "The ID of this permission. This is a unique identifier for the grantee, and is published in User resources as permissionId. IDs should be treated as opaque values.", "type": "string" }, "kind": { "default": "drive#permission", "description": "Identifies what kind of resource this is. Value: the fixed string \"drive#permission\".", "type": "string" }, "pendingOwner": { "description": "Whether the account associated with this permission is a pending owner. Only populated for user type permissions for files that are not in a shared drive.", "type": "boolean" }, "permissionDetails": { "description": "Details of whether the permissions on this shared drive item are inherited or directly on this item. This is an output-only field which is present only for shared drive items.", "items": { "properties": { "inherited": { "description": "Whether this permission is inherited. This field is always populated. This is an output-only field.", "type": "boolean" }, "inheritedFrom": { "description": "The ID of the item from which this permission is inherited. This is an output-only field.", "type": "string" }, "permissionType": { "description": "The permission type for this user. While new values may be added in future, the following are currently possible: \n- file \n- member", "type": "string" }, "role": { "description": "The primary role for this user. While new values may be added in the future, the following are currently possible: \n- organizer \n- fileOrganizer \n- writer \n- commenter \n- reader", "type": "string" } }, "type": "object" }, "readOnly": true, "type": "array" }, "photoLink": { "description": "A link to the user's profile photo, if available.", "type": "string" }, "role": { "description": "The role granted by this permission. While new values may be supported in the future, the following are currently allowed: \n- owner \n- organizer \n- fileOrganizer \n- writer \n- commenter \n- reader", "type": "string" }, "teamDrivePermissionDetails": { "description": "Deprecated - use permissionDetails instead.", "items": { "properties": { "inherited": { "description": "Deprecated - use permissionDetails/inherited instead.", "type": "boolean" }, "inheritedFrom": { "description": "Deprecated - use permissionDetails/inheritedFrom instead.", "type": "string" }, "role": { "description": "Deprecated - use permissionDetails/role instead.", "type": "string" }, "teamDrivePermissionType": { "description": "Deprecated - use permissionDetails/permissionType instead.", "type": "string" } }, "type": "object" }, "readOnly": true, "type": "array" }, "type": { "description": "The type of the grantee. Valid values are: \n- user \n- group \n- domain \n- anyone When creating a permission, if type is user or group, you must provide an emailAddress for the user or group. When type is domain, you must provide a domain. There isn't extra information required for a anyone type.", "type": "string" }, "view": { "description": "Indicates the view for this permission. Only populated for permissions that belong to a view. published is the only supported value.", "type": "string" } }, "type": "object" }, "type": "array" }, "properties": { "additionalProperties": { "type": "string" }, "description": "A collection of arbitrary key-value pairs which are visible to all apps.\nEntries with null values are cleared in update and copy requests.", "type": "object" }, "quotaBytesUsed": { "description": "The number of storage quota bytes used by the file. This includes the head revision as well as previous revisions with keepForever enabled.", "type": "string" }, "resourceKey": { "description": "A key needed to access the item via a shared link.", "type": "string" }, "shared": { "description": "Whether the file has been shared. Not populated for items in shared drives.", "type": "boolean" }, "sharedWithMeTime": { "description": "The time at which the file was shared with the user, if applicable (RFC 3339 date-time).", "type": "string" }, "sharingUser": { "description": "Information about a Drive user.", "properties": { "displayName": { "description": "A plain text displayable name for this user.", "type": "string" }, "emailAddress": { "description": "The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.", "type": "string" }, "kind": { "default": "drive#user", "description": "Identifies what kind of resource this is. Value: the fixed string \"drive#user\".", "type": "string" }, "me": { "description": "Whether this user is the requesting user.", "type": "boolean" }, "permissionId": { "description": "The user's ID as visible in Permission resources.", "type": "string" }, "photoLink": { "description": "A link to the user's profile photo, if available.", "type": "string" } }, "type": "object" }, "shortcutDetails": { "description": "Shortcut file details. Only populated for shortcut files, which have the mimeType field set to application/vnd.google-apps.shortcut.", "properties": { "targetId": { "description": "The ID of the file that this shortcut points to.", "type": "string" }, "targetMimeType": { "description": "The MIME type of the file that this shortcut points to. The value of this field is a snapshot of the target's MIME type, captured when the shortcut is created.", "type": "string" }, "targetResourceKey": { "description": "The ResourceKey for the target file.", "type": "string" } }, "type": "object" }, "size": { "description": "The size of the file's content in bytes. This is applicable to binary files in Google Drive and Google Docs files.", "type": "string" }, "spaces": { "description": "The list of spaces which contain the file. The currently supported values are 'drive', 'appDataFolder' and 'photos'.", "items": { "type": "string" }, "type": "array" }, "starred": { "description": "Whether the user has starred the file.", "type": "boolean" }, "teamDriveId": { "description": "Deprecated - use driveId instead.", "type": "string" }, "thumbnailLink": { "description": "A short-lived link to the file's thumbnail, if available. Typically lasts on the order of hours. 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.", "type": "string" }, "thumbnailVersion": { "description": "The thumbnail version for use in thumbnail cache invalidation.", "type": "string" }, "trashed": { "description": "Whether the file has been trashed, either explicitly or from a trashed parent folder. Only the owner may trash a file. The trashed item is excluded from all files.list responses returned for any user who does not own the file. However, all users with access to the file can see the trashed item metadata in an API response. All users with access can copy, download, export, and share the file.", "type": "boolean" }, "trashedTime": { "description": "The time that the item was trashed (RFC 3339 date-time). Only populated for items in shared drives.", "type": "string" }, "trashingUser": { "description": "Information about a Drive user.", "properties": { "displayName": { "description": "A plain text displayable name for this user.", "type": "string" }, "emailAddress": { "description": "The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.", "type": "string" }, "kind": { "default": "drive#user", "description": "Identifies what kind of resource this is. Value: the fixed string \"drive#user\".", "type": "string" }, "me": { "description": "Whether this user is the requesting user.", "type": "boolean" }, "permissionId": { "description": "The user's ID as visible in Permission resources.", "type": "string" }, "photoLink": { "description": "A link to the user's profile photo, if available.", "type": "string" } }, "type": "object" }, "version": { "description": "A monotonically increasing version number for the file. This reflects every change made to the file on the server, even those not visible to the user.", "type": "string" }, "videoMediaMetadata": { "description": "Additional metadata about video media. This may not be available immediately upon upload.", "properties": { "durationMillis": { "description": "The duration of the video in milliseconds.", "type": "string" }, "height": { "description": "The height of the video in pixels.", "type": "integer" }, "width": { "description": "The width of the video in pixels.", "type": "integer" } }, "type": "object" }, "viewedByMe": { "description": "Whether the file has been viewed by this user.", "type": "boolean" }, "viewedByMeTime": { "description": "The last time the file was viewed by the user (RFC 3339 date-time).", "type": "string" }, "viewersCanCopyContent": { "description": "Deprecated - use copyRequiresWriterPermission instead.", "type": "boolean" }, "webContentLink": { "description": "A link for downloading the content of the file in a browser. This is only available for files with binary content in Google Drive.", "type": "string" }, "webViewLink": { "description": "A link for opening the file in a relevant Google editor or viewer in a browser.", "type": "string" }, "writersCanShare": { "description": "Whether users with only writer permission can modify the file's permissions. Not populated for items in shared drives.", "type": "boolean" } }, "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/driveFilesCopy" }, "task": true }, { "name": "driveFilesExport", "summary": "Exports a Google Workspace document to the requested MIME type and returns exported byte content. N", "description": "Exports a Google Workspace document to the requested MIME type and returns exported byte content. Note that the exported content is limited to 10MB.", "input": [ { "name": "alt", "type": "string", "info": "Data format for the response.: Must be one of [json]", "required": false, "schema": { "title": "alt", "type": "string" } }, { "name": "fields", "type": "string", "info": "Selector specifying which fields to include in a partial response.: string", "required": false, "schema": { "title": "fields", "type": "string" } }, { "name": "key", "type": "string", "info": "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.: string", "required": false, "schema": { "title": "key", "type": "string" } }, { "name": "oauthToken", "type": "string", "info": "OAuth 2.0 token for the current user.: string", "required": false, "schema": { "title": "oauthToken", "type": "string" } }, { "name": "prettyPrint", "type": "boolean", "info": "Returns response with indentations and line breaks.: boolean", "required": false, "schema": { "title": "prettyPrint", "type": "boolean" } }, { "name": "quotaUser", "type": "string", "info": "An opaque string that represents a user for quota purposes. Must not exceed 40 characters.: string", "required": false, "schema": { "title": "quotaUser", "type": "string" } }, { "name": "userIp", "type": "string", "info": "Deprecated. Please use quotaUser instead.: string", "required": false, "schema": { "title": "userIp", "type": "string" } }, { "name": "fileId", "type": "string", "info": "The ID of the file.: string", "required": true, "schema": { "title": "fileId", "type": "string" } }, { "name": "mimeType", "type": "string", "info": "The MIME type of the format requested for this export.: string", "required": true, "schema": { "title": "mimeType", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/driveFilesExport" }, "task": true }, { "name": "driveFilesWatch", "summary": "Subscribes to changes to a file. While you can establish a channel forchanges to a file on a shared", "description": "Subscribes to changes to a file. While you can establish a channel forchanges to a file on a shared drive, a change to a shared drive file won't create a notification.", "input": [ { "name": "alt", "type": "string", "info": "Data format for the response.: Must be one of [json]", "required": false, "schema": { "title": "alt", "type": "string" } }, { "name": "fields", "type": "string", "info": "Selector specifying which fields to include in a partial response.: string", "required": false, "schema": { "title": "fields", "type": "string" } }, { "name": "key", "type": "string", "info": "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.: string", "required": false, "schema": { "title": "key", "type": "string" } }, { "name": "oauthToken", "type": "string", "info": "OAuth 2.0 token for the current user.: string", "required": false, "schema": { "title": "oauthToken", "type": "string" } }, { "name": "prettyPrint", "type": "boolean", "info": "Returns response with indentations and line breaks.: boolean", "required": false, "schema": { "title": "prettyPrint", "type": "boolean" } }, { "name": "quotaUser", "type": "string", "info": "An opaque string that represents a user for quota purposes. Must not exceed 40 characters.: string", "required": false, "schema": { "title": "quotaUser", "type": "string" } }, { "name": "userIp", "type": "string", "info": "Deprecated. Please use quotaUser instead.: string", "required": false, "schema": { "title": "userIp", "type": "string" } }, { "name": "fileId", "type": "string", "info": "The ID of the file.: string", "required": true, "schema": { "title": "fileId", "type": "string" } }, { "name": "acknowledgeAbuse", "type": "boolean", "info": "Whether the user is acknowledging the risk of downloading known malware or other abusive files. This is only applicable when alt=media.: boolean", "required": false, "schema": { "title": "acknowledgeAbuse", "type": "boolean" } }, { "name": "includePermissionsForView", "type": "string", "info": "Specifies which additional view's permissions to include in the response. Only 'published' is supported.: string", "required": false, "schema": { "title": "includePermissionsForView", "type": "string" } }, { "name": "supportsAllDrives", "type": "boolean", "info": "Whether the requesting application supports both My Drives and shared drives.: boolean", "required": false, "schema": { "title": "supportsAllDrives", "type": "boolean" } }, { "name": "supportsTeamDrives", "type": "boolean", "info": "Deprecated use supportsAllDrives instead.: boolean", "required": false, "schema": { "title": "supportsTeamDrives", "type": "boolean" } }, { "name": "body", "type": "object", "info": ": {\"address\": \"string\", \"expiration\": \"string\", \"id\": \"string\", \"kind\": \"string\", \"params\": \"object\", \"payload\": \"boolean\", \"resourceId\": \"string\", \"resourceUri\": \"string\", \"token\": \"string\", \"type\": \"string\"}", "required": false, "schema": { "description": "An notification channel used to watch for resource changes.", "properties": { "address": { "description": "The address where notifications are delivered for this channel.", "type": "string" }, "expiration": { "description": "Date and time of notification channel expiration, expressed as a Unix timestamp, in milliseconds. Optional.", "type": "string" }, "id": { "description": "A UUID or similar unique string that identifies this channel.", "type": "string" }, "kind": { "default": "api#channel", "description": "Identifies this as a notification channel used to watch for changes to a resource, which is \"api#channel\".", "type": "string" }, "params": { "additionalProperties": { "description": "Declares a new parameter by name.", "type": "string" }, "description": "Additional parameters controlling delivery channel behavior. Optional.", "type": "object" }, "payload": { "description": "A Boolean value to indicate whether payload is wanted. Optional.", "type": "boolean" }, "resourceId": { "description": "An opaque ID that identifies the resource being watched on this channel. Stable across different API versions.", "type": "string" }, "resourceUri": { "description": "A version-specific identifier for the watched resource.", "type": "string" }, "token": { "description": "An arbitrary string delivered to the target address with each notification delivered over this channel. Optional.", "type": "string" }, "type": { "description": "The type of delivery mechanism used for this channel. Valid values are \"web_hook\" (or \"webhook\"). Both values refer to a channel where Http requests are used to deliver messages.", "type": "string" } }, "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/driveFilesWatch" }, "task": true }, { "name": "driveCommentsList", "summary": "Lists a file's comments.", "description": "Lists a file's comments.", "input": [ { "name": "alt", "type": "string", "info": "Data format for the response.: Must be one of [json]", "required": false, "schema": { "title": "alt", "type": "string" } }, { "name": "fields", "type": "string", "info": "Selector specifying which fields to include in a partial response.: string", "required": false, "schema": { "title": "fields", "type": "string" } }, { "name": "key", "type": "string", "info": "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.: string", "required": false, "schema": { "title": "key", "type": "string" } }, { "name": "oauthToken", "type": "string", "info": "OAuth 2.0 token for the current user.: string", "required": false, "schema": { "title": "oauthToken", "type": "string" } }, { "name": "prettyPrint", "type": "boolean", "info": "Returns response with indentations and line breaks.: boolean", "required": false, "schema": { "title": "prettyPrint", "type": "boolean" } }, { "name": "quotaUser", "type": "string", "info": "An opaque string that represents a user for quota purposes. Must not exceed 40 characters.: string", "required": false, "schema": { "title": "quotaUser", "type": "string" } }, { "name": "userIp", "type": "string", "info": "Deprecated. Please use quotaUser instead.: string", "required": false, "schema": { "title": "userIp", "type": "string" } }, { "name": "fileId", "type": "string", "info": "The ID of the file.: string", "required": true, "schema": { "title": "fileId", "type": "string" } }, { "name": "includeDeleted", "type": "boolean", "info": "Whether to include deleted comments. Deleted comments will not include their original content.: boolean", "required": false, "schema": { "title": "includeDeleted", "type": "boolean" } }, { "name": "pageSize", "type": "number", "info": "The maximum number of comments to return per page.: 123", "required": false, "schema": { "title": "pageSize", "type": "number" } }, { "name": "pageToken", "type": "string", "info": "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.: string", "required": false, "schema": { "title": "pageToken", "type": "string" } }, { "name": "startModifiedTime", "type": "string", "info": "The minimum value of 'modifiedTime' for the result comments (RFC 3339 date-time).: string", "required": false, "schema": { "title": "startModifiedTime", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/driveCommentsList" }, "task": true }, { "name": "driveCommentsCreate", "summary": "Creates a new comment on a file.", "description": "Creates a new comment on a file.", "input": [ { "name": "alt", "type": "string", "info": "Data format for the response.: Must be one of [json]", "required": false, "schema": { "title": "alt", "type": "string" } }, { "name": "fields", "type": "string", "info": "Selector specifying which fields to include in a partial response.: string", "required": false, "schema": { "title": "fields", "type": "string" } }, { "name": "key", "type": "string", "info": "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.: string", "required": false, "schema": { "title": "key", "type": "string" } }, { "name": "oauthToken", "type": "string", "info": "OAuth 2.0 token for the current user.: string", "required": false, "schema": { "title": "oauthToken", "type": "string" } }, { "name": "prettyPrint", "type": "boolean", "info": "Returns response with indentations and line breaks.: boolean", "required": false, "schema": { "title": "prettyPrint", "type": "boolean" } }, { "name": "quotaUser", "type": "string", "info": "An opaque string that represents a user for quota purposes. Must not exceed 40 characters.: string", "required": false, "schema": { "title": "quotaUser", "type": "string" } }, { "name": "userIp", "type": "string", "info": "Deprecated. Please use quotaUser instead.: string", "required": false, "schema": { "title": "userIp", "type": "string" } }, { "name": "fileId", "type": "string", "info": "The ID of the file.: string", "required": true, "schema": { "title": "fileId", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"anchor\": \"string\", \"author\": {\"displayName\": \"string\", \"emailAddress\": \"string\", \"kind\": \"string\", \"me\": \"boolean\", \"permissionId\": \"string\", \"photoLink\": \"string\"}, \"content\": \"string\", \"createdTime\": \"string\", \"deleted\": \"boolean\", \"htmlContent\": \"string\", \"id\": \"string\", \"kind\": \"string\", \"modifiedTime\": \"string\", \"quotedFileContent\": {\"mimeType\": \"string\", \"value\": \"string\"}, \"replies\": [{\"action\": \"string\", \"author\": {\"displayName\": \"string\", \"emailAddress\": \"string\", \"kind\": \"string\", \"me\": \"boolean\", \"permissionId\": \"string\", \"photoLink\": \"string\"}, \"content\": \"string\", \"createdTime\": \"string\", \"deleted\": \"boolean\", \"htmlContent\": \"string\", \"id\": \"string\", \"kind\": \"string\", \"modifiedTime\": \"string\"}], \"resolved\": \"boolean\"}", "required": false, "schema": { "description": "A comment on a file.", "properties": { "anchor": { "description": "A region of the document represented as a JSON string. For details on defining anchor properties, refer to Add comments and replies.", "type": "string" }, "author": { "description": "Information about a Drive user.", "properties": { "displayName": { "description": "A plain text displayable name for this user.", "type": "string" }, "emailAddress": { "description": "The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.", "type": "string" }, "kind": { "default": "drive#user", "description": "Identifies what kind of resource this is. Value: the fixed string \"drive#user\".", "type": "string" }, "me": { "description": "Whether this user is the requesting user.", "type": "boolean" }, "permissionId": { "description": "The user's ID as visible in Permission resources.", "type": "string" }, "photoLink": { "description": "A link to the user's profile photo, if available.", "type": "string" } }, "type": "object" }, "content": { "description": "The plain text content of the comment. This field is used for setting the content, while htmlContent should be displayed.", "type": "string" }, "createdTime": { "description": "The time at which the comment was created (RFC 3339 date-time).", "type": "string" }, "deleted": { "description": "Whether the comment has been deleted. A deleted comment has no content.", "type": "boolean" }, "htmlContent": { "description": "The content of the comment with HTML formatting.", "type": "string" }, "id": { "description": "The ID of the comment.", "type": "string" }, "kind": { "default": "drive#comment", "description": "Identifies what kind of resource this is. Value: the fixed string \"drive#comment\".", "type": "string" }, "modifiedTime": { "description": "The last time the comment or any of its replies was modified (RFC 3339 date-time).", "type": "string" }, "quotedFileContent": { "description": "The file content to which the comment refers, typically within the anchor region. For a text file, for example, this would be the text at the location of the comment.", "properties": { "mimeType": { "description": "The MIME type of the quoted content.", "type": "string" }, "value": { "description": "The quoted content itself. This is interpreted as plain text if set through the API.", "type": "string" } }, "type": "object" }, "replies": { "description": "The full list of replies to the comment in chronological order.", "items": { "description": "A reply to a comment on a file.", "properties": { "action": { "description": "The action the reply performed to the parent comment. Valid values are: \n- resolve \n- reopen", "type": "string" }, "author": { "description": "Information about a Drive user.", "properties": { "displayName": { "description": "A plain text displayable name for this user.", "type": "string" }, "emailAddress": { "description": "The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.", "type": "string" }, "kind": { "default": "drive#user", "description": "Identifies what kind of resource this is. Value: the fixed string \"drive#user\".", "type": "string" }, "me": { "description": "Whether this user is the requesting user.", "type": "boolean" }, "permissionId": { "description": "The user's ID as visible in Permission resources.", "type": "string" }, "photoLink": { "description": "A link to the user's profile photo, if available.", "type": "string" } }, "type": "object" }, "content": { "description": "The plain text content of the reply. This field is used for setting the content, while htmlContent should be displayed. This is required on creates if no action is specified.", "type": "string" }, "createdTime": { "description": "The time at which the reply was created (RFC 3339 date-time).", "type": "string" }, "deleted": { "description": "Whether the reply has been deleted. A deleted reply has no content.", "type": "boolean" }, "htmlContent": { "description": "The content of the reply with HTML formatting.", "type": "string" }, "id": { "description": "The ID of the reply.", "type": "string" }, "kind": { "default": "drive#reply", "description": "Identifies what kind of resource this is. Value: the fixed string \"drive#reply\".", "type": "string" }, "modifiedTime": { "description": "The last time the reply was modified (RFC 3339 date-time).", "type": "string" } }, "type": "object" }, "type": "array" }, "resolved": { "description": "Whether the comment has been resolved by one of its replies.", "type": "boolean" } }, "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/driveCommentsCreate" }, "task": true }, { "name": "driveCommentsDelete", "summary": "Deletes a comment.", "description": "Deletes a comment.", "input": [ { "name": "alt", "type": "string", "info": "Data format for the response.: Must be one of [json]", "required": false, "schema": { "title": "alt", "type": "string" } }, { "name": "fields", "type": "string", "info": "Selector specifying which fields to include in a partial response.: string", "required": false, "schema": { "title": "fields", "type": "string" } }, { "name": "key", "type": "string", "info": "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.: string", "required": false, "schema": { "title": "key", "type": "string" } }, { "name": "oauthToken", "type": "string", "info": "OAuth 2.0 token for the current user.: string", "required": false, "schema": { "title": "oauthToken", "type": "string" } }, { "name": "prettyPrint", "type": "boolean", "info": "Returns response with indentations and line breaks.: boolean", "required": false, "schema": { "title": "prettyPrint", "type": "boolean" } }, { "name": "quotaUser", "type": "string", "info": "An opaque string that represents a user for quota purposes. Must not exceed 40 characters.: string", "required": false, "schema": { "title": "quotaUser", "type": "string" } }, { "name": "userIp", "type": "string", "info": "Deprecated. Please use quotaUser instead.: string", "required": false, "schema": { "title": "userIp", "type": "string" } }, { "name": "fileId", "type": "string", "info": "The ID of the file.: string", "required": true, "schema": { "title": "fileId", "type": "string" } }, { "name": "commentId", "type": "string", "info": "The ID of the comment.: string", "required": true, "schema": { "title": "commentId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/driveCommentsDelete" }, "task": true }, { "name": "driveCommentsGet", "summary": "Gets a comment by ID.", "description": "Gets a comment by ID.", "input": [ { "name": "alt", "type": "string", "info": "Data format for the response.: Must be one of [json]", "required": false, "schema": { "title": "alt", "type": "string" } }, { "name": "fields", "type": "string", "info": "Selector specifying which fields to include in a partial response.: string", "required": false, "schema": { "title": "fields", "type": "string" } }, { "name": "key", "type": "string", "info": "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.: string", "required": false, "schema": { "title": "key", "type": "string" } }, { "name": "oauthToken", "type": "string", "info": "OAuth 2.0 token for the current user.: string", "required": false, "schema": { "title": "oauthToken", "type": "string" } }, { "name": "prettyPrint", "type": "boolean", "info": "Returns response with indentations and line breaks.: boolean", "required": false, "schema": { "title": "prettyPrint", "type": "boolean" } }, { "name": "quotaUser", "type": "string", "info": "An opaque string that represents a user for quota purposes. Must not exceed 40 characters.: string", "required": false, "schema": { "title": "quotaUser", "type": "string" } }, { "name": "userIp", "type": "string", "info": "Deprecated. Please use quotaUser instead.: string", "required": false, "schema": { "title": "userIp", "type": "string" } }, { "name": "fileId", "type": "string", "info": "The ID of the file.: string", "required": true, "schema": { "title": "fileId", "type": "string" } }, { "name": "commentId", "type": "string", "info": "The ID of the comment.: string", "required": true, "schema": { "title": "commentId", "type": "string" } }, { "name": "includeDeleted", "type": "boolean", "info": "Whether to return deleted comments. Deleted comments will not include their original content.: boolean", "required": false, "schema": { "title": "includeDeleted", "type": "boolean" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/driveCommentsGet" }, "task": true }, { "name": "driveCommentsUpdate", "summary": "Updates a comment with patch semantics.", "description": "Updates a comment with patch semantics.", "input": [ { "name": "alt", "type": "string", "info": "Data format for the response.: Must be one of [json]", "required": false, "schema": { "title": "alt", "type": "string" } }, { "name": "fields", "type": "string", "info": "Selector specifying which fields to include in a partial response.: string", "required": false, "schema": { "title": "fields", "type": "string" } }, { "name": "key", "type": "string", "info": "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.: string", "required": false, "schema": { "title": "key", "type": "string" } }, { "name": "oauthToken", "type": "string", "info": "OAuth 2.0 token for the current user.: string", "required": false, "schema": { "title": "oauthToken", "type": "string" } }, { "name": "prettyPrint", "type": "boolean", "info": "Returns response with indentations and line breaks.: boolean", "required": false, "schema": { "title": "prettyPrint", "type": "boolean" } }, { "name": "quotaUser", "type": "string", "info": "An opaque string that represents a user for quota purposes. Must not exceed 40 characters.: string", "required": false, "schema": { "title": "quotaUser", "type": "string" } }, { "name": "userIp", "type": "string", "info": "Deprecated. Please use quotaUser instead.: string", "required": false, "schema": { "title": "userIp", "type": "string" } }, { "name": "fileId", "type": "string", "info": "The ID of the file.: string", "required": true, "schema": { "title": "fileId", "type": "string" } }, { "name": "commentId", "type": "string", "info": "The ID of the comment.: string", "required": true, "schema": { "title": "commentId", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"anchor\": \"string\", \"author\": {\"displayName\": \"string\", \"emailAddress\": \"string\", \"kind\": \"string\", \"me\": \"boolean\", \"permissionId\": \"string\", \"photoLink\": \"string\"}, \"content\": \"string\", \"createdTime\": \"string\", \"deleted\": \"boolean\", \"htmlContent\": \"string\", \"id\": \"string\", \"kind\": \"string\", \"modifiedTime\": \"string\", \"quotedFileContent\": {\"mimeType\": \"string\", \"value\": \"string\"}, \"replies\": [{\"action\": \"string\", \"author\": {\"displayName\": \"string\", \"emailAddress\": \"string\", \"kind\": \"string\", \"me\": \"boolean\", \"permissionId\": \"string\", \"photoLink\": \"string\"}, \"content\": \"string\", \"createdTime\": \"string\", \"deleted\": \"boolean\", \"htmlContent\": \"string\", \"id\": \"string\", \"kind\": \"string\", \"modifiedTime\": \"string\"}], \"resolved\": \"boolean\"}", "required": false, "schema": { "description": "A comment on a file.", "properties": { "anchor": { "description": "A region of the document represented as a JSON string. For details on defining anchor properties, refer to Add comments and replies.", "type": "string" }, "author": { "description": "Information about a Drive user.", "properties": { "displayName": { "description": "A plain text displayable name for this user.", "type": "string" }, "emailAddress": { "description": "The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.", "type": "string" }, "kind": { "default": "drive#user", "description": "Identifies what kind of resource this is. Value: the fixed string \"drive#user\".", "type": "string" }, "me": { "description": "Whether this user is the requesting user.", "type": "boolean" }, "permissionId": { "description": "The user's ID as visible in Permission resources.", "type": "string" }, "photoLink": { "description": "A link to the user's profile photo, if available.", "type": "string" } }, "type": "object" }, "content": { "description": "The plain text content of the comment. This field is used for setting the content, while htmlContent should be displayed.", "type": "string" }, "createdTime": { "description": "The time at which the comment was created (RFC 3339 date-time).", "type": "string" }, "deleted": { "description": "Whether the comment has been deleted. A deleted comment has no content.", "type": "boolean" }, "htmlContent": { "description": "The content of the comment with HTML formatting.", "type": "string" }, "id": { "description": "The ID of the comment.", "type": "string" }, "kind": { "default": "drive#comment", "description": "Identifies what kind of resource this is. Value: the fixed string \"drive#comment\".", "type": "string" }, "modifiedTime": { "description": "The last time the comment or any of its replies was modified (RFC 3339 date-time).", "type": "string" }, "quotedFileContent": { "description": "The file content to which the comment refers, typically within the anchor region. For a text file, for example, this would be the text at the location of the comment.", "properties": { "mimeType": { "description": "The MIME type of the quoted content.", "type": "string" }, "value": { "description": "The quoted content itself. This is interpreted as plain text if set through the API.", "type": "string" } }, "type": "object" }, "replies": { "description": "The full list of replies to the comment in chronological order.", "items": { "description": "A reply to a comment on a file.", "properties": { "action": { "description": "The action the reply performed to the parent comment. Valid values are: \n- resolve \n- reopen", "type": "string" }, "author": { "description": "Information about a Drive user.", "properties": { "displayName": { "description": "A plain text displayable name for this user.", "type": "string" }, "emailAddress": { "description": "The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.", "type": "string" }, "kind": { "default": "drive#user", "description": "Identifies what kind of resource this is. Value: the fixed string \"drive#user\".", "type": "string" }, "me": { "description": "Whether this user is the requesting user.", "type": "boolean" }, "permissionId": { "description": "The user's ID as visible in Permission resources.", "type": "string" }, "photoLink": { "description": "A link to the user's profile photo, if available.", "type": "string" } }, "type": "object" }, "content": { "description": "The plain text content of the reply. This field is used for setting the content, while htmlContent should be displayed. This is required on creates if no action is specified.", "type": "string" }, "createdTime": { "description": "The time at which the reply was created (RFC 3339 date-time).", "type": "string" }, "deleted": { "description": "Whether the reply has been deleted. A deleted reply has no content.", "type": "boolean" }, "htmlContent": { "description": "The content of the reply with HTML formatting.", "type": "string" }, "id": { "description": "The ID of the reply.", "type": "string" }, "kind": { "default": "drive#reply", "description": "Identifies what kind of resource this is. Value: the fixed string \"drive#reply\".", "type": "string" }, "modifiedTime": { "description": "The last time the reply was modified (RFC 3339 date-time).", "type": "string" } }, "type": "object" }, "type": "array" }, "resolved": { "description": "Whether the comment has been resolved by one of its replies.", "type": "boolean" } }, "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/driveCommentsUpdate" }, "task": true }, { "name": "driveRepliesList", "summary": "Lists a comment's replies.", "description": "Lists a comment's replies.", "input": [ { "name": "alt", "type": "string", "info": "Data format for the response.: Must be one of [json]", "required": false, "schema": { "title": "alt", "type": "string" } }, { "name": "fields", "type": "string", "info": "Selector specifying which fields to include in a partial response.: string", "required": false, "schema": { "title": "fields", "type": "string" } }, { "name": "key", "type": "string", "info": "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.: string", "required": false, "schema": { "title": "key", "type": "string" } }, { "name": "oauthToken", "type": "string", "info": "OAuth 2.0 token for the current user.: string", "required": false, "schema": { "title": "oauthToken", "type": "string" } }, { "name": "prettyPrint", "type": "boolean", "info": "Returns response with indentations and line breaks.: boolean", "required": false, "schema": { "title": "prettyPrint", "type": "boolean" } }, { "name": "quotaUser", "type": "string", "info": "An opaque string that represents a user for quota purposes. Must not exceed 40 characters.: string", "required": false, "schema": { "title": "quotaUser", "type": "string" } }, { "name": "userIp", "type": "string", "info": "Deprecated. Please use quotaUser instead.: string", "required": false, "schema": { "title": "userIp", "type": "string" } }, { "name": "fileId", "type": "string", "info": "The ID of the file.: string", "required": true, "schema": { "title": "fileId", "type": "string" } }, { "name": "commentId", "type": "string", "info": "The ID of the comment.: string", "required": true, "schema": { "title": "commentId", "type": "string" } }, { "name": "includeDeleted", "type": "boolean", "info": "Whether to include deleted replies. Deleted replies will not include their original content.: boolean", "required": false, "schema": { "title": "includeDeleted", "type": "boolean" } }, { "name": "pageSize", "type": "number", "info": "The maximum number of replies to return per page.: 123", "required": false, "schema": { "title": "pageSize", "type": "number" } }, { "name": "pageToken", "type": "string", "info": "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.: string", "required": false, "schema": { "title": "pageToken", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/driveRepliesList" }, "task": true }, { "name": "driveRepliesCreate", "summary": "Creates a new reply to a comment.", "description": "Creates a new reply to a comment.", "input": [ { "name": "alt", "type": "string", "info": "Data format for the response.: Must be one of [json]", "required": false, "schema": { "title": "alt", "type": "string" } }, { "name": "fields", "type": "string", "info": "Selector specifying which fields to include in a partial response.: string", "required": false, "schema": { "title": "fields", "type": "string" } }, { "name": "key", "type": "string", "info": "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.: string", "required": false, "schema": { "title": "key", "type": "string" } }, { "name": "oauthToken", "type": "string", "info": "OAuth 2.0 token for the current user.: string", "required": false, "schema": { "title": "oauthToken", "type": "string" } }, { "name": "prettyPrint", "type": "boolean", "info": "Returns response with indentations and line breaks.: boolean", "required": false, "schema": { "title": "prettyPrint", "type": "boolean" } }, { "name": "quotaUser", "type": "string", "info": "An opaque string that represents a user for quota purposes. Must not exceed 40 characters.: string", "required": false, "schema": { "title": "quotaUser", "type": "string" } }, { "name": "userIp", "type": "string", "info": "Deprecated. Please use quotaUser instead.: string", "required": false, "schema": { "title": "userIp", "type": "string" } }, { "name": "fileId", "type": "string", "info": "The ID of the file.: string", "required": true, "schema": { "title": "fileId", "type": "string" } }, { "name": "commentId", "type": "string", "info": "The ID of the comment.: string", "required": true, "schema": { "title": "commentId", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"action\": \"string\", \"author\": {\"displayName\": \"string\", \"emailAddress\": \"string\", \"kind\": \"string\", \"me\": \"boolean\", \"permissionId\": \"string\", \"photoLink\": \"string\"}, \"content\": \"string\", \"createdTime\": \"string\", \"deleted\": \"boolean\", \"htmlContent\": \"string\", \"id\": \"string\", \"kind\": \"string\", \"modifiedTime\": \"string\"}", "required": false, "schema": { "description": "A reply to a comment on a file.", "properties": { "action": { "description": "The action the reply performed to the parent comment. Valid values are: \n- resolve \n- reopen", "type": "string" }, "author": { "description": "Information about a Drive user.", "properties": { "displayName": { "description": "A plain text displayable name for this user.", "type": "string" }, "emailAddress": { "description": "The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.", "type": "string" }, "kind": { "default": "drive#user", "description": "Identifies what kind of resource this is. Value: the fixed string \"drive#user\".", "type": "string" }, "me": { "description": "Whether this user is the requesting user.", "type": "boolean" }, "permissionId": { "description": "The user's ID as visible in Permission resources.", "type": "string" }, "photoLink": { "description": "A link to the user's profile photo, if available.", "type": "string" } }, "type": "object" }, "content": { "description": "The plain text content of the reply. This field is used for setting the content, while htmlContent should be displayed. This is required on creates if no action is specified.", "type": "string" }, "createdTime": { "description": "The time at which the reply was created (RFC 3339 date-time).", "type": "string" }, "deleted": { "description": "Whether the reply has been deleted. A deleted reply has no content.", "type": "boolean" }, "htmlContent": { "description": "The content of the reply with HTML formatting.", "type": "string" }, "id": { "description": "The ID of the reply.", "type": "string" }, "kind": { "default": "drive#reply", "description": "Identifies what kind of resource this is. Value: the fixed string \"drive#reply\".", "type": "string" }, "modifiedTime": { "description": "The last time the reply was modified (RFC 3339 date-time).", "type": "string" } }, "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/driveRepliesCreate" }, "task": true }, { "name": "driveRepliesDelete", "summary": "Deletes a reply.", "description": "Deletes a reply.", "input": [ { "name": "alt", "type": "string", "info": "Data format for the response.: Must be one of [json]", "required": false, "schema": { "title": "alt", "type": "string" } }, { "name": "fields", "type": "string", "info": "Selector specifying which fields to include in a partial response.: string", "required": false, "schema": { "title": "fields", "type": "string" } }, { "name": "key", "type": "string", "info": "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.: string", "required": false, "schema": { "title": "key", "type": "string" } }, { "name": "oauthToken", "type": "string", "info": "OAuth 2.0 token for the current user.: string", "required": false, "schema": { "title": "oauthToken", "type": "string" } }, { "name": "prettyPrint", "type": "boolean", "info": "Returns response with indentations and line breaks.: boolean", "required": false, "schema": { "title": "prettyPrint", "type": "boolean" } }, { "name": "quotaUser", "type": "string", "info": "An opaque string that represents a user for quota purposes. Must not exceed 40 characters.: string", "required": false, "schema": { "title": "quotaUser", "type": "string" } }, { "name": "userIp", "type": "string", "info": "Deprecated. Please use quotaUser instead.: string", "required": false, "schema": { "title": "userIp", "type": "string" } }, { "name": "fileId", "type": "string", "info": "The ID of the file.: string", "required": true, "schema": { "title": "fileId", "type": "string" } }, { "name": "commentId", "type": "string", "info": "The ID of the comment.: string", "required": true, "schema": { "title": "commentId", "type": "string" } }, { "name": "replyId", "type": "string", "info": "The ID of the reply.: string", "required": true, "schema": { "title": "replyId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/driveRepliesDelete" }, "task": true }, { "name": "driveRepliesGet", "summary": "Gets a reply by ID.", "description": "Gets a reply by ID.", "input": [ { "name": "alt", "type": "string", "info": "Data format for the response.: Must be one of [json]", "required": false, "schema": { "title": "alt", "type": "string" } }, { "name": "fields", "type": "string", "info": "Selector specifying which fields to include in a partial response.: string", "required": false, "schema": { "title": "fields", "type": "string" } }, { "name": "key", "type": "string", "info": "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.: string", "required": false, "schema": { "title": "key", "type": "string" } }, { "name": "oauthToken", "type": "string", "info": "OAuth 2.0 token for the current user.: string", "required": false, "schema": { "title": "oauthToken", "type": "string" } }, { "name": "prettyPrint", "type": "boolean", "info": "Returns response with indentations and line breaks.: boolean", "required": false, "schema": { "title": "prettyPrint", "type": "boolean" } }, { "name": "quotaUser", "type": "string", "info": "An opaque string that represents a user for quota purposes. Must not exceed 40 characters.: string", "required": false, "schema": { "title": "quotaUser", "type": "string" } }, { "name": "userIp", "type": "string", "info": "Deprecated. Please use quotaUser instead.: string", "required": false, "schema": { "title": "userIp", "type": "string" } }, { "name": "fileId", "type": "string", "info": "The ID of the file.: string", "required": true, "schema": { "title": "fileId", "type": "string" } }, { "name": "commentId", "type": "string", "info": "The ID of the comment.: string", "required": true, "schema": { "title": "commentId", "type": "string" } }, { "name": "replyId", "type": "string", "info": "The ID of the reply.: string", "required": true, "schema": { "title": "replyId", "type": "string" } }, { "name": "includeDeleted", "type": "boolean", "info": "Whether to return deleted replies. Deleted replies will not include their original content.: boolean", "required": false, "schema": { "title": "includeDeleted", "type": "boolean" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/driveRepliesGet" }, "task": true }, { "name": "driveRepliesUpdate", "summary": "Updates a reply with patch semantics.", "description": "Updates a reply with patch semantics.", "input": [ { "name": "alt", "type": "string", "info": "Data format for the response.: Must be one of [json]", "required": false, "schema": { "title": "alt", "type": "string" } }, { "name": "fields", "type": "string", "info": "Selector specifying which fields to include in a partial response.: string", "required": false, "schema": { "title": "fields", "type": "string" } }, { "name": "key", "type": "string", "info": "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.: string", "required": false, "schema": { "title": "key", "type": "string" } }, { "name": "oauthToken", "type": "string", "info": "OAuth 2.0 token for the current user.: string", "required": false, "schema": { "title": "oauthToken", "type": "string" } }, { "name": "prettyPrint", "type": "boolean", "info": "Returns response with indentations and line breaks.: boolean", "required": false, "schema": { "title": "prettyPrint", "type": "boolean" } }, { "name": "quotaUser", "type": "string", "info": "An opaque string that represents a user for quota purposes. Must not exceed 40 characters.: string", "required": false, "schema": { "title": "quotaUser", "type": "string" } }, { "name": "userIp", "type": "string", "info": "Deprecated. Please use quotaUser instead.: string", "required": false, "schema": { "title": "userIp", "type": "string" } }, { "name": "fileId", "type": "string", "info": "The ID of the file.: string", "required": true, "schema": { "title": "fileId", "type": "string" } }, { "name": "commentId", "type": "string", "info": "The ID of the comment.: string", "required": true, "schema": { "title": "commentId", "type": "string" } }, { "name": "replyId", "type": "string", "info": "The ID of the reply.: string", "required": true, "schema": { "title": "replyId", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"action\": \"string\", \"author\": {\"displayName\": \"string\", \"emailAddress\": \"string\", \"kind\": \"string\", \"me\": \"boolean\", \"permissionId\": \"string\", \"photoLink\": \"string\"}, \"content\": \"string\", \"createdTime\": \"string\", \"deleted\": \"boolean\", \"htmlContent\": \"string\", \"id\": \"string\", \"kind\": \"string\", \"modifiedTime\": \"string\"}", "required": false, "schema": { "description": "A reply to a comment on a file.", "properties": { "action": { "description": "The action the reply performed to the parent comment. Valid values are: \n- resolve \n- reopen", "type": "string" }, "author": { "description": "Information about a Drive user.", "properties": { "displayName": { "description": "A plain text displayable name for this user.", "type": "string" }, "emailAddress": { "description": "The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.", "type": "string" }, "kind": { "default": "drive#user", "description": "Identifies what kind of resource this is. Value: the fixed string \"drive#user\".", "type": "string" }, "me": { "description": "Whether this user is the requesting user.", "type": "boolean" }, "permissionId": { "description": "The user's ID as visible in Permission resources.", "type": "string" }, "photoLink": { "description": "A link to the user's profile photo, if available.", "type": "string" } }, "type": "object" }, "content": { "description": "The plain text content of the reply. This field is used for setting the content, while htmlContent should be displayed. This is required on creates if no action is specified.", "type": "string" }, "createdTime": { "description": "The time at which the reply was created (RFC 3339 date-time).", "type": "string" }, "deleted": { "description": "Whether the reply has been deleted. A deleted reply has no content.", "type": "boolean" }, "htmlContent": { "description": "The content of the reply with HTML formatting.", "type": "string" }, "id": { "description": "The ID of the reply.", "type": "string" }, "kind": { "default": "drive#reply", "description": "Identifies what kind of resource this is. Value: the fixed string \"drive#reply\".", "type": "string" }, "modifiedTime": { "description": "The last time the reply was modified (RFC 3339 date-time).", "type": "string" } }, "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/driveRepliesUpdate" }, "task": true }, { "name": "drivePermissionsList", "summary": "Lists a file's or shared drive's permissions.", "description": "Lists a file's or shared drive's permissions.", "input": [ { "name": "alt", "type": "string", "info": "Data format for the response.: Must be one of [json]", "required": false, "schema": { "title": "alt", "type": "string" } }, { "name": "fields", "type": "string", "info": "Selector specifying which fields to include in a partial response.: string", "required": false, "schema": { "title": "fields", "type": "string" } }, { "name": "key", "type": "string", "info": "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.: string", "required": false, "schema": { "title": "key", "type": "string" } }, { "name": "oauthToken", "type": "string", "info": "OAuth 2.0 token for the current user.: string", "required": false, "schema": { "title": "oauthToken", "type": "string" } }, { "name": "prettyPrint", "type": "boolean", "info": "Returns response with indentations and line breaks.: boolean", "required": false, "schema": { "title": "prettyPrint", "type": "boolean" } }, { "name": "quotaUser", "type": "string", "info": "An opaque string that represents a user for quota purposes. Must not exceed 40 characters.: string", "required": false, "schema": { "title": "quotaUser", "type": "string" } }, { "name": "userIp", "type": "string", "info": "Deprecated. Please use quotaUser instead.: string", "required": false, "schema": { "title": "userIp", "type": "string" } }, { "name": "fileId", "type": "string", "info": "The ID of the file or shared drive.: string", "required": true, "schema": { "title": "fileId", "type": "string" } }, { "name": "includePermissionsForView", "type": "string", "info": "Specifies which additional view's permissions to include in the response. Only 'published' is supported.: string", "required": false, "schema": { "title": "includePermissionsForView", "type": "string" } }, { "name": "pageSize", "type": "number", "info": "The maximum number of permissions to return per page. When not set for files in a shared drive, at most 100 results will be returned. When not set for files that are not ...(description truncated): 123", "required": false, "schema": { "title": "pageSize", "type": "number" } }, { "name": "pageToken", "type": "string", "info": "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.: string", "required": false, "schema": { "title": "pageToken", "type": "string" } }, { "name": "supportsAllDrives", "type": "boolean", "info": "Whether the requesting application supports both My Drives and shared drives.: boolean", "required": false, "schema": { "title": "supportsAllDrives", "type": "boolean" } }, { "name": "supportsTeamDrives", "type": "boolean", "info": "Deprecated use supportsAllDrives instead.: boolean", "required": false, "schema": { "title": "supportsTeamDrives", "type": "boolean" } }, { "name": "useDomainAdminAccess", "type": "boolean", "info": "Issue the request as a domain administrator; if set to true, then the requester will be granted access if the file ID parameter refers to a shared drive and the requester...(description truncated): boolean", "required": false, "schema": { "title": "useDomainAdminAccess", "type": "boolean" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/drivePermissionsList" }, "task": true }, { "name": "drivePermissionsCreate", "summary": "Creates a permission for a file or shared drive.", "description": "Creates a permission for a file or shared drive.", "input": [ { "name": "alt", "type": "string", "info": "Data format for the response.: Must be one of [json]", "required": false, "schema": { "title": "alt", "type": "string" } }, { "name": "fields", "type": "string", "info": "Selector specifying which fields to include in a partial response.: string", "required": false, "schema": { "title": "fields", "type": "string" } }, { "name": "key", "type": "string", "info": "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.: string", "required": false, "schema": { "title": "key", "type": "string" } }, { "name": "oauthToken", "type": "string", "info": "OAuth 2.0 token for the current user.: string", "required": false, "schema": { "title": "oauthToken", "type": "string" } }, { "name": "prettyPrint", "type": "boolean", "info": "Returns response with indentations and line breaks.: boolean", "required": false, "schema": { "title": "prettyPrint", "type": "boolean" } }, { "name": "quotaUser", "type": "string", "info": "An opaque string that represents a user for quota purposes. Must not exceed 40 characters.: string", "required": false, "schema": { "title": "quotaUser", "type": "string" } }, { "name": "userIp", "type": "string", "info": "Deprecated. Please use quotaUser instead.: string", "required": false, "schema": { "title": "userIp", "type": "string" } }, { "name": "fileId", "type": "string", "info": "The ID of the file or shared drive.: string", "required": true, "schema": { "title": "fileId", "type": "string" } }, { "name": "emailMessage", "type": "string", "info": "A plain text custom message to include in the notification email.: string", "required": false, "schema": { "title": "emailMessage", "type": "string" } }, { "name": "enforceSingleParent", "type": "boolean", "info": "Deprecated. See moveToNewOwnersRoot for details.: boolean", "required": false, "schema": { "title": "enforceSingleParent", "type": "boolean" } }, { "name": "moveToNewOwnersRoot", "type": "boolean", "info": "This parameter will only take effect if the item is not in a shared drive and the request is attempting to transfer the ownership of the item. If set to true, the item wi...(description truncated): boolean", "required": false, "schema": { "title": "moveToNewOwnersRoot", "type": "boolean" } }, { "name": "sendNotificationEmail", "type": "boolean", "info": "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 di...(description truncated): boolean", "required": false, "schema": { "title": "sendNotificationEmail", "type": "boolean" } }, { "name": "supportsAllDrives", "type": "boolean", "info": "Whether the requesting application supports both My Drives and shared drives.: boolean", "required": false, "schema": { "title": "supportsAllDrives", "type": "boolean" } }, { "name": "supportsTeamDrives", "type": "boolean", "info": "Deprecated use supportsAllDrives instead.: boolean", "required": false, "schema": { "title": "supportsTeamDrives", "type": "boolean" } }, { "name": "transferOwnership", "type": "boolean", "info": "Whether to transfer ownership to the specified user and downgrade the current owner to a writer. This parameter is required as an acknowledgement of the side effect. File...(description truncated): boolean", "required": false, "schema": { "title": "transferOwnership", "type": "boolean" } }, { "name": "useDomainAdminAccess", "type": "boolean", "info": "Issue the request as a domain administrator; if set to true, then the requester will be granted access if the file ID parameter refers to a shared drive and the requester...(description truncated): boolean", "required": false, "schema": { "title": "useDomainAdminAccess", "type": "boolean" } }, { "name": "body", "type": "object", "info": ": {\"allowFileDiscovery\": \"boolean\", \"deleted\": \"boolean\", \"displayName\": \"string\", \"domain\": \"string\", \"emailAddress\": \"string\", \"expirationTime\": \"string\", \"id\": \"string\", \"kind\": \"string\", \"pendingOwner\": \"boolean\", \"permissionDetails\": [{\"inherited\": \"boolean\", \"inheritedFrom\": \"string\", \"permissionType\": \"string\", \"role\": \"string\"}], \"photoLink\": \"string\", \"role\": \"string\", \"teamDrivePermissionDetails\": [{\"inherited\": \"boolean\", \"inheritedFrom\": \"string\", \"role\": \"string\", \"teamDrivePermissionType\": \"string\"}], \"type\": \"string\", \"view\": \"string\"}", "required": false, "schema": { "description": "A permission for a file. A permission grants a user, group, domain or the world access to a file or a folder hierarchy.", "properties": { "allowFileDiscovery": { "description": "Whether the permission allows the file to be discovered through search. This is only applicable for permissions of type domain or anyone.", "type": "boolean" }, "deleted": { "description": "Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions.", "type": "boolean" }, "displayName": { "description": "The \"pretty\" name of the value of the permission. The following is a list of examples for each type of permission: \n- user - User's full name, as defined for their Google account, such as \"Joe Smith.\" \n- group - Name of the Google Group, such as \"The Company Administrators.\" \n- domain - String domain name, such as \"thecompany.com.\" \n- anyone - No displayName is present.", "type": "string" }, "domain": { "description": "The domain to which this permission refers.", "type": "string" }, "emailAddress": { "description": "The email address of the user or group to which this permission refers.", "type": "string" }, "expirationTime": { "description": "The time at which this permission will expire (RFC 3339 date-time). Expiration times have the following restrictions: \n- They can only be set on user and group permissions \n- The time must be in the future \n- The time cannot be more than a year in the future", "type": "string" }, "id": { "description": "The ID of this permission. This is a unique identifier for the grantee, and is published in User resources as permissionId. IDs should be treated as opaque values.", "type": "string" }, "kind": { "default": "drive#permission", "description": "Identifies what kind of resource this is. Value: the fixed string \"drive#permission\".", "type": "string" }, "pendingOwner": { "description": "Whether the account associated with this permission is a pending owner. Only populated for user type permissions for files that are not in a shared drive.", "type": "boolean" }, "permissionDetails": { "description": "Details of whether the permissions on this shared drive item are inherited or directly on this item. This is an output-only field which is present only for shared drive items.", "items": { "properties": { "inherited": { "description": "Whether this permission is inherited. This field is always populated. This is an output-only field.", "type": "boolean" }, "inheritedFrom": { "description": "The ID of the item from which this permission is inherited. This is an output-only field.", "type": "string" }, "permissionType": { "description": "The permission type for this user. While new values may be added in future, the following are currently possible: \n- file \n- member", "type": "string" }, "role": { "description": "The primary role for this user. While new values may be added in the future, the following are currently possible: \n- organizer \n- fileOrganizer \n- writer \n- commenter \n- reader", "type": "string" } }, "type": "object" }, "readOnly": true, "type": "array" }, "photoLink": { "description": "A link to the user's profile photo, if available.", "type": "string" }, "role": { "description": "The role granted by this permission. While new values may be supported in the future, the following are currently allowed: \n- owner \n- organizer \n- fileOrganizer \n- writer \n- commenter \n- reader", "type": "string" }, "teamDrivePermissionDetails": { "description": "Deprecated - use permissionDetails instead.", "items": { "properties": { "inherited": { "description": "Deprecated - use permissionDetails/inherited instead.", "type": "boolean" }, "inheritedFrom": { "description": "Deprecated - use permissionDetails/inheritedFrom instead.", "type": "string" }, "role": { "description": "Deprecated - use permissionDetails/role instead.", "type": "string" }, "teamDrivePermissionType": { "description": "Deprecated - use permissionDetails/permissionType instead.", "type": "string" } }, "type": "object" }, "readOnly": true, "type": "array" }, "type": { "description": "The type of the grantee. Valid values are: \n- user \n- group \n- domain \n- anyone When creating a permission, if type is user or group, you must provide an emailAddress for the user or group. When type is domain, you must provide a domain. There isn't extra information required for a anyone type.", "type": "string" }, "view": { "description": "Indicates the view for this permission. Only populated for permissions that belong to a view. published is the only supported value.", "type": "string" } }, "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/drivePermissionsCreate" }, "task": true }, { "name": "drivePermissionsDelete", "summary": "Deletes a permission.", "description": "Deletes a permission.", "input": [ { "name": "alt", "type": "string", "info": "Data format for the response.: Must be one of [json]", "required": false, "schema": { "title": "alt", "type": "string" } }, { "name": "fields", "type": "string", "info": "Selector specifying which fields to include in a partial response.: string", "required": false, "schema": { "title": "fields", "type": "string" } }, { "name": "key", "type": "string", "info": "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.: string", "required": false, "schema": { "title": "key", "type": "string" } }, { "name": "oauthToken", "type": "string", "info": "OAuth 2.0 token for the current user.: string", "required": false, "schema": { "title": "oauthToken", "type": "string" } }, { "name": "prettyPrint", "type": "boolean", "info": "Returns response with indentations and line breaks.: boolean", "required": false, "schema": { "title": "prettyPrint", "type": "boolean" } }, { "name": "quotaUser", "type": "string", "info": "An opaque string that represents a user for quota purposes. Must not exceed 40 characters.: string", "required": false, "schema": { "title": "quotaUser", "type": "string" } }, { "name": "userIp", "type": "string", "info": "Deprecated. Please use quotaUser instead.: string", "required": false, "schema": { "title": "userIp", "type": "string" } }, { "name": "fileId", "type": "string", "info": "The ID of the file or shared drive.: string", "required": true, "schema": { "title": "fileId", "type": "string" } }, { "name": "permissionId", "type": "string", "info": "The ID of the permission.: string", "required": true, "schema": { "title": "permissionId", "type": "string" } }, { "name": "supportsAllDrives", "type": "boolean", "info": "Whether the requesting application supports both My Drives and shared drives.: boolean", "required": false, "schema": { "title": "supportsAllDrives", "type": "boolean" } }, { "name": "supportsTeamDrives", "type": "boolean", "info": "Deprecated use supportsAllDrives instead.: boolean", "required": false, "schema": { "title": "supportsTeamDrives", "type": "boolean" } }, { "name": "useDomainAdminAccess", "type": "boolean", "info": "Issue the request as a domain administrator; if set to true, then the requester will be granted access if the file ID parameter refers to a shared drive and the requester...(description truncated): boolean", "required": false, "schema": { "title": "useDomainAdminAccess", "type": "boolean" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/drivePermissionsDelete" }, "task": true }, { "name": "drivePermissionsGet", "summary": "Gets a permission by ID.", "description": "Gets a permission by ID.", "input": [ { "name": "alt", "type": "string", "info": "Data format for the response.: Must be one of [json]", "required": false, "schema": { "title": "alt", "type": "string" } }, { "name": "fields", "type": "string", "info": "Selector specifying which fields to include in a partial response.: string", "required": false, "schema": { "title": "fields", "type": "string" } }, { "name": "key", "type": "string", "info": "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.: string", "required": false, "schema": { "title": "key", "type": "string" } }, { "name": "oauthToken", "type": "string", "info": "OAuth 2.0 token for the current user.: string", "required": false, "schema": { "title": "oauthToken", "type": "string" } }, { "name": "prettyPrint", "type": "boolean", "info": "Returns response with indentations and line breaks.: boolean", "required": false, "schema": { "title": "prettyPrint", "type": "boolean" } }, { "name": "quotaUser", "type": "string", "info": "An opaque string that represents a user for quota purposes. Must not exceed 40 characters.: string", "required": false, "schema": { "title": "quotaUser", "type": "string" } }, { "name": "userIp", "type": "string", "info": "Deprecated. Please use quotaUser instead.: string", "required": false, "schema": { "title": "userIp", "type": "string" } }, { "name": "fileId", "type": "string", "info": "The ID of the file.: string", "required": true, "schema": { "title": "fileId", "type": "string" } }, { "name": "permissionId", "type": "string", "info": "The ID of the permission.: string", "required": true, "schema": { "title": "permissionId", "type": "string" } }, { "name": "supportsAllDrives", "type": "boolean", "info": "Whether the requesting application supports both My Drives and shared drives.: boolean", "required": false, "schema": { "title": "supportsAllDrives", "type": "boolean" } }, { "name": "supportsTeamDrives", "type": "boolean", "info": "Deprecated use supportsAllDrives instead.: boolean", "required": false, "schema": { "title": "supportsTeamDrives", "type": "boolean" } }, { "name": "useDomainAdminAccess", "type": "boolean", "info": "Issue the request as a domain administrator; if set to true, then the requester will be granted access if the file ID parameter refers to a shared drive and the requester...(description truncated): boolean", "required": false, "schema": { "title": "useDomainAdminAccess", "type": "boolean" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/drivePermissionsGet" }, "task": true }, { "name": "drivePermissionsUpdate", "summary": "Updates a permission with patch semantics.", "description": "Updates a permission with patch semantics.", "input": [ { "name": "alt", "type": "string", "info": "Data format for the response.: Must be one of [json]", "required": false, "schema": { "title": "alt", "type": "string" } }, { "name": "fields", "type": "string", "info": "Selector specifying which fields to include in a partial response.: string", "required": false, "schema": { "title": "fields", "type": "string" } }, { "name": "key", "type": "string", "info": "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.: string", "required": false, "schema": { "title": "key", "type": "string" } }, { "name": "oauthToken", "type": "string", "info": "OAuth 2.0 token for the current user.: string", "required": false, "schema": { "title": "oauthToken", "type": "string" } }, { "name": "prettyPrint", "type": "boolean", "info": "Returns response with indentations and line breaks.: boolean", "required": false, "schema": { "title": "prettyPrint", "type": "boolean" } }, { "name": "quotaUser", "type": "string", "info": "An opaque string that represents a user for quota purposes. Must not exceed 40 characters.: string", "required": false, "schema": { "title": "quotaUser", "type": "string" } }, { "name": "userIp", "type": "string", "info": "Deprecated. Please use quotaUser instead.: string", "required": false, "schema": { "title": "userIp", "type": "string" } }, { "name": "fileId", "type": "string", "info": "The ID of the file or shared drive.: string", "required": true, "schema": { "title": "fileId", "type": "string" } }, { "name": "permissionId", "type": "string", "info": "The ID of the permission.: string", "required": true, "schema": { "title": "permissionId", "type": "string" } }, { "name": "removeExpiration", "type": "boolean", "info": "Whether to remove the expiration date.: boolean", "required": false, "schema": { "title": "removeExpiration", "type": "boolean" } }, { "name": "supportsAllDrives", "type": "boolean", "info": "Whether the requesting application supports both My Drives and shared drives.: boolean", "required": false, "schema": { "title": "supportsAllDrives", "type": "boolean" } }, { "name": "supportsTeamDrives", "type": "boolean", "info": "Deprecated use supportsAllDrives instead.: boolean", "required": false, "schema": { "title": "supportsTeamDrives", "type": "boolean" } }, { "name": "transferOwnership", "type": "boolean", "info": "Whether to transfer ownership to the specified user and downgrade the current owner to a writer. This parameter is required as an acknowledgement of the side effect. File...(description truncated): boolean", "required": false, "schema": { "title": "transferOwnership", "type": "boolean" } }, { "name": "useDomainAdminAccess", "type": "boolean", "info": "Issue the request as a domain administrator; if set to true, then the requester will be granted access if the file ID parameter refers to a shared drive and the requester...(description truncated): boolean", "required": false, "schema": { "title": "useDomainAdminAccess", "type": "boolean" } }, { "name": "body", "type": "object", "info": ": {\"allowFileDiscovery\": \"boolean\", \"deleted\": \"boolean\", \"displayName\": \"string\", \"domain\": \"string\", \"emailAddress\": \"string\", \"expirationTime\": \"string\", \"id\": \"string\", \"kind\": \"string\", \"pendingOwner\": \"boolean\", \"permissionDetails\": [{\"inherited\": \"boolean\", \"inheritedFrom\": \"string\", \"permissionType\": \"string\", \"role\": \"string\"}], \"photoLink\": \"string\", \"role\": \"string\", \"teamDrivePermissionDetails\": [{\"inherited\": \"boolean\", \"inheritedFrom\": \"string\", \"role\": \"string\", \"teamDrivePermissionType\": \"string\"}], \"type\": \"string\", \"view\": \"string\"}", "required": false, "schema": { "description": "A permission for a file. A permission grants a user, group, domain or the world access to a file or a folder hierarchy.", "properties": { "allowFileDiscovery": { "description": "Whether the permission allows the file to be discovered through search. This is only applicable for permissions of type domain or anyone.", "type": "boolean" }, "deleted": { "description": "Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions.", "type": "boolean" }, "displayName": { "description": "The \"pretty\" name of the value of the permission. The following is a list of examples for each type of permission: \n- user - User's full name, as defined for their Google account, such as \"Joe Smith.\" \n- group - Name of the Google Group, such as \"The Company Administrators.\" \n- domain - String domain name, such as \"thecompany.com.\" \n- anyone - No displayName is present.", "type": "string" }, "domain": { "description": "The domain to which this permission refers.", "type": "string" }, "emailAddress": { "description": "The email address of the user or group to which this permission refers.", "type": "string" }, "expirationTime": { "description": "The time at which this permission will expire (RFC 3339 date-time). Expiration times have the following restrictions: \n- They can only be set on user and group permissions \n- The time must be in the future \n- The time cannot be more than a year in the future", "type": "string" }, "id": { "description": "The ID of this permission. This is a unique identifier for the grantee, and is published in User resources as permissionId. IDs should be treated as opaque values.", "type": "string" }, "kind": { "default": "drive#permission", "description": "Identifies what kind of resource this is. Value: the fixed string \"drive#permission\".", "type": "string" }, "pendingOwner": { "description": "Whether the account associated with this permission is a pending owner. Only populated for user type permissions for files that are not in a shared drive.", "type": "boolean" }, "permissionDetails": { "description": "Details of whether the permissions on this shared drive item are inherited or directly on this item. This is an output-only field which is present only for shared drive items.", "items": { "properties": { "inherited": { "description": "Whether this permission is inherited. This field is always populated. This is an output-only field.", "type": "boolean" }, "inheritedFrom": { "description": "The ID of the item from which this permission is inherited. This is an output-only field.", "type": "string" }, "permissionType": { "description": "The permission type for this user. While new values may be added in future, the following are currently possible: \n- file \n- member", "type": "string" }, "role": { "description": "The primary role for this user. While new values may be added in the future, the following are currently possible: \n- organizer \n- fileOrganizer \n- writer \n- commenter \n- reader", "type": "string" } }, "type": "object" }, "readOnly": true, "type": "array" }, "photoLink": { "description": "A link to the user's profile photo, if available.", "type": "string" }, "role": { "description": "The role granted by this permission. While new values may be supported in the future, the following are currently allowed: \n- owner \n- organizer \n- fileOrganizer \n- writer \n- commenter \n- reader", "type": "string" }, "teamDrivePermissionDetails": { "description": "Deprecated - use permissionDetails instead.", "items": { "properties": { "inherited": { "description": "Deprecated - use permissionDetails/inherited instead.", "type": "boolean" }, "inheritedFrom": { "description": "Deprecated - use permissionDetails/inheritedFrom instead.", "type": "string" }, "role": { "description": "Deprecated - use permissionDetails/role instead.", "type": "string" }, "teamDrivePermissionType": { "description": "Deprecated - use permissionDetails/permissionType instead.", "type": "string" } }, "type": "object" }, "readOnly": true, "type": "array" }, "type": { "description": "The type of the grantee. Valid values are: \n- user \n- group \n- domain \n- anyone When creating a permission, if type is user or group, you must provide an emailAddress for the user or group. When type is domain, you must provide a domain. There isn't extra information required for a anyone type.", "type": "string" }, "view": { "description": "Indicates the view for this permission. Only populated for permissions that belong to a view. published is the only supported value.", "type": "string" } }, "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/drivePermissionsUpdate" }, "task": true }, { "name": "driveRevisionsList", "summary": "Lists a file's revisions.", "description": "Lists a file's revisions.", "input": [ { "name": "alt", "type": "string", "info": "Data format for the response.: Must be one of [json]", "required": false, "schema": { "title": "alt", "type": "string" } }, { "name": "fields", "type": "string", "info": "Selector specifying which fields to include in a partial response.: string", "required": false, "schema": { "title": "fields", "type": "string" } }, { "name": "key", "type": "string", "info": "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.: string", "required": false, "schema": { "title": "key", "type": "string" } }, { "name": "oauthToken", "type": "string", "info": "OAuth 2.0 token for the current user.: string", "required": false, "schema": { "title": "oauthToken", "type": "string" } }, { "name": "prettyPrint", "type": "boolean", "info": "Returns response with indentations and line breaks.: boolean", "required": false, "schema": { "title": "prettyPrint", "type": "boolean" } }, { "name": "quotaUser", "type": "string", "info": "An opaque string that represents a user for quota purposes. Must not exceed 40 characters.: string", "required": false, "schema": { "title": "quotaUser", "type": "string" } }, { "name": "userIp", "type": "string", "info": "Deprecated. Please use quotaUser instead.: string", "required": false, "schema": { "title": "userIp", "type": "string" } }, { "name": "fileId", "type": "string", "info": "The ID of the file.: string", "required": true, "schema": { "title": "fileId", "type": "string" } }, { "name": "pageSize", "type": "number", "info": "The maximum number of revisions to return per page.: 123", "required": false, "schema": { "title": "pageSize", "type": "number" } }, { "name": "pageToken", "type": "string", "info": "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.: string", "required": false, "schema": { "title": "pageToken", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/driveRevisionsList" }, "task": true }, { "name": "driveRevisionsDelete", "summary": "Permanently deletes a file version. You can only delete revisions for files with binary content in", "description": "Permanently deletes a file version. You can only delete revisions for files with binary content in Google Drive, like images or videos. Revisions for other files, like Google Docs or Sheets, and the last remaining file version can't be deleted.", "input": [ { "name": "alt", "type": "string", "info": "Data format for the response.: Must be one of [json]", "required": false, "schema": { "title": "alt", "type": "string" } }, { "name": "fields", "type": "string", "info": "Selector specifying which fields to include in a partial response.: string", "required": false, "schema": { "title": "fields", "type": "string" } }, { "name": "key", "type": "string", "info": "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.: string", "required": false, "schema": { "title": "key", "type": "string" } }, { "name": "oauthToken", "type": "string", "info": "OAuth 2.0 token for the current user.: string", "required": false, "schema": { "title": "oauthToken", "type": "string" } }, { "name": "prettyPrint", "type": "boolean", "info": "Returns response with indentations and line breaks.: boolean", "required": false, "schema": { "title": "prettyPrint", "type": "boolean" } }, { "name": "quotaUser", "type": "string", "info": "An opaque string that represents a user for quota purposes. Must not exceed 40 characters.: string", "required": false, "schema": { "title": "quotaUser", "type": "string" } }, { "name": "userIp", "type": "string", "info": "Deprecated. Please use quotaUser instead.: string", "required": false, "schema": { "title": "userIp", "type": "string" } }, { "name": "fileId", "type": "string", "info": "The ID of the file.: string", "required": true, "schema": { "title": "fileId", "type": "string" } }, { "name": "revisionId", "type": "string", "info": "The ID of the revision.: string", "required": true, "schema": { "title": "revisionId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/driveRevisionsDelete" }, "task": true }, { "name": "driveRevisionsGet", "summary": "Gets a revision's metadata or content by ID.", "description": "Gets a revision's metadata or content by ID.", "input": [ { "name": "alt", "type": "string", "info": "Data format for the response.: Must be one of [json]", "required": false, "schema": { "title": "alt", "type": "string" } }, { "name": "fields", "type": "string", "info": "Selector specifying which fields to include in a partial response.: string", "required": false, "schema": { "title": "fields", "type": "string" } }, { "name": "key", "type": "string", "info": "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.: string", "required": false, "schema": { "title": "key", "type": "string" } }, { "name": "oauthToken", "type": "string", "info": "OAuth 2.0 token for the current user.: string", "required": false, "schema": { "title": "oauthToken", "type": "string" } }, { "name": "prettyPrint", "type": "boolean", "info": "Returns response with indentations and line breaks.: boolean", "required": false, "schema": { "title": "prettyPrint", "type": "boolean" } }, { "name": "quotaUser", "type": "string", "info": "An opaque string that represents a user for quota purposes. Must not exceed 40 characters.: string", "required": false, "schema": { "title": "quotaUser", "type": "string" } }, { "name": "userIp", "type": "string", "info": "Deprecated. Please use quotaUser instead.: string", "required": false, "schema": { "title": "userIp", "type": "string" } }, { "name": "fileId", "type": "string", "info": "The ID of the file.: string", "required": true, "schema": { "title": "fileId", "type": "string" } }, { "name": "revisionId", "type": "string", "info": "The ID of the revision.: string", "required": true, "schema": { "title": "revisionId", "type": "string" } }, { "name": "acknowledgeAbuse", "type": "boolean", "info": "Whether the user is acknowledging the risk of downloading known malware or other abusive files. This is only applicable when alt=media.: boolean", "required": false, "schema": { "title": "acknowledgeAbuse", "type": "boolean" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/driveRevisionsGet" }, "task": true }, { "name": "driveRevisionsUpdate", "summary": "Updates a revision with patch semantics.", "description": "Updates a revision with patch semantics.", "input": [ { "name": "alt", "type": "string", "info": "Data format for the response.: Must be one of [json]", "required": false, "schema": { "title": "alt", "type": "string" } }, { "name": "fields", "type": "string", "info": "Selector specifying which fields to include in a partial response.: string", "required": false, "schema": { "title": "fields", "type": "string" } }, { "name": "key", "type": "string", "info": "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.: string", "required": false, "schema": { "title": "key", "type": "string" } }, { "name": "oauthToken", "type": "string", "info": "OAuth 2.0 token for the current user.: string", "required": false, "schema": { "title": "oauthToken", "type": "string" } }, { "name": "prettyPrint", "type": "boolean", "info": "Returns response with indentations and line breaks.: boolean", "required": false, "schema": { "title": "prettyPrint", "type": "boolean" } }, { "name": "quotaUser", "type": "string", "info": "An opaque string that represents a user for quota purposes. Must not exceed 40 characters.: string", "required": false, "schema": { "title": "quotaUser", "type": "string" } }, { "name": "userIp", "type": "string", "info": "Deprecated. Please use quotaUser instead.: string", "required": false, "schema": { "title": "userIp", "type": "string" } }, { "name": "fileId", "type": "string", "info": "The ID of the file.: string", "required": true, "schema": { "title": "fileId", "type": "string" } }, { "name": "revisionId", "type": "string", "info": "The ID of the revision.: string", "required": true, "schema": { "title": "revisionId", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"exportLinks\": \"object\", \"id\": \"string\", \"keepForever\": \"boolean\", \"kind\": \"string\", \"lastModifyingUser\": {\"displayName\": \"string\", \"emailAddress\": \"string\", \"kind\": \"string\", \"me\": \"boolean\", \"permissionId\": \"string\", \"photoLink\": \"string\"}, \"md5Checksum\": \"string\", \"mimeType\": \"string\", \"modifiedTime\": \"string\", \"originalFilename\": \"string\", \"publishAuto\": \"boolean\", \"published\": \"boolean\", \"publishedLink\": \"string\", \"publishedOutsideDomain\": \"boolean\", \"size\": \"string\"}", "required": false, "schema": { "description": "The metadata for a revision to a file.", "properties": { "exportLinks": { "additionalProperties": { "description": "A mapping from export format to URL", "type": "string" }, "description": "Links for exporting Docs Editors files to specific formats.", "type": "object" }, "id": { "description": "The ID of the revision.", "type": "string" }, "keepForever": { "description": "Whether to keep this revision forever, even if it is no longer the head revision. If not set, the revision will be automatically purged 30 days after newer content is uploaded. This can be set on a maximum of 200 revisions for a file.\nThis field is only applicable to files with binary content in Drive.", "type": "boolean" }, "kind": { "default": "drive#revision", "description": "Identifies what kind of resource this is. Value: the fixed string \"drive#revision\".", "type": "string" }, "lastModifyingUser": { "description": "Information about a Drive user.", "properties": { "displayName": { "description": "A plain text displayable name for this user.", "type": "string" }, "emailAddress": { "description": "The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.", "type": "string" }, "kind": { "default": "drive#user", "description": "Identifies what kind of resource this is. Value: the fixed string \"drive#user\".", "type": "string" }, "me": { "description": "Whether this user is the requesting user.", "type": "boolean" }, "permissionId": { "description": "The user's ID as visible in Permission resources.", "type": "string" }, "photoLink": { "description": "A link to the user's profile photo, if available.", "type": "string" } }, "type": "object" }, "md5Checksum": { "description": "The MD5 checksum of the revision's content. This is only applicable to files with binary content in Drive.", "type": "string" }, "mimeType": { "description": "The MIME type of the revision.", "type": "string" }, "modifiedTime": { "description": "The last time the revision was modified (RFC 3339 date-time).", "type": "string" }, "originalFilename": { "description": "The original filename used to create this revision. This is only applicable to files with binary content in Drive.", "type": "string" }, "publishAuto": { "description": "Whether subsequent revisions will be automatically republished. This is only applicable to Docs Editors files.", "type": "boolean" }, "published": { "description": "Whether this revision is published. This is only applicable to Docs Editors files.", "type": "boolean" }, "publishedLink": { "description": "A link to the published revision. This is only populated for Google Sites files.", "type": "string" }, "publishedOutsideDomain": { "description": "Whether this revision is published outside the domain. This is only applicable to Docs Editors files.", "type": "boolean" }, "size": { "description": "The size of the revision's content in bytes. This is only applicable to files with binary content in Drive.", "type": "string" } }, "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/driveRevisionsUpdate" }, "task": true }, { "name": "driveTeamdrivesList", "summary": "Deprecated use drives.list instead.", "description": "Deprecated use drives.list instead.", "input": [ { "name": "alt", "type": "string", "info": "Data format for the response.: Must be one of [json]", "required": false, "schema": { "title": "alt", "type": "string" } }, { "name": "fields", "type": "string", "info": "Selector specifying which fields to include in a partial response.: string", "required": false, "schema": { "title": "fields", "type": "string" } }, { "name": "key", "type": "string", "info": "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.: string", "required": false, "schema": { "title": "key", "type": "string" } }, { "name": "oauthToken", "type": "string", "info": "OAuth 2.0 token for the current user.: string", "required": false, "schema": { "title": "oauthToken", "type": "string" } }, { "name": "prettyPrint", "type": "boolean", "info": "Returns response with indentations and line breaks.: boolean", "required": false, "schema": { "title": "prettyPrint", "type": "boolean" } }, { "name": "quotaUser", "type": "string", "info": "An opaque string that represents a user for quota purposes. Must not exceed 40 characters.: string", "required": false, "schema": { "title": "quotaUser", "type": "string" } }, { "name": "userIp", "type": "string", "info": "Deprecated. Please use quotaUser instead.: string", "required": false, "schema": { "title": "userIp", "type": "string" } }, { "name": "pageSize", "type": "number", "info": "Maximum number of Team Drives to return.: 123", "required": false, "schema": { "title": "pageSize", "type": "number" } }, { "name": "pageToken", "type": "string", "info": "Page token for Team Drives.: string", "required": false, "schema": { "title": "pageToken", "type": "string" } }, { "name": "q", "type": "string", "info": "Query string for searching Team Drives.: string", "required": false, "schema": { "title": "q", "type": "string" } }, { "name": "useDomainAdminAccess", "type": "boolean", "info": "Issue the request as a domain administrator; if set to true, then all Team Drives of the domain in which the requester is an administrator are returned.: boolean", "required": false, "schema": { "title": "useDomainAdminAccess", "type": "boolean" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/driveTeamdrivesList" }, "task": true }, { "name": "driveTeamdrivesCreate", "summary": "Deprecated use drives.create instead.", "description": "Deprecated use drives.create instead.", "input": [ { "name": "alt", "type": "string", "info": "Data format for the response.: Must be one of [json]", "required": false, "schema": { "title": "alt", "type": "string" } }, { "name": "fields", "type": "string", "info": "Selector specifying which fields to include in a partial response.: string", "required": false, "schema": { "title": "fields", "type": "string" } }, { "name": "key", "type": "string", "info": "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.: string", "required": false, "schema": { "title": "key", "type": "string" } }, { "name": "oauthToken", "type": "string", "info": "OAuth 2.0 token for the current user.: string", "required": false, "schema": { "title": "oauthToken", "type": "string" } }, { "name": "prettyPrint", "type": "boolean", "info": "Returns response with indentations and line breaks.: boolean", "required": false, "schema": { "title": "prettyPrint", "type": "boolean" } }, { "name": "quotaUser", "type": "string", "info": "An opaque string that represents a user for quota purposes. Must not exceed 40 characters.: string", "required": false, "schema": { "title": "quotaUser", "type": "string" } }, { "name": "userIp", "type": "string", "info": "Deprecated. Please use quotaUser instead.: string", "required": false, "schema": { "title": "userIp", "type": "string" } }, { "name": "requestId", "type": "string", "info": "An ID, such as a random UUID, which uniquely identifies this user's request for idempotent creation of a Team Drive. A repeated request by the same user and with the same...(description truncated): string", "required": true, "schema": { "title": "requestId", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"backgroundImageFile\": {\"id\": \"string\", \"width\": 123, \"xCoordinate\": 123, \"yCoordinate\": 123}, \"backgroundImageLink\": \"string\", \"capabilities\": {\"canAddChildren\": \"boolean\", \"canChangeCopyRequiresWriterPermissionRestriction\": \"boolean\", \"canChangeDomainUsersOnlyRestriction\": \"boolean\", \"canChangeTeamDriveBackground\": \"boolean\", \"canChangeTeamMembersOnlyRestriction\": \"boolean\", \"canComment\": \"boolean\", \"canCopy\": \"boolean\", \"canDeleteChildren\": \"boolean\", \"canDeleteTeamDrive\": \"boolean\", \"canDownload\": \"boolean\", \"canEdit\": \"boolean\", \"canListChildren\": \"boolean\", \"canManageMembers\": \"boolean\", \"canReadRevisions\": \"boolean\", \"canRemoveChildren\": \"boolean\", \"canRename\": \"boolean\", \"canRenameTeamDrive\": \"boolean\", \"canShare\": \"boolean\", \"canTrashChildren\": \"boolean\"}, \"colorRgb\": \"string\", \"createdTime\": \"string\", \"id\": \"string\", \"kind\": \"string\", \"name\": \"string\", \"orgUnitId\": \"string\", \"restrictions\": {\"adminManagedRestrictions\": \"boolean\", \"copyRequiresWriterPermission\": \"boolean\", \"domainUsersOnly\": \"boolean\", \"teamMembersOnly\": \"boolean\"}, \"themeId\": \"string\"}", "required": false, "schema": { "description": "Deprecated: use the drive collection instead.", "properties": { "backgroundImageFile": { "description": "An image file and cropping parameters from which a background image for this Team Drive is set. This is a write only field; it can only be set on drive.teamdrives.update requests that don't set themeId. When specified, all fields of the backgroundImageFile must be set.", "properties": { "id": { "description": "The ID of an image file in Drive to use for the background image.", "type": "string" }, "width": { "description": "The width of the cropped image in the closed range of 0 to 1. This value represents the width of the cropped image divided by the width of the entire image. The height is computed by applying a width to height aspect ratio of 80 to 9. The resulting image must be at least 1280 pixels wide and 144 pixels high.", "type": "number" }, "xCoordinate": { "description": "The X coordinate of the upper left corner of the cropping area in the background image. This is a value in the closed range of 0 to 1. This value represents the horizontal distance from the left side of the entire image to the left side of the cropping area divided by the width of the entire image.", "type": "number" }, "yCoordinate": { "description": "The Y coordinate of the upper left corner of the cropping area in the background image. This is a value in the closed range of 0 to 1. This value represents the vertical distance from the top side of the entire image to the top side of the cropping area divided by the height of the entire image.", "type": "number" } }, "type": "object" }, "backgroundImageLink": { "description": "A short-lived link to this Team Drive's background image.", "type": "string" }, "capabilities": { "description": "Capabilities the current user has on this Team Drive.", "properties": { "canAddChildren": { "description": "Whether the current user can add children to folders in this Team Drive.", "type": "boolean" }, "canChangeCopyRequiresWriterPermissionRestriction": { "description": "Whether the current user can change the copyRequiresWriterPermission restriction of this Team Drive.", "type": "boolean" }, "canChangeDomainUsersOnlyRestriction": { "description": "Whether the current user can change the domainUsersOnly restriction of this Team Drive.", "type": "boolean" }, "canChangeTeamDriveBackground": { "description": "Whether the current user can change the background of this Team Drive.", "type": "boolean" }, "canChangeTeamMembersOnlyRestriction": { "description": "Whether the current user can change the teamMembersOnly restriction of this Team Drive.", "type": "boolean" }, "canComment": { "description": "Whether the current user can comment on files in this Team Drive.", "type": "boolean" }, "canCopy": { "description": "Whether the current user can copy files in this Team Drive.", "type": "boolean" }, "canDeleteChildren": { "description": "Whether the current user can delete children from folders in this Team Drive.", "type": "boolean" }, "canDeleteTeamDrive": { "description": "Whether the current user can delete this Team Drive. Attempting to delete the Team Drive may still fail if there are untrashed items inside the Team Drive.", "type": "boolean" }, "canDownload": { "description": "Whether the current user can download files in this Team Drive.", "type": "boolean" }, "canEdit": { "description": "Whether the current user can edit files in this Team Drive", "type": "boolean" }, "canListChildren": { "description": "Whether the current user can list the children of folders in this Team Drive.", "type": "boolean" }, "canManageMembers": { "description": "Whether the current user can add members to this Team Drive or remove them or change their role.", "type": "boolean" }, "canReadRevisions": { "description": "Whether the current user can read the revisions resource of files in this Team Drive.", "type": "boolean" }, "canRemoveChildren": { "description": "Deprecated - use canDeleteChildren or canTrashChildren instead.", "type": "boolean" }, "canRename": { "description": "Whether the current user can rename files or folders in this Team Drive.", "type": "boolean" }, "canRenameTeamDrive": { "description": "Whether the current user can rename this Team Drive.", "type": "boolean" }, "canShare": { "description": "Whether the current user can share files or folders in this Team Drive.", "type": "boolean" }, "canTrashChildren": { "description": "Whether the current user can trash children from folders in this Team Drive.", "type": "boolean" } }, "type": "object" }, "colorRgb": { "description": "The color of this Team Drive as an RGB hex string. It can only be set on a drive.teamdrives.update request that does not set themeId.", "type": "string" }, "createdTime": { "description": "The time at which the Team Drive was created (RFC 3339 date-time).", "type": "string" }, "id": { "description": "The ID of this Team Drive which is also the ID of the top level folder of this Team Drive.", "type": "string" }, "kind": { "default": "drive#teamDrive", "description": "Identifies what kind of resource this is. Value: the fixed string \"drive#teamDrive\".", "type": "string" }, "name": { "description": "The name of this Team Drive.", "type": "string" }, "orgUnitId": { "description": "The organizational unit of this shared drive. This field is only populated on drives.list responses when the useDomainAdminAccess parameter is set to true.", "type": "string" }, "restrictions": { "description": "A set of restrictions that apply to this Team Drive or items inside this Team Drive.", "properties": { "adminManagedRestrictions": { "description": "Whether administrative privileges on this Team Drive are required to modify restrictions.", "type": "boolean" }, "copyRequiresWriterPermission": { "description": "Whether the options to copy, print, or download files inside this Team Drive, should be disabled for readers and commenters. When this restriction is set to true, it will override the similarly named field to true for any file inside this Team Drive.", "type": "boolean" }, "domainUsersOnly": { "description": "Whether access to this Team Drive and items inside this Team Drive is restricted to users of the domain to which this Team Drive belongs. This restriction may be overridden by other sharing policies controlled outside of this Team Drive.", "type": "boolean" }, "teamMembersOnly": { "description": "Whether access to items inside this Team Drive is restricted to members of this Team Drive.", "type": "boolean" } }, "type": "object" }, "themeId": { "description": "The ID of the theme from which the background image and color will be set. The set of possible teamDriveThemes can be retrieved from a drive.about.get response. When not specified on a drive.teamdrives.create request, a random theme is chosen from which the background image and color are set. This is a write-only field; it can only be set on requests that don't set colorRgb or backgroundImageFile.", "type": "string" } }, "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/driveTeamdrivesCreate" }, "task": true }, { "name": "driveTeamdrivesDelete", "summary": "Deprecated use drives.delete instead.", "description": "Deprecated use drives.delete instead.", "input": [ { "name": "alt", "type": "string", "info": "Data format for the response.: Must be one of [json]", "required": false, "schema": { "title": "alt", "type": "string" } }, { "name": "fields", "type": "string", "info": "Selector specifying which fields to include in a partial response.: string", "required": false, "schema": { "title": "fields", "type": "string" } }, { "name": "key", "type": "string", "info": "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.: string", "required": false, "schema": { "title": "key", "type": "string" } }, { "name": "oauthToken", "type": "string", "info": "OAuth 2.0 token for the current user.: string", "required": false, "schema": { "title": "oauthToken", "type": "string" } }, { "name": "prettyPrint", "type": "boolean", "info": "Returns response with indentations and line breaks.: boolean", "required": false, "schema": { "title": "prettyPrint", "type": "boolean" } }, { "name": "quotaUser", "type": "string", "info": "An opaque string that represents a user for quota purposes. Must not exceed 40 characters.: string", "required": false, "schema": { "title": "quotaUser", "type": "string" } }, { "name": "userIp", "type": "string", "info": "Deprecated. Please use quotaUser instead.: string", "required": false, "schema": { "title": "userIp", "type": "string" } }, { "name": "teamDriveId", "type": "string", "info": "The ID of the Team Drive: string", "required": true, "schema": { "title": "teamDriveId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/driveTeamdrivesDelete" }, "task": true }, { "name": "driveTeamdrivesGet", "summary": "Deprecated use drives.get instead.", "description": "Deprecated use drives.get instead.", "input": [ { "name": "alt", "type": "string", "info": "Data format for the response.: Must be one of [json]", "required": false, "schema": { "title": "alt", "type": "string" } }, { "name": "fields", "type": "string", "info": "Selector specifying which fields to include in a partial response.: string", "required": false, "schema": { "title": "fields", "type": "string" } }, { "name": "key", "type": "string", "info": "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.: string", "required": false, "schema": { "title": "key", "type": "string" } }, { "name": "oauthToken", "type": "string", "info": "OAuth 2.0 token for the current user.: string", "required": false, "schema": { "title": "oauthToken", "type": "string" } }, { "name": "prettyPrint", "type": "boolean", "info": "Returns response with indentations and line breaks.: boolean", "required": false, "schema": { "title": "prettyPrint", "type": "boolean" } }, { "name": "quotaUser", "type": "string", "info": "An opaque string that represents a user for quota purposes. Must not exceed 40 characters.: string", "required": false, "schema": { "title": "quotaUser", "type": "string" } }, { "name": "userIp", "type": "string", "info": "Deprecated. Please use quotaUser instead.: string", "required": false, "schema": { "title": "userIp", "type": "string" } }, { "name": "teamDriveId", "type": "string", "info": "The ID of the Team Drive: string", "required": true, "schema": { "title": "teamDriveId", "type": "string" } }, { "name": "useDomainAdminAccess", "type": "boolean", "info": "Issue the request as a domain administrator; if set to true, then the requester will be granted access if they are an administrator of the domain to which the Team Drive ...(description truncated): boolean", "required": false, "schema": { "title": "useDomainAdminAccess", "type": "boolean" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/driveTeamdrivesGet" }, "task": true }, { "name": "driveTeamdrivesUpdate", "summary": "Deprecated use drives.update instead", "description": "Deprecated use drives.update instead", "input": [ { "name": "alt", "type": "string", "info": "Data format for the response.: Must be one of [json]", "required": false, "schema": { "title": "alt", "type": "string" } }, { "name": "fields", "type": "string", "info": "Selector specifying which fields to include in a partial response.: string", "required": false, "schema": { "title": "fields", "type": "string" } }, { "name": "key", "type": "string", "info": "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.: string", "required": false, "schema": { "title": "key", "type": "string" } }, { "name": "oauthToken", "type": "string", "info": "OAuth 2.0 token for the current user.: string", "required": false, "schema": { "title": "oauthToken", "type": "string" } }, { "name": "prettyPrint", "type": "boolean", "info": "Returns response with indentations and line breaks.: boolean", "required": false, "schema": { "title": "prettyPrint", "type": "boolean" } }, { "name": "quotaUser", "type": "string", "info": "An opaque string that represents a user for quota purposes. Must not exceed 40 characters.: string", "required": false, "schema": { "title": "quotaUser", "type": "string" } }, { "name": "userIp", "type": "string", "info": "Deprecated. Please use quotaUser instead.: string", "required": false, "schema": { "title": "userIp", "type": "string" } }, { "name": "teamDriveId", "type": "string", "info": "The ID of the Team Drive: string", "required": true, "schema": { "title": "teamDriveId", "type": "string" } }, { "name": "useDomainAdminAccess", "type": "boolean", "info": "Issue the request as a domain administrator; if set to true, then the requester will be granted access if they are an administrator of the domain to which the Team Drive ...(description truncated): boolean", "required": false, "schema": { "title": "useDomainAdminAccess", "type": "boolean" } }, { "name": "body", "type": "object", "info": ": {\"backgroundImageFile\": {\"id\": \"string\", \"width\": 123, \"xCoordinate\": 123, \"yCoordinate\": 123}, \"backgroundImageLink\": \"string\", \"capabilities\": {\"canAddChildren\": \"boolean\", \"canChangeCopyRequiresWriterPermissionRestriction\": \"boolean\", \"canChangeDomainUsersOnlyRestriction\": \"boolean\", \"canChangeTeamDriveBackground\": \"boolean\", \"canChangeTeamMembersOnlyRestriction\": \"boolean\", \"canComment\": \"boolean\", \"canCopy\": \"boolean\", \"canDeleteChildren\": \"boolean\", \"canDeleteTeamDrive\": \"boolean\", \"canDownload\": \"boolean\", \"canEdit\": \"boolean\", \"canListChildren\": \"boolean\", \"canManageMembers\": \"boolean\", \"canReadRevisions\": \"boolean\", \"canRemoveChildren\": \"boolean\", \"canRename\": \"boolean\", \"canRenameTeamDrive\": \"boolean\", \"canShare\": \"boolean\", \"canTrashChildren\": \"boolean\"}, \"colorRgb\": \"string\", \"createdTime\": \"string\", \"id\": \"string\", \"kind\": \"string\", \"name\": \"string\", \"orgUnitId\": \"string\", \"restrictions\": {\"adminManagedRestrictions\": \"boolean\", \"copyRequiresWriterPermission\": \"boolean\", \"domainUsersOnly\": \"boolean\", \"teamMembersOnly\": \"boolean\"}, \"themeId\": \"string\"}", "required": false, "schema": { "description": "Deprecated: use the drive collection instead.", "properties": { "backgroundImageFile": { "description": "An image file and cropping parameters from which a background image for this Team Drive is set. This is a write only field; it can only be set on drive.teamdrives.update requests that don't set themeId. When specified, all fields of the backgroundImageFile must be set.", "properties": { "id": { "description": "The ID of an image file in Drive to use for the background image.", "type": "string" }, "width": { "description": "The width of the cropped image in the closed range of 0 to 1. This value represents the width of the cropped image divided by the width of the entire image. The height is computed by applying a width to height aspect ratio of 80 to 9. The resulting image must be at least 1280 pixels wide and 144 pixels high.", "type": "number" }, "xCoordinate": { "description": "The X coordinate of the upper left corner of the cropping area in the background image. This is a value in the closed range of 0 to 1. This value represents the horizontal distance from the left side of the entire image to the left side of the cropping area divided by the width of the entire image.", "type": "number" }, "yCoordinate": { "description": "The Y coordinate of the upper left corner of the cropping area in the background image. This is a value in the closed range of 0 to 1. This value represents the vertical distance from the top side of the entire image to the top side of the cropping area divided by the height of the entire image.", "type": "number" } }, "type": "object" }, "backgroundImageLink": { "description": "A short-lived link to this Team Drive's background image.", "type": "string" }, "capabilities": { "description": "Capabilities the current user has on this Team Drive.", "properties": { "canAddChildren": { "description": "Whether the current user can add children to folders in this Team Drive.", "type": "boolean" }, "canChangeCopyRequiresWriterPermissionRestriction": { "description": "Whether the current user can change the copyRequiresWriterPermission restriction of this Team Drive.", "type": "boolean" }, "canChangeDomainUsersOnlyRestriction": { "description": "Whether the current user can change the domainUsersOnly restriction of this Team Drive.", "type": "boolean" }, "canChangeTeamDriveBackground": { "description": "Whether the current user can change the background of this Team Drive.", "type": "boolean" }, "canChangeTeamMembersOnlyRestriction": { "description": "Whether the current user can change the teamMembersOnly restriction of this Team Drive.", "type": "boolean" }, "canComment": { "description": "Whether the current user can comment on files in this Team Drive.", "type": "boolean" }, "canCopy": { "description": "Whether the current user can copy files in this Team Drive.", "type": "boolean" }, "canDeleteChildren": { "description": "Whether the current user can delete children from folders in this Team Drive.", "type": "boolean" }, "canDeleteTeamDrive": { "description": "Whether the current user can delete this Team Drive. Attempting to delete the Team Drive may still fail if there are untrashed items inside the Team Drive.", "type": "boolean" }, "canDownload": { "description": "Whether the current user can download files in this Team Drive.", "type": "boolean" }, "canEdit": { "description": "Whether the current user can edit files in this Team Drive", "type": "boolean" }, "canListChildren": { "description": "Whether the current user can list the children of folders in this Team Drive.", "type": "boolean" }, "canManageMembers": { "description": "Whether the current user can add members to this Team Drive or remove them or change their role.", "type": "boolean" }, "canReadRevisions": { "description": "Whether the current user can read the revisions resource of files in this Team Drive.", "type": "boolean" }, "canRemoveChildren": { "description": "Deprecated - use canDeleteChildren or canTrashChildren instead.", "type": "boolean" }, "canRename": { "description": "Whether the current user can rename files or folders in this Team Drive.", "type": "boolean" }, "canRenameTeamDrive": { "description": "Whether the current user can rename this Team Drive.", "type": "boolean" }, "canShare": { "description": "Whether the current user can share files or folders in this Team Drive.", "type": "boolean" }, "canTrashChildren": { "description": "Whether the current user can trash children from folders in this Team Drive.", "type": "boolean" } }, "type": "object" }, "colorRgb": { "description": "The color of this Team Drive as an RGB hex string. It can only be set on a drive.teamdrives.update request that does not set themeId.", "type": "string" }, "createdTime": { "description": "The time at which the Team Drive was created (RFC 3339 date-time).", "type": "string" }, "id": { "description": "The ID of this Team Drive which is also the ID of the top level folder of this Team Drive.", "type": "string" }, "kind": { "default": "drive#teamDrive", "description": "Identifies what kind of resource this is. Value: the fixed string \"drive#teamDrive\".", "type": "string" }, "name": { "description": "The name of this Team Drive.", "type": "string" }, "orgUnitId": { "description": "The organizational unit of this shared drive. This field is only populated on drives.list responses when the useDomainAdminAccess parameter is set to true.", "type": "string" }, "restrictions": { "description": "A set of restrictions that apply to this Team Drive or items inside this Team Drive.", "properties": { "adminManagedRestrictions": { "description": "Whether administrative privileges on this Team Drive are required to modify restrictions.", "type": "boolean" }, "copyRequiresWriterPermission": { "description": "Whether the options to copy, print, or download files inside this Team Drive, should be disabled for readers and commenters. When this restriction is set to true, it will override the similarly named field to true for any file inside this Team Drive.", "type": "boolean" }, "domainUsersOnly": { "description": "Whether access to this Team Drive and items inside this Team Drive is restricted to users of the domain to which this Team Drive belongs. This restriction may be overridden by other sharing policies controlled outside of this Team Drive.", "type": "boolean" }, "teamMembersOnly": { "description": "Whether access to items inside this Team Drive is restricted to members of this Team Drive.", "type": "boolean" } }, "type": "object" }, "themeId": { "description": "The ID of the theme from which the background image and color will be set. The set of possible teamDriveThemes can be retrieved from a drive.about.get response. When not specified on a drive.teamdrives.create request, a random theme is chosen from which the background image and color are set. This is a write-only field; it can only be set on requests that don't set colorRgb or backgroundImageFile.", "type": "string" } }, "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/driveTeamdrivesUpdate" }, "task": true } ], "views": [] }