集成 Singular SDK:规划和前提条件

文档

SDK 集成前提条件

在任何 Singular SDK 集成之前所需的基本预备步骤,包括规划、应用程序注册、域配置和测试准备。

必要的预备步骤:任何Singular SDK集成都需要以下步骤。

了解如何规划 SDK 集成、注册用于开发的应用程序、创建用于跟踪链接的域名,以及在实施过程中和实施后准备测试工作流程。

目标受众 业务团队、营销团队、开发团队
前提条件 Singular 账户访问权限、应用程序捆绑 ID、营销 KPI 定义

集成概述

跨职能协作

成功的 Singular SDK 集成需要营销、业务和开发团队之间的协作,以确定需求、配置跟踪和验证实施。

团队职责

团队 团队职责
营销/业务
  • 确定活动跟踪要求和营销关键绩效指标
  • 为活动跟踪选择链接域
  • 在 Singular 平台中配置生产应用程序设置
  • 审查和批准测试程序
开发
  • 按照技术规范实施 SDK 集成
  • 在 Singular 平台注册开发/测试应用程序
  • 配置深度链接和跟踪链接处理程序
  • 执行测试程序和验证

步骤 1:规划 SDK 集成

在开始 SDK 整合之前,市场营销和业务团队必须回答关键问题,以便开发团队实施适当的 SDK 特性和功能。

儿童隐私合规

面向儿童的应用程序

问题此应用程序是否明确针对儿童?

针对儿童的应用程序必须遵守 Play Store 和 App Store 的儿童隐私保护政策。Singular 提供专门的 SDK 以确保合规性。

推荐解决方案:使用Singular 的儿童应用程序 SDK,它不会捕获设备标识符,有助于遵守隐私政策。


深度链接配置

深度链接处理

问题应用程序能否处理深度链接?

深度链接可将用户从外部资源(如营销活动、推送通知或网页)引导至应用程序内的特定内容。

实施要求

  • 先决条件:按照奇异链接先决条件进行域和平台配置
  • 深度链接处理程序:按照相关 SDK 指南(iOS、Android、React Native 等)的说明在代码中实施处理程序
  • 测试:使用测试控制台和手动测试程序验证深度链接功能

事件跟踪策略

应用内事件规划

问题应用程序是否会跟踪用户事件?

Singular 收集应用程序内的事件数据,用于分析营销活动绩效和衡量关键绩效指标。活动策略应与营销目标和用户价值衡量相一致。

标准活动
#

标准事件的优势

Singular支持各垂直行业常用的各种标准事件,广告网络通常也支持这些事件的报告和优化。

优点

  • 自动识别:Singular能自动识别标准事件,并将其添加到事件列表中,无需手动定义。
  • 合作伙伴支持:广告网络支持用于广告活动优化和报告的标准事件
  • 行业一致性:跨平台和合作伙伴的一致命名
  • 最佳实践:只要事件符合标准定义,就推荐使用该方法

标准事件属性

对于每个标准事件,通过推荐的标准属性,以实现完整的数据采集和合作伙伴兼容性。

例如: sng_content_view 事件(用户查看产品)应包括

  • sng_attr_content_type - 查看的内容类型
  • sng_attr_content_id - 独特的内容标识符
  • sng_attr_content - 内容描述或名称

活动战略资源

用户体验/营销/业务团队应使用以下资源,根据营销关键绩效指标编制事件列表:


特定平台的事件名称

开发人员注意:根据开发平台的不同,SDK 集成可能需要略微不同的事件/属性名称格式(全大写、无下划线等)。

特定平台列表

自定义事件
#

自定义事件定义

如果事件与 Singular 的标准事件不匹配,可使用自定义名称定义自定义事件,以满足特定的跟踪要求。

自定义事件指南

  • 字符限制:最多 32 个字符
  • 语言:建议使用英文名称,以便与从 Singular 接收事件的广告网络合作伙伴兼容
  • 命名规范:使用描述性的、一致的命名,以提高清晰度和维护性
  • 文档:维护记录自定义事件名称和目的的事件目录

事件跟踪范围

