Click or drag to resize

Campaign Class

Container for campaign activities and responses, sales literature, products, and lists to create, plan, execute, and track the results of a specific marketing campaign through its life.
Inheritance Hierarchy
SystemObject
  Entity
    Crm.MSCrmServiceCampaign

Namespace: Crm.MSCrmService
Assembly: Scripting (in Scripting.dll) Version: 1.0.0.0 (1.0.0.0)
Syntax
public class Campaign : Entity, INotifyPropertyChanging, 
	INotifyPropertyChanged

The Campaign type exposes the following members.

Constructors
 NameDescription
Public methodCampaign Default Constructor.
Top
Properties
 NameDescription
Public propertyActualEnd Enter the date when the campaign was closed or completed.
Public propertyActualStart Enter the actual start date and time for the campaign.
Public propertyAttributes
(Inherited from Entity)
Public propertyBudgetedCost Type the amount budgeted for the campaign to define a limit for how much you can spend.
Public propertyBudgetedCost_Base Shows the Budget Allocated field converted to the system's default base currency. The calculations use the exchange rate specified in the Currencies area.
Public propertyBusinessUnit_Campaigns N:1 BusinessUnit_Campaigns
Public propertycampaign_activity_parties 1:N campaign_activity_parties
Public propertyCampaign_ActivityPointers 1:N Campaign_ActivityPointers
Public propertyCampaign_Annotation 1:N Campaign_Annotation
Public propertyCampaign_Appointments 1:N Campaign_Appointments
Public propertyCampaign_AsyncOperations 1:N Campaign_AsyncOperations
Public propertyCampaign_BulkDeleteFailures 1:N Campaign_BulkDeleteFailures
Public propertyCampaign_CampaignActivities 1:N Campaign_CampaignActivities
Public propertyCampaign_CampaignResponses 1:N Campaign_CampaignResponses
Public propertycampaign_connections1 1:N campaign_connections1
Public propertycampaign_connections2 1:N campaign_connections2
Public propertyCampaign_DuplicateBaseRecord 1:N Campaign_DuplicateBaseRecord
Public propertyCampaign_DuplicateMatchingRecord 1:N Campaign_DuplicateMatchingRecord
Public propertyCampaign_Emails 1:N Campaign_Emails
Public propertyCampaign_Faxes 1:N Campaign_Faxes
Public propertycampaign_leads 1:N campaign_leads
Public propertyCampaign_Letters 1:N Campaign_Letters
Public propertyCampaign_MailboxTrackingFolder 1:N Campaign_MailboxTrackingFolder
Public propertycampaign_opportunities 1:N campaign_opportunities
Public propertycampaign_orders 1:N campaign_orders
Public propertyCampaign_Phonecalls 1:N Campaign_Phonecalls
Public propertycampaign_principalobjectattributeaccess 1:N campaign_principalobjectattributeaccess
Public propertyCampaign_ProcessSessions 1:N Campaign_ProcessSessions
Public propertycampaign_quotes 1:N campaign_quotes
Public propertyCampaign_RecurringAppointmentMasters 1:N Campaign_RecurringAppointmentMasters
Public propertyCampaign_ServiceAppointments 1:N Campaign_ServiceAppointments
Public propertyCampaign_SyncErrors 1:N Campaign_SyncErrors
Public propertyCampaign_Tasks 1:N Campaign_Tasks
Public propertyCampaignId Unique identifier of the campaign.
Public propertycampaignlist_association N:N campaignlist_association
Public propertycampaignproduct_association N:N campaignproduct_association
Public propertycampaignsalesliterature_association N:N campaignsalesliterature_association
Public propertyCodeName Type a number or other tracking code to identify the campaign. If no value is entered, a code will be generated automatically.
Public propertyCreatedBy Shows who created the record.
Public propertyCreatedOn Shows the date and time when the record was created. The date and time are displayed in the time zone selected in Microsoft Dynamics CRM options.
Public propertyCreatedOnBehalfBy Shows who created the record on behalf of another user.
Public propertyDescription Type additional information to describe the campaign, such as the products or services offered or the targeted audience.
Public propertyEntityImage The default image for the entity.
Public propertyEntityImage_Timestamp 
Public propertyEntityImage_URL 
Public propertyEntityImageId For internal use only.
Public propertyEntityState
(Inherited from Entity)
Public propertyExchangeRate Shows the conversion rate of the record's currency. The exchange rate is used to convert all money fields in the record from the local currency to the system's default currency.
Public propertyExpectedResponse Type the expected response rate for the campaign as a full number between 0 and 100.
Public propertyExpectedRevenue Type the expected revenue for the campaign for return on investment projections and post-campaign reporting.
Public propertyExpectedRevenue_Base Shows the estimated revenue converted to the system's default base currency. The calculations use the exchange rate specified in the Currencies area.
Public propertyExtensionData
(Inherited from Entity)
Public propertyFormattedValues
(Inherited from Entity)
Public propertyHasLazyFileAttribute
(Inherited from Entity)
Public propertyId
(Overrides Entity.Id)
Public propertyImportSequenceNumber Unique identifier of the data import or data migration that created this record.
Public propertyIsTemplate Select whether the campaign is a template that can be copied when you create future campaigns.
Public propertyItem
(Inherited from Entity)
Public propertyKeyAttributes
(Inherited from Entity)
Public propertyLazyFileAttributeKey
(Inherited from Entity)
Public propertyLazyFileAttributeValue
(Inherited from Entity)
Public propertyLazyFileSizeAttributeKey
(Inherited from Entity)
Public propertyLazyFileSizeAttributeValue
(Inherited from Entity)
Public propertylk_campaign_createdby N:1 lk_campaign_createdby
Public propertylk_campaign_createdonbehalfby N:1 lk_campaign_createdonbehalfby
Public propertylk_campaign_modifiedby N:1 lk_campaign_modifiedby
Public propertylk_campaign_modifiedonbehalfby N:1 lk_campaign_modifiedonbehalfby
Public propertyLogicalName
(Inherited from Entity)
Public propertyMessage Type the promotional message or marketing copy for the campaign.
Public propertyModifiedBy Shows who last updated the record.
Public propertyModifiedOn Shows the date and time when the record was last updated. The date and time are displayed in the time zone selected in Microsoft Dynamics CRM options.
Public propertyModifiedOnBehalfBy Shows who created the record on behalf of another user.
Public propertyName Type a name for the campaign so that it is identified correctly in lists.
Public propertyObjective Type the objective of the campaign, including products, services, discounts, and pricing.
Public propertyOtherCost Type the sum of any miscellaneous campaign costs not included in the campaign activities to make sure the actual cost of the campaign is calculated correctly.
Public propertyOtherCost_Base Shows the Miscellaneous Costs field converted to the system's default base currency for reporting purposes. The calculations use the exchange rate specified in the Currencies area.
Public propertyOverriddenCreatedOn Date and time that the record was migrated.
Public propertyOwnerId Enter the user or team who is assigned to manage the record. This field is updated every time the record is assigned to a different user.
Public propertyOwningBusinessUnit Shows the business unit that the record owner belongs to.
Public propertyOwningTeam Unique identifier of the team who owns the campaign.
Public propertyOwningUser Unique identifier of the user who owns the campaign.
Public propertyPriceList_Campaigns N:1 PriceList_Campaigns
Public propertyPriceListId Choose the price list associated with this item to make sure the products associated with the campaign are offered at the correct prices.
Public propertyProcessId Shows the ID of the process.
Public propertyprocessstage_campaigns N:1 processstage_campaigns
Public propertyPromotionCodeName Type a promotional code to track sales related to the campaign or allow customers to redeem a discount offer.
Public propertyProposedEnd Enter the date when the campaign is scheduled to end.
Public propertyProposedStart Enter the date when the campaign is scheduled to start.
Public propertyReferencedcampaigncampaign_association N:N campaigncampaign_association
Public propertyReferencingcampaigncampaign_association N:N campaigncampaign_association
Public propertyRelatedEntities
(Inherited from Entity)
Public propertyRowVersion
(Inherited from Entity)
Public propertyStageId Shows the ID of the stage.
Public propertyStateCode Shows the status of the campaign. By default, campaigns are active and can't be deactivated.
Public propertyStatusCode Select the campaign's status.
Public propertySystemUser_Campaigns N:1 SystemUser_Campaigns
Public propertyteam_Campaigns N:1 team_Campaigns
Public propertyTimeZoneRuleVersionNumber For internal use only.
Public propertyTotalActualCost Shows the sum of the amounts entered in the Total Cost of Campaign Activities and Miscellaneous Costs fields.
Public propertyTotalActualCost_Base Shows the Total Cost of Campaign field converted to the system's default base currency for reporting purposes. The calculations use the exchange rate specified in the Currencies area.
Public propertyTotalCampaignActivityActualCost Shows the sum of the values entered in the Actual Cost field on all campaign activities related to the campaign.
Public propertyTotalCampaignActivityActualCost_Base Shows the Total Cost of Campaign Activities field converted to the system's default base currency. The calculations use the exchange rate specified in the Currencies area.
Public propertytransactioncurrency_campaign N:1 transactioncurrency_campaign
Public propertyTransactionCurrencyId Choose the local currency for the record to make sure budgets are reported in the correct currency.
Public propertyTraversedPath For internal use only.
Public propertyTypeCode Select the type of the campaign.
Public propertyuserentityinstancedata_campaign 1:N userentityinstancedata_campaign
Public propertyUTCConversionTimeZoneCode Time zone code that was in use when the record was created.
Public propertyVersionNumber Version number of the campaign.
Top
Methods
 NameDescription
Public methodContains
(Inherited from Entity)
Public methodEqualsDetermines whether the specified object is equal to the current object.
(Inherited from Object)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object)
Public methodGetAttributeValue``1
(Inherited from Entity)
Protected methodGetFormattedAttributeValue
(Inherited from Entity)
Public methodGetHashCodeServes as the default hash function.
(Inherited from Object)
Protected methodGetRelatedEntities``1
(Inherited from Entity)
Protected methodGetRelatedEntity``1
(Inherited from Entity)
Public methodGetTypeGets the Type of the current instance.
(Inherited from Object)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object.
(Inherited from Object)
Protected methodSetAttributeValue
(Inherited from Entity)
Protected methodSetRelatedEntities``1
(Inherited from Entity)
Protected methodSetRelatedEntity``1
(Inherited from Entity)
Public methodToEntity``1
(Inherited from Entity)
Public methodToEntityReference
(Inherited from Entity)
Public methodToStringReturns a string that represents the current object.
(Inherited from Object)
Public methodTryGetAttributeValue``1
(Inherited from Entity)
Top
Events
Fields
See Also