CampaignUrls

[アーティクル]
10/04/2023

キャンペーンの URL を管理するためのメソッドが含まれています。詳細については、「アップグレードされた URL を使用した URL 追跡」を参照してください。

メソッド

メソッド名	戻り値の型	説明
clearTrackingTemplate	void	キャンペーンの追跡テンプレートを削除します。
getCustomParameters	オブジェクト	キャンペーンのカスタムパラメーターを取得します。
getTrackingTemplate	string	キャンペーンの追跡テンプレートを取得します。
setCustomParameters(Object customParameters)	void	キャンペーンのカスタムパラメーターを設定します。
setTrackingTemplate(String trackingTemplate)	void	キャンペーンのトラッキングテンプレートを設定します。

clearTrackingTemplate

キャンペーンの追跡テンプレートを削除します。追跡テンプレートの詳細については、「追跡テンプレート」を参照してください。

戻り値

型	説明
void	Nothing を返します。

getCustomParameters

キャンペーンのカスタムパラメーターを取得します。

カスタムパラメーターは、複数の URL 間で動的な情報を共有する場合に役立ちます。その使用方法の詳細については、「カスタムパラメーター」を参照してください。

戻り値

型	説明
オブジェクト	キャンペーンのカスタムパラメーターのマップ。たとえば、 `{key1: 'value1', key2: 'value2', key3: 'value3'}`key はカスタムパラメーターの名前で、値はパラメーターの値です。

getTrackingTemplate

キャンペーンの追跡テンプレートを取得します。

トラッキングテンプレートは、キーワードの FinalUrl と共に使用され、広告で使用される宛先 URL を作成します。詳細については、「使用できる追跡パラメーターまたは URL パラメーター」を参照してください。

戻り値

型	説明
string	キャンペーンの追跡テンプレート。

setCustomParameters(Object customParameters)

キャンペーンのカスタムパラメーターを設定します。最終的な URL または追跡テンプレートにカスタム置換文字列が含まれている場合は、このメソッドを使用します。

最終的な URL または追跡テンプレートで顧客パラメーター名を使用するには、名前を中かっこで囲み、名前にアンダースコア (_) を付加します。たとえば、パラメーター名が foo の場合は、追跡テンプレートまたは最終的な URL で {_foo} を使用します。カスタムパラメーターオブジェクトを定義するときは、パラメーター名に先頭のアンダースコアを追加しないでください。

このメソッドを呼び出すと、キャンペーンの既存のカスタムパラメーターが置き換えられます。

キャンペーンからカスタムパラメーターをクリアするには、空のオブジェクト (例: setCustomParameters({})) を渡します。カスタムパラメーターを完全にクリアするには、すべてのレベルでパラメーターをクリアします。

引数

名前	型	説明
customParameters	オブジェクト	キャンペーンで使用する最大 3 つのカスタムパラメーターのマップ。たとえば、 `{key1: 'value1', key2: 'value2', key3: 'value3'}`key はカスタムパラメーターの名前であり、値はパラメーターの値です。パラメーターの名前には英数字のみを含め、パラメーターの値に空白を含めないようにすることができます。名前には最大 16 個の 8 バイト文字を含め、値には最大 200 個の 8 バイト文字を含む場合があります。

戻り値

型	説明
void	Nothing を返します。

setTrackingTemplate(string trackingTemplate)

キャンペーンのトラッキングテンプレートを設定します。

引数

名前	型	説明
trackingTemplate	string	このキャンペーンで使用する追跡テンプレート。

戻り値

型	説明
void	Nothing を返します。

次の方法で共有