リソース: ファイル
ファイルのメタデータ。
JSON 表現 |
---|
{ "kind": string, "driveId": string, "fileExtension": string, "copyRequiresWriterPermission": boolean, "md5Checksum": string, "contentHints": { "indexableText": string, "thumbnail": { "image": string, "mimeType": string } }, "writersCanShare": boolean, "viewedByMe": boolean, "mimeType": string, "exportLinks": { string: string, ... }, "parents": [ string ], "thumbnailLink": string, "iconLink": string, "shared": boolean, "lastModifyingUser": { object ( |
フィールド | |
---|---|
kind |
出力のみ。リソースの種類を示します。値: 固定文字列 |
driveId |
出力のみ。ファイルが存在する共有ドライブの ID。共有ドライブ内のアイテムに対してのみデータが入力されます。 |
fileExtension |
出力のみ。 |
copyRequiresWriterPermission |
このファイルのコピー、印刷、ダウンロードを行うためのオプションを、閲覧者と閲覧者(コメント可)に無効にする必要があります。 |
md5Checksum |
出力のみ。ファイルの内容の MD5 チェックサム。これは、Google ドライブのバイナリ コンテンツを含むファイルにのみ適用されます。 |
contentHints |
ファイルの内容に関する追加情報。これらのフィールドはレスポンスに入力されません。 |
contentHints.indexableText |
fullText クエリを改善するためにファイルのインデックス登録されるテキスト。長さは 128 KB に制限され、HTML 要素を含めることができます。 |
contentHints.thumbnail |
ファイルのサムネイル。Google ドライブで標準のサムネイルを生成できない場合のみ使用されます。 |
contentHints.thumbnail.image |
URL 用 Base64(RFC 4648 セクション 5)でエンコードされたサムネイル データ。 Base64 でエンコードされた文字列。 |
contentHints.thumbnail.mimeType |
サムネイルの MIME タイプ。 |
writersCanShare |
|
viewedByMe |
出力のみ。ユーザーがファイルを閲覧したかどうか。 |
mimeType |
ファイルの MIME タイプ。 Google ドライブでは、指定された値が指定されない場合、アップロードされたコンテンツから適切な値が自動的に検出されます。新しいリビジョンがアップロードされない限り、この値は変更できません。 ファイルが Google ドキュメントの MIME タイプで作成されている場合、アップロードしたコンテンツは可能な限りインポートされます。サポートされているインポート形式は [概要] リソースで公開されています。 |
exportLinks |
出力のみ。ドキュメント エディタ ファイルを特定の形式でエクスポートするためのリンク。
|
parents[] |
ファイルが格納されている親フォルダの ID。 作成リクエスト内で指定しなかった場合、ファイルはユーザーのマイドライブ フォルダに配置されます。コピー リクエストの一部として指定しなかった場合、ファイルはソースファイルの検出可能な親をすべて継承します。files.update リクエストでは、親リストを変更するには |
thumbnailLink |
出力のみ。ファイルのサムネイルへの有効期間の短いリンク(利用可能な場合)。通常は数時間程度続きます。リクエスト元のアプリがファイルのコンテンツにアクセスできる場合にのみ入力されます。ファイルが一般公開で共有されていない場合、 |
iconLink |
出力のみ。ファイルのアイコンへの静的な未認証リンク。 |
shared |
出力のみ。ファイルが共有されているかどうか。共有ドライブ内のアイテムについては入力されません。 |
lastModifyingUser |
出力のみ。ファイルを変更する最後のユーザー。 |
owners[] |
出力のみ。このファイルのオーナー。以前のオーナーのファイルのみ複数のオーナーになる場合があります。このフィールドは、共有ドライブ内のアイテムに対して入力されていません。 |
headRevisionId |
出力のみ。ファイルの head リビジョンの ID。現在のところ、Google ドライブでバイナリ コンテンツを使用しているファイルにのみ利用できます。 |
sharingUser |
出力のみ。リクエスト元のユーザーとファイルを共有したユーザー(該当する場合)。 |
webViewLink |
出力のみ。ブラウザで、関連する Google エディタまたはビューアでファイルを開くためのリンク。 |
webContentLink |
出力のみ。ブラウザでファイルの内容をダウンロードするためのリンク。この機能は Google ドライブでバイナリ コンテンツを使用しているファイルでのみ使用できます。 |
size |
出力のみ。blob と自社エディタ ファイルのサイズ(バイト単位)。ショートカットやフォルダなど、サイズの異なるファイルについては入力されません。 |
viewersCanCopyContent |
非推奨: 代わりに |
permissions[] |
出力のみ。ファイルに対する権限の完全なリスト。これは、リクエスト元のユーザーがファイルを共有できる場合のみ使用できます。共有ドライブ内のアイテムについては入力されません。 |
hasThumbnail |
出力のみ。ファイルにサムネイルがあるかどうか。これは、リクエスト元のアプリがサムネイルにアクセスできるかどうかを示します。アクセス権を確認するには、サムネイルリンク フィールドの有無を調べます。 |
spaces[] |
出力のみ。ファイルを含むスペースのリスト。現在サポートされている値は、「drive」、「appDataFolder」、「photos」です。 |
folderColorRgb |
フォルダの色またはフォルダへのショートカットを RGB タイプの 16 進文字列で指定します。サポートされている色は、About リソースの サポートされていない色が指定されている場合は、代わりにパレットで最も近い色が使用されます。 |
id |
ファイルの ID。 |
name |
ファイルの名前。これは必ずしもフォルダ内で一意ではありません。なお、不変アイテム(共有ドライブの最上位フォルダ、マイドライブのルートフォルダ、アプリケーション データ フォルダなど)については、名前は一定です。 |
description |
ファイルの簡単な説明。 |
starred |
ユーザーがファイルにスターを付けたかどうか |
trashed |
ファイルがゴミ箱にあるかどうか、またはゴミ箱の親フォルダにあるファイルファイルのオーナーのみがファイルをゴミ箱に移動でき、他のユーザーはオーナーのゴミ箱内のファイルを表示できません。 |
explicitlyTrashed |
出力のみ。ファイルが親フォルダから繰り返しゴミ箱に入っているのではなく、明示的にゴミ箱に移動したかどうか。 |
createdTime |
ファイルが作成された時刻(RFC 3339 の日時)。 |
modifiedTime |
ファイルが最後に変更された日時(RFC 3339 の日時)。
|
modifiedByMeTime |
出力のみ。ファイルが最後に変更された日時(RFC 3339 の日時)。 |
viewedByMeTime |
ユーザーがファイルを最後に表示した日時(RFC 3339 の日時)。 |
sharedWithMeTime |
出力のみ。ファイルがユーザーと共有された時刻(該当する場合、RFC 3339 の日時)。 |
quotaBytesUsed |
出力のみ。ファイルによって使用されるストレージ割り当てバイト数。これには、ヘッド リビジョンと、 |
version |
出力のみ。ファイルの単調増加するバージョン番号。この変更は、ユーザーのファイルに加えられた変更をすべて反映するもので、ユーザーに表示されないものも含まれます。 |
originalFilename |
アップロードされたコンテンツの元のファイル名(存在する場合)、または |
ownedByMe |
出力のみ。ユーザーがファイルのオーナーであるかどうか。共有ドライブ内のアイテムについては入力されません。 |
fullFileExtension |
出力のみ。 これは |
properties |
すべてのアプリに表示される任意の Key-Value ペアのコレクションです。 null 値のエントリは、更新リクエストとコピー リクエストでクリアされます。
|
appProperties |
リクエスト元アプリに非公開となる任意の Key-Value ペアのコレクション。 null 値のエントリは、更新リクエストとコピー リクエストでクリアされます。 これらのプロパティは、認証済みのリクエストを使用してのみ取得できます。認証済みのリクエストでは、OAuth 2 クライアント ID で取得したアクセス トークンを使用します。API キーを使用して非公開プロパティを取得することはできません。
|
isAppAuthorized |
出力のみ。リクエスト元のアプリによってファイルが作成または開かれたかどうか。 |
teamDriveId |
非推奨: 出力のみ。 |
capabilities |
出力のみ。現在のユーザーがこのファイルに対して持っている機能。それぞれの能力は、ユーザーが行うことができる操作に対応しています。 |
capabilities.canChangeViewersCanCopyContent |
非推奨: 出力のみ。 |
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 |
出力のみ。現在のユーザーがファイルのラベルを変更できるかどうか。 |
hasAugmentedPermissions |
出力のみ。このファイルに直接権限があるかどうか。この項目は共有ドライブ内のアイテムに対してのみ入力されます。 |
trashingUser |
出力のみ。ファイルを明示的にゴミ箱に移動した場合は、そのファイルをゴミ箱に移動したユーザー。共有ドライブ内のアイテムに対してのみデータが入力されます。 |
thumbnailVersion |
出力のみ。サムネイル キャッシュの無効化に使用するサムネイル バージョン。 |
trashedTime |
出力のみ。アイテムをゴミ箱に移動した日時(RFC 3339 の日時)。共有ドライブ内のアイテムに対してのみデータが入力されます。 |
modifiedByMe |
出力のみ。ユーザーがファイルを変更したかどうか。 |
permissionIds[] |
出力のみ。このファイルへのアクセス権を持つユーザーの権限 ID の files.list |
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.time |
出力のみ。写真が撮影された日時(EXIF DateTime)。 |
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 ドライブに保存されているコンテンツが含まれているファイルに対してのみ入力されます。ドキュメント エディタやショートカット ファイルでは入力されません。 |
コンテンツの制限
ファイルのコンテンツへのアクセスに関する制限。
JSON 表現 |
---|
{
"readOnly": boolean,
"reason": string,
"type": string,
"restrictingUser": {
object ( |
フィールド | |
---|---|
readOnly |
ファイルのコンテンツが読み取り専用かどうか。ファイルが読み取り専用の場合は、ファイルの新しい版の追加、コメントの追加、変更、ファイルのタイトルの変更はできません。 |
reason |
ファイルのコンテンツが制限されている理由。これは、 |
type |
出力のみ。コンテンツの制限の種類。現在、有効な値は |
restrictingUser |
出力のみ。コンテンツの制限を設定したユーザー。 |
restrictionTime |
出力のみ。コンテンツの制限が設定されている時刻(RFC 3339 形式のタイムスタンプ)。 |
Methods |
|
---|---|
|
ファイルのコピーを作成し、パッチのセマンティクスを使用して、リクエストされた更新を適用します。 |
|
新しいファイルを作成します。 |
|
ユーザーが所有するファイルをゴミ箱に移動せずに、完全に削除する。 |
|
ユーザーのゴミ箱内のファイルがすべて完全に削除されます。 |
|
リクエストされた MIME タイプに Google Workspace ドキュメントをエクスポートし、エクスポートされたバイト コンテンツを返します。 |
|
作成リクエストまたはコピー リクエストで指定できるファイル ID のセットを生成します。 |
|
ID でファイルのメタデータまたはコンテンツを取得します。 |
|
ユーザーのファイルを一覧表示します。 |
|
ファイルのラベルを一覧表示します。 |
|
ファイルに適用されているラベルのセットを変更します。 |
|
ファイルのメタデータやコンテンツを更新します。 |
|
ファイルの変更に登録します。 |