ResponsiveSearchAdBuilder

レスポンシブ検索広告を定義して作成するためのメソッドについて説明します。 ビルダーの詳細については、「 ビルダー」を参照してください。

使用例:

    var operation = adGroup.newAd().responsiveSearchAdBuilder()
        .withFinalUrl('LANDING PAGE URL GOES HERE')
        .build();

    // See the Builders topic for performance considerations
    // when using the operation object's methods.
    if (!operation.isSuccessful()) {
        for (var error of operation.getErrors()) {
            Logger.log(`${error}\n`);
        }
    }

メソッド

メソッド名 戻り値の型 説明
addDescription(文字列の説明, 文字列のピン留め) ResponsiveSearchAdBuilder 指定された説明を現在の説明一覧に追加します。 このメソッドまたは addDescription() メソッドを使用して、少なくとも 2 つの説明を指定する必要があります。
addHeadline(string headline, string pinning) ResponsiveSearchAdBuilder 指定された見出しを現在の見出しの一覧に追加します。 このメソッドまたは addHeadline() メソッドを使用して、少なくとも 3 つの見出しを指定する必要があります。
build AdOperation 広告を作成し、スクリプトが広告を正常に追加したかどうかをチェックするために使用される操作オブジェクトを返します。
withCustomParameters(Object customParameters) ResponsiveSearchAdBuilder 広告のカスタム パラメーターを設定します。
withDescriptions(object[], descriptions) ResponsiveSearchAdBuilder 広告の説明文を設定します。
withFinalUrl(string finalUrl) ResponsiveSearchAdBuilder 広告のランディング ページ URL を設定します。
withFinalUrlSuffix(string finalUrlSuffix) ResponsiveSearchAdBuilder 広告の最終ページ URL サフィックスを設定します。
withHeadlines(object[] headlines) ResponsiveSearchAdBuilder 広告の見出しを設定します。
withMobileFinalUrl(string mobileFinalUrl) ResponsiveSearchAdBuilder モバイル デバイス向けに広告の最終ページ URL を設定します。
withPath1(string urlPath1) ResponsiveSearchAdBuilder 広告の表示 URL に追加する最初のオプション パスを設定します。
withPath2(string urlPath2) ResponsiveSearchAdBuilder 広告の表示 URL に追加する 2 番目のパス (オプション) を設定します。
withTrackingTemplate(string trackingTemplate) ResponsiveSearchAdBuilder 広告のトラッキング テンプレートを設定します。

addDescription(文字列の説明, 文字列のピン留め)

指定された説明を現在の説明一覧に追加します。 このメソッドまたは addDescription() メソッドを使用して、少なくとも 2 つの説明を指定する必要があります。

引数

名前 説明
description string 追加する説明文。 制限と動的テキスト文字列を含む詳細については、「 Bing Ads API」を参照してください。
ピン留め string オプションのピン留めされた場所。

説明文に指定できる値は DESCRIPTION_1、DESCRIPTION_2 です
テキスト string このアセットのテキスト。

戻り値

説明
ResponsiveSearchAdBuilder 説明文が適用された広告ビルダー。

addHeadline(string headline, string pinning)

指定された見出しを現在の見出しの一覧に追加します。 このメソッドまたは addHeadline() メソッドを使用して、少なくとも 3 つの見出しを指定する必要があります。

引数

名前 説明
ヘッドライン string 追加する広告見出し。 制限と動的テキスト文字列を含む詳細については、「 Bing Ads API」を参照してください。
ピン留め string オプションのピン留めされた場所。

見出しに使用できる値は、HEADLINE_1、HEADLINE_2、HEADLINE_3 です

戻り値

説明
ResponsiveSearchAdBuilder 広告見出しが適用された広告ビルダー。

ビルド

広告を作成し、スクリプトが広告を正常に追加したかどうかをチェックするために使用される操作オブジェクトを返します。

広告グループに追加できる広告の数の制限については、「 エンティティ階層の制限」を参照してください。

