サポート サポートへのお問い合わせ | システムステータス システムステータス
ページコンテンツ

    CMSとビデオクラウドの統合

    このトピックでは、Brightcove ブ Video Cloud と CMS の統合に関する基本的な操作について説明します。CMS 内でユーザが実行する一般的な関数と、その機能を提供するために使用できる Brightcove API オペレーションの一覧を示します。

    ユーザ関数

    以下は関連する機能ですVideo Cloud CMSのユーザーに提供したい場合があります。

    • 新しいビデオを追加するVideo Cloud
    • 交換してくださいVideo Cloud新しいバージョンのビデオ
    • タイトル、説明、タグなどの動画のメタデータを更新する
    • 動画を削除する
    • プレイリストを作成する
    • プレイリストの動画を変更する
    • プレイリストの削除
    • ビデオプレーヤーを作成する
    • 寸法やスタイリングなど、ビデオプレーヤーのプロパティを変更する
    • プラグインを通じてビデオプレーヤーに特別な機能を追加する
    • 単一の動画または再生リストを公開
    • 動画のロード、視聴回数、再生率、エンゲージメントなどの分析データを提供します。

    エンドユーザーにこの機能をすべて公開したくない場合があります。たとえば、エンドユーザーに動画を削除させたくない場合があります。統合の利点の1つVideo Cloudユーザーが直接アクセスできるようにするのではなく、CMSを使用するVideo Cloud Studioは、BrightcoveAPIを介してユーザーに公開する機能を正確に選択できることです。

    認証

    すべてのBrightcove ブ API リクエストについて、認証は OAuth2 アクセストークンに基づいて行われます。アクセストークンの取得には、次の 2 つの手順があります。

    1. 必要な API オペレーションのアクセス許可を持つクライアント認証情報を作成する
    2. クライアントの認証情報を使用して一時的なアクセストークンを作成し、API リクエストを認証する

    クライアント認証情報の作成

    クライアント資格情報の作成は、次の方法で実行できる1回限りの操作です。Video CloudスタジオまたはOAuth API。どのようにそれをするにしても、client_idそしてclient_secretが返されます。アクセストークンをリクエストするには、これを保存する必要があります。

    アクセストークンの作成

    一時アクセストークンは、OAuth API。ザ・client_idそしてclient_secret BASE64でエンコードし、として渡す必要がありますBasic認証文字列。

    access_token返されたは、API 呼び出しで Authorization ヘッダーに渡されます。

        >Authorization: Bearer your_access_token
        
        

    アクセストークンは5分間有効です。何百もの連続するAPI呼び出しを行うバッチ操作を実行していない限り、タイムアウトを追跡するのではなく、API呼び出しごとに新しいものをリクエストするだけで理にかなっています。

    動画の追加

    ユーザーが動画を追加できるようにする場合Video Cloud CMSから、を使用してそれを行うことができますDynamic Ingest API。ユーザーは、S3 バケットまたはパブリック向けサーバーのみであるリポジトリに動画をアップロードすることをお勧めします。ダイナミックインジェストシステムは、ビデオをプルして、Video Cloud以下に概説する2段階のプロセスを介してシステム。

    にビデオオブジェクトを追加するVideo Cloud

    最初のステップは、でビデオオブジェクトを作成することですVideo Cloudシステムを作ることによってPOSTにリクエストCMS API

        https://cms.api.brightcove.com/v1/accounts/:account_id/videos
        
        

    リクエストの本文には、基本的な動画のプロパティが含まれますJSONオブジェクト-最低限、ビデオname、ただし、次のような追加のメタデータを含めることもできますdescriptionそしてtags

        {
        "name": "Woodpecker",
        "description": "A bird that hunts insects inside wood",
        "reference_id": "Bird_Woodpecker.mp4",
        "tags": ["bird", "air", "nature"]
        }
        
        

    ビデオの取り込み

    ビデオオブジェクトを作成すると、CMS APIを返しますJSONビデオプロパティを含むオブジェクト。ビデオを抽出しますidからJSON、およびそれを使用してDynamic Ingest APIビデオの取り込みとトランスコーディングを要求するには:

        https://ingest.api.brightcove.com/v1/accounts/ACCOUNT_ID/videos/VIDEO_ID/ingest-requests
        
        

    もう一度送信しますJSONビデオファイルの場所を指定するリクエスト本文で:

        {
          "master":{
            "url":"http://learning-services-media.brightcove.com/videos/mp4/Bird_Woodpecker.mp4"
          },
          "profile":"multi-platform-extended-static",
          "capture-images": true
        }
        
        

    profileここには、トランスコーディングプロセスで作成されるレンディションを指定するインジェストプロファイルがあります。ほとんどの場合、次の標準プロファイルのいずれかで十分です。

    動的配信プロファイル

    • multi-platform-extended-static
    • multi-platform-standard-static

    従来の取り込みプロファイル

    • videocloud-default-v1 (the default)
    • screencast-1280
    • smart-player-transition
    • single-bitrate-high
    • audio-only
    • single-bitrate-standard
    • high-resolution

    ただし、必要に応じて、を使用して追加のカスタム取り込みプロファイルを作成できます。Ingest Profiles APIまたは使用Video Cloudスタジオ

    ポスターとサムネイル画像を追加する

    ザ・capture-images上記のコードのオプションは指示しますVideo Cloudトランスコーディングプロセスの中間点でビデオのポスターとサムネイル画像をキャプチャします。または、ビデオの取り込みと同時に、capture-imagesまたは後でイメージをに設定して取り込むこともできます。false

        {
        "master":{
        "url":"http://learning-services-media.brightcove.com/videos/mp4/Bird_Woodpecker.mp4"
        },
        "profile":"multi-platform-extended-static",
        "capture-images": false,
        "poster": {
        "url": "http://learning-services-media.brightcove.com/images/for_video/titmouse-poster.png",
        "width": 640,
        "height": 360
        },
        "thumbnail": {
        "url": "http://learning-services-media.brightcove.com/images/for_video/titmouse-thumbnail.png",
        "width": 160,
        "height": 90
        }
        }
        
        

    詳細については、「イメージ」および「」を参照してください。Dynamic Ingest API

    キャプションまたはチャプター用のテキストトラックの追加

    を使用して、 WebVTT ファイルのテキストトラックを、取り込み時または後でビデオに追加することもできます。Dynamic Ingest APIテキストトラックは追加に使用されますキャプションまたはチャプタービデオに。

        {
        "master":{
        "url":"http://learning-services-media.brightcove.com/videos/mp4/Bird_Woodpecker.mp4"
        },
        "profile":"multi-platform-extended-static",
        "capture-images": false,
        "poster": {
        "url": "http://learning-services-media.brightcove.com/images/for_video/titmouse-poster.png",
        "width": 640,
        "height": 360
        },
        "thumbnail": {
        "url": "http://learning-services-media.brightcove.com/images/for_video/titmouse-thumbnail.png",
        "width": 160,
        "height": 90
        },
        "text_tracks": [
        {
        "url": "http://learning-services-media.brightcove.com/captions/for_video/Water-in-Motion.vtt",
        "srclang": "en",
        "kind": "captions",
        "label": "English",
        "default": true
        }
        ]
        }
        
        

    詳細については、 WebVTT ファイルの取り込みを参照してください

    ビデオを管理する

    CMS APIでは、アカウントのビデオデータを取り戻すことができます。(上記のように、ビデオ取り込みプロセスの一環としてビデオオブジェクトを作成するためにも使用されます)。最も基本的な要求は次のとおりです。

        https://cms.api.brightcove.com/v1/accounts/account_id/videos
        
        

    デフォルトでは、このリクエストはJSON名前、説明、タグ、カスタムフィールド、作成日と最終変更日、ポスターとサムネイルのURLなど、豊富なメタデータを含む20個のビデオオブジェクトの配列。

    リクエストに次のパラメーターを 1 つ以上追加することで、リクエストの結果を絞り込むことができます。

    limit
    これは、返すビデオオブジェクトの数を決定し、100以上の任意の数に設定することができます-デフォルトは20です
    offset
    これは、スキップする項目の数を決定するので、limitビデオカタログのページに移動するために一緒に使用されます-デフォルトは0です
    sort
    これは、結果をソートする動画のメタデータフィールドを決定します-デフォルトでは、結果は順にソートされますupdated_at(降順、最後に更新された動画が最初に表示されます)

    これらのパラメータの詳細は、「CMS API概要-パラメータ」を参照してください。

    動画を検索する

    qパラメーターを使用して、さまざまな基準で動画を検索することもできます。名前、説明、タグ、日付や動画の状態などの特定のフィールドで検索できます。

        https://cms.api.brightcove.com/v1/accounts/account_id/videos?q=tags:sea,mammal
        
        

    詳細と検索のすべてのオプションについては、「ビデオの検索」を参照してください。

    特定の動画の取得と更新

    特定の動画を ID または参照 ID で取得するには:

        https://cms.api.brightcove.com/v1/accounts/account_id/videos/id
        or
        https://cms.api.brightcove.com/v1/accounts/account_id/videos/ref:reference_id
        
        

    GETリクエストは、ビデオオブジェクトを返します。更新するには、JSONを変更して、同じ URL PATCHへのリクエストを使用して返します。

    プレイリスト

    プレイリスト情報は、ビデオ情報とほぼ同じ方法でを使用して管理されます。CMS APIご了承くださいVideo Cloud 2つのカテゴリで8種類のプレイリストをサポートします。

    手動 (またはEXPLICIT ) プレイリスト
    指定された動画セットを含む-最大 100 本の動画を含めることができます。
    スマートプレイリスト
    検索条件に基づいて実行時に動的に構築されます。リスト内での動画の順序付け方法に対応するスマートプレイリストの7種類があります。
    • ACTIVATEDOLDESTTONEWEST
    • ACTIVATEDNEWESTTOOLDEST
    • ALPHABETICAL
    • PLAYSTOTAL
    • PLAYSTRAILINGWEEK
    • STARTDATEOLDESTTONEWEST
    • STARTDATENEWESTTO_OLDEST

    動画数の制限は、100までの任意の数に設定できます。

    動画と同様に、を使用してすべての再生リストを取得できますlimitそしてoffsetアカウントに多数のプレイリストがある場合に結果をページングするには:

        https://cms.api.brightcove.com/v1/accounts/account_id/playlists
        
        

    返されたプレイリストオブジェクトの配列には、type上記のタイプに対応するを含む、プレイリストのメタデータが含まれます。型がの場合EXPLICIT、含まれる動画の ID video_idsを含む配列もあります。タイプがスマートプレイリストのタイプの 1 つである場合、search動画を取得する検索文字列を含むプロパティがあります。

        q=tags:fish,birds
        
        

    以下の操作で、1 つのプレイリストを取得することもできますid

        https://cms.api.brightcove.com/v1/accounts/account_id/playlists/playlist_id
        
        

    再生リストの完全なビデオオブジェクトを取得する必要がある場合(ページ上のビデオに関する情報を表示するには)、/videosそのURLに追加するだけです。

        https://cms.api.brightcove.com/v1/accounts/account_id/playlists/playlist_id/videos
        
        

    スマートプレイリストの場合、リクエストは現在、検索条件に一致する動画を返しますが、変更される可能性があります。

    プレーヤを作成する

    Brightcoveプレーヤーは、Player Management API。API を使用すると、プレーヤーの作成、プロパティの更新、URL、iframeタグ、または HTML ブロックの形式で埋め込みコードを取得してページに埋め込むことができます。

    アカウントごとに最大200人のプレイヤーが可能ですが、通常は必要な数のプレイヤーを持つことがユーザーにとって混乱しにくくなります。単一のビデオやプレイリストを再生するには、別々のプレーヤーを用意する必要がありますが、そうでない場合は、異なるスタイルを設定したり、プラグインを通じて異なる機能を追加したりする場合にのみ、異なるプレーヤーが必要です。

    プレーヤーを作成するには、単にPOSTにリクエストPlayer Management API

        https://players.api.brightcove.com/v2/accounts/account_id/players
        
        

    リクエストの本文には、プレイヤーの設定を含めますname必要なのは以下だけです。

        {
        "name": "Single video player for blog posts"
        }
        
        

    応答は、プレイヤーIDと複数のフォームの埋め込みコードを提供します:

        {
        "embed_code": "<iframe src='//players.brightcove.net/57838016001/de055fa4-4f09-45af-8531-419c6794ad04_default/index.html' allowfullscreen webkitallowfullscreen mozallowfullscreen></iframe>",
        "embed_in_page": "http://players.brightcove.net/57838016001/de055fa4-4f09-45af-8531-419c6794ad04_default/in_page.embed",
        "id": "de055fa4-4f09-45af-8531-419c6794ad04",
        "preview_embed_code": "<iframe src='//preview-players.brightcove.net/v1/accounts/57838016001/players/de055fa4-4f09-45af-8531-419c6794ad04/preview/embeds/default/master/index.html' allowfullscreen webkitallowfullscreen mozallowfullscreen></iframe>",
        "preview_url": "http://preview-players.brightcove.net/v1/accounts/57838016001/players/de055fa4-4f09-45af-8531-419c6794ad04/preview/embeds/default/master/index.html",
        "url": "http://players.brightcove.net/57838016001/de055fa4-4f09-45af-8531-419c6794ad04_default/index.html"
        }
        
        

    完全なプレーヤー設定を取得するには、/playersエンドポイントにリクエストを行いますが、上記の応答で返されるプレーヤー ID を追加します。

        https://players.api.brightcove.com/v2/accounts/account_id/players/de055fa4-4f09-45af-8531-419c6794ad04
        
        

    プレイヤーの設定を更新するために、PATCH同じエンドポイントにリクエストを行うことができます。

    上記のレスポンス、preview_embed_codeおよびに気づくでしょうpreview_url。新しいプレーヤーやプレーヤーの更新をテストするために、新しく作成または更新されたプレーヤーはプレビューモードに設定され、既存のプレイヤーに変更をプッシュする前に確認することができます。変更をプロダクションにプッシュするには、次のリクエストでプレイヤーを公開する必要があります

        https://players.api.brightcove.com/v2/accounts/account_id/players/de055fa4-4f09-45af-8531-419c6794ad04/publish
        
        

    プレーヤーのカスタマイズ

    Brightcove ブプレーヤーは、標準的なウェブテクノロジーを使用して構築されています。HTML、CSS、およびJavaScript。これらの同じ技術を使用してプレーヤーをカスタマイズできます。これは、プレーヤーが公開されているページで実行できますが、ベストプラクティスは、プレーヤーを介してプレーヤー自体にカスタマイズを追加することです。構成、を介してプレーヤーを更新するPATCHにリクエストPlayer Management API前のセクションで説明したように。

    を介してプレーヤーに機能を追加することもできますJavaScriptプラグイン、および広範なプレーヤーAPIコードをプレーヤーと統合するのに役立ちます。Brightcove ブでは、広告の有効化、エンドスクリーンのカスタマイズ、オーバーレイの追加など、既製のプラグインを多数提供しています。

    動画を公開する

    の中にプレーヤーの作成セクション上記では、を使用してプレーヤー構成オブジェクトを取得すると、Player Management API、返されるデータには、プレーヤーをHTMLページに埋め込むためのiframeタグと、プレーヤーをページに直接埋め込む場合は完全なHTMLのURLが含まれます。

    どちらの埋め込みを選択した場合でも、を追加する必要がありますVideo Cloudプレーヤーにコンテンツを追加するための埋め込みコードへのビデオIDまたはプレイリストID。iframe埋め込みコードは次のようになります。

        <iframe
        src='//players.brightcove.net/57838016001/de055fa4-4f09-45af-8531-419c6794ad04_default/index.html'
        allowfullscreen webkitallowfullscreen mozallowfullscreen></iframe>
        
        

    プレーヤーのURLには、完全な埋め込みコードは次のようになりますvideoId={}video_id、パラメータを追加する必要があります。

        <iframe
        src='//players.brightcove.net/57838016001/de055fa4-4f09-45af-8531-419c6794ad04_default/index.html?videoId=4483119716001'
        allowfullscreen webkitallowfullscreen mozallowfullscreen></iframe>
        
        

    これがプレイリストプレーヤーの場合は、playlistId={playlist_id}代わりにパラメーターを使用します。ページ内埋め込みコードの変更も同様です。

    プレーヤーの寸法がプレーヤー構成で固定されていない限り、style属性に幅と高さを追加してプレーヤーのサイズを設定する必要もあります。

        <iframe
        src='//players.brightcove.net/57838016001/de055fa4-4f09-45af-8531-419c6794ad04_default/index.html?videoId=4483119716001'
        allowfullscreen webkitallowfullscreen mozallowfullscreen
        style=width:640px;height:360px;></iframe>
        
        

    分析レポートの取得

    Analytics APIでは、dimensionsさまざまな分析レポートを生成できます。詳細は、寸法ガイドを参照してください

    レポートの日付範囲、返されるメトリックを指定でき、データを取得できます。JSONcsv、またはxlxsフォーマット

    先月内の期間については、動画の 100 分ごとの視聴回数を表示する詳細なエンゲージメントレポートを生成することもできます

    APIのまとめ

    との統合に役立つAPIの概要は次のとおりですVideo Cloud

    OAuth API
    他の API にアクセスするためのクライアント資格情報およびアクセストークンを作成するために使用されます。
    メディア管理
    Ingest Profiles API
    追加されたビデオに対して作成されるレンディションを指定するカスタム取り込みプロファイルを作成するために使用されますVideo Cloud
    Dynamic Ingest API
    ビデオおよび関連するメディアアセットをに追加するために使用されますVideo Cloud
    CMS API
    取り込み用のビデオオブジェクトを作成したり、動画や再生リストを管理したりするために使用します。
    Brightcove プレーヤ
    Brightcove ブプレーヤー
    プレーヤーにはJavaScript実行時にプレーヤーと対話するためのAPI
    Player Management API
    プレーヤーを作成および設定し、プレーヤーの埋め込みコードを取得するために使用されます
    Analytics API
    動画のパフォーマンスに関する分析レポートを取得するために使用します