as

Settings
Sign out
Notifications
Alexa
Amazonアプリストア
AWS
ドキュメント
Support
Contact Us
My Cases
開発
設計と開発
公開
リファレンス
サポート

ChannelMetadataBuilder

ChannelMetadataBuilder

ChannelMetadataオブジェクトのインスタンスを作成するビルダー。

拡張

コンストラクタ

new ChannelMetadataBuilder()

new ChannelMetadataBuilder(): ChannelMetadataBuilder

戻り値

ChannelMetadataBuilder

継承元

Builder.constructor

メソッド

attributes()

attributes(attributes): ChannelMetadataBuilder

ChannelMetadataビルダーのチャンネル属性を設定します。

パラメーター

attributes

string[]

チャンネルの属性。このフィールドで推奨される標準値のリストについては、開発者ガイドを参照してください。リストの最大サイズは32です。アイテムが32個を超える場合、余分なアイテムは削除されます。各項目の最大サイズは255バイトです。この長さを超える項目は切り捨てられ、最後の3バイトは「...」に置き換えられます。

戻り値

ChannelMetadataBuilder

チャンネル属性が設定された ChannelMetadataBuilderオブジェクト。

詳細

このフィールドはチャンネルメタデータの場合は任意です。

スロー

このビルダーインスタンスが既にオブジェクトを1回ビルドした後に関数が呼び出されると、IllegalStateErrorが発生します。

スロー

有効なUTF-8ではない文字列が渡されると、InvalidArgumentErrorが発生します。


build()

build(): IChannelMetadata

ChannelMetadataBuilder内のフィールドに基づいてChannelMetadataオブジェクトをビルドします。

戻り値

IChannelMetadata

ビルドされたChannelMetadataオブジェクト。

スロー

必須フィールドが1つ以上欠落していると、InvalidArgumentErrorが発生します。

スロー

このビルダーインスタンスが既にオブジェクトを1回ビルドした後に関数が呼び出されると、IllegalStateErrorが発生します。

オーバーライド

Builder.build


channelGroupId()

channelGroupId(channelGroupId): ChannelMetadataBuilder

ChannelMetadataビルダーでチャンネルのグループIDを設定します。

パラメーター

channelGroupId

string

Amazonの担当者から提供されたチャンネルグループID。このフィールドの最大長は8192バイトです。

戻り値

ChannelMetadataBuilder

channelGroupIdが設定されたChannelMetadataBuilderオブジェクト。

詳細

このフィールドは任意であり、Amazonの担当者から推奨されない限り、通常は不要です。

スロー

このビルダーインスタンスが既にオブジェクトを1回ビルドした後に関数が呼び出されると、IllegalStateErrorが発生します。

スロー

ExternIdのいずれかのフィールドが最大長の8192バイトを超えると、InvalidArgumentErrorが発生します。

スロー

有効なUTF-8ではない文字列が渡されると、InvalidArgumentErrorが発生します。


channelType()

channelType(channelType): ChannelMetadataBuilder

ChannelMetadataビルダーのチャンネルタイプを設定します。他のチャンネルタイプはまだ利用できないため、このフィールドはOTTにのみ設定してください。

パラメーター

channelType

ChannelTypeEnum

チャンネルのソースを表すチャンネルタイプ。これはChannelTypeEnumで定義されているソースの1つである必要があります。

戻り値

ChannelMetadataBuilder

チャンネルタイプが設定されたChannelMetadataBuilderオブジェクト。

詳細

このフィールドはチャンネルメタデータに必須です。

スロー

このビルダーインスタンスが既にオブジェクトを1回ビルドした後に関数が呼び出されると、IllegalStateErrorが発生します。


externalIdList()

externalIdList(externalIdList): ChannelMetadataBuilder

ChannelMetadataビルダーのチャンネルExternalIdリストを設定します。

パラメーター

externalIdList

IExternalId[]

チャンネルを関連付ける外部ラインアップソースの識別子のリスト。リストの最大サイズは255です。アイテムが255個を超える場合、それを越えるアイテムは削除されます。IExtrnalIdのフィールドの最大長は8192バイトです。

戻り値

ChannelMetadataBuilder

チャンネルの外部IDリストが設定されたChannelMetadataBuilderオブジェクト。

詳細

このフィールドはチャンネルメタデータの場合は任意です。

スロー

このビルダーインスタンスが既にオブジェクトを1回ビルドした後に関数が呼び出されると、IllegalStateErrorが発生します。

スロー

ExternalIdのフィールドのいずれかが最大長の8192バイトを超えると、InvalidArgumentErrorが発生します。

スロー

