Microsoft.CommerceServer.Marketing Namespace

Microsoft Commerce Server Marketing System allows users on the site to see ads and apply discounts by using coupons. The Management system allows business managers to create and manage campaign items like discounts, Ads and Direct Mails that are used as marketing tools to increase sales.

The goal for the Commerce Server Marketing system is to ship a highly performance, scalable, easy to use, secure and well documented system which should meet the requirements of any enterprise system.

The Marketing System helps the enterprise effectively communicate relevant messages to the shopper in order to improve sales (directly or indirectly). It is a rich and effective channel to communicate with customers.

It includes several tools to Target the customer, including:

• Discounts – E.g. Buy C, Get D at 20% off

• Awareness advertisement – E.g. Showcase the newly introduced Product B in the homepage

• Suggestive selling – E.g. If the shopping cart contains Product A, show banner ad BA

• Direct Mail – E.g. send the company newsletter to all active customers every month.

Classes

	Class	Description
	Advertisement	Defines a single advertisement within a campaign.
	AlwaysTrueExpressionRef	Associates a pseudo-expression that always evaluates to true with a campaign item.
	AsynchronousUploadFailedEventArgs	Provides data for the AsynchronousUploadFailed event.
	BatchInfo	Describes a batch of promotion codes during or after generation of an import and export operation.
	Campaign	Defines a Campaign object.
	CampaignEventType	Describes an Event Type in the Marketing System.
	CampaignItem	Represents the base class for all campaign item types. Provides the base functionality shared by all campaign items.
	CampaignItemManager	Manages storage and retrieval of a CampaignItem object.
	CampaignManager	Manages storage and retrieval of the Campaign object.
	Customer	Defines a Customer object.
	CustomerManager	Manages storage and retrieval of Customer objects.
	DataManager	This class is used for purging old items that have been marked as deleted in the Marketing database.
	DateRangeValidationException	The exception that is thrown when the date range properties of an entity is invalid.
	DateValidationException	The exception that is thrown when a datetime value is out of range of the expected values.
	DirectMail	Defines a direct mail campaign item.
	DirectMailRecurrence	Specifies a possible schedule of DirectMail.
	DirectMailSchedulingException	The exception that is thrown when an error occurs while setting up a Task Scheduler Entry for a direct mail using the Commerce Server Direct Mailer Service.
	Discount	Defines a single discount within a campaign.
	DiscountCondition	Represents a catalog condition that must be true for a discount to apply.
	DiscountPrioritizationException	The exception that is thrown when a failure occurs during prioritization of a Discount object.
	DiscountPrioritySet	The strongly typed DataSet that is used to perform bulk prioritization of Discount entities in the marketing system.
	DiscountPrioritySet..::.DiscountPrioritiesDataTable	The strongly typed DataTable that provides access to the "DiscountPriority" table of a DiscountPrioritySet.
	DiscountPrioritySet..::.DiscountPriority	The strongly typed DataRow that provides access to the rows of a DiscountPrioritySet.
	DiscountPrioritySet..::.DiscountPriorityChangeEvent	Provides data for the OnRowChanged, OnRowChanging, OnRowDeleted, and OnRowDeleting methods.
	DisplayableCampaignItem	Represents the base class for campaign item types that may have some display associated with them.
	DisplayProperty	Describes a substitution Property of a DisplayTemplate.
	DisplayPropertyCollection	Describes a collection of DisplayProperty objects. This class cannot be inherited.
	DisplayPropertyValue	Describes a value assigned to a DisplayProperty.
	DisplayPropertyValueCollection	Describes a collection of DisplayPropertyValue objects. This class cannot be inherited.
	DisplaySize	Defines a DisplaySize object.
	DisplaySizeManager	Manages DisplaySize related operations.
	DisplayTemplate	Represents a template that describes how a campaign item should be displayed.
	DisplayTemplateManager	Manages DisplayTemplate related operations.
	DuplicateEntityIdException	The exception that is thrown when an insert is attempted for an entity, and an entity with that Id already exists in the database.
	DuplicateEntityNameException	The exception that is thrown when an insert is attempted for an entity, and an entity with that name already exists within the appropriate scope.
	DuplicateMailingListUserException	The exception that is thrown when a name collision with an existing MailingListUser is encountered.
	DuplicatePromoCodeException	The exception that is thrown when a user is trying to save a PromoCodeDefintion with a duplicate PublicPromoCode.
	EntityHasChildrenException	The exception that is thrown when an operation fails because the entity contains children objects.
	EntityReferencedException	The exception that is thrown when a delete operation fails because some other entities depend on the current entity.
	EntityStateException	The exception that is thrown when an operation fails due to the current state of an entity.
	EnumeratedValueValidationException	The exception that is thrown when a property contains a value that cannot be converted to a specified enumeration type.
	Expression	Defines an Expression object.
	ExpressionCategorySet	The strongly typed DataSet that is used to access expression categories in the marketing system.
	ExpressionCategorySet..::.ExpressionCategoriesDataTable	The strongly typed DataTable that provides access to the "ExpressionCategory" table of a ExpressionCategorySet.
	ExpressionCategorySet..::.ExpressionCategoryRow	The strongly typed DataRow that provides access to the rows of a ExpressionCategorySet.
	ExpressionCategorySet..::.ExpressionCategoryRowChangeEvent	Provides data for the OnRowChanged, OnRowChanging, OnRowDeleted, , and OnRowDeleting event handlers for a ExpressionCategorySet.
	ExpressionList	ExpressionList is a dynamic list created through the evaluation of an expression.
	ExpressionManager	Manages Expression related operations.
	ExpressionRef	Associates Expression objects with CampaignItem objects.
	ExpressionRefCollection	Represents a collection of Expression references.
	ExpressionTarget	The ExpressionTarget class contains a set of expression/action pairs that can be used to select a single content item (an Ad for example) for display when several items fit the criteria.
	ExpressionTargetCollection	Contains a set of ExpressionTarget objects.
	ExpressionToProfilesWhereClauseConverter	Helper class to convert Expressions into a 'WHERE' clause that is supported by the OLE DB Provider for Commerce Server.
	ExpressionValidationException	The exception that is thrown when an expression does not pass simple validations.
	GlobalExpressionRef	Associates a global expression with a campaign item.
	ImportFileFormatException	The exception that is thrown when the format of an imported coupon file is invalid.
	ImportInProgressException	The exception that is thrown when a user tries to start another import/generation when they already have such operation in progress for this definition.
	IndustryCode	Represents a code for one of the industries, like Aviation or Food.
	IndustryCodeManager	Manages IndustryCode related operations.
	IntegerValueValidationException	The exception that is thrown when a property is expected to contain an integer value but does not.
	LanguageString	Describes a String value which is defined for a particular Language.
	LanguageStringCollection	Contains a collection of LanguageString objects. This class cannot be inherited.
	LanguageStringData	Describes a String value which is defined for a particular Language.
	LocalExpressionRef	Associates a local Expression object with a campaign item.
	MailingList	Mailing lists are used by Direct Mailer to send pieces of mail to selected recipients in a list.
	MailingListError	Describes an error that occurred during the list operation.
	MailingListManager	Manages MailingList related operations.
	MailingListOperation	MailingListOperation class describes a long-running list operation, such as Import, Export, Append, Subtract, etc.
	MailingListUser	A MailingList entry describing a user who is on this mailing list.
	MarketingContext	Contains the top level object used to interact with the Marketing System APIs.
	MarketingSearchClauseFactory	Factory class used to create SearchClause objects which are used to execute searches against the marketing system.
	MarketingServiceAgent	A ServiceAgent object used to run against the Marketing Web Service.
	MarketingServices	Acts as the base class for all of the objects in the Marketing System API. Custom extensions of the Marketing System API should derive from this type.
	PageGroup	The PageGroup class defines a set of pages on which a DisplayableCampaignItem can be displayed.
	PageGroupCollection	Contains a collection of PageGroup objects. This class cannot be inherited.
	PageGroupManager	Manages PageGroup related operations.
	ParentEntityDeletedException	The exception that is thrown when an operation failed because the parent entity has been deleted.
	ParentEntityDoesNotExistException	The exception that is thrown when an operation failed because the parent entity does not exist.
	ProfileDefinitionReader	Retrieves the details for profile definitions and site terms.
	ProgressEventArgs	Provides data for the PromoCodeDefinitionManager..::.ProgressEventHandler event.
	PromoCodeDefinition	Contains the definition of a promotion code or set of promotion codes.
	PromoCodeDefinitionManager	Manages storage and retrieval of PromoCodeDefinition objects. This class cannot be inherited.
	PromoCodeGenerationErrorCollection	Class that represents a set of promotion code generation errors.
	PromoCodeGeneratorException	The exception that is thrown when an error occurs sending messages to the Promo Code Generator Service.
	PromoCodeOperationStatus	Represents the current status of a promotion code import, export, or generation task.
	PromoCodeUsageValidationException	The exception that is thrown when the setting of the public code is not consistent with the PromoCodeUsageOption of the PromoCodeDefinition.
	RandomGenerationParameters	Class that specifies the parameters to a promotion code generation batch that uses the GenerateRandomCodes method.
	SearchPageNumberException	The exception that is thrown when a paged search is executed and no records are contained in the requested page.
	StaticList	StaticList is a list with no expressions or other dynamics associated with it.
	TooManyCodesRequestedException	The exception that is thrown when an attempt is made to generate a number of codes that is greater than the maximum allowed, or could not be physically generated given the generation parameters.

