- リソース: 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, "userPermission": { object ( |
フィールド | |
---|---|
kind |
出力専用。ファイルの種類。これは常に |
userPermission |
出力専用。このファイルに対する認証済みユーザーの権限。 |
fileExtension |
出力専用。拡張機能の一部ではないと思われる末尾のテキストを含む |
md5Checksum |
出力専用。このファイルの内容の MD5 チェックサム。このフィールドは、コンテンツが Google ドライブに保存されているファイルに対してのみ入力されます。ドキュメント エディタやショートカット ファイルには挿入されません。 |
selfLink |
出力専用。このファイルに戻るリンク。 |
ownerNames[] |
出力専用。このファイルのオーナーの名前。共有ドライブ内のアイテムにはデータが入力されません。 |
lastModifyingUserName |
出力専用。このファイルを変更した最後のユーザーの名前。 |
editable |
出力専用。非推奨: 代わりに |
writersCanShare |
ライターが他のユーザーとドキュメントを共有できるかどうか。共有ドライブ内のアイテムにはデータが入力されません。 |
downloadUrl |
出力専用。ファイルの有効期間の短いダウンロード URL。このフィールドは、コンテンツが Google ドライブに保存されているファイルに対してのみ入力されます。Google ドキュメントやショートカット ファイルでは入力されません。 |
mimeType |
ファイルの MIME タイプ。これは、新しいコンテンツをアップロードするときの更新時にのみ変更できます。このフィールドは空白のままにできます。その場合、MIME タイプは、アップロードされたコンテンツの MIME タイプから決定されます。 |
exportLinks |
出力専用。ドキュメント エディタ ファイルを特定の形式にエクスポートするためのリンク。
|
driveId |
出力専用。ファイルがある共有ドライブの ID。共有ドライブ内のアイテムに対してのみ入力されます。 |
parents[] |
ファイルを含む親フォルダの ID。 1 つのファイルに設定できる親フォルダは 1 つのみです。複数の親を指定することはできません。 挿入リクエストで指定されていない場合、ファイルはユーザーの [マイドライブ] フォルダに直接配置されます。コピー リクエストで指定されていない場合、ファイルは、ソースファイルの検出可能な親を継承します。files.update リクエストでは、 |
thumbnailLink |
出力専用。ファイルのサムネイルへの有効期間の短いリンク(利用可能な場合)。通常、数時間程度で終了します。クロスオリジン リソース シェアリング(CORS)のため、ウェブ アプリケーションで直接使用することを想定していない場合は、プロキシ サーバーの使用を検討してください。リクエスト元のアプリがファイルのコンテンツにアクセスできる場合にのみ入力されます。ファイルが一般公開で共有されていない場合、 |
appDataContents |
出力専用。このファイルが Application Data フォルダ内にあるかどうか。 |
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 |
出力専用。このファイルにサムネイルがあるかどうか。リクエスト元のアプリがサムネイルにアクセスできるかどうかを示すものではありません。アクセス権を確認するには、ThumbnailLink フィールドを探します。 |
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 を設定すると、その日付を設定したユーザーの ModifyedByMe 日付も更新されます。 |
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 の files.list。 |
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 |
出力専用。コンテンツの制限がシステムによって適用されたかどうか(電子署名など)。ユーザーは、システムにより制限されたコンテンツの制限を変更または削除できません。 |
メソッド |
|
---|---|
|
指定されたファイルのコピーを作成します。 |
|
ユーザーが所有するファイルをゴミ箱に移動せずに完全に削除します。 |
|
ユーザーのゴミ箱にあるすべてのファイルを完全に削除します。 |
|
Google Workspace ドキュメントをリクエストされた MIME タイプにエクスポートし、エクスポートされたバイト コンテンツを返します。 |
|
挿入リクエストまたはコピー リクエストで指定できるファイル ID のセットを生成します。 |
|
ファイルのメタデータまたはコンテンツを ID で取得します。 |
|
新しいファイルを挿入します。 |
|
ユーザーのファイルを一覧表示します。 |
|
ファイルのラベルを一覧表示します。 |
|
ファイルに適用されているラベルのセットを変更します。 |
|
ファイルのメタデータやコンテンツを更新します。 |
|
ファイルの更新時刻を現在のサーバー時刻に設定します。 |
|
ファイルをゴミ箱に移動します。 |
|
ゴミ箱からファイルを復元します。 |
|
ファイルのメタデータやコンテンツを更新します。 |
|
ファイルの変更を通知します。 |