CampaignUrls

發行項
11/13/2024

包含管理行銷活動 URL 的方法。如需詳細資訊，請參閱 URL 追蹤與升級的 URL。

方法

方法名稱	傳回類型	說明
clearTrackingTemplate	void	移除活動的追蹤範本。
getCustomParameters	物件	取得行銷活動的自訂參數。
getTrackingTemplate	字串	取得行銷活動的追蹤範本。
setCustomParameters (Object customParameters)	void	設定行銷活動的自訂參數。
setTrackingTemplate (String trackingTemplate)	void	設定行銷活動的追蹤範本。

clearTrackingTemplate

移除活動的追蹤範本。如需追蹤範本的相關資訊，請參閱追蹤範本。

傳回

類型	說明
void	會傳回 nothing。

getCustomParameters

取得行銷活動的自訂參數。

自訂參數有助於跨多個 URL 共用動態資訊。如需其使用方式的詳細資訊，請參閱自訂參數。

傳回

類型	描述
物件	行銷活動的自訂參數對應。例如， `{key1: 'value1', key2: 'value2', key3: 'value3'}` 其中 key 是自訂參數的名稱，而 value 是參數的值。

getTrackingTemplate

取得行銷活動的追蹤範本。

追蹤範本會與關鍵字的 FinalUrl 搭配使用，以建立廣告所使用的目的地 URL。如需詳細資訊，請參閱我可以使用哪些追蹤或 URL 參數？

傳回

類型	描述
字串	活動的追蹤範本。

setCustomParameters (Object customParameters)

設定行銷活動的自訂參數。如果最終 URL 或追蹤範本包含自訂替代字串，請使用此方法。

若要在最終 URL 或追蹤範本中使用客戶參數名稱，請以大括弧括住名稱，並在名稱前面加上底線 (_) 。例如，如果參數名稱是 foo，請在追蹤範本或最終 URL 中使用 {_foo}。定義自訂參數物件時，請勿將前置底線新增至參數名稱。

呼叫這個方法會取代行銷活動的現有自訂參數。

若要清除行銷活動的自訂參數，請傳遞空白物件 (例如， setCustomParameters({})) 。若要完全清除自訂參數，請清除所有層級的參數。

自訂參數有助於跨多個 URL 共用動態資訊。如需其使用方式的詳細資訊，請參閱自訂參數。

引數

名稱	類型	說明
customParameters	物件	最多可在行銷活動中使用三個自訂參數的對應。例如，其中 `{key1: 'value1', key2: 'value2', key3: 'value3'}` 索引鍵是自訂參數的名稱，而 value 是參數的值。參數的名稱可能只包含英數位元，而參數的值可能不包含空白字元。名稱最多可包含 16 個 8 位元組字元，且值最多可包含 200 個 8 位元組字元。

傳回

類型	說明
void	會傳回 nothing。

setTrackingTemplate (字串追蹤範本)

設定行銷活動的追蹤範本。