ExpandedTextAdBuilder

拡張テキスト広告を定義して作成するためのメソッドについて説明します。 ビルダーの詳細については、「 ビルダー」を参照してください。

注:

  • 拡張テキスト広告を、2023 年 2 月 1 日までにレスポンシブ検索広告にアップグレードしてください。 この日付を過ぎると、拡張テキスト広告を新規作成したり、編集したりできなくなります。 詳細については、「 レスポンシブ検索広告について」を参照してください。
  • 既存の拡張テキスト広告の配信は続けられ、またそのパフォーマンス レポートも表示されます。
  • 拡張テキスト広告は引き続き一時停止、有効化、削除可能です。 それ以外の場合、拡張テキスト広告を追加または更新しようとすると、 CampaignServiceAdTypeInvalid エラーになります。
  • この変更の詳細については、こちらをご覧ください

使用例:

    var operation = adGroup.newAd().expandedTextAdBuilder()
        .withHeadlinePart1('FIRST PART OF TITLE GOES HERE')
        .withHeadlinePart2('SECOND PART OF TITLE GOES HERE')
        .withDescription('AD TEXT GOES HERE')
        .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`);
        }
    }

メソッド

メソッド名 戻り値の型 説明
build AdOperation 広告を作成し、スクリプトが広告を正常に追加したかどうかをチェックするために使用される操作オブジェクトを返します。
withCustomParameters(Object customParameters) ExpandedTextAdBuilder 広告のカスタム パラメーターを設定します。
withDescription(string description) ExpandedTextAdBuilder 広告の最初の説明文を設定します。 このメソッドは、 withDescription1(string description1) のため非推奨になりました。
withDescription1(string description1) ExpandedTextAdBuilder 広告の最初の説明文を設定します。 このメソッドは、 withDescription(string description) と同じフィールドを設定します。
withDescription2(string description2) ExpandedTextAdBuilder 広告の 2 番目の説明文を設定します。
withFinalUrl(string finalUrl) ExpandedTextAdBuilder 広告のランディング ページ URL を設定します。
withHeadlinePart1(string headlinePart1) ExpandedTextAdBuilder 広告タイトルの最初の部分を設定します。
withHeadlinePart2(string headlinePart2) ExpandedTextAdBuilder 広告タイトルの 2 番目の部分を設定します。
withHeadlinePart3(string headlinePart3) ExpandedTextAdBuilder 広告タイトルの 3 番目の部分を設定します。
withMobileFinalUrl(string mobileFinalUrl) ExpandedTextAdBuilder モバイル デバイス向けに広告の最終ページ URL を設定します。
withPath1(string urlPath1) ExpandedTextAdBuilder 広告の表示 URL に追加する最初のオプション パスを設定します。
withPath2(string urlPath2) ExpandedTextAdBuilder 広告の表示 URL に追加する 2 番目のパス (オプション) を設定します。
withTrackingTemplate(string trackingTemplate) ExpandedTextAdBuilder 広告のトラッキング テンプレートを設定します。

ビルド

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

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

戻り値

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

withCustomParameters(Object customParameters)

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

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

引数

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

戻り値

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

withDescription(string description)

広告の最初の説明文を設定します。 このメソッドは、 withDescription1(string description1) のため非推奨になりました。

引数

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

戻り値

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

withDescription1(string description1)

広告の最初の説明文を設定します。 このメソッドは、 withDescription(string description) と同じフィールドを設定します。

引数

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

戻り値

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

withDescription2(string description2)

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

引数

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

戻り値

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

withFinalUrl(string finalUrl)

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

引数

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

戻り値

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

withHeadlinePart1(string headlinePart1)

広告タイトルの最初の部分を設定します。

引数

名前 説明
headlinePart1 string 広告タイトルの最初の部分。 Microsoft がタイトルのパート 1、2、3 を使用して広告のタイトルを生成する場合、"-" を使用してパーツを連結します。 タイトル パーツにはダッシュは指定しないでください。 タイトルの各部分には少なくとも 1 つの単語が含まれている必要があります。 タイトルの追加の制限とタイトルへの動的テキスト文字列のインクルードについては、「 Bing Ads API」を参照してください。

戻り値

説明
ExpandedTextAdBuilder 広告タイトルのパート 1 が適用された広告ビルダー。

withHeadlinePart2(string headlinePart2)

広告タイトルの 2 番目の部分を設定します。

引数

名前 説明
headlinePart2 string 広告タイトルの 2 番目の部分。 Microsoft がタイトルのパート 1、2、3 を使用して広告のタイトルを生成する場合、"-" を使用してパーツを連結します。 タイトル パーツにはダッシュは指定しないでください。 タイトルの各部分には少なくとも 1 つの単語が含まれている必要があります。 タイトルの追加の制限とタイトルへの動的テキスト文字列のインクルードについては、「 Bing Ads API」を参照してください。

戻り値

説明
ExpandedTextAdBuilder 広告タイトルのパート 1 が適用された広告ビルダー。

withHeadlinePart3(string headlinePart3)

広告タイトルの 3 番目の部分を設定します。

引数

名前 説明
headlinePart3 string 広告タイトルの 3 番目の部分。 Microsoft がタイトルのパート 1、2、3 を使用して広告のタイトルを生成する場合、"-" を使用してパーツを連結します。 タイトル パーツにはダッシュは指定しないでください。 タイトルの各部分には少なくとも 1 つの単語が含まれている必要があります。 タイトルの追加の制限とタイトルへの動的テキスト文字列のインクルードについては、「 Bing Ads API」を参照してください。

戻り値

説明
ExpandedTextAdBuilder 広告タイトルのパート 1 が適用された広告ビルダー。

withMobileFinalUrl(string mobileFinalUrl)

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

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

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

引数

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

戻り値

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

withPath1(string urlPath1)

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

引数

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

戻り値

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

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」を参照してください。

戻り値

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

withTrackingTemplate(string trackingTemplate)

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

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

引数

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

戻り値

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