`sendPushSubscription` send-push-subscription

Last update: Tue Dec 02 2025 00:00:00 GMT+0000 (Coordinated Universal Time)

建立對象：

開發人員

AVAILABILITY

Web SDK的推播通知目前在 測試版 中。功能和檔案可能會有所變更。

sendPushSubscription命令會向Adobe Experience Platform註冊推播通知訂閱。此命令會處理從瀏覽器擷取推播訂閱詳細資料，並將其傳送至您設定的資料流。它適用於Web SDK 2.29.0或更新版本。

先決條件 prerequisites

在使用sendPushSubscription之前，請確定您擁有：

已設定推播通知：使用您的VAPID公開金鑰設定pushNotifications設定屬性
使用者許可權：使用者必須已授予通知許可權(Notification.permission === "granted")
服務背景工作：您的網站上必須有已登入的服務背景工作
推播管理員支援：瀏覽器必須支援推播通知，並且有可用的PushManager API

呼叫您設定的Web SDK執行個體時執行sendPushSubscription命令。在呼叫configure命令之前，請確定您已設定推播通知來呼叫sendPushSubscription命令。

alloy("sendPushSubscription")
  .then(() => {
    console.log("Push subscription recorded successfully");
  })
  .catch((error) => {
    console.error("Failed to send push subscription:", error);
  });

建議的執行頻率 recommended-execution-frequency

為獲得最佳的推播通知功能，Adobe建議每天執行sendPushSubscription命令一次。此頻率可確保：

Adobe Experience Platform中的訂閱詳細資料保持最新狀態
會擷取對推送代號或訂閱狀態所做的任何變更
使用者的設定檔會與最新的推播通知偏好設定一起更新

您可以使用類似下列的方法來實施此方法：

// Check if subscription data was sent today
const lastSent = localStorage.getItem("alloy_push_last_sent");
const today = new Date().toDateString();

if (lastSent !== today) {
  alloy("sendPushSubscription").then(() => {
    localStorage.setItem("alloy_push_last_sent", today);
  });
}

運作方式 how-it-works

sendPushSubscription命令會執行下列動作：

驗證先決條件：驗證是否已設定推播通知並授予使用者許可權
等待身分識別：等待使用者的ECID可用
擷取訂閱：使用設定的VAPID金鑰從Service Worker取得作用中推播訂閱
檢查變更：比較目前的訂閱詳細資料與快取的值（ECID +訂閱詳細資料）。如果訂閱詳細資料未變更，該命令會記錄一則資訊訊息，並且不會提出網路要求即會傳回
傳送至資料流：如果偵測到變更，會將訂閱資料傳輸至您設定的Adobe Experience Platform資料流
更新快取：儲存新的訂閱詳細資料，以供日後比較

錯誤處理 error-handling

常見錯誤條件及其訊息：

錯誤

原因

"Push notifications module is not configured. No VAPID public key was provided."

pushNotifications設定遺失或無效

"Service workers are not supported in this browser."

瀏覽器不支援服務背景工作

"Push notifications are not supported in this browser."

瀏覽器不支援推播通知或通知API

"The user has not given permission to send push notifications."

使用者尚未授與通知許可權(Notification.permission === "granted")

"No service worker registration was found."

目前來源未登入服務背景工作

"No VAPID public key was provided."

設定中缺少VAPID公開金鑰

資料裝載 data-payload

該命令會以下列格式傳送推播通知資料：

{
  pushNotificationDetails: [
    {
      appID: "example.com", // Current domain
      token: "...", // Serialized subscription details + ECID
      platform: "web", // Always "web" for Web SDK
      denylisted: false, // Always false
      identity: {
        namespace: {
          code: "ECID",
        },
        id: "12345678901234567890", // User's ECID
      },
    },
  ],
}

使用網頁SDK標籤擴充功能註冊推播訂閱 register-push-subscription-tag-extension

此欄位對應的Web SDK標籤延伸模組正在使用標籤規則中的Send Push Subscription動作。

recommendation-more-help

1ae86b30-e55e-49c1-ab11-9d0356a5f3e1

sendPushSubscription send-push-subscription