KeywordUrls

キーワード (keyword) の URL、トラッキングテンプレート、カスタムパラメーターを管理するためのメソッドを含みます。詳細については、「改良版 URL を使用した URL トラッキング」を参照してください。

メソッド

メソッド名	戻り値の型	説明
clearFinalUrl	void	キーワード (keyword) の最終ページ URL を削除します。
clearMobileFinalUrl	void	モバイルデバイスのキーワード (keyword) の最終ページ URL を削除します。
clearTrackingTemplate	void	キーワード (keyword) のトラッキングテンプレートを削除します。
getCustomParameters	オブジェクト	キーワード (keyword) のカスタムパラメーターを取得します。
getFinalUrl	string	キーワード (keyword) の最終ページ URL を取得します。
getMobileFinalUrl	string	モバイルデバイスのキーワード (keyword) の最終ページ URL を取得します。
getTrackingTemplate	string	キーワード (keyword) のトラッキングテンプレートを取得します。
setCustomParameters(Object customParameters)	void	キーワード (keyword) のカスタムパラメーターを設定します。
setFinalUrl(String finalUrl)	void	キーワード (keyword) の最終ページ URL を設定します。
setMobileFinalUrl(String finalUrl)	void	モバイル向けのキーワード (keyword) の最終ページ URL を設定します。
setTrackingTemplate(String trackingTemplate)	void	キーワード (keyword) のトラッキングテンプレートを設定します。

clearFinalUrl

キーワード (keyword) の最終ページ URL を削除します。

戻り値

型	説明
void	Nothing を返します。

clearMobileFinalUrl

モバイルデバイスのキーワード (keyword) の最終ページ URL を削除します。

戻り値

型	説明
void	Nothing を返します。

clearTrackingTemplate

キーワード (keyword) のトラッキングテンプレートを削除します。

戻り値

型	説明
void	Nothing を返します。

getCustomParameters

キーワード (keyword) のカスタムパラメーターを取得します。

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

戻り値

型	説明
オブジェクト	キーワード (keyword) のカスタムパラメーターのマップ。たとえば、 `{key1: 'value1', key2: 'value2', key3: 'value3'}` などです。ここで、key はカスタムパラメーターの名前で、value はパラメーターの値です。

getFinalUrl

キーワード (keyword) の最終ページ URL を取得します。ユーザーが広告をクリックした後に表示される Web ページの URL です。

他の場所と同じオーバーライドルールが適用されます。たとえば、キーワード (keyword) の最終ページ URL を指定すると、広告の最終ページ URL がオーバーライドされます。

戻り値

型	説明
string	キーワード (keyword) の最終ページ URL。

getMobileFinalUrl

モバイルデバイスのキーワード (keyword) の最終ページ URL を取得します。ユーザーが広告をクリックしたときに表示されるモバイル Web ページの URL です。

他の場所と同じオーバーライドルールが適用されます。たとえば、キーワード (keyword) のモバイル最終ページ URL を指定すると、広告のモバイル最終ページ URL がオーバーライドされます。

戻り値

型	説明
string	モバイルデバイスのキーワード (keyword)の最終ページ URL。

getTrackingTemplate

キーワード (keyword) のトラッキングテンプレートを取得します。

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

戻り値

型	説明
string	キーワード (keyword) のトラッキングテンプレート。

setCustomParameters(Object customParameters)

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

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

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

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

引数

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

戻り値

型	説明
void	Nothing を返します。

setFinalUrl(String finalUrl)

キーワード (keyword) の最終ページ URL を設定します。

最終ページ URL はユーザーが広告をクリックした際に誘導される Web ページを識別します。指定しない場合、エンティティは親エンティティから最終ページ URL を継承します。たとえば、キーワード (keyword) エンティティは広告の最終ページ URL を継承します。広告の最終ページ URL を上書きするには、キーワード (keyword) の最終ページ URL を指定します。

詳細については、どのトラッキングまたは URL パラメーターを使用できるかをご覧ください。

プロパティの値が無効な場合、呼び出しはサイレントに失敗します。プロパティが実際に更新されたかどうかを確認するには、オブジェクトを再度取得して、プロパティの値が新しい値と等しいかどうかをテストします。詳細については、エラーと警告の処理を参照してください。

引数

名前	型	説明
finalUrl	string	キーワード (keyword) の最終ページ URL。

戻り値

型	説明
void	Nothing を返します。

setMobileFinalUrl(String finalUrl)

モバイルデバイス向けのキーワード (keyword) の最終ページ URL を設定します。

詳細については、どのトラッキングまたは URL パラメーターを使用できるかをご覧ください。

モバイルデバイス用の最終ページ URL を指定する場合は、まずモバイル以外のデバイス用の最終ページ URL を指定します ( setFinalUrl() を参照してください)。

引数

名前	型	説明
finalUrl	string	キーワード (keyword) の最終ページ URL は、モバイルデバイスです。

戻り値

型	説明
void	Nothing を返します。

setTrackingTemplate(String trackingTemplate)

キーワード (keyword) のトラッキングテンプレートを設定します。

引数

名前	型	説明
trackingTemplate	string	キーワード (keyword) のトラッキングテンプレート。

戻り値

型	説明
void	Nothing を返します。

フィードバック

このページはお役に立ちましたか?

Last updated on 2026-09-11