Structures

	Structure	Description
	PromoCodeGenerationError	Represents an error that might happen during a promotion code import or generation.

Delegates

	Delegate	Description
	AsynchronousUploadFailedEventHandler	Represents the method that will handle the AsynchronousUploadFailed event.
	DiscountPrioritySet..::.DiscountPriorityChangeEventHandler	Represents the method that will handle the DiscountPrioritySet..::.DiscountPriorityChangeEvent event of a DiscountPrioritySet.
	ExpressionCategorySet..::.ExpressionCategoryRowChangeEventHandler	Represents the method that will handle the ExpressionCategorySet..::.ExpressionCategoryRowChangeEvent events of a ExpressionCategorySet.
	PromoCodeDefinitionManager..::.ProgressEventHandler	Represents the method that will handle the Progress event of a ExportPromoCodesForDefinition operation.

Enumerations

	Enumeration	Description
	AdvertisementType	Specifies different types of Advertisement.
	ApprovalStatus	Enumeration is not used in Microsoft.CommerceServer.
	CampaignItemType	Specifies the type of campaign item.
	ConditionBasis	Specifies what the basis for a discount condition will be.
	CurrentEntityState	Specifies the current state of an entity when an EntityStateException is thrown.
	CustomerType	Specifies the type of customer: Advertiser, Agency or Self.
	DirectMailRecurrenceType	Specifies possible types of DirectMail schedule.
	DiscountType	Specifies how a Discount is applied.
	DisplayPropertyType	Specifies the type of display property.
	GenerationErrorCode	Specifies possible states of a promocode generation operation.
	ListOperationStatusCode	Specifies possible states of a MailingList operation.
	ListOperationType	Specifies possible types of a MailingList operation.
	MailingListErrorCode	Specifies possible errors of a Mailing List operation.
	MailingListStatusCode	Specifies possible status codes of a Mailing List.
	MessageFormat	Specifies possible formats of a DirectMail message.
	OfferType	Specifies the way that a price discount is awarded.
	PrioritizeOption	Specifies how prioritization of a discount should be performed, relative to existing discounts.
	PromoCodeGenerationErrorCode	Specifies possible promotion code import error codes.
	PromoCodeGenerationMethod	Specifies the different methods supported for promotion code generation.
	PromoCodeOperationStatusCode	Describes the status of a current or completed promotion code generation task.
	PromoCodePurgeOption	Specifies a purging criteria for promotion codes.
	PromoCodeUsageOption	Specifies the type of a promotion code definition.
	RecurrenceDays	Specifies the Day of Week flags that are used to setup a schedule.
	RecurrenceMonths	Specifies the Month flags that are used to setup a schedule.
	RecurrenceWeek	Specifies one week of a month that is used to setup a schedule.
	TargetAction	Specifies the action of an ExpressionTarget.
	TemplatePropertySource	Specifies where the value of the template property comes from during substitution.
	UrlEncodingType	Contains the options for encoding a URL.