adjust-icon

配置

请使用该文档中的方法配置 Adjust SDK 行为。

实例化 config 对象

方法签名
public AdjustConfig(string appToken, string environment, Action<string> logDelegate = null, LogLevel? logLevel = null)

要配置 Adjust SDK,您需要实例化一个 AdjustConfig 对象。该对象包含 只读 配置选项。请将这些配置选项发送给 Adjust SDK。

要实例化您的 config 对象,请创建新的 AdjustConfig 实例,并传送下列参数:

  • appToken (string):您的 Adjust 应用识别码
  • environment (string):SDK 运行的环境。传送 AdjustConfig.EnvironmentSandbox,可在 sandbox 模式下运行 SDK,方便进行测试;传送 AdjustConfig.EnvironmentProduction,可在生产模式下运行 SDK,方便发布。
  • logDelegate (Action<string>):被委托进行日志记录的函数。您也可以使用 setLogDelegate 方法配置该函数。
  • logLevel (LogLevel):要记录的日志级别。受支持的日志级别包括:
logLevel描述
LogLevel.Verbose启用完整日志
LogLevel.Debug启用调试记录
LogLevel.Info仅显示信息层级日志 (默认选项)
LogLevel.Warn禁用信息警告
LogLevel.Error禁用警告及更低级别日志
LogLevel.Assert禁用错误及更低级别日志
LogLevel.Suppress禁止所有日志
string appToken = "hmqwpvspxnuo";
string environment = AdjustConfig.EnvironmentSandbox;
var adjustConfig = new AdjustConfig(appToken, environment,
msg => System.Diagnostics.Debug.WriteLine(msg), LogLevel.Verbose);
Adjust.ApplicationLaunching(adjustConfig);

只读配置

只读 配置选项需要在 SDK 初始化 之前AdjustConfig 实例中设定。这些配置选项无法在 SDK 运行过程中变更。请务必在运行 Adjust.ApplicationLaunching() 之前配置要使用的所有设置。

配置日志委托

方法签名
public void setLogDelegate(Action<string> logDelegate);

日志委托是一种函数。Adjust SDK 会调用日志委托以记录日志。要配置日志委托,请将您的日志函数传送至 setLogDelegate。Adjust SDK 会在每次输出日志消息时调用该函数。

AdjustConfig adjustConfig = new AdjustConfig("{YourAppToken}", AdjustEnvironment.Sandbox, true);
//...
adjustConfig.setLogDelegate(msg => Debug.Log(msg));
//...
Adjust.ApplicationLaunching(config);

设置外部设备标识符

方法签名
public void setExternalDeviceId(string externalDeviceId);

外部设备标识符是您为设备或用户自定义的一个值。您可以通过这个值在不同的会话和平台中识别用户。您也可以通过该值基于用户对安装进行去重,这样同一位用户就不会被记录为多次新安装了。请联系您的 Adjust 代表来开始使用外部设备 ID。

您还可以使用外部设备 ID 作为设备的自定义标识符。这可以确保您的数据与其他系统中的数据保持一致性。您可以使用下列参数调用 setExternalDeviceId 方法,以设置该属性:

  • externalDeviceId (string):您的外部设备标识符。需要 区分大小写 。如果您导入了外部设备 ID,则需要确保发送的值与已导入的值相匹配。
AdjustConfig adjustConfig = new AdjustConfig("{YourAppToken}", AdjustEnvironment.Sandbox, true);
//...
adjustConfig.setExternalDeviceId("{Your-External-Device-Id}");
//...
Adjust.ApplicationLaunching(adjustConfig);

如果您想在商业分析中使用外部设备 ID,则可以将其作为会话回传参数发送。

您可以将已有外部设备 ID 导入到 Adjust。这能保证 Adjust 服务器将未来的数据与已有设备记录相匹配。请联系您的 Adjust 代表,了解更多信息。

属性声明
public string DefaultTracker { get; set; }

如果您的应用已预安装在设备上,那么则可以配置一个默认链接识别码。当用户首次打开预安装应用时,安装就会被归因给默认链接识别码。要设置默认链接识别码,请将您的 Adjust 链接识别码指定给 config 实例上的 DefaultTracker 属性。

