[Alpha]{class="badge informative"}

Server SDKの設定

このページでは、Server SDKの設定方法について説明します。 Web SDKについては、Web SDKの設定を参照してください。

Server SDKは、configure メソッドを使用して設定します。 サーバーが起動し、forRequestまたはその他のメソッドを呼び出す前に、各インスタンスで1回呼び出します。 forRequest ハンドルごとに、それを作成したインスタンスの設定が使用されます。

datastreamId、orgId、edgeCredentialsのプロパティが必要です。 その他のプロパティはすべてオプションです。 次の例は、使用可能なすべてのプロパティを使用する設定オブジェクトを示しています。

import { createInstance } from "@adobe/alloy-node";

const alloy = createInstance();

await alloy.configure({
  datastreamId: "ebebf826-a01f-4458-8cec-ef61de241c93",
  orgId: "ADB3LETTERSANDNUMBERS@AdobeOrg",
  edgeCredentials: {
    clientId: process.env.ADOBE_CLIENT_ID,
    clientSecret: process.env.ADOBE_CLIENT_SECRET,
    scopes: process.env.ADOBE_SCOPES.split(",")
  },
  debugEnabled: false,
  defaultConsent: "in",
  edgeBasePath: "ee",
  edgeConfigOverrides: {
    com_adobe_target: {
      propertyToken: "01dbc634-07c1-d8f9-ca69-b489a5ac5e94"
    }
  },
  edgeDomain: "data.example.com",
  idMigrationEnabled: false,
  onBeforeEventSend: (content) => {
    content.xdm.application ??= {};
    content.xdm.application.name = "Example storefront";
  },
  thirdPartyCookiesEnabled: false
});

設定プロパティ properties

defaultConsent プロパティは、インスタンスに同意コンポーネントが含まれている場合にのみ使用できます。このコンポーネントは、createInstanceにデフォルトで含まれています。 ​ カスタムインスタンスの作成を参照してください。

Server SDKでサポートされていないオプション unsupported

Web SDKには、リンククリック収集、パーソナライズされたコンテンツのレンダリング、プッシュ通知など、ブラウザーに依存する機能の設定オプションがあります。 Server SDKでは、これらのオプションは使用できません。 1つを含めると、configureさんがオプションを指定するUnknown field エラーで拒否します。

次のWeb SDK オプションは使用できません：autoCollectPropositionInteractions、clickCollection、clickCollectionEnabled、context、conversation、downloadLinkQualifier、onBeforeLinkClickSend、personalizationStorageEnabled、prehidingStyle、pushNotifications、streamingMedia、およびtargetMigrationEnabled。

結果とエラー result

configure メソッドは、設定が成功したときに空のオブジェクトで解決するプロミスを返します。 以下の場合は拒否します。

configureが拒否すると、インスタンスは未設定のままになり、forRequestはconfigureへの呼び出しが成功するまでエラーをスローします。