KeywordUrls

[アーティクル]
11/13/2024

キーワードの URL、追跡テンプレート、およびカスタムパラメーターを管理するためのメソッドが含まれています。詳細については、「アップグレードされた URL を使用した URL 追跡」を参照してください。

メソッド

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

clearFinalUrl

キーワードの最終 URL を削除します。

戻り値

型	説明
void	Nothing を返します。

clearMobileFinalUrl

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

戻り値

型	説明
void	Nothing を返します。

clearTrackingTemplate

キーワードの追跡テンプレートを削除します。

戻り値

型	説明
void	Nothing を返します。

getCustomParameters

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

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

戻り値

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

getFinalUrl

キーワードの最終 URL を取得します。これは、ユーザーが広告をクリックしたときに取得される Web ページの URL です。

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

戻り値

型	説明
string	キーワードの最終 URL。

getMobileFinalUrl

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

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

戻り値

型	説明
string	モバイルデバイスのキーワードの最終 URL。

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 を返します。

setFinalUrl(String finalUrl)

キーワードの最終 URL を設定します。

最後の URL は、ユーザーが広告をクリックしたときに取得される Web ページを識別します。指定しない場合、エンティティは親エンティティから最終的な URL を継承します。たとえば、キーワードエンティティは広告の最終 URL を継承します。キーワードの最終 URL を指定して、広告の最終 URL をオーバーライドします。

詳細については、「使用できる追跡パラメーターまたは URL パラメーター」を参照してください。

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

引数

名前	型	説明
finalUrl	string	キーワードの最終 URL。

戻り値

型	説明
void	Nothing を返します。

setMobileFinalUrl(String finalUrl)

モバイルデバイスのキーワードの最終 URL を設定します。