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

File message_orchestration.md committed. #7379

Merged
merged 2,899 commits into from
May 21, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2899 commits
Select commit Hold shift + click to select a range
1a35bca
File quick_push.md committed.
Translationmanagement May 21, 2024
8567ba5
File ios.md committed.
Translationmanagement May 21, 2024
76fb0dd
File advanced_campaign_settings.md committed.
Translationmanagement May 21, 2024
ff31d24
File customizable_app_icons.md committed.
Translationmanagement May 21, 2024
0f416cd
File notification_options.md committed.
Translationmanagement May 21, 2024
0ec07d3
File rich_notifications.md committed.
Translationmanagement May 21, 2024
45021d5
File utilizing_badge_count.md committed.
Translationmanagement May 21, 2024
083deaa
File push_reporting.md committed.
Translationmanagement May 21, 2024
e496b02
File push_registration.md committed.
Translationmanagement May 21, 2024
0ea8dce
File types.md committed.
Translationmanagement May 21, 2024
88c81b9
File users_and_subscriptions.md committed.
Translationmanagement May 21, 2024
31654d0
File web.md committed.
Translationmanagement May 21, 2024
08201e5
File sms.md committed.
Translationmanagement May 21, 2024
49f09a4
File about_sms.md committed.
Translationmanagement May 21, 2024
a299317
File best_practices.md committed.
Translationmanagement May 21, 2024
114ae9c
File know_before_send.md committed.
Translationmanagement May 21, 2024
6237b16
File opt-ins.md committed.
Translationmanagement May 21, 2024
3120545
File campaign.md committed.
Translationmanagement May 21, 2024
eacbc86
File create.md committed.
Translationmanagement May 21, 2024
587bce1
File link_shortening.md committed.
Translationmanagement May 21, 2024
d9070d2
File retargeting.md committed.
Translationmanagement May 21, 2024
89278e0
File segments.md committed.
Translationmanagement May 21, 2024
595d6e9
File faqs.md committed.
Translationmanagement May 21, 2024
e5246a0
File keywords.md committed.
Translationmanagement May 21, 2024
79b4904
File fuzzy_opt_out.md committed.
Translationmanagement May 21, 2024
1e44edf
File keyword_handling.md committed.
Translationmanagement May 21, 2024
2dbac49
File optin_optout.md committed.
Translationmanagement May 21, 2024
ee8fac2
File sms_double_opt_in.md committed.
Translationmanagement May 21, 2024
d2efdf5
File unknown_phone_numbers.md committed.
Translationmanagement May 21, 2024
5bc95d0
File mms.md committed.
Translationmanagement May 21, 2024
3657134
File about_mms.md committed.
Translationmanagement May 21, 2024
af444b9
File contact_card.md committed.
Translationmanagement May 21, 2024
91b4af2
File create.md committed.
Translationmanagement May 21, 2024
2cbe263
File faqs.md committed.
Translationmanagement May 21, 2024
d63181a
File mms_short_long_codes.md committed.
Translationmanagement May 21, 2024
9c39aa5
File phone_numbers.md committed.
Translationmanagement May 21, 2024
fe5f019
File 10dlc.md committed.
Translationmanagement May 21, 2024
aacde50
File user_phone_numbers.md committed.
Translationmanagement May 21, 2024
bd47088
File sms_campaign_analytics.md committed.
Translationmanagement May 21, 2024
143098c
File sms_laws_and_regulations.md committed.
Translationmanagement May 21, 2024
9d5da03
File sms_setup.md committed.
Translationmanagement May 21, 2024
8c4c5d3
File short_and_long_codes.md committed.
Translationmanagement May 21, 2024
bd4e791
File sms_sending.md committed.
Translationmanagement May 21, 2024
4ddaf94
File terms.md committed.
Translationmanagement May 21, 2024
cd37451
File user_data_migration.md committed.
Translationmanagement May 21, 2024
0b77e95
File sms_subscription_group.md committed.
Translationmanagement May 21, 2024
3be3fec
File webhooks.md committed.
Translationmanagement May 21, 2024
a34c69b
File braze_to_braze_webhooks.md committed.
Translationmanagement May 21, 2024
024f744
File creating_a_webhook.md committed.
Translationmanagement May 21, 2024
2a375d1
File reporting.md committed.
Translationmanagement May 21, 2024
9b67fc4
File understanding_webhooks.md committed.
Translationmanagement May 21, 2024
3c2a074
File webhook_template.md committed.
Translationmanagement May 21, 2024
d0c0b9a
File whatsapp.md committed.
Translationmanagement May 21, 2024
ab4dfe9
File message_processing.md committed.
Translationmanagement May 21, 2024
12d45b3
File faqs.md committed.
Translationmanagement May 21, 2024
2ccc687
File handling_unknown_numbers.md committed.
Translationmanagement May 21, 2024
1a18fe6
File opt-ins_and_opt-outs.md committed.
Translationmanagement May 21, 2024
bf1b200
File quality_rating.md committed.
Translationmanagement May 21, 2024
f0db51d
File user_messages.md committed.
Translationmanagement May 21, 2024
fa07339
File meta_resources.md committed.
Translationmanagement May 21, 2024
826a9a8
File overview.md committed.
Translationmanagement May 21, 2024
d8233af
File multiple_subscription_groups.md committed.
Translationmanagement May 21, 2024
e2e9ebe
File user_phone_numbers.md committed.
Translationmanagement May 21, 2024
ab58607
File user_subscription.md committed.
Translationmanagement May 21, 2024
71f2b8e
File whatsapp_best_practices.md committed.
Translationmanagement May 21, 2024
fec5b6d
File whatsapp_campaign.md committed.
Translationmanagement May 21, 2024
b48c821
File create.md committed.
Translationmanagement May 21, 2024
14eb963
File user_retargeting.md committed.
Translationmanagement May 21, 2024
345144a
File whatsapp_campaign_analytics.md committed.
Translationmanagement May 21, 2024
213d4ff
File personalization_and_dynamic_content.md committed.
Translationmanagement May 21, 2024
9a45a26
File onboarding_faq.md committed.
Translationmanagement May 21, 2024
5bd696b
File canvas_persistent_entry_properties.md committed.
Translationmanagement May 21, 2024
117243f
File catalogs.md committed.
Translationmanagement May 21, 2024
eec2dfe
File back_in_stock_notifications.md committed.
Translationmanagement May 21, 2024
3d4babf
File catalog.md committed.
Translationmanagement May 21, 2024
f830a85
File selections.md committed.
Translationmanagement May 21, 2024
5ccbcb8
File connected_content.md committed.
Translationmanagement May 21, 2024
ca15736
File aborting_connected_content.md committed.
Translationmanagement May 21, 2024
548dd30
File connected_content_retries.md committed.
Translationmanagement May 21, 2024
a74e8d0
File local_connected_content_variables.md committed.
Translationmanagement May 21, 2024
5329c49
File making_an_api_call.md committed.
Translationmanagement May 21, 2024
a680b06
File public_apis.md committed.
Translationmanagement May 21, 2024
9d027cc
File user_profile_fields_connected_content.md committed.
Translationmanagement May 21, 2024
a04dbf4
File deep_linking_to_in-app_content.md committed.
Translationmanagement May 21, 2024
d984f25
File key_value_pairs.md committed.
Translationmanagement May 21, 2024
dec68e4
File liquid.md committed.
Translationmanagement May 21, 2024
370e4b7
File aborting_messages.md committed.
Translationmanagement May 21, 2024
be098c9
File advanced_filters.md committed.
Translationmanagement May 21, 2024
8de9cc4
File message_extras.md committed.
Translationmanagement May 21, 2024
16b2db3
File conditional_logic.md committed.
Translationmanagement May 21, 2024
2a8acc3
File faq.md committed.
Translationmanagement May 21, 2024
4f73ff7
File filters.md committed.
Translationmanagement May 21, 2024
dc766cd
File operators.md committed.
Translationmanagement May 21, 2024
ef7e703
File setting_default_values.md committed.
Translationmanagement May 21, 2024
b583cbd
File liquid_use_cases.md committed.
Translationmanagement May 21, 2024
8b3b2b7
File using_liquid.md committed.
Translationmanagement May 21, 2024
cc89e37
File supported_personalization_tags.md committed.
Translationmanagement May 21, 2024
3918404
File promotion_codes.md committed.
Translationmanagement May 21, 2024
fac6ec3
File overview.md committed.
Translationmanagement May 21, 2024
0f377b1
File privacy_portal.md committed.
Translationmanagement May 21, 2024
8b53dac
File sage_ai.md committed.
Translationmanagement May 21, 2024
c133b72
File ai_content_qa.md committed.
Translationmanagement May 21, 2024
00c7656
File generative_ai.md committed.
Translationmanagement May 21, 2024
0dca7f9
File ai_copywriting.md committed.
Translationmanagement May 21, 2024
548583f
File intelligence.md committed.
Translationmanagement May 21, 2024
b2ffa20
File intelligent_channel.md committed.
Translationmanagement May 21, 2024
369517f
File intelligent_selection.md committed.
Translationmanagement May 21, 2024
1df545a
File faqs.md committed.
Translationmanagement May 21, 2024
c689a3e
File intelligent_timing.md committed.
Translationmanagement May 21, 2024
b90b26b
File predictive_suite.md committed.
Translationmanagement May 21, 2024
1278aaa
File creating_a_churn_prediction.md committed.
Translationmanagement May 21, 2024
70fbc16
File messaging_users.md committed.
Translationmanagement May 21, 2024
3312d93
File prediction_analytics.md committed.
Translationmanagement May 21, 2024
9b68818
File predictive_churn.md committed.
Translationmanagement May 21, 2024
f15c5d2
File prediction_quality.md committed.
Translationmanagement May 21, 2024
75e50ee
File prediction_faq.md committed.
Translationmanagement May 21, 2024
261c357
File predictive_events.md committed.
Translationmanagement May 21, 2024
1ad19c0
File creating_an_event_prediction.md committed.
Translationmanagement May 21, 2024
746e654
File messaging_users.md committed.
Translationmanagement May 21, 2024
e2a610a
File prediction_analytics.md committed.
Translationmanagement May 21, 2024
0bb8cd1
File about_item_recommendations.md committed.
Translationmanagement May 21, 2024
f3a53cc
File recommendations.md committed.
Translationmanagement May 21, 2024
339ccd6
File ai_item_recommendations.md committed.
Translationmanagement May 21, 2024
8a64e2f
File rules_based_recommendations.md committed.
Translationmanagement May 21, 2024
f4ccbf8
File intelligent_selection.md committed.
Translationmanagement May 21, 2024
c23eb77
File create_a_canvas.md committed.
Translationmanagement May 21, 2024
8b6d0fe
File integration.md committed.
Translationmanagement May 21, 2024
265eb4f
File integration.md committed.
Translationmanagement May 21, 2024
6e3b0dd
File integration.md committed.
Translationmanagement May 21, 2024
1dc88f5
File integration.md committed.
Translationmanagement May 21, 2024
4d2123d
File integration.md committed.
Translationmanagement May 21, 2024
59865f7
File installation_methods.md committed.
Translationmanagement May 21, 2024
bb959f8
File overview.md committed.
Translationmanagement May 21, 2024
cfc1305
File initial_sdk_setup.md committed.
Translationmanagement May 21, 2024
bb64633
File troubleshooting.md committed.
Translationmanagement May 21, 2024
f3f8aff
File cocoapods.md committed.
Translationmanagement May 21, 2024
db1f710
File manual_integration.md committed.
Translationmanagement May 21, 2024
5dcf31f
File completing_integration.md committed.
Translationmanagement May 21, 2024
5d645fd
File overview.md committed.
Translationmanagement May 21, 2024
aec9009
File other_sdk_customizations.md committed.
Translationmanagement May 21, 2024
a62f515
File swift_package_manager.md committed.
Translationmanagement May 21, 2024
2456132
File android.md committed.
Translationmanagement May 21, 2024
2acd6b6
File ios.md committed.
Translationmanagement May 21, 2024
78cfd60
File tracking_custom_events.md committed.
Translationmanagement May 21, 2024
e040966
File unreal_engine.md committed.
Translationmanagement May 21, 2024
39b803b
File in-app_messaging.md committed.
Translationmanagement May 21, 2024
70ca3e8
File tracking_sessions.md committed.
Translationmanagement May 21, 2024
ee5303b
File content_security_policy.md committed.
Translationmanagement May 21, 2024
7f311d7
File google_tag_manager.md committed.
Translationmanagement May 21, 2024
c7617af
File custom_styling.md committed.
Translationmanagement May 21, 2024
25db4ca
File customization.md committed.
Translationmanagement May 21, 2024
5bac139
File customization.md committed.
Translationmanagement May 21, 2024
6ef99db
File defining_a_news_feed_category.md committed.
Translationmanagement May 21, 2024
d62ae31
File safari_mobile_push.md committed.
Translationmanagement May 21, 2024
caeeb33
File inapp_messages.md committed.
Translationmanagement May 21, 2024
83c36c1
File experiments.md committed.
Translationmanagement May 21, 2024
be080b1
File content_cards.md committed.
Translationmanagement May 21, 2024
365f7a3
File create.md committed.
Translationmanagement May 21, 2024
21ef8e3
File faq.md committed.
Translationmanagement May 21, 2024
0fcb30d
File sending_test_messages.md committed.
Translationmanagement May 21, 2024
c3354a6
File about.md committed.
Translationmanagement May 21, 2024
6174d47
File architecture_overview.md committed.
Translationmanagement May 21, 2024
3c54430
File platform_overview.md committed.
Translationmanagement May 21, 2024
9982622
File integration_overview.md committed.
Translationmanagement May 21, 2024
8170610
File sdk_authentication.md committed.
Translationmanagement May 21, 2024
9f48a7d
File analytics_overview.md committed.
Translationmanagement May 21, 2024
d3af406
File getting_started.md committed.
Translationmanagement May 21, 2024
e0a20af
File platform_wide.md committed.
Translationmanagement May 21, 2024
a0a5bb4
File feature_flags.md committed.
Translationmanagement May 21, 2024
ad97663
File braze_actions.md committed.
Translationmanagement May 21, 2024
3547e8a
File push_notifications.md committed.
Translationmanagement May 21, 2024
23b3356
File canvas.md committed.
Translationmanagement May 21, 2024
ba1ed0f
File troubleshooting.md committed.
Translationmanagement May 21, 2024
10fc422
File news_feed.md committed.
Translationmanagement May 21, 2024
4335090
File initial_sdk_setup.md committed.
Translationmanagement May 21, 2024
1d7ec87
File xamarin.md committed.
Translationmanagement May 21, 2024
72041b0
File changelog.md committed.
Translationmanagement May 21, 2024
8136ff3
File smart_tvs.md committed.
Translationmanagement May 21, 2024
7ad5945
File integration.md committed.
Translationmanagement May 21, 2024
0203f01
File analytics.md committed.
Translationmanagement May 21, 2024
91a237e
File soft_push_prompt.md committed.
Translationmanagement May 21, 2024
cb43eb4
File alternate_push_domain.md committed.
Translationmanagement May 21, 2024
231fad9
File push_notifications.md committed.
Translationmanagement May 21, 2024
c59282c
File integration.md committed.
Translationmanagement May 21, 2024
381b830
File read_and_unread.md committed.
Translationmanagement May 21, 2024
0565c62
File key_value_pairs.md committed.
Translationmanagement May 21, 2024
6bc5d46
File badges.md committed.
Translationmanagement May 21, 2024
7f6cc49
File initial_sdk_setup.md committed.
Translationmanagement May 21, 2024
eecd6dc
File news_feed.md committed.
Translationmanagement May 21, 2024
52afe6f
File custom_styling.md committed.
Translationmanagement May 21, 2024
e34b337
File troubleshooting.md committed.
Translationmanagement May 21, 2024
0cafa68
File open_link_in_new_tab.md committed.
Translationmanagement May 21, 2024
2d4a01c
File in-app_message_delivery.md committed.
Translationmanagement May 21, 2024
b0dd68f
File integration.md committed.
Translationmanagement May 21, 2024
46091ef
File message_dismissal.md committed.
Translationmanagement May 21, 2024
a181aa2
File logging_impressions_and_clicks.md committed.
Translationmanagement May 21, 2024
58acbbf
File key_value_pairs.md committed.
Translationmanagement May 21, 2024
a2d4948
File integration.md committed.
Translationmanagement May 21, 2024
7b8bc19
File setting_custom_attributes.md committed.
Translationmanagement May 21, 2024
4710d3d
File content_cards.md committed.
Translationmanagement May 21, 2024
62404e4
File cookies_and_storage.md committed.
Translationmanagement May 21, 2024
136d837
File setting_user_ids.md committed.
Translationmanagement May 21, 2024
5d8d191
File changelog.md committed.
Translationmanagement May 21, 2024
c11959c
File browser_extensions.md committed.
Translationmanagement May 21, 2024
acde45f
File logging_purchases.md committed.
Translationmanagement May 21, 2024
88e1c0d
File location_tracking.md committed.
Translationmanagement May 21, 2024
ec541b1
File disabling_tracking.md committed.
Translationmanagement May 21, 2024
0f4bfbe
File analytics.md committed.
Translationmanagement May 21, 2024
9d7f8a5
File troubleshooting.md committed.
Translationmanagement May 21, 2024
01307c3
File web.md committed.
Translationmanagement May 21, 2024
111fee3
File amp_support.md committed.
Translationmanagement May 21, 2024
a63f9da
File advanced_use_cases.md committed.
Translationmanagement May 21, 2024
c4d34f6
File initial_sdk_setup.md committed.
Translationmanagement May 21, 2024
1d58f1a
File ios.md committed.
Translationmanagement May 21, 2024
3c9e05c
File android.md committed.
Translationmanagement May 21, 2024
05f6413
File sdk_integration.md committed.
Translationmanagement May 21, 2024
b56daff
File in-app_messaging.md committed.
Translationmanagement May 21, 2024
2c7b16a
File content_cards.md committed.
Translationmanagement May 21, 2024
9d78195
File adm_push_notifications.md committed.
Translationmanagement May 21, 2024
e81871e
File news_feed.md committed.
Translationmanagement May 21, 2024
b9994a3
File setting_user_ids.md committed.
Translationmanagement May 21, 2024
5c8dae8
File push_notifications.md committed.
Translationmanagement May 21, 2024
3293f37
File analytics.md committed.
Translationmanagement May 21, 2024
9355c4d
File changelog.md committed.
Translationmanagement May 21, 2024
6f895c6
File setting_custom_attributes.md committed.
Translationmanagement May 21, 2024
76c9218
File logging_purchases.md committed.
Translationmanagement May 21, 2024
eea131d
File logging_custom_events.md committed.
Translationmanagement May 21, 2024
76a51ce
File unity.md committed.
Translationmanagement May 21, 2024
d2f7481
File sample_apps.md committed.
Translationmanagement May 21, 2024
dfcbaf0
File silent_push_notifications.md committed.
Translationmanagement May 21, 2024
d2023dd
File troubleshooting.md committed.
Translationmanagement May 21, 2024
9d17958
File tv_and_ott.md committed.
Translationmanagement May 21, 2024
1d0dad3
File storage.md committed.
Translationmanagement May 21, 2024
c0f3fc4
File push_story.md committed.
Translationmanagement May 21, 2024
aedba14
File integration.md committed.
Translationmanagement May 21, 2024
df3b3ce
File implementation_guide.md committed.
Translationmanagement May 21, 2024
de23d51
File rich_notifications.md committed.
Translationmanagement May 21, 2024
0f1825f
File ignoring_internal_push.md committed.
Translationmanagement May 21, 2024
56caa76
File badges.md committed.
Translationmanagement May 21, 2024
bd6c31e
File advanced_settings.md committed.
Translationmanagement May 21, 2024
e278163
File custom_sounds.md committed.
Translationmanagement May 21, 2024
5ea311d
File customization.md committed.
Translationmanagement May 21, 2024
920dbd9
File live_activities.md committed.
Translationmanagement May 21, 2024
0b60d84
File action_buttons.md committed.
Translationmanagement May 21, 2024
2818802
File push_notifications.md committed.
Translationmanagement May 21, 2024
e5d7d46
File privacy_manifest.md committed.
Translationmanagement May 21, 2024
71b411b
File faq.md committed.
Translationmanagement May 21, 2024
2d62752
File live_activities.md committed.
Translationmanagement May 21, 2024
059bff4
File ios_17.md committed.
Translationmanagement May 21, 2024
90003d9
fix japanese pages
zzhaobraze May 21, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
49 changes: 49 additions & 0 deletions _lang/ja/_api/api_campaigns.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
---
nav_title: API キャンペーン
article_title: API キャンペーン
page_order: 5
description: "このリファレンス記事では、API コールに含めるcampaign_id を生成する方法と、そのキャンペーンを設定する方法について説明します。"
page_type: reference
tool: Campaigns

