Skip to content

/AWS1/CL_PZEEVENT

Represents item interaction event information sent using the PutEvents API.

CONSTRUCTOR

IMPORTING

Required arguments:

iv_eventtype TYPE /AWS1/PZESTRINGTYPE /AWS1/PZESTRINGTYPE

The type of event, such as click or download. This property corresponds to the EVENT_TYPE field of your Item interactions dataset's schema and depends on the types of events you are tracking.

iv_sentat TYPE /AWS1/PZEDATE /AWS1/PZEDATE

The timestamp (in Unix time) on the client side when the event occurred.

Optional arguments:

iv_eventid TYPE /AWS1/PZESTRINGTYPE /AWS1/PZESTRINGTYPE

An ID associated with the event. If an event ID is not provided, Amazon Personalize generates a unique ID for the event. An event ID is not used as an input to the model. Amazon Personalize uses the event ID to distinguish unique events. Any subsequent events after the first with the same event ID are not used in model training.

iv_eventvalue TYPE /AWS1/RT_FLOAT_AS_STRING /AWS1/RT_FLOAT_AS_STRING

The event value that corresponds to the EVENT_VALUE field of the Item interactions schema.

iv_itemid TYPE /AWS1/PZEITEMID /AWS1/PZEITEMID

The item ID key that corresponds to the ITEM_ID field of the Item interactions dataset's schema.

iv_properties TYPE /AWS1/PZESYNTHJSONEVTPRPSJSON /AWS1/PZESYNTHJSONEVTPRPSJSON

A string map of event-specific data that you might choose to record. For example, if a user rates a movie on your site, other than movie ID (itemId) and rating (eventValue) , you might also send the number of movie ratings made by the user.

Each item in the map consists of a key-value pair. For example,

{"numberOfRatings": "12"}

The keys use camel case names that match the fields in the Item interactions dataset's schema. In the above example, the numberOfRatings would match the 'NUMBER_OF_RATINGS' field defined in the Item interactions dataset's schema.

The following can't be included as a keyword for properties (case insensitive).

  • userId

  • sessionId

  • eventType

  • timestamp

  • recommendationId

  • impression

iv_recommendationid TYPE /AWS1/PZERECOMMENDATIONID /AWS1/PZERECOMMENDATIONID

The ID of the list of recommendations that contains the item the user interacted with. Provide a recommendationId to have Amazon Personalize implicitly record the recommendations you show your user as impressions data. Or provide a recommendationId if you use a metric attribution to measure the impact of recommendations.

For more information on recording impressions data, see Recording impressions data. For more information on creating a metric attribution see Measuring impact of recommendations.

it_impression TYPE /AWS1/CL_PZEIMPRESSION_W=>TT_IMPRESSION TT_IMPRESSION

A list of item IDs that represents the sequence of items you have shown the user. For example, ["itemId1", "itemId2", "itemId3"]. Provide a list of items to manually record impressions data for an event. For more information on recording impressions data, see Recording impressions data.

io_metricattribution TYPE REF TO /AWS1/CL_PZEMETRICATTRIBUTION /AWS1/CL_PZEMETRICATTRIBUTION

Contains information about the metric attribution associated with an event. For more information about metric attributions, see Measuring impact of recommendations.

Queryable Attributes

eventId

An ID associated with the event. If an event ID is not provided, Amazon Personalize generates a unique ID for the event. An event ID is not used as an input to the model. Amazon Personalize uses the event ID to distinguish unique events. Any subsequent events after the first with the same event ID are not used in model training.

Accessible with the following methods

Method Description
GET_EVENTID() Getter for EVENTID, with configurable default
ASK_EVENTID() Getter for EVENTID w/ exceptions if field has no value
HAS_EVENTID() Determine if EVENTID has a value

eventType

The type of event, such as click or download. This property corresponds to the EVENT_TYPE field of your Item interactions dataset's schema and depends on the types of events you are tracking.

Accessible with the following methods

