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

Leftover Deploy - September 8, 2022 #4041

Merged
merged 27 commits into from
Sep 8, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
27 commits
Select commit Hold shift + click to select a range
33c04f8
TikTok Beta Documentation
KellieHawks Aug 24, 2022
35cf2f3
TikTok Beta Documentation
KellieHawks Aug 24, 2022
aceb7b4
final edits
KellieHawks Aug 29, 2022
c71af54
image edits
KellieHawks Sep 2, 2022
56a36dc
Update android_13.md
davidbielik Sep 6, 2022
7d97cf2
Updating Voucherify (partner) documention; link to new video and link…
janiksam Sep 7, 2022
46c34fc
Merge pull request #4029 from braze-inc/android-13-version
KellieHawks Sep 7, 2022
93ec681
BD-1572: Updating Amplitude cohort segmentation filter
KellieHawks Sep 7, 2022
b2973b9
Merge pull request #4032 from braze-inc/BD-1572
lydia-xie Sep 7, 2022
4910ae5
doc edits
KellieHawks Sep 7, 2022
c930351
Update _docs/_partners/message_orchestration/channel_extensions/loyal…
KellieHawks Sep 7, 2022
2cd0601
Update _docs/_partners/message_orchestration/channel_extensions/loyal…
KellieHawks Sep 7, 2022
d5056cc
Merge pull request #4033 from braze-inc/pr/4031
KellieHawks Sep 7, 2022
55d2a02
BD-1567
lydia-xie Sep 7, 2022
368add0
Update success and support services handbook
KellieHawks Sep 7, 2022
7fb1cd7
Remove warning about ASCII characters
ianabels Sep 7, 2022
68d8521
Merge pull request #4036 from ianabels/patch-12
KellieHawks Sep 7, 2022
ec196c0
Update Changelog - Swift
KellieHawks Sep 7, 2022
6128b0f
Merge pull request #4037 from braze-inc/kh/update_changelog
bre-fitzgerald Sep 8, 2022
1e3c40f
update
KellieHawks Sep 8, 2022
2ff8de7
BD-1577: Link fix
KellieHawks Sep 8, 2022
c8ebe7a
Merge pull request #4035 from braze-inc/kh/sshandbook
lydia-xie Sep 8, 2022
53f8efd
Merge pull request #4039 from braze-inc/BD-1577
bre-fitzgerald Sep 8, 2022
793854c
Update _docs/_hidden/private_betas/tiktok.md
KellieHawks Sep 8, 2022
3b76413
Eng and PM edits
lydia-xie Sep 8, 2022
72219c4
Merge pull request #3972 from braze-inc/kh/tiktok
lydia-xie Sep 8, 2022
7244a3c
Merge pull request #4034 from braze-inc/BD-1567
KellieHawks Sep 8, 2022
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
Original file line number Diff line number Diff line change
Expand Up @@ -55,9 +55,9 @@ It is strongly recommended that your app targets Android 13 in order to control

This will allow you to optimize your [push opt-in rates][6] by prompting users at more appropriate times and will lead to a better user experience in how and when your app asks for push permission.

To start using our new ["no-code" push primer feature][7], upgrade your Android SDK to the [latest version (v21.0.0+)][1].
To start using our new ["no-code" push primer feature][7], upgrade your Android SDK to the [latest version (v23.0.0+)][1].

[1]: https://github.com/Appboy/appboy-android-sdk/blob/master/CHANGELOG.md#2100
[1]: https://github.com/Appboy/appboy-android-sdk/blob/master/CHANGELOG.md#2300
[2]: https://developer.android.com/about/versions/13
[3]: https://developer.android.com/about/versions/13/changes/notification-permission
[4]: https://developer.android.com/about/versions/13/changes/notification-permission#eligibility
Expand Down
Original file line number Diff line number Diff line change
@@ -1,13 +1,6 @@
---
nav_title: Changelog
article_title: Changelog for iOS SDK
page_order: 30
page_type: update
platform: iOS
description: "This page lists updates to Braze's iOS SDK changelog."

---

# iOS SDK changelog

