サポート サポート問い合わせ先 | システムステータス システムステータス

ビデオクラウドをCMSと統合する

このトピックでは、Brightcoveの統合に関連する基本的な操作を学びます Video Cloud CMSで。 ユーザーがCMS内で実行する典型的な機能と、その機能を提供するために使用できるBrightcove APIオペレーションをリストします。

ユーザー機能

以下は、 Video Cloud CMSのユーザーに提供したいことがあります。

  • 新しい動画を追加する Video Cloud
  • aを交換する Video Cloud 新しいバージョンのビデオ
  • タイトル、説明、タグなどの動画のメタデータを更新する
  • 動画を削除する
  • プレイリストを作成する
  • プレイリスト内のビデオを変更する
  • プレイリストを削除する
  • ビデオを作成する players
  • ビデオを変更する player 寸法やスタイルなどのプロパティ
  • ビデオに特別な機能を追加する playerプラグインを介して
  • 単一の動画や再生リストを公開する
  • 動画の読み込み、再生回数、再生回数、エンゲージメントなどの分析データを提供する

この機能をすべてエンドユーザーに公開することは望ましくないかもしれません。例えば、ビデオを削除させたくないかもしれません。 統合の利点の1つ Video Cloud ユーザーが直接に行くのではなく、CMSで Video Cloud Studioは、Brightcove APIを通じてユーザーに公開する機能を正確に選択できることです。

認証

すべてのBrightcove APIリクエストについて、認証はOAuth2アクセストークンに基づいています。 アクセストークンを取得するためのXNUMXつのステップのプロセスがあります。

  1. 必要なAPI操作の権限を持つクライアントの資格情報を作成する
  2. クライアントの資格情報を使用して、APIリクエストを認証するための一時的なアクセストークンを作成する

クライアントの資格情報を作成する

クライアント資格情報を作成することは、 Video Cloud Studio または OAuth API 。 しかし、あなたはそれを行う、 client_idclient_secret アクセストークンを要求するために保存する必要があります。

アクセストークンの作成

一時アクセストークンは、 OAuth API client_idclient_secret BASE64でエンコードされ、a Basic 承認文字列。

挽き目 access_token API呼び出しでAuthorizationヘッダーに戻ります。

    >Authorization: Bearer your_access_token
    
    

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

動画を追加する

ユーザーに動画を追加できるようにする場合 Video Cloud あなたのCMSから、あなたはそれを行うことができます Dynamic Ingest API 。 リポジトリには、S3バケットや一般公開サーバだけの動画をアップロードさせることをお勧めします。 Dynamic Ingestシステムは、ビデオを引き込み、 Video Cloud システムに、以下に説明する2つのステップのプロセスを実行します。

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

