カスタムファイルプロパティ



  • この記事は、Google Drive™ APIに関する記事を和訳したものです。
  • 原文: Custom File Properties
  • 元記事のライセンスは CC-BYで、この和訳記事のライセンスは CC-BYです。
  • 自己責任でご利用ください。
  • 和訳した時期は 2019年6月ころです。

Google Driveのファイルに独自のプロパティを追加するために、Drive APIを使用することができます。 これらのプロパティは、ファイル上で、キー/値のペアとして格納されています。 プロパティは、すべてのアプリに表示可能か、あるいは、そのプロパティを作成したアプリに制限されているかもしれません。

プロパティは、filesproperties (すべてのアプリに表示可能)、および appProperties (単一のアプリに制限された)フィールドを使用して、アクセスされます

プロパティは、検索式で使用されることもできます。

プロパティを使用することは、あなたのアプリに、タグ、他のデータストアからの ID、表示設定などといった、追加のメタデータをファイル上に格納できるようにするでしょう。 プロパティは、例えば、ワークフローアプリケーションにて、アプリケーション間でメタデータを共有するために使用されることができます。

これは、ファイル自体上の Driveファイルのためにあなたのデータベースの IDを格納するために使用されるかもしれない、典型的なプロパティの構造です。

"appProperties": {
  "additionalID": "8e8aceg2af2ge72e78",
}

カスタムファイルプロパティは、次の使用制限を持っています:

  • ファイルごとに最大 100のカスタムプロパティ、それは、すべてのソースから合計されます。
  • ファイルごとに最大 30のパブリックプロパティ、それは、すべてのソースから合計されます。
  • 任意のひとつのアプリケーションから、ファイルごとに最大 30のプライベートプロパティ。
  • UTF-8エンコーディングにて、プロパティ(キーと値の両方を含む)文字列ごとに最大 124バイトサイズ。 例えば、10文字の長さであるキーを伴うプロパティは、値には 114文字のみを持つことができます。 値のために 100文字を必要とするプロパティは、キーのために 24文字まで使用することができます。
  • ファイルプロパティに書き込むことは、他の書き込み操作と同じパフォーマンスの影響を持っています。
詳細については、リファレンスドキュメントの filesを参照してください。