最初的SDK安裝

          

           

            

             
1 2 3
             
npm安裝——保存@braze / web-sdk#或，使用yarn:# yarn add @braze/web sdk
            
           
          

          

           

            

             
1 2 3
             
進口＊作為釺從＂@braze / web-sdk＂；//或者，使用' require '常量釺＝需要（＂@braze / web-sdk＂）;
            
           
          

          

           

            

             
12 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20
             
//初始化SDK釺．初始化（＇YOUR-API-KEY-HERE＇，｛baseUrl：＂YOUR-SDK-ENDPOINT-HERE＂})；//可選地顯示所有應用程序內消息，而不進行自定義處理釺．automaticallyShowInAppMessages（）；//如果您使用內容卡釺．subscribeToContentCardsUpdates（函數（卡片) {//卡片已經更新})；//設置當前用戶的外部ID如果（isLoggedIn) {釺．changeUser（userIdentifier）;｝//確保在' automaticyshowinappmessages '之後調用' openSession '釺．openSession（）；
            
           
          

步驟3:Web推送(可選)

使用Web推送通知需要額外的設置。看到推送通知的指令。

故障排除

為了幫助排除故障，可以在SDK中啟用詳細日誌記錄。這對開發很有用，但對所有用戶都是可見的，因此您應該刪除此選項或提供一個備用記錄器braze.setLogger ()在您的生產環境中。

          

           

            

             
1 2 3 4 5 6 7 8
             
釺．初始化（＂YOUR-API-KEY-HERE＂，｛baseUrl：＂YOUR-API-ENDPOINT＂，enableLogging：真正的})；//或初始化後:釺．toggleLogging（）
            
           
          

SDK升級

例如，當您從我們的內容交付網絡引用Braze Web SDK時，https://js.appboycdn.com/web-sdk/a.a/braze.min.js(正如我們默認的集成說明所建議的那樣)，您的用戶將收到較小的更新(bug修複和向後兼容的特性、版本)a.a.a通過a.a.z在上麵的例子中)自動刷新你的網站。

然而，當我們發布重大更改時，我們要求您手動升級Braze Web SDK，以確保集成中的任何內容都不會受到任何破壞性更改的影響。此外，如果您下載了我們的SDK並自己托管它，您將不會自動收到任何版本更新，應該手動升級以接收最新功能和bug修複。

您可以隨時了解我們的最新版本跟隨我們的發布提要使用RSS閱讀器或你選擇的服務，然後看看我們的更新日誌查看我們的Web SDK發布曆史的完整記錄。升級Braze Web SDK。

• 的版本號來更新Braze庫版本https://js.appboycdn.com/web-sdk/(老版本號)/ braze.min.js，或者在包管理器的依賴項中。
• 如果您集成了web推送，請更新站點上的service worker文件—默認情況下，該文件位於/ service-worker.js在站點的根目錄中，但是在某些集成中可以自定義該位置。必須訪問根目錄以駐留service worker文件。

這兩個文件必須相互協調更新，以確保正確的功能。

替代集成方法

服務器端呈現框架

如果您使用服務器端呈現框架，如Next.js，您可能會遇到錯誤，因為SDK應該在瀏覽器環境中運行。您可以通過動態導入SDK來解決這些問題。

通過將SDK中需要的部分導出到一個單獨的文件中，然後動態地將該文件導入到組件中，您可以保留搖樹的好處。

          

           

            

             
12 3 4 5 6 7 8 9 10 11 12 13 14 15
             
MyComponent / /添加/ braze-exports.js//導出您需要的SDK部分出口｛初始化，openSession｝從＂@braze / web-sdk＂；MyComponent / /添加/ MyComponent.js//從braze exports文件中導入你需要的函數useEffect（（)= >｛進口（＂。/ braze-exports.js＂）.然後(({初始化，openSession}）= >｛初始化（＂YOUR-API-KEY-HERE＂，｛baseUrl：＂YOUR-SDK-ENDPOINT＂，enableLogging：真正的，})；openSession（）；})；}，[]);
            
           
          

或者，如果你正在使用webpack來捆綁你的應用程序，你可以利用它的神奇注釋來動態導入你需要的SDK部分。

          

           

            

             
12 3 4 5 6 7 8 9 10 11 12 13
             
/ / MyComponent.jsuseEffect（（)= >｛進口（/* webpackExports: ["initialize"， "openSession"] */＂@braze / web-sdk＂）.然後(({初始化，openSession}）= >｛初始化（＂YOUR-API-KEY-HERE＂，｛baseUrl：＂YOUR-SDK-ENDPOINT＂，enableLogging：真正的，})；openSession（）；})；}，[]);
            
           
          

AMD模塊加載器

如果你使用RequireJS或其他AMD模塊加載器，我們建議自托管我們庫的副本，並像使用其他資源一樣引用它:

          

           

            

             
1 2 3 4 5
             
需要（[＇路徑/ / braze.min.js＇),函數（釺）｛釺．初始化（＇YOUR-API-KEY-HERE＇，｛baseUrl：＇YOUR-SDK-ENDPOINT＇})；釺．automaticallyShowInAppMessages（）；釺．openSession（）；})；
            
           
          

不安裝AMD

如果你的網站使用RequireJS或其他AMD模塊加載器，但你更喜歡通過上麵的其他選項加載Braze Web SDK，你可以加載一個不包含AMD支持的庫版本。這個版本的庫可以從以下CDN位置加載:

Tealium智商

Tealium iQ提供了一個基本的交鑰匙Braze集成。要配置集成，請在Tealium Tag Management界麵中搜索Braze，並從儀表板中提供Web SDK API密鑰。

要了解更多細節或深入的Tealium配置支持，請查看我們的集成的文檔或者聯係你的Tealium客戶經理。

其他標簽管理器

Braze還可以通過在自定義HTML標記中遵循我們的集成說明與其他標記管理解決方案兼容。如果您需要幫助評估這些解決方案，請聯係Braze的代表。