Skip to content

Commit

Permalink
Merge pull request #8189 from braze-inc/develop
Browse files Browse the repository at this point in the history
Deploy - October 1, 2024
  • Loading branch information
rachel-feinberg authored Oct 1, 2024
2 parents b3d50a5 + 08b0396 commit 673d530
Show file tree
Hide file tree
Showing 457 changed files with 6,030 additions and 4,796 deletions.
12 changes: 11 additions & 1 deletion .github/CODEOWNERS
Original file line number Diff line number Diff line change
Expand Up @@ -14,4 +14,14 @@

# Liquid use case library: Validate that new and updated use cases are tested before merging them in. Rachel will validate. Josh is added as code owner in case Rachel is out of office to avoid blockers.

/_docs/_user_guide/personalization_and_dynamic_content/liquid/liquid_use_cases.md @josh-mccrowell-braze @rachel-feinberg
/_docs/_user_guide/personalization_and_dynamic_content/liquid/liquid_use_cases.md @josh-mccrowell-braze @rachel-feinberg

# Ingestion Endpoints: Ingestion owns Data Transformation templates for the following endpoints. They are added as codeowners so they can watch for changes to these endpoints. So their codeownership doesn't block style changes to the docs, Lydia is added as a codeowner as the primary API tech writer. In case she's out, the rest of the Docs Team is also added so that changes are not inappropriately blocked.

