概要: EPG API

入門

EPG APIを使用すると、クラウドプレイアウトチャネルの電子番組ガイドを取得できます。クラウドプレイアウトチャネルはStudioで作成されます-を参照してくださいクラウドプレイアウトを使用したVODビデオのストリーミング詳細については。

認証

EPG APIはBrightcoveOAuthシステムリクエストとともに認証ヘッダーで渡されるアクセストークンを介してリクエストを認証するには、次のようにします。

Authorization: Bearer {access token}

アクセストークンは、OAuthAPIを使用して取得されます-を参照してくださいアクセストークンの取得詳細については。アクセストークンのリクエストを認証するには、クライアントの資格情報も必要です。これらはStudioの管理セクションで作成できます-を参照してくださいAPI資格情報の管理。資格情報がEPG APIに必要とする権限は次のとおりです。

APIURL

すべて取得クラウドプレイアウトチャネル

次のエンドポイントを使用して、アカウントのすべてのクラウドプレイアウトチャネルのリストを取得できます。

https://cm.cloudplayout.brightcove.com/accounts/{account_id}/cp_channels

ザ・account_id VideoCloudアカウントIDです。

EPGを取得する

EPG APIリクエストのURLは次のとおりです。

https://sm.cloudplayout.brightcove.com/accounts/{account_id}/channels/{channel_id}/epg

ザ・account_idはVideoCloudアカウントIDであり、channel_id Studioで作成されたチャンネルのIDです。

チャンネルのIDは、すべてのクラウドプレイアウトチャンネルを取得するリクエストへの応答、またはスタジオのクラウドプレイアウトセクションのチャンネルビューにいる場合はブラウザのURLにあります。

https://studio.brightcove.com/products/videocloud/cloudplayout/channel/2c73c2112f794e6eb80be1284a495674

リクエストパラメータ

次のオプションのクエリパラメータをEPGリクエストに追加できます。

EPG APIクエリパラメータ
パラメーター	デフォルト値	説明
`start`	`(14 days prior to now)`	EPG応答を照会し、ISO8601日付形式で返すことができる日時
`end`	`(now - the current date-time)`	EPG応答を照会してISO8601日付形式で返すことができる日時
`limit`	`(all programs)`	1つの要求で返されるプログラムの数を制御する整数値
`include_ads`	`false`	これをtrueに設定すると、応答に広告が含まれます

注

ザ・start / endウィンドウは14日を超えることはできません。履歴EPGを照会するには、開始が現在の日時から14日遅れることがあります。また、現在の日時から最大14日間の将来のEPGデータを取得できます。
終了時刻と開始時刻の差が14日を超える場合、APIは、要求された時刻から終了時刻までの14日または14日のいずれか早い方のみを生成します。
どちらもstartそしてendタイムゾーンオフセットがある場合とない場合の日時値を受け入れることができます-タイムゾーンオフセットが含まれていない場合、UTCが想定されます。

どちらもstartそしてend URIエンコードする必要があります：

URI エンコード
ISO8601サンプル	URIエンコード
`2020-07-24 15:30:00`	`2020-07-24%2015%3A30%3A00`
`2020-07-24 15:30:00 +0530`	`2020-07-24%2015%3A30%3A00%20%2B0530`

レスポンスの例

以下は、APIからのサンプル応答です。

<?xml version="1.0" encoding="utf-8"?>
  <tv source-info-name="Cloudplayout Schedules" source-info-url="http://www.cloudplayout.qa.brightcove.com">
      <channel id="8732bb664063401691ef95d1a813b954">
          <display-name>onetwo</display-name>
          <icon src="https://bc-cloudplayout-prod.s3.amazonaws.com/default_channel_image.png"/>
      </channel>
      <programme channel="8732bb664063401691ef95d1a813b954" start="20200730024628" stop="20200730024638">
          <title>ccsample10s_d10</title>
          <length unit="seconds">10.077</length>
          <icon src="https://cf-images.us-east-1.prod.boltdns.net/v1/jit/6063799219001/5739d822-eb06-43e3-add8-3c5af6b27821/main/1280x720/5s38ms/match/image.jpg"/>
          <category>video</category>
          <keyword>6176109299001:1</keyword>
      </programme>
      <programme channel="8732bb664063401691ef95d1a813b954" start="20200730024723" stop="20200730024733">
          <title>frozen2</title>
          <length unit="seconds">10.069</length>
          <icon src="https://cf-images.us-east-1.prod.boltdns.net/v1/jit/6063799219001/84bb134d-1aba-4d73-a0e9-7ed3d5bb962f/main/1280x720/5s34ms/match/image.jpg"/>
          <category>video</category>
          <keyword>6162613467001:2</keyword>
      </programme>
  </tv>

注

開始タイムスタンプと終了タイムスタンプはUTC時間です。
ザ・categoryそしてkeywordエントリは内部目的です。

制限

EPGは、ベストエフォート/ほぼ正確に生成されます。
EPGが最初にプレイリストから作成されるとき、クラウドプレイアウトが切り替えを開始するのに時間がかかるため、開始時間エラーが発生する可能性があります。
EPGは、保持している現在の情報に基づいて動的に構築されるため、プレイリストが変更されたときにすべての取得で一貫しているとは限りません。EPGを変更するアクションには、プレイリストの並べ替えやプレイリスト内のアセットの追加/削除などがあります。
切り替えで誤動作が発生し、切り替え時間が正確でない場合、将来のEPGでトランジットが不正確になる可能性があります。これを引き起こす可能性のあるアクションの例としては、プレイリストの切り替えや、プレイリスト内の現在アクティブなアセットの削除などがあります。
EPGの消費者は、最も正確なバージョンを取得するために、可能な限りリアルタイムに近いものを要求する必要があります。