リソース: ファイル
ファイルのメタデータ。
一部のリソース メソッド(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 |
出力専用。リソースの種類を示します。値は固定文字列 |
drive |
出力専用。ファイルが存在する共有ドライブの ID。共有ドライブ内のアイテムに対してのみ入力されます。 |
file |
出力専用。 |
copy |
このファイルのコピー、印刷、ダウンロードのオプションを、閲覧者とコメント投稿者に対して無効にするかどうか。 |
md5 |
出力専用。ファイルの内容の MD5 チェックサム。これは、Google ドライブ内のバイナリ コンテンツを含むファイルにのみ適用されます。 |
content |
ファイルの内容に関する追加情報。これらのフィールドはレスポンスに入力されません。 |
content |
全文検索のクエリの精度を高めるために、ファイルにインデックスを付けるテキスト。長さは 128 KB に制限され、HTML 要素を含めることができます。 |
content |
ファイルのサムネイル。これは、Google ドライブで標準の縮小画像を生成できない場合にのみ使用されます。 |
content |
URL セーフな Base64(RFC 4648 セクション 5)でエンコードされたサムネイル データ。 Base64 でエンコードされた文字列。 |
content |
サムネイルの MIME タイプ。 |
writers |
|
viewed |
出力専用。このユーザーがファイルを閲覧したかどうか。 |
mime |
ファイルの MIME タイプ。 値が指定されていない場合、Google ドライブはアップロードされたコンテンツから適切な値を自動的に検出しようとします。新しいリビジョンをアップロードしない限り、値を変更することはできません。 ファイルが Google ドキュメントの MIME タイプで作成されている場合、アップロードされたコンテンツは可能であればインポートされます。サポートされているインポート形式については、概要リソースをご覧ください。 |
export |
出力専用。Docs エディタのファイルを特定の形式にエクスポートするためのリンク。
|
parents[] |
ファイルを含む親フォルダの ID。 ファイルの親フォルダは 1 つだけです。複数の親フォルダを指定することはできません。 作成リクエストの一部として指定されていない場合、ファイルはユーザーのマイドライブ フォルダに直接配置されます。コピー リクエストの一部として指定されていない場合、ファイルはソースファイルの検出可能な親を継承します。files.update リクエストでは、 |
thumbnail |
出力専用。ファイルのサムネイルへのリンク(利用可能な場合)。通常は数時間ほどで解消されます。クロスオリジン リソース シェアリング(CORS)ポリシーにより、ウェブ アプリケーションでの直接使用は想定されていません。プロキシ サーバーの使用を検討してください。リクエスト元のアプリがファイルのコンテンツにアクセスできる場合にのみ入力されます。ファイルが一般公開されていない場合は、 |
icon |
出力専用。ファイルのアイコンへの静的かつ未認証のリンク。 |
shared |
出力専用。ファイルが共有されているかどうか。共有ドライブ内のアイテムには入力されません。 |
last |
出力専用。ファイルを最後に変更したユーザー。このフィールドは、ログイン中のユーザーが最後に変更を行った場合にのみ入力されます。 |
owners[] |
出力専用。このファイルのオーナー。複数のオーナーを持つことができるのは、特定の以前のファイルに限られます。共有ドライブ内のアイテムの場合、このフィールドには入力されません。 |
head |
出力専用。ファイルのヘドリビジョンの ID。現在、この機能は Google ドライブ内のバイナリ コンテンツを含むファイルでのみ使用できます。 |
sharing |
出力専用。リクエスト元のユーザーとファイルを共有したユーザー(該当する場合)。 |
web |
出力専用。ブラウザで関連する Google エディタまたはビューアでファイルを開くためのリンク。 |
web |
出力専用。ブラウザでファイルのコンテンツをダウンロードするためのリンク。これは、Google ドライブ内のバイナリ コンテンツを含むファイルでのみ使用できます。 |
size |
出力専用。blob とファーストパーティ エディタ ファイルのサイズ(バイト単位)。ショートカットやフォルダなど、サイズのないファイルには入力されません。 |
viewersCanCopyContent |
非推奨: 代わりに、 |
permissions[] |
出力専用。ファイルの権限の完全なリスト。これは、リクエスト元のユーザーがファイルを共有できる場合にのみ使用できます。共有ドライブ内のアイテムには入力されません。 |
has |
出力専用。このファイルにサムネイルがあるかどうか。これは、リクエスト元のアプリがサムネイルにアクセスできるかどうかを示すものではありません。アクセス権を確認するには、thumbnailLink フィールドの有無を確認します。 |
spaces[] |
出力専用。ファイルを含むスペースのリスト。現在サポートされている値は、drive、appDataFolder、photos です。 |
folder |
フォルダまたはフォルダのショートカットの色(RGB 16 進数文字列)。サポートされている色は、About リソースの サポートされていない色が指定されている場合は、パレット内の最も近い色が代わりに使用されます。 |
id |
ファイルの ID。 |
name |
ファイルの名前。フォルダ内で一意である必要はありません。共有ドライブの最上位フォルダ、マイドライブのルートフォルダ、アプリケーション データ フォルダなどの不変のアイテムの名前は一定です。 |
description |
ファイルの簡単な説明。 |
starred |
ユーザーがファイルにスターを付けたかどうか。 |
trashed |
ファイルが明示的にゴミ箱に移動されたか、ゴミ箱に移動された親フォルダから移動されたかどうか。ファイルをゴミ箱に移動できるのはオーナーのみです。他のユーザーは、オーナーのゴミ箱内のファイルを表示できません。 |
explicitly |
出力専用。親フォルダから再帰的にゴミ箱に移動されたのではなく、ファイルが明示的にゴミ箱に移動されたかどうか。 |
created |
ファイルが作成された時刻(RFC 3339 日時)。 |
modified |
ファイルが最後に変更された日時(RFC 3339 日時)。
|
modified |
出力専用。ユーザーが最後にファイルを変更した日時(RFC 3339 日時)。 |
viewed |
ユーザーが最後にファイルを表示した日時(RFC 3339 の日時)。 |
shared |
出力専用。ファイルがユーザーと共有された時刻(該当する場合)(RFC 3339 日時)。 |
quota |
出力専用。ファイルで使用された保存容量のバイト数。これには、HEAD リビジョンと、 |
version |
出力専用。ファイルの単調増加バージョン番号。ユーザーには表示されない変更も含め、サーバー上のファイルに加えられたすべての変更が反映されます。 |
original |
アップロードされたコンテンツの元のファイル名(利用可能な場合)、または |
owned |
出力専用。ユーザーがファイルの所有者かどうか。共有ドライブ内のアイテムには入力されません。 |
full |
出力専用。 これは、 |
properties |
すべてのアプリに表示される任意の Key-Value ペアのコレクション。 null 値を含むエントリは、更新リクエストとコピー リクエストで消去されます。
|
app |
リクエスト元のアプリに固有の任意の Key-Value ペアのコレクション。 null 値を含むエントリは、更新リクエストとコピー リクエストで消去されます。 これらのプロパティは、認証済みリクエストを使用してのみ取得できます。認証済みリクエストでは、OAuth 2 クライアント ID で取得したアクセス トークンを使用します。API キーを使用してプライベート プロパティを取得することはできません。
|
is |
出力専用。リクエスト元のアプリによってファイルが作成されたか、開かれたか。 |
teamDriveId |
非推奨: 出力専用。 |
capabilities |
出力専用。現在のユーザーがこのファイルに対して持っている権限。各機能は、ユーザーが実行できるきめ細かいアクションに対応しています。 |
capabilities.canChangeViewersCanCopyContent |
非推奨: 出力専用。 |
capabilities. |
出力専用。現在のユーザーがこのフォルダの子フォルダを共有ドライブの外部に移動できるかどうか。アイテムがフォルダでない場合、これは false になります。共有ドライブ内のアイテムに対してのみ入力されます。 |
capabilities. |
出力専用。現在のユーザーが、このファイルが属する共有ドライブを読み取れるかどうか。共有ドライブ内のアイテムに対してのみ入力されます。 |
capabilities. |
出力専用。現在のユーザーがこのファイルを編集できるかどうか。ユーザーがファイルに加えることができる変更の種類は、他の要因によって制限される場合があります。たとえば、 |
capabilities. |
出力専用。現在のユーザーがこのファイルをコピーできるかどうか。共有ドライブ内のアイテムの場合、現在のユーザーがこのアイテムのフォルダ以外の子孫をコピーできるかどうか、またはこのアイテム自体をコピーできるかどうか(このアイテムがフォルダでない場合)。 |
capabilities. |
出力専用。現在のユーザーがこのファイルにコメントできるかどうか。 |
capabilities. |
出力専用。現在のユーザーがこのフォルダに子フォルダを追加できるかどうか。アイテムがフォルダでない場合、これは常に false になります。 |
capabilities. |
出力専用。現在のユーザーがこのファイルを削除できるかどうか。 |
capabilities. |
出力専用。現在のユーザーがこのファイルをダウンロードできるかどうか。 |
capabilities. |
出力専用。現在のユーザーがこのフォルダの子フォルダを一覧表示できるかどうか。アイテムがフォルダでない場合、これは常に false になります。 |
capabilities. |
出力専用。現在のユーザーがこのフォルダから子フォルダを削除できるかどうか。アイテムがフォルダでない場合、これは常に false になります。共有ドライブ内のフォルダの場合は、代わりに |
capabilities. |
出力専用。現在のユーザーがこのファイルの名前を変更できるかどうか。 |
capabilities. |
出力専用。現在のユーザーがこのファイルをゴミ箱に移動できるかどうか。 |
capabilities. |
出力専用。現在のユーザーがこのファイルのリビジョン リソースを読み取ることができるかどうか。共有ドライブのアイテムの場合、このアイテムのフォルダ以外の子孫のリビジョン、またはフォルダでない場合はこのアイテム自体を読み取ることができます。 |
capabilities.canReadTeamDrive |
非推奨: 出力専用。 |
capabilities.canMoveTeamDriveItem |
非推奨: 出力専用。代わりに |
capabilities. |
出力専用。現在のユーザーがこのファイルの |
capabilities.canMoveItemIntoTeamDrive |
非推奨: 出力専用。 |
capabilities. |
出力専用。現在のユーザーがこのファイルをゴミ箱から復元できるかどうか。 |
capabilities. |
出力専用。現在のユーザーがこのファイルの内容を変更できるかどうか。 |
capabilities.canMoveItemWithinTeamDrive |
非推奨: 出力専用。 |
capabilities.canMoveItemOutOfTeamDrive |
非推奨: 出力専用。 |
capabilities. |
出力専用。現在のユーザーがこのフォルダの子フォルダを削除できるかどうか。アイテムがフォルダでない場合、これは false になります。共有ドライブ内のアイテムに対してのみ入力されます。 |
capabilities.canMoveChildrenOutOfTeamDrive |
非推奨: 出力専用。 |
capabilities.canMoveChildrenWithinTeamDrive |
非推奨: 出力専用。 |
capabilities. |
出力専用。現在のユーザーがこのフォルダの子フォルダをゴミ箱に移動できるかどうか。アイテムがフォルダでない場合、これは false になります。共有ドライブ内のアイテムに対してのみ入力されます。 |
capabilities. |
出力専用。現在のユーザーが、親を変更してこのアイテムをこのドライブの外部に移動できるかどうか。アイテムの親を変更するリクエストは、追加される新しい親によっては失敗することがあります。 |
capabilities. |
出力専用。現在のユーザーが、同じリクエストで既存の親を削除せずにアイテムの親を追加できるかどうか。共有ドライブのファイルには入力されません。 |
capabilities. |
出力専用。現在のユーザーが、同じリクエストで別の親を追加せずに、アイテムから親を削除できるかどうか。共有ドライブのファイルには入力されません。 |
capabilities. |
出力専用。現在のユーザーがこのドライブ内でこのアイテムを移動できるかどうか。アイテムの親を変更するリクエストは、追加される新しい親と削除される親によっては失敗することがあります。 |
capabilities. |
出力専用。現在のユーザーがこのファイルの共有設定を変更できるかどうか。 |
capabilities. |
出力専用。現在のユーザーがこのドライブ内でこのフォルダの子フォルダを移動できるかどうか。アイテムがフォルダでない場合、これは false になります。子フォルダへの移動リクエストは、現在のユーザーが子フォルダと宛先フォルダにアクセスできるかどうかによって失敗することがあります。 |
capabilities.canModifyContentRestriction |
非推奨: 出力専用。 |
capabilities. |
出力専用。現在のユーザーが別のドライブ(別の共有ドライブまたはマイドライブ)からこのフォルダにフォルダを追加できるかどうか。アイテムがフォルダでない場合、これは false になります。共有ドライブ内のアイテムに対してのみ入力されます。 |
capabilities. |
出力専用。現在のユーザーがリンク共有メタデータの securityUpdateEnabled フィールドを変更できるかどうか。 |
capabilities. |
出力専用。現在のユーザーがファイルの保留中の所有者かどうか。共有ドライブのファイルには入力されません。 |
capabilities. |
出力専用。現在のユーザーがファイルのラベルを読み取れるかどうか。 |
capabilities. |
出力専用。現在のユーザーがファイルのラベルを変更できるかどうか。 |
capabilities. |
出力専用。現在のユーザーが、編集者制限のあるファイルのコンテンツ制限を追加または変更できるかどうか。 |
capabilities. |
出力専用。現在のユーザーが、オーナーが制限しているコンテンツ制限を追加または変更できるかどうか。 |
capabilities. |
出力専用。現在のユーザーが削除できるコンテンツ制限がファイルに適用されているかどうか。 |
capabilities. |
ユーザーが継承された権限を無効にできるかどうか。 |
capabilities. |
ユーザーが継承された権限を再度有効にできるかどうか。 |
has |
出力専用。このファイルに直接権限が付与されているかどうか。このフィールドは、共有ドライブ内のアイテムに対してのみ入力されます。 |
trashing |
出力専用。ファイルが明示的にゴミ箱に移動されている場合は、そのファイルをゴミ箱に移動したユーザー。共有ドライブ内のアイテムに対してのみ入力されます。 |
thumbnail |
出力専用。サムネイル キャッシュの無効化で使用するサムネイル バージョン。 |
trashed |
出力専用。アイテムがゴミ箱に移動された時刻(RFC 3339 日時)。共有ドライブ内のアイテムに対してのみ入力されます。 |
modified |
出力専用。このユーザーがファイルを変更したかどうか。 |
permission |
出力のみ。このファイルにアクセスできるユーザーの権限 ID の files.list。 |
image |
出力専用。画像メディアに関する追加のメタデータ(利用可能な場合)。 |
image |
出力専用。写真の作成にフラッシュが使用されたかどうか。 |
image |
出力専用。写真の作成に使用された測光モード。 |
image |
出力専用。写真の作成に使用されたセンサーの種類。 |
image |
出力専用。写真の作成に使用された露出モード。 |
image |
出力専用。写真の色空間。 |
image |
出力専用。写真の作成に使用されたホワイトバランス モード。 |
image |
出力専用。画像の幅(ピクセル単位)。 |
image |
出力専用。画像の高さ(ピクセル単位)。 |
image |
出力専用。画像に保存されている地理的位置情報。 |
image |
出力専用。画像に保存されている緯度。 |
image |
出力専用。画像に保存されている経度。 |
image |
出力専用。画像に保存されている高度。 |
image |
出力専用。画像の元の向きから適用された時計回りの 90 度回転の数。 |
image |
出力専用。写真の撮影日時(EXIF DateTime)。 |
image |
出力専用。写真の作成に使用されたカメラのメーカー。 |
image |
出力専用。写真の作成に使用されたカメラのモデル。 |
image |
出力専用。露出時間(秒単位)。 |
image |
出力専用。写真の作成に使用された絞り(f 値)。 |
image |
出力専用。写真の作成に使用された焦点距離(ミリメートル単位)。 |
image |
出力専用。写真の作成に使用された ISO 感度。 |
image |
出力専用。写真の露出バイアス(APEX 値)。 |
image |
出力専用。写真の作成に使用された焦点距離におけるレンズの最小絞り値(APEX 値)。 |
image |
出力専用。写真の被写体までの距離(メートル単位)。 |
image |
出力専用。写真の作成に使用されたレンズ。 |
video |
出力専用。動画メディアに関する追加のメタデータ。アップロード直後は利用できない場合があります。 |
video |
出力専用。動画の幅(ピクセル)。 |
video |
出力専用。動画の高さ(ピクセル)。 |
video |
出力専用。動画の再生時間(ミリ秒単位)。 |
shortcut |
ショートカット ファイルの詳細。mimeType フィールドが |
shortcut |
このショートカットが参照するファイルの ID。 |
shortcut |
出力専用。このショートカットが参照するファイルの MIME タイプ。このフィールドの値は、ショートカットの作成時にキャプチャされた、ターゲットの MIME タイプのスナップショットです。 |
shortcut |
出力専用。ターゲット ファイルの ResourceKey。 |
content |
ファイルのコンテンツへのアクセス制限。このような制限が存在する場合にのみ入力されます。 |
resource |
出力専用。共有リンク経由でアイテムにアクセスするために必要なキー。 |
link |
出力専用。LinkShare 関連の詳細。クライアントがこのアイテムを参照するために使用しているリンク URL の詳細が含まれます。 |
link |
出力専用。ファイルがセキュリティ アップデートの対象かどうか。 |
link |
出力専用。このファイルでセキュリティ アップデートが有効かどうか。 |
label |
出力専用。ファイルのラベルの概要。 |
label |
出力専用。 |
sha1 |
出力専用。このファイルに関連付けられている SHA1 チェックサム(利用可能な場合)。このフィールドには、Google ドライブにコンテンツが保存されているファイルにのみ値が入力されます。ドキュメント エディタやショートカット ファイルには値が入力されません。 |
sha256 |
出力専用。このファイルに関連付けられている SHA256 チェックサム(利用可能な場合)。このフィールドには、Google ドライブにコンテンツが保存されているファイルにのみ値が入力されます。ドキュメント エディタやショートカット ファイルには値が入力されません。 |
inherited |
このファイルの継承された権限が無効になっているかどうか。継承された権限はデフォルトで有効になっています。 |
ContentRestriction
ファイルの内容へのアクセス制限。
JSON 表現 |
---|
{
"readOnly": boolean,
"reason": string,
"type": string,
"restrictingUser": {
object ( |
フィールド | |
---|---|
read |
ファイルの内容が読み取り専用かどうか。ファイルが読み取り専用の場合、ファイルの新しいリビジョンを追加したり、コメントを追加または変更したり、ファイルのタイトルを変更したりすることはできません。 |
reason |
ファイルのコンテンツが制限されている理由。これは、 |
type |
出力専用。コンテンツ制限の種類。現在、指定できる値は |
restricting |
出力専用。コンテンツ制限を設定したユーザー。 |
restriction |
出力専用。コンテンツの制限が設定された時刻(RFC 3339 形式のタイムスタンプ)。 |
owner |
コンテンツの制限を変更または削除できるのは、ファイルのオーナーであるユーザーのみかどうか。共有ドライブ内のファイルの場合、 |
system |
出力専用。電子署名などにより、コンテンツの制限がシステムによって適用されたかどうか。ユーザーは、システムで制限されているコンテンツの制限を変更または削除することはできません。 |
メソッド |
|
---|---|
|
ファイルのコピーを作成し、パッチ セマンティクスを使用してリクエストされた更新を適用します。 |
|
新しいファイルを作成します。 |
|
ユーザーが所有するファイルをゴミ箱に移動せずに完全に削除します。 |
|
ファイルのコンテンツをダウンロードします。 |
|
ユーザーのゴミ箱内のすべてのファイルを完全に削除します。 |
|
Google Workspace ドキュメントをリクエストされた MIME タイプにエクスポートし、エクスポートされたバイト コンテンツを返します。 |
|
作成リクエストまたはコピー リクエストで指定できる一連のファイル ID を生成します。 |
|
ID を指定してファイルのメタデータまたはコンテンツを取得します。 |
|
ユーザーのファイルを一覧表示します。 |
|
ファイルのラベルを一覧表示します。 |
|
ファイルに適用されているラベルセットを変更します。 |
|
ファイルのメタデータやコンテンツを更新します。 |
|
ファイルの変更をサブスクライブします。 |