EndPoint Update metadata in a file

Contents

1 Label
2 Description
3 Parameters
4 Output Columns
5 Input Columns

Name

update_metadata_file

Description

Updates meta-data in a file [API Help]

Parameters

Parameter

Label

Required

Options

Description

File Id

YES

Id of a file you want to update meta-data to

keepRevisionForever

Keep Revision Forever

Option	Value
True	True
False	False

Defines whether uploaded file has revisions

addParents

AddParents

A comma-separated list of parent IDs to add

ocrLanguage

OcrLanguage

A language hint for OCR processing during image import (ISO 639-1 code).

useContentAsIndexableText

UseContentAsIndexableText

Whether to use the uploaded content as indexable text.

DriveId

Shared DriveId

By default file lists from MyDrive but if you like to search other Shared drive (formally known as Team drive) then set this parameter.

DriveType

Drive Type

YES

Option	Value
My Drive	user
Shared Drive	drive

Default search context is User's drive. Bodies of items (files/documents) to which the query applies. Supported bodies are 'user', 'domain', 'drive', and 'allDrives'. Prefer 'user' or 'drive' to 'allDrives' for efficiency. By default, corpora is set to 'user'. However, this can change depending on the filter set through the 'Query' parameter.

SupportsAllDrives

Supports all drives (e.g. My and Shared)

Option	Value
true	true
false	false

Whether the requesting application supports both My Drives and shared drives.

Output Columns

Label	DataType	Length	Raw
Id	DT_WSTR	440	False
Kind	DT_WSTR	200	False
Name	DT_WSTR	780	False
MimeType	DT_WSTR	650	False
DriveId	DT_WSTR	4000	False

Input Columns

Label	DataType	Length	Raw	Description
AppProperties	DT_WSTR	2000	True	A collection of arbitrary key-value pairs which are private to the requesting app. Entries 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.
ContentHintsIndexableText	DT_WSTR	2000	False	Text to be indexed for the file to improve fullText queries. This is limited to 128KB in length and may contain HTML elements.
ThumbnailImage	DT_WSTR	4000	False	The thumbnail data encoded with URL-safe Base64 (RFC 4648 section 5).
ThumbnailMimeType	DT_WSTR	4000	False	The MIME type of the thumbnail
ContentRestrictionsReadOnly	DT_WSTR	4000	True	Format: 'contentRestrictions[].readOnly'. 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.
ContentRestrictionsReason	DT_WSTR	4000	True	Format: 'contentRestrictions[].reason'. Reason for why the content of the file is restricted. This is only mutable on requests that also set readOnly=true.
CopyRequiresWriterPermission	DT_BOOL	0	False	Whether the options to copy, print, or download this file, should be disabled for readers and commenters
Description	DT_WSTR	4000	False	A short description of the file.
FolderColorRgb	DT_WSTR	2000	False	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. If an unsupported color is specified, the closest color in the palette will be used instead.
MimeType	DT_WSTR	2000	False	The MIME type of the file. Google 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. If 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.
ModifiedTime	DT_DBTIMESTAMP	0	False	Format: 2019-10-12T07:20:50.52Z. The last time the file was modified by anyone (RFC 3339 date-time). Note that setting modifiedTime will also update modifiedByMeTime for the user
Name	DT_WSTR	2000	False	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.
OriginalFilename	DT_WSTR	2000	False	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.
Properties	DT_WSTR	2000	True	Entry as JSON object. A collection of arbitrary key-value pairs which are visible to all apps. Entries with null values are cleared in update and copy requests.
Starred	DT_BOOL	0	False	Whether the user has starred the file.
Trashed	DT_BOOL	0	False	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.
ViewedByMeTime	DT_DBTIMESTAMP	2000	False	Format: 2019-10-12T07:20:50.52Z. The last time the file was viewed by the user (RFC 3339 date-time).
WritersCanShare	DT_BOOL	0	False	Whether users with only writer permission can modify the file's permissions. Not populated for items in shared drives.