For the complete documentation index, see llms.txt. This page is also available as Markdown.

响应区域

Ad Placement API 返回的 JSON 包含 区域 数组以及 渲染器用户 对象。

在本页中,我们将解释 区域 数组,其中包含与你的广告请求中获胜广告有关的所有详细信息。

该数组包含一个对象,其中为请求的每个区域 ID 提供广告数据。

属性
描述

idzone

广告区域的 ID。

type

所使用的广告格式,例如 横幅广告.

data

广告数据(对象)

下面将列出根据可用广告格式,为每个 data 对象返回的详细属性列表。

横幅广告

属性
描述

url

广告指向的 URL。

impression

展示 URL

image

为广告上传的原始图片。

optimum_image

如果上传的创意是动画 GIF,则这是系统为广告使用而生成的优化版 MP4。

width

广告宽度(像素)。

height

广告高度(像素)。

media

这表示这是哪种横幅广告:图片、HTML 或视频;应分别为 img_banner, html_bannervideo_banner

横幅广告响应示例

图片横幅广告:

HTML 横幅广告:

视频横幅广告:

粘性横幅广告

属性
描述

url

点击 URL

impression

展示 URL

image

为广告上传的原始图片。

optimum_image

在粘性横幅广告中,如果上传的创意是动画 GIF,则这是系统为广告使用而生成的优化版 MP4。

width

广告宽度(像素)。

height

广告高度(像素)。

frequency_period

广告展示的频率,单位为分钟。

v_pos

广告的垂直位置。

h_pos

广告的水平位置。

media

这表示这是哪种横幅广告:图片、HTML 或视频;应分别为 img_banner, html_banner,或 video_banner 分别。

粘性横幅广告响应示例

即时消息

属性
描述

url

点击 URL

impression

展示 URL

image

图片的 URL

optimum_image

如果上传的创意是动画 GIF,则这是系统为广告使用而生成的优化版 MP4。

width

广告宽度(像素)。

height

广告高度(像素)。

frequency_period

广告展示的间隔时间,单位为分钟。

media

这表示使用的是哪种横幅广告:图片、HTML 或视频;应分别为 img_banner, html_banner,或 video_banner 分别。

即时消息响应示例

原生广告

当响应返回原生广告时,zones.data 将返回两个对象: layoutad_items

data.layout

属性
描述

widgetHeaderContentHtml

显示的“Powered by”品牌链接的 URL。*

branding_logo

启用时显示的品牌徽标 URL。*

branding_logo_hover

当用户将鼠标悬停其上时显示的品牌徽标 URL。*

itemsPerRow

小组件每行显示的广告数量。

itemsPerCol

小组件每列显示的广告数量。

font_family

广告中使用的字体系列。

header_font_size

品牌标题中使用的字体大小。

header_font_color

品牌标题中使用的字体颜色。

widget_background_color

小组件背景颜色的十六进制代码。

widget_width

整个小组件的宽度。

minimum_width_for_full_sized_layout

完整尺寸布局的最小宽度(像素)。

item_height

每个单独广告的高度。

item_padding

广告之间的内边距。

image_height

每个广告中图片的高度。

image_width

每个广告中图片的宽度。

text_margin_top

顶部文本边距的像素大小。

text_margin_bottom

底部文本边距的像素大小。

text_margin_left

左侧文本边距的像素大小。

text_margin_right

右侧文本边距的像素大小。

title_font_size

每个广告标题的字体大小。

title_font_color

每个广告标题的字体颜色。

title_font_weight

每个广告标题的字体粗细。

title_decoration

标题是否带下划线。

title_hover_color

标题悬停时的字体颜色。

title_hover_font_weight

标题悬停时的字体粗细。

title_hover_decoration

标题悬停时是否带下划线。

description_font_size

每个广告描述的字体大小。

description_font_color

每个广告描述的字体颜色。

description_font_weight

每个广告描述的字体粗细。

description_decoration

描述是否带下划线。

description_hover_color

描述悬停时的字体颜色。

description_hover_font_weight

描述悬停时的字体粗细。

description_hover_decoration

描述悬停时是否带下划线。

open_in_new_window

点击时是否应在新窗口中打开广告。1=是,0=否。

mobile_responsive_type

在移动设备上使用时的响应式类型(即 none 或 compact)。1=compact,0=no。

header_is_on_top

