Skip to content

Commit 4850f25

Browse files
stayseesongstayseesong
authored
Merge branch 'develop' into master
2 parents af326db + 7df61c1 commit 4850f25

File tree

22 files changed

+367
-44
lines changed

22 files changed

+367
-44
lines changed

‎src/api/public-api/index.md

Lines changed: 28 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ Learn more about [GitHub's secret scanning program](https://docs.github.com/en/d
4646
4747
You can authenticate and authorize the Public API using [OAuth 2.0](/docs/connections/oauth).
4848

49-
### Frequently asked questions
49+
## FAQs
5050
#### What should I do if I see a notification that my token was exposed?
5151
In most cases, identifying and revoking an exposed token takes seconds. Segment recommends you check the [audit trail](/docs/segment-app/iam/audit-trail/) to ensure no unauthorized actions were taken with the token.
5252

@@ -64,3 +64,30 @@ If you see a CORS error, this means you're attempting to make a request to the P
6464

6565
#### What User Role / Workspace permissions are required to generate Public API tokens?
6666
Only [users that have a `Workspace Owner` role](https://segment.com/docs/segment-app/iam/roles/#global-roles) can create Public API Tokens.
67+
68+
## Troubleshooting
69+
#### The `Update Schema Settings in Source` endpoint returns error for field `forwardingViolationsTo` and `forwardingBlockedEventsTo`
70+
When you don't have a source to forward violations or blocked events to, then exclude the fields `forwardingViolationsTo` or `forwardingBlockedEventsTo` entirely from the request and the setting will be disabled.
71+
72+
`PATCH` endpoint : `https://api.segmentapis.com/sources/{sourceId}/settings`
73+
```
74+
{
75+
"group": {
76+
"allowTraitsOnViolations": false,
77+
"allowUnplannedTraits": false,
78+
"commonEventOnViolations": "ALLOW"
79+
},
80+
"identify": {
81+
"allowTraitsOnViolations": true,
82+
"allowUnplannedTraits": true,
83+
"commonEventOnViolations": "Block"
84+
},
85+
"track": {
86+
"allowEventOnViolations": false,
87+
"allowPropertiesOnViolations": false,
88+
"allowUnplannedEventProperties": false,
89+
"allowUnplannedEvents": false,
90+
"commonEventOnViolations": "OMIT_PROPERTIES"
91+
}
92+
}
93+
```

‎src/connections/destinations/catalog/1flow-mobile-plugin/index.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -33,10 +33,10 @@ In the Xcode File menu, click Add Packages. You'll see a dialog where you can se
3333

3434
You'll then have the option to pin to a version, or specific branch, as well as which project in your workspace to add it to. Once you've made your selections, click the Add Package button.
3535

36-
### Step 2: Initialise Segment and Add 1Fow Destination
36+
### Step 2: Initialize Segment and add 1Fow Destination
3737

3838
```
39-
import Segment1Flow
39+
import Segment1Flow
4040
...
4141
let config = Configuration(writeKey: "YOUR_WRITE_KEY_HERE")
4242
let analytics = Analytics(configuration: config)
@@ -45,7 +45,7 @@ analytics.add(plugin: OneFlowDestination())
4545

4646
## Android
4747

48-
### Step 1: Install 1Flow-Segment-Tool
48+
### Step 1: Install Segment1Flow Package
4949

5050
- If gradle version is 6.5 or lower, include the below repository in your project's build.gradle file:
5151

‎src/connections/destinations/catalog/actions-google-analytics-4-web/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ The automatically collected and enhanced measurement events include parameters b
4848

4949
Google Analytics 4 does not accept custom event names that include spaces. Segment replaces spaces in the Event Name in the Custom Event action with an underscore. As a result, you will see custom events snake cased in Google Analytics 4.
5050

51-
Google Analytics 4 is also case sensitive. If you would like all event names to be lowercase, use the `Lowercase Event Name` setting in the Custom Event action. If this setting is disabled, Google will treat event names with different casing as distinct events. For more information, see [Google Analytics 4 Event name rules](https://support.google.com/analytics/answer/13316687?hl=en&ref_topic=13367860&sjid=2167389739796023681-NA#zippy=%2Cweb){:target="_blank"}.
51+
Event names are case-sensitive in Google Analytics 4. If you would like all event names to be lowercase, use the **Lowercase Event Name** setting when you create a Custom Event mapping and select `Yes` from the dropdown. If this setting is set to `No` (`false`), Google treats event names with different casing as distinct events. For more information, see [Google Analytics 4 Event name rules](https://support.google.com/analytics/answer/13316687?hl=en&ref_topic=13367860&sjid=2167389739796023681-NA#zippy=%2Cweb){:target="_blank"}.
5252

5353
### Custom Dimensions and Metrics
5454

‎src/connections/destinations/catalog/actions-pushwoosh/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1+
---
12
title: Pushwoosh (Actions) Destination
23
id: 64e72af1eabf77368b877a51
3-
private: true
44
beta: true
55
---
66

‎src/connections/sources/catalog/cloud-apps/livelike-source/index.md

Lines changed: 133 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,134 @@
11
---
2-
title: 'LiveLike (Source) Source'
3-
hidden: true
4-
---
2+
title: LiveLike Source
3+
id: EjYD7n6dOa
4+
---
5+
6+
[LiveLike](https://livelike.com/){:target="_blank"} is a technology company dedicated to empowering digital experiences that enable deeper fan engagement, increased retention rates, and new monetization opportunities.
7+
8+
This integration will enable you to receive related engagement and achievements from LiveLike into your Segment warehouse, which can enable and enhance your automated marketing tacics and capabilities as well as augment your analytics and first-party data for your users.
9+
10+
This source is maintained by LiveLike. For any issues with the source, [contact the LiveLike Support team](mailto:[email protected]).
11+
12+
## Getting started
13+
14+
1. From your workspace's [Sources catalog page](https://app.segment.com/goto-my-workspace/sources/catalog){:target="_blank"} click **Add Source**.
15+
2. Search for *LiveLike* in the Sources Catalog. Select **LiveLike**, and click **Add Source**.
16+
3. Give the Source a name and configure any other settings.
17+
18+
- The name is used as a label in the Segment app, and Segment creates a related schema name in your warehouse. The name can be anything, but Segment recommends using something that reflects the source itself and distinguishes amongst your environments (for example, LiveLike_Prod, LiveLike_Staging, LiveLike_Dev).
19+
20+
4. Click **Add Source** to save your settings.
21+
5. Copy the **Write Key** from the Segment UI.
22+
6. Provide the write Key to your LiveLike Account Manager so that LiveLike staff can input that write key into the platform to complete the process and enable the integration.
23+
24+
## Stream
25+
26+
LiveLike uses Segment's stream Source component to send Segment event data. It uses a server-side `track` method(s) to send data to Segment. These events are then available in any destination that accepts server-side events, and available in a schema in your data warehouse, so you can query using SQL.
27+
28+
The default behavior is for LiveLike to pass the userId associated with the event, which usually is your already-known userId, as well as a LiveLike User Profile ID as livelike_profile_id inside the Properties object within the Track event payload.
29+
30+
## Events
31+
32+
The table below lists events that LiveLike sends to Segment. These events appear as tables in your warehouse, and as regular events in other Destinations. LiveLike includes the `userId` if available.
33+
34+
| Event Name | Description |
35+
| ------------------ | ------------------------------------- |
36+
| Badge Rewarded | When a user receives a badge. |
37+
| Quest Task Completed | When a user completes a Quest Task. |
38+
| Quest Reward Awarded | When a user receives a Reward Item via a Quest Completion. |
39+
| Reward Item Rewarded | When a user is rewarded via a Reward Table. |
40+
| User Quest Task Progressed | When a user progresses a Quest Task. |
41+
| User Quest Completed | When a user completes a Quest. |
42+
43+
## Event Properties for Badge Rewarded
44+
45+
The table below lists the properties included in Badge Rewarded event.
46+
47+
| Property Name | Description |
48+
| --------------- | ------------------------- |
49+
| `livelike_profile_id` | The profile ID of the LiveLike user. |
50+
| `badge_id` | The ID of the specific Badge the user earned. |
51+
| `badge_title` | The title of the specific Badge the user earned. |
52+
| `description` | The description of the specific Badge the user earned. |
53+
| `earned_badge_id` | The ID of the specific transaction of the user earning the Badge. |
54+
| `image_url` | The URL of the Badge image. |
55+
| `reward_item_id` | The ID of the Reward Item that's associated to the threshold to earn the Badge. |
56+
| `reward_item_name` | The name of the Reward Item that's associated to the threshold to earn the Badge. |
57+
| `reward_item_threshold` | The threshold amount of the Reward Item that's associated to earning the Badge. |
58+
59+
## Event Properties for Quest Task Completed
60+
61+
The table below lists the properties included in the Quest Task Completed event.
62+
63+
| Property Name | Description |
64+
| --------------- | ------------------------- |
65+
| `livelike_profile_id` | The profile ID of the LiveLike user. |
66+
| `quest_id` | The ID of the Quest. |
67+
| `quest_name` | The name of the Quest. |
68+
| `quest_task_id` | The ID of the specific Task within the Quest that was completed. |
69+
| `quest_task_name` | The name of the specific Task within the Quest that was completed. |
70+
| `user_quest_id` | The ID of the specific relationship between the User and that Quest. |
71+
| `user_quest_task_id` | The ID of the specific relationship between the User and that Quest Task. |
72+
73+
## Event Properties for Quest Reward Awarded
74+
75+
The table below lists the properties included in the Quest Reward Awarded event.
76+
77+
| Property Name | Description |
78+
| --------------- | ------------------------- |
79+
| `livelike_profile_id` | The profile ID of the LiveLike user. |
80+
| `quest_id` | The ID of the Quest the user completed to earn Rewards (if applicable). |
81+
| `quest_name` | The name of the Quest the user completed to earn Rewards (if applicable). |
82+
| `reward_item_name` | The name of the Reward Item that was rewarded. |
83+
| `reward_item_amount` | The amount of the Reward Item that was rewarded. |
84+
| `reward_item_balance` | The new balance of the Reward Item for the user. |
85+
| `reward_item_id` | The ID of the Reward Item that was rewarded. |
86+
| `reward_item_transaction_id` | The ID of the transaction of the User being rewarded. |
87+
88+
## Event Properties for Reward Item Rewarded
89+
90+
The table below lists the properties included in the Reward Item Rewarded event.
91+
92+
| Property Name | Description |
93+
| --------------- | ------------------------- |
94+
| `livelike_profile_id` | The profile ID of the LiveLike user. |
95+
| `reward_item_name` | The name of the Reward Item that was rewarded. |
96+
| `reward_item_amount` | The amount of the Reward Item that was rewarded. |
97+
| `reward_item_balance` | The new balance of the Reward Item for the user. |
98+
| `reward_item_id` | The ID of the Reward Item that was rewarded. |
99+
| `reward_item_transaction_id` | The ID of the transaction of the User being rewarded. |
100+
101+
## Event Properties for User Quest Task Progressed
102+
103+
The table below lists the properties included in the User Quest Task Progressed event.
104+
105+
| Property Name | Description |
106+
| --------------- | ------------------------- |
107+
| `livelike_profile_id` | The profile ID of the LiveLike user. |
108+
| `quest_id` | The ID of the Quest. |
109+
| `quest_name` | The name of the Quest. |
110+
| `quest_task_id` | The ID of the specific Task within the Quest that was completed. |
111+
| `quest_task_name` | The name of the specific Task within the Quest that was completed. |
112+
| `quest_task_target_value` | The target number of times this Task needs to be done to complete the Task. |
113+
| `user_quest_id` | The ID of the specific relationship between the User and that Quest. |
114+
| `user_quest_task_id` | The ID of the specific relationship between the User and that Quest Task. |
115+
| `user_quest_task_progress` | The number of times this Task has been done so far. |
116+
117+
## Event Properties for User Quest Completed
118+
119+
The table below lists the properties included in the User Quest Completed event.
120+
121+
| Property Name | Description |
122+
| --------------- | ------------------------- |
123+
| `livelike_profile_id` | The profile ID of the LiveLike user. |
124+
| `quest_id` | The ID of the Quest. |
125+
| `quest_name` | The name of the Quest. |
126+
| `user_quest_id` | The ID of the specific relationship between the User and that Quest. |
127+
128+
## Adding Destinations
129+
130+
Once your Source is set up, you can connect it with Destinations.
131+
132+
Log in to your downstream tools and check to see that your events appear as expected, and that they contain all of the properties you expect. If your events and properties don’t appear, check the [Event Delivery](/docs/connections/event-delivery/) tool, and refer to the Destination docs for each tool for troubleshooting.
133+
134+
If there are any issues with how the events arrive to Segment, [contact the LiveLike support team](mailto:[email protected]).

‎src/connections/sources/catalog/cloud-apps/livelike/index.md

Lines changed: 0 additions & 4 deletions
This file was deleted.

‎src/connections/sources/catalog/libraries/website/javascript/cookie-validity-update.md

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -164,13 +164,19 @@ The `storage` property accepts an array of supported storage names (`localStorag
164164
```js
165165
analytics.load('writeKey', {
166166
// Global Storage Priority: Both User and Group data
167-
storage: ['cookie', 'localStorage', 'memory']
167+
storage: {
168+
stores: ['cookie', 'localStorage', 'memory']
169+
},
168170
// Specific Storage Priority
169171
user: {
170-
storage: ['cookie', 'localStorage', 'memory']
172+
storage: {
173+
stores: ['cookie', 'localStorage', 'memory']
174+
}
171175
},
172176
group: {
173-
storage: ['cookie', 'localStorage', 'memory']
177+
storage: {
178+
stores: ['cookie', 'localStorage', 'memory']
179+
}
174180
},
175181
}
176182
```

‎src/engage/audiences/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ You can also specify two different types of time-windows, `within` and `in betwe
3333

3434
### Custom Traits
3535

36-
You can also build Audiences based on custom traits. These traits can be collected from your apps when a user completes a form or signs up using an [Identify](/docs/connections/spec/identify) call. You can view these traits in the Profile explorer, as well.
36+
You can also build Audiences based on custom traits. These traits can be collected from your apps when a user completes a form or signs up using an [Identify](/docs/connections/spec/identify) call. You can view these traits in the Profile explorer, as well. Custom Traits are mutable and update to the latest value seen by the user's Identify events.
3737

3838
### Computed Traits
3939

‎src/engage/campaigns/broadcasts.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,8 +24,7 @@ Follow these steps to create an email broadcast:
2424
- To send a message to a pre-built audience, choose `Part of an Audience`, then select the audience.
2525
- To exclude users from the audience, click **Add condition** in the **And who** section. Click **And who**, then select **And not who**. Segment will exclude users from the audience you choose.
2626
5. Click **Preview** to estimate the audience size.
27-
6. Select the subscription group that you want to receive your broadcast.
28-
- Segment recommends only sending broadcasts to users with a `subscribed` status.
27+
6. Select the [subscription group](/docs/engage/user-subscriptions/subscription-groups/) that you want to receive your broadcast.
2928
7. Select **Build**, then choose either **Build a new email** or select a template.
3029
8. Fill out the **Email settings** fields, choose your email editor, then click **Continue**.
3130
9. Configure your email, then click **Continue**.

‎src/engage/campaigns/email-campaigns.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ Follow these steps to create an email campaign:
4343
2. From the **Select a Step** window, click **Send an email**.
4444
3. In the **Send Email** window, select **Build a new email** or [Use a template](/docs/engage/content/email/template/) to choose an existing email template.
4545
4. Build or edit your design, then click **Save Email**.
46-
5. Fill out all **Send Email** fields relevant to your campaign, then click **Save**.
46+
5. Fill out all **Send Email** fields relevant to your campaign, select the [subscription states or groups](/docs/engage/user-subscriptions/subscription-groups/) that you want to receive your email, then click **Save**.
4747

4848
Some email campaign fields, like **Sender email** and **Subject**, are required. The Send Email window indicates required fields with an asterisk. Refer to the [email campaign fields](/docs/engage/campaigns/email-campaigns/#email-campaign-fields) table for a full description of available email fields.
4949

‎src/engage/content/email/editor.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -118,6 +118,10 @@ Add an unsubscribe link to text:
118118

119119
You can alternatively add a [predefined unsubscribe](#add-blank-columns-or-predefined-content-blocks) link content block.
120120

121+
## Add a manage preference link
122+
123+
Engage also adds a manage preference link to templates. The manage preference link lets your customers opt in and out of email groups on an individual basis instead of unsubscribing from all your campaigns. For more information, see [subscription groups](/docs/engage/user-subscriptions/subscription-groups/).
124+
121125
## Personalize with merge tags
122126
Add merge tags in the Drag and Drop Editor to personalize your message with user profile traits.
123127

0 commit comments

Comments
 (0)