[Alpha]{class="badge informative"}

設定伺服器SDK

此頁面說明如何設定Server SDK。 若為網頁SDK,請參閱設定網頁SDK。

您使用​ configure ​方法設定伺服器SDK。 在伺服器啟動時,以及在呼叫forRequest或任何其他方法之前,在每個執行個體上呼叫一次。 每個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

屬性
類型
必要
預設
datastreamId
字串
是
無
orgId
字串
是
無
edgeCredentials
物件
是
無
debugEnabled
布林值
無
false
defaultConsent
字串
無
"in"
edgeBasePath
字串
無
"ee"
edgeConfigOverrides
物件
無
無
edgeDomain
字串
無
"edge.adobedc.net"
idMigrationEnabled
布林值
無
true
onBeforeEventSend
函數
無
無
thirdPartyCookiesEnabled
布林值
無
true

只有當執行個體包含createInstance預設包含的Consent元件時,defaultConsent屬性才可用。 請參閱建立自訂執行個體。

伺服器SDK不支援的選項 unsupported

網頁SDK提供依賴瀏覽器的功能設定選項,例如連結點選集合、呈現個人化內容和推播通知。 伺服器SDK不接受這些選項。 如果您包含一個,configure會以Unknown field錯誤拒絕並指定選項。

無法使用下列Web SDK選項: autoCollectPropositionInteractions、clickCollection、clickCollectionEnabled、context、conversation、downloadLinkQualifier、onBeforeLinkClickSend、personalizationStorageEnabled、prehidingStyle、pushNotifications、streamingMedia和targetMigrationEnabled。

結果和錯誤 result

configure方法傳回的Promise會在設定成功時解析為空物件。 在以下情況下會拒絕:

  • edgeCredentials遺失,或其中一個必要的屬性遺失。
  • defaultConsent已設定為"pending"。 請參閱defaultConsent。
  • 屬性的值無效或無法辨識。
  • 已在相同執行個體上成功呼叫configure。 每個執行個體只能設定一次。

如果configure拒絕,執行個體會保持未設定,而且forRequest會擲回錯誤,直到呼叫configure成功。

recommendation-more-help
experience-platform-help-collection