Method Description
GET_EVENTTYPE() Getter for EVENTTYPE, with configurable default
ASK_EVENTTYPE() Getter for EVENTTYPE w/ exceptions if field has no value
HAS_EVENTTYPE() Determine if EVENTTYPE has a value

eventValue

The event value that corresponds to the EVENT_VALUE field of the Item interactions schema.

Accessible with the following methods

Method Description
GET_EVENTVALUE() Getter for EVENTVALUE, with configurable default
ASK_EVENTVALUE() Getter for EVENTVALUE w/ exceptions if field has no value
STR_EVENTVALUE() String format for EVENTVALUE, with configurable default
HAS_EVENTVALUE() Determine if EVENTVALUE has a value

itemId

The item ID key that corresponds to the ITEM_ID field of the Item interactions dataset's schema.

Accessible with the following methods

Method Description
GET_ITEMID() Getter for ITEMID, with configurable default
ASK_ITEMID() Getter for ITEMID w/ exceptions if field has no value
HAS_ITEMID() Determine if ITEMID has a value

properties

A string map of event-specific data that you might choose to record. For example, if a user rates a movie on your site, other than movie ID (itemId) and rating (eventValue) , you might also send the number of movie ratings made by the user.

Each item in the map consists of a key-value pair. For example,

{"numberOfRatings": "12"}

The keys use camel case names that match the fields in the Item interactions dataset's schema. In the above example, the numberOfRatings would match the 'NUMBER_OF_RATINGS' field defined in the Item interactions dataset's schema.

The following can't be included as a keyword for properties (case insensitive).

  • userId

  • sessionId

  • eventType

  • timestamp

  • recommendationId

  • impression

Accessible with the following methods

Method Description
GET_PROPERTIES() Getter for PROPERTIES, with configurable default
ASK_PROPERTIES() Getter for PROPERTIES w/ exceptions if field has no value
HAS_PROPERTIES() Determine if PROPERTIES has a value

sentAt

The timestamp (in Unix time) on the client side when the event occurred.

Accessible with the following methods

Method Description
GET_SENTAT() Getter for SENTAT, with configurable default
ASK_SENTAT() Getter for SENTAT w/ exceptions if field has no value
HAS_SENTAT() Determine if SENTAT has a value

recommendationId

The ID of the list of recommendations that contains the item the user interacted with. Provide a recommendationId to have Amazon Personalize implicitly record the recommendations you show your user as impressions data. Or provide a recommendationId if you use a metric attribution to measure the impact of recommendations.

For more information on recording impressions data, see Recording impressions data. For more information on creating a metric attribution see Measuring impact of recommendations.

Accessible with the following methods

Method Description
GET_RECOMMENDATIONID() Getter for RECOMMENDATIONID, with configurable default
ASK_RECOMMENDATIONID() Getter for RECOMMENDATIONID w/ exceptions if field has no va
HAS_RECOMMENDATIONID() Determine if RECOMMENDATIONID has a value

impression

A list of item IDs that represents the sequence of items you have shown the user. For example, ["itemId1", "itemId2", "itemId3"]. Provide a list of items to manually record impressions data for an event. For more information on recording impressions data, see Recording impressions data.

Accessible with the following methods

Method Description
GET_IMPRESSION() Getter for IMPRESSION, with configurable default
ASK_IMPRESSION() Getter for IMPRESSION w/ exceptions if field has no value
HAS_IMPRESSION() Determine if IMPRESSION has a value

metricAttribution

Contains information about the metric attribution associated with an event. For more information about metric attributions, see Measuring impact of recommendations.

Accessible with the following methods

Method Description
GET_METRICATTRIBUTION() Getter for METRICATTRIBUTION

Public Local Types In This Class

Internal table types, representing arrays and maps of this class, are defined as local types:

TT_EVENTLIST

TYPES TT_EVENTLIST TYPE STANDARD TABLE OF REF TO /AWS1/CL_PZEEVENT WITH DEFAULT KEY
.