集成中心是GMP对接外部系统的平台，支持数据转换、接口对接、iframe接入等多种对接能力。本文主要介绍以iframe的方式嵌入GMP系统的对接方案。

iframe接入支持外部系统以iframe的方式嵌入到GMP系统中。目前支持以下点位的iframe嵌入：

1. 导航栏嵌入：外部系统嵌入到GMP菜单，点击展示用户自有系统。
   
2. 人群范围配置：在消息触达-新建分群、流程画布进入条件/策略器中，已有分群的新建分群功能展示用户自有系统，用户在自有系统完成人群配置后，返回 GMP 引用同步到 GMP 的人群配置。
   
3. 触发事件：在消息触达-触发条件-完成 A、流程画布触发条件-完成 A、流程画布策略器-按事件分流功能中，触发事件设置展示用户自有系统，用户配置完成之后，传输数据到GMP，GMP在实际执行触达任务中，以用户配置的规则执行。
   
4. 在消息触达-数据分析、流程画布-数据分析功能中，增加自定义的数据分析跳转入口，用户点击自定义数据分析，跳转自有系统。
   

   说明

   该功能在GMP V5.9.0及以上版本提供。

方式一：导航栏嵌入

1. 登录GMP控制台，选择项目中心＞开放平台＞业务集成，点击列表右上角创建业务。
   

2. 输入必要信息，选择iframe导航栏嵌入外部系统（prod模板名称可能会有所调整）集成模板。点击选择。
   

3. （可选）点击获取免登token，配置免登节点。
   
   打开iframe之前会执行该节点获取免登参数，注入到cookie或携带到iframe参数中，实现免登使用。标准的同步请求配置，请按照实际情况录入。

   说明

   按照同步请求完成节点基本信息配置后，需要完成规范的响应字段配置，否则可能导致免登参数注入失败。

   特殊配置逻辑：
   响应字段配置需要有特定的约定格式：（可参考下图红框内容，返回expired_at及token，token key可自定义）

   {
       "expired_at": number|string;
       "[token: string]": string;
   }
   

   • expired_at: token 过期时间时间戳（精确到秒），例如token 在 '2024-04-29 00:00:00' 过期，则返回1714320000
   • token: 登录所用的 token，key 值可自定义，eg：gmp_token、custom_token 等
   • 更多参数可在返回结构体中定义，gmp 会将返回数据统一注入到 cookie 或携带到 iframe 参数中。
     

4. 点击iframe顶部导航栏对接，​配置iframe节点，然后点击保存。
   

   配置项	说明	示例
   接口类型	选择iframe集成	iframe 集成
   对接系统	选择要对接的系统。 可以新增，但需要保证免登token节点跟iframe节点对接系统一致；多份配置需要保证每份配置的对接系统不一致，例如接入导航A，对接系统，接入导航B，对接系统b。	default
   页面名称	iframe 的标题。展示到导航栏中的名称（如果勾选了集成到GMP菜单）	test
   是否集成到gmp菜单	若需要将自有系统集成到导航栏，请打开开关配置。需要开启该功能。	是
   插入菜单位置	从下拉选项中选择需要插入的导航栏位置。 也可以点击添加自定义菜单，添加新的菜单位置。新增项会展示到所选项之后具体插入菜单的展示位置会根据登录账号权限有所调整。 例如：插入位置选择首页下二级菜单，但是登录账户没有首页权限，则该插入菜单也无法展示	首页
   菜单权重	自定义菜单内依据菜单权重再次排序。例如， 菜单A跟菜单B同属于自定义菜单一，菜单A权重为2，菜单B的权重为1，则最终的展示效果如下： 自定义菜单一 菜单 B 菜单 A 相同层级的自定义菜单会按照权重值再次排序，权重值越小，排序越靠前 仅在父级菜单为自定义菜单中生效	1
   集成的url	iframe地址，需要与gmp保持同域名，否则会因为跨域问题导致iframe无法打开	http://www.xxxx.com
   打开方式	新开窗口或在当前页展示 说明 GMP V5.9版本及以上支持。	新页面打开
   url参数	需要动态插入到iframe url的参数 支持常量、gmp保留字、前端数据的参数类型。 gmp保留字：可选操作人部门、操作人 前端数据：支持 cookies、sessionStorage、localStorage、gmp url参数中获取数据 说明 支持前端运行时数据：任务 ID、任务类型、通道ID，仅在GMP V5.9版本及以上支持。	operator_id 操作人
   是否需要免登	选择是需要完成前置节点【免登token】的配置才能完成完整的免登流程。	否
   免登参数处理方式	选择token的处理方式 设置到cookie 添加到路由参数	免登token中【响应参数配置】配置了{ custom_token: xxxx }，免登处理方式选择了【设置到 cookies】，则token会以 custom_token=xxx 的方式设置到当前域名下
   url处理脚本	自定义处理iframe参数。 基本参数配置完成之后，点击根据配置生成脚本会自动生成可执行脚本。 可根据需求对自动生成的脚本再次调整，需要保证最后返回 { iframe_url: xxx }	/
   是否传输数据到gmp	需要从自有系统传递数据到gmp展示或保存	是
   传输数据配置	传输数据的字段映射配置。 数据来源目前支持localStorage、sessionStorage、常量方式的数据传递。 localStorage、sessionStorage需要用户在自有系统中，往这两个 storage写入数据，关闭iframe之后，gmp会根据配置从中取出数据。	ID localStorage
   自定义传输数据处理脚本	自定义的数据处理脚本，脚本需返回规范的用于 gmp回显的json数据，请参考注释代码	/
   自定义逆向数据处理脚本	逆向将gmp的数据转换成用户系统数据，针对再次编辑的场景，将环境重置成用户关闭 iframe 时的状态。例如在自有系统往 localStorage 写入了 { ID: 123 } 的配置，再次进入编辑时，gmp会还原 { ID: 123 } 到 localStorage。	/

