Skip to content

Commit

Permalink
Merge pull request #8147 from braze-inc/develop
Browse files Browse the repository at this point in the history
Deploy - September 24, 2024
  • Loading branch information
internetisaiah authored Sep 24, 2024
2 parents 8761b27 + 8d8dbd4 commit e435889
Show file tree
Hide file tree
Showing 29 changed files with 217 additions and 250 deletions.
140 changes: 83 additions & 57 deletions _docs/_api/identifier_types.md

Large diffs are not rendered by default.

Original file line number Diff line number Diff line change
Expand Up @@ -1637,7 +1637,7 @@ This event occurs when an SMS is sent to the carrier.
"canvas_variation_name": (optional, string) name of the Canvas variation the user is in if from a Canvas,
"canvas_step_id": (optional, string) ID of the step for this message if from a Canvas,
"canvas_step_name": (optional, string) name of the Canvas step this event belongs to,
"send_id": (optional, string) message send ID this message belongs to
"send_id": (optional, string) message send ID this message belongs to (SMS Sends events only)
}
```
{% endapi %}
Expand All @@ -1650,7 +1650,7 @@ This event occurs when an SMS is sent to the carrier.
SMS, Delivery
{% endapitags %}

This event occurs when an SMS was successfully delivered to the users mobile phone.
This event occurs when an SMS was successfully delivered to the user's mobile phone.

```json
// SMS Delivery: users.messages.sms.Delivery
Expand All @@ -1675,7 +1675,7 @@ This event occurs when an SMS was successfully delivered to the users mobile pho
"canvas_variation_name": (optional, string) name of the Canvas variation the user is in if from a Canvas,
"canvas_step_id": (optional, string) ID of the step for this message if from a Canvas,
"canvas_step_name": (optional, string) name of the Canvas step this event belongs to,
"send_id": (optional, string) message send ID this message belongs to
"send_id": (optional, string) message send ID this message belongs to (SMS Sends events only)
}
```
{% endapi %}
Expand Down Expand Up @@ -1715,7 +1715,7 @@ This event occurs when an SMS send gets rejected by the carrier, this can happen
"message_variation_name": (optional, string) the name of the message variation if from a campaign,
"canvas_step_id": (optional, string) ID of the step for this message if from a Canvas,
"canvas_step_name": (optional, string) name of the Canvas step this event belongs to,
"send_id": (optional, string) ID of the message if specified for the campaign (See Send Identifier under API Identifier Types)
"send_id": (optional, string) message send ID this message belongs to (SMS Sends events only)
}
```
{% endapi %}
Expand Down Expand Up @@ -1755,7 +1755,7 @@ This event occurs when an SMS experiences delivery failure. Use this event and t
"canvas_variation_name": (optional, string) name of the Canvas variation the user is in if from a Canvas,
"canvas_step_id": (optional, string) ID of the step for this message if from a Canvas,
"canvas_step_name": (optional, string) name of the Canvas step this event belongs to,
"send_id": (optional, string) message send ID this message belongs to
"send_id": (optional, string) message send ID this message belongs to (SMS Sends events only)
}
```
{% endapi %}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -161,7 +161,7 @@ Property values can be any of the following data types:
| Nested objects | Objects that are inside of other objects. For more, see the section in this article on [Nested objects](#nested-objects).
{: .reset-td-br-1 .reset-td-br-2}

Event property objects that contain array or object values can have an event property payload up to 50 KB.
Event property objects that contain array or object values can have an event property payload up to 100 KB.

You can change the data type of your custom event property, but be aware of the impacts of [changing data types]({{site.baseurl}}/help/help_articles/data/change_custom_data_type/) after data has been collected.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ You can use nested objects—objects that are inside of another object—to send
## Limitations

- Nested data is supported for both [custom events]({{site.baseurl}}/user_guide/data_and_analytics/custom_data/custom_events/) and [purchase events]({{site.baseurl}}/user_guide/data_and_analytics/custom_data/purchase_events/), but not other event types.
- Event property objects that contain array or object values can have an event property payload of up to 50 KB.
- Event property objects that contain array or object values can have an event property payload of up to 100 KB.
- Event property schemas cannot be generated for purchase events.
- Event property schemas are generated through sampling custom events from the last 24 hours.

Expand Down Expand Up @@ -172,7 +172,7 @@ There is no change in how we charge data points as a result of adding this capab

### How much nested data can be sent?

If one or more of the event's properties contains nested data, the maximum payload for all combined properties on an event is 50 KB. Any request over that size limit will be rejected.
If one or more of the event's properties contains nested data, the maximum payload for all combined properties on an event is 100 KB. Any request over that size limit will be rejected.

[4]: {% image_buster /assets/img_archive/nested_event_properties_segmentation.png %}
[5]: {% image_buster /assets/img_archive/nested_event_properties_personalization.png %}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -42,13 +42,16 @@ You will see the following segment statistics, which update in real-time as you

You can see how one segment is performing compared to another across a set of pre-selected KPIs by visiting the [Segment Insights]({{site.baseurl}}/user_guide/engagement_tools/segments/segment_insights/) page of your dashboard.

### Messaging use and historical membership
### Messaging use
The **Messaging Use** section shows which segments, currently enabled campaigns, and currently enabled canvases are targeting your segment.

The **Messaging Use** section shows which campaigns have targeted your segment, while the **Historical Membership** section shows how the size of your segment changed over time. Use the dropdown to filter segment membership by date range.
![Under Messaging Use, view the campaigns that your segment is being used in.][4]

### Historical membership
The **Historical Membership** section shows how the size of your segment changed over time. Use the dropdown to filter segment membership by date range.

The historical segment membership count is an estimate, similar to how the segment size is an estimate before you click **Calculate Exact Statistics**. Braze estimates the membership count by querying users in a random bucket range. This means that on one day, the membership count could be based on users with a random bucket number of 111–120, and on another day, users with a random bucket number of 8,452–8,455. Therefore, the graph might show slight fluctuations on each date due to different amounts of users landing within the random bucket ranges.

![Under Messaging Use, view the campaigns that your segment is being used in.][4]
![Use the Historical Membership dropdown to filter segment membership by date range.][10]

### User preview
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ guide_featured_list:
guide_menu_title: "Additional resources"
guide_menu_list:
- name: AI Copywriting Assistant
link: /docs/user_guide/intelligence/ai_copywriting/
link: /docs/user_guide/brazeai/generative_ai/ai_copywriting/
image: /assets/img/braze_icons/edit-05.svg

---
Original file line number Diff line number Diff line change
Expand Up @@ -65,13 +65,16 @@ For more information and best practices, refer to [Multivariate & A/B Testing][4

Braze provides detailed audience statistics of the targeted channels in the footer.

For campaigns, select **Calculate Exact Statistics** to determine an accurate number for your reachable users as this will search through every user in your user base. The number of reachable users may decrease if you use a [Global Control Group]({{site.baseurl}}/user_guide/engagement_tools/testing/global_control_group/) or set up message eligibility.
The larger your user base is, the more likely the **Reachable Users** amount is a rough estimate. The number of reachable users may decrease if you use a [Global Control Group]({{site.baseurl}}/user_guide/engagement_tools/testing/global_control_group/) or set up message eligibility. Select [Calculate exact statistics]({{site.baseurl}}/user_guide/engagement_tools/segments/creating_a_segment#calculating-exact-statistics) to determine an accurate number for your reachable users as this will search through every user in your user base.

For segments, the larger your user base is, the more likely the **Reachable Users** amount is a rough estimate. For more details, refer to [Calculating exact statistics]({{site.baseurl}}/user_guide/engagement_tools/segments/creating_a_segment#calculating-exact-statistics).
Note that:

- Calculating exact statistics can take a few minutes to run. This function only calculates the exact statistics at the segment level, not at the filter or filter group level.
- For large segments, it is normal to see slight variation even when calculating exact statistics. The accuracy of this feature is expected to be 99.999% or greater.

![][24]

In order to see what percentage of your user base is being targeted or the Lifetime Value (LTV) for this segment, click **Show Additional Stats** located after the statistics footer.
To see what percentage of your user base is being targeted or the Lifetime Value (LTV) for this segment, select **Show Additional Statistics**.

[1]: {{site.baseurl}}/user_guide/engagement_tools/campaigns/building_campaigns/creating_campaign/
[2]: {{site.baseurl}}/user_guide/engagement_tools/campaigns/building_campaigns/delivery_types/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,9 @@ description: "This reference article covers time-based functionalities for campa

> When using campaigns, you can use the time-based scheduling options to reach your audience. These time-based functionalities include campaigns that are set to scheduled delivery and action-based delivery.
You can also check out our [Campaign Setup](https://learning.braze.com/campaign-setup-delivery-targeting-conversions) Braze Learning course for more on campaign delivery.
{% alert tip %}
For more on campaign delivery, check out our dedicated [Campaign Setup](https://learning.braze.com/campaign-setup-delivery-targeting-conversions) Braze Learning course.
{% endalert %}

## Scheduled delivery

Expand Down Expand Up @@ -76,7 +78,7 @@ When choosing your delay length, keep in mind that if you set a delay that is lo

| Definition | Time Zone |
| ---------- | --------- |
| Send message after a delay. You can specify a delay in seconds, minutes, hours, days, or weeks. | N/A |
| Send message after a delay. You can specify a delay in seconds, minutes, hours, days, or weeks. For [in-app message campaigns]({{site.baseurl}}/user_guide/message_building_by_channel/in-app_messages/about), you can set a delay up to two hours only. | N/A |
{: .reset-td-br-1 .reset-td-br-2}

![Schedule Delay set to send campaign after one day after the trigger event occurs.][7]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,6 @@ guide_featured_list:
guide_menu_title: "Additional resources"
guide_menu_list:
- name: AI Copywriting Assistant
link: /docs/user_guide/intelligence/ai_copywriting/
link: /docs/user_guide/brazeai/generative_ai/ai_copywriting/
image: /assets/img/braze_icons/edit-05.svg
---
Original file line number Diff line number Diff line change
Expand Up @@ -150,7 +150,7 @@ After adding segments and filters to your target audience, you can test if your

![]({% image_buster /assets/img_archive/user_lookup.png %}){: style="max-width:50%;"}

#### Adjust entry controls
#### Selecting entry controls

Entry controls determine if users are allowed to re-enter a Canvas. You can also limit the number of people who would potentially enter this Canvas. For example, if you set the **Maximum users to potentially enter this Canvas** field to 1,000 users, and select the **Limit everytime the Canvas is scheduled** checkbox, then the Canvas will sent to 1,000 users per day.

Expand All @@ -162,6 +162,19 @@ Braze doesn't recommend using the **Limit everytime the Canvas is scheduled** fe

Setting the [exit criteria]({{site.baseurl}}/user_guide/engagement_tools/canvas/create_a_canvas/exit_criteria) determines which users you want to exit a Canvas. If a user performs the exception event or matches the segments and filters, they won't receive any further messages.

#### Calculating target population

In the **Target Population** section, you can view a summary of your audience, such as your selected segments and additional filters, and a breakdown of how many users are reachable per messaging channel. To calculate the exact number of reachable users in your target audience instead of the default estimation, select [Calculate exact statistics]({{site.baseurl}}/user_guide/engagement_tools/segments/creating_a_segment#calculating-exact-statistics).

Note that:

- Calculating exact statistics can take a few minutes to run. This function only calculates the exact statistics at the segment level, not at the filter or filter group level.
- For large segments, it is normal to see slight variation even when calculating exact statistics. The accuracy of this feature is expected to be 99.999% or greater.

To view additional statistics, such as the average lifetime revenue for targeted users, select **Show Additional Statistics**.

![Target Population breakdown with option to cacluate exact statistics.][2]

### Step 2d: Select your send settings

Select **Send Settings** to edit your subscription settings, turn on rate limiting, and to turn on Quiet Hours. By turning on [rate limiting][6b] or [frequency capping][6c], you can ease the marketing pressure placed on your users and ensure you aren't over messaging them.
Expand Down Expand Up @@ -327,7 +340,8 @@ Need to make edits to your Canvas after launch? Well, you can! Check out [Editin
{% endalert %}


[1]:{% image_buster /assets/img_archive/canvas_dropdown.png %}
[1]: {% image_buster /assets/img_archive/canvas_dropdown.png %}
[2]: {% image_buster /assets/img_archive/canvas_exact_stats.png %}
[3]: {% image_buster /assets/img_archive/choose_canvas_experience.png %}
[6b]: {{site.baseurl}}/user_guide/engagement_tools/campaigns/building_campaigns/rate-limiting/#rate-limiting-and-canvas-components
[6c]: {{site.baseurl}}/user_guide/engagement_tools/campaigns/building_campaigns/rate-limiting#frequency-capping
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ For a Message component in multi-channel messaging, we recommend the following:

You've launched your Canvas! Now, what? Use this checklist to see how you can review and adjust your Canvas in the event of discrepancies after launch based on these scenarios.

### Lots of entries, but few sends
### Many entries, but few sends

For example, let's say that you've noticed a disparity between your number of messages sent versus total entries. You can identify and uncover areas to adjust your Canvas by checking these key areas.

Expand All @@ -82,7 +82,7 @@ Review the distribution of users between your variants and your control group. I

### An empty total audience

If you're noticing that messages have been sent, but aren't seeing any entry data for your Canvas, the main reason that users may not be entering your Canvas can be due to race conditions and restrictive audience segmentation filters.
If you arent seeing any entry data for your Canvas, the reason that users may not be entering your Canvas can be due to race conditions and restrictive audience segmentation filters.

If you're using action-based entry in your entry schedule, check that you haven't used the same trigger action here as in your **Target Audience**. A race condition may occur in which the user is not in the audience at the time they perform the trigger event, which means they won't enter the Canvas.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,9 @@ You can edit these Canvas settings and information after a Canvas launches using
* Quiet Hours
* Target audience

You can't edit conversion events after a Canvas has launched.
After a Canvas has launched:
- Conversion events can't be edited.
- [Audience paths]({{site.baseurl}}/user_guide/engagement_tools/canvas/canvas_components/audience_paths/), [action paths]({{site.baseurl}}/user_guide/engagement_tools/canvas/canvas_components/action_paths/), and [experiment paths]({{site.baseurl}}/user_guide/engagement_tools/canvas/canvas_components/experiment_step) can't be added or removed to these steps and can't be reordered to adjust the ranking. As a workaround, edit the active Canvas and duplicate the step, which will be editable until you launch the draft.

### Individual steps

Expand Down Expand Up @@ -138,11 +140,11 @@ If you update the delay in a Delay step or evaluation window in the Action Paths

If you delete a step with a time delay (such as Delay or Action Paths) and decide to redirect those users into another Canvas step, the users will only be redirected after the step's time delay has completed. For example, let's say you delete a Delay step with a one day delay and redirect those users to a Message step. In this case, the users will only be redirected after the one day delay has been completed.

If your Canvas contains one or more [Experiment Paths]({{site.baseurl}}/user_guide/engagement_tools/canvas/canvas_components/experiment_step/) steps, deleting steps could invalidate the results of this step.
If your Canvas has one or more Experiment Paths steps, deleting steps could invalidate the results of this step.

### Stopping Canvases

Stopping a Canvas will not exit users who are waiting in a step. If you re-enable the Canvas and the users are still waiting, they will complete the step and move to the next step. However, if the time that the user should've progressed to the next step has passed, they will instead exit the Canvas.
Stopping a Canvas won't exit users who are waiting in a step. If you re-enable the Canvas and the users are still waiting, they will complete the step and move to the next step. However, if the time that the user should've progressed to the next step has passed, they will instead exit the Canvas.

For example, let's say you have a Canvas created using the Canvas Flow workflow set to launch at 2 pm with one variant with two steps: a Delay step with a one hour delay that goes into a Message step.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@ The media library acts as your dashboard's centralized location for assets, as a

## Generate an image using AI {#generate-ai}

You can generate images for your media library using [DALL·E 2](https://openai.com/dall-e-2/), an AI system from OpenAI, a Braze third-party provider. This system can create realistic images and art from a description in natural language. Each request generates four variations of your prompt, and your company can generate images 10 times per day. This total applies to all users in your company.
You can generate images for your media library using [DALL·E 3](https://openai.com/index/dall-e-3/), an AI system from OpenAI, a Braze third-party provider. This system can create realistic images and art from a description in natural language. Each request generates four variations of your prompt, and your company can generate images 10 times per day. This total applies to all users in your company.

1. From the media library, select <i class="fas fa-wand-magic-sparkles"></i> **AI Image Generator**.
2. Enter a description of the image you want to generate, up to 300 characters. The more detailed the description, the better your result.
Expand Down
Loading

0 comments on commit e435889

Please sign in to comment.