品牌标题应显示在广告上方还是下方。1=是,0=否。

header_text_align

品牌标题的水平对齐方式。

title_enabled

标题是否启用。1=是,0=否。

description_enabled

描述是否启用。1=是,0=否。

image_border_size

图片边框的像素大小。

image_border_color

图片边框的十六进制颜色代码。

text_align

文本对齐方式:左、中或右。

customcss_enabled

是否启用自定义 CSS。1=是,0=否。

customcss

如果已启用,自定义 CSS 将显示在这里。

header_enabled

标题是否启用。1=是,0=否。

mobile_breakpoint

广告区域在桌面端和移动端视图之间的断点(像素)。

spacing_v

高级选项中设置的广告之间的垂直间距(像素)。

spacing_h

高级选项中设置的广告之间的水平间距(像素)。

zoom

广告在悬停时是否应放大/缩小。

mobile_rows

移动端小组件中的广告行数。

mobile_cols

移动端小组件中的广告列数。

use_v2_script

该广告区域是使用较新的 V2 设置创建的,还是旧的 v1 设置创建的。

text_enabled

是否应显示文本标题和描述。1=是,0=否。

mobile_image_width

移动端每个广告中图片的宽度。

mobile_text_box_size

移动端文本框大小。有效范围 50-500。

mobile_text_enabled

移动端标题是否启用。1=是,0=否。

mobile_text_position

移动端文本的位置:底部或右侧。

item_spacing_on_each_side

如果使用旧的 v1 设置,则广告两侧的内边距。

text_position

文本位于左侧还是右侧。

text_box_size

文本框大小(像素)。范围 50-500。

widget_height

整个小组件的高度。

brand_enabled

品牌信息是否启用。

brand_font_size

品牌信息的字体大小。

brand_font_color

品牌信息的字体颜色。

brand_font_weight

品牌信息的字体粗细。

brand_decoration

字体是否带下划线。

mobile_image_height

移动端每个广告中图片的高度。

publisherAdType

这是什么类型的原生广告,即推荐、退出或插页式广告: native-recommendation, native-interstitial.

data.ad_items

属性
描述

idvariation

变体的 ID。

image

为广告上传的原始图片。

url

点击 URL。

impression

展示 URL。

title

广告标题文本。

description

广告描述文本。

brand

广告的品牌文本。

original_url

落地页的原始 URL。

image_position

广告图片的位置(图片将如何裁剪)。

size

所选广告格式的尺寸

iframe_url

如果使用 iframe 作为变体,则这是该 iframe 的 URL。

video_thumb_id

与广告创意关联的视频缩略图资源标识符(如有)。

video_thumb_url

视频缩略图资源(如有)的 URL。

video_thumb_enabled

视频缩略图资源(如有)的状态。

原生广告响应示例

外播视频

属性
描述

url

点击 URL

跟踪

包含跟踪信息的对象。

视频

要加载的视频广告文件或 VAST 链接。

brandingEnabled

启用品牌展示的标记。 此值当前未使用

frequencyPeriod

广告展示的频率,单位为分钟。

maximumWidth

视频宽度大小。

isVast

表示获胜广告活动是普通视频广告(false)还是 VAST 链接广告活动(true)。

ctaEnabled

是否在广告上显示 CTA 的标记

cta

包含 CTA 详情的对象

impression

展示 URL

data.tracking

目前, data.tracking 对象仅返回一个 进度 包含用于跟踪视频播放的对象数组。在这些对象中,具有 "offset": "00:00:10.000" 的是用于记录视频观看的那个。每个对象的属性说明如下:

属性
描述

offset

以秒或视频广告播放百分比表示的进度标记

url

跟踪 URL

data.cta

属性
描述

displayUrl

与广告落地页相关的 URL

文本

用于 CTA 元素的文本

外播视频响应示例

视频滑块

属性
描述

url

点击 URL

跟踪

包含跟踪信息的对象。

视频

要加载的视频广告文件或 VAST 链接。

屏幕密度

表示广告在用户设备上占用的最大屏幕空间比例的整数

完成后行为

指示广告在视频播放结束后的行为。"hide" 表示广告应隐藏,而 "repeat" 表示广告应留在页面上以便用户重新播放

关闭延迟

指示广告显示关闭按钮前需要的秒数

brandingEnabled

启用品牌展示的标记。 此属性当前未使用