5. 点击确定，完成业务创建。

方式二：人群范围对接

1. 登录GMP控制台，选择项目中心＞开放平台＞业务集成，点击列表右上角创建业务。
   

2. 在弹出的对话框中，输入‘业务名称’和‘业务描述’等信息，选择iframe分群对接（prod模板名称可能会有所调整）集成模板。点击选择。
   

3. （可选）配置免登节点，具体操作同方式一：导航栏嵌入的步骤3。

4. 点击iframe人群对接，​配置iframe节点，然后点击保存。

   配置项	说明	示例
   接口类型	选择iframe集成	iframe 集成
   对接系统	选择要对接的系统。 可以新增，但需要保证免登token节点跟iframe节点对接系统一致；多份配置需要保证每份配置的对接系统不一致，例如接入导航A，对接系统 ，接入导航B，对接系统b。	default
   页面名称	iframe 的标题。展示到导航栏中的名称（如果勾选了集成到GMP菜单）	test
   是否集成到gmp菜单	需要设置成否	否
   集成的url	iframe地址，需要与gmp保持同域名，否则会因为跨域问题导致iframe无法打开	http://www.xxxx.com
   打开方式	新开窗口或在当前页展示 说明 GMP V5.9版本及以上支持。	新页面打开
   url参数	需要动态插入到iframe url的参数 支持常量、gmp保留字、前端数据的参数类型。 gmp保留字：可选操作人部门、操作人 前端数据：支持 cookies、sessionStorage、localStorage、gmp url参数中获取数据 说明 支持前端运行时数据：任务 ID、任务类型、通道ID，仅在GMP V5.9版本及以上支持。	operater_id 操作人
   是否需要免登	选择是需要完成前置节点【免登token】的配置才能完成完整的免登流程。	否
   免登参数处理方式	选择token的处理方式 设置到cookie 添加到路由参数	免登token中【响应参数配置】配置了{ custom_token: xxxx }，免登处理方式选择了【设置到 cookies】，则token会以 custom_token=xxx 的方式设置到当前域名下
   url处理脚本	自定义处理iframe参数。 基本参数配置完成之后，点击根据配置生成脚本会自动生成可执行脚本。 可根据需求对自动生成的脚本再次调整，需要保证最后返回 { iframe_url: xxx }	/
   是否传输数据到gmp	需要从自有系统传递数据到gmp展示或保存，需要设置成否。	否

5. 点击确定，完成业务创建。

方式三：触发事件-完成A对接

1. 登录GMP控制台，选择项目中心＞开放平台＞业务集成，点击列表右上角创建业务。
   

2. 输入必要信息，选择iframe触发事件对接（prod模板名称可能会有所调整）集成模板。点击选择。

