腾讯优量汇 快应用 SDK 接入文档

Version:1.6.1064

概述

说明

本文档旨在帮助快应用开发者在程序中快速植入腾讯优量汇开发者平台提供的广告。作为快应用开发者，您只需要进行简单配置，就可以在您的快应用中显示定制的广告。关于快应用 SDK 的具体使用方法，请仔细阅读下面的文档。

背景

开发环境

• 操作系统：支持 Linux/Mac/Windows 系统，具体依赖开发者选择的 IDE
• 开发工具：支持 华为快应用开发工具 和 快应用联盟开发工具
• 部署目标：接入优量汇流量的快应用
• 接入方式：通过 npm 或 yarn 安装，请参考下方：

npm install ylh-quick-app-ad-sdk -S
// or
yarn add ylh-quick-app-ad-sdk -S

SDK 接入

步骤1：安装 ylh-quick-app-ad-sdk

通过 npm 安装：

npm install ylh-quick-app-ad-sdk -S

通过 yarn 安装：

yarn add ylh-quick-app-ad-sdk -S

步骤2：在 manifest.json 文件中添加接口权限

{
  "features": [
    { "name": "system.app" }
    { "name": "system.fetch" },
    { "name": "system.file" },
    { "name": "system.device" },
    { "name": "system.network" },
    { "name": "system.shortcut" },
    { "name": "system.keyguard" },
    { "name": "system.battery" },
    { "name": "system.telecom" },
    { "name": "system.brightness" },
    { "name": "system.webview" },
    { "name": "system.storage" },
    { "name": "system.package" },
    { "name": "system.router" },
    { "name": "system.prompt" },
    { "name": "system.cipher" },
    { "name": "system.volume" },
    { "name": "system.sensor" },
    { "name": "system.vibrator" },
  ]
}

步骤3：初始化SDK

// 标准版
import YLHQuickAppSDK from 'ylh-quick-app-ad-sdk';

// 无插件版
import YLHQuickAppSDK from 'ylh-quick-app-ad-sdk/pure';

// 📢注意：华为只支持无插件版，非华为快应用，两种都支持

export default {
  onCreate() {
    try {
        const config = {
            appId: '1200540367' // 注意📢：appId为 必填字段
        };
        new YLHQuickAppSDK(this, config)
    } catch (error) {
    }
  }
}

config 配置项字段说明如下表所示：

术语介绍

• appId：媒体 ID，是您在腾讯优量汇开发者平台创建媒体时获得的 ID，这个 ID 是我们在广告网络中识别您应用的唯一 ID。
• placementId：广告位 ID，是您在腾讯优量汇开发者平台为您的媒体所创建的某种类型的广告位置的 ID。

广告位创建流程

在您的媒体通过审核后，可以在腾讯优量汇开发者平台选择“新建广告位”。

步骤说明：

• 1.在新建广告位之前，确保您已经安装最新版SDK并阅读完说明文档，了解如何在您的媒体中使用广告位 ID
• 2.选择需要嵌入广告的媒体名称。注意此处只可选择已通过审核的媒体
• 3.广告位名称用于区分媒体内设置的各个广告位，方便您在后台进行统一管理和查看数据报表；目前支持接入的广告类型包含：开屏广告、激励广告等；接入方式包含优量汇渲染、开发者自渲染等
• 4.点击完成按钮以后即获得对应该广告位的 ID 号
• 5.成功得到广告位ID以后，您可以在应用代码内使用该ID进行广告联调测试（见“接入代码”部分）
• 6.通过测试后去掉测试代码部分（TestAd），即可发布带有优量汇广告位的快应用

支持广告类型及对应接入方式及简介

优量汇支持以下几种广告类型，您可以根据开发需要选择合适的广告：