Method: files.patch

ファイルのメタデータやコンテンツを更新します。このメソッドを呼び出す際は、変更したいリクエストのフィールドのみにデータを入力します。フィールドを更新する際、一部のフィールド(ModifiedDate など)は自動的に変更されることがあります。このメソッドは、パッチのセマンティクスをサポートしています。

HTTP リクエスト

PATCH https://www.googleapis.com/drive/v2/files/{fileId}

この URL は gRPC Transcoding 構文を使用します。

パスパラメータ

パラメータ
fileId

string

更新するファイルの ID。

クエリ パラメータ

パラメータ
addParents

string

追加する親 ID のカンマ区切りのリスト。

convert
(deprecated)

boolean

非推奨: このパラメータに関数はありません。

enforceSingleParent
(deprecated)

boolean

非推奨: 複数のフォルダにファイルを追加することはサポートされなくなりました。shortcuts を代わりに使用してください。

modifiedDateBehavior

enum (ModifiedDateBehavior)

modifiedDate を更新する動作を決定します。これは setModifiedDate をオーバーライドします。

newRevision

boolean

blob のアップロードで新しいリビジョンを作成するかどうか。false の場合、現在のヘッド リビジョンの blob データが置換されます。true または未設定の場合、新しい blob がヘッド リビジョンとして作成され、以前の固定されていないリビジョンが短期間保持されます。固定されたリビジョンは、追加の保存容量を使用して、最大 200 リビジョンまで無期限に保存されます。版の保持方法について詳しくは、ドライブのヘルプセンターをご覧ください。リクエストにペイロードがない場合、このフィールドは無視されます。

ocr

boolean

.jpg、.png、.gif、.pdf のいずれかのアップロードで OCR を使用するかどうかを指定します。

ocrLanguage

string

ocr が true の場合、使用する言語のヒントを示します。有効な値は BCP 47 コードです。

pinned

boolean

新しいリビジョンを固定するかどうか。1 つのファイルには最大 200 個のリビジョンを固定できます。リクエストにペイロードがない場合、このフィールドは無視されます。

removeParents

string

削除する親 ID のカンマ区切りのリスト。

setModifiedDate

boolean

リクエスト本文で指定された値を使用して更新日を設定するかどうかを指定します。このフィールドを true に設定すると modifiedDateBehavior=fromBodyOrNow と等価になり、falsemodifiedDateBehavior=now と等価になります。更新日が変更されないようにするには、modifiedDateBehavior=noChange を設定してください。

supportsAllDrives

boolean

リクエスト元のアプリケーションがマイドライブと共有ドライブの両方をサポートしているかどうかを指定します。

supportsTeamDrives
(deprecated)

boolean

非推奨: 代わりに supportsAllDrives を使用してください。

timedTextLanguage

string

読み上げるテキストの言語。

timedTextTrackName

string

再生タイミング指定テキスト トラックの名前。

updateViewedDate

boolean

ファイルが正常に更新された後に閲覧日を更新するかどうか。

useContentAsIndexableText

boolean

コンテンツをインデックス登録可能なテキストとして使用するかどうか。

includePermissionsForView

string

レスポンスに含める追加のビューの権限を指定します。published のみがサポートされています。

includeLabels

string

レスポンスの labelInfo 部分に含めるラベルの ID のカンマ区切りのリスト。

リクエスト本文

リクエストの本文には File のインスタンスが含まれています。

レスポンスの本文

成功した場合、レスポンスの本文には File のインスタンスが含まれます。

認可スコープ

次の OAuth スコープのいずれかが必要です。

  • https://www.googleapis.com/auth/docs
  • https://www.googleapis.com/auth/drive
  • https://www.googleapis.com/auth/drive.appdata
  • https://www.googleapis.com/auth/drive.apps.readonly
  • https://www.googleapis.com/auth/drive.file
  • https://www.googleapis.com/auth/drive.metadata
  • https://www.googleapis.com/auth/drive.scripts

一部のスコープは制限されているため、アプリで使用するにはセキュリティ評価が必要です。詳細については、承認ガイドをご覧ください。