Interface GoogleDriveV2NodeParameters

Source
interface GoogleDriveV2NodeParameters {
    authentication?: "oAuth2" | "serviceAccount";
    changeFileContent?: boolean;
    content?: string;
    driveId?: {
        mode: "id" | "list" | "url";
        value: string;
    };
    fileId?: { mode: "id"
    | "list"
    | "url"; value: string };
    filter?: {
        driveId?: {
            mode: "id" | "list" | "url";
            value: string;
        };
        fileTypes?: | (
            | "*"
            | "application/vnd.google-apps.audio"
            | "application/vnd.google-apps.document"
            | "application/vnd.google-apps.drawing"
            | "application/vnd.google-apps.presentation"
            | "application/vnd.google-apps.spreadsheet"
            | "application/vnd.google-apps.photo"
            | "application/vnd.google-apps.video"
            | "application/vnd.google-apps.drive-sdk"
            | "application/vnd.google-apps.script"
            | "application/vnd.google-apps.folder"
            | "application/vnd.google-apps.form"
            | "application/vnd.google-apps.fusiontable"
            | "application/vnd.google-apps.map"
            | "application/vnd.google-apps.unknown"
            | "application/vnd.google-apps.sites"
        )[]
        | (
            | "*"
            | "application/vnd.google-apps.audio"
            | "application/vnd.google-apps.document"
            | "application/vnd.google-apps.drawing"
            | "application/vnd.google-apps.presentation"
            | "application/vnd.google-apps.spreadsheet"
            | "application/vnd.google-apps.photo"
            | "application/vnd.google-apps.video"
            | "application/vnd.google-apps.drive-sdk"
            | "application/vnd.google-apps.script"
            | "application/vnd.google-apps.form"
            | "application/vnd.google-apps.fusiontable"
            | "application/vnd.google-apps.map"
            | "application/vnd.google-apps.unknown"
            | "application/vnd.google-apps.sites"
        )[];
        folderId?: {
            mode: "id"
            | "list"
            | "url";
            value: string;
        };
        includeTrashed?: boolean;
        whatToSearch?: "all"
        | "files"
        | "folders";
    };
    folderId?: {
        mode: "id"
        | "list"
        | "url";
        value: string;
    };
    folderNoRootId?: {
        mode: "id"
        | "list"
        | "url";
        value: string;
    };
    inputDataFieldName?: string;
    limit?: number;
    name?: string;
    newUpdatedFileName?: string;
    operation?: | "create"
    | "get"
    | "update"
    | "list"
    | "search"
    | "deleteFile"
    | "upload"
    | "move"
    | "copy"
    | "download"
    | "share"
    | "deleteDrive"
    | "createFromText"
    | "deleteFolder";
    options?: | {
        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;
        hidden?: boolean;
        restrictions?: {
            adminManagedRestrictions?: boolean;
            copyRequiresWriterPermission?: boolean;
            domainUsersOnly?: boolean;
            driveMembersOnly?: boolean;
        };
    }
    | { useDomainAdminAccess?: boolean }
    | { q?: string; useDomainAdminAccess?: boolean }
    | {
        colorRgb?: string;
        name?: string;
        restrictions?: {
            adminManagedRestrictions?: boolean;
            copyRequiresWriterPermission?: boolean;
            domainUsersOnly?: boolean;
            driveMembersOnly?: boolean;
        };
    }
    | {
        copyRequiresWriterPermission?: boolean;
        description?: string;
    }
    | { deletePermanently?: boolean }
    | {
        appPropertiesUi?: {
            appPropertyValues: {
                key?: string;
                value?: string;
            }[];
        };
        convertToGoogleDocument?: boolean;
        keepRevisionForever?: boolean;
        ocrLanguage?: string;
        propertiesUi?: {
            propertyValues: { key?: string; value?: string }[];
        };
        useContentAsIndexableText?: boolean;
    }
    | {
        binaryPropertyName?: string;
        fileName?: string;
        googleFileConversion?: {
            conversion: {
                docsToFormat?: | "text/plain"
                | "text/html"
                | "application/vnd.openxmlformats-officedocument.wordprocessingml.document"
                | "application/vnd.oasis.opendocument.text"
                | "application/pdf"
                | "application/rtf";
                drawingsToFormat?: | "application/pdf"
                | "image/jpeg"
                | "image/png"
                | "image/svg+xml";
                sheetsToFormat?: | "application/pdf"
                | "text/csv"
                | "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet"
                | "application/vnd.oasis.opendocument.spreadsheet";
                slidesToFormat?: | "application/pdf"
                | "application/vnd.openxmlformats-officedocument.presentationml.presentation"
                | "application/vnd.oasis.opendocument.presentation";
            };
        };
    }
    | {
        emailMessage?: string;
        moveToNewOwnersRoot?: boolean;
        sendNotificationEmail?: boolean;
        transferOwnership?: boolean;
        useDomainAdminAccess?: boolean;
    }
    | {
        appPropertiesUi?: {
            appPropertyValues: {
                key?: string;
                value?: string;
            }[];
        };
        fields?: (
            | "id"
            | "name"
            | "permissions"
            | "*"
            | "kind"
            | "explicitlyTrashed"
            | "exportLinks"
            | "hasThumbnail"
            | "iconLink"
            | "mimeType"
            | "shared"
            | "spaces"
            | "starred"
            | "thumbnailLink"
            | "trashed"
            | "version"
            | "webViewLink"
        )[];
        keepRevisionForever?: boolean;
        ocrLanguage?: string;
        propertiesUi?: {
            propertyValues: { key?: string; value?: string }[];
        };
        trashed?: boolean;
        useContentAsIndexableText?: boolean;
    }
    | {
        appPropertiesUi?: {
            appPropertyValues: {
                key?: string;
                value?: string;
            }[];
        };
        keepRevisionForever?: boolean;
        ocrLanguage?: string;
        propertiesUi?: {
            propertyValues: { key?: string; value?: string }[];
        };
        simplifyOutput?: boolean;
        useContentAsIndexableText?: boolean;
    }
    | {
        fields?: (
            | "id"
            | "name"
            | "permissions"
            | "*"
            | "kind"
            | "explicitlyTrashed"
            | "exportLinks"
            | "hasThumbnail"
            | "iconLink"
            | "mimeType"
            | "shared"
            | "spaces"
            | "starred"
            | "thumbnailLink"
            | "trashed"
            | "version"
            | "webViewLink"
        )[];
    }
    | { folderColorRgb?: string; simplifyOutput?: boolean };
    permissionsUi?: {
        permissionsValues: {
            allowFileDiscovery?: boolean;
            domain?: string;
            emailAddress?: string;
            role?:
                | "owner"
                | "commenter"
                | "fileOrganizer"
                | "organizer"
                | "reader"
                | "writer";
            type?: "user"
            | "group"
            | "domain"
            | "anyone";
        };
    };
    queryString?: string;
    resource?: "file"
    | "folder"
    | "drive"
    | "fileFolder";
    returnAll?: boolean;
    sameFolder?: boolean;
    searchMethod?: "query" | "name";
}

