CampaignService.SetCampaign Method

If CampaignInfo with given campaignCode exists, is running and combination of source and content is valid (when content is not null, source can't be null), sets campaignCode, source and content to their properties (CampaignCode, CampaignSourceName or CampaignContent respectively).

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

Syntax

public void SetCampaign(
	string campaignCode,
	string siteName,
	string source = null,
	string content = 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

content (Optional)

Type: System.String
Campaign UTM content

Implements

ICampaignService.SetCampaign(String, 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, String) method.

var campaignService = new CampaignService();

...

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

...

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


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


// returns myContent
public string GetCampaignContent() 
{
    return campaignService.CampaignSourceName;
}