@hyext/types-ext-sdk-hy 4.2.5-beta.9 → 4.2.6-beta.2

package/index.d.ts

@@ -582,6 +582,154 @@ namespace ad {
      * @returns 调用结果
      */
     function offAdMessage(): Promise<void>;
+    /**
+     * 创建原生模板广告组件
+     * @param params - 传入参数
+     * @returns 调用结果
+     */
+    function createCustomAd(params: CreateCustomAdReq): Promise<CreateCustomAdRsp>;
+    /**
+     * 创建激励视频广告组件
+     * @param params - 传入参数
+     * @returns 调用结果
+     */
+    function createRewardedVideoAd(params: CreateRewardedVideoAdReq): Promise<CreateRewardedVideoAdRsp>;
+    /**
+     * 销毁原生模板广告组件
+     * @param params - 传入参数
+     * @returns 调用结果
+     */
+    function destroyCustomAd(params: DestroyCustomAdReq): Promise<DestroyCustomAdRsp>;
+    /**
+     * 销毁激励视频广告组件
+     * @param params - 传入参数
+     * @returns 调用结果
+     */
+    function destroyRewardedVideoAd(params: DestroyRewardedVideoAdReq): Promise<DestroyRewardedVideoAdRsp>;
+    /**
+     * 获取原生模版广告组件的信息
+     * @param params - 传入参数
+     * @returns 调用结果
+     */
+    function getCustomAdInfo(params: GetCustomAdInfoReq): Promise<GetCustomAdInfoRsp>;
+    /**
+     * 隐藏原生模版广告组件
+     * @param params - 传入参数
+     * @returns 调用结果
+     */
+    function hideCustomAd(params: HideCustomAdReq): Promise<HideCustomAdRsp>;
+    /**
+     * 加载激励视频广告组件
+     * @param params - 传入参数
+     * @returns 调用结果
+     */
+    function loadRewardedVideoAd(params: LoadRewardedVideoAdReq): Promise<LoadRewardedVideoAdRsp>;
+    /**
+     * 监听原生模版广告组件的close消息
+     * @param params - 传入参数
+     * @returns 调用结果
+     */
+    function onCustomAdClose(params: OnCustomAdCloseReq): Promise<void>;
+    /**
+     * 取消监听原生模版广告组件的close消息
+     * @returns 调用结果
+     */
+    function offCustomAdClose(): Promise<void>;
+    /**
+     * 监听原生模版广告组件的error消息
+     * @param params - 传入参数
+     * @returns 调用结果
+     */
+    function onCustomAdError(params: OnCustomAdErrorReq): Promise<void>;
+    /**
+     * 取消监听原生模版广告组件的error消息
+     * @returns 调用结果
+     */
+    function offCustomAdError(): Promise<void>;
+    /**
+     * 监听原生模版广告组件的hide消息
+     * @param params - 传入参数
+     * @returns 调用结果
+     */
+    function onCustomAdHide(params: OnCustomAdHideReq): Promise<void>;
+    /**
+     * 取消监听原生模版广告组件的hide消息
+     * @returns 调用结果
+     */
+    function offCustomAdHide(): Promise<void>;
+    /**
+     * 监听原生模版广告组件的load消息
+     * @param params - 传入参数
+     * @returns 调用结果
+     */
+    function onCustomAdLoad(params: OnCustomAdLoadReq): Promise<void>;
+    /**
+     * 取消监听原生模版广告组件的load消息
+     * @returns 调用结果
+     */
+    function offCustomAdLoad(): Promise<void>;
+    /**
+     * 监听原生模版广告组件的resize消息
+     * @param params - 传入参数
+     * @returns 调用结果
+     */
+    function onCustomAdResize(params: OnCustomAdResizeReq): Promise<void>;
+    /**
+     * 取消监听原生模版广告组件的resize消息
+     * @returns 调用结果
+     */
+    function offCustomAdResize(): Promise<void>;
+    /**
+     * 监听激励视频广告组件的close消息
+     * @param params - 传入参数
+     * @returns 调用结果
+     */
+    function onRewardedVideoAdClose(params: OnRewardedVideoAdCloseReq): Promise<void>;
+    /**
+     * 取消监听激励视频广告组件的close消息
+     * @returns 调用结果
+     */
+    function offRewardedVideoAdClose(): Promise<void>;
+    /**
+     * 监听激励视频广告组件的error消息
+     * @param params - 传入参数
+     * @returns 调用结果
+     */
+    function onRewardedVideoAdError(params: OnRewardedVideoAdErrorReq): Promise<void>;
+    /**
+     * 取消监听激励视频广告组件的error消息
+     * @returns 调用结果
+     */
+    function offRewardedVideoAdError(): Promise<void>;
+    /**
+     * 监听激励视频广告组件的load消息
+     * @param params - 传入参数
+     * @returns 调用结果
+     */
+    function onRewardedVideoAdLoad(params: OnRewardedVideoAdLoadReq): Promise<void>;
+    /**
+     * 取消监听激励视频广告组件的load消息
+     * @returns 调用结果
+     */
+    function offRewardedVideoAdLoad(): Promise<void>;
+    /**
+     * 打开原生模版广告组件落地页
+     * @param params - 传入参数
+     * @returns 调用结果
+     */
+    function openCustomAd(params: OpenCustomAdReq): Promise<OpenCustomAdRsp>;
+    /**
+     * 显示原生模版广告组件
+     * @param params - 传入参数
+     * @returns 调用结果
+     */
+    function showCustomAd(params: ShowCustomAdReq): Promise<ShowCustomAdRsp>;
+    /**
+     * 显示激励视频广告组件
+     * @param params - 传入参数
+     * @returns 调用结果
+     */
+    function showRewardedVideoAd(params: ShowRewardedVideoAdReq): Promise<ShowRewardedVideoAdRsp>;
 }
 
 /**
@@ -797,6 +945,416 @@ type OnAdMessageReq = {
     callback: AdMessageCallback;
 };
 
+/**
+ * 原生模板广告组件的样式
+ * @property left - 原生模板广告组件的左上角横坐标
+ * @property top - 原生模板广告组件的左上角纵坐标
+ * @property [width] - 原生模板广告组件的宽度（仅在某些模板生效，如矩阵格子）
+ * @property [fixed] - (只对小程序适用) 原生模板广告组件是否固定屏幕位置（不跟随屏幕滚动）
+ */
+type CustomAdStyle = {
+    left: number;
+    top: number;
+    width?: number;
+    fixed?: boolean;
+};
+
+/**
+ * 创建原生模板广告组件参数
+ * @property adUnitId - 广告单元 id
+ * @property adIntervals - 广告自动刷新的间隔时间，单位为秒，参数值必须大于等于30（仅对支持自动刷新的模板生效）
+ * @property style - 原生模板广告组件的样式
+ */
+type CreateCustomAdReq = {
+    adUnitId: string;
+    adIntervals: number;
+    style: CustomAdStyle;
+};
+
+/**
+ * 创建原生模板广告组件结果
+ * @property errMsg - 错误信息，如果调用成功返回 ${apiName}:ok
+ * @property errCode - 错误码，成功时为 0，失败时参考错误码说明
+ * @property errno - 错误码，成功时为 0，失败时参考错误码说明
+ * @property customAdId - 原生模板广告组件id
+ */
+type CreateCustomAdRsp = {
+    errMsg: string;
+    errCode: number;
+    errno: number;
+    customAdId: string;
+};
+
+/**
+ * 创建激励视频广告组件参数
+ * @property adUnitId - 广告单元 id
+ * @property [multiton] - 是否启用多例模式，默认为false
+ * @property [disableFallbackSharePage] - 是否禁用分享页，默认为false
+ */
+type CreateRewardedVideoAdReq = {
+    adUnitId: string;
+    multiton?: boolean;
+    disableFallbackSharePage?: boolean;
+};
+
+/**
+ * 创建激励视频广告组件结果
+ * @property errMsg - 错误信息，如果调用成功返回 ${apiName}:ok
+ * @property errCode - 错误码，成功时为 0，失败时参考错误码说明
+ * @property errno - 错误码，成功时为 0，失败时参考错误码说明
+ * @property rewardedVideoAdId - 激励视频广告组件id
+ */
+type CreateRewardedVideoAdRsp = {
+    errMsg: string;
+    errCode: number;
+    errno: number;
+    rewardedVideoAdId: string;
+};
+
+/**
+ * 销毁原生模板广告组件参数
+ * @property customAdId - 原生模板广告组件id
+ */
+type DestroyCustomAdReq = {
+    customAdId: string;
+};
+
+/**
+ * 销毁原生模板广告组件结果
+ * @property errMsg - 错误信息，如果调用成功返回 ${apiName}:ok
+ * @property errCode - 错误码，成功时为 0，失败时参考下面的错误码说明
+ * @property errno - 错误码，成功时为 0，失败时参考下面的错误码说明
+ */
+type DestroyCustomAdRsp = {
+    errMsg: string;
+    errCode: number;
+    errno: number;
+};
+
+/**
+ * 销毁激励视频广告组件参数
+ * @property rewardedVideoAdId - 激励视频广告组件id
+ */
+type DestroyRewardedVideoAdReq = {
+    rewardedVideoAdId: string;
+};
+
+/**
+ * 销毁激励视频广告组件结果
+ * @property errMsg - 错误信息，如果调用成功返回 ${apiName}:ok
+ * @property errCode - 错误码，成功时为 0，失败时参考下面的错误码说明
+ * @property errno - 错误码，成功时为 0，失败时参考下面的错误码说明
+ */
+type DestroyRewardedVideoAdRsp = {
+    errMsg: string;
+    errCode: number;
+    errno: number;
+};
+
+/**
+ * 获取原生模版广告组件的信息参数
+ * @property customAdId - 原生模版广告组件id
+ */
+type GetCustomAdInfoReq = {
+    customAdId: string;
+};
+
+/**
+ * 获取原生模版广告组件的信息结果
+ * @property errCode - 错误码，成功时为 0，失败时参考下面的错误码说明
+ * @property errno - 错误码，成功时为 0，失败时参考下面的错误码说明
+ * @property isShow - 原生模板广告是否正在展示
+ */
+type GetCustomAdInfoRsp = {
+    errCode: number;
+    errno: number;
+    isShow: boolean;
+};
+
+/**
+ * 隐藏原生模版广告组件参数
+ * @property customAdId - 原生模版广告组件id
+ */
+type HideCustomAdReq = {
+    customAdId: string;
+};
+
+/**
+ * 隐藏原生模版广告组件结果
+ * @property errMsg - 错误信息，如果调用成功返回 ${apiName}:ok
+ * @property errCode - 错误码，成功时为 0，失败时参考下面的错误码说明
+ * @property errno - 错误码，成功时为 0，失败时参考下面的错误码说明
+ */
+type HideCustomAdRsp = {
+    errMsg: string;
+    errCode: number;
+    errno: number;
+};
+
+/**
+ * 加载激励视频广告组件参数
+ * @property rewardedVideoAdId - 激励视频广告组件id
+ */
+type LoadRewardedVideoAdReq = {
+    rewardedVideoAdId: string;
+};
+
+/**
+ * 加载激励视频广告组件结果
+ * @property errMsg - 错误信息，如果调用成功返回 ${apiName}:ok
+ * @property errCode - 错误码，成功时为 0，失败时参考下面的错误码说明
+ * @property errno - 错误码，成功时为 0，失败时参考下面的错误码说明
+ */
+type LoadRewardedVideoAdRsp = {
+    errMsg: string;
+    errCode: number;
+    errno: number;
+};
+
+/**
+ * 原生模版广告组件关闭消息
+ * @property customAdId - 原生模板广告组件id
+ */
+type OnCustomAdCloseNotice = {
+    customAdId: string;
+};
+
+/**
+ * @param notice - 原生模版广告组件关闭消息
+ */
+type OnCustomAdCloseCallback = (notice: OnCustomAdCloseNotice) => void;
+
+/**
+ * 监听原生模版广告组件的close消息参数
+ * @property callback - 消息回调函数
+ */
+type OnCustomAdCloseReq = {
+    callback: OnCustomAdCloseCallback;
+};
+
+/**
+ * 原生模版广告组件错误消息
+ * @property customAdId - 原生模板广告组件id
+ * @property errMsg - 错误信息
+ * @property errCode - 错误码（参考下面微信的文档）
+ */
+type OnCustomAdErrorNotice = {
+    customAdId: string;
+    errMsg: string;
+    errCode: number;
+};
+
+/**
+ * @param notice - 原生模版广告组件错误消息
+ */
+type OnCustomAdErrorCallback = (notice: OnCustomAdErrorNotice) => void;
+
+/**
+ * 监听原生模版广告组件的error消息参数
+ * @property callback - 消息回调函数
+ */
+type OnCustomAdErrorReq = {
+    callback: OnCustomAdErrorCallback;
+};
+
+/**
+ * 原生模版广告组件隐藏消息
+ * @property customAdId - 原生模板广告组件id
+ */
+type OnCustomAdHideNotice = {
+    customAdId: string;
+};
+
+/**
+ * @param notice - 原生模版广告组件隐藏消息
+ */
+type OnCustomAdHideCallback = (notice: OnCustomAdHideNotice) => void;
+
+/**
+ * 监听原生模版广告组件的hide消息参数
+ * @property callback - 消息回调函数
+ */
+type OnCustomAdHideReq = {
+    callback: OnCustomAdHideCallback;
+};
+
+/**
+ * 原生模版广告组件加载消息
+ * @property customAdId - 原生模板广告组件id
+ */
+type OnCustomAdLoadNotice = {
+    customAdId: string;
+};
+
+/**
+ * @param notice - 原生模版广告组件加载消息
+ */
+type OnCustomAdLoadCallback = (notice: OnCustomAdLoadNotice) => void;
+
+/**
+ * 监听原生模版广告组件的load消息参数
+ * @property callback - 消息回调函数
+ */
+type OnCustomAdLoadReq = {
+    callback: OnCustomAdLoadCallback;
+};
+
+/**
+ * 原生模版广告组件缩放消息
+ * @property customAdId - 原生模板广告组件id
+ * @property width - 缩放后的宽度
+ * @property height - 缩放后的高度
+ */
+type OnCustomAdResizeNotice = {
+    customAdId: string;
+    width: number;
+    height: number;
+};
+
+/**
+ * @param notice - 原生模版广告组件缩放消息
+ */
+type OnCustomAdResizeCallback = (notice: OnCustomAdResizeNotice) => void;
+
+/**
+ * 监听原生模版广告组件的resize消息参数
+ * @property callback - 消息回调函数
+ */
+type OnCustomAdResizeReq = {
+    callback: OnCustomAdResizeCallback;
+};
+
+/**
+ * 激励视频广告组件关闭消息
+ * @property rewardedVideoAdId - 激励视频广告组件id
+ * @property isEnded - 视频是否是在用户完整观看的情况下被关闭的
+ */
+type OnRewardedVideoAdCloseNotice = {
+    rewardedVideoAdId: string;
+    isEnded: boolean;
+};
+
+/**
+ * @param notice - 激励视频广告组件关闭消息
+ */
+type OnRewardedVideoAdCloseCallback = (notice: OnRewardedVideoAdCloseNotice) => void;
+
+/**
+ * 监听激励视频广告组件的close消息参数
+ * @property callback - 消息回调函数
+ */
+type OnRewardedVideoAdCloseReq = {
+    callback: OnRewardedVideoAdCloseCallback;
+};
+
+/**
+ * 激励视频广告组件错误消息
+ * @property rewardedVideoAdId - 激励视频广告组件id
+ * @property errMsg - 错误信息
+ * @property errCode - 错误码
+ */
+type OnRewardedVideoAdErrorNotice = {
+    rewardedVideoAdId: string;
+    errMsg: string;
+    errCode: number;
+};
+
+/**
+ * @param notice - 激励视频广告组件错误消息
+ */
+type OnRewardedVideoAdErrorCallback = (notice: OnRewardedVideoAdErrorNotice) => void;
+
+/**
+ * 监听激励视频广告组件的error消息参数
+ * @property callback - 消息回调函数
+ */
+type OnRewardedVideoAdErrorReq = {
+    callback: OnRewardedVideoAdErrorCallback;
+};
+
+/**
+ * 激励视频广告组件加载消息
+ * @property rewardedVideoAdId - 激励视频广告组件id
+ * @property useFallbackSharePage - 仅小游戏支持，本次展示使用激励广告分享页
+ */
+type OnRewardedVideoAdLoadNotice = {
+    rewardedVideoAdId: string;
+    useFallbackSharePage: boolean;
+};
+
+/**
+ * @param notice - 激励视频广告组件加载消息
+ */
+type OnRewardedVideoAdLoadCallback = (notice: OnRewardedVideoAdLoadNotice) => void;
+
+/**
+ * 监听激励视频广告组件的load消息参数
+ * @property callback - 消息回调函数
+ */
+type OnRewardedVideoAdLoadReq = {
+    callback: OnRewardedVideoAdLoadCallback;
+};
+
+/**
+ * 打开原生模版广告组件落地页参数
+ * @property customAdId - 原生模版广告组件id
+ */
+type OpenCustomAdReq = {
+    customAdId: string;
+};
+
+/**
+ * 打开原生模版广告组件落地页结果
+ * @property errMsg - 错误信息，如果调用成功返回 ${apiName}:ok
+ * @property errCode - 错误码，成功时为 0，失败时参考下面的错误码说明
+ * @property errno - 错误码，成功时为 0，失败时参考下面的错误码说明
+ */
+type OpenCustomAdRsp = {
+    errMsg: string;
+    errCode: number;
+    errno: number;
+};
+
+/**
+ * 显示原生模版广告组件参数
+ * @property customAdId - 原生模版广告组件id
+ */
+type ShowCustomAdReq = {
+    customAdId: string;
+};
+
+/**
+ * 显示原生模版广告组件结果
+ * @property errMsg - 错误信息，如果调用成功返回 ${apiName}:ok
+ * @property errCode - 错误码，成功时为 0，失败时参考下面的错误码说明
+ * @property errno - 错误码，成功时为 0，失败时参考下面的错误码说明
+ */
+type ShowCustomAdRsp = {
+    errMsg: string;
+    errCode: number;
+    errno: number;
+};
+
+/**
+ * 显示激励视频广告组件参数
+ * @property rewardedVideoAdId - 激励视频广告组件id
+ */
+type ShowRewardedVideoAdReq = {
+    rewardedVideoAdId: string;
+};
+
+/**
+ * 显示激励视频广告组件结果
+ * @property errMsg - 错误信息，如果调用成功返回 ${apiName}:ok
+ * @property errCode - 错误码，成功时为 0，失败时参考下面的错误码说明
+ * @property errno - 错误码，成功时为 0，失败时参考下面的错误码说明
+ */
+type ShowRewardedVideoAdRsp = {
+    errMsg: string;
+    errCode: number;
+    errno: number;
+};
+
 /**
  * 高级模块
  */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hyext/types-ext-sdk-hy",
-  "version": "4.2.5-beta.9",
+  "version": "4.2.6-beta.2",
   "description": "TypeScript definitions for sdk",
   "types": "./index.d.ts",
   "main": "",