AdGroupUrls

[アーティクル]
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({})) を渡します。広告グループのカスタムパラメーターをクリアすると、広告グループは親キャンペーンから URL を継承します (キャンペーンで URL が指定されている場合)。カスタムパラメーターを完全にクリアするには、すべてのレベルでパラメーターをクリアします。

引数

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

戻り値

型	説明
void	Nothing を返します。

setTrackingTemplate(string trackingTemplate)

この広告グループで使用する追跡テンプレートを設定します。

引数

名前	型	説明
trackingTemplate	string	この広告グループで使用するトラッキングテンプレート。

戻り値

型	説明
void	Nothing を返します。

次の方法で共有