ViewCatalogEvent

An event to capture when a user views a catalog object.

  • Target: androidJvm
  • SDK Version: SFMC SDK v3.1.0 (Salesforce Marketing Cloud Unified SDK 11.0.0)

ViewCatalogEvent is a concrete implementation of CatalogEvent used to track when a user views a catalog object in your application. This event is part of the engagement tracking system in the Salesforce Marketing Cloud SDK.

References the catalog item associated with the event.

The Event category Name. Category contains list of allowed values.

Defines the priority level for this event.

The Event attributes for this event.

Returns: A map containing string keys and any-type values representing event attributes.

The name for the event. This value must match the Event Name used when creating the event in the Marketing Cloud UI for any action to result from tracking this event.

Returns: String representing the event name.

Represents various items that can be tracked (e.g., a product, a blog post, etc.).

Constructor:

Parameters:

  • type (String): A type name representing the catalog object. Required.
  • id (String): A unique id representing the catalog object. Required.
  • attributes (Map<String, Any>): A map of user-supplied values. Default: empty map.
  • relatedCatalogObjects (Map<String, List>): A map of related catalog objects. Default: empty map.

Other catalog event types that extend CatalogEvent:

  1. ViewCatalogDetailEvent - Tracks detailed catalog item views
  2. QuickViewCatalogEvent - Tracks quick preview interactions
  3. ShareCatalogEvent - Tracks catalog sharing actions
  4. ReviewCatalogEvent - Tracks review submissions
  5. CommentCatalogEvent - Tracks comment interactions
  6. FavoriteCatalogEvent - Tracks favoriting/bookmarking actions

This event is part of the engagement tracking system, allowing applications to monitor and report user interactions with catalog items in Marketing Cloud campaigns. Events are tracked using the EventManager after SDK initialization via SFMCSdk.configure.

  • The @JvmOverloads annotation on CatalogObject generates multiple constructor overloads for Java interoperability
  • All CatalogObject properties are immutable (val)
  • ViewCatalogEvent is a sealed class subtype, meaning it can only be extended within its own module
  • The event name used when tracking must match the Event Name configured in the Marketing Cloud UI for any action to trigger