Add engagement.init to third-part Analytics provider installation #549
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
markzegarelli
requested changes
Mar 7, 2025
| @@ -51,6 +51,24 @@ amplitude.add(engagementPlugin()); | |||
|
|
|||
| Using the Guides and Surveys standalone SDK with another analytics provider requires extra configuration to help map properties to Amplitude. This initialization code accepts parameters that define the user and any integrations. | |||
|
|
|||
| First, call `init` to initialize the SDK. After calling this function, it will be possible to acccess `window.engagement` and call the SDK functions: | |||
There was a problem hiding this comment.
Suggested change
| First, call `init` to initialize the SDK. After calling this function, it will be possible to acccess `window.engagement` and call the SDK functions: | |
| First, call `init` to initialize the SDK. After calling this function, you can access `window.engagement` and call the SDK functions: |
| @@ -51,6 +51,24 @@ amplitude.add(engagementPlugin()); | |||
|
|
|||
| Using the Guides and Surveys standalone SDK with another analytics provider requires extra configuration to help map properties to Amplitude. This initialization code accepts parameters that define the user and any integrations. | |||
|
|
|||
| First, call `init` to initialize the SDK. After calling this function, it will be possible to acccess `window.engagement` and call the SDK functions: | |||
|
|
|||
| | ------------------------ | ---------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | ||
| | `apiKey` | `string` | Required. API key of the Amplitude project you want to use. | | ||
| | `initOptions.serverZone` | `EU` or `US` | Optional. Sets the Amplitude server zone. Set this to EU for Amplitude projects created in EU data center. Default: `US` | | ||
| | `initOptions.logger` | [Logger interface](https://github.com/amplitude/Amplitude-TypeScript/blob/main/packages/analytics-types/src/logger.ts#L1-L8) | Optional. Sets a custom loggign provider class. Default: [Amplitude Logger](https://github.com/amplitude/Amplitude-TypeScript/blob/main/packages/analytics-core/src/logger.ts) | |
There was a problem hiding this comment.
Suggested change
| | `initOptions.logger` | [Logger interface](https://github.com/amplitude/Amplitude-TypeScript/blob/main/packages/analytics-types/src/logger.ts#L1-L8) | Optional. Sets a custom loggign provider class. Default: [Amplitude Logger](https://github.com/amplitude/Amplitude-TypeScript/blob/main/packages/analytics-core/src/logger.ts) | | |
| | `initOptions.logger` | [Logger interface](https://github.com/amplitude/Amplitude-TypeScript/blob/main/packages/analytics-types/src/logger.ts#L1-L8) | Optional. Sets a custom logging provider class. Default: [Amplitude Logger](https://github.com/amplitude/Amplitude-TypeScript/blob/main/packages/analytics-core/src/logger.ts) | |
| | `initOptions.logLevel` | `LogLevel.None` or `LogLevel.Error` or `LogLevel.Warn` or `LogLevel.Verbose` or `LogLevel.Debug`. | Optional. Sets the log level. Default: `LogLevel.Warn` | | ||
|
|
||
|
|
||
| However, Guides and Surveys will not be fully functional until you call `boot`: |
There was a problem hiding this comment.
Suggested change
| However, Guides and Surveys will not be fully functional until you call `boot`: | |
| However, Guides and Surveys isn't fully functional until you call `boot`: |
markzegarelli
approved these changes
Mar 7, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Context: https://amplitude.slack.com/archives/C08BLQDFT98/p1739877518424259
If you use Amplitude Analytics, we will call
initautomatically on plugin initialization. If youbootGuides and Surveys manually, you also need to callinitmanually. Before callinginit, the boot method will not even be available on the global.