提供: Bright Pattern Documentation
移動先: 案内、 検索
• English

getVariables

指定された変数セットの値を、BPCCサーバーのシナリオから取得します。interactionIdの値が指定されていない場合、システムはアクティブなインタラクションの変数を取得します。

リクエスト

構文

getVariables(keys: string[], interactionId?: string): Promise<OperationResult<Record<string, string>>>

パラメータ

パラメータ パラメータ値 データ型 オプション/必須 説明
keys string[] 必須 対応する値を取得したいシナリオ変数名のリストです。
interactionId String オプション 特定の変数の値を取得したいインタラクションのIDです。IDが指定されていない場合は、現在アクティブなインタラクションが使用されます。

リクエスト例

 adApi.getVariables(["service.name", "service.version", "service.EWT"]).then(result => {

        if (result.status === "success") {

            const serviceName = result.data["service.name"]

            const serviceVersion = result.data["service.version"]

            const serviceEWT = result.data["service.EWT"]

        } else {

            console.error("Something went wrong:", result.error.message)

        }

    })

戻り値

オブジェクト オブジェクトの値 データ型 オプション?

(はい/いいえ)

値の説明
結果 変数名 Record<string, string> Y 要求されたシナリオ変数のキーと値のペアを含むオブジェクトです。
< 前へ | 次へ >