Jaa

Commerce Foundation EventRecord

  • Artikkeli

Use this Commerce Server 2009 commerce entity to initiate a Commerce Server pipeline to record key campaign events, such as request, click, and download. This notifies Commerce Server of an event that should be recorded, whether it is related to advertisement goals or data analysis.

Model

This commerce entity can be modified, as required. This model, taken from the out-of-the-box site, is provided as an example.

<CommerceEntity name="EventRecord">
    <DisplayName value="Event Record"/>
    <Description value="Represents an advertising event that was observed at the presentation layer that should be recorded so that advertising goals can be measured."/>
    <Properties>
      <Property name="AdvertisementId" dataType="String">
        <DisplayName value="Advertisement Id"/>
        <Description value="The id of the advertisement that was the source of the event."/>
      </Property>
      <Property name="PageGroupId" dataType="Integer">
        <DisplayName value="Page Group Id"/>
        <Description value="The id of the page group on which the event was observed."/>
      </Property>
      <Property name="ContextName" dataType="String">
        <DisplayName value="Context Name"/>
        <Description value="The context in which the source advertisement was retreived.  This represents the name of the Commerce Server cache that contains the advertisement."/>
      </Property>
      <Property name="EventName" dataType="String">
        <DisplayName value="Event Name"/>
        <Description value="The name of the event that was observed."/>
      </Property>
    </Properties>
</CommerceEntity>

Properties

Property

Type

Description

AdvertisementId

String

ID of the content item that was the source of the event.

ContextName

String

Name of the Commerce Server cache containing the content item that was the source of the event.

EventName

String

Name of the event that occurred.

PageGroupId

int?

ID of the page group of the page that was the source of the event.

Relationships

None.

Supported Operations

The event record commerce entity supports the following operations:

Commerce Foundation EventRecord CommerceCreate

See Also

Other Resources

Developing with the Commerce Foundation Marketing System

Commerce Foundation EventRecord CommerceCreate