最佳实践:仅当营销相关目的需要时,才向 Singular 发送事件。如果事件对营销活动绩效关键绩效指标或用户价值指标不重要,Singular 就不应跟踪该事件。

事件选择标准

  • 营销相关性:事件为营销活动优化提供洞察力
  • 关键绩效指标衡量:事件有助于关键绩效指标
  • 用户价值:活动表明用户参与度或货币化
  • 合作伙伴优化:广告网络用于广告活动定位的事件

iOS 特定配置

SKAdNetwork 实施

问题 (iOS):应用程序是否会实施 SKAdNetwork?

SKAdNetwork 可在 iOS 上实现隐私保护归因,而无需用户级跟踪权限。Singular 支持两种实施模式。

SKAdNetwork 模式

  • 托管模式:Singular 根据预定义规则自动更新转换值
  • 手动模式:您的应用程序使用 SDK 方法直接更新转换值

应用程序跟踪透明度

问题(iOS):应用程序是否会请求用户允许共享跟踪信息(ATT)?

Singular 建议显示 ATT 提示,因为用户选择共享设备 ID (IDFA),可提高安装归因的准确性。

配置要求:如果显示 ATT 提示,请配置 SDK 以延迟 Singular 初始化,直到用户回复提示。 这将确保归因捕获正确的跟踪授权状态。

ATT 实施

  • 提示定时:在初始化 Singular SDK 之前显示 ATT 提示
  • SDK 配置:使用 SDK 配置选项等待 ATT 响应
  • IDFA 捕捉:如果用户许可,则收集 IDFA 以确定归属
  • 后备归属:如果用户拒绝许可,则使用指纹和 IDFV 进行归属

步骤 2:注册开发应用程序

在 Singular 平台注册开发/测试应用程序,使用与生产应用程序不同的捆绑 ID,以保持测试期间的数据分离。

捆绑 ID 策略

开发与生产

生产和测试应用程序使用相同的 SDK 密钥和秘钥。 一旦数据保存在 Singular 中,就无法删除。

推荐方法:为测试应用程序使用不同的捆绑标识符,以保持数据与生产应用程序分离。在商店发布应用程序之前,将捆绑标识符更改为生产版本。

软件包 ID 示例

环境 软件包 ID
生产版本 com.myapp
开发/测试 com.myapp.dev

应用程序注册步骤

平台配置

如何注册开发应用程序
#