var adjustConfig = new AdjustConfig(appToken, environment,
msg => System.Diagnostics.Debug.WriteLine(msg), LogLevel.Verbose);
adjustConfig.DefaultTracker = "{TrackerToken}";
Adjust.ApplicationLaunching(adjustConfig);

启用后台记录

属性声明
public bool SendInBackground { get; set; }

默认情况下,应用在后台运行时,Adjust SDK 会暂停发送请求。您可以通过启用后台记录功能来使 SDK 在应用位于后台时发送请求。要启用后台记录,请为 config 实例 SendInBackground 属性指定 bool

var adjustConfig = new AdjustConfig(appToken, environment,
msg => System.Diagnostics.Debug.WriteLine(msg), LogLevel.Verbose);
//...
adjustConfig.SendInBackground = true;
//...
Adjust.ApplicationLaunching(adjustConfig);

启用事件缓冲

属性声明
public bool EventBufferingEnabled { get; set; }

用户在应用中触发事件后,Adjust SDK 会立即发送事件信息。您可以通过设置事件缓冲来按指定时间发送事件信息。事件缓冲会将事件存储在设备本地缓冲中,每分钟发送一批请求。

您的 config 对象包含一个 bool EventBufferingEnabled 属性,该属性控制此行为。要启用事件缓冲,请为 config 实例 EventBufferingEnabled 属性指定 bool 值。

  • EventBufferingEnabled (bool):设为 true 可启用事件缓冲;设为 false 可禁用事件缓冲。
var adjustConfig = new AdjustConfig(appToken, environment,
msg => System.Diagnostics.Debug.WriteLine(msg), LogLevel.Verbose);
//...
adjustConfig.EventBufferingEnabled = true;
//...
Adjust.ApplicationLaunching(adjustConfig);

延迟 SDK 启动

属性声明
public TimeSpan? DelayStart { get; set; }

默认情况下,Adjust SDK 会在应用打开时启动。如果您想通过会话参数发送的数据在应用打开时不可用,那么则可以延迟 SDK 启动。当您想发送唯一标识符等信息时,这一方法尤其有效。

要配置启动延迟,请为 config 实例DelayStart属性指定一个TimeSpan值。

  • delayStart (TimeSpan):SDK 启动延迟事件 (以秒计)。您最多可以将 SDK 的启动时间延迟 10 秒。
adjustConfig.DelayStart = TimeSpan.FromSeconds(5.5);

动态配置

为响应事件或用户进行的操作, 动态 配置选项可能在 SDK 的生命周期中发生变化。

开启和关闭离线模式

方法签名
public void SetOfflineMode(bool offline);

Adjust SDK 会实时向 Adjust 后端发送事件和会话数据。您可以通过将 SDK 设为离线状态来暂停信息的发送。在离线状态中,SDK 会在设备本地文件中存储所有数据。离线模式关闭后,SDK 会将此信息发送至 Adjust 服务器。

您可以随时使用下列参数调用 SetOfflineMode 方法,以开启和关闭离线模式:

  • offline (bool):设为 true 可启用离线模式;设为 false 可禁用离线模式。
Adjust.SetOfflineMode(true);

设置推送标签

方法签名
public static void SetPushToken(string pushToken);

推送标签 (Push token) 用于受众和客户回传。在卸载和重装监测中,推送标签也是必要的。

您的 config 对象包含一个 string pushToken 属性,您可以通过该属性存储推送标签。您可以随时调用 setPushToken 方法,并发送下列参数,以更新该属性:

  • pushToken (string):您的推送标签 (Push token)。
Adjust.SetPushToken("{YourDeviceToken}");

禁用或启用 SDK

方法签名
public static void SetEnabled(bool enabled);

应用打开时 Adjust SDK 会默认运行。您可以通过禁用和启用 Adjust SDK 来暂停或恢复记录。禁用 Adjust SDK 时,SDK 不会向 Adjust 服务器发送任何数据。

您可以随时使用下列参数调用 SetEnabled 方法,以启用或禁用 SDK:

  • enabled (bool):设为 true 可启用 SDK;设为 false 可禁用 SDK。
Adjust.SetEnabled(false);

查看启用状态

方法签名
public static bool IsEnabled();

您可以随时调用 isEnabled 方法,查看 Adjust SDK 是否已启用。该方法会返回 bool 来指示 SDK 是处于 启用 (true) 还是 禁用 (false) 状态。

Adjust.IsEnabled();