---
# APIキャンペーン

> このリファレンス記事では、`campaign_id` を生成してAPI コールに含める方法と、そのキャンペーンを設定する方法について説明します。

API キャンペーンは通常、トランザクションメッセージングに使用されます。API キャンペーンを登録する場合([API トリガキャンペーン]({{site.baseurl}}/user_guide/engagement_tools/campaigns/building_campaigns/delivery_types/api_triggered_delivery/) ではなく)、Braze ダッシュボードは`campaign_id` の生成にのみ使用され、キャンペーンレポートの分析を追跡できます。また、キャンペーンのバリアントごとに異なるメッセージバリエーションID を生成することもできます。

次に、その情報を開発チームに送信し、API リクエストで使用します。
\- キャンペーンコピー
\- 視聴者メンバーシップ
アセット

キャンペーンが開始されたら、ダッシュボードで結果を表示できます。API キャンペーンでは、Braze [メッセージングAPI]({{site.baseurl}}/api/endpoints/messaging/) を使用します。これは、ダッシュボードで完全に作成されたキャンペーンと同じ詳細なレポートおよびターゲット変更オプションを持ちます。

{% alert warning %}
API キャンペーンは通常トランザクションであるため、Global Control Group 内のユーザでも、すべてのユーザがAPI キャンペーンの対象になります。
{% endalert %}

