AdGroupUrls

広告グループの 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 はカスタム パラメーターの名前で、value はパラメーターの値です。

getTrackingTemplate

広告グループのトラッキング テンプレートを取得します。

トラッキング テンプレートは、キーワード (keyword) の FinalUrl と共に使用され、広告で使用されるリンク先 URL が作成されます。 詳細については、どの トラッキングまたは URL パラメーターを使用できるかをご覧ください。

戻り値

説明
string 広告グループのトラッキング テンプレート。

setCustomParameters(Object customParameters)

広告グループのカスタム パラメーターを設定します。 最終ページ URL またはトラッキング テンプレートにカスタム置換文字列が含まれている場合は、この方法を使用します。

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

このメソッドを呼び出すと、広告グループの既存のカスタム パラメーターが置き換えられます。

広告グループからカスタム パラメーターをクリアするには、空のオブジェクト (たとえば、 setCustomParameters({})) を渡します。 広告グループのカスタム パラメーターをオフにすると、広告グループは親キャンペーンから URL を継承します (キャンペーンで URL が指定されている場合)。 カスタム パラメーターを完全にクリアするには、すべてのレベルでパラメーターをクリアします。

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

引数

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

戻り値

説明
void Nothing を返します。

setTrackingTemplate(string trackingTemplate)

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

トラッキング テンプレートは、キーワード (keyword) の FinalUrl と共に使用され、広告で使用されるリンク先 URL が作成されます。 詳細については、どの トラッキングまたは URL パラメーターを使用できるかをご覧ください。

引数

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

戻り値

説明
void Nothing を返します。