AnalyticsManager

Package: com.salesforce.marketingcloud.analytics

Type: interface

SDK Version: 11.0.0

Public facing interface for interacting with the Marketing Cloud SDK’s analytics features.

1abstract fun areAnalyticsEnabled(): Boolean

Indicates whether the ET analytics are enabled or disabled.

Returns: Boolean

1abstract fun arePiAnalyticsEnabled(): Boolean

Indicates whether the Pi analytics are enabled or disabled.

Returns: Boolean

1abstract fun disableAnalytics()

This method allows you to disable the collection of ET Analytics through the SDK.

1abstract fun disablePiAnalytics()

This method allows you to disable the collection of Pi Analytics through the SDK.

1abstract fun enableAnalytics()

This method allows you to activate the collection of ET Analytics through the SDK.

1abstract fun enablePiAnalytics()

This method allows you to activate the collection of Pi Analytics through the SDK.

1@Nullable
2abstract fun getPiIdentifier(): String

Returns the value set by setPiIdentifier.

Returns: String (nullable)

1abstract fun setPiIdentifier(
2    @Nullable @Size(min = 1) piIdentifier: String
3)

Set the Predictive Intelligence Identifier to be associated with your Predictive Intelligence analytics.

Parameters:

• piIdentifier: String (nullable, minimum size = 1)

1abstract fun trackCartContents(@NonNull cart: PiCart)

PI Analytics Convenience method to track a shopping cart.

Parameters:

• cart: PiCart (non-null)

1abstract fun trackCartConversion(@NonNull order: PiOrder)

PI Analytics Convenience method to track a purchase.

Parameters:

• order: PiOrder (non-null)

1abstract fun trackInboxOpenEvent(@NonNull message: InboxMessage)

Track the opening of an InboxMessage in ETAnalytics.

Parameters:

• message: InboxMessage (non-null)

1abstract fun trackPageView(@NonNull @Size(min = 1) url: String)
2
3abstract fun trackPageView(
4    @NonNull @Size(min = 1) url: String,
5    @Nullable title: String
6)
7
8abstract fun trackPageView(
9    @NonNull @Size(min = 1) url: String,
10    @Nullable title: String,
11    @Nullable item: String
12)
13
14abstract fun trackPageView(
15    @NonNull @Size(min = 1) url: String,
16    @Nullable title: String,
17    @Nullable item: String,
18    @Nullable searchTerms: String
19)

Track page views within your application

Parameters:

• url: String (non-null, minimum size = 1) - Required page URL
• title: String (nullable) - Optional page title
• item: String (nullable) - Optional item identifier
• searchTerms: String (nullable) - Optional search terms