@itentialopensource/adapter-google_drive

{ "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" } } ], "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": [ { "name": "maxCalls", "required": false, "type": "number", "info": "How many GET endpoints to test (defaults to 5)", "schema": { "title": "maxCalls", "type": "number", "default": 5 } } ], "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 Itential Platform database", "description": "Moves entities from an adapter into the Itential Platform 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.",