常見Web SDK外掛程式擴充功能概觀

重要

此擴充功能旨在與Adobe Experience Platform Web SDK擴充功能搭配使用。 若要查看有關預期與AppMeasurement搭配使用的版本的資訊,請參閱 常見Analytics外掛程式擴充功能.

本檔案說明如何設定Web SDK外掛程式標籤擴充功能,以及使用擴充功能 Adobe Experience Platform Web SDK擴充功能.

設定常見Web SDK外掛程式擴充功能

本節提供設定Web SDK外掛程式擴充功能時可用選項的參考資料。

重要

常見Web SDK外掛程式擴充功能旨在擴大Adobe Experience Platform Web SDK擴充功能,但您不需要安裝該擴充功能,即可正常運作。

將外掛程式新增至Adobe Experience Platform Web SDK擴充功能

在使用下列通用Web SDK外掛程式擴充功能提供的原生資料元素外,在初始化外掛程式或將外掛程式新增至程式庫時不需要進行設定:

getAndPersistValue

重要

此資料元素會設定Cookie,並允許將使用者產生的值儲存在Cookie中。 如需詳細資訊,請參閱外掛程式的特定檔案。

可讓您設定 getAndPersistValue Analytics外掛程式. 此 getAndPersistValue 資料元素會將值儲存在cookie中,以便稍後造訪時擷取。

getAndPersistValue 資料元素提供下列引數:

  • vtp (必要):要在頁面之間保留的值
  • cn (選用):要儲存值的 Cookie 名稱。如果此引數未設定,系統會將 Cookie 命名為 "s_gapv"
  • ex (選用):Cookie 過期的天數。如果此引數為 0 或未設定,Cookie 會在造訪結束時過期 (閒置 30 分鐘)。

vtp 引數設定後,資料元素會設定cookie,然後傳回cookie值。 若 vtp 引數未設定,則資料元素只會傳回cookie值。

getGeoCoordinates

重要

此外掛程式需要用戶端上的位置存取權,但若未取得,則不會擲回例外狀況。

可讓您設定 getGeoCoordinates Analytics外掛程式. 此 getGeoCoordinates 資料元素會擷取訪客裝置的經緯度。

getGeoCoordinates 資料元素不使用任何引數。 它會傳回以下其中一個值:

  • "geo coordinates not available":針對外掛程式執行時沒有地理位置資料的裝置。此值在造訪的第一次點擊時很常見,尤其是當訪客需要先同意追蹤其位置的情況下。
  • "error retrieving geo coordinates":當外掛程式嘗試擷取裝置位置時遇到任何錯誤時
  • "latitude=[LATITUDE] | longtitude=[LONGITUDE]":其中的 [LATITUDE]/[LONGITUDE] 分別代表緯度與經度

getNewRepeat

重要

此資料元素會設定Cookie。 如需詳細資訊,請參閱外掛程式的特定檔案。

可讓您設定 getNewRepeat Analytics外掛程式. 此 getNewRepeat 資料元素會決定網站訪客是新訪客還是在指定天數內回訪的重複訪客。

getNewRepeat 資料元素使用下列引數:

  • d (整數,選用):將訪客重設回 "New" 的訪客距離上次造訪需間隔的最小天數。如果未設定此引數,其預設值為 30 天。

此資料元素會傳回 "New" 如果資料元素設定的cookie不存在或已過期。 它會傳回 "Repeat" 如果資料元素設定的cookie存在,且自目前點擊以來的時間量及cookie中設定的時間超過30分鐘。 此方法會為整個造訪傳回相同值。

getPageName

可讓您設定 getPageName Analytics外掛程式. 此 getPageName 資料元素可建立目前URL易讀、好記的格式化版本。

getPageName 資料元素使用下列引數:

  • si (選用,字串):在代表網站 ID 的字串開頭插入的 ID。此值可以是數值 ID 或好記的名稱。未設定時,其預設值為目前的網域。
  • qv (選用,字串):以逗號分隔的查詢字串參數清單,若在 URL 中找到,便會新增至字串
  • hv (選用,字串):在 URL 雜湊中找到的逗號分隔參數清單,若在 URL 中找到,則會新增至字串
  • de (選用,字串):分割字串個別部分的分隔字元。預設為縱線字元 (|)。

