---
title: "フローオブジェクト"
slug: "flow-object"
abstract: "Boxever JavaScriptライブラリ(Sitecore PersonalizeストリームAPI)内のフローオブジェクトを記述します。"
---
# フローオブジェクト

> !重要BoxeverのJavaScriptライブラリは今後アップデートを受け取れません。今後のアップデートや強化を受けるために、[Sitecore Engage SDKへのアップグレード](https://doc.sitecore.com/personalize/ja/developers/api/stream-api/bx-js-library-legacy-reference/objects-1166464/choose-an-integration-type.html "Choose an integration type") をお勧めします。

Boxever JavaScriptライブラリや直接HTTPリクエストを使ってSitecore Personalizeと統合する場合、フローオブジェクトを使ってユーザーに関する識別データや、そのユーザーのために実行したいインタラクティブフルスタックエクスペリエンスやインタラクティブフルスタック実験のfriendlyIDを収集します。その後、オブジェクトをSitecore Personalizeに送り、Sitecore Personalizeがその体験や実験を実行します。

## フローオブジェクトに必要な属性

最低限、すべてのフローオブジェクトには以下の属性と[1つのゲスト識別子属性](https://doc.sitecore.com/personalize/ja/developers/api/stream-api/bx-js-library-legacy-reference/objects-1166464/flow-object.html#UUID-4d89efcc-dd4a-58a2-8956-30b00b375c11_para-idm1903321269401284)を含める必要があります:

属性

種類

概要

例

必須/任意

clientKey

ストリング

[あなたのクライアントキー](https://doc.sitecore.com/personalize/ja/developers/api/stream-api/bx-js-library-legacy-reference/objects-1166464/collect-required-details.html)です。

"ZpHxO9WvLOfQRVPlvo0BqB8YjGYuFfNe"

必須

friendlyId

ストリング

あなたが実行したいライブのインタラクティブフルスタック体験やライブインタラクティブフルスタック実験のIDです。

"running\_shoes\_popup\_02"

必須

channel

文字列(大文字)

ユーザーがブランドと関わる接点です。  
  
例えば、ウェブページの場合、チャネルは "WEB"です。モバイルアプリの画面では、チャネルは "MOBILE\_APP"です。  
  
値を設定しなければ、体験や実験のチャネルは "WEB"になります。

以下のいずれかでなければなりません:  
  

-   "AIRPORT\_KIOSK"
-   "BRANCH"
-   "CALL\_CENTER"
-   "EMAIL"
-   "GDS"
-   "KIOSK"
-   "MOBILE\_APP"
-   "MOBILE\_WEB"
-   "SMS"
-   "OFFLINE"
-   "OTA"
-   "OTHER"
-   "WEB"

必須

language

文字列(大文字 [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes))

ユーザーがアプリを使っている言語。  
  
例えば、ユーザーがウェブサイトで日本語を選択した場合、その言語は "JA"です。

-   "DE"
-   "EN"
-   "FR"

必須

currencyCode

文字列(大文字の [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217#Active_codes))

ユーザーがアプリで使っている通貨のアルファベット順通貨コードです。  
  
例えば、ユーザーがあなたのウェブサイトで通貨としてオーストラリアドルを選択した場合、通貨は "AUD"となります。

-   "EUR"
-   "GBP"
-   "USD"

必須

pointOfSale

ストリング

[ブランドとのやり取りが行われる販売ポイントの名前。](https://doc.sitecore.com/personalize/ja/developers/api/stream-api/bx-js-library-legacy-reference/objects-1166464/collect-required-details.html#UUID-60c4c930-3cfe-e0ad-3b98-69ceff75989f_section-idm1903325950166538)  
  
この値は、あなたのSitecore Personalizeインスタンスに存在する販売時点名に設定しなければなりません。

-   "myretailsite/ireland"

必須

上記の属性に加え、フローオブジェクトには以下のいずれかのゲスト識別子属性も含めなければなりません:

-   属性:タイプ
-   browserId:文字列
-   email: 文字列(小文字推奨)
-   identifiers:オブジェクトの配列

identifiersオブジェクトの配列:

属性

種類

概要

例

必須/任意

id

ストリング

顧客関係管理(CRM)システムなど、組織のアイデンティティシステムが提供する一意のゲスト識別子。

"123456"

必須

provider

ストリング

Sitecore Personalize外部の組織のアイデンティティシステムの名前で、一意のゲスト識別子を提供したものです。

"BXLP"

必須

expiry\_date

文字列([ISO 8601](https://en.wikipedia.org/wiki/ISO_8601))

一意のゲスト識別子が有効期限を切る日付。これは組織のアイデンティティシステムによって決まります。

"2026-04-15T08:39:44.868Z"

オプション

## フローオブジェクトのオプション属性

フローオブジェクトには、任意のカスタムオブジェクトを含めることも可能です:

属性

種類

概要

例

必須/任意

params

目的

自分で選ぶ物。

params: { key: "value" }

オプション

## 例

この例は、Boxever JavaScript Libraryを使用する統合内のフローオブジェクトを説明しています。フローオブジェクトはbrowserIdをゲスト識別子として使用します。また、オプションのカスタムオブジェクトも含まれます。

const flowObject = {
 clientKey: Boxever.getClientKey(),
 friendlyId: "running\_shoes\_popup\_02",
 channel: "WEB",
 language: "EN",
 currencyCode: "EUR",
 pointOfSale: "myretailsite/ireland",
 // guest identifier:
 browserId: Boxever.getID(),
 // optional attributes:
 aCustomObject1: { key: "value" },
 aCustomObject2: { isOptional: true }
}

この例は、Boxever JavaScriptライブラリを使用する統合中のフローオブジェクトを説明しています。フローオブジェクトはゲスト識別子としてemailを使用します。

const flowObject = {
 clientKey: Boxever.getClientKey(),
 friendlyId: "running\_shoes\_popup\_02",
 channel: "WEB",
 language: "EN",
 currencyCode: "EUR",
 pointOfSale: "myretailsite/ireland",
 // guest identifier:
 email: "jane.doe@myretailsite.com"
}

この例は、Boxever JavaScriptライブラリを用いた統合におけるフローオブジェクトを説明しています。フローオブジェクトはidentifiers配列のオブジェクトをゲスト識別子として使用します。

const flowObject = {
 clientKey: Boxever.getClientKey(),
 friendlyId: "running\_shoes\_popup\_02",
 channel: "WEB",
 language: "EN",
 currencyCode: "EUR",
 pointOfSale: "myretailsite/ireland",
 // guest identifier:
 identifiers: {
 id: "123456",
 provider: "BXLP",
 }
}