ビデオカルーセルモードの制作スタジオにエピソードを追加します。

Usage note

制作スタジオにエピソードリスト (プログラム) が存在しない場合、この操作はエピソードリスト (プログラム) を作成します。

QPS limit

A single user can perform a maximum of 10 queries per second (QPS). Throttling is triggered when the number of calls per second exceeds the QPS limit. The throttling may affect your business. したがって、この操作のQPS制限を遵守することをお勧めします。 For more information about what a single user means and the QPS details, see QPS limit on an API operation in ApsaraVideo Live.

デバッグ

OpenAPI Explorer は署名値を自動的に計算します。 この操作は、OpenAPI Explorer で呼び出すことを推奨します。 OpenAPI Explorer は、さまざまな SDK に対して操作のサンプルコードを動的に生成します。

リクエストパラメーター

パラメーター データ型 必須／任意 例 説明
操作 String 必須 AddPlaylistItems

実行する操作です。 値を

AddPlaylistItems。

CasterId String 必須 0e94d1f4-1a65-445c-9dcf-de8b3b8d ****

The ID of the production studio.

If you create a production studio through the CreateCaster interface, check the value of the CasterId parameter in the response.

重要 The production studio must fulfill the following requirements when it was created:
  • NormType:3 which means the video carousel mode.
  • CasterTemplate: lp_noTranscode。
  • channelEnable: 0.
  • programEffect: 1。
ProgramItems String 必須 [{"ItemName": "item1","ResourceType": "vod","ResourceValue": "5f8809f2-3352-4d1f-a8f7-86f9429f ****"}, {"ItemName": "item2","ResourceType": "vod","ResourceValue": "e7411c0b-dd98-4c61-a545-f8bfba6c ****"}]

制作スタジオに追加するエピソード。 値はJSON文字列です。 詳細については、このトピックのInputProgramItemセクションを参照してください。

ProgramId String 任意 445409ec-7eaa-461d-8f29-4bec2eb9 ****

エピソードを追加するエピソードリストのID。 このパラメーターを設定しない場合、デフォルトでエピソードリストが作成されます。

ProgramConfig String 任意 [{"RepeatNumber":"0","ProgramName":"my program"}]

エピソードの設定。 エピソードを初めてストリーミングパネルに追加する場合、このパラメーターは初期設定で渡す必要があります。 詳細については、このトピックのProgramConfigセクションを参照してください。

InputProgramItem

パラメーター

例

タイプ

説明

ItemName

item1

String

エピソードの名前。

ResourceType

vod

String

エピソードリソースのタイプ。 有効な値は

vod。 ビデオオンデマンド (VOD) リソースのみがサポートされています。

ResourceValue

5f8809f2-3352-4d1f-a8f7-86f9429f ****

String

エピソードリソースのID。

ProgramConfig

パラメーター

例

タイプ

説明

RepeatNumber

0

Integer

最初の再生が完了した後にエピソードが繰り返される回数。 設定可能な値は以下のとおりです。

0: エピソードを1回だけ再生するように指定します。 デフォルト値です。

-1: エピソードをループモードで再生することを指定します。

正の整数: 最初の再生が完了した後にエピソードが繰り返される回数を指定します。

プログラム名

myprogram

String

エピソードを追加するエピソードリストの名前。

レスポンスパラメーター

パラメーター データ型 例 説明
Items Struct

追加するエピソードに関する情報。

FailedItems FailedItemの配列

追加に失敗したエピソード。

ItemId String c09f3d63-eacf-4fbf-bd48-a07a6ba7 ****

エピソードのID。

ItemName String item1

エピソードの名前。

成功アイテム SuccessItemの配列

追加されたエピソード。

ItemId String c09f3d63-eacf-4fbf-bd48-a07a6ba7 ****

エピソードのID。

ItemName String item2

エピソードの名前。

ProgramId String 445409ec-7eaa-461d-8f29-4bec2eb9****

エピソードが追加されたエピソードリストのID。 これは、エピソードの削除、エピソードの照会、エピソードリストの編集、エピソードリストの削除、エピソードリストの照会、エピソードリストの開始、エピソードリストの停止のための要求パラメータとして使用できます。

RequestId String 5c6a2a0d-f228-4a64-af62-20e91b96 ****

リクエストの ID です。

例

リクエストの例

http(s):// live.aliyuncs.com/?Action=AddPlaylistItems
&CasterId=0e94d1f4-1a65-445c-9dcf-de8b3b8d ****
&ProgramItems=[{"ItemName": "item1","ResourceType": "vod","ResourceValue": "5f8809f2-3352-4d1f-a8f7-86f9429f ****"}, {"ItemName": "item2","ResourceType": "vod","ResourceValue": "e7411c0b-dd98-4c61-a545-f8bfba6c ****"}]
&<共通リクエストパラメーター>

正常に処理された場合のレスポンス例

XML 形式 

<AddPlaylistItemsResponse>
      <RequestId>5c6a2a0d-f228-4a64-af62-20e91b96 ****</RequestId>
      <Items>
            <FailedItems>
                  <ItemName>item2</ItemName>
                  <ItemId>c09f3d63-eacf-4fbf-bd48-a07a6ba7 ****</ItemId>
            </FailedItems>
            <SuccessItems>
                  <ItemName>item2</ItemName>
                 <ItemId>c09f3d63-eacf-4fbf-bd48-a07a6ba7 ****</ItemId>
            </SuccessItems>
      </Items>
      <ProgramId>445409ec-7eaa-461d-8f29-4bec2eb9 ****</ProgramId>
</AddPlaylistItemsResponse>

JSON 形式 

{
    "RequestId":"5c6a2a0d-f228-4a64-af62-20e91b96 ****" 、
    "Items":{
        "FailedItems":[{
            "ItemName":"item1" 、
            "ItemId":"c09f3d63-eacf-4fbf-bd48-a07a6ba7 ****"
                    }],
        "SuccessItems":[{
            "ItemName":"item2" 、
            "ItemId":"c09f3d63-eacf-4fbf-bd48-a07a6ba7 ****"
                    }]
        },
    "ProgramId":"445409ec-7eaa-461d-8f29-4bec2eb9 ****"
}

エラーコード

エラーコードリストについては、「API エラーセンター」をご参照ください。