リソース: File
ファイルのメタデータ。
一部のリソース メソッド(files.update
など)では fileId
が必要です。files.list
メソッドを使用して、ファイルの ID を取得します。
JSON 表現 |
---|
{ "exportLinks": { string: string, ... }, "parents": [ string ], "owners": [ { object ( |
フィールド | |
---|---|
exportLinks |
出力専用。ドキュメント エディタのファイルを特定の形式にエクスポートするためのリンク。
|
parents[] |
ファイルを含む親フォルダの ID。 ファイルに設定できる親フォルダは 1 つだけです。複数の親を指定することはできません。 作成リクエストの一部として指定されていない場合、ファイルはユーザーのマイドライブ フォルダに直接配置されます。コピー リクエストの一部として指定されていない場合、ファイルはソースファイルの検出可能な親を継承します。files.update リクエストでは、 |
owners[] |
出力専用。このファイルのオーナー。複数のオーナーを持つことができるのは、特定の以前のファイルのみです。共有ドライブ内のアイテムの場合、このフィールドは入力されません。 |
permissions[] |
出力専用。ファイルに対する権限の完全なリスト。これは、リクエストしているユーザーがファイルを共有できる場合にのみ使用できます。共有ドライブ内のアイテムには入力されません。 |
spaces[] |
出力専用。ファイルを含むスペースのリスト。現在サポートされている値は、'drive'、'appDataFolder'、'photos' です。 |
properties |
すべてのアプリから見える任意の Key-Value ペアのコレクション。 null 値を含むエントリは、更新リクエストとコピー リクエストでクリアされます。
|
appProperties |
リクエスト元のアプリに固有の任意の Key-Value ペアのコレクション。 null 値を含むエントリは、更新リクエストとコピー リクエストでクリアされます。 これらのプロパティは、認証されたリクエストでのみ取得できます。認証されたリクエストは、OAuth 2 クライアント ID で取得したアクセス トークンを使用します。API キーを使用して非公開プロパティを取得することはできません。
|
permissionIds[] |
出力専用。このファイルにアクセスできるユーザーの権限 ID の files.list。 |
contentRestrictions[] |
ファイルの内容へのアクセスに関する制限。このような制限が存在する場合にのみ入力されます。 |
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 タイプでファイルが作成された場合、アップロードされたコンテンツは可能な限りインポートされます。サポートされているインポート形式は、About リソースで公開されています。 |
thumbnailLink |
出力専用。ファイルのサムネイルへの有効期間の短いリンク(利用可能な場合)。通常、数時間程度で終了します。クロスオリジン リソース シェアリング(CORS)ポリシーにより、ウェブ アプリケーションで直接使用することは想定されていません。プロキシ サーバーの使用を検討してください。リクエスト元のアプリがファイルのコンテンツにアクセスできる場合にのみ入力されます。ファイルが一般公開されていない場合、 |
iconLink |
出力専用。ファイルのアイコンへの静的な未認証リンク。 |
shared |
出力専用。ファイルが共有されているかどうか。共有ドライブ内のアイテムには入力されません。 |
lastModifyingUser |
出力専用。ファイルを最後に変更したユーザー。このフィールドは、ログインしたユーザーが最後に変更を行った場合にのみ入力されます。 |
headRevisionId |
出力専用。ファイルのヘッド リビジョンの ID。この機能は現在、Google ドライブ内のバイナリ コンテンツを含むファイルでのみ使用できます。 |
sharingUser |
出力専用。リクエスト元のユーザーとファイルを共有したユーザー(該当する場合)。 |
webViewLink |
出力専用。ブラウザで関連する Google エディタまたはビューアでファイルを開くためのリンク。 |
webContentLink |
出力専用。ブラウザでファイルの内容をダウンロードするためのリンク。これは、Google ドライブ内のバイナリ コンテンツを含むファイルでのみ使用できます。 |
size |
出力専用。blob とファーストパーティ エディタ ファイルのサイズ(バイト単位)。ショートカットやフォルダなど、サイズのないファイルについては入力されません。 |
viewersCanCopyContent |
非推奨: 代わりに、 |
hasThumbnail |
出力専用。このファイルにサムネイルがあるかどうか。これは、リクエスト元のアプリがサムネイルにアクセスできるかどうかを示すものではありません。アクセスを確認するには、thumbnailLink フィールドの有無を確認します。 |
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 |
出力専用。ファイルによって使用された保存容量のバイト数。これには、HEAD リビジョンと |
version |
出力専用。ファイルの単調増加するバージョン番号。ユーザーには表示されない変更も含め、サーバー上のファイルに加えられたすべての変更が反映されます。 |
originalFilename |
アップロードされたコンテンツの元のファイル名(利用可能な場合)。利用できない場合は、 |
ownedByMe |
出力専用。ユーザーがファイルを所有しているかどうか。共有ドライブ内のアイテムには入力されません。 |
fullFileExtension |
出力専用。 これは |
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 |
出力専用。現在のユーザーがファイルにラベルを付けられるかどうか。 |
capabilities.canModifyEditorContentRestriction |
出力専用。現在のユーザーが、編集者制限のあるファイルにコンテンツ制限を追加または変更できるかどうか。 |
capabilities.canModifyOwnerContentRestriction |
出力専用。現在のユーザーが、オーナー制限付きのコンテンツ制限を追加または変更できるかどうか。 |
capabilities.canRemoveContentRestriction |
出力専用。現在のユーザーが削除できるコンテンツ制限がファイルに設定されているかどうか。 |
capabilities.canDisableInheritedPermissions |
ユーザーが継承された権限を無効にできるかどうか。 |
capabilities.canEnableInheritedPermissions |
ユーザーが継承された権限を再度有効にできるかどうか。 |
capabilities.canChangeItemDownloadRestriction |
出力専用。現在のユーザーが、ファイルに適用されているオーナーまたは主催者によるダウンロード制限を変更できるかどうか。 |
hasAugmentedPermissions |
出力専用。このファイルに直接権限が付与されているかどうか。このフィールドは、共有ドライブ内のアイテムにのみ入力されます。 |
trashingUser |
出力専用。ファイルが明示的にゴミ箱に移動された場合、そのファイルをゴミ箱に移動したユーザー。共有ドライブ内のアイテムにのみ入力されます。 |
thumbnailVersion |
出力専用。サムネイル キャッシュの無効化で使用するサムネイル バージョン。 |
trashedTime |
出力専用。アイテムがゴミ箱に移動された時間(RFC 3339 日付と時刻)。共有ドライブ内のアイテムにのみ入力されます。 |
modifiedByMe |
出力専用。ファイルがこのユーザーによって変更されたかどうか。 |
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。 |
resourceKey |
出力専用。共有リンク経由でアイテムにアクセスするために必要なキー。 |
linkShareMetadata |
出力専用。LinkShare 関連の詳細。クライアントがこのアイテムを参照するために使用しているリンク URL の詳細が含まれます。 |
linkShareMetadata.securityUpdateEligible |
出力専用。ファイルがセキュリティ アップデートの対象かどうか。 |
linkShareMetadata.securityUpdateEnabled |
出力専用。このファイルでセキュリティ アップデートが有効になっているかどうか。 |
labelInfo |
出力専用。ファイルに設定されているラベルの概要。 |
labelInfo.labels[] |
出力専用。 |
sha1Checksum |
出力専用。このファイルに関連付けられた SHA1 チェックサム(使用可能な場合)。このフィールドは、Google ドライブにコンテンツが保存されているファイルに対してのみ入力されます。ドキュメント エディタやショートカット ファイルに対しては入力されません。 |
sha256Checksum |
出力専用。このファイルに関連付けられている SHA256 チェックサム(使用可能な場合)。このフィールドは、Google ドライブにコンテンツが保存されているファイルに対してのみ入力されます。ドキュメント エディタやショートカット ファイルに対しては入力されません。 |
inheritedPermissionsDisabled |
このファイルで権限の継承が無効になっているかどうか。継承された権限はデフォルトで有効になっています。 |
downloadRestrictions |
ファイルにダウンロードの制限が適用されています。 |
ContentRestriction
ファイルの内容へのアクセス制限。
JSON 表現 |
---|
{
"readOnly": boolean,
"reason": string,
"type": string,
"restrictingUser": {
object ( |
フィールド | |
---|---|
readOnly |
ファイルの内容が読み取り専用かどうか。ファイルが読み取り専用の場合、ファイルの新しいリビジョンを追加したり、コメントを追加または変更したり、ファイルのタイトルを変更したりすることはできません。 |
reason |
ファイルの内容が制限されている理由。これは、 |
type |
出力専用。コンテンツ制限のタイプ。現在、指定できる値は |
restrictingUser |
出力専用。コンテンツ制限を設定したユーザー。 |
restrictionTime |
出力専用。コンテンツ制限が設定された時刻(RFC 3339 タイムスタンプ形式)。 |
ownerRestricted |
コンテンツの制限を、ファイルのオーナーのみが変更または削除できるかどうか。共有ドライブ内のファイルの場合、 |
systemRestricted |
出力専用。コンテンツの制限がシステムによって適用されたかどうか(電子署名など)。ユーザーは、システムで制限されたコンテンツの制限を変更または削除できません。 |
DownloadRestrictionsMetadata
ファイルにダウンロードの制限が適用されています。
JSON 表現 |
---|
{ "itemDownloadRestriction": { object ( |
フィールド | |
---|---|
itemDownloadRestriction |
オーナーまたは主催者が直接適用したファイルのダウンロード制限。共有ドライブの設定や DLP ルールは考慮されません。 |
effectiveDownloadRestrictionWithContext |
出力専用。このファイルに適用されている有効なダウンロード制限。すべての制限設定と DLP ルールが考慮されます。 |
DownloadRestriction
ファイルのコピーとダウンロードの制限。
JSON 表現 |
---|
{ "restrictedForReaders": boolean, "restrictedForWriters": boolean } |
フィールド | |
---|---|
restrictedForReaders |
閲覧者に対してダウンロードとコピーが制限されているかどうか。 |
restrictedForWriters |
編集者に対してダウンロードとコピーが制限されているかどうか。true の場合、読者によるダウンロードも制限されます。 |
メソッド |
|
---|---|
|
ファイルのコピーを作成し、リクエストされた更新をパッチ セマンティクスで適用します。 |
|
新しいファイルを作成します。 |
|
ファイルをゴミ箱に移動せずに、ユーザーが所有するファイルを完全に削除します。 |
|
ファイルの内容をダウンロードします。 |
|
ユーザーのゴミ箱内のすべてのファイルを完全に削除します。 |
|
Google Workspace ドキュメントをリクエストされた MIME タイプにエクスポートし、エクスポートされたバイト コンテンツを返します。 |
|
作成リクエストまたはコピー リクエストで指定できるファイル ID のセットを生成します。 |
|
ID を指定して、ファイルのメタデータまたはコンテンツを取得します。 |
|
ユーザーのファイルの一覧を取得します。 |
|
ファイルに設定されているラベルを一覧表示します。 |
|
ファイルに適用されているラベルのセットを変更します。 |
|
ファイルのメタデータまたはコンテンツを更新します。 |
|
ファイルへの変更の通知を受け取ります。 |