要配置 Adjust SDK 的行为,请指定 Adjust.initSdk
方法中的各属性。
必要配置
function initSdk({ logLevel, logOutput, ...options }: InitOptions): void;
要配置 Adjust SDK,请使用下列参数调用 Adjust.initSdk
方法:
appToken
(string
):您的 Adjust 应用识别码。environment
(string
):SDK 运行的环境。传送sandbox
,可在 sandbox 模式下运行 SDK,方便进行测试;传送production
,可在生产模式下运行 SDK,方便发布。
Adjust.initSdk({ appToken: "YOUR_APP_TOKEN", environment: "sandbox",});
日志选项
export type LogOptionsT = $ReadOnly< $Shape<{| logLevel: "none" | "error" | "warning" | "info" | "verbose", logOutput: string, |}>>;
通过 Adjust SDK,您可以配置不同日志级别,返回不同数量的信息。可用的日志级别包括:
值 | 描述 |
---|---|
verbose | 启用完整日志 |
info | 返回信息、警告和错误日志 |
warning | 返回警告和错误日志 |
error | 只返回错误日志 |
none | 禁用所有日志 |
您可以通过在 initSdk
方法中指定 logLevel
参数来设置日志级别。若未传递值,则 SDK 默认使用 error
级别。
Adjust.initSdk({ appToken: "YOUR_APP_TOKEN", environment: "sandbox", logLevel: "verbose",});
设置日志输出
您可以在网页应用中委派日志输出位置来直接在屏幕中显示日志。为此,请在 initSdk
方法中的 logOutput
参数中指定一个 HTML 选择器。SDK 日志会输出至此容器。
Adjust.initSdk({ appToken: "YOUR_APP_TOKEN", environment: "sandbox", logOutput: "#logDiv",});
初始化选项
export type InitOptionsT = $ReadOnly< $Shape<{| appToken: $PropertyType<BaseParamsT, "appToken">, environment: $PropertyType<BaseParamsT, "environment">, defaultTracker: $PropertyType<BaseParamsT, "defaultTracker">, externalDeviceId: $PropertyType<BaseParamsT, "externalDeviceId">, customUrl: $PropertyType<CustomConfigT, "customUrl">, dataResidency: $PropertyType<CustomConfigT, "dataResidency">, urlStrategy: $PropertyType<CustomConfigT, "urlStrategy">, eventDeduplicationListLimit: $PropertyType< CustomConfigT, "eventDeduplicationListLimit" >, namespace: $PropertyType<CustomConfigT, "namespace">, attributionCallback: (string, Object) => mixed, |}>>;
设置外部设备标识符
externalDeviceId: string;
外部设备标识符是您为设备或用户自定义的一个值。您可以通过这个值在不同的会话和平台中识别用户。您也可以通过该值基于用户对安装进行去重,这样同一位用户就不会被记录为多次新安装了。请联系您的 Adjust 代表来开始使用外部设备 ID。
您还可以使用外部设备 ID 作为设备的自定义标识符。这可以确保您的数据与其他系统中的数据保持一致性。请在 Adjust.initSdk
调用中以 externalDeviceId
形式传送外部设备 ID。
Adjust.initSdk({ appToken: "YOUR_APP_TOKEN", environment: "sandbox", externalDeviceId: "YOUR_EXTERNAL_DEVICE_ID",});
如果您想在商业分析中使用外部设备 ID,则可以将其作为会话回传参数发送。
您可以将已有外部设备 ID 导入到 Adjust。这能保证 Adjust 服务器将未来的数据与已有设备记录相匹配。请联系您的 Adjust 代表,了解更多信息。
设置默认链接识别码
defaultTracker: string;
如果您的应用已预安装在设备上,那么则可以配置一个默认链接识别码。当用户首次打开预安装应用时,安装就会被归因给默认链接识别码。请在 Adjust.initSdk
调用的 defaultTracker
属性中传送您的识别码。
Adjust.initSdk({ appToken: "YOUR_APP_TOKEN", environment: "sandbox", defaultTracker: "YOUR_LINK_TOKEN",});
设置存储命名空间
namespace: string;
Adjust SDK 默认创建一个用于存储数据的存储命名空间。您可以改写此设置并指定一个自定义命名空间来控制数据存储位置。
设置后,所有 SDK 存储在默认命名空间中的数据都会被转移到自定义命名空间。
您可以在 initSdk
方法中指定一个 namespace
属性,来设置自定义命名空间。
Adjust.initSdk({ appToken: "YOUR_APP_TOKEN", environment: "sandbox", namespace: "myCustomNamespace",});
动态配置
为响应事件或用户进行的操作, 动态 配置选项可能在 SDK 的生命周期中发生变化。
开启和关闭离线模式
function switchToOfflineMode(): void;
Adjust SDK 会实时向 Adjust 后端发送事件和会话数据。您可以通过将 SDK 设为离线状态来暂停信息的发送。在离线状态,SDK 会在浏览器的 IndexedDB 中存储所有数据,如不支持 IndexedDB,则会将数据存储在 localStorage。
您可以随时使用下列参数调用 switchToOfflineMode
方法,以开启和关闭离线模式:
Adjust.switchToOfflineMode();
事件缓冲
function switchBackToOnlineMode(): void;
离线模式关闭后,SDK 会将所有已储存的信息发送至 Adjust 服务器。为此,请调用 switchBackToOnlineMode
方法。
Adjust.switchBackToOnlineMode();
禁用 SDK
function stop(): void;
应用打开时 Adjust SDK 会默认运行。您可以通过禁用和启用 Adjust SDK 来暂停或恢复记录。禁用 Adjust SDK 时,SDK 不会向 Adjust 服务器发送任何数据。
您可以调用 stop
方法来随时停用 SDK。
Adjust.stop();
重新启用 SDK
function restart(): void;
您可以调用 restart
方法来随时重启 SDK。
Adjust.restart();