有効なUTF-8ではない文字列が渡されると、InvalidArgumentErrorが発生します。


genres()

genres(genres): ChannelMetadataBuilder

ChannelMetadataビルダーのチャンネルジャンルを設定します。

パラメーター

genres

string[]

チャンネルに適用されるジャンルのリスト。このフィールドで推奨される標準値のリストについては、開発者ガイドを参照してください。リストの最大サイズは32です。アイテムが32個を超える場合、余分なアイテムは削除されます。各項目の最大サイズは255バイトです。この長さを超える項目は切り捨てられ、最後の3バイトは「...」に置き換えられます。

戻り値

ChannelMetadataBuilder

チャンネルジャンルが設定されたChannelMetadataBuilderオブジェクト。

詳細

このフィールドはチャンネルメタデータの場合は任意です。

スロー

このビルダーインスタンスが既にオブジェクトを1回ビルドした後に関数が呼び出されると、IllegalStateErrorが発生します。

スロー

有効なUTF-8ではない文字列が渡されると、InvalidArgumentErrorが発生します。


logoUrl()

logoUrl(logoUrl): ChannelMetadataBuilder

ChannelMetadataビルダーのチャンネルロゴのURLを設定します。

パラメーター

logoUrl

string

チャンネルロゴのURL。チャンネルサムネイルのレンダリングに使用されます。このフィールドの最大長は8192バイトです。

戻り値

ChannelMetadataBuilder

チャンネルロゴのURLが設定されたChannelMetadataBuilderオブジェクト。

詳細

このフィールドはチャンネルメタデータの場合は任意です。

スロー

このビルダーインスタンスが既にオブジェクトを1回ビルドした後に関数が呼び出されると、IllegalStateErrorが発生します。

スロー

フィールドが最大長の8192バイトを超えると、InvalidArgumentErrorが発生します。

スロー

有効なUTF-8ではない文字列が渡されると、InvalidArgumentErrorが発生します。


name()

name(name): ChannelMetadataBuilder

ChannelMetadataビルダーのチャンネル名を設定します。

パラメーター

name

string

「The CW」や「Comedy Central」など、チャンネルのマーケティング名を示します。文字列の長さが255バイトを超えると文字列は切り捨てられ、最後の3バイトは「...」に置き換えられます。

戻り値

ChannelMetadataBuilder

チャンネル名が設定されたChannelMetadataBuilderオブジェクト。

詳細

このフィールドは必須で、チャンネルメタデータを空の文字列にすることはできません。

スロー

このビルダーインスタンスが既にオブジェクトを1回ビルドした後に関数が呼び出されると、IllegalStateErrorが発生します。

スロー

有効なUTF-8ではない文字列が渡されると、InvalidArgumentErrorが発生します。


sortRank()

sortRank(sortRank): ChannelMetadataBuilder

ChannelMetadataビルダーでチャンネルの並べ替えランクを設定します。

パラメーター

sortRank

number

このチャンネルを他のチャンネルと比較した並べ替えランク。このアプリの電子番組表(EPG)では、並べ替えランクの整数値が小さいチャンネルが、並べ替えランク値の大きいチャンネルよりも前に表示されます。このフィールドは任意であり、指定しない場合はデフォルトでMAX Int32に設定されます。チャンネルを並べ替えランク値に従って表示したい場合は、Amazonの担当者に連絡してください。

戻り値

ChannelMetadataBuilder

チャンネルの並べ替えランクが設定されたChannelMetadataBuilderオブジェクト。

詳細

このフィールドはチャンネルメタデータの場合は任意です。

スロー

このビルダーインスタンスが既にオブジェクトを1回ビルドした後に関数が呼び出されると、IllegalStateErrorが発生します。


videoResolution()

videoResolution(videoResolution): ChannelMetadataBuilder

ChannelMetadataビルダーでチャンネルのビデオ解像度を設定します。

パラメーター

videoResolution

string

チャンネルのビデオ解像度。このフィールドで推奨される標準値のリストについては、開発者ガイドを参照してください。文字列の長さが127バイトを超えると文字列は切り捨てられ、最後の3バイトは「...」に置き換えられます。

戻り値

ChannelMetadataBuilder

チャンネルのビデオ解像度が設定されたChannelMetadataBuilderオブジェクト。

詳細

このフィールドはチャンネルメタデータの場合は任意です。

スロー

このビルダーインスタンスが既にオブジェクトを1回ビルドした後に関数が呼び出されると、IllegalStateErrorが発生します。

スロー

有効なUTF-8ではない文字列が渡されると、InvalidArgumentErrorが発生します。


Last updated: 2025年9月30日