Properties§

Source§

readonly authentication?: "oAuth2" | "serviceAccount"

Default: "oAuth2"

Source§

readonly changeFileContent?: boolean

Whether to send a new binary data to update the file

Source§

readonly content?: string

The text to create the file with Type options: {"rows":2}

Source§

readonly driveId?: { mode: "id" | "list" | "url"; value: string }

The shared drive to delete Default: {"mode":"list","value":""}

Source§

readonly fileId?: { mode: "id" | "list" | "url"; value: string }

The file to copy Default: {"mode":"list","value":""}

Source§

readonly filter?: {
    driveId?: {
        mode: "id" | "list" | "url";
        value: string;
    };
    fileTypes?: | (
        | "*"
        | "application/vnd.google-apps.audio"
        | "application/vnd.google-apps.document"
        | "application/vnd.google-apps.drawing"
        | "application/vnd.google-apps.presentation"
        | "application/vnd.google-apps.spreadsheet"
        | "application/vnd.google-apps.photo"
        | "application/vnd.google-apps.video"
        | "application/vnd.google-apps.drive-sdk"
        | "application/vnd.google-apps.script"
        | "application/vnd.google-apps.folder"
        | "application/vnd.google-apps.form"
        | "application/vnd.google-apps.fusiontable"
        | "application/vnd.google-apps.map"
        | "application/vnd.google-apps.unknown"
        | "application/vnd.google-apps.sites"
    )[]
    | (
        | "*"
        | "application/vnd.google-apps.audio"
        | "application/vnd.google-apps.document"
        | "application/vnd.google-apps.drawing"
        | "application/vnd.google-apps.presentation"
        | "application/vnd.google-apps.spreadsheet"
        | "application/vnd.google-apps.photo"
        | "application/vnd.google-apps.video"
        | "application/vnd.google-apps.drive-sdk"
        | "application/vnd.google-apps.script"
        | "application/vnd.google-apps.form"
        | "application/vnd.google-apps.fusiontable"
        | "application/vnd.google-apps.map"
        | "application/vnd.google-apps.unknown"
        | "application/vnd.google-apps.sites"
    )[];
    folderId?: {
        mode: "id"
        | "list"
        | "url";
        value: string;
    };
    includeTrashed?: boolean;
    whatToSearch?: "all"
    | "files"
    | "folders";
}

Default: {}

Source§

readonly folderId?: { mode: "id" | "list" | "url"; value: string }

The folder where to save the copied file Default: {"mode":"list","value":"root","cachedResultName":"/ (Root folder)"}

Source§

readonly folderNoRootId?: { mode: "id" | "list" | "url"; value: string }

The folder to delete Default: {"mode":"list","value":""}

Source§

readonly inputDataFieldName?: string

Find the name of input field containing the binary data to update the file in the Input panel on the left, in the Binary tab Default: "data"

Source§

readonly limit?: number

Max number of results to return Default: 100 Type options: {"minValue":1,"maxValue":200}

Source§

readonly name?: string

The name of the shared drive to create

Source§

readonly newUpdatedFileName?: string

If not specified, the file name will not be changed

Source§

