ExternalIdBuilder

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

拡張

• Builder<IExternalId>

コンストラクタ

new ExternalIdBuilder()

new ExternalIdBuilder(): ExternalIdBuilder

戻り値

ExternalIdBuilder

継承元

Builder.constructor

メソッド

build()

build(): IExternalId

指定されたパラメーターに基づいてExternalIdオブジェクトをビルドします。

戻り値

IExternalId

外部のラインアップソースでチャンネルを識別するために使用できる、構築されたExternalIdオブジェクト。

スロー

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

スロー

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

オーバーライド

Builder.build

---

idType()

idType(idType): ExternalIdBuilder

ExternalIdの識別子タイプを設定します。

パラメーター

idType

string

外部識別子のタイプ。このフィールドのいくつかの標準値は、開発者ガイドに記載されています。このフィールドの最大長は8192バイトです。

戻り値

ExternalIdBuilder

識別子のタイプが設定されたExternalIdBuilderオブジェクト。

スロー

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

---

value()

value(value): ExternalIdBuilder

ExternalIdの値を設定します。

パラメーター

値

string

外部識別子の文字列値。このフィールドの最大長は8192バイトです。

戻り値

ExternalIdBuilder

値が設定されたExternalIdBuilderオブジェクト。

スロー

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

---

Last updated: 2026年6月30日