注册步骤

  1. 导航至应用程序:在Singular平台,进入设置→应用程序,点击添加新应用程序
  2. 输入应用程序名称:输入开发应用程序的名称(为清晰起见,建议使用捆绑 ID
  3. 选择平台:选择与应用程序平台相对应的操作系统(iOS 或 Android
  4. 配置捆绑 ID:选择捆绑 ID 选项并输入开发版本的捆绑标识符,然后保存应用程序
  5. 仅限 iOS - 高级设置:保存应用程序后,单击应用程序名称旁边的箭头查看详细信息
    • 切换显示高级设置选项
    • 添加团队 ID(通用链接需要)
    • 添加方案(深度链接需要)

开发后更新

完成开发和测试后:

  1. 更新软件包 ID:在应用程序配置中将软件包 ID 更改为生产版本
  2. 生产应用程序设置:营销团队根据应用程序配置常见问题说明添加生产应用程序

重要:确保在向 App Store 或 Play Store 发布应用程序之前将捆绑 ID 更新为生产值。不匹配的捆绑 ID 会妨碍正确的归属和跟踪。


步骤 3:创建链接域

为 Singular 跟踪链接建立自定义域,以启用品牌营销活动 URL 和深度链接功能。

链接域结构

奇异链接格式

奇异链接(奇异跟踪链接)遵循带有自定义子域的标准化结构:

https://[SUBDOMAIN].sng.link/[PARAMETERS]

例如对于名为 "Jewel Rush "的应用程序,创建域jewelrush.sng.link,使跟踪链接具有结构:

https://jewelrush.sng.link/[PARAMETERS]

域策略

单域与多域

企业可以为所有链接使用单个域,也可以为不同目的(应用程序、品牌、活动等)创建多个域。

要求:使用单一跟踪链接前至少需要一个域。营销团队应参与域的选择,因为它会出现在营销活动和面向用户的材料中。

域使用案例

  • 单一域:一个域用于跨应用程序和营销活动的所有跟踪链接
  • 特定应用程序:每个应用程序都有单独的域,以提高品牌清晰度
  • 特定活动:不同类型的营销活动使用不同的域
  • 地域性:用于本地化营销活动的区域域

iOS 域名配置

关联域设置

在 iOS 应用程序中集成 Singular SDK 时,请在 Xcode 关联域设置中添加链接域,以支持通用链接。

关联域格式

applinks:[DOMAIN].sng.link

示例

applinks:jewelrush.sng.link

其他资源:有关完整的域设置和配置说明,请参阅Singular Links Prerequisites


步骤 4:计划集成测试

在发布应用程序之前,使用 Singular 的测试工具和验证程序验证 SDK/S2S 集成功能。

测试策略

测试阶段

综合测试分为两个阶段:实施过程中的实时验证和实施后的完整集成验证。

实施过程中的测试
#

实时验证工具

使用提供即时反馈的实时验证工具,对实施的功能进行测试。

测试控制台

使用测试控制台在实施过程中实时手动测试不同的 SDK 功能。

测试控制台的优势

  • 实时反馈:即时验证 SDK 调用和数据传输
  • 逐个功能测试:在开发过程中逐步测试各个功能
  • 调试支持:立即识别配置问题和数据问题
  • 会话跟踪:验证会话初始化和事件跟踪

第三方调试工具

使用代理工具进行流量检查和验证的替代测试方法。

查尔斯代理设置

  • 安装Charles 代理或类似的网络检测工具
  • 启用 SSL 代理进行 HTTPS 流量检测
  • 验证在正确的时间以正确的参数触发的奇异数据
  • 验证 API 端点调用和响应代码
实施后测试
#

综合验证工具

完成实施后,使用自动和手动工具进行完整的集成验证。

SDK 审计报告

运行 SDK 审计报告,自动识别集成问题并获得建议的解决方案。

审核报告功能

  • 自动检测:识别缺失或配置错误的 SDK 功能
  • 最佳实践验证:根据 Singular 建议验证实施情况
  • 可执行建议:针对发现的问题提供具体的解决方案
  • 全面覆盖:检查所有 SDK 功能和配置

导出日志验证

使用导出日志页面下载用户级数据,查看从应用程序成功传输到 Singular 的所有数据。

导出日志详细信息

  • 数据格式:包含完整用户级数据的 CSV 文件
  • 时间数据可用前约 30 分钟
  • 验证:验证事件、会话和属性数据
  • 调试:识别缺失事件或错误数据

深度链接测试

按照《如何测试 Singular SDK 集成》中的说明测试深层链接

深度链接测试用例

  • 通用链接:测试 iOS 通用链接和安卓应用程序链接
  • 自定义方案:验证自定义 URL 方案处理
  • 延迟深度链接:测试应用程序安装前点击的链接
  • 活动参数:验证参数传递和归因

归因验证

使用归因详情 API 在测试后查询设备归因详情。事件发生后约 4-6 分钟即可获得归因数据。

了解如何使用归因详情端点验证归因

归因验证步骤

  1. 执行测试:安装应用程序并完成测试用户旅程
  2. 等待处理:等待 4-6 分钟进行归因处理
  3. 查询 API:使用带有设备标识符的归因详情 API
  4. 验证结果:确认归因到正确的营销活动和来源

其他测试资源

完整测试指南

有关全面的测试程序、最佳实践和故障排除,请参阅《如何测试您的 Singular SDK 集成》。

测试清单

  • 测试控制台验证实时 SDK 调用
  • SDK 审计报告确认完整集成
  • 导出日志验证数据传输
  • 深层链接在各种情况下正常运行
  • 归因符合预期的营销活动来源
  • 使用正确的名称和属性跟踪事件
  • 收入事件捕获金额和货币

下一步

完成前提条件后,继续进行特定平台的 SDK 集成或 S2S 实施。

SDK 集成指南


其他资源