キャンペーンの 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 で動的な情報を共有する場合に役立ちます。 使用方法の詳細については、「 カスタム パラメーター」を参照してください。
引数
| 名前 | 型 | 説明 |
|---|---|---|
| customParameters | オブジェクト | キャンペーンで使用する最大 3 つのカスタム パラメーターのマップ。 たとえば、 {key1: 'value1', key2: 'value2', key3: 'value3'} などです。ここで、key はカスタム パラメーターの名前で、値はパラメーターの値です。 パラメーターの名前には英数字のみを含めることができ、パラメーターの値に空白を含めることはできません。 名前には最大 16 個の 8 バイト文字を含めることができ、値は最大 200 個の 8 バイト文字を含めることができます。 |
戻り値
| 型 | 説明 |
|---|---|
| void | Nothing を返します。 |
setTrackingTemplate(string trackingTemplate)
キャンペーンのトラッキング テンプレートを設定します。
トラッキング テンプレートは、キーワード (keyword) の FinalUrl と共に使用され、広告で使用されるリンク先 URL が作成されます。 詳細については、どの トラッキングまたは URL パラメーターを使用できるかをご覧ください。
引数
| 名前 | 型 | 説明 |
|---|---|---|
| trackingTemplate | string | このキャンペーンで使用するトラッキング テンプレート。 |
戻り値
| 型 | 説明 |
|---|---|
| void | Nothing を返します。 |