# wx.openEmbeddedMiniProgram(Object object)

> 基础库 2.20.1 开始支持，低版本需做[兼容处理](1003706)。

> __以 [Promise 风格](/miniprogram/dev/framework/app-service/api.md#异步-API-返回-Promise) 调用__：支持
> 
> __需要页面权限__：当前是插件页面时，宿主小程序不能调用该接口，反之亦然
> 
> __小程序插件__：支持，需要小程序基础库版本不低于 [2.26.2](1003706)
> 
> __微信 鸿蒙 OS 版__：支持
> 
> __限制__：仅在点击行为时调用

## 功能描述

打开半屏小程序。接入指引请参考 [半屏小程序能力](/miniprogram/dev/framework/open-ability/openEmbeddedMiniProgram.md)。

## 参数

### Object object


```json
[
  {
    "属性": "appId",
    "类型": "string",
    "默认值": "",
    "必填": "是",
    "说明": "要打开的小程序 appId",
    "最低版本": ""
  },
  {
    "属性": "path",
    "类型": "string",
    "默认值": "",
    "必填": "否",
    "说明": "打开的页面路径，如果为空则打开首页。path 中 ? 后面的部分会成为 query，在小程序的 \u0000INLINECODE_0\u0000、\u0000INLINECODE_1\u0000 和 \u0000INLINECODE_2\u0000 的回调函数或小游戏的 [wx.onShow](/minigame/dev/api/base/app/life-cycle/wx.onShow.md) 回调函数、[wx.getLaunchOptionsSync](/miniprogram/dev/api/base/app/life-cycle/wx.getLaunchOptionsSync) 中可以获取到 query 数据。对于小游戏，可以只传入 query 部分，来实现传参效果，如：传入 \"?foo=bar\"。",
    "最低版本": ""
  },
  {
    "属性": "extraData",
    "类型": "object",
    "默认值": "",
    "必填": "否",
    "说明": "需要传递给目标小程序的数据，目标小程序可在 \u0000INLINECODE_3\u0000，\u0000INLINECODE_4\u0000 中获取到这份数据。如果跳转的是小游戏，可以在 [wx.onShow](/minigame/dev/api/base/app/life-cycle/wx.onShow.md)、[wx.getLaunchOptionsSync](/miniprogram/dev/api/base/app/life-cycle/wx.getLaunchOptionsSync) 中可以获取到这份数据数据。",
    "最低版本": ""
  },
  {
    "属性": "envVersion",
    "类型": "string",
    "默认值": "release",
    "必填": "否",
    "说明": "要打开的小程序版本。仅在当前小程序为开发版或体验版时此参数有效。如果当前小程序是正式版，则打开的小程序必定是正式版。",
    "最低版本": "",
    "子项": [
      {
        "合法值": "develop",
        "说明": "开发版"
      },
      {
        "合法值": "trial",
        "说明": "体验版"
      },
      {
        "合法值": "release",
        "说明": "正式版"
      }
    ]
  },
  {
    "属性": "shortLink",
    "类型": "string",
    "默认值": "",
    "必填": "否",
    "说明": "小程序链接，当传递该参数后，可以不传 appId 和 path。链接可以通过【小程序菜单】->【复制链接】获取。仅 verify=binding 支持。",
    "最低版本": ""
  },
  {
    "属性": "verify",
    "类型": "string",
    "默认值": "binding",
    "必填": "否",
    "说明": "校验方式。",
    "最低版本": "[2.24.3](1003706)",
    "子项": [
      {
        "合法值": "binding",
        "说明": "校验小程序管理后台的绑定关系。"
      },
      {
        "合法值": "unionProduct",
        "说明": "校验目标打开链接是否为[小程序联盟](https://developers.weixin.qq.com/doc/ministore/union/brief-introduction.html)商品。"
      }
    ]
  },
  {
    "属性": "noRelaunchIfPathUnchanged",
    "类型": "boolean",
    "默认值": "false",
    "必填": "否",
    "说明": "不reLaunch目标小程序，直接打开目标跳转的小程序退后台时的页面，需满足以下条件：1. 目标跳转的小程序生命周期未被销毁；2. 且目标当次启动的path、query与上次启动相同，apiCategory以wx.getApiCategory接口的返回结果为准。",
    "最低版本": "[2.24.0](1003706)"
  },
  {
    "属性": "allowFullScreen",
    "类型": "boolean",
    "默认值": "false",
    "必填": "否",
    "说明": "打开的小程序是否支持全屏。基础库 \u0000INLINECODE_5\u0000 版本起，强制为 true",
    "最低版本": "[2.33.0](1003706)"
  },
  {
    "属性": "success",
    "类型": "function",
    "默认值": "",
    "必填": "否",
    "说明": "接口调用成功的回调函数",
    "最低版本": ""
  },
  {
    "属性": "fail",
    "类型": "function",
    "默认值": "",
    "必填": "否",
    "说明": "接口调用失败的回调函数",
    "最低版本": ""
  },
  {
    "属性": "complete",
    "类型": "function",
    "默认值": "",
    "必填": "否",
    "说明": "接口调用结束的回调函数（调用成功、失败都会执行）",
    "最低版本": ""
  }
]
```
