Skip to content

Google: Gets a file's metadata or content by ID For more information, see Search for files and folders (https: developers google com workspace drive api guides search-files) If you provide the URL parameter `alt=media`, then the response includes the file contents in the response body Downloading content with `alt=media` only works if the file is stored in Drive To download Google Docs, Sheets, and Slides use `files export` (https: developers google com workspace drive api reference rest v3 files export) instead For more information, see Download and export files (https: developers google com workspace drive api guides manage-downloads)

Google driveFiles.driveFilesGet: arguments, response, policy and SDK examples.

← Drive files operations · Get started

Operation google.drive_files_get

Provider route: GET /drive/v3/files/{fileId}. 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["driveFiles"]["driveFilesGet"]>[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.driveFiles.driveFilesGet(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_files.drive_files_get(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
pathobjectRequired within parentAdditional keys: not allowed
path.fileIdstringRequired within parentThe ID of the file.
queryModelOptionalExpand Subscribes to changes to a file For more information, see Notifications for resource changes (https: developers google com workspace drive api guides push) — request body — query

Referenced models: Subscribes to changes to a file For more information, see Notifications for resource changes (https: developers google com workspace drive api guides push) — request body — query

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 copy of a file and applies any requested updates with patch semantics For more information, see Create and manage files (https: developers google com workspace drive api guides create-file) — response body

Referenced models: Creates a copy of a file and applies any requested updates with patch semantics For more information, see Create and manage files (https: developers google com workspace drive api guides create-file) — response body

8 more schemas are linked from the tables above, on the schema pages.

Subscribes to changes to a file For more information, see Notifications for resource changes (https: developers google com workspace drive api guides push) — request body — query
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
fieldsstringOptionalSelector specifying which fields to include in a partial response.
prettyPrintbooleanOptionalReturns response with indentations and line breaks.
Default: true
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.
acknowledgeAbusebooleanOptionalWhether the user is acknowledging the risk of downloading known malware or other abusive files. This is only applicable when the `alt` parameter is set to `media` and the user is the owner of the file or an organizer of the shared drive in which the file resides.
Default: false
includeLabelsstringOptionalA comma-separated list of IDs of labels to include in the `labelInfo` part of the response.
includePermissionsForViewstringOptionalSpecifies which additional view's permissions to include in the response. Only `published` is supported.
supportsAllDrivesbooleanOptionalWhether the requesting application supports both My Drives and shared drives.
Default: false
supportsTeamDrivesbooleanOptionalDeprecated: Use `supportsAllDrives` instead.
Default: false
Creates a copy of a file and applies any requested updates with patch semantics For more information, see Create and manage files (https: developers google com workspace drive api guides create-file) — response body — client Encryption Details
FieldTypePresenceDescription and constraints
$objectRootDetails about the client-side encryption applied to the file.
decryptionMetadataModelOptionalExpand Creates a copy of a file and applies any requested updates with patch semantics For more information, see Create and manage files (https: developers google com workspace drive api guides create-file) — response body — client Encryption Details decryption Metadata
The metadata used for client-side operations.
encryptionStatestringOptionalThe encryption state of the file. The values expected here are: - encrypted - unencrypted

Referenced models: Creates a copy of a file and applies any requested updates with patch semantics For more information, see Create and manage files (https: developers google com workspace drive api guides create-file) — response body — client Encryption Details decryption Metadata

Creates a copy of a file and applies any requested updates with patch semantics For more information, see Create and manage files (https: developers google com workspace drive api guides create-file) — response body — content Restrictions item
FieldTypePresenceDescription and constraints
$objectRootA restriction for accessing the content of the file.
ownerRestrictedbooleanOptionalWhether the content restriction can only be modified or removed by a user who owns the file. For files in shared drives, any user with `organizer` capabilities can modify or remove this content restriction.
readOnlybooleanOptionalWhether 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.
reasonstringOptionalReason for why the content of the file is restricted. This is only mutable on requests that also set `readOnly=true`.
restrictingUserModelOptionalExpand Gets information about the user, the user's Drive, and system capabilities. For more information, see [Return user info](https://developers.google.com/workspace/drive/api/guides/user-info). Required: The `fields` parameter must be set To return the exact fields you need, see Return specific fields (https: developers google com workspace drive api guides fields-parameter) — response body — user
Output only. The user who set the content restriction. Only populated if `readOnly=true`.
restrictionTimestringOptionalThe time at which the content restriction was set (formatted RFC 3339 timestamp). Only populated if readOnly is true.
Format: date-time
systemRestrictedbooleanOptionalOutput only. Whether the content restriction was applied by the system, for example due to an esignature. Users cannot modify or remove system restricted content restrictions.
typestringOptionalOutput only. The type of the content restriction. Currently the only possible value is `globalContentRestriction`.

Referenced models: Gets information about the user, the user's Drive, and system capabilities. For more information, see [Return user info](https://developers.google.com/workspace/drive/api/guides/user-info). Required: The `fields` parameter must be set To return the exact fields you need, see Return specific fields (https: developers google com workspace drive api guides fields-parameter) — response body — user

Creates a copy of a file and applies any requested updates with patch semantics For more information, see Create and manage files (https: developers google com workspace drive api guides create-file) — response body — download Restrictions
FieldTypePresenceDescription and constraints
$objectRootDownload restrictions applied to the file.
effectiveDownloadRestrictionWithContextModelOptionalExpand Deprecated: Use `drives get` instead — response body — restrictions download Restriction
Output only. The effective download restriction applied to this file. This considers all restriction settings and DLP rules.
itemDownloadRestrictionModelOptionalExpand Deprecated: Use `drives get` instead — response body — restrictions download Restriction
The download restriction of the file applied directly by the owner or organizer. This doesn't take into account shared drive settings or DLP rules.

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

Lists the labels on a file For more information, see List labels on a file (https: developers google com workspace drive api guides list-labels) — response body — labels item
FieldTypePresenceDescription and constraints
$objectRootRepresentation of label and label fields.
fieldsobjectOptionalA map of the fields on the label, keyed by the field's ID.
Additional keys: see wildcard field
fields.*ModelAdditional keysExpand Lists the labels on a file For more information, see List labels on a file (https: developers google com workspace drive api guides list-labels) — response body — labels item fields value
idstringOptionalThe ID of the label.
kindstringOptionalThis is always drive#label
revisionIdstringOptionalThe revision ID of the label.

Referenced models: Lists the labels on a file For more information, see List labels on a file (https: developers google com workspace drive api guides list-labels) — response body — labels item fields value

Gets information about the user, the user's Drive, and system capabilities. For more information, see [Return user info](https://developers.google.com/workspace/drive/api/guides/user-info). Required: The `fields` parameter must be set To return the exact fields you need, see Return specific fields (https: developers google com workspace drive api guides fields-parameter) — response body — user
FieldTypePresenceDescription and constraints
$objectRootInformation about a Drive user.
displayNamestringOptionalOutput only. A plain text displayable name for this user.
Read only: true
emailAddressstringOptionalOutput only. 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.
Read only: true
kindstringOptionalOutput only. Identifies what kind of resource this is. Value: the fixed string `drive#user`.
Default: drive#user
Read only: true
mebooleanOptionalOutput only. Whether this user is the requesting user.
Read only: true
permissionIdstringOptionalOutput only. The user's ID as visible in Permission resources.
Read only: true
photoLinkstringOptionalOutput only. A link to the user's profile photo, if available.
Read only: true
Creates a copy of a file and applies any requested updates with patch semantics For more information, see Create and manage files (https: developers google com workspace drive api guides create-file) — response body — content Hints
FieldTypePresenceDescription and constraints
$objectRootAdditional information about the content of the file. These fields are never populated in responses.
indexableTextstringOptionalText to be indexed for the file to improve fullText queries. This is limited to 128 KB in length and may contain HTML elements.
thumbnailobjectOptionalA thumbnail for the file. This will only be used if Google Drive cannot generate a standard thumbnail.
thumbnail.imagestringOptionalThe thumbnail data encoded with URL-safe Base64 ([RFC 4648 section 5](https://datatracker.ietf.org/doc/html/rfc4648#section-5)).
Format: byte
thumbnail.mimeTypestringOptionalThe MIME type of the thumbnail.
Creates a copy of a file and applies any requested updates with patch semantics For more information, see Create and manage files (https: developers google com workspace drive api guides create-file) — response body — shortcut Details
FieldTypePresenceDescription and constraints
$objectRootInformation about a shortcut file.
targetIdstringOptionalThe ID of the file that this shortcut points to. Can only be set on `files.create` requests.
targetMimeTypestringOptionalOutput only. 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.
targetResourceKeystringOptionalOutput only. The `resourceKey` for the target file.

SDK function policy ID: google.drive_files_get. Catalog operation: drive.files.get. 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", "https://www.googleapis.com/auth/drive.appdata", "https://www.googleapis.com/auth/drive.file", "https://www.googleapis.com/auth/drive.meet.readonly", "https://www.googleapis.com/auth/drive.metadata", "https://www.googleapis.com/auth/drive.metadata.readonly", "https://www.googleapis.com/auth/drive.photos.readonly", "https://www.googleapis.com/auth/drive.readonly"]

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.