投放链路服务

如果开发者希望实现页面的原生化渲染，并快速接入字节生态的广告流程，请参考下面步骤：

前置准备

请先前往巨量引擎开放平台open in new window，注册成为开发者并获取相应广告主授权，具体流程详见巨量引擎开放平台的 Oauth2.0 授权流程open in new window。

落地页管理

所有请求 Header

字段	类型	含义
Access-Token 必填	string	授权 access_token，可以通过获取 Access tokenopen in new window接口获取
Content-Type 必填	string	"application/json"

创建 AIP 落地页站点

URL

https://ad.oceanengine.com/open_api/2/tools/aip_third_site/create/

接口描述

通过此接口，开发者可以创建 AIP 落地页站点。

注意

因校验落地页是否为 AIP 落地页是异步进行的，所以创建时若落地页不符合标准落地页规范，也可创建成功。开发者可通过获取 AIP 落地页站点接口返回的校验状态 validate_status 确认是否成功创建 AIP 落地页，校验结果将在创建或更新后实时生成，审核结果将在创建或更新后约 30 分钟生成。

请求方法

POST

请求参数

参数	类型	含义
advertiser_id 必填	number	广告主 id
url 必填	string	站点 URL
name	string	站点名称，长度限制，1-50 字

返回结果

参数	类型	详情
code	number	返回码，详见巨量开放平台返回码open in new window
message	string	返回信息，详见巨量开放平台返回码open in new window
data	object	返回数据
request_id	string	请求日志 id

• data 部分

参数	类型	含义
site_id	number	站点 id

更新 AIP 落地页站点

URL

https://ad.oceanengine.com/open_api/2/tools/aip_third_site/update/

接口描述

开发者可以在修改完第三方落地页的内容后，调用此接口更新站点再次发起落地页标准化校验。

注意

因校验落地页是否为 AIP 落地页是异步进行的，所以更新时若落地页不符合标准落地页规范，也可更新成功。开发者可通过获取 AIP 落地页站点接口返回的校验状态validate_status和update_time确认本次是否成功更新 AIP 落地页，即校验成功则表示此次更新成功，校验失败则表示此次更新失败。校验结果将在创建或更新后实时生成，审核结果将在创建或更新后约 30 分钟生成。

请求方法

POST

请求参数

参数	类型	含义
advertiser_id 必填	number	广告主 id
site_id 必填	number	站点 id

返回结果

参数	类型	详情
code	number	返回码，详见巨量开放平台返回码open in new window
message	string	返回信息，详见巨量开放平台返回码open in new window
data	object	返回数据
request_id	string	请求日志 id

• data 部分

参数	类型	含义
site_id	number	站点 id
success	bool	是否更新成功 注意：此处"是否更新成功"仅代表更新接口调用成功与否，因校验落地页是否为 AIP 落地页是异步进行的，所以更新时若落地页不符合标准落地页规范，也可更新成功。

获取 AIP 落地页站点详情

URL

https://ad.oceanengine.com/open_api/2/tools/aip_third_site/get/

接口描述

通过此接口，开发者可以获取广告主下 AIP 落地页站点详情。

站点详情信息包含：

站点 ID、站点名称、广告主 id、站点 URL、站点创建和更新时间、站点状态、站点审核状态、站点审核信息、站点标准化校验状态、站点标准化校验失败信息。

请求方法

GET

请求参数

参数	类型	含义
advertiser_id 必填	number	广告主 id
site_id 必填	number	站点 id，暂不支持批量查询

返回结果

参数	类型	详情
code	number	返回码，详见巨量开放平台返回码open in new window
message	string	返回信息，详见巨量开放平台返回码open in new window
data	object	返回数据
request_id	string	请求日志 id

• data 部分

参数	类型	含义
site_id	number	站点 id
name	string	站点名称
adveriser_id	number	广告主 id
url	string	站点 URL
create_time	string	站点创建时间
update_time	string	站点更新时间
audit_status	string	站点审核状态 枚举值： AUDIT_UNKNOW - 未知 AUDIT_ACCEPTED - 审核通过 AUDIT_REJECTED - 审核拒绝 AUDIT_BANNED - 审核封禁 AUDITING - 已送审审核中 AWAIT_AUDIT - 待审核
validate_status	string	站点标准化校验状态 枚举值： VALIDATE_SUCCESS - 校验成功 VALIDATE_FAIL - 校验失败 UN_VALIDATE - 未校验
validate_message	string	站点标准化校验失败信息

获取 AIP 落地页站点列表

URL

https://ad.oceanengine.com/open_api/2/tools/aip_third_site/list/

接口描述

通过此接口，开发者可以获取广告主下 AIP 落地页站点列表。

注意

注意：通过此列表接口获取的站点必须曾经通过校验（也即需要符合 AIP 语法，无须通过审核）。若从未通过 AIP 语法校验，则不会被认定为 AIP 站点，也即不会出现在此列表接口中。