資料元素會傳回包含易記格式化版URL的字串。 此字串通常會指派給 pageName 變數,但也可用於其他變數。

getPreviousValue

重要

此資料元素會設定Cookie,並允許將使用者產生的值儲存在Cookie中。 如需詳細資訊,請參閱外掛程式的特定檔案。

可讓您設定 getPreviousValue Analytics外掛程式. 此 getPreviousValue 資料元素會將變數設為先前點擊上設定的值。

getPreviousValue 資料元素使用下列引數:

  • v (字串,必要):具有您要傳遞至下一個影像要求之值的變數。用來擷取上一頁值的通用變數為 s.pageName
  • c (字串,選用):儲存值的 Cookie 名稱。如果未設定此引數,其預設值為 "s_gpv"

呼叫此資料元素時,它會傳回Cookie中包含的字串值。 此外掛程式會重設 Cookie 有效期,並從 v 引數指派變數值。閒置 30 分鐘後,Cookie 便會到期。

getQueryParam

可讓您設定 getQueryParam Analytics外掛程式. 此 getQueryParam 資料元素會擷取URL中包含之任何查詢字串參數的值。 如需從登陸頁面 URL 擷取內部和外部促銷活動程式碼,此外掛程式非常有用。擷取搜尋詞或其他查詢字串參數時,它也很有用。此資料元素提供強大的功能,可剖析複雜的URL,包括雜湊和包含多個查詢字串參數的URL。

getQueryParam 資料元素使用下列引數:

  • qsp (必要):要在 URL 中尋找的查詢字串參數清單 (以逗號分隔)。不區分大小寫。
  • de (選用):有多個查詢字串參數相符時要使用的分隔字元。預設為空字串。
  • url (選用):自訂 URL、字串或變數,系統會從其中擷取查詢字串參數值。預設為 window.location

呼叫此資料元素會根據上述引數和URL傳回值:

  • 如果找不到相符的查詢字串參數,方法會傳回空字串。
  • 如果找到相符的查詢字串參數,方法會傳回查詢字串參數值。
  • 如果找到相符的查詢字串參數但值為空,方法會傳回 true
  • 如果找到多個相符的查詢字串參數,方法會傳回一個字串,其中每個參數值都由 de 引數中的字串分隔開。

getTimeParting

可讓您設定 getTimeParting Analytics外掛程式. 此 getTimeParting 資料元素會擷取網站上發生任何可測量活動的時間詳細資訊。 如果您想要依指定日期範圍內任何可重複的時間劃分來劃分量度,此資料元素就十分實用。 例如,您可以比較一週內兩天之間的轉換率,例如所有週日比較所有週四。您也可以比較一天中的時段,例如所有早上比較所有晚上。

getTimeParting 資料元素使用下列引數:

t (選用但建議使用,字串):將訪客的當地時間轉換為該時區的時區名稱。預設為 UTC/GMT 時間。請參閱 TZ資料庫時區清單 有效值的完整清單。

常見的有效值包括:

  • "America/New_York" 為美國東部時間
  • "America/Chicago" 為美國中部時間
  • "America/Denver" 為美國山區時間
  • "America/Los_Angeles" 為美國太平洋時間

呼叫此資料元素會傳回包含下列內容的字串,並以縱線字元(|):

  • 當年
  • 當月
  • 該月某日
  • 當週某日
  • 當下時間 (AM/PM)

getTimeSinceLastVisit

重要

此資料元素會設定Cookie。 如需詳細資訊,請參閱外掛程式的特定檔案。

可讓您設定 getTimeSinceLastVisit Analytics外掛程式. 此 getTimeSinceLastVisit 資料元素會追蹤訪客在上次造訪後回訪您網站所花的時間。

