Macros for Listing Campaigns

There are two high-level Campaign listing macros that allow you to loop over all active Campaigns. Use at least one of the macros in the table below as the {fmt} parameter. Specify a delimiter using {delim}.

  • __SS_LISTCAMPAIGN{fmt}{delim}__ – Returns data on all active Campaigns the visitor is assigned to.
  • __SS_LISTCAMPAIGNCOUNTED{fmt}{delim}__ – Similar to the one above, but includes only Campaigns in which the visitor is counted.
Macro Data Type Description
__SS_TCID__ Integer Campaign ID. The TestCampaign_ID listed in the URL when you are editing a Campaign or the ID visible in the tooltip when you hover over the Campaign on the Campaign List.
__SS_TCNAME__ Alphanumeric, cleaned Campaign name. The name of the Campaign.
__SS_VGID__ Integer Variation Group ID. The VariationGroup_ID in an edit Variation Group URL or the tooltip when hovering over the Variation Group Edit button.
__SS_VGNAME__ Alphanumeric, cleaned Variation Group name. The name of the Variation Group.
__SS_UASMTVISITCOUNT__ Integer Vists. The number of visits by the visitor within the context of this Campaign.
__SS_UVISITASMTCOUNTED__ Integer User Visit Counted. A value of 1 if the user is counted in the Campaign; otherwise, it’s 0. This macro also works when using __SS_LISTCAMPAIGNCOUNTED{fmt}{delim}__, but it will always contain a value of 1 since the user will be counted in all Campaigns listed.

Example For __SS_LISTCAMPAIGNCOUNTED

To create a list of Variation Group IDs that includes only Campaigns in which the visitor is counted, use the following macro:

__SS_LISTCAMPAIGNCOUNTED{__SS_VGID__}{;}__

If the visitor is assigned to two Campaigns, but counted in only one, the dynamically generated text looks similar to the following:

432

Note: We recommend this macro when you want to accurately list Campaign Assignments.

Example For __SS_LISTCAMPAIGN

To create a list of all the Variation Group IDs that the visitor is assigned to in every Campaign, use the following macro:

__SS_LISTCAMPAIGN{__SS_VGID__}{;}__

If the visitor is assigned to two Campaigns, the dynamically generated text looks similar to the following:

751;432