## 新しいキャンペーンを作成する

**Messaging**> **Campaigns**に進み、**Create Campaign**をクリックし、**API Campaigns**を選択します。これで、API キャンペーンの設定に進むことができます。

[API トリガキャンペーン]({{site.baseurl}}/user_guide/engagement_tools/campaigns/building_campaigns/delivery_types/api_triggered_delivery/) はAPI キャンペーンとは異なります。

## キャンペーンの設定

キャンペーンを設定するには、次の手順を実行します。

1. メッセージを送信した後、キャンペーンページで結果を確認できるように、説明的なタイトルを追加します。
2. **Add Message**をクリックし、API キャンペーンに含まれるメッセージタイプを追加します。これにより、`campaign_id` とメッセージバリエーションID を生成できます。これらは、含めるチャンネルごとに異なります。
3. 必要に応じて、特定のアクションまたはキャンペーン目標のユーザ変換を追跡する変換イベントを追加できます。
4. **Save Campaign**をクリックすると、APIキャンペーンを開始するように設定されます!

## APIコール

API キャンペーンを保存した後、API リクエストに以下を含めます。
\- 生成された`campaign_id` フィールドとAPI リクエスト。[メッセージエンドポイントの送信][2] に記載されています。
\- キャンペーンに含まれる各プラットフォームの[message オブジェクト]({{site.baseurl}}/api/objects_filters/#messaging-objects)。メッセージオブジェクトで、メッセージバリエーションID を指定します。これにより、統計を収集し、そのバリアントの下に表示するように指定します。以下のメッセージオブジェクトがサポートされています。Android、コンテンツカード、メール、iOS、Kindle、SMS/MMS、ウェブプッシュ、ウェブフック。

[2]: {{site.baseurl}}/api/endpoints/messaging/#send-endpoints

5 changes: 5 additions & 0 deletions _lang/ja/_api/api_campaigns/transactional_api_campaign.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
nav_title: トランザクションキャンペーン
layout: redirect
redirect_to: /docs/user_guide/message_building_by_channel/email/transactional_message_api_campaign/
---
151 changes: 151 additions & 0 deletions _lang/ja/_api/api_limits.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,151 @@
---
nav_title: レート制限
article_title: API レート制限
page_order: 4.5
description: "このリファレンス記事では、BrazeAPIインフラストラクチャのAPIレート制限について説明します。"
page_type: reference

---

# レート制限

> Braze API インフラストラクチャは、顧客ベース全体で大量のデータを処理するように設計されています。このために、ワークスペースごとにAPI レート制限を適用します。

レート制限は、API が特定の期間に受信できるリクエストの数です。大規模システムにおける負荷ベースのサービス拒否インシデントの多くは、意図しないものです。これは、ソフトウェアや構成のエラーによるものです。悪意のある攻撃ではありません。レート制限は、このようなエラーが顧客からのBraze APIリソースを奪うことがないことを確認します。所定の時間内に送信されるリクエストが多すぎる場合、エラーレスポンスで`429` というステータスコードが表示されることがあります。これは、レート制限に達したことを示しています。

{% alert warning %}
APIレートリミットは、当社システムの適切な使用方法によって変更される場合があります。私たちは、破損や誤使用を防ぐためにAPIコールを行う際には、合理的な制限を推奨します。
{% endalert %}

## リクエストタイプ別のレート制限

次の表に、さまざまなリクエストタイプのデフォルトのAPI レート制限を示します。これらのデフォルトの制限は、要求に応じて増やすことができます。詳細については、カスタマー・サクセス・マネージャーにお問い合わせください。

{% alert note %}
このテーブルにリストされていないリクエストは、1 時間あたり 250,000 リクエストという合計デフォルトレート制限を共有します。
{% endalert %}

| 要求タイプ| デフォルトAPI レート制限|
| --- | --- |
| [`/users/track`][10] | **リクエスト:**1 分あたり 50,000 件のリクエスト。<br><br>**バッチ処理:**API リクエストごとに、75 個のイベント、75 個の購入、および75 個の属性。詳細については、[ユーザーのトラック要求のバッチ処理](#batch-user-track)を参照してください。|
| [`/users/export/ids`][11]| 1 分あたり2500 件のリクエスト|
| [`/users/delete`][12]<br>[`/users/alias/new`][13]<br>[`/users/alias/update`][45]<br>[`/users/identify`][14]<br>[`/users/merge`][44] | エンドポイント間で共有される、1 分あたり 20,000 件のリクエスト。|
| [`/users/external_id/rename`][20]| 1 分あたり1000 件のリクエスト|
| [`/users/external_id/remove`][21]| 1 分あたり1000 件のリクエスト|
| [`/events/list`][15] | 1,000 requests per hour, shared with the `/purchases/product_list` endpoint. |
| [`/purchases/product_list`][16] | 1,000 requests per hour, shared with the `/events/list` endpoint. |
| [`/campaigns/data_series`][17.3] | 50,000 requests per minute. |
| [`/messages/send`][17] | ブロードキャストコール(セグメントまたはConnected Audience のみを指定する場合) 1 分あたり250 件のリクエスト。それ以外の場合は、1 時間あたり250,000 件のリクエスト。|
| [`/campaigns/trigger/send`][17.1] | ブロードキャストコールに対する1 分あたり250 件のリクエスト(セグメントまたはConnected Audience のみを指定する場合)。それ以外の場合は、1 時間あたり250,000 件のリクエスト。|
| [`/canvas/trigger/send`][17.2] | ブロードキャストコール(セグメントまたはConnected Audience のみを指定する場合) 1 分あたり250 件のリクエスト。それ以外の場合は、1 時間あたり250,000 件のリクエスト。|
| [`/sends/id/create`][18] | 1 日あたり100 件のリクエスト。|
| [`/subscription/status/set`][19]| 1 分あたり5000 件のリクエスト|
| [`/preference_center/v1/{preferenceCenterExternalId}/url/{userId}`][26]<br>[`/preference_center/v1/list`][27]<br>[`/preference_center/v1/{preferenceCenterExternalId}`][28] | 1 分あたり 1000 件のリクエスト (ワークスペースあたり) |
| [`/preference_center/v1`][29]<br>[`/preference_center/v1/{preferenceCenterExternalId}`][30] | 1 分あたり10 件の要求(ワークスペースあたり) |
| [`/catalogs/{catalog_name}`][31]<br>[`/catalogs`][32]<br>[`/catalogs`][33] | エンドポイント間で共有される 1 分あたり 50 リクエスト。|
| [`/catalogs/{catalog_name}/items`][34]<br>[`/catalogs/{catalog_name}/items`][35]<br>[`/catalogs/{catalog_name}/items`][36] | エンドポイント間で共有される1 分あたり16,000 件のリクエスト。|
| [`/catalogs/{catalog_name}/items/{item_id}`][37]<br>[`/catalogs/{catalog_name}/items/{item_id}`][38]<br>[`/catalogs/{catalog_name}/items`][39]<br>[`/catalogs/{catalog_name}/items/{item_id}`][40]<br>[`/catalogs/{catalog_name}/items/{item_id}`][41] | エンドポイント間で共有される 1 分あたり 50 リクエスト。|
| [`/scim/v2/Users/{id}`][22]<br>[`/scim/v2/Users?filter={userName@example.com}`][43]<br>[`/scim/v2/Users/{id}`][25]<br>[`/scim/v2/Users/{id}}`][24]<br>[`/scim/v2/Users/`][23] | エンドポイント間で共有される、1 日あたり1 社あたり5000 件のリクエスト。|
{: .reset-td-br-1 .reset-td-br-2}

<!-- Add during CDI endpoints GA
| [`/cdi/integrations`][46] | 50 requests per minute. |
| [`/cdi/integrations/{integration_id}/sync`][47] | 20 requests per minute. |
| [`/cdi/integrations/{integration_id}/job_sync_status`][48] | 100 requests per minute. |
-->

## API 要求のバッチ処理

BrazeAPI はバッチ処理をサポートするように構築されています。バッチ処理を使用すると、Braze は1 回のAPI 呼び出しでできるだけ多くのデータを取り込むことができるため、多くのAPI 呼び出しを行う必要がありません。データを一度に1 回の呼び出しで処理するよりも、Braze でデータを一度に処理する方が効率的です。たとえば、1000 回のバッチAPI コールを処理すると、75,000 回の個別コールを処理するよりも少ないリソースが必要になります。バッチ処理は、1 時間に75,000 回を超えるコールが必要なアプリケーションでは非常に重要です。

{% alert note %}
REST API レート制限の増加は、API バッチ機能を使用している顧客のニーズに基づいて考慮されます。
{% endalert %}

### ユーザートラック要求のバッチ処理 {#batch-user-track}

各`/users/track` リクエストには、最大75 個のイベントオブジェクト、75 個の属性オブジェクト、および75 個の購入オブジェクトを含めることができます。各オブジェクト(イベント、属性、購入アレイ)は、各1 人のユーザーを更新できます。これにより、1回の通話で最大225人のユーザを更新できます。また、1 つのユーザープロファイルを複数のオブジェクトで更新できます。

このエンドポイントに対して行われた要求は、通常、次の順序で処理を開始します。

1. 属性
2. イベント
3. 購入

### バッチメッセージングエンドポイント要求

[メッセージングエンドポイント][1]への単一のリクエストは、次のいずれかに到達できます。

- 最大50 個の特定の`external_ids`、それぞれ個別のメッセージパラメータを含む
- Braze ダッシュボードで作成された任意のサイズのセグメント。Braze ダッシュボードで指定されます `segment_id`
- リクエストで[接続されたオーディエンス][2]オブジェクトとして定義されている任意のサイズの追加のオーディエンスフィルタに一致するユーザ

## レート制限の監視

Braze に送信された 1 つの API リクエストごとに、レスポンスヘッダーに以下の情報が返されます。

ヘッダ名| 説明
----------------------- | -----------------------
`X-RateLimit-Limit` | 指定した間隔で実行できるリクエストの最大数(レート制限)。
`X-RateLimit-Remaining` | 現在のレート制限ウィンドウに残っている要求の数。
`X-RateLimit-Reset` | 現在のレート制限ウィンドウがUTC エポック秒でリセットされる時間。
{: .reset-td-br-1 .reset-td-br-2}

この情報は、Braze ダッシュボードではなく、API 要求に対する応答のヘッダーに意図的に含まれています。これにより、システムは、API とやり取りする際にリアルタイムでより効果的に反応できます。たとえば、`X-RateLimit-Remaining` の値が特定のしきい値を下回った場合、すべてのトランザクションメールが確実に送信されるように送信を遅くすることができます。または、ゼロに達した場合は、`X-RateLimit-Reset` で指定した時間が経過するまで、すべての送信を一時停止することができます。

API 制限についてご質問がある場合は、カスタマーサクセスマネージャーにお問い合わせいただくか、[サポートチケット][support] を開きます。

### エンドポイント間の最適遅延

{% alert note %}
エラーを最小限に抑えるために、連続するエンドポイントコールの間に5 分の遅延を許可することをお勧めします。
{% endalert %}

Braze API を連続して呼び出す場合、エンドポイント間の最適な遅延を理解することが重要です。エンドポイントが他のエンドポイントの正常な処理に依存している場合、問題が発生し、呼び出しが早すぎるとエラーが発生する可能性があります。たとえば、ユーザーに`/user/alias/new` エンドポイント経由でエイリアスを割り当て、そのエイリアスをヒットして`/users/track` エンドポイント経由でカスタムイベントを送信する場合、どのくらいの期間待機する必要がありますか?

通常の条件下では、データの整合性が実現するまでの時間は10 ~100ms (1/10 秒) です。ただし、その整合性の発生に時間がかかる場合があるため、エラーの可能性を最小限に抑えるために、後続の呼び出しの間に5 分の遅延を許可することをお勧めします。

[1]: {{site.baseurl}}/api/endpoints/messaging/
[2]: {{site.baseurl}}/api/objects_filters/connected_audience/
[support]: {{site.baseurl}}/braze_support/
[10]: {{site.baseurl}}/api/endpoints/user_data/post_user_track/
[11]: {{site.baseurl}}/api/endpoints/export/user_data/post_users_identifier/
[12]: {{site.baseurl}}/api/endpoints/user_data/post_user_delete/
[13]: {{site.baseurl}}/api/endpoints/user_data/post_user_alias/
[14]: {{site.baseurl}}/api/endpoints/user_data/post_user_identify/
[15]: {{site.baseurl}}/api/endpoints/export/custom_events/get_custom_events/
[16]: {{site.baseurl}}/api/endpoints/export/purchases/get_list_product_id/
[17]: {{site.baseurl}}/api/endpoints/messaging/send_messages/post_send_messages/
[17.1]: {{site.baseurl}}/api/endpoints/messaging/send_messages/post_send_triggered_campaigns/
[17.2]: {{site.baseurl}}/api/endpoints/messaging/send_messages/post_send_triggered_canvases/
[17.3]: {{site.baseurl}}/api/endpoints/export/campaigns/get_campaign_analytics/
[18]: {{site.baseurl}}/api/endpoints/messaging/send_messages/post_create_send_ids/
[19]: {{site.baseurl}}/api/endpoints/subscription_groups/post_update_user_subscription_group_status/
[20]: {{site.baseurl}}/api/endpoints/user_data/external_id_migration/post_external_ids_rename/
[21]: {{site.baseurl}}/api/endpoints/user_data/external_id_migration/post_external_ids_remove/
[22]: {{site.baseurl}}/get_see_user_account_information/
[23]: {{site.baseurl}}/post_create_user_account/
[24]: {{site.baseurl}}/delete_existing_dashboard_user/
[25]: {{site.baseurl}}/post_update_existing_user_account/
[26]: {{site.baseurl}}/api/endpoints/preference_center/get_create_url_preference_center/
[27]: {{site.baseurl}}/api/endpoints/preference_center/get_list_preference_center/
[28]: {{site.baseurl}}/api/endpoints/preference_center/get_view_details_preference_center/
[29]: {{site.baseurl}}/api/endpoints/preference_center/post_create_preference_center/
[30]: {{site.baseurl}}/api/endpoints/preference_center/put_update_preference_center/
[31]: {{site.baseurl}}/api/endpoints/catalogs/catalog_management/synchronous/delete_catalog/
[32]: {{site.baseurl}}/api/endpoints/catalogs/catalog_management/synchronous/get_list_catalogs/
[33]: {{site.baseurl}}/api/endpoints/catalogs/catalog_management/synchronous/post_create_catalog/
[34]: {{site.baseurl}}/api/endpoints/catalogs/catalog_items/asynchronous/delete_catalog_items_bulk/
[35]: {{site.baseurl}}/api/endpoints/catalogs/catalog_items/asynchronous/patch_catalog_items_bulk/
[36]: {{site.baseurl}}/api/endpoints/catalogs/catalog_items/asynchronous/post_create_catalog_items_bulk/
[37]: {{site.baseurl}}/api/endpoints/catalogs/catalog_items/synchronous/delete_catalog_item/
[38]: {{site.baseurl}}/api/endpoints/catalogs/catalog_items/synchronous/get_catalog_item_details/
[39]: {{site.baseurl}}/api/endpoints/catalogs/catalog_items/synchronous/get_catalog_items_details_bulk/
[40]: {{site.baseurl}}/api/endpoints/catalogs/catalog_items/synchronous/patch_catalog_item/
[41]: {{site.baseurl}}/api/endpoints/catalogs/catalog_items/synchronous/post_create_catalog_item/
[43]: {{site.baseurl}}/get_search_existing_dashboard_user_email/
[44]: {{site.baseurl}}/api/endpoints/user_data/post_users_merge/
[45]: {{site.baseurl}}/api/endpoints/user_data/post_users_alias_update/
[46]: {{site.baseurl}}/api/endpoints/cdi/get_integration_list/
[47]: {{site.baseurl}}/api/endpoints/cdi/job_sync/
[48]: {{site.baseurl}}/api/endpoints/cdi/job_sync_status/
Loading