ResponsiveSearchAdBuilder

包含用于定义和创建响应式搜索广告的方法。 有关生成器的信息,请参阅 Builders

用法示例:

    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 (字符串标题,字符串固定) ResponsiveSearchAdBuilder 将提供的标题添加到当前标题列表。 必须使用此方法或 addHeadline () 方法指定至少 3 个标题。
建立 AdOperation 创建广告并返回一个操作对象,用于检查脚本是否成功添加了广告。
withCustomParameters (Object customParameters) ResponsiveSearchAdBuilder 设置广告的自定义参数。
withDescriptions (object[] descriptions) ResponsiveSearchAdBuilder 设置广告的说明。
withFinalUrl (string finalUrl) ResponsiveSearchAdBuilder 设置广告的登陆页 URL。
withFinalUrlSuffix (string finalUrlSuffix) ResponsiveSearchAdBuilder 设置广告的最终 URL 后缀。
withHeadlines (object[] 标题) ResponsiveSearchAdBuilder 设置广告的标题。
withMobileFinalUrl (string mobileFinalUrl) ResponsiveSearchAdBuilder 为移动设备设置广告的最终 URL。
withPath1 (字符串 urlPath1) ResponsiveSearchAdBuilder 设置要追加到广告显示 URL 的第一个可选路径。
withPath2 (字符串 urlPath2) ResponsiveSearchAdBuilder 设置要追加到广告显示 URL 的第二个可选路径。
withTrackingTemplate (字符串 trackingTemplate) ResponsiveSearchAdBuilder 设置广告的跟踪模板。

addDescription (字符串说明、字符串固定)

将提供的说明添加到当前说明列表。 必须使用此方法或 addDescription () 方法至少指定 2 个说明。

参数

名称 类型 说明
说明 string 要添加的广告说明。 有关限制和包含动态文本字符串的信息,请参阅 必应广告 API
寄托 string 可选的固定位置。

说明的可能值为:DESCRIPTION_1、DESCRIPTION_2
text string 此资产的文本。

返回

类型 说明
ResponsiveSearchAdBuilder 应用了说明的广告生成器。

addHeadline (字符串标题,字符串固定)

将提供的标题添加到当前标题列表。 必须使用此方法或 addHeadline () 方法指定至少 3 个标题。

参数

名称 类型 说明
标题 string 要添加的广告标题。 有关限制和包含动态文本字符串的信息,请参阅 必应广告 API
寄托 string 可选的固定位置。

标题的可能值为:HEADLINE_1、HEADLINE_2、HEADLINE_3

返回

类型 说明
ResponsiveSearchAdBuilder 应用了标题的广告生成器。

build

创建广告并返回一个操作对象,用于检查脚本是否成功添加了广告。

有关可添加到广告组的广告数量限制,请参阅 实体层次结构限制

返回

类型 说明
AdOperation 用于检查脚本是否成功添加广告的操作对象。

withCustomParameters (Object customParameters)

设置广告的自定义参数。

自定义参数有助于跨多个 URL 共享动态信息。 有关其用法的详细信息,请参阅 自定义参数

参数

名称 类型 说明
customParameters Object 要应用于广告的最终 URL 的自定义参数的映射。 例如, {key1: 'value1', key2: 'value2', key3: 'value3'}其中键是自定义参数的名称,值是参数的值。 名称最多可包含 16 个 8 字节字符,值最多可包含 200 个 8 字节字符。

返回

类型 说明
ResponsiveSearchAdBuilder 应用了自定义参数的广告生成器。

withDescriptions (object[] descriptions)

设置广告的说明。

参数

名称 类型 说明
描述 AdTextAsset[] 广告的说明。 有关限制和包含动态文本字符串的信息,请参阅 必应广告 API

返回

类型 说明
ResponsiveSearchAdBuilder 应用了说明的广告生成器。

withFinalUrl (string finalUrl)

设置广告的登陆页 URL。

参数

名称 类型 说明
finalUrl string 广告的登陆页 URL。 有关 URL 限制的信息,请参阅 必应广告 API

返回

类型 说明
ResponsiveSearchAdBuilder 应用了最终 URL 的广告生成器。

withFinalUrlSuffix (string finalUrlSuffix)

设置广告的最终 URL 后缀。

参数

名称 类型 说明
finalUrl string 广告的最终 URL 后缀。 有关 URL 限制的信息,请参阅 必应广告 API

返回

类型 说明
ResponsiveSearchAdBuilder 应用了最终 URL 的广告生成器。

withHeadlines (object[] 标题

设置广告的标题。

参数

名称 类型 说明
标题 AdTextAsset[] 广告的头条新闻。 有关限制和包含动态文本字符串的信息,请参阅 必应广告 API

返回

类型 说明
ResponsiveSearchAdBuilder 应用了广告标题的广告生成器。

withMobileFinalUrl (字符串 mobileFinalUrl)

为移动设备设置广告的最终 URL。

最后一个 URL 标识用户在单击广告时将访问的网页。 若要为移动设备指定最终 URL,请先为非移动设备指定最终 URL, (请参阅 withFinalUrl()) 。

有关详细信息,请参阅 我可以使用哪些跟踪或 URL 参数?

参数

名称 类型 说明
mobileFinalUrl string 移动设备的最终 URL。

返回

类型 说明
ResponsiveSearchAdBuilder 应用了移动最终 URL 的广告生成器。

withPath1 (字符串 urlPath1)

设置要追加到广告显示 URL 的第一个可选路径。

参数

名称 类型 说明
mobileFinalUrl string 要追加到广告显示 URL 的第一个可选路径。 Microsoft 使用 中指定的 withFinalUrl 域作为显示 URL。 如果最终 URL 的域 contoso.com 并且路径为 shoes,则广告的显示 URL 将 contoso.com/shoes。 有关使用情况和限制,请参阅 Path1

返回

类型 说明
ResponsiveSearchAdBuilder 应用了路径的广告生成器。

withPath2 (字符串 urlPath2)

设置要追加到广告显示 URL 的第二个可选路径。

参数

名称 类型 说明
mobileFinalUrl string 要追加到广告显示 URL 的第二个可选路径。 若要指定第二个路径,请先指定第一个路径, (请参阅 withPath1) 。 Microsoft 使用 中指定的 withFinalUrl 域作为显示 URL。 如果最终 URL 的域 contoso.com,第一个路径是 ,第二个路径是 女士,则广告的显示 URL contoso.com/shoes/ladies。 有关使用情况和限制,请参阅 Path2

返回

类型 说明
ResponsiveSearchAdBuilder 应用了路径的广告生成器。

withTrackingTemplate (string trackingTemplate)

设置广告的跟踪模板。

跟踪模板与关键字 (keyword) 的 FinalUrl 一起使用,以创建广告使用的目标 URL。 有关详细信息,请参阅 我可以使用哪些跟踪或 URL 参数?

参数

名称 类型 说明
trackingTemplate string 要用于此广告的跟踪模板。

返回

类型 说明
ResponsiveSearchAdBuilder 应用了跟踪模板的广告生成器。