- この記事は、Google Drive™ APIに関する記事を和訳したものです。
- 原文: Manage file metadata
- 元記事のライセンスは CC-BYで、この和訳記事のライセンスは CC-BYです。
- 自己責任でご利用ください。
- 和訳した時期は 2019年6月ころです。
ファイルの挿入および取得を開始するために必要となる情報の多くは、Files referenceで詳しく説明しています。 ここでは、ファイルを名づけ、サムネイルやインデックス可能なテキストのようなメタデータを操作するための、少しのより重要な考慮事項があります。
ファイルの名前と拡張子を指定する
アプリは、APIを用いてファイルを挿入するとき、タイトルプロパティにてファイルの拡張子を指定する必要があります。
例えば、JPEGファイルを挿入するための操作は、メタデータにて "name": "cat.jpg"
のような何かを指定する必要があります。
後続の GET
リクエストは、元々 name
プロパティに指定された拡張子を用いて設定された、読み取り専用の fileExtension
プロパティを含んでいます。
Google Driveのユーザがファイルをダウンロードすることをリクエストしたとき、あるいは、ファイルが同期クライアントを介してダウンロードされるとき、Driveはタイトルに基づいてフルなファイル名(拡張子を伴う)を構築します。
拡張子がない場合、Google Driveは、ファイルの MIMEタイプに基づいて拡張子を決定しようとします。
インデックス可能なテキストを保存する
Driveは、それがファイルタイプを認識したとき、検索のためにドキュメントを自動的にインデックスします。 これは、テキストドキュメント、PDF、テキストを伴う画像、および他の一般的なタイプを含みます。 もしあなたのアプリが他のファイルのタイプ(図面、動画、ショートカット)を保存するならば、インデックス可能なテキストを提供することによって検索可能性を改善することができます。
インデックス可能なテキストは、HTMLとしてインデックスされます。
もし、インデックス可能なテキスト文字列 <section attribute="value1">Here's some text</section>
を保存するならば、"Here's some text" はインデックスされますが、"value1" はそうではなありません。
このため、インデックス可能なテキストとして XMLを保存することは、HTMLを保存することほど役立ちません。
さらには、次のことを心に留めてください:
-
contentHints.indexableText
のサイズ制限は 128Kです。 - 重要度の高い順にテキストをソートしようとしないでください; インデクサは、あなたのためにそれを非常に効率的に行います。
- インデックス可能なテキストは、それぞれの保存ごとにあなたのアプリケーションによって更新される必要があります。
- テキストがファイルのコンテンツに関連していることを確認してください。
この最後のポイントははっきりと見えるかもしれませんが、それは非常に重要です。 ファイルを検索結果に表示させようと、一般的に検索された用語を追加することは良いアイデアではありません。 これは、ユーザを苛立たせる可能性があり、彼らにファイルを削除するよう動機づけるかもしれません。
サムネイルをアップロードする
Driveは、多くの一般的なファイルタイプのためのサムネイルを自動的に生成します。
ショートカット、および Driveがレンダリングできない他のファイルタイプの場合、あなたのアプリケーションによって生成されたサムネイル画像を提供することができます。
次のように、挿入あるいは更新呼び出し中に、File resource上の contentHints.thumbnail
プロパティをセットすることによって、サムネイルをアップロードします。
-
contentHints.thumbnail.image
に、URLセーフな Base64エンコードされた画像(RFC 4648 section 5を参照)をセットします -
contentHints.thumbnail.mimeType
に、画像形式のための適切なタイプをセットします
もし Driveがファイルからサムネイルを生成することができるならば、それは生成されたものを使用し、あなたがアップロードしたかもしれないものすべてを無視します。 もしそれがサムネイルを生成することができなければ、それは、常に、あなたが提供した場合にはあなたのものを使用します。 心に留めておくこと:
- サムネイルは、PNG、GIF、あるいは JPG形式でアップロードされることができます。
- 推奨される幅は 1600pxです。
- サムネイルのための最大ファイルサイズは 2MBです。
- サムネイルのための最小幅は 220pxです。
- サムネイルは、それぞれの保存ごとにあなたのアプリケーションによって更新される必要があります。
詳細については、Files referenceを参照してください。