Drive API v2 と v3 の比較ガイド

Google Drive API の最新バージョンは v3 です。v3 では、検索で返されるフィールドのサブセットのみが返されるため、パフォーマンスが向上しています。v2 コレクションが必要な場合を除き、現在のバージョンを使用してください。v2 を使用している場合は、v3 への移行をご検討ください。移行については、Drive API v3 に移行するをご覧ください。バージョンの違いの一覧については、 Drive API v2 と v3 の比較 リファレンスをご覧ください。

v2 を引き続き使用する場合は、Drive API v2 の修正に関するガイドをご覧ください。v3 ガイドの一部の手順を v2 デベロッパー向けに修正する方法について説明しています。

Drive API v3 の改善について詳しくは、Google のエンジニアが新しい API 設計について説明している次の動画をご覧ください。

v3 の改善点

パフォーマンスを最適化し、API の動作の複雑さを軽減するため、v3 では以前の API バージョンから次のように改善されています。

  • ファイルと共有ドライブの検索では、デフォルトで完全なリソースは返されず、よく使用されるフィールドのサブセットのみが返されます。 fields の詳細については、files.list メソッド と drives.list メソッドをご覧ください。
  • レスポンスを返すメソッドのほとんどで、fields パラメータが必要になりました。fields が必要なすべてのメソッドの一覧については、 Drive API リファレンスをご覧ください。
  • 重複する機能を持つリソースが削除されました。例:
    • files.list メソッドは Children コレクションと Parents コレクションと同じ機能を実行するため、v3 から削除されました。
    • Realtime.* メソッドが削除されました。
  • デフォルトでは、アプリデータは検索で返されません。v2 では、 drive.appdata スコープを設定すると、files.list メソッドと changes.list メソッドからアプリケーション データが返されますが、パフォーマンスが低下します。v3 では、drive.appdata スコープを設定し、クエリ パラメータ spaces=appDataFolder を設定してアプリケーション データをリクエストします。
  • すべての更新オペレーションで、PUT ではなく PATCH が使用されます。
  • Google ドキュメントをエクスポートするには、 files.export メソッドを使用します。
  • changes.list メソッドの動作が異なります。変更 ID ではなく、不透明なページトークンを使用します。変更コレクションをポーリングするには、まず changes.getStartPageToken メソッドを呼び出して初期値を取得します。以降のクエリでは、changes.list メソッドは newStartPageToken 値を返します。
  • 更新メソッドで、書き込み不可のフィールドを指定するリクエストが拒否されるようになりました。
  • `about` リソースの v2 exportFormats フィールドと importFormats フィールドは、許可されるインポートまたはエクスポート形式のリストです。aboutv3 では、サポートされているすべてのインポートまたはエクスポートに対するターゲットの MIME タイプのマップです。
  • v2 の appdata エイリアスと appfolder エイリアスは、v3 では appDataFolder になりました。
  • properties リソースが v3 から削除されました。 files リソースには、実際の Key-Value ペアを含む properties フィールド があります。properties フィールドには公開プロパティが含まれ、appProperties フィールドには非公開プロパティが含まれるため、visibility フィールドは必要ありません。
  • files リソースの modifiedTime フィールドは、最後にファイルを変更した時刻を更新します。v2 では、setModifiedDate フィールドを設定した場合にのみ、更新時に modifiedDate フィールドを変更できました。
  • files リソースの viewedByMeTime フィールドは自動的に更新されません。
  • Google ドキュメント形式をインポートするには、リソース本文で適切なターゲット mimeType を設定します。v2 では、?convert=true を設定します。
  • 形式がサポートされていない場合、インポート オペレーションは 400 エラーを返します。
  • 閲覧者とコメント投稿者は権限を表示できません。
  • 権限の me エイリアスが削除されました。
  • 一部の機能はリクエスト リソースの一部として使用できましたが、リクエスト パラメータとして使用できるようになりました。例:
    • v2 では、children.delete を使用して、親フォルダから子ファイルを削除できます。
    • v3 では、URL に ?removeParents=parent_id を指定して、子に対して files.update を使用します。

その他の相違点

v3 では、フィールド名とパラメータ名が異なります。以下にいくつか例を示します。

  • files リソースの title が name プロパティに置き換えられました。
  • すべての日付と時刻のフィールドの接尾辞が Date ではなく Time になりました。
  • リスト オペレーションでは、結果セットを格納するために items フィールドを使用しません。リソースタイプには、結果のフィールド（files や changes など）が用意されています。