ChannelMetadataオブジェクトのインスタンスを作成するビルダー。
拡張
Builder
コンストラクタ
new ChannelMetadataBuilder()
new ChannelMetadataBuilder(): ChannelMetadataBuilder戻り値
ChannelMetadataBuilderメソッド
attributes()
attributes(attributes:string[]): ChannelMetadataBuilder
ChannelMetadataビルダーのチャンネル属性を設定します。
このフィールドはチャンネルメタデータの場合は任意です。
パラメーター
attributes
string[]
チャンネルの属性。このフィールドで推奨される標準値のリストについては、開発者ガイドを参照してください。リストの最大サイズは32です。アイテムが32個を超える場合、余分なアイテムは削除されます。各項目の最大サイズは255バイトです。この長さを超える項目は切り捨てられ、最後の3バイトは「…」に置き換えられます。
エラー
- このビルダーインスタンスが既にオブジェクトを1回ビルドした後に関数が呼び出されると、
IllegalStateErrorが発生します。 - 有効なUTF-8ではない文字列が渡されると、
InvalidArgumentErrorが発生します。
戻り値
ChannelMetadataBuilder ChannelMetadataBuilder：チャンネル属性が設定されたChannelMetadataBuilderオブジェクト。
build()
build(): IChannelMetadataChannelMetadataBuilder内のフィールドに基づいてChannelMetadataオブジェクトをビルドします。
エラー
- 必須フィールドが1つ以上欠落していると、
InvalidArgumentErrorが発生します。 - このビルダーインスタンスが既にオブジェクトを1回ビルドした後に関数が呼び出されると、
IllegalStateErrorが発生します。
戻り値
IChannelMetadata IChannelMetadata：ビルドされたChannelMetadataオブジェクト。
channelGroupId
channelGroupId(channelGroupId:string): ChannelMetadataBuilder
ChannelMetadataビルダーでチャンネルのグループIDを設定します。
このフィールドは任意であり、Amazonの担当者から推奨されない限り、通常は不要です。
パラメーター
channelGroupId
string
Amazonの担当者から提供されたチャンネルグループID。このフィールドの最大長は8192バイトです。
エラー
- このビルダーインスタンスが既にオブジェクトを1回ビルドした後に関数が呼び出されると、
IllegalStateErrorが発生します。 - ExternIdのいずれかのフィールドが最大長の8192バイトを超えると、
InvalidArgumentErrorが発生します。 - 有効なUTF-8ではない文字列が渡されると、
InvalidArgumentErrorが発生します。
戻り値
ChannelMetadataBuilder ChannelMetadataBuilder：channelGroupIdが設定されたChannelMetadataBuilderオブジェクト。
channelType()
channelType(channelType: ChannelTypeEnum): ChannelMetadataBuilderChannelMetadataビルダーのチャンネルタイプを設定します。他のチャンネルタイプはまだ利用できないため、このフィールドはOTTにのみ設定してください。
このフィールドはチャンネルメタデータに必須です。
パラメーター
channelType
ChannelTypeEnum チャンネルのソースを表すチャンネルタイプ。これはChannelTypeEnumで定義されているソースの1つである必要があります。
エラー
- このビルダーインスタンスが既にオブジェクトを1回ビルドした後に関数が呼び出されると、
IllegalStateErrorが発生します。
戻り値
ChannelMetadataBuilder ChannelMetadataBuilder：チャンネルタイプが設定されたChannelMetadataBuilderオブジェクト。
externalIdList
externalIdList(externalIdList: IExternalId[]): ChannelMetadataBuilder
ChannelMetadataビルダーのチャンネルExternalIdリストを設定します。
このフィールドはチャンネルメタデータの場合は任意です。
パラメーター
externalIdList
IExternalId[]
チャンネルを関連付ける外部ラインアップソースの識別子のリスト。リストの最大サイズは255です。アイテムが255個を超える場合、それを越えるアイテムは削除されます。IExtrnalIdのフィールドの最大長は8192バイトです。
エラー
- このビルダーインスタンスが既にオブジェクトを1回ビルドした後に関数が呼び出されると、
IllegalStateErrorが発生します。 - ExternalIdのフィールドのいずれかが最大長の8192バイトを超えると、
InvalidArgumentErrorが発生します。 - 有効なUTF-8ではない文字列が渡されると、
InvalidArgumentErrorが発生します。
戻り値
ChannelMetadataBuilder ChannelMetadataBuilder：チャンネルの外部IDリストが設定されたChannelMetadataBuilderオブジェクト。
genres()
genres(genres:string[]): ChannelMetadataBuilder
ChannelMetadataビルダーのチャンネルジャンルを設定します。
このフィールドはチャンネルメタデータの場合は任意です。
パラメーター
genres
string[]
チャンネルに適用されるジャンルのリスト。このフィールドで推奨される標準値のリストについては、開発者ガイドを参照してください。リストの最大サイズは32です。アイテムが32個を超える場合、余分なアイテムは削除されます。各項目の最大サイズは255バイトです。この長さを超える項目は切り捨てられ、最後の3バイトは「…」に置き換えられます。
エラー
- このビルダーインスタンスが既にオブジェクトを1回ビルドした後に関数が呼び出されると、
IllegalStateErrorが発生します。 - 有効なUTF-8ではない文字列が渡されると、
InvalidArgumentErrorが発生します。
戻り値
ChannelMetadataBuilder ChannelMetadataBuilder：チャンネルジャンルが設定されたChannelMetadataBuilderオブジェクト。
logoUrl()
logoUrl(logoUrl:string): ChannelMetadataBuilder
ChannelMetadataビルダーのチャンネルロゴのURLを設定します。
このフィールドはチャンネルメタデータの場合は任意です。
パラメーター
logoUrl
string
チャンネルロゴのURL。チャンネルサムネイルのレンダリングに使用されます。このフィールドの最大長は8192バイトです。
エラー
- このビルダーインスタンスが既にオブジェクトを1回ビルドした後に関数が呼び出されると、
IllegalStateErrorが発生します。 - フィールドが最大長の8192バイトを超えると、
InvalidArgumentErrorが発生します。 - 有効なUTF-8ではない文字列が渡されると、
InvalidArgumentErrorが発生します。
戻り値
ChannelMetadataBuilder ChannelMetadataBuilder：チャンネルロゴのURLが設定されたChannelMetadataBuilderオブジェクト。
name()
name(name:string): ChannelMetadataBuilder
ChannelMetadataビルダーのチャンネル名を設定します。
このフィールドは必須で、チャンネルメタデータを空の文字列にすることはできません。
パラメーター
name
string
「The CW」や「Comedy Central」など、チャンネルのマーケティング名を示します。文字列の長さが255バイトを超えると文字列は切り捨てられ、最後の3バイトは「…」に置き換えられます。
エラー
- このビルダーインスタンスが既にオブジェクトを1回ビルドした後に関数が呼び出されると、
IllegalStateErrorが発生します。 - 有効なUTF-8ではない文字列が渡されると、
InvalidArgumentErrorが発生します。
戻り値
ChannelMetadataBuilder ChannelMetadataBuilder：チャンネル名が設定されたChannelMetadataBuilderオブジェクト。
sortRank()
sortRank(sortRank:number): ChannelMetadataBuilder
ChannelMetadataビルダーでチャンネルの並べ替えランクを設定します。
このフィールドはチャンネルメタデータの場合は任意です。
パラメーター
sortRank
number
このチャンネルを他のチャンネルと比較した並べ替えランク。このアプリの電子番組表（EPG）では、並べ替えランクの整数値が小さいチャンネルが、並べ替えランク値の大きいチャンネルよりも前に表示されます。このフィールドは任意であり、指定しない場合はデフォルトでMAX Int32に設定されます。チャンネルを並べ替えランク値に従って表示したい場合は、Amazonの担当者に連絡してください。
エラー
- このビルダーインスタンスが既にオブジェクトを1回ビルドした後に関数が呼び出されると、
IllegalStateErrorが発生します。
戻り値
ChannelMetadataBuilder ChannelMetadataBuilder：チャンネルの並べ替えランクが設定されたChannelMetadataBuilderオブジェクト。
videoResolution
videoResolution(videoResolution:string): ChannelMetadataBuilder
ChannelMetadataビルダーでチャンネルのビデオ解像度を設定します。
このフィールドはチャンネルメタデータの場合は任意です。
パラメーター
videoResolution
string
チャンネルのビデオ解像度。このフィールドで推奨される標準値のリストについては、開発者ガイドを参照してください。文字列の長さが127バイトを超えると文字列は切り捨てられ、最後の3バイトは「…」に置き換えられます。
エラー
- このビルダーインスタンスが既にオブジェクトを1回ビルドした後に関数が呼び出されると、
IllegalStateErrorが発生します。 - 有効なUTF-8ではない文字列が渡されると、
InvalidArgumentErrorが発生します。
戻り値
ChannelMetadataBuilder ChannelMetadataBuilder：チャンネルのビデオ解像度が設定されたChannelMetadataBuilderオブジェクト。
