Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

BD-3237 Glossary Audit - Part 1 #7652

Merged
merged 1 commit into from
Jul 10, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions _docs/_api/endpoints/messaging/live_activity/start.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ To use this endpoint, you'll need to complete the following:
"app_id": "(required, string) App API identifier retrieved from the Developer Console.",
"activity_id": "(required, string) Define a custom string as your `activity_id`. You will use this ID when you wish to send update or end events to your Live Activity.",
"activity_attributes_type": "(required, string) The activity attributes type you define within `liveActivities.registerPushToStart` in your app",
"activity_attributes": "(required, object) The static attribute values for the activity type (i.e. the sports team names which don't change)",
"activity_attributes": "(required, object) The static attribute values for the activity type (such as the sports team names, which don't change)",
"content_state": "(required, object) You define the ContentState parameters when you create your Live Activity. Pass the updated values for your ContentState using this object. The format of this request must match the shape you initially defined.",
"dismissal_date": "(optional, datetime in ISO-8601 format) The time to remove the Live Activity from the user’s UI. If this time is in the past, the Live Activity will be removed immediately.",
"stale_date": "(optional, datetime in ISO-8601 format) The time the Live Activity content is marked as outdated in the user’s UI.",
Expand All @@ -58,7 +58,7 @@ To use this endpoint, you'll need to complete the following:
| `app_id` | Required | String | App [API identifier]({{site.baseurl}}/api/identifier_types/#the-app-identifier) retrieved from the [API Keys]({{site.baseurl}}/user_guide/administrative/app_settings/api_settings_tab/) page. |
| `activity_id` | Required | String | Define a custom string as your `activity_id`. You will use this ID when you wish to send update or end events to your Live Activity. |
| `activity_attributes_type` | Required | String | The activity attributes type you define within `liveActivities.registerPushToStart` in your app. |
| `activity_attributes` | Required | Object | The static attribute values for the activity type (i.e. the sports team names which don't change). |
| `activity_attributes` | Required | Object | The static attribute values for the activity type (such as the sports team names, which don't change). |
| `content_state` | Required | Object | You define the `ContentState` parameters when you create your Live Activity. Pass the updated values for your `ContentState` using this object.<br><br>The format of this request must match the shape you initially defined. |
| `dismissal_date` | Optional | Datetime <br>([ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) string) | This parameter defines the time to remove the Live Activity from the user's UI. |
| `stale_date` | Optional | Datetime <br>([ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) string) | This parameter tells the system when the Live Activity content is marked as outdated in the user's UI. |
Expand Down
2 changes: 1 addition & 1 deletion _docs/_api/objects_filters/messaging/android_object.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ You must include an Android push object in `messages` if you want users you have
"push_icon_image_url": (optional, string) an image URL for the large icon,
"accent_color": (optional, integer) accent color to be applied by the standard Style templates when presenting this notification, an RGB integer value,
"send_to_most_recent_device_only": (optional, boolean) defaults to false, if set to true, Braze will only send this push to a user's most recently used Android device, rather than all eligible Android devices,
"buttons" : (optional, array of Android Push Action Button Objects) push action buttons to display
"buttons" : (optional, array of Android push action button objects) push action buttons to display
"conversation_data" : (optional, Android Conversation Push Object) the data to be displayed via Conversation Push.
}
```
Expand Down
2 changes: 1 addition & 1 deletion _docs/_api/objects_filters/messaging/apple_object.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ description: "This reference article lists and explains the different Apple obje
"mutable_content": (optional, boolean) if true, Braze will add the mutable-content flag to the payload and set it to 1. The mutable-content flag is automatically set to 1 when sending a rich notification, regardless of the value of this parameter.
"send_to_most_recent_device_only": (optional, boolean) defaults to false, if set to true, Braze will only send this push to a user's most recently used iOS device, rather than all eligible iOS devices,
"category": (optional, string) the iOS notification category identifier for displaying push action buttons,
"buttons" : (optional, array of Apple Push Action Button Objects) push action buttons to display
"buttons" : (optional, array of Apple push action button objects) push action buttons to display
}
```

Expand Down
2 changes: 1 addition & 1 deletion _docs/_api/objects_filters/messaging/web_objects.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ description: "This reference article lists and explains the different web object
"require_interaction": (optional, boolean) whether to require the user to dismiss the notification, supported on Mac Chrome,
"time_to_live": (optional, integer (seconds)),
"send_to_most_recent_device_only" : (optional, boolean) defaults to false, if set to true, Braze will only send this push to a user's most recently used browser, rather than all eligibles browsers,
"buttons" : (optional, array of Web Push Action Button Objects) push action buttons to display
"buttons" : (optional, array of Web push action button objects) push action buttons to display
}
```

Expand Down
2 changes: 1 addition & 1 deletion _docs/_contributing/content_management.md
Original file line number Diff line number Diff line change
Expand Up @@ -98,7 +98,7 @@ Replace the following.

| Placeholder | Description |
|-------------|-------------------------------------------------------------------------------------------------------------------------|
| `ALT_TEXT` | The alt text for the image. This is required to ensure Braze Docs is equally accessible for those using screen readers. |
| `ALT_TEXT` | The alt text for the image. This is required to make Braze Docs equally accessible for those using screen readers. |
| `IMAGE` | The relative path to your image starting from the `img` directory. |
{: .reset-td-br-1 .reset-td-br-2}

Expand Down
4 changes: 2 additions & 2 deletions _docs/_contributing/content_management/images.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ Replace the following:

| Placeholder | Description |
|-------------|-------------------------------------------------------------------------------------------------------------------------|
| `ALT_TEXT` | The alt text for the image. This is required to ensure Braze Docs is equally accessible for those using screen readers. |
| `ALT_TEXT` | The alt text for the image. This is required to make Braze Docs equally accessible for those using screen readers. |
| `IMAGE` | The relative path to your image starting from the `img` directory. |
{: .reset-td-br-1 .reset-td-br-2}

Expand All @@ -88,7 +88,7 @@ Replace the following:

| Placeholder | Description |
|--------------------|-------------------------------------------------------------------------------------------------------------------------|
| `ALT_TEXT` | The alt text for the image. This is required to ensure Braze Docs is equally accessible for those using screen readers. |
| `ALT_TEXT` | The alt text for the image. This is required to make Braze Docs equally accessible for those using screen readers. |
| `REFERENCE_NUMBER` | Assign any positive integer that's not already assigned to another reference-style link on this page. |
{: .reset-td-br-1 .reset-td-br-2}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ Then, register a callback function to [subscribe for data updates][6] when cards

### Step 3: Implement analytics

Content Card impressions, clicks, and dismissals are not automatically logged in your custom view. You must [implement each respective method][3] to ensure all metrics get properly logged back to Braze dashboard analytics.
Content Card impressions, clicks, and dismissals are not automatically logged in your custom view. You must [implement each respective method][3] to properly log all metrics back to Braze dashboard analytics.

## Content Card placements

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -164,8 +164,8 @@ public class BrazeGtmTagProvider implements CustomTagProvider {
private static Context sApplicationContext;

/**
* Must be set before calling any of the follwing methods to
* ensure that the proper application context is available when needed.
* Must be set before calling any of the following methods
* so that the proper application context is available when needed.
*
* Recommended to be called in your {@link Application#onCreate()}.
*/
Expand Down Expand Up @@ -372,8 +372,8 @@ class BrazeGtmTagProvider : CustomTagProvider {
private var sApplicationContext: Context? = null

/**
* Must be set before calling any of the following methods to
* ensure that the proper application context is available when needed.
* Must be set before calling any of the following methods so
* that the proper application context is available when needed.
*
* Recommended to be called in your [Application.onCreate].
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ The following is an example custom font family definition using the [font family
xmlns:app="http://schemas.android.com/apk/res-auto">

<!--Note: You must declare both sets of attributes
to ensure your fonts load on devices running Android 8.0 (API level 26) or lower.
so that your fonts load on devices running Android 8.0 (API level 26) or lower.
See https://developer.android.com/guide/topics/ui/look-and-feel/fonts-in-xml.html -->

<font android:fontStyle="normal"
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ There can be some latency for in-app messages that display immediately on delive

## Minimum time interval between triggers

By default, we rate limit in-app messages to once every 30 seconds to ensure a quality user experience.
By default, we rate limit in-app messages to once every 30 seconds to support a quality user experience.

To override this value, set `com_braze_trigger_action_minimum_time_interval_seconds` in your `braze.xml` via:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ By default, the Braze Android SDK log level is set to `INFO`. You can [suppress

### Enabling logs {#enabling-logs}

To help troubleshoot issues in your app, or ensure fast turnaround times with Braze Support, you'll want to enable verbose logs for the SDK. When you send verbose logs to Braze Support, ensure they begin as soon as you launch your application and end far after your issue occurs.
To help troubleshoot issues in your app, or reduce turnaround times with Braze Support, you'll want to enable verbose logs for the SDK. When you send verbose logs to Braze Support, ensure they begin as soon as you launch your application and end far after your issue occurs.

Keep in mind, verbose logs are only intended for your development environment, so you'll want to disable them before releasing your app.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -222,7 +222,7 @@ Braze includes a service to handle push receipt and open intents. Our `BrazeFire
</service>
```

Our notification code also uses `BrazeFirebaseMessagingService` to handle open and click action tracking. This service must be registered in the `AndroidManifest.xml` to function correctly. Also, remember that Braze prefixes notifications from our system with a unique key to ensure we only render notifications sent from our systems. You may register additional services separately to render notifications sent from other FCM services. See [`AndroidManifest.xml`][70] in the Firebase push sample app.
Our notification code also uses `BrazeFirebaseMessagingService` to handle open and click action tracking. This service must be registered in the `AndroidManifest.xml` to function correctly. Also, remember that Braze prefixes notifications from our system with a unique key so that we only render notifications sent from our systems. You may register additional services separately to render notifications sent from other FCM services. See [`AndroidManifest.xml`][70] in the Firebase push sample app.

{% alert important %}
Before Braze SDK 3.1.1, `AppboyFcmReceiver` was used to handle FCM push. The `AppboyFcmReceiver` class should be removed from your manifest and replaced with the preceding integration.
Expand Down
2 changes: 1 addition & 1 deletion _docs/_help/release_notes/2020/december.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ Pypestream is a full-stack, conversational AI platform offering patented, all-in

## Dyspatch partnership

With Dyspatch, use the intuitive drag and drop email builder to create beautiful, responsive, and engaging emails without needing to write code. Collaborate with your team to create and approve emails within Dyspatch and then upload them to use within Braze, all in a couple of steps! For more information, check out our [Dyspatch]({{site.baseurl}}/partners/channel_extensions/creative_and_personalization/email_orchestration/dyspatch/) documentation.
With Dyspatch, use the intuitive drag-and-drop email builder to create beautiful, responsive, and engaging emails without needing to write code. Collaborate with your team to create and approve emails within Dyspatch and then upload them to use within Braze, all in a couple of steps! For more information, check out our [Dyspatch]({{site.baseurl}}/partners/channel_extensions/creative_and_personalization/email_orchestration/dyspatch/) documentation.

## RudderStack partnership

Expand Down
2 changes: 1 addition & 1 deletion _docs/_partners/canvas_steps/criteo_audience_sync.md
Original file line number Diff line number Diff line change
Expand Up @@ -153,7 +153,7 @@ You can simply disconnect and reconnect your Criteo account on the Criteo partne
{% enddetails %}

{% details Why is my Canvas not allowed to launch? %}
Please ensure that your Criteo ad account has successfully connected to Braze on the Criteo partner page.
Make sure that your Criteo ad account has successfully connected to Braze on the Criteo partner page.

Make sure you have selected an ad account, entered a name for the new audience, and selected fields to match
{% enddetails %}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ search_tag: Partner
> This article describes how to import user cohorts from Treasure Data to Braze so you can send targeted campaigns based on data that may only exist in your warehouse.

{% alert important %}
This feature is currently in Beta. For more information, contact your Treasure Data and Braze representatives.
This feature is currently in beta. For more information, contact your Treasure Data and Braze representatives.
{% endalert %}

## Prerequisites
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ For more information on Stories, the Movable Ink Customer Data API, and how Mova
| Movable Ink account | A Movable Ink account is required to take advantage of this partnership. |
| Movable Ink API credentials | Movable Ink's Solutions team will generate API credentials for you. The API credentials consist of:{::nomarkdown}<ul><li>An endpoint URL (where the data will be sent to)</li><li>Username and password (used to authenticate the API)</li></ul>{:/} If desired, Movable Ink can supply the username and password as a base64-encoded value to be used as a basic authorization header value. |
| Behavioral event payloads | You will need to share your event payloads with your Movable Ink Client Experience team. See [Sharing event payloads](#event-payloads) with Movable Ink for details. |
| Creative assets and business logic | You will need to share creative assets with Movable Ink, including Adobe Photoshop (PSD) files directing Movable Ink on how to build the block and a fallback image. You will also need to provide business logic for how and when to display the partner-activated content block. |
| Creative assets and business logic | You will need to share creative assets with Movable Ink, including Adobe Photoshop (PSD) files directing Movable Ink on how to build the block and a fallback image. You will also need to provide business logic for how and when to display the partner-activated Content Block. |
{: .reset-td-br-1 .reset-td-br-2}

## Integration
Expand Down
2 changes: 1 addition & 1 deletion _docs/_user_guide/data_and_analytics/creating_a_formula.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ Formulas, especially when combined with custom events, allow you to better under
The following are some examples of the kinds of behavior patterns that can be detected using formulas:

- **Ride-sharing apps:** If you have a custom event for when the user cancels a ride, configuring a function for Canceled Rides / DAU can be used to find if certain user segments tend to cancel more rides than others.
- **E-commerce apps:** By configuring a function for purchases of a certain product ID / MAU, you can, compare the popularity of a recently promoted product between segments, even if all of the promotions couldn't be tracked using Braze.
- **Ecommerce apps:** By configuring a function for purchases of a certain product ID / MAU, you can, compare the popularity of a recently promoted product between segments, even if all of the promotions couldn't be tracked using Braze.
- **Media apps using ads:** If the users' experience is interrupted by ads between video or audio clips, recording mid-ad exits as a custom event and calculating the ratio of mid-ad exits / DAU can help find the best segments to target with a campaign for ad-free premium subscriptions.

## Creating formulas
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,7 @@ Unlike an `external_id`, an alias can be updated with a new name for a given lab

![Two different user profiles for separate users with the same user alias label but different alias names][29]

User aliases also allow you to tag anonymous users with an identifier. For example, if a user provides your e-commerce site with their email address but hasn't yet signed up, the email address can be used as an alias for that anonymous user. These users can then be exported using their aliases or referenced by the API.
User aliases also allow you to tag anonymous users with an identifier. For example, if a user provides your ecommerce site with their email address but hasn't yet signed up, the email address can be used as an alias for that anonymous user. These users can then be exported using their aliases or referenced by the API.

If an anonymous user profile with an alias is later recognized with an `external_id`, they will be treated as a normal identified user profile, but will retain their existing alias and can still be referenced by that alias.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -200,7 +200,7 @@ Basic Liquid is supported in the drag-and-drop email editor. To add personalizat
1. Select **Personalization** under the **Content** section.
2. Select the personalization type. This includes default (standard) attributes, device attributes, custom attributes, and more.
3. Search for the attribute to be added.
4. Copy your generated Liquid snippet and paste it into a content block in your email body.
4. Copy your generated Liquid snippet and paste it into a in your email body.

Liquid personalization is not supported for image blocks and button link type fields.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ You can set certain styles to be applied across all relevant blocks in your pref
To return to the common styles, select the "X" button on individual block properties. Next, select the message container, message "X" button, or editor background.
{% endalert %}

## Drag and drop preference center components
## Drag-and-drop preference center components

The drag-and-drop editor uses two key components to make preference center composition quick and easy: rows and blocks. All blocks must be placed in a row.

Expand Down
Loading