カスタム ファイルのプロパティを追加する

カスタム ファイル プロパティは、カスタム メタデータの格納に使用される Key-Value ペアで、 Google ドライブのファイル（タグなど）、他のデータストアの ID、情報 ワークフロー アプリケーション間で共有されます。たとえば、ファイルの追加、 第 1 四半期に営業部門が生成したすべてのドキュメントに、これらのプロパティを追加することをおすすめします。

すべてのアプリケーションに表示されるプロパティを追加するには、properties files リソース。プロパティを追加するには アプリに限定する場合は、files リソースの appProperties フィールドを使用します。

プロパティは 式。

これは、変数の格納に使用できる典型的なプロパティの構造です。 ファイル上のドライブ ファイルのデータベース ID。

Drive API v3

"appProperties": {
  "additionalID": "ID",
}

Drive API v2

{
  'key':        'additionalID',
  'value':      'ID',
  'visibility': 'PRIVATE'
}

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

このセクションでは、カスタム ファイルのプロパティ関連のタスクを実行する方法について説明します。 すべてのアプリケーションに影響します。

カスタム ファイルのプロパティを追加または更新する

すべてのアプリケーションに表示されるプロパティを追加または更新するには、 files.update メソッドを使用して、 files の properties フィールド リソースです。

PATCH https://www.googleapis.com/drive/v3/files/FILE_ID
{
  "properties": {
    "name": "wrench",
    "mass": "1.3kg",
    "count": "3"
  }
}

詳細設定を使用して、ファイルにカスタム プロパティを追加することもできます。 Google Apps Script のドライブ サービス。詳細については、次をご覧ください: カスタム プロパティをご覧ください。

カスタム ファイル プロパティを取得または一覧表示する

すべてのアプリケーションに表示されるプロパティを表示するには、 files.get メソッドで取得し、 ファイルのカスタム ファイル プロパティ。

GET https://www.googleapis.com/drive/v3/files/FILE_ID?fields=properties

レスポンスは、properties オブジェクトで構成されます。このオブジェクトには、 Key-Value ペアです。

{
  "properties": {
    "name": "wrench",
    "mass": "1.3kg",
    "count": "3"
  }
}

カスタム ファイルのプロパティを削除する

すべてのアプリケーションに表示されるプロパティ値を削除するには、 files.update メソッドを使用して、 files の properties フィールド null に変更してください。

PATCH https://www.googleapis.com/drive/v3/files/FILE_ID
{
  "name": null
}

変更を表示するには、 files.get メソッドで取得し、 ファイルの properties オブジェクト。

{
  "properties": {
    "mass": "1.3kg",
    "count": "3"
  }
}

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

カスタム プロパティには次の制限があります。

  • カスタム プロパティの最大数はファイルごとに 100 個（すべてのソースからの合計）です。
  • 公開プロパティの数は、すべてのソースから合計で 1 ファイルあたり 30 個までです。
  • 1 つのアプリケーションから、1 つのファイルに最大 30 個の非公開プロパティを使用できます。
  • プロパティ文字列（キーと値の両方を含む）あたり最大 124 バイト UTF-8 エンコード。たとえば、プロパティにキーの長さが 10 文字あるとします。 値は 114 文字以内にする必要があります。同様に 必要な文字は 100 文字、値には最大で 24 文字 ] キーを押します。

詳細については、files をご覧ください。 リソースです。Drive API v2 については、 properties リソース。

限定公開のカスタム ファイルのプロパティにアクセスする

非公開プロパティを取得するには、appProperties フィールドを使用する必要があります。 OAuth 2.0 で取得したアクセス トークンを使用する認証済みリクエスト できます。API キーを使用して非公開プロパティを取得することはできません。