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

新しいリビジョンを固定するかどうか。ファイルに固定できるリビジョンは 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

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