readonly operation?:
    | "create"
    | "get"
    | "update"
    | "list"
    | "search"
    | "deleteFile"
    | "upload"
    | "move"
    | "copy"
    | "download"
    | "share"
    | "deleteDrive"
    | "createFromText"
    | "deleteFolder"

Default: "create"

Source§

readonly options?:
    | {
        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;
        hidden?: boolean;
        restrictions?: {
            adminManagedRestrictions?: boolean;
            copyRequiresWriterPermission?: boolean;
            domainUsersOnly?: boolean;
            driveMembersOnly?: boolean;
        };
    }
    | { useDomainAdminAccess?: boolean }
    | { q?: string; useDomainAdminAccess?: boolean }
    | {
        colorRgb?: string;
        name?: string;
        restrictions?: {
            adminManagedRestrictions?: boolean;
            copyRequiresWriterPermission?: boolean;
            domainUsersOnly?: boolean;
            driveMembersOnly?: boolean;
        };
    }
    | {
        copyRequiresWriterPermission?: boolean;
        description?: string;
    }
    | { deletePermanently?: boolean }
    | {
        appPropertiesUi?: {
            appPropertyValues: {
                key?: string;
                value?: string;
            }[];
        };
        convertToGoogleDocument?: boolean;
        keepRevisionForever?: boolean;
        ocrLanguage?: string;
        propertiesUi?: {
            propertyValues: { key?: string; value?: string }[];
        };
        useContentAsIndexableText?: boolean;
    }
    | {
        binaryPropertyName?: string;
        fileName?: string;
        googleFileConversion?: {
            conversion: {
                docsToFormat?: | "text/plain"
                | "text/html"
                | "application/vnd.openxmlformats-officedocument.wordprocessingml.document"
                | "application/vnd.oasis.opendocument.text"
                | "application/pdf"
                | "application/rtf";
                drawingsToFormat?: | "application/pdf"
                | "image/jpeg"
                | "image/png"
                | "image/svg+xml";
                sheetsToFormat?: | "application/pdf"
                | "text/csv"
                | "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet"
                | "application/vnd.oasis.opendocument.spreadsheet";
                slidesToFormat?: | "application/pdf"
                | "application/vnd.openxmlformats-officedocument.presentationml.presentation"
                | "application/vnd.oasis.opendocument.presentation";
            };
        };
    }
    | {
        emailMessage?: string;
        moveToNewOwnersRoot?: boolean;
        sendNotificationEmail?: boolean;
        transferOwnership?: boolean;
        useDomainAdminAccess?: boolean;
    }
    | {
        appPropertiesUi?: {
            appPropertyValues: {
                key?: string;
                value?: string;
            }[];
        };
        fields?: (
            | "id"
            | "name"
            | "permissions"
            | "*"
            | "kind"
            | "explicitlyTrashed"
            | "exportLinks"
            | "hasThumbnail"
            | "iconLink"
            | "mimeType"
            | "shared"
            | "spaces"
            | "starred"
            | "thumbnailLink"
            | "trashed"
            | "version"
            | "webViewLink"
        )[];
        keepRevisionForever?: boolean;
        ocrLanguage?: string;
        propertiesUi?: {
            propertyValues: { key?: string; value?: string }[];
        };
        trashed?: boolean;
        useContentAsIndexableText?: boolean;
    }
    | {
        appPropertiesUi?: {
            appPropertyValues: {
                key?: string;
                value?: string;
            }[];
        };
        keepRevisionForever?: boolean;
        ocrLanguage?: string;
        propertiesUi?: {
            propertyValues: { key?: string; value?: string }[];
        };
        simplifyOutput?: boolean;
        useContentAsIndexableText?: boolean;
    }
    | {
        fields?: (
            | "id"
            | "name"
            | "permissions"
            | "*"
            | "kind"
            | "explicitlyTrashed"
            | "exportLinks"
            | "hasThumbnail"
            | "iconLink"
            | "mimeType"
            | "shared"
            | "spaces"
            | "starred"
            | "thumbnailLink"
            | "trashed"
            | "version"
            | "webViewLink"
        )[];
    }
    | { folderColorRgb?: string; simplifyOutput?: boolean }

Default: {}

Source§

readonly permissionsUi?: {
    permissionsValues: {
        allowFileDiscovery?: boolean;
        domain?: string;
        emailAddress?: string;
        role?:
            | "owner"
            | "commenter"
            | "fileOrganizer"
            | "organizer"
            | "reader"
            | "writer";
        type?: "user"
        | "group"
        | "domain"
        | "anyone";
    };
}

Default: {} Type options: {"multipleValues":false}

Source§

readonly queryString?: string

The name of the file or folder to search for. Returns also files and folders whose names partially match this search term.

Source§

readonly resource?: "file" | "folder" | "drive" | "fileFolder"

Default: "file"

Source§

readonly returnAll?: boolean

Whether to return all results or only up to a given limit

Source§

readonly sameFolder?: boolean

Whether to copy the file in the same folder as the original file Default: true

Source§

readonly searchMethod?: "query" | "name"

Whether to search for the file/folder name or use a query string Default: "name"