最初のステップは、ビデオオブジェクトを Video Cloud システムを POSTCMS API:

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

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

    {
    "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 ここでは、トランスコードプロセスで作成するレンディションを指定するIngest 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 Studio.

ポスター画像とサムネイル画像の追加

挽き目 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 詳細はこちら

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

使用することもできます Dynamic Ingest API テキストトラックを追加する WebVTT 摂取時またはそれ以降のいずれかで、ファイルを動画に追加します。 テキストトラックを使用して追加する キャプション or ビデオへ。

    {
    "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
    
    

デフォルトでは、この要求はaを返します。 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
    
    

A GET 要求はビデオオブジェクトを返します。 それを更新するには、 JSON それを返す PATCH 同じURLへのリクエスト。

プレイリスト

プレイリスト情報も、 CMS API ビデオ情報とほとんど同じように。 ご了承ください Video Cloud 次の2つのカテゴリの8種類のプレイリストをサポートしています。

マニュアル(または EXPLICIT)プレイリスト
指定されたビデオセットを含む - 100までのビデオが含まれる
スマートプレイリスト
検索基準に基づいて実行時に動的に構築されます - スマートプレイリストには、リスト内でのビデオの並べ方に対応する7種類があります。
  • ACTIVATEDOLDESTTONEWEST
  • ACTIVATEDNEWESTTOOLDEST
  • ALPHABETICAL
  • PLAYSTOTAL
  • PLAYSTRAILINGWEEK
  • STARTDATEOLDESTTONEWEST
  • STARTDATENEWESTTO_OLDEST

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

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

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

返されたプレイリストオブジェクトの配列には、プレイリストのメタデータが含まれます。 type 上記のタイプのうちの1つに対応する。 タイプが EXPLICIT、また video_ids 含まれている動画のIDを含む配列。 タイプがスマートプレイリストタイプの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
    
    

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

作成 Players

Brightcove playersは Player Management API 。 APIを使用すると、 players、それらのプロパティを更新し、埋め込みコードをURL、 iframe タグ、またはHTMLブロックをページに埋め込むことができます。

最大200まで playerアカウントごとにsですが、一般的にユーザーが少ないので混乱が少なくなります。 player必要に応じて。 あなたは別々に持っているべきです player単一の動画または再生リストを再生するためのs player■スタイルが異なる場合、またはプラグインを介して異なる機能が追加される場合。

作成するには player、あなたは単に POSTPlayer Management API:

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

要求の本文には、 player の監視 必要なのは、 name:

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

応答はあなたに与えます player 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"
    }
    
    

いっぱいになるには player 構成、あなたはにリクエストを行います /players エンドポイント、ただし追加 player 上記の応答で返されるID:

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

あなたは PATCH 同じエンドポイントにリクエストして、 player 構成。

あなたは上記の反応で気づくでしょう。 preview_embed_codepreview_url。 新しいのテストを許可するには playersまたは player 更新、新しく作成または更新 playersはプレビューモードに設定されており、既存の変更をプッシュする前に確認できます。 players。 変更を本番環境にプッシュするには、 パブリッシュ インクルード player このリクエストでは:

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

カスタマイズ Players

挽き目 Brightcove Player 標準的なWebテクノロジー、HTML、CSS、および JavaScript。 あなたはカスタマイズすることができます player 同じテクノロジーを使用しています。 これは、 player は公開されていますが、ベストプラクティスは、カスタマイズを player それ自体を通して player の監視、更新 player 人生 PATCHPlayer Management API 前のセクションで説明したとおりです。

に追加の機能を追加することもできます player : JavaScript プラグイン、そして広範な Player API コードを player。 Brightcoveは、広告の有効化、エンドスクリーンのカスタマイズ、オーバーレイの追加など、既成のプラグインを多数提供しています。

ビデオの公開

の中に 作成 Playersセクション 上記では、あなたが取得したときにそれを見ました player を使用した構成オブジェクト Player Management API、返されるデータには、 player HTMLページ内、および埋め込みたい場合は完全なHTMLのURL player ページ内で直接。

任意の埋め込みを選択するには、aを追加する必要があります Video Cloud ビデオIDまたは再生リストIDを埋め込みコードに追加して、コンテンツを player。 iframe埋め込みコードは次のようになります。

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

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

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

これがプレイリストの場合 player、あなたはパラメータを使用します playlistId={playlist_id} 代わりに。 ページはめ込みコードの変更は似ています。

を除いて player 寸法は player 構成、あなたはまた、サイズを設定する必要があります player に幅と高さを追加することにより 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レポートの取得

挽き目 Analytics API さまざまな方法で分析レポートを生成できます dimensions。 見る 寸法ガイド 詳細については。

レポートの日付範囲と返されるメトリックを指定することができます。 JSON, csvまたは xlxs フォーマット

先月の期間については、詳細を生成することもできます Engageメントレポート ビデオの100分の1の部分ごとのビューを表示します。

APIの概要

ここでは、 Video Cloud.

OAuth API
他のAPIにアクセスするためにクライアントの資格情報とアクセストークンを作成するために使用されます。
メディア管理
Ingest Profiles API
追加されたビデオに作成されるレンディションを指定するカスタムのインジェストプロファイルを作成するために使用されます。 Video Cloud
Dynamic Ingest API
動画や関連するメディア資産を Video Cloud
CMS API
取り込みのためのビデオオブジェクトの作成、ビデオやプレイリストの管理に使用されます。
Brightcove Players
挽き目 Brightcove Player
挽き目 player 含ま JavaScript と対話するAPI player 実行時に
Player Management API
作成および構成に使用 players、そして取得する player 埋め込みコード
Analytics API
動画の掲載結果に関するアナリティクスレポートの取得に使用されます

ページの最終更新日:12年2020月XNUMX日