getTimeSinceLastVisit 資料元素不使用任何引數。 它會傳回自訪客上次造訪網站以來經過的時間長度,並以下列格式分組:

  • 自上次造訪後 30 分鐘至 1 小時之間的時間設為最接近的半分鐘基準。例如, "30.5 minutes", "53 minutes"
  • 一小時至一天之間的時間會捨入至最接近的四分之一小時基準。例如, "2.25 hours", "7.5 hours"
  • 大於一天的時間會捨入至最接近的天數基準。例如, "1 day", "3 days", "9 days", "372 days"
  • 如果訪客之前未造訪過,或經過的時間超過兩年,則值會設為 "New Visitor"

getValOnce

重要

此資料元素會設定Cookie,並允許將使用者產生的值儲存在Cookie中。 如需詳細資訊,請參閱外掛程式的特定檔案。

可讓您設定 getValOnce Analytics外掛程式. 此 getValOnce 資料元素可防止變數多次設為等於相同值。

getValOnce 資料元素使用下列引數:

  • vtc (必要,字串):要檢查的變數,查看它之前是否設為相同值
  • cn (選用,字串):包含要檢查之值的 Cookie 名稱。預設為 "s_gvo"
  • et (選用,整數):Cookie 的有效期,單位為天 (或分鐘,視 ep 引數而定)。預設為 0,在瀏覽器作業階段結束時到期
  • ep (選用,字串):只有在也設定了 et 引數時才設定此引數。如果您希望 et 引數在幾分鐘內而不是幾天內到期,請將此引數設為 "m"。預設為 "d",以天為單位設定 et 引數。

如果 vtc 引數與 Cookie 值相符,此方法會傳回空字串。如果 vtc 引數與 Cookie 值不相符,則方法會將 vtc 引數傳回為字串。

getVisitDuration

重要

此資料元素會設定Cookie。 如需詳細資訊,請參閱外掛程式的特定檔案。

可讓您設定 getVisitDuration Analytics外掛程式. 此 getVisitDuration 資料元素會追蹤訪客截至該時間點為止在網站上逗留的時間長度,以分鐘為單位。

getVisitDuration 資料元素不使用任何引數。 它會傳回以下其中一個值:

  • "first hit of visit"
  • "less than a minute"
  • "1 minute"
  • "[x] minutes" (其中 [x] 是訪客進到網站以來經過的分鐘數)

getVisitNum

重要

此資料元素會設定Cookie。 如需詳細資訊,請參閱外掛程式的特定檔案。

可讓您設定 getVisitNum Analytics外掛程式. 此 getVisitNum 資料元素會傳回在指定天數內造訪過網站的所有訪客造訪次數。

getVisitNum 資料元素使用下列引數:

  • rp (選用,整數或字串):造訪次數計數器重設前的天數。若未設定,則預設為 365
    • 此引數為 "w" 時,計數器會在當週結束時 (本週六晚上 11:59) 重設
    • 此引數為 "m" 時,計數器會在當月結束時 (本月的最後一天) 重設
    • 此引數為 "y" 時,計數器會在當年結束時 (12 月 31 日) 重設
  • erp (選用,布林值):rp 引數為數字時,此引數會決定是否應延長造訪次數的有效期。若設為 true,您網站的後續點擊會重設造訪次數計數器。若設為 false,造訪次數計數器重設時,您網站的後續點擊不會延長。預設為 truerp 引數為字串時,此引數無效。

訪客閒置 30 分鐘後再返回您的網站時,造訪次數會增加。呼叫此方法會傳回一個整數,代表訪客目前的造訪次數。

p_fo (僅限頁面優先)

可讓您設定 p_fo Analytics外掛程式. 此 p_fo 資料元素是公用程式,可檢查特定JavaScript物件是否存在。 如果物件不存在,外掛程式將會建立該物件並傳回 true。如果頁面上已存在 JavaScript 物件,則會傳回 false。若要在頁面上執行一次程式碼,此資料元素很實用。

p_fo 資料元素使用下列引數:

  • on (必要,字串):如果頁面上尚未存在物件,資料元素會建立的JavaScript物件名稱。

如果物件尚不存在,則此方法會傳回 true 並建立該物件。如果物件已存在,則此方法會傳回 false

本頁內容