🚀 DAY 3 OF LAUNCH WEEK:Announcing Bun and vlt Support in Socket.Learn more
Socket
Book a DemoInstallSign in
Socket

@alipay-inc/mpaas-mcdp-h5-render

Package Overview
Dependencies
Maintainers
0
Versions
19
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

@alipay-inc/mpaas-mcdp-h5-render

MCDP多端渲染

latest
npmnpm
Version
0.2.0-beta.3
Version published
Maintainers
0
Created
Source

接入文档

Package信息

包名:@alipay-inc/mpaas-mcdp-h5-render 类型:公共类库 适用场景:Web网页 功能简介:支持在h5进行弹屏、公告、轮播(banner)、浮标四种类型的展位投放,和个性化广告投放能力。

接入配置

mpaas-mcdp-h5-render提供两种接入方式:HTML文件内script标签引入及代码内npm包引用。

HTML标签引入

在HTML文件内,进行以下操作

  • <head>中添加以下代码进行引用
  <script type="text/javascript" src="https://unpkg.com/@alipay-inc/mpaas-mcdp-h5-render/dist/index.js"  />
  • <body>末尾处,添加script标签,进行配置初始化,init参数见下表
<script type="text/javascript">
    // init方法支持随时调用,每次调用都会使用当次传入的参数请求数据,更新广告数据
    McdpView.init({
        appId: 'my-appId',  //必填
        workspaceId: 'my-workspaceId', //必填
        reportURL: 'my-url', //必填
        uploadURL: 'my-url', //必填
        userId: 'userId', //非必填
        utdid: 'utdid' //非必填
    });
</script>
  • 在调用展位的dom元素上绑定类名及展位码,例如
<div class="mcdp-view-wrap" data-mcdp-code="my-code"></div>

npm引入

  • 添加依赖
npm install @alipay-inc/mpaas-mcdp-h5-render
  • 在文件项目源码内,用npm的方式引入(以es6语法为例),init参数见下表
import McdpView from '@alipay-inc/mpaas-mcdp-h5-render';
// init方法支持随时调用,每次调用都会使用当次传入的参数请求数据,更新广告数据
McdpView.init({
    appId: 'my-appId',  //必填
    workspaceId: 'my-workspaceId', //必填
    reportURL: 'my-url', //必填
    uploadURL: 'my-url', //必填
    userId: 'userId', //非必填
    utdid: 'utdid' //非必填
});
  • 在调用展位的dom元素上绑定类名及展位码,例如
<div class="mcdp-view-wrap" data-mcdp-code="my-code"></div>

init配置参数

属性名类型必填默认值说明备注
appIdstring-展位应用ID获取展位信息必需
workspaceIdstring-展位工作控件ID获取展位信息必需
reportURLstring-请求路径host获取展位信息必需
uploadURLstring-埋点上报数据host埋点上报数据必需
userIdstring-用户自定义,不传为空用以统计PV,UV
utdidstring-用户自定义,不传为空用以统计PV,UV
useMPbooleanfalse是否使用 MGS SDK 发送请求
MPConfigObject-MGS 相关配置,详细见下方 MPConfig 配置参数若 useMP 为 true,则MPConfig.MP为必填项

MPConfig 配置参数

属性名类型必填默认值说明备注
MPObject-MGS JSSDK导出的MP对象若 useMP 为 true,则MPConfig.MP为必填项
extraHttpConfigObject-额外的请求配置详情见 MGS JSSDK 文档
extraHeaderInfosObject-额外的请求头配置详情见 MGS JSSDK 文档
signTypestring-加签方法 ,不传则不加签详情见 MGS JSSDK 文档
secretKeystring-加签密钥,如果signType有值,则必填详情见 MGS JSSDK 文档
encryptTypenumber-加密方法类型 ,不传则不加密,详情见上方加密原子能力详情见 MGS JSSDK 文档
publicKeystring-公钥,如果encryptType有值,则必填详情见 MGS JSSDK 文档

useMP = true 时需要使用 MGS JSSDK,使用方法请参考对应文档,参考代码如下:

import MP from '@alipay-inc/mpaas-mgs-sdk';
import McdpView from '@alipay-inc/mpaas-mcdp-h5-render';

McdpView.init({
  appId: 'my-appId',  //必填
  workspaceId: 'my-workspaceId', //必填
  reportURL: 'my-url', //必填
  uploadURL: 'my-url', //必填
  userId: 'userId', //非必填
  utdid: 'utdid' //非必填
  useMP: true,
  MPConfig: {
    MP: MP,  //必填
    signType: 'md5', //非必填,加签使用
    secretKey: 'xxxxxxx', //如果signType有值,则必填
    encryptType: 1, //非必填,加密使用
    publicKey: 'xxxxxxx' //如果encryptType有值,则必填
  }
});

广告类型配置参数

广告类型属性名类型必填默认值说明备注
rotation (轮播) classstringmcdp-view-wrap展位容器显示展位信息必需
data-mcdp-codestring-展位码应用ID获取展位信息必需
buoy (浮标) classstringmcdp-view-wrap展位容器显示展位信息必需
data-mcdp-codestring-展位码应用ID获取展位信息必需
notice (公告) classstringmcdp-view-wrap展位容器显示展位信息必需
data-mcdp-codestring-展位码应用ID获取展位信息必需
banner (弹屏) classstringmcdp-view-wrap展位容器显示展位信息必需
data-mcdp-codestring-展位码应用ID获取展位信息必需

FAQs

Package last updated on 29 Jul 2024

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts