Method: files.patch

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

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 の場合、現在の head リビジョンの blob データは置き換えられます。true に設定するか未設定のままにした場合、新しい blob は head リビジョンとして作成され、以前の固定されていないリビジョンは短期間保持されます。固定されたリビジョンは、追加の保存容量を使用して無期限で保存されます(最大 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

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