Adobe 外掛程式：getQueryParam

getQueryParam 外掛程式讓您可擷取 URL 中所含任何查詢字串參數的值。如需從登陸頁面 URL 擷取內部和外部促銷活動程式碼，此外掛程式非常有用。擷取搜尋詞或其他查詢字串參數時，它也很有用。

此外掛程式提供完善的功能，可剖析複雜的 URL，包括雜湊和包含多個查詢字串參數的 URL。如果您的查詢字串參數需求很簡單，Adobe 建議使用 Launch 中的 URL 參數功能，或是 AppMeasurement 中包含的 Util.getQueryParam() 方法。

使用 Adobe Experience Platform Launch 擴充功能安裝外掛程式

Adobe 提供一個擴充功能，可讓您使用最常用的外掛程式。

1. 使用您的 AdobeID 憑證登入 launch.adobe.com。
2. 按一下所需的屬性。
3. 前往擴充功能標籤，然後按一下「目錄」按鈕
4. 安裝並發佈常用 Analytics 外掛程式擴充功能
5. 如果您尚未執行上述步驟，請使用下列設定建立標示為「初始化外掛程式」的規則：
   • 條件：無
   • 事件：核心 - 已載入程式庫 (頁面頂端)
6. 使用下列設定將動作新增至上述規則：
   • 擴充功能：常用 Analytics 外掛程式
   • 動作類型：初始化 getQueryParam
7. 儲存並發佈規則的變更。

使用 Launch 自訂程式碼編輯器安裝外掛程式

如果您不想使用外掛程式擴充功能，可以使用自訂程式碼編輯器。

1. 使用您的 AdobeID 憑證登入 launch.adobe.com。
2. 按一下所需的屬性。
3. 前往擴充功能標籤，然後按一下 Adobe Analytics 擴充功能底下的「設定」按鈕。
4. 展開使用自訂程式碼設定追蹤摺疊式功能表，便會顯示「開啟編輯器」按鈕。
5. 開啟自訂程式碼編輯器，並將下方提供的外掛程式程式碼貼入編輯視窗中。
6. 儲存並發佈 Analytics 擴充功能的變更。

/******************************************* BEGIN CODE TO DEPLOY *******************************************/
/* Adobe Consulting Plugin: getQueryParam v3.3 (Requires pt plug-in) */
s.getQueryParam=function(qsp,de,url){var g=this,e="",k=function(b,de){de=de.split("?").join("&");de=de.split("#").join("&");var d=de.indexOf("&"),url="";b&&(-1<d||de.indexOf("=")>d)&&(d=de.substring(d+1),url=g.pt(d,"&","gpval",b));return url};qsp=qsp.split(",");var l=qsp.length;g.gpval=function(de,b){if(de){var d=de.split("="),url=d[0];d=d[1]?d[1]:!0;if(b.toLowerCase() ==url.toLowerCase())return"boolean"===typeof d?d:this.unescape(d)}return""};de=de?de:"";url=(url?url:g.pageURL?g.pageURL: location.href)+"";if((4<de.length||-1<de.indexOf("="))&&url&&4>url.length){var b=de;de=url;url=b}for(var h=0;h<l;h++)b=k(qsp[h],url) ,"string"===typeof b?(b=-1<b.indexOf("#")?b.substring(0,b.indexOf("#")):b,e+=e?de+b:b):e=""===e?b:e+(de+b);return e};

/* Adobe Consulting Plugin: pt v2.01 */ 
s.pt=function(l,de,cf,fa){if(l&&this[cf]){l=l.split(de||",");de=l.length;for(var e,c=0;c<de;c++)if(e=this[cf](l[c],fa))return e}};
/******************************************** END CODE TO DEPLOY ********************************************/

使用外掛程式

getQueryParam 方法使用以下引數：

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

若呼叫此方法，系統會根據上述引數和 URL 傳回值：

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

呼叫範例

範例 #1

如果目前的 URL 為：

http://www.abc123.com/?cid=trackingcode1

下列程式碼會將 s.campaign 設為等於 "trackingcode1"：

s.campaign=s.getQueryParam('cid');

範例 #2

如果目前的 URL 為：

http://www.abc123.com/?cid=trackingcode1&ecid=123456

下列程式碼會將 s.campaign 設為等於「trackingcode1:123456」：

s.campaign=s.getQueryParam('cid,ecid',':');

範例 #3

如果目前的 URL 為：

http://www.abc123.com/?cid=trackingcode1&ecid=123456

下列程式碼會將 s.campaign 設為等於 "trackingcode1123456"：

s.campaign=s.getQueryParam('cid,ecid');

範例 #4

如果目前的 URL 為：

http://www.abc123.com/?cid=trackingcode1&ecid=123456#location

下列程式碼會將 s.campaign 設為等於「123456」：

s.campaign=s.getQueryParam('ecid');

範例 #5

如果目前的 URL 為：

http://www.abc123.com/#location&cid=trackingcode1&ecid=123456

下列程式碼會將 s.campaign 設為等於「123456」

s.campaign=s.getQueryParam('ecid');

注意：​若不存在問號，該外掛程式會以問號取代 URL 以檢查雜湊字元。如果 URL 中雜湊字元前含有問號，外掛程式會以 & 符號取代 URL 以檢查雜湊字元；

範例 #6

如果目前的 URL 為…

http://www.abc123.com/

…且若變數 s.testURL 的設定如下：

s.testURL="http://www.abc123.com/?cid=trackingcode1&ecid=123456#location&pos=300";

下列程式碼完全不會設定 s.campaign：

s.campaign=s.getQueryParam('cid');

但是，下列程式碼會將 s.campaign 設為 "trackingcode1"：

s.campaign=s.getQueryParam('cid','',s.testURL);

注意：​第三個參數可為任何字串/變數，程式碼將用來嘗試在其中尋找查詢字串參數

下列程式碼會將 s.eVar2 設為等於「123456|trackingcode1|true|300」：

s.eVar2=s.getQueryParam('ecid,cid,location,pos','|',s.testURL);

• 123456 值來自 s.testURL 變數中的 ecid 參數
• trackingcode1 值來自 s.testURL 變數中的 cid 參數
• true 值來自 s.testURL 變數中雜湊字元之後位置參數的存在 (但非值)

300 值來自 s.testURL 變數中 pos 參數的值

版本記錄

3.3 (2019 年 9 月 24 日)

• 略過不必要的邏輯以縮小程式碼大小

3.2 (2018 年 5 月 15 日)

• 將 findParameterValue 和 getParameterValue 函數移入 getQueryParam 函數

3.1 (2018 年 5 月 10 日)

• 修正擷取無值查詢字串參數的問題

3.0 (2018 年 4 月 16 日)

• 單點發行 (重新編譯，程式碼大小較小)。
• 為提高可讀性，將協助程式函數重新命名為 findParameterValue 和 getParameterValue。
• 移除新增引數以尋找 URL 雜湊中所含參數的必要性

2.5 (2016 年 1 月 8 日)

• 與 H-Code 和 AppMeasurement 相容(需要 s.pt 搭配 AppMeasurement)。

2.4

• 新增 h 參數，讓程式碼可尋找在雜湊 (#) 字元後發現的查詢字串參數

2.3

• 修正外掛程式只有在追蹤代碼之後出現雜湊時才運作的回歸問題

2.2

• 現在會從傳回值中移除雜湊字元 (以及之後的所有內容)

2.1

• 與 H.10 程式碼相容