com.vwo.services.api.TrackCampaign Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of vwo-java-sdk Show documentation
Show all versions of vwo-java-sdk Show documentation
Java library to initiate VWo instance for server side a/b testing
/**
* Copyright 2019-2022 Wingify Software Pvt. Ltd.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.vwo.services.api;
import com.vwo.enums.APIEnums;
import com.vwo.enums.CampaignEnums;
import com.vwo.enums.GoalEnums;
import com.vwo.logger.Logger;
import com.vwo.logger.LoggerService;
import com.vwo.models.response.BatchEventData;
import com.vwo.models.response.Campaign;
import com.vwo.models.response.Goal;
import com.vwo.models.response.Variation;
import com.vwo.services.batch.BatchEventQueue;
import com.vwo.services.core.VariationDecider;
import com.vwo.services.http.HttpGetRequest;
import com.vwo.services.http.HttpParams;
import com.vwo.services.http.HttpPostRequest;
import com.vwo.services.http.HttpRequestBuilder;
import com.vwo.services.settings.SettingFile;
import com.vwo.utils.CampaignUtils;
import com.vwo.utils.HttpUtils;
import com.vwo.utils.ValidationUtils;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.HashSet;
import java.util.Map;
public class TrackCampaign {
private static final Logger LOGGER = Logger.getLogger(TrackCampaign.class);
/**
* Get variation, tracks conversion event and send to VWO server.
* LOGGER.debug("Track goal response received" + properties);
*
* @param campaignSpecifier Campaign key or array of Strings containing campaign keys or null
* @param userId User ID
* @param goalIdentifier Goal key
* @param revenueValue revenue generated on triggering the goal
* @param settingFile Settings File Configuration
* @param variationDecider Variation decider service
* @param isDevelopmentMode Development mode flag.
* @param batchEventQueue Event Batching Queue.
* @param CustomVariables Pre Segmentation custom variables
* @param variationTargetingVariables User Whitelisting Targeting variables
* @param goalsToTrack Enum of goal type to track a particular type of goal
* @return Map containing the campaign name and their boolean status representing if tracked or not, and null if something went wrong.
*/
public static Map trackGoal(
Object campaignSpecifier,
String userId,
String goalIdentifier,
Object revenueValue,
SettingFile settingFile,
VariationDecider variationDecider,
boolean isDevelopmentMode,
BatchEventQueue batchEventQueue,
Map CustomVariables,
Map variationTargetingVariables,
GoalEnums.GOAL_TYPES goalsToTrack,
Map usageStats,
Map eventProperties
) {
try {
if (!TrackCampaign.isTrackParamsValid(campaignSpecifier, userId, goalIdentifier)) {
return null;
}
if (eventProperties == null) {
eventProperties = new HashMap<>();
}
ArrayList campaignList = new ArrayList<>();
if (campaignSpecifier == null) {
campaignList = CampaignUtils.getCampaignFromGoalIdentifier(goalIdentifier, settingFile.getSettings().getCampaigns());
} else {
campaignSpecifier = campaignSpecifier instanceof String ? new String[]{(String) campaignSpecifier} : campaignSpecifier;
for (String campaign : (String[]) campaignSpecifier) {
campaignList.add(settingFile.getCampaign(campaign));
}
}
if (campaignList.size() == 0) {
LOGGER.error(LoggerService.getComputedMsg(LoggerService.getInstance().errorMessages.get("NO_CAMPAIGN_FOUND"), new HashMap() {
{
put("goalIdentifier", goalIdentifier);
}
}));
return null;
}
Map trackStatus = new HashMap<>();
Map metricMap = new HashMap<>();
HashSet revenuePropList = new HashSet();
Boolean areGlobalGoals = campaignList.size() > 1 && batchEventQueue == null;
if (areGlobalGoals) {
BatchEventData batchEventData = new BatchEventData();
batchEventData.setEventsPerRequest(campaignList.size());
batchEventQueue = new BatchEventQueue(batchEventData,
settingFile.getSettings().getSdkKey(),
settingFile.getSettings().getAccountId(), isDevelopmentMode, usageStats);
}
for (int i = 0; i < campaignList.size(); i++) {
Campaign campaign = campaignList.get(i);
String key = campaign == null ? ((String[]) campaignSpecifier)[i] : campaign.getKey();
trackStatus.put(key, false);
if (campaign == null) {
LOGGER.warn(LoggerService.getComputedMsg(LoggerService.getInstance().warningMessages.get("CAMPAIGN_NOT_RUNNING"), new HashMap() {
{
put("campaignKey", key);
put("api", APIEnums.API_TYPES.TRACK.value());
}
}));
} else if (campaign.getType().equalsIgnoreCase(CampaignEnums.CAMPAIGN_TYPES.FEATURE_ROLLOUT.value())) {
LOGGER.error(LoggerService.getComputedMsg(LoggerService.getInstance().errorMessages.get("API_NOT_APPLICABLE"), new HashMap() {
{
put("api", "track");
put("userId", userId);
put("campaignKey", key);
put("campaignType", campaign.getType());
}
}));
} else {
Goal goal = TrackCampaign.getGoalId(campaign, goalIdentifier);
if (goal == null) {
LOGGER.error(LoggerService.getComputedMsg(LoggerService.getInstance().errorMessages.get("TRACK_API_GOAL_NOT_FOUND"), new HashMap() {
{
put("goalIdentifier", goalIdentifier);
put("userId", userId);
put("campaignKey", key);
}
}));
} else if (goalsToTrack.value().equals(GoalEnums.GOAL_TYPES.ALL.value()) || goalsToTrack.value().equals(goal.getType())) {
if (goal.getType().equalsIgnoreCase(GoalEnums.GOAL_TYPES.REVENUE.value()) && revenueValue == null) {
if (!eventProperties.containsKey(goal.getRevenueProp())) {
if (settingFile.getSettings().getIsEventArchEnabled() != null && settingFile.getSettings().getIsEventArchEnabled()) {
LOGGER.error(LoggerService.getComputedMsg("({file}): Revenue value should be passed either in options or as an event property for revenue goal:{goalIdentifier} "
+
"for Campaign:{campaignKey} and User Id:{userId}",
new HashMap() {
{
put("goalIdentifier", goalIdentifier);
put("userId", userId);
put("campaignKey", key);
}
}));
} else {
LOGGER.error(LoggerService.getComputedMsg(LoggerService.getInstance().errorMessages.get("TRACK_API_REVENUE_NOT_PASSED_FOR_REVENUE_GOAL"), new HashMap() {
{
put("goalIdentifier", goalIdentifier);
put("userId", userId);
put("campaignKey", key);
}
}));
}
} else {
if (goal.getType().equalsIgnoreCase(GoalEnums.GOAL_TYPES.REVENUE.value()) && goal.getRevenueProp() != null) {
revenuePropList.add(goal.getRevenueProp());
}
Object revenue = goal.getType().equalsIgnoreCase(GoalEnums.GOAL_TYPES.CUSTOM.value()) ? null : revenueValue;
String variation = CampaignVariation.getCampaignVariationName(settingFile.getSettings(), APIEnums.API_TYPES.TRACK.value(), campaign, userId, variationDecider, CustomVariables,
variationTargetingVariables, goalIdentifier);
if (variation != null) {
TrackCampaign.sendTrackCall(
settingFile,
campaign,
userId,
goal,
CampaignUtils.getVariationObjectFromCampaign(campaign, variation),
revenue,
isDevelopmentMode,
batchEventQueue,
metricMap,
areGlobalGoals
);
trackStatus.put(key, true);
}
}
} else {
if (goal.getType().equalsIgnoreCase(GoalEnums.GOAL_TYPES.REVENUE.value()) && goal.getRevenueProp() != null) {
revenuePropList.add(goal.getRevenueProp());
}
Object revenue = goal.getType().equalsIgnoreCase(GoalEnums.GOAL_TYPES.CUSTOM.value()) ? null : revenueValue;
String variation = CampaignVariation.getCampaignVariationName(settingFile.getSettings(), APIEnums.API_TYPES.TRACK.value(), campaign, userId, variationDecider, CustomVariables,
variationTargetingVariables, goalIdentifier);
if (variation != null) {
TrackCampaign.sendTrackCall(
settingFile,
campaign,
userId,
goal,
CampaignUtils.getVariationObjectFromCampaign(campaign, variation),
revenue,
isDevelopmentMode,
batchEventQueue,
metricMap,
areGlobalGoals
);
trackStatus.put(key, true);
}
}
}
}
}
if (areGlobalGoals && !batchEventQueue.getBatchQueue().isEmpty()) {
batchEventQueue.flush(false);
}
if (settingFile.getSettings().getIsEventArchEnabled() != null && settingFile.getSettings().getIsEventArchEnabled() && metricMap.size() > 0) {
Map trackGoalPayload = HttpRequestBuilder.getEventArchTrackGoalPayload(settingFile, userId, metricMap, goalIdentifier, revenueValue, revenuePropList, eventProperties);
HttpParams httpParams = HttpRequestBuilder.getEventArchQueryParams(settingFile, goalIdentifier, trackGoalPayload, null);
HttpPostRequest.send(httpParams, HttpUtils.handleEventArchResponse(settingFile.getSettings().getAccountId(), goalIdentifier, null), false);
}
return trackStatus;
} catch (Exception e) {
// LOGGER.error(LoggerMessagesEnums.ERROR_MESSAGES.GENERIC_ERROR.value(), e);
return null;
}
}
private static boolean isTrackParamsValid(Object campaignSpecifier, String userId, String goalIdentifier) {
return ValidationUtils.isValidParams(
new HashMap() {
{
put("campaignKey", campaignSpecifier);
put("userId", userId);
put("goalIdentifier", goalIdentifier);
}
},
APIEnums.API_TYPES.TRACK
);
}
public static Goal getGoalId(Campaign campaign, String goalIdentifier) {
for (Goal singleGoal : campaign.getGoals()) {
if (goalIdentifier.equalsIgnoreCase(singleGoal.getIdentifier())) {
return singleGoal;
}
}
return null;
}
private static void sendTrackCall(
SettingFile settingFile,
Campaign campaign,
String userId,
Goal goal,
Variation variation,
Object revenueValue,
boolean isDevelopmentMode,
BatchEventQueue batchEventQueue,
Map metricMap,
boolean areGlobalGoals
) {
try {
if (batchEventQueue != null && !areGlobalGoals) {
batchEventQueue.enqueue(HttpRequestBuilder.getBatchEventForTrackingGoal(settingFile, campaign, userId, goal, variation, revenueValue));
} else if (settingFile.getSettings().getIsEventArchEnabled() != null && settingFile.getSettings().getIsEventArchEnabled()) {
metricMap.put(String.valueOf(campaign.getId()), goal.getId());
} else {
if (areGlobalGoals) {
batchEventQueue.enqueue(HttpRequestBuilder.getBatchEventForTrackingGoal(settingFile, campaign, userId, goal, variation, revenueValue));
} else {
HttpParams httpParams = HttpRequestBuilder.getGoalParams(settingFile, campaign, userId, goal, variation, revenueValue);
if (!isDevelopmentMode) {
HttpGetRequest.send(httpParams, settingFile.getSettings().getAccountId());
}
}
}
} catch (Exception e) {
// LOGGER.error(LoggerMessagesEnums.ERROR_MESSAGES.UNABLE_TO_DISPATCH_HTTP_REQUEST.value());
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy