承認機能を管理する

このドキュメントでは、Google Drive API で承認を管理する方法について説明します。

コンテンツの承認は Google ドライブで確認できます。Google Drive API には approvals リソースが用意されており、承認のステータスを取得して一覧表示できます。approvals リソースのメソッドは、ドライブ、Google ドキュメント、その他の Google Workspace エディタ内のアイテムで動作します。

このプロセスを使用すると、契約の審査や公開前の公式文書など、正式な審査が必要な状況で承認を見つけることができます。承認では、レビューのステータス(進行中、承認済み、不承認など)と、関与するレビュー担当者の両方が追跡されます。承認は、コンテンツを検証し、レビュー担当者の記録を保持する優れた方法です。

ファイルの承認を表示するには、ファイルのメタデータを読み取る権限が必要です。詳細については、ロールと権限をご覧ください。

fields パラメータを使用する

レスポンスで返すフィールドを指定する場合は、approvals リソースの任意の方法で fields システム パラメータを設定できます。fields パラメータを省略すると、サーバーはメソッドに固有のデフォルトのフィールド セットを返します。別のフィールドを返すには、特定のフィールドを返すをご覧ください。

承認を得る

ファイルに対する承認を取得するには、fileId パスパラメータと approvalId パスパラメータを指定して、approvals リソースの get メソッドを使用します。承認 ID がわからない場合は、list メソッドを使用して承認を一覧表示できます。

レスポンスの本文には、approvals リソースのインスタンスが含まれます。

承認を一覧表示する

ファイルの承認を一覧表示するには、approvals リソースの list メソッドを呼び出し、fileId パス パラメータを含めます。

レスポンス本文は、ファイルに対する承認のリストで構成されます。items フィールドには、approvals リソースの形式で各承認に関する情報が含まれます。

approvals リソースには、承認のステータスを詳しく説明する Status オブジェクトと、特定の審査担当者による承認に対する回答を詳しく説明する ReviewerResponse オブジェクトも含まれています。この審査担当者の回答は、Response オブジェクトで表されます。

次のクエリ パラメータを渡して、承認のページネーションをカスタマイズしたり、承認をフィルタしたりすることもできます。

  • pageSize: ページごとに返す承認の最大数。pageSize を設定しない場合、サーバーは最大 100 件の承認を返します。

  • pageToken: 前回のリスト呼び出しから受け取ったページトークン。このトークンは、次のページを取得するために使用されます。前のレスポンスの nextPageToken の値に設定する必要があります。