CampaignService.SetCampaign Method

If CampaignInfo with given campaignCode exists and is running, sets both campaignCode and source to their properties (CampaignCode or CampaignSourceName respectively).

Namespace: CMS.WebAnalytics
Assembly: CMS.WebAnalytics (in CMS.WebAnalytics.dll) Version: 10.0.0

Syntax

public void SetCampaign(
	string campaignCode,
	string siteName,
	string source = null
)

Parameters

campaignCode

Type: System.String
Name of the campaign to be set

siteName

Type: System.String
Name of the site the campaignCode belongs to

source (Optional)

Type: System.String
Name of the campaign source

Implements

ICampaignService.SetCampaign(String, String, String)

Exceptions

Exception	Condition
ArgumentException	campaignCode is null -or- siteName is null or empty

Examples

Following example shows how to use the SetCampaign(String, String, String) method.

var campaignService = new CampaignService();

...

// stores myCampaign to the <see cref="P:CMS.WebAnalytics.CampaignService.CampaignCode" /> and mySource to the <see cref="P:CMS.WebAnalytics.CampaignService.CampaignSourceName" />
campaignService.SetCampaign("myCampaign", "mySite", "mySource");

...

// for all following requests of the same visitor
// returns myCampaign
public string GetCampaignCode() 
{
    return campaignService.CampaignCode;
}


// returns mySource
public string GetSourceName() 
{
    return campaignService.CampaignSourceName;
}