レビューリンクの操作

概要

レビューリンクは、明示的なチームまたはプロジェクトアクセスを必要とせずに、1 個の URL を介してアセットを収集し、フィードバック用に送信するための主要な Frame.io 機能です。基本的に、これは、1 個のプロジェクト内のアセットの表現なので、このガイドでは、次を想定しています。

1. アセットが手元にあるか、API を介したアセットのアップロードに精通しているかのいずれか。
2. レビューリンクを作成するプロジェクトの ID がわかっている。
3. 目標は、Frame.io の外部で（メール、チャット、または他の送出を介してなど）配布できる URL を作成することです。

主要な概念

レビューリンクは、厳密にはプロジェクトに属しており、レビューリンク内のアセットは、レビューリンク項目と呼ばれる特別なリソースタイプとして表されます。レビューリンク項目には、参加しようとする review_link_id と asset_id 、および関連付けられているアセットのペイロード全体が常に含まれています。

レビューリンク項目は、単独でトラッキングまたは管理する必要はありませんが、このガイドでキャプチャされるワークフロー全体を理解するのに役立つ構造です。したがって、レビューリンクの階層ファミリーは、次のようになります。

プロジェクト／レビューリンク／レビューリンク項目／アセット参照

必要なスコープ

このガイドを開始する前に、少なくとも次のスコープを含むトークンがあることを確認してください。

1.ID の収集

レビューリンクを作成するには、次を収集する必要があります。

1. プロジェクト ID
2. そのプロジェクト内の 1 個または複数のアセットの ID

プロジェクト ID が手元になくても、Frame.io にアクセスでき、使用するプロジェクトがわかっている場合は、プロジェクトに移動すると、次のようにアドレスバーに ID が表示されます：https://app.frame.io/projects/<project-id>。

同様に、アセット ID が手元にない場合は、目的のアセットに移動し、次のようにブラウザーのアドレスバーから ID を取り込みます：https://app.frame.io/player/<asset-id>。

2.レビューリンクの作成

リンクのベースを作成するには、目的のレビューリンクオプションを特定し、JSON ペイロードに組み込むことが必要になります。少なくとも、name を思いつくことが必要になります。

ペイロードの例を次に示します。便宜上、name のみで生成することを選択した場合、各フィールドのデフォルトが表示されます。

1
{    
2
    "name": "New Review Link",
3
    "allow_approvals": true,
4
    "current_version_only": false,
5
    "enable_downloading": true,
6
    "expires_at": null,
7
    "has_password": false
8
}

次に、ペイロードをリクエスト本文として使用して、承認済み POST https://api.frame.io/v2/projects/:id/review_links を作成します。

完了しました。レビューリンクを作成しました。応答本文には、次のような 2 つの重要な属性が表示されます。

• id：これは、リンクコンテナへの参照です。次のステップでアセットを追加するときに必要になるので、そのままにしておきます。
• short_url：これは、最終的に配布するレビューリンクの URL です。https://f.io/_aBcDeF のようなものに見えます

3.アセットをレビューリンクに追加

これで、レビューリンクが作成されました。次に、いくつかのアセットを追加します。まず、アセット id の文字列配列を含んだ JSON ペイロードを準備します。

1
{
2
    "asset_ids":[
3
        "<asset-id-1>",
4
        "<asset-id-2>",
5
        "<asset-id-3>"
6
    ]
7
}

次に、パスにステップ 2 のレビューリンク id、リクエスト本文にアセット id を使用して、https://api.frame.io/v2/review_links/:id/assets への承認済み POST を作成します。

これで完成です。これで、short_url を配布する準備ができました。