戻り値

説明
AdOperation スクリプトが広告を正常に追加したかどうかをチェックするために使用される操作オブジェクト。

withCustomParameters(Object customParameters)

広告のカスタム パラメーターを設定します。

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

引数

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

戻り値

説明
ResponsiveSearchAdBuilder カスタム パラメーターが適用された広告ビルダー。

withDescriptions(object[], descriptions)

広告の説明文を設定します。

引数

名前 説明
説明 AdTextAsset[] 広告の説明文。 制限と動的テキスト文字列を含む詳細については、「 Bing Ads API」を参照してください。

戻り値

説明
ResponsiveSearchAdBuilder 説明文が適用された広告ビルダー。

withFinalUrl(string finalUrl)

広告のランディング ページ URL を設定します。

引数

名前 説明
finalUrl string 広告のランディング ページ URL。 URL 制限の詳細については、「 Bing Ads API」を参照してください。

戻り値

説明
ResponsiveSearchAdBuilder 最終ページ URL が適用された広告ビルダー。

withFinalUrlSuffix(string finalUrlSuffix)

広告の最終ページ URL サフィックスを設定します。

引数

名前 説明
finalUrl string 広告の最終ページ URL サフィックス。 URL 制限の詳細については、「 Bing Ads API」を参照してください。

戻り値

説明
ResponsiveSearchAdBuilder 最終ページ URL が適用された広告ビルダー。

withHeadlines(object[] headlines

広告の見出しを設定します。

引数

名前 説明
広告見出し AdTextAsset[] 広告の見出し。 制限と動的テキスト文字列を含む詳細については、「 Bing Ads API」を参照してください。

戻り値

説明
ResponsiveSearchAdBuilder 広告の見出しが適用された広告ビルダー。

withMobileFinalUrl(string mobileFinalUrl)

モバイル デバイス向けに広告の最終ページ URL を設定します。

最終ページ URL はユーザーが広告をクリックした際に誘導される Web ページを識別します。 モバイル デバイス用の最終ページ URL を指定する場合は、まずモバイル以外のデバイス用の最終ページ URL を指定します ( withFinalUrl() を参照してください)。

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

引数

名前 説明
mobileFinalUrl string モバイル デバイスの最終ページ URL。

戻り値

説明
ResponsiveSearchAdBuilder モバイル用の最終ページ URL が適用された広告ビルダー。

withPath1(string urlPath1)

広告の表示 URL に追加する最初のオプション パスを設定します。

引数

名前 説明
mobileFinalUrl string 広告の表示 URL に追加する最初のパスのオプション。 Microsoft は、 withFinalUrl で指定されたドメインを表示 URL として使用します。 最終ページ URL のドメインが contoso.com で、パスが shoes の場合、広告の表示 URL は contoso.com/shoes になります。 使用法と制限については、 Path1 を参照してください。

戻り値

説明
ResponsiveSearchAdBuilder パスが適用された広告ビルダー。

withPath2(string urlPath2)

広告の表示 URL に追加する 2 番目のパス (オプション) を設定します。

引数

名前 説明
mobileFinalUrl string 広告の表示 URL に追加する 2 つ目のオプションのパス。 2 つ目のパスを指定するには、最初に最初のパスを指定します ( withPath1 を参照)。 Microsoft は、 withFinalUrl で指定されたドメインを表示 URL として使用します。 最終ページ URL のドメインが contoso.com で、最初のパスは shoes、2 番目のパスが ladies の場合、広告の表示 URL は contoso.com/shoes/ladies になります。 使用法と制限については、「 Path2」を参照してください。

戻り値

説明
ResponsiveSearchAdBuilder パスが適用された広告ビルダー。

withTrackingTemplate(string trackingTemplate)

広告のトラッキング テンプレートを設定します。

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

引数

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

戻り値

説明
ResponsiveSearchAdBuilder トラッキング テンプレートが適用された広告ビルダー。