Initialization
To create a VWO Client instance, you need to initialize the VWO FME Python SDK. This client instance serves as the core interface for conducting feature management and experimentation(A/B and personalization) within your application.
Usage
using VWOFmeSdk;
var vwoInitOptions = new VWOInitOptions{
SdkKey = "32-alpha-numeric-sdk-key", // Replace with your SDK key
AccountId = 123456 // Replace with your account ID
};
var vwoClient = VWO.Init(vwoInitOptions);
An object of VWOInitOptions
is created to store the SDK configuration details.
The Init()
function is called with the vwoInitOptions
object. It initializes and returns a VWO Client ObjectvwoClient
, which can be used to perform feature
This client object allows you to run experiments, track events, and enable/disable feature flags.
Parameter Definitions
Parameter | Type | Description |
---|---|---|
AccountId Required | integer | Your VWO application's Account ID. |
SdkKey Required | string | A unique environment key is provided to you inside the Websites & Apps section in the VWO application, under Default Project. |
PollInterval Optional | integer | Time (in milliseconds) at which VWO should check with the server for any updates to the feature flag or rules in the VWO Dashboard. Useful to keep your VWO Client instance up-to-date with any changes made in the VWO Application. For more details, please check - Polling |
Logger Optional | ILogger | An optional logger object that defines the logging behavior. For more details, please check - Logger |
Storage Optional | IStorage | Storage Service, if required, can be implemented using this parameter. For more details, please check - Storage Service |
GatewayService Optional | Dictionary | If using the FME Gateway Service, this object will specify the location and port of where the gateway service is deployed on your servers. |
Integrations Optional | Action | Contains a callback function that receives campaign data which can be pushed to any external tool that you need to integrate with. Integrations |
Poll Interval (Keeping VWO client up-to-date)
When you initialize the vwoClient on your server, it pulls the latest configurations you've done in the VWO application.
If/when you make any changes to the feature flags or rules within VWO after the vwoClient has been initialized in your server, there needs to be some way to update your vwoClient with the latest settings from VWO. This can be done via polling.
The poll interval is an optional parameter that allows the SDK to automatically fetch and update settings from the VWO server at specified intervals. Setting this parameter ensures your application always uses the latest configuration.
var vwoClient = VWO.Init(new VWOInitOptions
{
SdkKey = "32-alpha-numeric-sdk-key",
AccountId = 123456,
PollInterval = 60000 // Fetch updates every 60 seconds
});
Logger
VWO by default logs all ERROR level messages to your server console. To gain more control over VWO's logging behavior, you can use the logger parameter in the init configuration.
var vwoInitOptions1 = new VWOInitOptions
{
SdkKey = "32-alpha-numeric-sdk-key",
AccountId = 123456,
Logger = new Logger
{
Level = "DEBUG"
}
};
var vwoClient1 = VWO.Init(vwoInitOptions1);
Please click here for more advanced logger options.
Storage
By default, the SDK operates in stateless mode, evaluating flags on each get_flag call. To improve performance and consistency, you can use a custom storage mechanism to cache decisions, ensuring stable user experiences and reducing application load.
var vwoInitOptions = new VWOInitOptions
{
SdkKey = "32-alpha-numeric-sdk-key",
AccountId = 123456,
Storage = new StorageConnector()
};
Please click here to learn more about storage implementation.
Gateway Service
The VWO FME Gateway Service enhances Feature Management and Experimentation (FME) SDKs by enabling pre-segmentation based on user location and user agent. It ensures minimal latency and improved security. The service can be customized via the gateway_service parameter during initialization.
var vwoInitOptions = new VWOInitOptions
{
SdkKey = "32-alpha-numeric-sdk-key",
AccountId = 123456,
Logger = logger,
GatewayService = new Dictionary<string, object> { { "url", "https://custom.gateway.com" } },
};
Please click here to learn more about gateway service.
Integrations
VWO FME SDKs provide seamless integration with third-party tools like analytics platforms, monitoring services, customer data platforms (CDPs), and messaging systems. This is achieved through a simple yet powerful callback mechanism that receives VWO-specific properties and can forward them to any third-party tool of your choice.
// Integration callback implementation
public class IntegrationCallbackImpl : IntegrationCallback
{
public void Execute(Dictionary<string, object> properties)
{
Console.WriteLine("Integration callback executed: " + JsonConvert.SerializeObject(properties));
}
}
var vwoClient = VWO.Init(new VWOInitOptions
{
SdkKey = "your-sdk-key", // Replace with your SDK key
AccountId = your-account-id, // Replace with your account ID
Integrations = new IntegrationCallbackImpl() // Your integration callback implementation
});
Please click here to learn more about Integrations,.
Updated 20 days ago