forked from segmentio/analytics-java
-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
chore(release): v3.1.0
- Loading branch information
Showing
31 changed files
with
1,131 additions
and
1,241 deletions.
There are no files selected for viewing
This file was deleted.
Oops, something went wrong.
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
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
This file was deleted.
Oops, something went wrong.
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
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
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
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -2,56 +2,62 @@ | |
|
||
# What is RudderStack? | ||
|
||
[RudderStack](https://rudderstack.com/) is a **customer data pipeline** tool for collecting, routing and processing data from your websites, apps, cloud tools, and data warehouse. | ||
[RudderStack](https://rudderstack.com/) is a **customer data pipeline** tool for collecting, routing and processing data from | ||
your websites, apps, cloud tools, and data warehouse. | ||
|
||
## RudderStack's Java SDK | ||
|
||
RudderStack’s Java SDK allows you to track your customer event data from your Java code. Once enabled, the event requests hit the RudderStack servers. RudderStack then routes the events to the specified destination platforms as configured by you. | ||
RudderStack’s Java SDK allows you to track your customer event data from your Java code. Once enabled, the event requests hit | ||
the RudderStack servers. RudderStack then routes the events to the specified destination platforms as configured by you. | ||
|
||
For detailed documentation on the Java SDK, click [here](https://www.rudderstack.com/docs/sources/event-streams/sdks/rudderstack-java-sdk/). | ||
For detailed documentation on the Java SDK, | ||
click [here](https://www.rudderstack.com/docs/sources/event-streams/sdks/rudderstack-java-sdk/). | ||
|
||
## Getting Started with the RudderStack Java SDK | ||
|
||
*Add to `pom.xml`:* | ||
|
||
```xml | ||
|
||
<dependency> | ||
<groupId>com.rudderstack.sdk.java.analytics</groupId> | ||
<artifactId>analytics</artifactId> | ||
<version>3.0.0</version> | ||
<version>3.1.0</version> | ||
</dependency> | ||
|
||
``` | ||
|
||
*or if you're using Gradle:* | ||
|
||
```bash | ||
implementation 'com.rudderstack.sdk.java.analytics:analytics:3.0.0' | ||
implementation 'com.rudderstack.sdk.java.analytics:analytics:3.1.0' | ||
``` | ||
|
||
## Initializing ```RudderClient``` | ||
|
||
```java | ||
RudderAnalytics analytics = RudderAnalytics | ||
.builder("<WRITE_KEY>") | ||
.setDataPlaneUrl("<DATA_PLANE_URL>") | ||
.build(); | ||
RudderAnalytics analytics=RudderAnalytics | ||
.builder("<WRITE_KEY>") | ||
.setDataPlaneUrl("<DATA_PLANE_URL>") | ||
.build(); | ||
``` | ||
|
||
## Sending events | ||
|
||
```java | ||
Map<String, Object> map = new HashMap<>(); | ||
map.put("name", "John Marshal"); | ||
map.put("email", "[email protected]"); | ||
analytics.enqueue(IdentifyMessage.builder() | ||
Map<String, Object> map=new HashMap<>(); | ||
map.put("name","John Marshal"); | ||
map.put("email","[email protected]"); | ||
analytics.enqueue(IdentifyMessage.builder() | ||
.userId("6754ds7d9") | ||
.traits(map) | ||
); | ||
); | ||
``` | ||
|
||
For more information on the different types of events supported by the Java SDK, refer to our [docs](https://www.rudderstack.com/docs/sources/event-streams/sdks/rudderstack-java-sdk/). | ||
For more information on the different types of events supported by the Java SDK, refer to | ||
our [docs](https://www.rudderstack.com/docs/sources/event-streams/sdks/rudderstack-java-sdk/). | ||
|
||
## Contact Us | ||
|
||
If you come across any issues while configuring or using this SDK, feel free to start a conversation on our [Slack](https://resources.rudderstack.com/join-rudderstack-slack) channel. We will be happy to help you. | ||
If you come across any issues while configuring or using this SDK, feel free to start a conversation on | ||
our [Slack](https://resources.rudderstack.com/join-rudderstack-slack) channel. We will be happy to help you. |
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
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
Oops, something went wrong.