3. （可选）配置免登节点，具体操作同方式一：导航栏嵌入的步骤3。

4. 点击iframe触发事件对接，​配置iframe节点，然后点击保存。

   配置项	说明	示例
   接口类型	选择iframe集成	iframe 集成
   对接系统	选择要对接的系统。 可以新增，但需要保证免登token节点跟iframe节点对接系统一致；多份配置需要保证每份配置的对接系统不一致，例如接入导航A，对接系统 ，接入导航B，对接系统b。	default
   页面名称	iframe 的标题。展示到导航栏中的名称（如果勾选了集成到GMP菜单）	test
   是否集成到gmp菜单	若需要将自有系统集成到导航栏，请打开开关配置。需要开启该功能。	是
   插入菜单位置	从下拉选项中选择需要插入的导航栏位置。 也可以点击添加自定义菜单，添加新的菜单位置。新增项会展示到所选项之后具体插入菜单的展示位置会根据登录账号权限有所调整。 例如：插入位置选择首页下二级菜单，但是登录账户没有首页权限，则该插入菜单也无法展示	首页
   菜单权重	自定义菜单内依据菜单权重再次排序。例如， 菜单A跟菜单B同属于自定义菜单一，菜单A权重为2，菜单B的权重为1，则最终的展示效果如下： 自定义菜单一 菜单 B 菜单 A 相同层级的自定义菜单会按照权重值再次排序，权重值越小，排序越靠前 仅在父级菜单为自定义菜单中生效	1
   集成的url	iframe地址，需要与gmp保持同域名，否则会因为跨域问题导致iframe无法打开	http://www.xxxx.com
   打开方式	新开窗口或在当前页展示 说明 GMP V5.9版本及以上支持。	新页面打开
   url参数	需要动态插入到iframe url的参数 支持常量、gmp保留字、前端数据的参数类型。 gmp保留字：可选操作人部门、操作人 前端数据：支持 cookies、sessionStorage、localStorage、gmp url参数中获取数据 说明 支持前端运行时数据：任务 ID、任务类型、通道ID，仅在GMP V5.9版本及以上支持。	operater_id 操作人
   是否需要免登	选择是需要完成前置节点【免登token】的配置才能完成完整的免登流程。	否
   免登参数处理方式	选择token的处理方式 设置到cookie 添加到路由参数	免登token中【响应参数配置】配置了{ custom_token: xxxx }，免登处理方式选择了【设置到 cookies】，则token会以 custom_token=xxx 的方式设置到当前域名下
   url处理脚本	自定义处理iframe参数。 基本参数配置完成之后，点击根据配置生成脚本会自动生成可执行脚本。 可根据需求对自动生成的脚本再次调整，需要保证最后返回 { iframe_url: xxx }	/
   是否传输数据到gmp	需要从自有系统传递数据到gmp展示或保存。需要开启该功能。	是
   传输数据配置	gmp key：gmp 预置了 ID、Name 的传输 key，针对规则配置的场景，会读取用户传递到 gmp 的数据之后，展示到 gmp 系统中，并保存到 gmp 数据库 数据来源可选 sessionStorage 或 localStorage，按实际情况选择 客户系统 key：用户系统塞入 sessionStorage 或 localStorage 中的key值
   自定义传输数据处理脚本	自定义的数据处理脚本，脚本需返回规范的用于 gmp回显的json数据，请参考注释代码。简单的数据映射不满足诉求的情况下，通过自定义脚本对数据再次处理。	// 参考代码 function process(ctx, response) { var body = JSON.parse(response.Body); var result = { ID: body.ID, Description: '回显的描述' }; if (body.Name) { // eg：塞入 storage 中的 name 是一个数组，需要从数组中读取值之后展示 var nameJson = JSON.parse(body.Name); result.Name = nameJson[0].name; } return result; }
   自定义逆向数据处理脚本	逆向将 gmp 的数据转换成用户系统数据 针对再次编辑的场景，再环境重置成用户关闭 iframe 之后的状态。例如在自有系统往 localStorage 写入了 { ID: 123 } 的配置，再次进入编辑时，gmp 会还原 { ID: 123 } 到 localStorage。 简单的数据映射不满足诉求的情况下，通过自定义脚本对数据再次处理	// 参考代码 function process(ctx, response) { // eg: var body = JSON.parse(response.Body); var result = { ruleIds: body.ruleIds, // ruleNames 是一个数组，需要还原成数组，存到 storage ruleNames: JSON.stringify([{ id: body.ruleIds, name: body.ruleNames }]) }; return result; }

