adjust-icon

配置

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

实例化 config 对象

方法签名
public AdjustConfig(string appToken, AdjustEnvironment environment, bool allowSuppressLogLevel)

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

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

  • appToken (string):您的 Adjust 应用识别码
  • environment (AdjustEnvironment):SDK 运行的环境。传送 AdjustEnvironment.Sandbox,可在 sandbox 模式下运行 SDK,方便进行测试;传送 AdjustEnvironment.Production,可在生产模式下运行 SDK,方便发布。
  • allowSuppressLogLevel (bool):是否禁用所有日志记录。设为 true 可禁用日志记录;设为 false 可启用日志记录。
AdjustConfig adjustConfig = new AdjustConfig("{YourAppToken}", AdjustEnvironment.Sandbox, false);
// ...
Adjust.InitSdk(adjustConfig);

只读配置

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

设置日志级别

属性声明
public AdjustLogLevel? LogLevel { get; set; }

通过 Adjust SDK,您可以配置不同日志级别,返回不同数量的信息。可用的日志级别包括:

logLevel描述
AdjustLogLevel.Verbose启用完整日志
AdjustLogLevel.Debug启用调试记录
AdjustLogLevel.Info仅显示信息级别日志 (默认选项)
AdjustLogLevel.Warn禁用信息日志
AdjustLogLevel.Error禁用警告及更低级别日志
AdjustLogLevel.Assert禁用错误及更低级别日志
AdjustLogLevel.Suppress禁止所有日志

您可以指定AdjustConfig实例中的LogLevel属性值,以设置日志级别。

AdjustConfig config = new AdjustConfig("{YourAppToken}", AdjustEnvironment.Sandbox, true);
//...
config.LogLevel = AdjustLogLevel.Error;
//...
Adjust.InitSdk(config);

设置外部设备标识符

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

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

您可以使用外部设备 ID 作为设备的自定义标识符。这可以确保您的数据与其他系统中的数据保持一致性。您可以通过将外部设备 ID 分配给AdjustConfig实例的ExternalDeviceId属性来设置外部设备 ID。

AdjustConfig adjustConfig = new AdjustConfig("{YourAppToken}", AdjustEnvironment.Sandbox, true);
//...
adjustConfig.ExternalDeviceId = "{Your-External-Device-Id}";
//...
Adjust.InitSdk(adjustConfig);

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

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

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

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

AdjustConfig adjustConfig = new AdjustConfig("{YourAppToken}", AdjustEnvironment.Sandbox);
//...
adjustConfig.DefaultTracker = "{TrackerToken}";
//...
Adjust.InitSdk(adjustConfig);

在归因中接收广告支出数据

属性声明
public bool? IsCostDataInAttributionEnabled { get; set; }

默认情况下,Adjust 不会在用户归因信息中发送成本数据。您可以通过将AdjustConfig实例上的IsCostDataInAttributionEnabled属性设置为true来请求此信息。

您可以在用户的归因信息中访问成本数据。

AdjustConfig adjustConfig = new AdjustConfig("{Your App Token}", AdjustEnvironment.Sandbox);
adjustConfig.LogLevel = AdjustLogLevel.Verbose;
adjustConfig.IsCostDataInAttributionEnabled = true;
Adjust.InitSdk(adjustConfig);

启用后台记录

属性声明
public bool? IsSendingInBackgroundEnabled { get; set; }

默认情况下,应用在后台运行时,Adjust SDK 不会发送请求。您可以将AdjustConfig实例的IsSendingInBackgroundEnabled属性设置为true 来配置SDK在应用在后台运行时发送信息。

AdjustConfig adjustConfig = new AdjustConfig("{YourAppToken}", AdjustEnvironment.Sandbox);
//...
adjustConfig.IsSendingInBackgroundEnabled = true;
//...
Adjust.InitSdk(adjustConfig);

动态配置

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

激活离线模式

方法签名
public static void SwitchToOfflineMode();

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

要启用离线模式,请调用Adjust.SwitchToOfflineMode方法。

Adjust.SwitchToOfflineMode();

禁用离线模式

方法签名
public static void SwitchBackToOnlineMode();

您可以通过调用Adjust.SwitchBackToOnlineMode方法来重新启用 SDK。这会提示 SDK 恢复发送信息。

Adjust.SwitchBackToOnlineMode();

设置推送标签 (Push token)

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

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

您可以随时调用Adjust.SetPushToken方法并传递以下参数来更新推送标签 (Push token):

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

禁用 SDK

方法签名
public static void Disable()

应用打开时 Adjust SDK 会默认运行。您可以通过调用Adjust.Disable方法禁用 Adjust SDK,暂停向 Adjust 发送信息。禁用 Adjust SDK 后,Adjust 不会收到任何数据,SDK 也不会记录任何信息。也就是说,SDK 禁用时调用的任何 Adjust 方法都不会记录任何内容。

Adjust.Disable();

启用 SDK

方法签名
public static void Enable()

如果您已经禁用了 SDK 并希望重新启用,请调用Adjust.Enable方法。启用后,SDK 会向 Adjust 服务器发送信息。

Adjust.Enable();

查看启用状态

方法签名
public static void IsEnabled(Action<bool> callback)

您可以随时调用Adjust.IsEnabled方法并发送回传函数来查看 Adjust SDK 是否启用。状态以异步方式返回并以boolean值传递至您的回传函数。

Adjust.IsEnabled(isEnabled =>
{
// Your callback function
});