/_docs/_api/endpoints/user_data/post_user_track.md @braze-inc/ingestion @lydia-xie @braze-inc/docs-team
/_docs/_api/endpoints/messaging/send_messages/post_send_messages.md @braze-inc/ingestion @lydia-xie @braze-inc/docs-team
/_docs/_api/endpoints/catalogs/catalog_items/synchronous/delete_catalog_item.md @braze-inc/ingestion @lydia-xie @braze-inc/docs-team
/_docs/_api/endpoints/catalogs/catalog_items/synchronous/put_update_catalog_item.md @braze-inc/ingestion @lydia-xie @braze-inc/docs-team
/_docs/_api/endpoints/catalogs/catalog_items/synchronous/patch_catalog_item.md @braze-inc/ingestion @lydia-xie @braze-inc/docs-team
/_docs/_api/endpoints/messaging/send_messages/post_send_triggered_campaigns.md @braze-inc/ingestion @lydia-xie @braze-inc/docs-team
/_docs/_api/endpoints/messaging/send_messages/post_send_triggered_canvases.md @braze-inc/ingestion @lydia-xie @braze-inc/docs-team
2 changes: 1 addition & 1 deletion _docs/_api/endpoints/user_data/post_user_track.md
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@ curl --location --request POST 'https://rest.iad-01.braze.com/users/track' \
"email": "test@braze.com",
"string_attribute": "fruit",
"boolean_attribute_1": true,
"integer_attribute": 25,
"integer_attribute": 26,
"array_attribute": [
"banana",
"apple"
Expand Down
2 changes: 2 additions & 0 deletions _docs/_api/objects_filters/messaging/android_object.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@ You must include an Android push object in `messages` if you want users you have
"message_variation_id": (optional, string) used when providing a campaign_id to specify which message variation this message should be tracked under (must be an Android Push Message),
"notification_channel_id": (optional, string) the channel ID the notification will be sent with,
"priority": (optional, integer) the notification priority value,
"android_priority": (optional, string) the FCM sender priority,
"send_to_sync": (optional, if set to true we will throw an error if "alert" or "title" is set),
"collapse_key": (optional, string) the collapse key for this message,
// Specifying "default" in the sound field will play the standard notification sound
Expand All @@ -47,6 +48,7 @@ You can send "Big Picture" notifications by specifying the key `appboy_image_url
| Parameter | Details |
| --------- | ------- |
| `priority` | This parameter will accept values from `-2` to `2`, where `-2` represents "MIN" priority and `2` represents "MAX". `0` is the "DEFAULT" value. <br> <br> Any values sent outside of that range will default to 0. For more information on which priority level to use, see [Android notification priority]({{site.baseurl}}/developer_guide/platform_integration_guides/android/push_notifications/android/customization/advanced_settings#notification-priority). |
| `android_priority` | This parameter will accept values either "normal" or "high" to specify the FCM sender priority. By default, notification messages are sent with high priority, and data messages are sent with normal priority.<br><br> For more information on how different values impact delivery, see [Android message priority](https://firebase.google.com/docs/cloud-messaging/android/message-priority). |
| `collapse_key` | FCM can simultaneously store only up to four collapse keys per device. If you use more than four collapse keys, FCM does not make any guarantees as to which ones will be kept. Braze uses one of these by default for campaigns, so make sure to specify only up to three additional collapse keys for Android messages. |
| `push_icon_image_url` | The value for the large icon parameter should be a URL that links to where your image is hosted. <br> <br> Images need to be cropped to a 1:1 aspect ratio and should be at least 40x40. |
| `notification_channel` | If this is not specified, Braze will attempt to send the notification payload with the [dashboard fallback][45] channel ID. For more, see [Notification channels][44] and refer to the steps for [defining notification channels][43] during integration. |
Expand Down
70 changes: 70 additions & 0 deletions _docs/_developer_guide/platform_wide/debugging.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,70 @@
---
nav_title: SDK Debugging
article_title: Debugging the Braze SDK
description: "Learn how to use the Braze SDK debugger, so you can troubleshoot issues for your SDK-powered channels, without enabling verbose logging in your app manually."
page_order: 3
---

# Debugging the Braze SDK

> Learn how to use the Braze SDK's built-in debugger, so you can troubleshoot issues for your SDK-powered channels, without needing to enable verbose logging in your app.
{% alert important %}
Currently, this feature is only available for native iOS and Android apps. To enable debugging for the Braze Web SDK, you can [use a URL parameter]({{site.baseurl}}/developer_guide/platform_integration_guides/web/initial_sdk_setup/#logging) instead.
{% endalert %}

## Prerequisites

To use the Braze SDK debugger, ensure your SDKs are up to date with at least these minimum versions:

{% sdk_min_versions swift:10.2.0 android:32.1.0 %}

## Debugging the Braze SDK

### Step 1: Close your app

Before you start your debugging session, close the app that's currently experiencing issues. You can relaunch the app at the start of your session.

### Step 2: Create a debugging session

In Braze, go to **Settings**, then under **Setup and Testing**, select **SDK Debugger**.

![The "Setup and Testing" section with "SDK Debugger" highlighted.]({% image_buster /assets/img/sdk_debugger/select_sdk_debugger.png %})

Select **Create debugging session**.

![The "SDK Debugger" page.]({% image_buster /assets/img/sdk_debugger/select_create_debugging_session.png %})

### Step 3: Select a user

Search for a user using their email address, `external_id`, user alias, or push token. When you're ready to start your session, select **Select User**.

![The debugging page for the selected user.]({% image_buster /assets/img/sdk_debugger/search_and_select_user.png %}){: style="max-width:85%;"}

### Step 4: Relaunch the app

First, launch the app and confirm that your device is paired. If the pairing is successful, relaunch your app&#8212;this will ensure that app's initialization logs are fully captured.

### Step 5: Complete the reproduction steps

After relaunching your app, follow the steps to reproduce the error.

{% alert tip %}
When you're reproducing the error, be sure to follow the reproduction steps as closely as possible, so you can create [quality logs](#step-6-export-your-session-logs-optional).
{% endalert %}

### Step 6: End your session

When you're finished with your reproduction steps, select **End Session** > **Close**.

![The debugging session showing the "End Session" button.]({% image_buster /assets/img/sdk_debugger/close_debugging_session.png %}){: style="max-width:85%;"}

{% alert note %}
It may take a few minutes to generate your logs depending on your session length and network connectivity.
{% endalert %}

### Step 7: Share or export your session (optional)

After your session, you can export your session logs as a CSV file. Additionally, others can use your **Session ID** to search for your debug session, so you don't need to send them your logs directly.

![The debugging page with "Export Logs" and "Copy Session ID" shown after the session.]({% image_buster /assets/img/sdk_debugger/copy_id_and_export_logs.png %})
2 changes: 1 addition & 1 deletion _docs/_developer_guide/platform_wide/feature_flags.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
nav_title: Feature Flags
article_title: Feature Flags
page_order: 8
page_order: 4
layout: dev_guide
guide_top_header: "Feature Flags"
guide_top_text: "Feature flags allow you to remotely enable or disable functionality for a selection of users. Importantly, they let you turn a feature on and off in production without additional code deployment or app store updates. This allows you to safely roll out new features with confidence."
Expand Down
2 changes: 1 addition & 1 deletion _docs/_developer_guide/platform_wide/getting_started.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
page_order: 1
page_order: 0
nav_title: Getting Started
article_title: Getting Started
layout: dev_guide
Expand Down
2 changes: 1 addition & 1 deletion _docs/_developer_guide/platform_wide/sdk_authentication.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
nav_title: SDK Authentication
article_title: SDK Authentication
page_order: 2
page_order: 1
description: "This reference article covers SDK authentication and how to enable this feature in the Braze SDK."
platform:
- iOS
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
nav_title: Sending Test Messages
article_title: Sending Test Messages
page_order: 3
page_order: 2
description: "This reference article covers sending test messages for different channels."

---
Expand Down
2 changes: 1 addition & 1 deletion _docs/_hidden/other/credit_ratios.md
Original file line number Diff line number Diff line change
Expand Up @@ -151,7 +151,7 @@ In the event that Meta modifies its pricing or packaging for WhatsApp, Braze res
| WhatsApp - United Arab Emirates Service | 5 |
| WhatsApp - United Arab Emirates Utility | 4.2 |
| WhatsApp - United Kingdom Authentication | 9.5 |
| WhatsApp - United Kingdom Marketing | 18.5 |
| WhatsApp - United Kingdom Marketing | 14 |
| WhatsApp - United Kingdom Service | 10.5 |
| WhatsApp - United Kingdom Utility | 5.8 |
{: .reset-td-br-1 .reset-td-br-2}
Expand Down
4 changes: 2 additions & 2 deletions _docs/_hidden/pricing/message_credits_delta_a3sy.md
Original file line number Diff line number Diff line change
Expand Up @@ -2648,8 +2648,8 @@ Column definitions are as follows:
<td>WhatsApp</td>
<td>10</td>
<td>United Kingdom Marketing</td>
<td>1.85</td>
<td>18.50</td>
<td>1.40</td>
<td>14.00</td>
</tr>
<tr>
<td>WhatsApp</td>
Expand Down
4 changes: 2 additions & 2 deletions _docs/_hidden/pricing/message_credits_gamma_0dhr.md
Original file line number Diff line number Diff line change
Expand Up @@ -2648,8 +2648,8 @@ Column definitions are as follows:
<td>WhatsApp</td>
<td>10</td>
<td>United Kingdom Marketing</td>
<td>1.85</td>
<td>18.50</td>
<td>1.40</td>
<td>14.00</td>
</tr>
<tr>
<td>WhatsApp</td>
Expand Down
4 changes: 2 additions & 2 deletions _docs/_hidden/pricing/message_credits_lambda_k5gh.md
Original file line number Diff line number Diff line change
Expand Up @@ -2648,8 +2648,8 @@ Column definitions are as follows:
<td>WhatsApp</td>
<td>10</td>
<td>United Kingdom Marketing</td>
<td>1.85</td>
<td>18.50</td>
<td>1.40</td>
<td>14.00</td>
</tr>
<tr>
<td>WhatsApp</td>
Expand Down
4 changes: 2 additions & 2 deletions _docs/_hidden/pricing/message_credits_sigma_pow2.md
Original file line number Diff line number Diff line change
Expand Up @@ -2648,8 +2648,8 @@ Column definitions are as follows:
<td>WhatsApp</td>
<td>7.5</td>
<td>United Kingdom Marketing</td>
<td>1.85</td>
<td>13.88</td>
<td>1.40</td>
<td>10.50</td>
</tr>
<tr>
<td>WhatsApp</td>
Expand Down
4 changes: 2 additions & 2 deletions _docs/_hidden/pricing/message_credits_theta_d9kw.md
Original file line number Diff line number Diff line change
Expand Up @@ -2648,8 +2648,8 @@ Column definitions are as follows:
<td>WhatsApp</td>
<td>10</td>
<td>United Kingdom Marketing</td>
<td>1.85</td>
<td>18.50</td>
<td>1.40</td>
<td>14.00</td>
</tr>
<tr>
<td>WhatsApp</td>
Expand Down
11 changes: 10 additions & 1 deletion _docs/_partners/canvas_steps/google_audience_sync.md
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,16 @@ If an EEA previously provided consent for both signals, that data will continue
* While you can't explicitly set a user as unspecified, if you send a `null` or `nil` value or any value that isn't `true` or `false`, Braze will pass this user to Google as `UNSPECIFIED`.
* New users added or updated without specifying either consent attribute will be synced to Google with those consent attributes marked as unspecified.

If you attempt to sync an EEA user without the necessary consent fields and granted status, Google will reject this and not serve ads to this end user. In addition, if an ad is served to an EEA user without their explicit consent, you may be liable and could be at financial risk. To avoid this, we suggest sending campaigns with segment filters that only include EEA, UK, and Switzerland users with `true` Google consent attributes. For more details regarding the EU User Consent Policy for Customer Match upload partners, see Google’s [FAQs](https://support.google.com/google-ads/answer/14310715).
If you attempt to sync an EEA user without the necessary consent fields and granted status, Google will reject this and not serve ads to this user. In addition, if an ad is served to an EEA user without their explicit consent, you may be liable and could be at financial risk. To avoid this, we suggest sending campaigns with segment filters that only include EEA, UK, and Switzerland users with `true` Google consent attributes. For more details regarding the EU User Consent Policy for Customer Match upload partners, see Google’s [FAQs](https://support.google.com/google-ads/answer/14310715).

### Setting up your Canvas

After you have synced to Braze, the following consent attributes will be available on your user profiles and for segmentation:

- `$google_ad_user_data`
- `$google_ad_personalization`

In any Canvas where you're targeting EEA, UK, and Switzerland end users using a Google Audience Sync to add users to an audience, you need to exclude these users whenever both consent attributes are any value that isn't `true`. This can be achieved by segmenting these users when the consent values are set to `true`. This also ensures that the more accurate analytics of users are synced since we know Google will reject these users from the audiences. Note that if you're using Google Audience Sync to remove users from an audience, consent attributes are not required.

## Integration

Expand Down
22 changes: 13 additions & 9 deletions _docs/_user_guide/administrative/access_braze/portal.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,18 +19,22 @@ If you are using the [older navigation]({{site.baseurl}}/navigation), you can fi

## What's in the portal

| **Recently Released** | New features that we've released by quarter |
| **Planned Features** | Features that we've committed to building and will begin development within the quarter. <br>There is no confirmed deadline as to when these features will be released. |
| **Under Consideration** | Features we're considering building that our product team would like your feedback on. <br>These are ideas and no guarantee that we will build this feature. |
| **Submit Ideas** | There are 10 product categories in which you can vote for general improvements or comment with a specific feature request or idea. <br>Our product team will receive and read your requests but an idea submission does not guarantee it will be built. |
| Section | Description |
| --- | --- |
| Recently Released | New features that we've released by quarter |
| Planned Features | Features that we've committed to building and will begin development within the quarter. <br>There is no confirmed deadline as to when these features will be released. |
| Under Consideration | Features we're considering building that our product team would like your feedback on. <br>These are ideas and no guarantee that we will build this feature. |
| Submit Ideas | There are 10 product categories in which you can vote for general improvements or comment with a specific feature request or idea. <br>Our product team will receive and read your requests but an idea submission does not guarantee it will be built. |
{: .reset-td-br-1 .reset-td-br-2}

## How you can join the conversation

| **Rank a Feature's Importance** | Rank a feature's importance by selecting **Nice to Have**, **Important**, or **Critical**. |
| **Comment on a Feature** | After you've ranked a feature, you can leave a comment with your feedback. |
| **Answer a Product Manager's Question** | Look for the "How Customers Can Help" on a feature's card to answer questions from our product team. |
| **Submit an Idea** | Go to the **Submit Ideas** page in the portal and select from one of ten cards to rank its importance and include your idea or request in the comments. <br><br>Once submitted, your idea will be reviewed by a member of our product team. We cannot provide updates on the status of a request. Occasionally check back to see if your idea has been added to the "Under Consideration" or "Planned Features" sections. |
| Option | Description |
| --- | --- |
| Rank a feature's importance | Rank a feature's importance by selecting **Nice to Have**, **Important**, or **Critical**. |
| Comment on a feature | After you've ranked a feature, you can leave a comment with your feedback. |
| Answer a Product Manager's question | Look for the "How Customers Can Help" on a feature card to answer questions from our product team. |
| Submit an idea | Go to the portal's **Submit Ideas** page and select from one of ten cards to rank its importance. Include your idea or request in the comments! <br><br>Once submitted, your idea will be reviewed by a member of our product team. We cannot provide updates on the status of a request. Occasionally check back to see if your idea has been added to the "Under Consideration" or "Planned Features" sections. |
{: .reset-td-br-1 .reset-td-br-2}

## Product feedback at Braze
Expand All @@ -53,4 +57,4 @@ The more information and context the better! Include links to campaigns, Canvase

For an example of a well-written product request, see this [Product Request Example]({{site.baseurl}}/product_request/).

[1]: {% image_buster /assets/img/portal.png %}
[1]: {% image_buster /assets/img/portal.png %}
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,7 @@ This graph shows your data point usage across apps.

![App Level Total Data Point Usage shows data points used for each app.][14]

Select one of the totals to view the **Data Point Usage Over Time** table, which shows your weekly data point totals for each workspace.
Select one of the totals to view the **Data Point Usage Over Time** table, which shows your weekly data point totals for each workspace. Rows that have a blank **App Name** column represent data points that aren't associated with any app (such as data points used in requests that don't specify an `app_id`).

![Data Point Usage Over Time showing total weekly data points for two workspaces.][15]

Expand All @@ -98,7 +98,7 @@ This graph allows you to view how data point usage is spread across different ev

#### Data point usage over time

This graph gives you the ability to quickly see your total data point usage versus your allotted amount of data points.
This graph gives you the ability to quickly see your total data point usage versus your allotted amount of data points.

![Data Point Usage over time contrasting current billing cycle allotted data points with running total][8]{: style="max-width:90%;"}

Expand Down
10 changes: 5 additions & 5 deletions _docs/_user_guide/data_and_analytics/query_builder.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,18 +37,18 @@ Results from each report can be generated once a day. If you run the same report

### Query templates

All query templates surface data from the last 60 days. Access templates by selecting **Create SQL Query** > **Query Template** when first creating a report.
Access query templates by selecting **Create SQL Query** > **Query Template** when first creating a report.

See [Query templates]({{site.baseurl}}/user_guide/data_and_analytics/query_builder/query_templates/) for a list of available templates.

### Data timeframe

All queries surface data from the last 60 days.

## Generating SQL with the AI Query Builder

The AI Query Builder leverages [GPT](https://openai.com/gpt-4), powered by OpenAI, to recommend SQL for your query.

{% alert note %}
The AI Query Builder is currently available as a beta feature. Contact your customer success manager if you’re interested in participating in this beta trial.
{% endalert %}

![][2]{: style="max-width:60%;" }

To generate SQL with the AI Query Builder:
Expand Down
2 changes: 1 addition & 1 deletion _docs/_user_guide/data_and_analytics/report_metrics.md
Original file line number Diff line number Diff line change
Expand Up @@ -609,7 +609,7 @@ This is the total number of delivered emails that have been opened by a single u
All
{% endapitags %}

The number of unique daily recipients, or users who received a particular message in a day. This number is received from Braze.
The number of unique daily recipients, or users who received a particular message in a day. This number is received from Braze and is based on the `user_id`.

<span class="calculation-line">Calculation: Count</span>

Expand Down
Loading

0 comments on commit 673d530

Please sign in to comment.