5. 点击确定，完成业务创建。

方式四：消息触达、流程画布自定义数据分析入口

1. 登录GMP控制台，选择项目中心＞开放平台＞业务集成，点击列表右上角创建业务。
   

2. 输入必要信息，选择iframe触发事件对接（prod模板名称可能会有所调整）集成模板。点击选择。

3. （可选）配置免登节点，具体操作同方式一：导航栏嵌入的步骤3。

4. 点击iframe触发事件对接，​配置iframe节点，然后点击保存。

   配置项	说明	示例
   接口类型	选择iframe集成	iframe 集成
   对接系统	对接系统选择或输入dataAnalysis 可以新增，但需要保证免登token节点跟iframe节点对接系统一致；多份配置需要保证每份配置的对接系统不一致，例如接入导航A，对接系统 ，接入导航B，对接系统b。	dataAnalysis
   页面名称	iframe 的标题。展示到导航栏中的名称（如果勾选了集成到GMP菜单）	test
   是否集成到gmp菜单	若需要将自有系统集成到导航栏，请打开开关配置	否
   插入菜单位置	从下拉选项中选择需要插入的导航栏位置。 也可以点击添加自定义菜单，添加新的菜单位置。新增项会展示到所选项之后具体插入菜单的展示位置会根据登录账号权限有所调整。 例如：插入位置选择首页下二级菜单，但是登录账户没有首页权限，则该插入菜单也无法展示	首页
   菜单权重	自定义菜单内依据菜单权重再次排序。例如， 菜单A跟菜单B同属于自定义菜单一，菜单A权重为2，菜单B的权重为1，则最终的展示效果如下： 自定义菜单一 菜单 B 菜单 A 相同层级的自定义菜单会按照权重值再次排序，权重值越小，排序越靠前 仅在父级菜单为自定义菜单中生效	1
   集成的url	iframe地址，需要与gmp保持同域名，否则会因为跨域问题导致iframe无法打开	http://www.xxxx.com
   打开方式	新开窗口或在当前页展示 说明 GMP V5.9版本及以上支持。	新页面打开
   url参数	新增前端运行时数据，可根据诉求按需使用。 任务ID：触达任务ID或流程画布ID。Iframe 链接https://xxx.com?xxx=1&taskId=[id] 任务类型：功能来自消息触达、流程画布或短链。​Iframe 链接：https://xxx.com?xxx=1&taskType=[Push 消息触达：Push 流程画布：Flow 短链：ShortLink 通道ID：触达通道的 ID。Iframe 链接：https://xxx.com?xxx=1&ChannelId=[id]	Flow /
   是否需要免登	选择是需要完成前置节点【免登token】的配置才能完成完整的免登流程。	否
   免登参数处理方式	选择token的处理方式 设置到cookie 添加到路由参数	免登token中【响应参数配置】配置了｛ custom_token: xxxx }，免登处理方式选择了【设置到 cookies】，则token会以 custom_token=xxx 的方式设置到当前域名下
   url处理脚本	自定义处理iframe参数。 基本参数配置完成之后，点击根据配置生成脚本会自动生成可执行脚本。 可根据需求对自动生成的脚本再次调整，需要保证最后返回 { iframe_url: xxx }	/
   是否传输数据到gmp	需要从自有系统传递数据到gmp展示或保存	否
   传输数据配置	传输数据的字段映射配置。 数据来源目前支持localStorage、sessionStorage、常量方式的数据传递。 localStorage、sessionStorage需要用户在自有系统中，往这两个 storage写入数据，关闭iframe之后，gmp会根据配置从中取出数据。	ID localStorage
   自定义传输数据处理脚本	自定义的数据处理脚本，脚本需返回规范的用于 gmp回显的json数据，请参考注释代码	/
   自定义逆向数据处理脚本	逆向将gmp的数据转换成用户系统数据，针对再次编辑的场景，再环境重置成用户关闭 iframe 之后的状态。例如在自有系统往 localStorage 写入了 { ID: 123 } 的配置，再次进入编辑时，gmp会还原 { ID: 123 } 到 localStorage。	/