Media API でカスタム メタデータを設定する

カスタム メタデータが利用できるのは、Brightcove Pro および Enterprise のみです。Brightcove アカウントのアップグレードについては、Brightcove にお問い合わせください。

Brightcove アカウントのカスタム メタデータを設定したら、動画のカスタム メタデータ フィールドに値を設定できます。Media モジュール、FTP バッチ プロビジョニング、または Media API を使用し、動画のメタデータを設定し、読み取ることができます。このトピックでは、Media API を使用して動画に対してカスタム メタデータを設定し、取得する方法について説明します。

事前確認事項

動画に対してカスタム メタデータを設定する前に、アカウントで使用するカスタム メタデータ フィールドを設定する必要があります。カスタム メタデータ フィールドの設定方法を参照してください。

Media API の書き込みメソッドでカスタム メタデータを設定する

動画のカスタム メタデータを設定するには、create_video または update_video メソッドを使用します。カスタム メタデータは、Video オブジェクトの customFields プロパティに、一連のフィールド名と値のペアとして含まれています。たとえば、genre および rating という名前のカスタム メタデータ フィールドを持つ動画を作成する JSON は、次のようになります。

{"method":"create_video",
"params" :{"token" :"riBfgveLvpRb-rHGiBBouSAXs-Q8NmphGxt0z04kE.",
"video" :{"id":38,"name":"Cookies!","shortDescription":"yumyumyumyum tasty!",
"customFields":{"genre":"Martial Arts","rating":"TV-Y7"}},
"filename":"miamiMoon.mp4",
"create_multiple_renditions" :true}}

Media API 読み込みメソッドでカスタム メタデータを取得する

カスタム メタデータを含む動画を取得するときに、希望のフィールド名を持つオプションの custom_fields 引数を渡すことでカスタム メタデータ値を取得することができます。

command=find_all_videos&custom_fields=genre

要求したカスタム フィールドは、JSON では次のように返されます。

"customFields":{"genre":"Martial Arts"}

さらに、customFields を video_fields 引数の値として含めることにより、すべてのカスタム フィールドを取得することができます。

command=find_all_videos&video_fields=name,shortDescription,customFields

指定のカスタム フィールドに値がない場合は、そのフィールドは返されません。たとえば、「fruit」および「vegetable」という名前の 2 つのカスタム フィールドがあり、「fruit」を「kumquat」に、「vegetable」を「null」にそれぞれ設定した場合は、video_fields=customFields に対して返される値は

{"fruit":"kumquat"}

であり、次の値ではありません。

{"fruit":"kumquat","vegetable":null}