{% markdown_embed https://raw.githubusercontent.com/Appboy/appboy-ios-sdk/master/CHANGELOG.md %}
config_only: true
layout: blank_config
---
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
---
nav_title: Objective-C
article_title: Changelog for iOS Objective-C SDK
page_order: 30
page_type: update
platform: iOS
description: "This page lists updates to Braze's iOS Objective-C SDK changelog."

---

# iOS Objective-C SDK changelog

{% markdown_embed https://raw.githubusercontent.com/Appboy/appboy-ios-sdk/master/CHANGELOG.md %}
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
---
nav_title: Swift
article_title: Changelog for iOS Swift SDK
page_order: 1
page_type: update
platform: iOS
description: "This page lists updates to Braze's iOS Swift SDK changelog."

---

# iOS Swift SDK changelog

{% markdown_embed https://raw.githubusercontent.com/braze-inc/braze-swift-sdk/main/CHANGELOG.md %}
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,11 @@ guide_featured_list:
- name: Android SDK
link: /docs/developer_guide/platform_integration_guides/android/changelog/
image: /assets/img/android.png
- name: iOS SDK
link: /docs/developer_guide/platform_integration_guides/ios/changelog/
- name: iOS SDK (Swift)
link: /docs/developer_guide/platform_integration_guides/ios/changelog/swift_changelog/
fa_icon: fab fa-apple
- name: iOS SDK (Objective-C)
link: /docs/developer_guide/platform_integration_guides/ios/changelog/objc_changelog/
fa_icon: fab fa-apple
- name: Web SDK
link: /docs/developer_guide/platform_integration_guides/web/changelog/
Expand Down Expand Up @@ -44,7 +47,10 @@ guide_menu_list:
- name: Android SDK
link: https://github.com/Appboy/appboy-android-sdk/blob/master/CHANGELOG.md
image: /assets/img/android.png
- name: iOS SDK
- name: iOS SDK (Swift)
link: https://github.com/braze-inc/braze-swift-sdk/blob/main/CHANGELOG.md
fa_icon: fab fa-apple
- name: iOS SDK (Objective-C)
link: https://github.com/Appboy/appboy-ios-sdk/blob/master/CHANGELOG.md
fa_icon: fab fa-apple
- name: Web SDK
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ Visit [Manual in-app message display][5] for more information on how your Smart


[1]: https://developer.samsung.com/smarttv/develop/specifications/tv-model-groups.html
[2]: http://webostv.developer.lge.com/discover/discover-webos-tv/
[2]: https://webostv.developer.lge.com/discover
[3]: https://js.appboycdn.com/web-sdk/latest/doc/modules/braze.html
[4]: {{site.baseurl}}/developer_guide/platform_integration_guides/web/initial_sdk_setup/
[5]: {{site.baseurl}}/developer_guide/platform_integration_guides/web/in-app_messaging/in-app_message_delivery/#manual-in-app-message-display
Expand Down
4 changes: 0 additions & 4 deletions _docs/_hidden/private_betas/link_shortening.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,10 +26,6 @@ For Braze to recognize URLs, they must start with _http://_ or _https://_. When

![][3]

{% alert note %}
Non-ASCII characters in URLs are currently not supported.
{% endalert %}

## Testing

We always recommend that you preview and test your message before launching a campaign or Canvas.
Expand Down
151 changes: 151 additions & 0 deletions _docs/_hidden/private_betas/tiktok.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,151 @@
---
nav_title: Audience Sync to TikTok
article_title: Canvas Audience Sync to TikTok
alias: /tiktok_audience_sync/
description: "This reference article will cover how to use Braze Audience Sync to TikTok, to deliver advertisements based upon behavioral triggers, segmentation, and more."
Tool:
- Canvas
hidden: true
---

# Audience Sync to TikTok

Using the Braze Audience Sync to TikTok, brands can elect to add user data from their own Braze integration to TikTok Audiences to deliver advertisements based upon behavioral triggers, segmentation, and more. Any criteria you'd normally use to trigger a message (push, email, SMS, webhook, etc.) in a Braze Canvas based upon your user data can now be used to trigger an ad to that user in your TikTok Audiences.

**Common use cases for audience syncing include**:

- Targeting high-value users via multiple channels to drive purchases or engagement
- Retargeting users who are less responsive to other marketing channels
- Creating suppression audiences to prevent users from receiving advertisements when they're already loyal consumers of your brand
- Creating Lookalike Audiences to acquire new users more efficiently

This feature gives brands the option to control what specific first-party data is shared with TikTok. At Braze, the integrations you can and cannot share your first-party data with are given the utmost consideration. For more information, refer to our [privacy policy](https://www.braze.com/privacy).

{% alert important %}
Audience Sync to TikTok is currently in beta. Contact your Braze account manager if you're interested in participating in the beta
{% endalert %}

## Integration requirements

You will need to ensure that you have the following items created and completed before setting up your TikTok Audience Step in Canvas.

| Requirement | Origin | Description |
| ----------- | ------ | ----------- |
| TikTok for Business Center Account | [TikTok](https://business.tiktok.com/) | A centralized tool to manage your brand's TikTok assets (i.e., ad accounts, pages, apps). |
| TikTok Ad Account | [TikTok](https://ads.tiktok.com/) | An active TikTok ad account tied to your brand's Business Center account.<br><br>Ensure that your TikTok Business Center manager admin has granted you admin permissions to the TikTok ad accounts you plan to use with Braze. |
{: .reset-td-br-1 .reset-td-br-2 .reset-td-br-3}

## Integration

### Step 1: Connect to TikTok

In the Braze dashboard, go to **Technology Partners** and select **TikTok**. In the TikTok Audience Export module, click **Connect TikTok**.

![TikTok technology page in Braze includes an Overview module and TikTok Audience Export module with the Connected TikTok button.][1]{: style="max-width:75%;"}

You'll then be redirected to the TikTok OAuth page to authorize Braze for Ad Account Management and Audience Management. Once you have selected confirm, you'll be redirected back into Braze to select which TikTok ad accounts you wish to sync to.

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

Once successfully connected, you will be taken back to the partner page, where you can view which accounts are connected and disconnect existing accounts.

![][3]{: style="max-width:75%;"}

Your TikTok connection will be applied at the Braze app group level. If your TikTok admin removes you from your TikTok Business Center or access to the connected TikTok accounts, Braze will detect an invalid token. As a result, your active Canvases using TikTok Audience components will show errors, and Braze will not be able to sync users.

### Step 2: Add a TikTok Audience component in Canvas Flow

Add a component in your Canvas and select **TikTok Audience**.

![][8]

### Step 3: Sync setup

Click on the **Custom Audience** button to open the component editor.

Select the desired TikTok ad account. Under the Choose a **New or Existing Audience** dropdown, type in the name of a new or existing audience.

{% tabs %}
{% tab Create a New Audience %}

**Create a New Audience**<br>
Enter a name for the new audience, select **Add Users to Audience**, and select which fields you would like to sync with TikTok. Next, save your audience by clicking the **Create Audience** button at the bottom of the step editor.

![]({% image_buster /assets/img/tiktok/tiktok7.png %})

Users will be notified at the top of the step editor if the audience is created successfully or if errors arise during this process. Users can also reference this audience for user removal later in the Canvas journey because the audience was created in draft mode.

![]({% image_buster /assets/img/tiktok/tiktok6.png %})

When you launch a Canvas with a new audience, Braze will create the new audience upon launching the Canvas and subsequently sync users in near real-time as they enter the TikTok Audience Step.
{% endtab %}
{% tab Sync with an Existing Audience %}

**Sync with an Existing Audience**<br>
Braze also offers the ability to add users to existing TikTok audiences to ensure that these audiences are up-to-date. To sync with an existing audience, type the existing audience name in the dropdown and **Add to the Audience**. Braze will then add users in near real-time as they enter the TikTok Audience step.

![Expanded view of the Custom Audience Canvas step. Here, the desired Ad account and existing audience are selected.]({% image_buster /assets/img/tiktok/tiktok4.png %})

{% endtab %}
{% endtabs %}

{% alert note %}
At this time, TikTok does not have the ability to remove users from audiences. In addition, the TikTok team is also working on providing the ability to share multiple user fields to match within a single request.
{% endalert %}

### Step 4: Launch Canvas
Once you have configured your TikTok Audience component, simply launch the Canvas! A new audience will be created, and users who flow through the TikTok Audience component will be passed into this audience on TikTok. If your Canvas contains subsequent components, your users will then advance to the next step in their user journey.

You can view the audience in TikTok by going into your ads manager account and then selecting **Audiences** from the **Assets** dropdown. From the **Audience** page, you can see the size of each audience after it reaches &#126;1,000.

![TikTok page listing the following metrics for the given audience.][5]

## User syncing and rate limit considerations

As users reach the Audience Sync step, Braze will sync these users in near real-time while also respecting TikTok's Marketing API rate limits. This means that Braze will try to batch and process as many users every 5 seconds before sending these users to TikTok.

TikTok's Segment API rate limit states no more than 50 queries per second and 10k users per request. If a Braze customer reaches this rate limit, Braze the Canvas will retry the sync for up to &#126;13 hours. If the sync is not possible, these users are listed under the Users Errored metric.

## Understanding analytics

The following table includes metrics and descriptions to help you better understand analytics from your Audience Sync component.

| Metric | Description |
| ------ | ----------- |
| Entered | Number of users who entered this component to be synced to TikTok. |
| Proceeded to Next Step | Number of users that advanced to the next component if one exists. All users will auto-advance if this is the last step in the Canvas branch. |
| Users Synced | Number of users who have successfully been synced to TikTok. |
| Users Not Synced | Number of users that have not been synced due to missing fields to match. |
| Users Pending | Number of users currently being processed by Braze to sync into TikTok. |
| Users Errored | Number of users who were not synced to TikTok due to an API error after about 13 hours of retries. Potential causes of errors can include an invalid TikTok token or if the audience was deleted on TikTok. |
| Exited Canvas | Number of users who have exited the Canvas. This occurs when the last step in a Canvas is a TikTok step. |
{: .reset-td-br-1 .reset-td-br-2}

{% alert important %}
Remember that there will be a delay in reporting for users synced and users errored metrics due to the bulk flusher and the 13-hour retry, respectively.
{% endalert %}

## Troubleshooting

{% details What should I do next if I receive an invalid token error?
%}
You can simply disconnect and reconnect your TikTok account on the TikTok partner page. Ensure with your TikTok Business Center admin that you have the appropriate permissions to the ad account you wish to sync.
{% enddetails %}

{% details Why is my Canvas not allowed to launch? %}
Ensure that your TikTok account successfully connects to Braze on the TikTok partner page.
Make sure you have selected an ad account, entered a name for the new audience, and selected fields to match
{% enddetails %}

{% details How do I know if users have matched after passing users to TikTok? %}
TikTok does not provide this information for their data privacy policies.
{% enddetails %}

[1]: {% image_buster /assets/img/tiktok/tiktok1.png %}
[2]: {% image_buster /assets/img/tiktok/tiktok2.png %}
[3]: {% image_buster /assets/img/tiktok/tiktok3.png %}
[4]: {% image_buster /assets/img/tiktok/tiktok4.png %}
[5]: {% image_buster /assets/img/tiktok/tiktok5.png %}
[6]: {% image_buster /assets/img/tiktok/tiktok6.png %}
[7]: {% image_buster /assets/img/tiktok/tiktok7.png %}
[8]: {% image_buster /assets/img/tiktok/tiktok8.png %}
28 changes: 13 additions & 15 deletions _docs/_partners/canvas_steps/google_audience_sync.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ Tool:

The Braze Audience Sync to Google integration enables brands to extend the reach of their cross-channel customer journeys to Google Search, Google Shopping, Gmail, YouTube, and Google Display. Using your first-party customer data, you can securely deliver ads based upon dynamic behavioral triggers, segmentation, and more. Any criteria you'd typically use to trigger a message (e.g., push, email, SMS, etc.) as part of a Braze Canvas can be used to trigger an ad to that user via Google's [Customer Match](https://support.google.com/google-ads/answer/6379332?hl=en).

Common use cases for syncing Custom Audiences include:
**Common use cases for syncing Custom Audiences include**:
- Targeting high-value users via multiple channels to drive purchases or engagement.
- Retargeting users who are less responsive to other marketing channels.
- Creating suppression audiences to prevent users from receiving advertisements when they're already loyal consumers of your brand.
Expand Down Expand Up @@ -105,21 +105,19 @@ As users reach the Audience Sync component, Braze will sync these users in near
Once a customer is close to reaching the Google Ads API rate limit, Google will provide feedback back to Braze around retry recommendations. If a Braze customer reaches their rate limit, Braze the Canvas will retry the sync for up to &#126;13 hours. If the sync is not possible, these users are listed under the Users Errored metric.

## Understanding analytics
<br>

**Entered**: Number of users who entered this step to be synced to Google.

**Proceeded to Next Step**: How many users advanced to the next component if there is one. All users will auto-advance. 0 if this is the last step in the Canvas branch.

**Users Synced**: Number of users who have successfully been synced to Google.

**User Not Synced**: Number of users that have not been synced due to missing fields to match.

**Users Errored**: Number of users who were not synced to Google due to an error, after &#126;13 hours of retries. For specific errors, like Google Ads API service disruptions, Canvas will retry the sync for up to &#126;13 hours. If the sync is still not possible at that point, the User Not Synced will be populated.

**Users Pending**: Number of users currently being processed by Braze to sync to Google.

**Exited Canvas**: Number of users who have exited the Canvas. This occurs when the last step in a Canvas is a Google step.
The following table includes metrics and descriptions to help you better understand analytics from your Audience Sync component.

| Metric | Description |
| ------ | ----------- |
| Entered | Number of users who entered this step to be synced to Google. |
| Proceeded to Next Step | How many users advanced to the next component if there is one. All users will auto-advance. 0 if this is the last step in the Canvas branch. |
| Users Synced | Number of users who have successfully been synced to Google. |
| User Not Synced | Number of users that have not been synced due to missing fields to match. |
| Users Errored | Number of users who were not synced to Google due to an error, after &#126;13 hours of retries. For specific errors, like Google Ads API service disruptions, Canvas will retry the sync for up to &#126;13 hours. If the sync is still not possible at that point, the User Not Synced will be populated. |
| Users Pending | Number of users currently being processed by Braze to sync to Google. |
| Exited Canvas | Number of users who have exited the Canvas. This occurs when the last step in a Canvas is a Google step. |
{: .reset-td-br-1 .reset-td-br-2}

## Troubleshooting
{% details Why am I unable to select multiple fields to match in my Google Audience Step configuration? %}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,10 +11,11 @@ search_tag: Partner

# Voucherify

{% include video.html id="Xh_c53cBA9w" align="right" %}

> [Voucherify](https://www.voucherify.io/) is an all-in-one promotional platform that allows for personalized campaigns and loyalty programs that drive user engagement and retention.

<iframe src="https://player.vimeo.com/video/745340934?h=17ceae8c3c" width="640" height="360" frameborder="0" allow="autoplay; fullscreen; picture-in-picture" allowfullscreen></iframe>

The Braze and Voucherify integration allows you to grow your promotional campaigns by sending unique codes through the use of:

- [Connected Content]({{site.baseurl}}/partners/message_orchestration/channel_extensions/loyalty/voucherify/voucherify_fetching_data_through_braze_connected_content): Add unique codes to Braze campaigns via Braze’s Connected Content. With this feature, you can use Voucherify discount coupons, gift card campaigns, loyalty cards, and referral codes.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,9 @@ The basic schema of the script looks as follows:
}
```
{% endraw %}

Visit the Voucherify [GitHub repository](https://github.com/voucherifyio/braze-connected-content) to see examples of Connected Content scripts.

## Security settings

Without the following settings set each time a Connected Content message is triggered, it will call the Voucherify API at least two times. These settings reduce the number of API calls invoiced to Braze and cut the risk of hitting the hard-blocking API limit that may break message delivery.
Expand Down Expand Up @@ -136,6 +139,8 @@ Keep in mind that all examples below use Voucherify publication source id and Br
- It isn't possible to publish and send different codes to the same customer in a single Braze campaign.
- If your Voucherify campaign uses the _join only once feature_, you need to remove `source_id` from the Connected Content body as described in the join-once tab above.

Visit the Voucherify [GitHub repository](https://github.com/voucherifyio/braze-connected-content) to see examples of Connected Content scripts.

### Publish and send unique coupon code

In this example, the Connected Content script calls Voucherify API to publish a unique coupon code and send it in the Braze message. Each Braze user receives only one unique code.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -277,8 +277,8 @@ glossaries:
description: Segments your users by their age, as they indicated from within your app.
tags:
- User Attributes
- name: Amplitude Extension
description: Clients who use Amplitude to supplement their segments may import and choose from those exntensions.
- name: Amplitude Cohorts
description: Clients who use Amplitude can supplement their segments by choosing and importing their cohorts in Amplitude.
tags:
- User Attributes
- name: Background Push Enabled
Expand Down
Loading