请求方法

POST

请求参数

参数	类型	含义
advertiser_id 必填	number	广告主 id
page	number	页码,默认值: 1，范围：page >= 1
page_size	number	页面数据量，默认值: 20,取值范围：1 ～ 100
filter	object	过滤字段

• filter 部分

参数	类型	含义
site_ids	number[]	站点 ID 列表（精确匹配）
keyword	string	站点 ID 或站点名称模糊匹配
start_time	string	时间过滤条件：时间范围内创建的落地页，开始时间，形式如：2017-01-01 00:00:00
end_time	string	时间过滤条件：时间范围内创建的落地页，结束时间，形式如：2017-01-01

返回结果

参数	类型	含义
list	object	站点列表
page_info	object	分页信息

• list 部分

参数	类型	含义
create_time	string	站点创建时间
update_time	string	站点更新时间
name	string	站点名称
site_id	number	站点 ID
url	string	站点链接
audit_status	number	审核状态
audit_message	string	审核信息
validate_status	number	校验状态
validate_message	string	校验信息

• page_info 部分

参数	类型	含义
page	number	页码
page_size	number	页面大小
total_number	number	总数
total_page	number	总页数

落地页状态 SPI 订阅服务

SPI 订阅服务：当事件(event)发生时，开放平台会通过主动推送的方式，将事件内容推送到开发者配置好的回调地址。通过 SPI 订阅服务，开发者可以第一时间获取到订阅的事件变化，减少轮询调用带来的流量消耗和接口调用频次消耗。

基于 SPI 订阅服务，我们提供了开发者订阅 AIP 落地页页面状态变更的能力。具体接入步骤如下：

一、 申请应用

确保应用已开通「AIP 落地页管理」权限。

1. 进入巨量引擎开放平台官网
2. 点击右上角「开发者管理后台」
3. 点击左侧菜单栏「基础应用」或「市场应用」
4. 权限范围中确定已勾选开通「工具-建站管理」模块，该模块下能力全选。

如下图所示：

二、配置订阅事件

1. 进入巨量引擎开放平台官网
2. 点击右上角「开发者管理后台」
3. 点击左侧菜单栏「订阅服务」
4. 点击「+新建订阅」
5. 选择「事件推送-AIP 落地页」，按照流程指引填写必要信息。

注意

该功能为白名单功能，如果你无法看到「AIP 落地页」选项，表示你尚未开通相关权限，请联系对接人员或通过工单open in new window系统联系我们。

具体操作如下所示：

三、验证收到相关事件内容

当订阅的具体事件发生时，如授权广告主的 AIP 落地页审核通过时，可收到事件通知。

必要前提：

• 开发者为应用 A 创建了「AIP 落地页事件推送」订阅任务，即上述第二步
• 应用 A 已开通「AIP 落地页管理」的权限，且广告主 b 授权给「AIP 落地页管理」权限并在授权有效期内，b 的应用 A 的 AIP 落地页发生订阅事件的变更，开放平台推送对应的事件通知给到订阅任务中预设的 http 地址，即上述表示第一步

支持订阅的事件

event	事件名称	应用需要开通的权限
AIP_VALIDATE_STATUS	AIP 校验状态变更	/open_api/2/tools/aip_third_site/get/
AIP_AUDIT_STATUS	AIP 落地页审核状态变更	/open_api/2/tools/aip_third_site/get/

回调消息体结构

参数名称	类型	描述
message_id	number	唯一标识一条推送数据
service_label	string	change.aipthirdsite.realtime AIP 落地页事件推送
data	jsonstring	触发推送的事件消息
publish_time	number	本条消息实际产生时间
timestamp	number	推送时间
nonce	number	随机数，和 timestamp 组合防重
subscribe_task_id	number	产生推送数据的订阅任务 id

• data 部分

参数名称	类型	描述
event	string	事件名称
user_id	string	事件触发广告主 id
content	jsonstring	事件内容

• 事件内容 content 部分

EventType 值	含义	数据格式
1	AIP 校验状态变更	{ "site_id": 123 , "validate_status": "" , "validate_message":"" }
2	AIP 落地页审核状态变更	{ "site_id": 123, "audit_status": "", "audit_message":"" }

四、推送失败数据查询（非必要步骤）

接口说明open in new window

SPI 对于推送失败的数据会尝试在一段时间内重新推送，重试多次仍然失败后就会丢弃掉该数据。

提供「推送失败数据查询」接口用于查询推送失败的相关数据，限制最多只能查询一天内数据，即结束时间-开始时间<1 天。

落地页投放

广告主在巨量引擎广告投放平台open in new window按正常 AIP 落地页站点进行广告投放即可。

如需要开启原生化渲染方式，则需要在投放页面的 URL 后加入

?lynx_enable=1&adid=__AID__&creativeid=__CID__&creativetype=__CTYPE__&clickid=__CLICKID__

的 query 标识进行 AIP 站点的创建和广告的投放。