Media API によるメディア共有

Product
Video Cloud
対象となる役割
開発者
バージョン
Brightcove 5
モジュール
Media API
エディション
Pro, Enterprise

メディア共有は Brightcove の機能の 1 つで、パブリッシャが他のパブリッシャと動画を共有することができ、複数のアカウントにまたがる動画の管理が容易になります。このトピックでは、Media API を使用して動画を共有する方法を説明します。概要情報については、次のトピックを参照してください。

メディア共有機能が利用できるのは、複数のアカウントを持つ Brightcove Pro エディションまたは Enterprise エディションをご利用の方のみです。Brightcove アカウントのアップグレードについては、Brightcove にお問い合わせください。

share_video メソッド

Brightcove Media API には share_video というメソッドがあり、アフィリエイトと動画を共有するために使用します。share_video のシグネチャは以下のとおりです。

share_video(token:String, video_id:Long, sharee_account_ids:Long[],
            auto_accept:Boolean, force_reshare:Boolean):Long

share_video メソッドを使用するには、以下を渡します。

  • Media API の書き込みトークン
  • 共有する動画の ID
  • 動画を共有するアフィリエイトの Brightcove アカウント ID。ID はコンマで区切ります。
  • さらに必要に応じて、アフィリエイトのアカウントが共有動画を自動的に受け入れるように構成されている場合は、auto_accept=true を設定します。
  • オプションで、アフィリエイトのアカウントにある既存バージョンの動画を共有動画が上書きすることを希望する場合は、force_reshare=true を設定します。

たとえば、ID が 123 の動画を、Brightcove アカウント ID が 456 と 789 のアフィリエイト 2 件と共有するには、以下のような内容を http://api.brightcove.co.jp/services/post にポストします。

{"method": "share_video",
    "params": {"token" : "riBfgveLvpRb-rHGiBBouSAXs-Q8NmphGxt0z04kE.",
               "video_id" : 123,
               "sharee_account_ids":[456,789]}}

ここをクリックすると、JavaScript、HTML フォーム、share_video メソッドを使用して、動画を共有するサンプル ページを表示します。

ここをクリックすると、このサンプルのソースコードを表示します。

共有動画の変更を変更する

共有した後に自分のアカウントにある動画を変更した場合、行った変更は、動画を共有したアカウントに自動的には反映されません。そのような以降の変更をアフィリエイトと共有するためには、share_video メソッドを使用して再び動画を共有する必要があります。デフォルトでは、アフィリエイトのアカウントと動画を共有しようとした際に、以前に共有したのでアフィリエイトのアカウントにすでにその動画がある場合、share_video メソッドは失敗します。自分のアカウントで共有動画を更新した(たとえば、より高品質のレンディションを追加した、またはメタデータを変更した)ので、アフィリエイトのアカウントにある共有動画にそれらのアップデートを適用したい場合、オプションの force_reshare=true 引数を使用してください。

force_reshare=true 引数を使用した場合、sharee_account_ids 引数にアカウント ID を記載したアフィリエイトの共有動画のみが更新されます。sharee_account_ids 引数に記載したアカウントの 1 つ以上で動画をまだ共有していない場合、force_reshare 引数に特別な効果はありません。その場合、動画は通常どおりに共有されます。

動画の共有を解除する

Brightcove アフィリエイトと動画を共有すると、Brightcove はアフィリエイトのアカウントに動画のコピーを追加します。その動画のアフィリエイトとの共有を止めたい場合は、unshare_video メソッドを使用してください。unshare_video メソッドは、共有していたアカウントから指定された動画を削除します。このメソッドには、共有を止める動画を指定するための video_id 引数、および指定した動画を削除するアカウントを指定するための sharee_account_ids 引数があります。共有動画が、指定した共有先アカウントに存在しない場合は、何も行われません。Media API リファレンスで unshare_video を参照してください

共有動画を削除する

delete_video メソッドには、オプションの delete_shares 引数があります。共有されている動画を削除するためには、delete_videodelete_shares="true" で呼び出す必要があります。これにより、アカウントから動画が削除されるとともに、すべての共有先アカウントからも動画が削除されます。delete_shares 引数はオプションですが、共有されている動画をこの引数なしで削除しようとすると、メソッドは失敗してエラーが発生します。

share_video のエラー メッセージ

share_video メソッドでは、以下のエラー メッセージが出ることがあります。

メッセージ 説明
The video specified was not found. 指定された動画 ID を持つ動画が、アカウント内に見つかりませんでした。
Invalid video id: null 動画 ID として null を渡しました。
Shared videos cannot be re-shared. アカウントが共有として取得した動画を共有しようとしました。動画をアップロードしたオリジナル アカウントのみが、動画を共有できます。
Invalid sharee account idx: ? value: null
(ここで ? は、渡したアカウント ID リスト内のインデックス)
共有先アカウント ID のいずれかとして、null が渡されました。
Sharing is not allowed to account: ?
(ここで ? はアカウント ID)
自分のアカウントと、アカウント ID を渡したアカウントの間で、共有関係が確立されていません。アカウント ID が正しくないか、自分のアカウントと共有先アカウントの間で共有がセットアップされていません。カスタマ サポートに連絡し、共有関係のセットアップを依頼します。

 

タグ
メディア共有, syndication