Skip to content

Google: Restores a shared drive to the default view For more information, see Manage shared drives (https: developers google com workspace drive api guides manage-shareddrives)

Google driveDrives.driveDrivesUnhide: arguments, response, policy and SDK examples.

← Drive drives operations · Get started

Operation google.drive_drives_unhide

Provider route: POST /drive/v3/drives/{driveId}/unhide. Alter supplies the connection’s credentials and routing.

Install @alter-ai/sdk @alter-ai/google with npm, or alter-sdk-google with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { GoogleIntegration } from "@alter-ai/google";
async function execute(input: Parameters<GoogleIntegration["driveDrives"]["driveDrivesUnhide"]>[0]) {
const app = new App({ apiKey: process.env.ALTER_API_KEY! });
try {
const provider = new GoogleIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
const call = await provider.driveDrives.driveDrivesUnhide(input);
const result = await call.wait();
return result.bodyJson();
} finally {
await app.close();
}
}
import os
from alter_sdk import App
from alter_sdk_google import GoogleIntegration
async def execute(arguments):
async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
provider = GoogleIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
call = await provider.drive_drives.drive_drives_unhide(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
pathobjectRequired within parentAdditional keys: not allowed
path.driveIdstringRequired within parentThe ID of the shared drive.
queryobjectOptionalAdditional keys: not allowed
query.fieldsstringOptionalSelector specifying which fields to include in a partial response.
query.prettyPrintbooleanOptionalReturns response with indentations and line breaks.
Default: true
query.quotaUserstringOptionalAvailable to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

FieldTypePresenceDescription and constraints
$ModelRootExpand Creates a shared drive For more information, see Manage shared drives (https: developers google com workspace drive api guides manage-shareddrives) — response body

Referenced models: Creates a shared drive For more information, see Manage shared drives (https: developers google com workspace drive api guides manage-shareddrives) — response body

Creates a shared drive For more information, see Manage shared drives (https: developers google com workspace drive api guides manage-shareddrives) — response body
FieldTypePresenceDescription and constraints
$objectRootRepresentation of a shared drive. Some resource methods (such as `drives.update`) require a `driveId`. Use the `drives.list` method to retrieve the ID for a shared drive.
backgroundImageFileobjectOptionalAn 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.
backgroundImageFile.idstringOptionalThe ID of an image file in Google Drive to use for the background image.
backgroundImageFile.widthJSONOptional
backgroundImageFile.width (anyOf 1)numberAlternativeThe 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.
Format: float
backgroundImageFile.width (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
backgroundImageFile.xCoordinateJSONOptional
backgroundImageFile.xCoordinate (anyOf 1)numberAlternativeThe 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.
Format: float
backgroundImageFile.xCoordinate (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
backgroundImageFile.yCoordinateJSONOptional
backgroundImageFile.yCoordinate (anyOf 1)numberAlternativeThe 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.
Format: float
backgroundImageFile.yCoordinate (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
backgroundImageLinkstringOptionalOutput only. A short-lived link to this shared drive's background image.
capabilitiesModelOptionalExpand Creates a shared drive For more information, see Manage shared drives (https: developers google com workspace drive api guides manage-shareddrives) — response body — capabilities
colorRgbstringOptionalThe 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`.
createdTimestringOptionalThe time at which the shared drive was created (RFC 3339 date-time).
Format: date-time
hiddenbooleanOptionalWhether the shared drive is hidden from default view.
idstringOptionalOutput only. The ID of this shared drive which is also the ID of the top level folder of this shared drive.
kindstringOptionalOutput only. Identifies what kind of resource this is. Value: the fixed string `"drive#drive"`.
Default: drive#drive
namestringOptionalThe name of this shared drive.
orgUnitIdstringOptionalOutput only. The organizational unit of this shared drive. This field is only populated on `drives.list` responses when the `useDomainAdminAccess` parameter is set to `true`.
restrictionsModelOptionalExpand Creates a shared drive For more information, see Manage shared drives (https: developers google com workspace drive api guides manage-shareddrives) — response body — restrictions
themeIdstringOptionalThe 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`.

Referenced models: Creates a shared drive For more information, see Manage shared drives (https: developers google com workspace drive api guides manage-shareddrives) — response body — capabilities, Creates a shared drive For more information, see Manage shared drives (https: developers google com workspace drive api guides manage-shareddrives) — response body — restrictions

Creates a shared drive For more information, see Manage shared drives (https: developers google com workspace drive api guides manage-shareddrives) — response body — capabilities
FieldTypePresenceDescription and constraints
$objectRootOutput only. Capabilities the current user has on this shared drive.
canAddChildrenbooleanOptionalOutput only. Whether the current user can add children to folders in this shared drive.
canChangeCopyRequiresWriterPermissionRestrictionbooleanOptionalOutput only. Whether the current user can change the `copyRequiresWriterPermission` restriction of this shared drive.
canChangeDomainUsersOnlyRestrictionbooleanOptionalOutput only. Whether the current user can change the `domainUsersOnly` restriction of this shared drive.
canChangeDownloadRestrictionbooleanOptionalOutput only. Whether the current user can change organizer-applied download restrictions of this shared drive.
canChangeDriveBackgroundbooleanOptionalOutput only. Whether the current user can change the background of this shared drive.
canChangeDriveMembersOnlyRestrictionbooleanOptionalOutput only. Whether the current user can change the `driveMembersOnly` restriction of this shared drive.
canChangeSharingFoldersRequiresOrganizerPermissionRestrictionbooleanOptionalOutput only. Whether the current user can change the `sharingFoldersRequiresOrganizerPermission` restriction of this shared drive.
canCommentbooleanOptionalOutput only. Whether the current user can comment on files in this shared drive.
canCopybooleanOptionalOutput only. Whether the current user can copy files in this shared drive.
canDeleteChildrenbooleanOptionalOutput only. Whether the current user can delete children from folders in this shared drive.
canDeleteDrivebooleanOptionalOutput only. 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.
canDownloadbooleanOptionalOutput only. Whether the current user can download files in this shared drive.
canEditbooleanOptionalOutput only. Whether the current user can edit files in this shared drive
canListChildrenbooleanOptionalOutput only. Whether the current user can list the children of folders in this shared drive.
canManageMembersbooleanOptionalOutput only. Whether the current user can add members to this shared drive or remove them or change their role.
canReadRevisionsbooleanOptionalOutput only. Whether the current user can read the revisions resource of files in this shared drive.
canRenamebooleanOptionalOutput only. Whether the current user can rename files or folders in this shared drive.
canRenameDrivebooleanOptionalOutput only. Whether the current user can rename this shared drive.
canResetDriveRestrictionsbooleanOptionalOutput only. Whether the current user can reset the shared drive restrictions to defaults.
canSharebooleanOptionalOutput only. Whether the current user can share files or folders in this shared drive.
canTrashChildrenbooleanOptionalOutput only. Whether the current user can trash children from folders in this shared drive.
Creates a shared drive For more information, see Manage shared drives (https: developers google com workspace drive api guides manage-shareddrives) — response body — restrictions
FieldTypePresenceDescription and constraints
$objectRootA set of restrictions that apply to this shared drive or items inside this shared drive. Note that restrictions can't be set when creating a shared drive. To add a restriction, first create a shared drive and then use `drives.update` to add restrictions.
adminManagedRestrictionsbooleanOptionalWhether administrative privileges on this shared drive are required to modify restrictions.
copyRequiresWriterPermissionbooleanOptionalWhether 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.
domainUsersOnlybooleanOptionalWhether 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.
downloadRestrictionModelOptionalExpand Deprecated: Use `drives get` instead — response body — restrictions download Restriction
Download restrictions applied by shared drive managers.
driveMembersOnlybooleanOptionalWhether access to items inside this shared drive is restricted to its members.
sharingFoldersRequiresOrganizerPermissionbooleanOptionalIf true, only users with the organizer role can share folders. If false, users with either the organizer role or the file organizer role can share folders.

Referenced models: Deprecated: Use `drives get` instead — response body — restrictions download Restriction

Deprecated: Use `drives get` instead — response body — restrictions download Restriction
FieldTypePresenceDescription and constraints
$objectRootA restriction for copy and download of the file.
restrictedForReadersbooleanOptionalWhether download and copy is restricted for readers.
restrictedForWritersbooleanOptionalWhether download and copy is restricted for writers. If true, download is also restricted for readers.

SDK function policy ID: google.drive_drives_unhide. Catalog operation: drive.drives.unhide. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

Required provider scopes: ["https://www.googleapis.com/auth/drive"]

Official provider source

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.