frequencyPeriod

广告展示的频率,单位为分钟。

impression

展示 URL

isVast

表示获胜广告活动是普通视频广告(false)还是 VAST 链接广告活动(true)。

ctaEnabled

是否在广告上显示 CTA 的标记

cta

包含 CTA 详情的对象

data.tracking

目前, data.tracking 对象仅返回一个 进度 包含用于跟踪视频播放的对象数组。在这些对象中,具有 "offset": "00:00:10.000" 的是用于记录视频观看的那个。每个对象的属性说明如下:

属性
描述

offset

以秒或视频广告播放百分比表示的进度标记

url

跟踪 URL

data.cta

属性
描述

displayUrl

与广告落地页相关的 URL

文本

用于 CTA 元素的文本

视频滑块响应示例

全屏插页广告

属性
描述

url

点击 URL

impression

展示 URL

image

为广告上传的原始图片。

optimum_image

如果上传的创意是动画 GIF,则这是系统为广告使用而生成的优化版 MP4。

width

广告宽度(像素)。

height

广告高度(像素)。

frequency_count

广告可展示的次数

frequency_period

广告每隔多少分钟展示一次

frequency_trigger_type

标记此广告的频次是基于展示(0)还是点击(1)

ad_trigger_method

此广告区域启用的触发方式

ad_trigger_classes

应触发广告的类(如果有)

first_trigger_clicks

用户首次访问时触发广告所需的点击次数

next_trigger_clicks

广告首次触发后再次展示广告所需的点击次数

chrome_enabled

标记此广告区域是否对 Chrome 启用(1)、禁用(0)或仅对此浏览器启用(2)

capping_enabled

标记是否应对此广告区域执行限频

media

这表示这是哪种横幅广告:图片、HTML 或视频;应分别为 img_banner, html_bannervideo_banner

注意: Fullpage Interstitial 响应的大多数属性都与广告的限频和触发有关。由于广告由你负责渲染,因此是否关注这些属性由你自行决定。

全屏插页广告响应示例

请注意,尽管示例展示的是桌面端全屏插页广告,但移动端全屏插页广告的响应除 zone.type 外应相同。

页面内推送

属性
描述

url

点击 URL

impression

展示 URL

image

为广告上传的原始图片。

optimum_image

如果上传的创意是动画 GIF,则这是系统为广告使用而生成的优化版 MP4。

title

通知标题

description

通知描述

水平位置

指示页面上的水平位置(左、中、右)

垂直位置

指示页面上的垂直位置(上、中、下)

延迟

页面加载后通知出现前的秒数

页面最大通知数

页面上可同时出现的通知数量

关闭后隐藏时长

广告关闭后隐藏的时长(秒)(需要用户同意 Cookie)

用户会话限频

广告展示给用户的次数(需要用户同意 Cookie)

通知间延迟

前一条通知加载后到下一条通知出现前的秒数

页面内推送通知响应示例

多格式

Multi-Format 请求的响应可能返回不同结果:

  • 如果获胜广告是原生广告系列,则响应将包含一个 常规原生数据对象。

  • 如果获胜广告是横幅广告系列,并且你有一个 单区域 布局,则响应将包含一个 常规横幅数据对象。

  • 如果获胜广告是横幅广告系列,并且你选择了一个具有 多个广告的布局,则响应将包含一个 对象,具有以下属性:

属性
描述

方向

多区域布局的方向,可以是"horizontal"或"vertical"

ad_items

包含布局中每个位置广告数据的数组。

无论结果如何,属性 多区域 ID 都会被添加到响应中,用于指示此响应对应的多格式广告区域的区域 ID。

多格式响应示例

以下示例显示了 区域 一个 Multi-Format 广告区域的对象,其中包含一个 横向 x 3 布局:

响应式展示广告

某些格式,如横幅广告和全屏插页广告,可以启用 响应式展示广告 以接收来自原生广告系列的需求,以及其原始广告格式的需求。在这种情况下,响应将包含 original_zone 对象,用于指示原始格式的类型和数据。

下面是横幅广告格式的示例:

曝光追踪

请务必对曝光 URL 发起 GET 请求,以便为您的广告请求记录曝光。实现这一点的一种方法是在展示广告的页面上,使用曝光 URL 作为源创建一张不可见的图片文件,例如:

最后更新于

这有帮助吗?