- リソース: File
<ph type="x-smartling-placeholder">
- </ph>
- JSON 表現
- ContentRestriction
<ph type="x-smartling-placeholder">
- </ph>
- JSON 表現
- メソッド
リソース: File
ファイルのメタデータ。
一部のリソース メソッド(files.update
など)には fileId
が必要です。files.list
メソッドを使用して、ファイルの ID を取得します。
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 |
フルテキスト クエリを改善するために、ファイルのインデックスに登録されるテキスト。長さは 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。 1 つのファイルに設定できる親フォルダは 1 つのみです。複数の親を指定することはできません。 作成リクエストで指定されていない場合、ファイルはユーザーの [マイドライブ] フォルダに直接配置されます。コピー リクエストで指定されていない場合、ファイルは、ソースファイルの検出可能な親を継承します。files.update リクエストでは、 |
thumbnailLink |
出力専用。ファイルのサムネイルへの有効期間の短いリンク(利用可能な場合)。通常、数時間程度で終了します。クロスオリジン リソース シェアリング(CORS)ポリシーのため、ウェブ アプリケーションで直接使用することは想定されていません。プロキシ サーバーの使用を検討してください。リクエスト元のアプリがファイルのコンテンツにアクセスできる場合にのみ入力されます。ファイルが一般公開で共有されていない場合、 |
iconLink |
出力専用。ファイルのアイコンへの未認証の静的なリンク。 |
shared |
出力専用。ファイルが共有されているかどうか。共有ドライブ内のアイテムにはデータが入力されません。 |
lastModifyingUser |
出力専用。ファイルを変更した最後のユーザー。このフィールドは、ログイン ユーザーによって最終更新が行われた場合にのみ入力されます。 |
owners[] |
出力専用。このファイルのオーナー。複数のオーナーを設定できるのは、以前の特定のファイルのみです。共有ドライブ内のアイテムでは、このフィールドに値は入力されません。 |
headRevisionId |
出力専用。ファイルのヘッド リビジョンの ID。現在のところ、この機能は Google ドライブ内のバイナリ コンテンツを含むファイルでのみ利用できます。 |
sharingUser |
出力専用。リクエスト元のユーザーとファイルを共有したユーザー(該当する場合)。 |
webViewLink |
出力専用。関連する Google エディタまたはブラウザのビューアでファイルを開くためのリンク。 |
webContentLink |
出力専用。ブラウザでファイルのコンテンツをダウンロードするためのリンク。この機能は、Google ドライブ内のバイナリ コンテンツを含むファイルでのみ利用できます。 |
size |
出力専用。blob とファーストパーティ エディタ ファイルのサイズ(バイト単位)。ショートカットやフォルダなど、サイズのないファイルにはデータが入力されません。 |
viewersCanCopyContent |
非推奨: 代わりに |
permissions[] |
出力専用。ファイルの権限の完全なリスト。この操作は、リクエスト元のユーザーがファイルを共有できる場合にのみ使用できます。共有ドライブ内のアイテムにはデータが入力されません。 |
hasThumbnail |
出力専用。このファイルにサムネイルがあるかどうか。リクエスト元のアプリがサムネイルにアクセスできるかどうかを示すものではありません。アクセス権を確認するには、ThumbnailLink フィールドを探します。 |
spaces[] |
出力専用。ファイルを含むスペースのリスト。現在サポートされている値は「drive」、「appDataFolder」です。「photos」などです。 |
folderColorRgb |
フォルダまたはフォルダへのショートカットの色(RGB 16 進文字列)。サポートされている色は、概要リソースの サポートされていない色が指定された場合、パレット内で最も近い色が代わりに使用されます。 |
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 |
出力専用。現在のユーザーがファイルのラベルを変更できるかどうか。 |
capabilities.canModifyEditorContentRestriction |
出力専用。編集者による制限を受けているファイルのコンテンツ制限を現在のユーザーが追加または変更できるかどうか。 |
capabilities.canModifyOwnerContentRestriction |
出力専用。所有者による制限付きコンテンツの制限を現在のユーザーが追加または変更できるかどうか。 |
capabilities.canRemoveContentRestriction |
出力専用。現在のユーザーが削除できるコンテンツの制限がファイルにあるかどうか。 |
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 ドライブに保存されているファイルに対してのみ入力されます。ドキュメント エディタやショートカット ファイルには挿入されません。 |
ContentRestriction
ファイルのコンテンツにアクセスするための制限。
JSON 表現 |
---|
{
"readOnly": boolean,
"reason": string,
"type": string,
"restrictingUser": {
object ( |
フィールド | |
---|---|
readOnly |
ファイルのコンテンツが読み取り専用かどうか。ファイルが読み取り専用の場合、ファイルの新しいリビジョンの追加、コメントの追加や変更、ファイルのタイトルの変更はできません。 |
reason |
ファイルのコンテンツが制限されている理由。これを変更できるのは、 |
type |
出力専用。コンテンツの制限のタイプ。現在指定できる値は |
restrictingUser |
出力専用。コンテンツの制限を設定したユーザー。 |
restrictionTime |
出力専用。コンテンツの制限が設定された時刻(形式の RFC 3339 タイムスタンプ)。 |
ownerRestricted |
コンテンツの制限を変更、削除できるのは、ファイルを所有しているユーザーのみかどうかを指定します。共有ドライブ内のファイルについては、 |
systemRestricted |
出力専用。コンテンツの制限がシステムによって適用されたかどうか(電子署名など)。ユーザーは、システムにより制限されたコンテンツの制限を変更または削除できません。 |
メソッド |
|
---|---|
|
ファイルのコピーを作成し、パッチ セマンティクスを使用してリクエストされた更新を適用します。 |
|
新しいファイルを作成します。 |
|
ユーザーが所有するファイルをゴミ箱に移動せずに完全に削除します。 |
|
ユーザーのゴミ箱にあるすべてのファイルを完全に削除します。 |
|
Google Workspace ドキュメントをリクエストされた MIME タイプにエクスポートし、エクスポートされたバイト コンテンツを返します。 |
|
作成リクエストまたはコピー リクエストで提供できる一連のファイル ID を生成します。 |
|
ファイルのメタデータまたはコンテンツを ID で取得します。 |
|
ユーザーのファイルを一覧表示します。 |
|
ファイルのラベルを一覧表示します。 |
|
ファイルに適用されているラベルのセットを変更します。 |
|
ファイルのメタデータやコンテンツを更新します。 |
|
ファイルの変更を通知します。 |