KeywordUrls

發行項
11/13/2024

包含用來管理關鍵字 URL、追蹤範本和自訂參數的方法。如需詳細資訊，請參閱 URL 追蹤與升級的 URL。

方法

方法名稱	傳回類型	說明
clearFinalUrl	void	移除關鍵字的最終 URL。
clearMobileFinalUrl	void	移除行動裝置的關鍵字最終 URL。
clearTrackingTemplate	void	移除關鍵字的追蹤範本。
getCustomParameters	物件	取得關鍵字的自訂參數。
getFinalUrl	字串	取得關鍵字的最終 URL。
getMobileFinalUrl	字串	取得行動裝置的關鍵字最終 URL。
getTrackingTemplate	字串	取得關鍵字的追蹤範本。
setCustomParameters (Object customParameters)	void	設定關鍵字的自訂參數。
setFinalUrl (String finalUrl)	void	設定關鍵字的最終 URL。
setMobileFinalUrl (String finalUrl)	void	設定行動裝置的關鍵字最終 URL。
setTrackingTemplate (String trackingTemplate)	void	設定關鍵字的追蹤範本。

clearFinalUrl

移除關鍵字的最終 URL。

傳回

類型	說明
void	會傳回 nothing。

clearMobileFinalUrl

移除行動裝置的關鍵字最終 URL。

傳回

類型	說明
void	會傳回 nothing。

clearTrackingTemplate

移除關鍵字的追蹤範本。

傳回

類型	說明
void	會傳回 nothing。

getCustomParameters

取得關鍵字的自訂參數。

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

傳回

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

getFinalUrl

取得關鍵字的最終 URL。這是使用者按一下廣告時所前往的網頁 URL。

相同的覆寫規則會和其他地方一樣套用。例如，指定關鍵字的最終 URL 會覆寫廣告的最終 URL。

傳回

類型	描述
字串	關鍵字的最終 URL。

getMobileFinalUrl

取得行動裝置的關鍵字最終 URL。這是使用者在按一下廣告時所使用的行動網頁 URL。

相同的覆寫規則會和其他地方一樣套用。例如，指定關鍵字的行動最終 URL 會覆寫廣告的行動裝置最終 URL。

傳回

類型	描述
字串	行動裝置的關鍵字最終 URL。

getTrackingTemplate

取得關鍵字的追蹤範本。

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

傳回

類型	描述
字串	關鍵字的追蹤範本。

setCustomParameters (Object customParameters)

設定關鍵字的自訂參數。如果最終 URL 或追蹤範本包含自訂替代字串，請使用這個方法。

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

呼叫這個方法會取代關鍵字的現有自訂參數。

若要從關鍵字清除自訂參數，請傳遞空白物件 (例如， setCustomParameters({})) 。如果您清除關鍵字的自訂參數，如果廣告群組指定 URL) ，關鍵字會繼承其父廣告群組 (的 URL。若要完全清除自訂參數，請在階層中的所有層級清除它們。

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

引數

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

傳回

類型	說明
void	會傳回 nothing。

setFinalUrl (String finalUrl)

設定關鍵字的最終 URL。

最後一個 URL 會識別使用者在按一下廣告時所前往的網頁。如果未指定，則實體會從其父實體繼承最終 URL。例如，關鍵字實體會繼承廣告的最終 URL。指定關鍵字的最終 URL，以覆寫廣告的最終 URL。

如需詳細資訊，請參閱我可以使用哪些追蹤或 URL 參數？

如果屬性的值無效，則呼叫會以無訊息方式失敗。若要確認屬性是否已實際更新，請再次取得物件，並測試屬性的值是否等於新值。如需詳細資訊，請參閱處理錯誤和警告。

引數

名稱	類型	說明
finalUrl	字串	關鍵字的最終 URL。

傳回

類型	說明
void	會傳回 nothing。

setMobileFinalUrl (String finalUrl)

設定行動裝置的關鍵字最終 URL。