AI Search

SDK规范

概览

本页面定义了配置 SDK 以使用 UnifID 及其集成的身份识别供应商所需的 API 规范。您可以在一次配置中集成和使用多个身份识别供应商。

传递哈希值(电子邮件地址或电话号码)

  1. 使用以下任一哈希协议对PII数据进行哈希处理:SHA1、SHA256或MD5。
  2. 使用 InMobi 帐户 ID 调用 InMobi SDK 初始化 API。更多信息,请参阅iOSAndroid初始化。如果您使用中介服务,则中介服务会负责初始化。
  3. 用于InMobiUserDataTypes捕获哈希处理后的个人身份信息数据。
  4. 使用以下命令构建请求 InMobiUserDataModel
  5. 使用 UnifID 推送 API 推送个人身份信息 (PII) 数据(参见“UnifID API 规范”)。每次会话都调用此 API。
  6. 如果您是新用户,您必须InMobiUnifiedIdService.reset()先致电InMobiUnifiedIdService.push(userDataModel)

传递移动广告 ID (MAID)

  1. 使用 InMobi 帐户 ID 调用 InMobi SDK 初始化 API。更多信息,请参阅iOSAndroid初始化。如果您使用中介服务,则中介服务会负责初始化。
  2. 调用 MAID 的 UnifID 推送 API:。InMobiUnifiedIdService.push(null)每次会话都调用此 API。

笔记

建议在初始化中介 SDK 之前预先初始化 InMobi SDK,但这并非强制要求。这样做可以确保无缝集成,因为 UnifID API 会在开始盈利之前启用。此步骤不会影响中介堆栈。

UnifID API 规范

IMUnifiedIdService这是一个新类,它包含以下 API。

API 

句法 

描述 

 

<span data-contrast="none" xml:lang="EN-US">push(</span><span data-contrast="none" xml:lang="EN-US">data: </span><span data-contrast="none" xml:lang="EN-US">IMUserDataModel</span><span data-contrast="none" xml:lang="EN-US">)</span> 

您应该使用此 API 将哈希处理后的个人身份信息 (PII) 数据提交给 InMobi  ID 服务。 每次 调用此 API时 SDK 都会向  InMobi ID 服务发出 请求您 应该在每个应用会话开始时调用此 API  。 
 

InMobiUnifiedIdService.push(null);

您应该使用此 API 将 MAID(移动广告 ID)传递给 InMobi ID 服务。每次调用此 API 时,SDK 都会向 InMobi ID 服务发出请求。

您应该在每个应用程序会话开始时调用此 API。

拿来 

<span data-contrast="none" xml:lang="EN-US">fetch</span><span data-contrast="none" xml:lang="EN-US">Unified</span><span data-contrast="none" xml:lang="EN-US">Ids</span><span data-contrast="none" xml:lang="EN-US">(</span><span data-contrast="none" xml:lang="EN-US">delegate: </span><span data-contrast="none" xml:lang="EN-US">Unified</span><span data-contrast="none" xml:lang="EN-US">IdInterface</span><span data-contrast="none" xml:lang="EN-US">)</span>

您应该使用此方法获取统一 ID。如果统一 ID 过期,InMobi ID 服务会收到刷新传递给您的 ID 的调用。 

重置 

<span data-contrast="none" xml:lang="EN-US">reset(</span><span data-contrast="none" xml:lang="EN-US">)</span>

您应该使用此 API 清除 SDK 本地存储的所有 UnifID 和签名 

发布商提供的 ID setPublisherProvidedUnifiedID <key-value> - <parners> 您应该使用此 API 传递从您与 ID 提供商的直接合作关系中获得的通用 ID。请参阅“IM SDK”部分中的完整列表。

IMUserDataTypes 和 IMUserDataModel   

IMUserDataTypes该类保存您传递的不同用户数据。首先,您应该创建一个实例 IMUserDataTypes并设置该实例的相应值IMUserDataModel。系统会将该实例传递 IMUserDataModel给相应的函数。

IMUserDataTypes  

财产

类型

目的

MD5 

细绳 

使用 MD5 哈希算法提供哈希数据  

sha1 细绳 使用 SHA1 哈希算法提供哈希数据。

SHA256 

细绳 

使用 SHA256 哈希算法提供哈希数据。 

IM用户数据模型 

财产

类型

目的

电话号码 

IMUserDataTypes 

提供不同变体(md5、sha1 等)的电话号码。

邮箱地址 

IMUserDataTypes 

提供不同格式(md5、sha1 等)的电子邮件地址。

额外内容 

字典 

提供任何额外信息。 

您必须注意,某些数据类型(例如电子邮件 ID)是某些身份合作伙伴的必备条件。

回调 

SDK 会调用“ onFetchCompleted ”函数,通知您已成功将哈希处理后的个人身份信息 (PII) 数据提交到 InMobi  ID服务。它还会以字典的形式返回通用 ID 列表。SDK 不会返回已过期的通用ID ,并且 仅在主线程上调用此函数 

功能

句法

onFetchCompleted 

onFetchCompleted 响应:字典?,错误:错误?) 

如果您设置了错误对象,SDK 会调用此函数,以便在将哈希 PII 数据提交到InMobi Id 服务时通知您错误  。 

IMSDK  

您应该使用此功能将通过与不同ID 合作伙伴(例如 LiveRamp、ID5 等)的直接合作获得的通用 ID 向上游传递给需求合作伙伴或其他广告交易平台。这有助于您在整个生态系统中实现广告资源变现。本质上,它是 SDK 中现有的 API,使您能够将通用 ID 传递给 InMobi。当通用 ID 和 SDK UnifID 服务同时存在时,SDK UnifID 服务优先级更高。

功能 

句法

设置发布者提供的统一ID 

设置发布者提供的统一ID ids:字典) 

以下是支持的ID 合作伙伴列表。在“key”值中,发布商需要遵守命名约定(全部小写)。

ID Partners 关键值
LiveRamp liveramp.com
ID5 id5-sync.com
布莱特普尔 britepool.com
交易台(UID2) uidapi.com
活体意图 liveintent.com
公共通用 pubcid.org
Nextroll nextroll.com
寓言 parrable.com
点击广告 tapad.com
ZeoTap zeotap.com
Criteo criteo.com
UIDTTD adserver.org
netid.de
NeustarFabrick neustar.biz
光环 audigent.com
洛塔姆全景 crwdcntrl.net
默克尔 merkleinc.com
Quantcast quantcast.com
IntentIQ intentiq.com
DMD hcn.health
IDx dx.lat
Verizon Media Connect verizonmedia.com
Media Wallah 开放链接 mediawallahscript.com
Novatiq雪花 novatiq.com
深度意图 deepintent.com
混合器 admixer.net
美国运通 amxrtb.com
ε pubcid.org

内部 API  

为了创建广告请求,SDK  内部使用了getUids API  

功能

句法

获取用户 ID 

getUids ( ) -&gt; 字典? 

 如果您设置了错误对象,SDK 会调用此函数,以便在将哈希 PII 数据提交到 InMobi Id 服务时通知您错误

本页内容

最后更新于 : 21 Jul, 2026