リソース: File
ファイルのメタデータ。
一部のリソース メソッド(files.update
など)には fileId
が必要です。files.list
メソッドを使用して、ファイルの ID を取得します。
JSON 表現 |
---|
{ "kind": string, "userPermission": { object ( |
フィールド | |
---|---|
kind |
出力のみ。ファイルの種類。これは常に |
userPermission |
出力のみ。このファイルに対する認証済みユーザーの権限。 |
fileExtension |
出力のみ。削除された拡張機能の一部ではないと思われる末尾のテキストを含む |
md5Checksum |
出力のみ。このファイルの内容の MD5 チェックサム。この項目にデータが表示されるのは、Google ドライブに保存されているコンテンツを含むファイルのみです。ドキュメント エディタやショートカット ファイルについては入力されません。 |
selfLink |
出力のみ。このファイルへのリンク。 |
ownerNames[] |
出力のみ。このファイルのオーナーの名前。共有ドライブ内のアイテムのデータは入力されません。 |
lastModifyingUserName |
出力のみ。このファイルを変更する最後のユーザーの名前。 |
editable |
出力のみ。非推奨: 代わりに |
writersCanShare |
ライターが他のユーザーとドキュメントを共有できるかどうかを指定します。共有ドライブ内のアイテムのデータは入力されません。 |
downloadUrl |
出力のみ。有効期間が短いファイルのダウンロード URL。この項目にデータが表示されるのは、Google ドライブに保存されているコンテンツを含むファイルのみです。Google ドキュメントやショートカット ファイルについては入力されません。 |
mimeType |
ファイルの MIME タイプ。これは、新しいコンテンツをアップロードするときのみ更新時に変更できます。このフィールドは空白のままにできます。mimetype はアップロードされたコンテンツの MIME タイプから判断されます。 |
exportLinks |
出力のみ。ドキュメント エディタ ファイルを特定の形式にエクスポートするためのリンク。
|
driveId |
出力のみ。ファイルが存在する共有ドライブの ID。共有ドライブ内のアイテムに対してのみデータが入力されます。 |
parents[] |
このファイルを含む親フォルダのコレクション。 挿入リクエストの一部として指定されていない場合、ファイルはユーザーのマイドライブ フォルダに直接配置されます。コピー リクエストの一部として指定されていない場合、ファイルはソースファイルの検出可能な親をすべて継承します。files.update リクエストでは、 |
thumbnailLink |
出力のみ。ファイルのサムネイルへの有効期間の短いリンク(利用可能な場合)。通常、数時間ほどで終了します。リクエスト元のアプリがファイルのコンテンツにアクセスできる場合にのみ入力されます。ファイルが一般公開で共有されていない場合は、認証リクエストを使用して |
appDataContents |
出力のみ。このファイルがアプリケーション データ フォルダにあるかどうか。 |
webViewLink |
出力のみ。Google ドライブのウェブサイト ホスティングを介して静的ウェブアセット(HTML、CSS、JS など)を表示するために、パブリック フォルダでのみ利用可能なリンク。 |
iconLink |
出力のみ。ファイルのアイコンへのリンク。 |
shared |
出力のみ。ファイルが共有されているかどうか。共有ドライブ内のアイテムのデータは入力されません。 |
lastModifyingUser |
出力のみ。このファイルを変更する最後のユーザー。 |
owners[] |
出力のみ。このファイルのオーナー。複数のオーナーを指定できるのは、一部の以前のファイルのみです。共有ドライブ内のアイテムについては入力されません。 |
openWithLinks |
出力のみ。各ユーザーのアプリの ID の、そのアプリでこのファイルを開くためのリンク。drive.apps.readonly スコープが使用されている場合にのみ入力されます。
|
defaultOpenWithLink |
出力のみ。このファイルに対するユーザーのデフォルト アプリでこのファイルを開くリンク。drive.apps.readonly スコープが使用されている場合にのみ入力されます。 |
headRevisionId |
出力のみ。ファイルのヘッド リビジョンの ID。この項目にデータが表示されるのは、Google ドライブに保存されているコンテンツを含むファイルのみです。ドキュメント エディタやショートカット ファイルについては入力されません。 |
properties[] |
プロパティのリスト。 |
copyable |
出力のみ。非推奨: 代わりに |
etag |
出力のみ。ファイルの ETag。 |
sharingUser |
出力のみ。現在のユーザーとアイテムを共有したユーザー(ある場合)。 |
alternateLink |
出力のみ。該当する Google エディタやビューアでファイルを開くためのリンク。 |
embedLink |
出力のみ。ファイルを埋め込むためのリンク。 |
webContentLink |
出力のみ。Cookie ベースの認証を使用してブラウザにファイルの内容をダウンロードするためのリンク。コンテンツが一般公開されている場合は、認証情報なしでコンテンツをダウンロードすることが可能です。 |
fileSize |
出力のみ。blob と自社のエディタ ファイルのサイズ(バイト単位)。サイズのないファイル(ショートカットやフォルダなど)には入力されません。 |
copyRequiresWriterPermission |
閲覧者と閲覧者(コメント可)に対して、このファイルをコピー、印刷、ダウンロードするオプションを無効にする必要があります。 |
permissions[] |
出力のみ。このファイルにアクセスできるユーザーの権限のリスト。共有ドライブ内のアイテムのデータは入力されません。 |
hasThumbnail |
出力のみ。このファイルにサムネイルがあるかどうか。これは、リクエスト元のアプリがサムネイルにアクセスできるかどうかを示すものではありません。アクセス権を確認するには、サムネイルリンク フィールドが存在するかどうかを確認します。 |
spaces[] |
出力のみ。ファイルが含まれているスペースのリスト。サポートされる値は |
folderColorRgb |
ファイルがフォルダまたはフォルダへのショートカットである場合のフォルダの色(RGB の 16 進文字列)。サポートされている色のリストは、About リソースの folderColorPalette フィールドで確認できます。サポートされていない色を指定すると、パレット内の最も近い色に変更されます。 |
id |
ファイルの ID。 |
title |
このファイルのタイトル。共有ドライブの最上位フォルダ、マイドライブのルートフォルダ、アプリケーション データ フォルダなど、変更できないアイテムのタイトルは一定であることにご注意ください。 |
description |
ファイルの簡単な説明。 |
labels |
ファイルのラベルのグループ。 |
labels.viewed |
このユーザーがこのファイルを閲覧したかどうか。 |
labels.restricted |
出力のみ。非推奨: 代わりに |
labels.starred |
このファイルにユーザーがスターを付けるかどうか。 |
labels.hidden |
出力のみ。廃止されました。 |
labels.trashed |
このファイルがゴミ箱に移動されたかどうか。このラベルは、ファイルにアクセスするすべてのユーザーに適用されます。ただし、ファイルを閲覧したりゴミ箱から出したりできるのはオーナーのみです。 |
labels.modified |
出力のみ。このユーザーによってファイルが変更されたかどうか。 |
explicitlyTrashed |
出力のみ。ファイルが再帰的にゴミ箱に移動するのではなく、明示的にゴミ箱に移動したかどうかを示します。 |
createdDate |
出力のみ。このファイルの作成時間(RFC 3339 タイムスタンプ形式)。 |
modifiedDate |
ファイルが最後に変更された日時(RFC 3339 タイムスタンプ形式)。これは、setModifiedDate パラメータが設定されている場合のみ変更可能です。 |
modifiedByMeDate |
出力のみ。このファイルがユーザーによって最後に変更された日時(RFC 3339 タイムスタンプ形式)。なお、ModifiedDate を設定すると、日付を設定したユーザーの ModifiedByMe 日付も更新されます。 |
lastViewedByMeDate |
ユーザーがこのファイルを最後に表示した日時(RFC 3339 タイムスタンプ形式)。 |
markedViewedByMeDate |
出力のみ。廃止されました。 |
sharedWithMeDate |
出力のみ。このファイルがユーザーと共有された時刻(RFC 3339 タイムスタンプ形式)。 |
quotaBytesUsed |
出力のみ。このファイルで使用される割り当てバイト数。 |
version |
出力のみ。単調に増加するファイルのバージョン番号。これにより、サーバー上のファイルに加えられたすべての変更が反映されます。これには、リクエストしているユーザーに表示されない変更も含まれます。 |
indexableText |
ファイルのインデックス登録可能なテキスト属性(書き込みのみ可能) |
indexableText.text |
このファイルのインデックスに登録するテキスト。 |
originalFilename |
アップロードされたコンテンツの元のファイル名(存在する場合)。それ以外の場合は、 |
ownedByMe |
出力のみ。現在のユーザーがファイルを所有しているかどうか。共有ドライブ内のアイテムのデータは入力されません。 |
canComment |
出力のみ。非推奨: 代わりに |
shareable |
出力のみ。非推奨: 代わりに |
fullFileExtension |
出力のみ。タイトルから抽出された完全なファイル拡張子。「tar.gz」のように、連結された複数の拡張子を含めることができます。タイトルから拡張子を削除しても、このフィールドはクリアされません。ただし、タイトルの拡張子を変更すると、このフィールドが更新されます。この項目にデータが表示されるのは、Google ドライブに保存されているコンテンツを含むファイルのみです。ドキュメント エディタやショートカット ファイルについては入力されません。 |
isAppAuthorized |
出力のみ。リクエスト元のアプリによってファイルが作成または開かれたかどうか。 |
teamDriveId |
出力のみ。非推奨: 代わりに |
capabilities |
出力のみ。現在のユーザーがこのファイルに対して持っている機能。各機能は、ユーザーが実行できる詳細なアクションに対応しています。 |
capabilities.canChangeRestrictedDownload |
出力のみ。廃止されました。 |
capabilities.canMoveChildrenOutOfDrive |
出力のみ。現在のユーザーがこのフォルダの子を共有ドライブの外に移動できるかどうか。アイテムがフォルダでない場合は false です。共有ドライブ内のアイテムに対してのみデータが入力されます。 |
capabilities.canReadDrive |
出力のみ。現在のユーザーがこのファイルが属する共有ドライブの読み取りを許可するかどうか。共有ドライブ内のアイテムに対してのみデータが入力されます。 |
capabilities.canEdit |
出力のみ。現在のユーザーがこのファイルを編集できるかどうか。その他の要因によって、ユーザーがファイルに対して行える変更の種類が制限される場合があります。たとえば、 |
capabilities.canCopy |
出力のみ。現在のユーザーがこのファイルをコピーできるかどうか。共有ドライブ内のアイテムについて、現在のユーザーがこのアイテムのフォルダ以外の子孫をコピーできるかどうか。フォルダでない場合はこのアイテム自体をコピーできるかどうか。 |
capabilities.canComment |
出力のみ。現在のユーザーがこのファイルにコメントできるかどうか。 |
capabilities.canAddChildren |
出力のみ。現在のユーザーがこのフォルダに子供を追加できるかどうか。アイテムがフォルダでない場合は、常に false になります。 |
capabilities.canDelete |
出力のみ。現在のユーザーがこのファイルを削除できるかどうか。 |
capabilities.canDownload |
出力のみ。現在のユーザーがこのファイルをダウンロードできるかどうかを指定します。 |
capabilities.canListChildren |
出力のみ。現在のユーザーがこのフォルダの子を一覧表示できるかどうか。アイテムがフォルダでない場合は、常に false になります。 |
capabilities.canRemoveChildren |
出力のみ。現在のユーザーがこのフォルダから子を削除できるかどうか。アイテムがフォルダでない場合は、常に false になります。共有ドライブ内のフォルダの場合は、代わりに |
capabilities.canRename |
出力のみ。現在のユーザーがこのファイルの名前を変更できるかどうか。 |
capabilities.canTrash |
出力のみ。現在のユーザーがこのファイルをゴミ箱に移動できるかどうか。 |
capabilities.canReadRevisions |
出力のみ。現在のユーザーがこのファイルのリビジョン リソースを読み取ることができるかどうかを指定します。共有ドライブのアイテムについては、このアイテムのフォルダ以外の子孫のリビジョンや、フォルダでない場合はこのアイテム自体のリビジョンを読み取ることができます。 |
capabilities.canReadTeamDrive |
出力のみ。非推奨: 代わりに |
capabilities.canMoveTeamDriveItem |
出力のみ。非推奨: 代わりに |
capabilities.canChangeCopyRequiresWriterPermission |
出力のみ。現在のユーザーがこのファイルの |
capabilities.canMoveItemIntoTeamDrive |
出力のみ。非推奨: 代わりに |
capabilities.canUntrash |
出力のみ。現在のユーザーがこのファイルをゴミ箱から復元できるかどうか。 |
capabilities.canModifyContent |
出力のみ。現在のユーザーがこのファイルの内容を変更できるかどうか。 |
capabilities.canMoveItemWithinTeamDrive |
出力のみ。非推奨: 代わりに |
capabilities.canMoveItemOutOfTeamDrive |
出力のみ。非推奨: 代わりに |
capabilities.canDeleteChildren |
出力のみ。現在のユーザーがこのフォルダの子を削除できるかどうか。アイテムがフォルダでない場合は false です。共有ドライブ内のアイテムに対してのみデータが入力されます。 |
capabilities.canMoveChildrenOutOfTeamDrive |
出力のみ。非推奨: 代わりに |
capabilities.canMoveChildrenWithinTeamDrive |
出力のみ。非推奨: 代わりに |
capabilities.canTrashChildren |
出力のみ。現在のユーザーがこのフォルダの子をゴミ箱に移動できるかどうか。アイテムがフォルダでない場合は false です。共有ドライブ内のアイテムに対してのみデータが入力されます。 |
capabilities.canMoveItemOutOfDrive |
出力のみ。現在のユーザーが親を変更して、このアイテムをこのドライブの外に移動できるかどうか。なお、新たに追加する親によっては、アイテムの親を変更するリクエストが失敗することがあります。 |
capabilities.canAddMyDriveParent |
出力のみ。現在のユーザーが、同じリクエストで既存の親を削除せずにアイテムの親を追加できるかどうか。共有ドライブ ファイルの場合は入力されません。 |
capabilities.canRemoveMyDriveParent |
出力のみ。現在のユーザーが、同じリクエストに別の親を追加せずにアイテムから親を削除できるかどうか。共有ドライブ ファイルの場合は入力されません。 |
capabilities.canMoveItemWithinDrive |
出力のみ。現在のユーザーがこのドライブ内でこのアイテムを移動できるかどうか。追加する新しい親と削除する親によっては、アイテムの親を変更するリクエストが失敗することがあります。 |
capabilities.canShare |
出力のみ。現在のユーザーがこのファイルの共有設定を変更できるかどうかを指定します。 |
capabilities.canMoveChildrenWithinDrive |
出力のみ。現在のユーザーがこのドライブ内でこのフォルダの子を移動できるかどうか。アイテムがフォルダでない場合は false です。子フォルダと移動先フォルダに対する現在のユーザーのアクセス権によっては、子の移動リクエストが失敗することもあります。 |
capabilities.canModifyContentRestriction |
非推奨: 出力のみ。 |
capabilities.canAddFolderFromAnotherDrive |
出力のみ。現在のユーザーが別のドライブ(別の共有ドライブまたはマイドライブ)のフォルダをこのフォルダに追加できるかどうか。アイテムがフォルダでない場合は false です。共有ドライブ内のアイテムに対してのみデータが入力されます。 |
capabilities.canChangeSecurityUpdateEnabled |
出力のみ。現在のユーザーがリンク共有メタデータの securityUpdateEnabled フィールドを変更できるかどうか。 |
capabilities.canAcceptOwnership |
出力のみ。現在のユーザーがファイルの保留中のオーナーかどうか。共有ドライブ ファイルの場合は入力されません。 |
capabilities.canReadLabels |
出力のみ。現在のユーザーがファイルのラベルを読み取ることができるかどうかを指定します。 |
capabilities.canModifyLabels |
出力のみ。現在のユーザーがファイルのラベルを変更できるかどうか。 |
capabilities.canModifyEditorContentRestriction |
出力のみ。編集者による制限のあるファイルに対して、現在のユーザーがコンテンツの制限を追加または変更できるかどうかを指定します。 |
capabilities.canModifyOwnerContentRestriction |
出力のみ。現在のユーザーが、所有者による制限をかけたコンテンツの制限を追加または変更できるかどうか。 |
capabilities.canRemoveContentRestriction |
出力のみ。現在のユーザーが削除できるファイルにコンテンツ制限があるかどうか。 |
hasAugmentedPermissions |
出力のみ。このファイルに直接権限があるかどうか。このフィールドにデータが入力されるのは共有ドライブ内のアイテムのみです。 |
trashingUser |
出力のみ。ファイルが明示的にゴミ箱に移動している場合、そのファイルをゴミ箱に移動したユーザー。共有ドライブ内のアイテムに対してのみデータが入力されます。 |
canReadRevisions |
出力のみ。非推奨: 代わりに |
thumbnailVersion |
出力のみ。サムネイル キャッシュの無効化で使用するサムネイルのバージョン。 |
trashedDate |
出力のみ。アイテムがゴミ箱に移動した時刻(RFC 3339 タイムスタンプ形式)。共有ドライブ内のアイテムに対してのみデータが入力されます。 |
permissionIds[] |
出力のみ。このファイルへのアクセス権を持つユーザーの権限 ID のリスト。 |
thumbnail |
ファイルのサムネイル。これは標準サムネイルを生成できない場合にのみ使用されます。 |
thumbnail.image |
サムネイル画像を URL 用 Base64 でエンコードしたバイト。RFC 4648 セクション 5 に準拠する必要があります。 Base64 でエンコードされた文字列。 |
thumbnail.mimeType |
サムネイルの MIME タイプ。 |
imageMediaMetadata |
出力のみ。画像メディアに関するメタデータ。これは画像タイプの場合にのみ存在し、そのコンテンツは画像コンテンツから解析できる内容によって異なります。 |
imageMediaMetadata.flashUsed |
出力のみ。写真の作成にフラッシュを使用したかどうかを示します。 |
imageMediaMetadata.meteringMode |
出力のみ。写真の作成に使用される測光モード。 |
imageMediaMetadata.sensor |
出力のみ。写真の作成に使用されるセンサーの種類。 |
imageMediaMetadata.exposureMode |
出力のみ。写真の作成に使用される露出モード。 |
imageMediaMetadata.colorSpace |
出力のみ。写真の色空間。 |
imageMediaMetadata.whiteBalance |
出力のみ。写真の作成に使用されるホワイト バランス モード。 |
imageMediaMetadata.width |
出力のみ。画像の幅(ピクセル単位)。 |
imageMediaMetadata.height |
出力のみ。画像の高さ(ピクセル単位)。 |
imageMediaMetadata.location |
出力のみ。画像に保存されている地理的位置情報。 |
imageMediaMetadata.location.latitude |
出力のみ。画像に保存されている緯度。 |
imageMediaMetadata.location.longitude |
出力のみ。画像に保存されている経度。 |
imageMediaMetadata.location.altitude |
出力のみ。画像に格納されている標高。 |
imageMediaMetadata.rotation |
出力のみ。画像の元の向きから時計回りに 90 度回転する回数。 |
imageMediaMetadata.date |
出力のみ。写真の撮影日時(EXIF 形式のタイムスタンプ)。 |
imageMediaMetadata.cameraMake |
出力のみ。写真の作成に使用されたカメラのメーカー。 |
imageMediaMetadata.cameraModel |
出力のみ。写真の作成に使用されたカメラのモデル。 |
imageMediaMetadata.exposureTime |
出力のみ。露出時間(秒単位)。 |
imageMediaMetadata.aperture |
出力のみ。写真の作成に使用する絞り(F 値)。 |
imageMediaMetadata.focalLength |
出力のみ。写真の作成に使用されたレンズ焦点距離(ミリメートル)。 |
imageMediaMetadata.isoSpeed |
出力のみ。写真の作成に使用される ISO 感度。 |
imageMediaMetadata.exposureBias |
出力のみ。写真の露出バイアス(APEX 値)。 |
imageMediaMetadata.maxApertureValue |
出力のみ。写真の作成に使用される焦点距離におけるレンズの最小 f 番号(APEX 値)。 |
imageMediaMetadata.subjectDistance |
出力のみ。写真の被写体までの距離(メートル単位)。 |
imageMediaMetadata.lens |
出力のみ。写真の作成に使用されたレンズ。 |
videoMediaMetadata |
出力のみ。動画メディアに関するメタデータ。動画タイプの場合のみ表示されます。 |
videoMediaMetadata.width |
出力のみ。ピクセル単位の動画の幅です。 |
videoMediaMetadata.height |
出力のみ。ピクセル単位の動画の高さです。 |
videoMediaMetadata.durationMillis |
出力のみ。動画の再生時間(ミリ秒単位)。 |
shortcutDetails |
ショートカット ファイルの詳細。mimeType フィールドが |
shortcutDetails.targetId |
このショートカットが指すファイルの ID。 |
shortcutDetails.targetMimeType |
出力のみ。このショートカットが指すファイルの MIME タイプ。このフィールドの値は、ショートカットの作成時に取得されるターゲットの MIME タイプのスナップショットです。 |
shortcutDetails.targetResourceKey |
出力のみ。ターゲット ファイルの ResourceKey。 |
contentRestrictions[] |
ファイルのコンテンツへのアクセスに関する制限。そのような制限が存在する場合のみ入力されます。 |
resourceKey |
出力のみ。共有リンク経由でアイテムにアクセスするために必要なキー。 |
linkShareMetadata |
出力のみ。LinkShare 関連の詳細。クライアントがこのアイテムを参照するために使用しているリンク URL の詳細が含まれます。 |
linkShareMetadata.securityUpdateEligible |
出力のみ。ファイルがセキュリティ アップデートの対象かどうかを指定します。 |
linkShareMetadata.securityUpdateEnabled |
出力のみ。このファイルに対するセキュリティ アップデートが有効かどうか。 |
labelInfo |
出力のみ。ファイルのラベルの概要。 |
labelInfo.labels[] |
出力のみ。 |
sha1Checksum |
出力のみ。このファイルに関連付けられている SHA1 チェックサム(利用可能な場合)。この項目にデータが表示されるのは、Google ドライブに保存されているコンテンツを含むファイルのみです。ドキュメント エディタやショートカット ファイルについては入力されません。 |
sha256Checksum |
出力のみ。このファイルに関連付けられている SHA256 チェックサム(利用可能な場合)。この項目にデータが表示されるのは、Google ドライブに保存されているコンテンツを含むファイルのみです。ドキュメント エディタやショートカット ファイルについては入力されません。 |
ContentRestriction
ファイルの内容にアクセスするための制限。
JSON 表現 |
---|
{
"readOnly": boolean,
"reason": string,
"type": string,
"restrictingUser": {
object ( |
フィールド | |
---|---|
readOnly |
ファイルのコンテンツが読み取り専用かどうか。ファイルが読み取り専用の場合、ファイルの新しいリビジョンが追加されたり、コメントが追加または変更されたり、ファイルのタイトルが変更されたりすることがあります。 |
reason |
ファイルのコンテンツが制限されている理由。これは、 |
type |
出力のみ。コンテンツの制限のタイプ。現在、指定可能な値は |
restrictingUser |
出力のみ。コンテンツの制限を設定したユーザー。 |
restrictionDate |
出力のみ。コンテンツの制限が設定された時刻(RFC 3339 タイムスタンプ形式)。 |
ownerRestricted |
コンテンツの制限の変更や削除を、そのファイルを所有するユーザーだけが行うことができるかどうかを指定します。共有ドライブ内のファイルについては、 |
systemRestricted |
出力のみ。電子署名などにより、コンテンツの制限がシステムによって適用されたかどうかを示します。ユーザーは、システム制限されているコンテンツの制限を変更したり削除したりすることはできません。 |
Methods |
|
---|---|
|
指定されたファイルのコピーを作成します。 |
|
ユーザーが所有するファイルをゴミ箱に移動せずに完全に削除します。 |
|
ユーザーのゴミ箱にあるすべてのファイルを完全に削除します。 |
|
Google Workspace ドキュメントをリクエストされた MIME タイプにエクスポートし、エクスポートされたバイト コンテンツを返します。 |
|
挿入リクエストまたはコピー リクエストで指定可能なファイル ID のセットを生成します。 |
|
ID により、ファイルのメタデータまたはコンテンツを取得します。 |
|
新しいファイルを挿入します。 |
|
ユーザーのファイルを一覧表示します。 |
|
ファイルのラベルを一覧表示します。 |
|
ファイルに適用されているラベルのセットを変更します。 |
|
ファイルのメタデータやコンテンツを更新します。 |
|
ファイルの更新時刻を現在のサーバー時刻に設定します。 |
|
ファイルをゴミ箱に移動します。 |
|
ゴミ箱からファイルを復元します。 |
|
ファイルのメタデータやコンテンツを更新します。 |
|
ファイルの変更に対してサブスクライブします。 |