Second-Generation Managed Packaging Developer Guide

Second-Generation Managed Packages
What’s a Second-Generation Managed Package?
Set Up Your Development Environment
Before You Create Second-Generation Managed Packages
Scratch Orgs and Package Development
Workflow for Second-Generation Managed Packages
Components Available in Second-Generation Managed Packages
Behavior of Specific Metadata in Second-Generation Managed Packages
Develop Second-Generation Managed Packages
Install and Uninstall Second-Generation Managed Packages
Prepare to Distribute Your Second-Generation Managed Package
Push a Package Upgrade for Second-Generation Managed Packages
Advanced Features for Second-Generation Managed Packages
Best Practices for Second-Generation Managed Packages
Manage Licenses for Managed Packages
Manage Features in Second-Generation Managed Packages
Get Started with AppExchange App Analytics
App Analytics Use Cases
Enable App Analytics on Your Second-Generation Managed Package
Download Package Usage Logs, Package Usage Summaries, and Subscriber Snapshots
Considerations for Custom Interactions
AppExchange App Analytics Best Practices
Package Usage Summaries
Package Usage Summary Schema
Package Usage Logs
Subscriber Snapshots
Test Custom Integrations
AppExchange App Analytics Developer Cookbook
Gaps Between First-Generation and Second-Generation Managed Packaging
PDF

Package Usage Summary Schema

Use the package usage summary to discover how many users access your package and which operations they perform.

Package usage summaries contain aggregate data derived from related package usage logs. ISV partners have access to package usage summaries by default, and they can activate access to package usage logs and subscriber snapshots. Subscribers only have access to package usage summaries.

Field Description
custom_entity The developer name of the component or custom object.
custom_entity_type The type of component or custom object that the user viewed or manipulated.

Examples:

  • AnalyticsDashboard
  • AnalyticsLens
  • ApexClass
  • ApexTrigger
  • CustomInteractionLabel
  • CustomInteractionFailure
  • CustomObject
  • ExternalObject
  • LightningPage
  • LightningComponent
  • VisualforcePage
managed_package_namespace Namespace of the package.
month The month that this usage summary applies to in YYYY-MM format. Example: 2019-03.
num_creates The number of new records created from the package.
num_deletes The number of deleted records associated with the package.
num_events The number of log records associated with a custom_entity.
num_reads The aggregate number of records associated with the custom_entity that was read.

The definition of num_reads changed with the Spring ’23 release. Some data from February 2023 and all data dated January 2023 and earlier used this previous num_reads definition: the aggregate number of records associated with the package that were read, plus the number of SOSL and SOQL queries performed on the entity.
num_updates The number of records associated with the package that were updated.
num_views The number of times the component or page has been viewed.
organization_edition The name of the Salesforce edition that the subscriber org is using.

Examples:

  • Developer Edition
  • Enterprise Edition
  • Unlimited Edition
organization_id The 15-character ID of the subscriber org.
organization_name The name of the subscriber org. Example: Acme, Inc.
organization_status The paid status of the subscriber org.

Examples:

  • Active
  • Demo
  • Free
  • Trial
package_id The ID of the package.
user_id_token The hashed token representing the ID of the user who accessed the package. The token persists over time, even if a user’s details change. The token also persists across any packages that the user interacts with.

The user ID token starts with the prefix 005-. In compliance with privacy regulations, our systems can’t access the actual user ID. Likewise, the hashed token can’t be linked to the user ID.
user_type The user license category of the user accessing Salesforce services through the UI or API.

Examples:

  • Guest
  • Partner
  • Standard