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

    概要: Ingest Profiles API

    このトピックでは、取り込みプロファイル API の概要を説明します。プロファイルの取り込み API を使用すると、Video Cloud アカウントのレンディションプロファイルの作成、取得、更新、削除を行うことができます。

    トランスコードプロファイルを管理する

    このバージョンの概要は、動的配信が有効になっているアカウント向けです。これらのアカウントは、コンテキスト認識エンコーディングを有効にする場合とそうでない場合があります従来の取り込みプロファイルについては、別の概要があります。

    インジェストプロファイルは、動画をアップロードまたは再トランスコードするときに、トランスコーディングの仕様として使用されます。これらのプロファイルは、Ingest Profiles API を使用して管理できます。

    API リファレンス」も参照してください。

    用語集

    プロファイルJSON

    以下の「プロファイル JSON」という用語は、プロファイルオブジェクトの JSON 表現を意味します。リストには、最上位のプロファイルフィールドとレンディションオブジェクトのコレクションが含まれます。すべてのアカウントに含まれる標準プロファイルの JSON については「標準プロファイル」、DRM パッケージを含むサンプルプロファイルについては「コンテンツセキュリティ (DRM および HLSE) 」を参照してください。

    プロフィール ID

    profile idは、idnameプロファイル内のトップレベルフィールドまたはトップレベルフィールドのいずれかになります。この例では(プロファイルの断片):

    {
    		"id": "f1b16093e2dc4f81810f1488",
    		"version": 1,
    		"name": "multi-platform-extended-static",
    		"description": "Deliver high quality content for a wide range content types and screen sizes including mobile, desktop and large screens.", ...

    「マルチプラットフォーム拡張静的」または「f1b16093e2dc4f81810f148" は両方とも有効なプロファイル ID です。プロファイルを初めて作成するときは、ID を含まない名前を持つプロファイルを指定します。応答には、ID を含む作成されたプロファイルが含まれます。その後、後続の API 呼び出しでどちらを使用することもできます。

    参照ID

    は、reference_idプロファイル内のレンディションを一意に識別します。参照 ID は DRM パッケージングに使用され、将来的には他の目的に使用される可能性があります。プロファイル内で一意である以外に、参照 ID には任意の文字列を指定できます。スペースを含めることはできません。レンディションの形式を簡単に識別できるスキームを使用することをお勧めします。たとえばmp4_1mp4_2hls1hls2など

    プロファイルのバージョン

    A versionは、アカウントのプロファイルのリビジョン番号です。これは、長い整数値で表されます。注:JSON表現では引用符で囲まれていません。

    アクティブなプロファイル

    プロファイルは、activeアップロードに使用できるかどうかです。たとえば、プロファイルを更新すると、アクティブなバージョン番号が増分された新しいプロファイルが取得され、古いバージョンは非アクティブになります。

    標準プロファイル

    プロファイルとは、standardBrightcove ブが使用するために提供されている場合です(つまり、単一のアカウントに固有のカスタムプロファイルではありません)。

    既定のプロファイル

    プロファイルとはdefault、プロファイルが明示的に選択されていないときに使用される場合です。アカウント設定がない場合、または設定でデフォルトのプロファイルを設定していない場合は、アカウントタイプに応じて Brightcove standardプロファイルの 1 つが使用されます。

    ベース URL

    サービス URL は次のとおりです。

    https://ingestion.api.brightcove.com/v1/

    認証

    API の認証は、Brightcove ブの OAuth2 実装を介して行われます。アカウントで次の操作を行うアクセス許可を持つクライアント資格情報 (クライアント ID とクライアントシークレット) が必要です。

    • video-cloud/ingest-profiles/profile/read
    • video-cloud/ingest-profiles/profile/write
    • video-cloud/ingest-profiles/account/read
    • video-cloud/ingest-profiles/account/write

    client_idとを取得するにはclient_secret、OAuth UI に移動してアプリを登録する必要があります。

    また、CURL または Postman 経由で資格を取得することもできます。以下を参照してください。

    クライアントの認証情報を使用して、API を呼び出すためのアクセストークンを取得します。アクセストークンは Authorization ヘッダーで渡されます。

    Authorization: Bearer {your_access_token}

    詳細については、 Oauth セクションを参照してください

    最大レンディション

    プロファイルの取り込みのベストプラクティス」を参照してください。

    アカウント操作

    アカウントレベルでは、アカウントのすべてのプロファイルを取得し、新しいプロファイルを作成できます。

    終点

    /accounts/{account_id}/profiles

    すべてのプロファイルを取得

    アカウントのすべてのプロファイル(標準プロファイルを含む)を取得するには、上記のエンドポイントに GET リクエストを送信します。

    プロファイルの作成

    新しいプロファイルを作成するには、上記のエンドポイントに POST リクエストを送信します。これには、プロファイルの JSON データをリクエスト本文に含めます。詳細とサンプルリクエストボディについては「 API リファレンス」を、使用できるフィールドについては「プロファイルフィールドリファレンス」を参照してください。

     

    ライブプロファイルの作成

    Live のカスタムインジェストプロファイルを作成するには、live_streamをに設定して HLS レンディションを指定するだけですtrue

    {
      "media_type": "video",
      "format": "ts",
      "segment_seconds": 6,
      "label": "hls1080p",
      "live_stream": true,
      "video_codec": "h264",
      "video_bitrate": 4000,
      "keyframe_interval": 60,
      "width": 1920,
      "height": 1080,
      "h264_profile": "high"
    }

    renditionライブプロファイルには従来の取り込み設定のみを使用し、dynamic_origin動的配信プロファイルの設定は使用しないでください 。

    単一プロファイル操作

    個々のプロファイルについては、名前または ID でプロファイルを取得したり、プロファイルを置き換えたり、プロファイルを削除したりできます。

    終点

    /accounts/{account_id}/profiles/{profile_id}

    ではprofile_id次のいずれかを使用できます

    • 名前 (例:マルチプラットフォーム標準静的)
    • 生成されたID (例:f1b16093e2dc4f81810f1488)

    IDでプロファイルを取得する

    単一のプロファイルを取得するには、上記のエンドポイントに GET リクエストを行います。

    プロファイルを更新する

    プロファイルを更新するには、リクエスト本文にプロファイルの完全な JSON データを含めて、上記のエンドポイントに PUT リクエストを実行します。

    プロファイルを削除する

    プロファイルを削除するには、上記のエンドポイントに DELETE リクエストを行います。

    このアクションは元に戻せません

    デフォルトのプロファイル操作

    エンドポイントを使用して、アカウントのデフォルトのビデオオンデマンドおよびライブビデオプロファイルを取得、設定、または更新できます。

    /accounts/{account_id}/configuration

    デフォルトのプロファイルを取得する

    上記のエンドポイントに GET リクエストを実行して、アカウントのデフォルトプロファイルを取得します。

    デフォルトプロファイルが設定されていない場合は、システムのデフォルトプロファイルが返されます。

    デフォルトプロファイルの設定

    デフォルトのプロファイルを設定するには、リクエスト本文に JSON を含めて、上記のエンドポイントに POST リクエストを実行します。

    {
      "account_id": {account_id},
      "default_profile_id": {default_profile_id}
    }

    ではdefault_profile_id、次のいずれかを使用できます。

    • 名前 (例:マルチプラットフォーム標準静的)
    • 生成されたID (例:f1b16093e2dc4f81810f1488)

    既定のプロファイルを更新する

    デフォルトのプロファイルを更新するには、リクエスト本文に次の JSON を含めて、上記のエンドポイントに PUT リクエストを実行します。

    {
      "id": {configuration_id},
      "account_id": {account_id},
      "default_profile_id": {default_profile_id}
    }

    GET または POST configuration_id要求への応答からを取得します。

    デフォルトのライブプロファイルの設定

    デフォルトのライブプロファイルの設定は、デフォルトのビデオオンデマンドプロファイルの設定とまったく同じです。ただし、リクエスト本文でのこの変更を除きます。

    {
      "id": {configuration_id},
      "account_id": {account_id},
      "default_live_profile_id": {default_live_profile_id}
    }

    デフォルトのソーシャルクリッピングプロファイルの設定

    デフォルトのソーシャルクリッピングプロファイルの設定は、デフォルトのビデオオンデマンドプロファイルの設定とまったく同じです。ただし、リクエスト本文でのこの変更を除きます。

    {
      "id": {configuration_id},
      "account_id": {account_id},
      "default_social_clipping_profile_id": {default_social_clipping_profile_id}
    }

    • 存在しないプロファイルを指定すると、要求は失敗します

    サンプルプロファイル

    標準プロファイルドキュメントには、すべての Video Cloud アカウントに現在存在するすべてのデフォルトプロファイルが表示されます。

    透かし

    動画に透かし(またはロゴ画像)を追加する場合は、Brightcove ブサポートにお問い合わせください