Skip to content

APIのユースケース

Braze REST APIは、カスタマーエンゲージメント戦略の管理と最適化を支援するために設計された幅広いエンドポイントを提供します。この記事では、カタログ、メールリストとアドレス、エクスポート、メッセージ、ユーザー設定センター、SMS、サブスクリプショングループ、テンプレート、ユーザーデータなど、各エンドポイントコレクションのユースケースをいくつか紹介します。

各セクションでは、ステップバイステップのガイド、コードサンプル、期待される結果とともにシナリオを紹介します。この記事を読み終わる頃には、カスタマーエンゲージメント活動を強化するためのBraze REST APIの使い方をより深く理解できるようになります。

カタログの複数のアイテムを削除する

キッチン用品を専門とする小売ブランドKitchenerieは、新年を迎えて新商品を発表しました。Brazeダッシュボードでは、Kitchenerieの食器コレクション用に「Dishware」というカタログが設定されています。今年は以下の製品を食器コレクションから削除することになりました。

  • Plain Bisque
  • Pearl Porcelain
  • Pink Shimmer

これらの製品をカタログから削除するには、Kitchenerieは/catalogs/{catalog_name}/items エンドポイントを使用してアイテムIDを渡すことができます。

リクエストの例を以下に示します。

1
2
3
4
5
6
7
8
9
10

curl --location --request DELETE 'https://rest.iad-03.braze.com/catalogs/dishware/items' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer YOUR-REST-API-KEY' \
--data-raw '{
  "items": [
    {"id": "plainbisque"},
    {"id": "pearlporcelain"},
    {"id": "pinkshimmer"}
  ]
}'

このペイロードを送信すると、レスポンスにより、BrazeがKitchenerieの食器カタログから3つのコレクションを正常に削除したことが確認されます。

1
2
3

{
  "message": "success"
}

Brazeのスパムリストからメールを削除する

ストリーミングサービス会社のMovieCanonでは、開発者チームが定期的にメールリストを監査し、メールキャンペーンに登録しているユーザーを特定して維持する役割を担っています。この監査の一環として、MovieCanonは以下のメールリストをスパムリストから削除したいと考えています。

このタスクを達成するには、開発者チームは/email/spam/remove エンドポイントを使用するためのemail.spam.remove 権限を持つAPIキーが必要です。このエンドポイントは、Brazeのスパムリストと MovieCanonのメールプロバイダーが管理するスパムリストからメールアドレスを削除します。

このリクエストを送信するには、文字列のメールアドレスか、修正するメールアドレスを最大50件まで含む配列のいずれかを含めます。削除するメールのリストが50件以下であるため、MovieCanonは以下のリクエストボディでこのタスクを達成できます。

1
2

Content-Type: application/json
Authorization: Bearer YOUR-REST-API-KEY

1
2
3

{
  "email": ["august.author.example.com","[email protected]","[email protected]","[email protected]","[email protected]"]
}

このペイロードを正常に送信すると、レスポンスにより、BrazeがMovieCanonのスパムリストからメールを削除したことが確認されます。

1
2
3

{
  "message": "success"
}

すべてのキャンバスを監査する

Siege Valley Healthは、数千人の患者を抱える10の稼働中の病院と研究センターからなる病院システムです。同社のマーケティングチームは、過去3年間にBrazeを使用してインフルエンザ予防接種の予約を促すために患者に送信したキャンバスを比較したいと考えています。Siege Valley Healthのマーケティングチームは、キャンバスのリストと分析サマリーの両方を素早く効率的に確認する方法も求めています。

Brazeダッシュボードでフィルタリングするのではなく、エンドポイントの組み合わせを使ってSiege Valley Healthがこの2つのタスクをどのように達成できるかを見てみましょう。

キャンバスを監査する最初のタスクとして、/canvas/list エンドポイントを使用して、名前とタグを含むキャンバスのリストをエクスポートします。リクエストの例を以下に示します。

Siege Valley Healthのマーケティングチームが受け取るレスポンスは以下のとおりです。
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22

{
  "canvases" : [
  	{
  		"id": "canvas_identifier_1",
  		"last_edited": "2020-07-10T23:59:59",
  		"name": "PatientReminder_FluShot_2020",
  		"tags": {
        "flu_shots", "patienthealth", "2020"
      }
  	},
  	{
  		"id": "canvas_identifier_2",
  		"last_edited": "2020-07-30T23:59:59",
  		"name": "PatientReminder2_FluShot_2020",
  		"tags": {
        "flu_shots", "patienthealth", "reminder", "2020"
      }
  	},
    ... (more Canvases)
  ],
  "message": 'success'
}

次に、Siege Valley Healthのキャンバスリストから最初のキャンバスの分析サマリーを確認するタスクに移りましょう。そのためには、以下のリクエストパラメーターで/canvas/data_summary エンドポイントを使用します。

  • canvas_id: “canvas_identifier_2”
  • ending_at: 2023-07-10T23:59:59
  • starting_at: 2020-07-10T23:59:59

リクエストの例を以下に示します。

1
2

curl --location -g --request GET 'https://rest.iad-01.braze.com/canvas/data_summary?canvas_id=&ending_at=2023-07-10T23:59:59&starting_at=2020-07-10T23:59:59&length=5&include_variant_breakdown=false&include_step_breakdown=false&include_deleted_step_data=false' \
--header 'Authorization: Bearer YOUR-REST-API-KEY'

今後スケジュールされているキャンペーンとキャンバスを確認する

衣料品や美容製品をオンラインと店舗で販売する小売ブランドFlash & Threadにとって、最も忙しい時期が間もなく訪れます。同社のマーケティングチームは、2024年3月31日午後12時までに、Brazeダッシュボードから今後のキャンペーンとキャンバスを確認したいと考えています。これは/messages/scheduled_broadcasts エンドポイントを使用して実現できます。

リクエストの例を以下に示します。

1
2

curl --location --request GET 'https://rest.iad-01.braze.com/messages/scheduled_broadcasts?end_time=2024-03-31T12:00:00' \
--header 'Authorization: Bearer YOUR-REST-API-KEY'

このエンドポイントは、今後のキャンペーンとキャンバスのリストを返します。ここから、マーケティングチームはレスポンス内のキャンペーンとキャンバスのname フィールドを参照することで、メッセージのリストを確認できます。

古いユーザー設定センターを表示する

PoliterWeeklyはデジタル雑誌で、購読者にはメールで連絡を取ることができます。マーケティングチームは、購読者のユーザージャーニーをより深く理解するため、PoliterWeeklyのユーザー設定センターの詳細を確認し、いつ作成され、最後に更新されたかを調べたいと考えています。

/preference_center/v1/{preferenceCenterExternalID} エンドポイントを使用すると、マーケティングチームはパスパラメーターとしてユーザー設定センターの外部IDを挿入するだけで済みます。以下のようになります。

1
2

curl --location -g --request GET https://rest.iad-01.braze.com/preference_center/v1/politer_weekly_preference_center_api_id \
--header 'Authorization: Bearer YOUR-REST-API-KEY'
PoliterWeeklyのマーケティングチームが受け取るレスポンスは以下のとおりです。
1
2
3
4
5
6
7
8
9
10
11
12
13
14

{
  "name": "PoliterWeekly Notification Preferences",
  "preference_center_api_id": "user_engage_pref_123",
  "created_at": "2021-04-03T12:00:00",
  "updated_at": "2024-08-15T15:00:00",
  "preference_center_title": "Manage Your PoliterWeekly Notification Preferences",
  "preference_center_page_html": "<!DOCTYPE html><html><head><title>Your PoliterWeekly Newsletter Preferences</title><style>body { font-family: Arial, sans-serif; margin: 0; padding: 20px; }.container { max-width: 600px; margin: auto; }h1 { color: #333; }.preference { margin-bottom: 20px; }.preference label { font-size: 16px; }.preference input[type=\"checkbox\"] { margin-right: 10px; }.submit-btn { background-color: #007bff; color: white; padding: 10px 20px; border: none; cursor: pointer; }</style></head><body><div class=\"container\"><h1>Manage your notification preferences</h1><p>Select the types of updates you wish to receive from us:</p><form id=\"preferencesForm\"><div class=\"preference\"><label><input type=\"checkbox\" name=\"newsUpdates\" checked> News Updates</label></div><div class=\"preference\"><label><input type=\"checkbox\" name=\"editorialPicks\"> Editorial Picks</label></div><div class=\"preference\"><label><input type=\"checkbox\" name=\"events\"> Events & Webinars</label></div><div class=\"preference\"><label><input type=\"checkbox\" name=\"specialOffers\"> Special Offers & Promotions</label></div><button type=\"submit\" class=\"submit-btn\">Save Preferences</button></form></div><script>document.getElementById('preferencesForm').addEventListener('submit', function(e) {e.preventDefault();alert('Your preferences have been saved!');});</script></body></html>",
  "confirmation_page_html": "<!DOCTYPE html><html><head><title>PoliterWeekly Preferences Updated</title></head><body><h1>You're good to go!</h1><p>Braze updated your preferences successfully.</p></body></html>",
  "redirect_page_html": null,
  "preference_center_options": {
    "meta-viewport-content": "width=device-width, initial-scale=1"
  },
  "state": "active"
}

このレスポンスから、マーケティングチームはユーザー設定センターが最新の更新の3年前に作成されたことがわかります。この情報を踏まえて、マーケティングチームは新しいユーザー設定センターを作成して立ち上げることができます。

無効な電話番号を削除する

CashBlastrの主な目標は、迅速な送金と受取りの方法を簡素化することです。金融サービス会社として、CashBlastrは顧客の電話番号リストを最新かつ正確な状態に保ちたいと考えています。開発者チームは、マーケティングチームのSMSメッセージがCashBlastrの適切な顧客に届くように、「無効」とマークされた以下の電話番号リストを削除するよう指示されています。

  • 12223135467
  • 12183095514
  • 14235662245
  • 14324567892

/sms/invalid_phone_numbers/remove エンドポイントでリクエストを送信するには、電話番号はe.164形式の文字列の配列にする必要があり、リクエストごとに最大50件の電話番号を指定できます。リストが50件を超えないため、CashBlastrの開発者チームが送信するリクエストボディの例を以下に示します。

1
2
3
4
5

Content-Type: application/json
Authorization: Bearer YOUR-REST-API-KEY
{
  "phone_numbers": ["12183095514","14255551212"]
}

このペイロードを送信すると、レスポンスにより、BrazeがCashBlastrの無効な電話番号をBrazeの無効リストから削除したことが確認されます。

1
2
3

{
  "message": "success"
}

ユーザーのサブスクリプショングループのステータスを表示する

SandwichEmperorは米国のクイックサービスレストランチェーンであり、マーケティングチームはランダムに選んだユーザーリストのSMS用サブスクリプショングループのステータスを確認したいと考えています。/subscription/status/get エンドポイントを使用すると、SandwichEmperorは以下のリクエスト例で個々のユーザーに対してこのタスクを実行できます。

1
2

curl --location -g --request GET 'https://rest.iad-01.braze.com/subscription/status/get?subscription_group_id={{subscription_group_id}}&phone=+11232223333' \
--header 'Authorization: Bearer YOUR-REST-API-KEY'

このエンドポイントは、ユーザーのメールに関するサブスクリプショングループのステータスも一覧表示します。複数のユーザーのサブスクリプショングループのステータスを確認する際にも使用できます。

メールメッセージング用のHTMLテンプレートを確認する

WorkFriendsは、異なる業界の労働者間のつながりを構築するソーシャルネットワークであり、マーケティングチームがユーザーにメールキャンペーンを送信する役割を担っています。これらのキャンペーンには、地域イベントのリマインダー、毎週のニュースレター、プロフィール活動のハイライトなどが含まれることがよくあります。

このシナリオでは、WorkFriendsはこれまでレガシーブランディングで単一のHTMLテンプレートを使用してきました。ブランドアイデンティティの統一を図るため、WorkFriendsは新しいテンプレートに移行する前に、このHTMLテンプレートに活用できる有用な情報があるかどうかを確認したいと考えています。

WorkFriendsチームが受け取るレスポンスは以下のとおりです。
1
2
3
4
5
6
7
8
9
10
11

{
  "email_template_id": "WorkFriends_Email_Template_ID",
  "template_name": "Promo template",
  "description": "Promo template",
  "subject": "WorkFriends Weekly Newsletter",
  "preheader": "Another week, another WorkFriends update",
  "body": "<!DOCTYPE html><html><head><title>WorkFriends Weekly Newsletter</title><style>body {font-family: Arial, sans-serif; color: #333;}.container {padding: 20px;}.header {background-color: #f2f2f2; padding: 10px; text-align: center;}.content {margin-top: 20px;}.footer {margin-top: 20px; font-size: 12px; text-align: center; color: #777;}</style></head><body><div class=\"container\"><div class=\"header\"><h2>WorkFriends Weekly Newsletter</h2></div><div class=\"content\"><p>Hello WorkFriends,</p><p>Welcome to another edition of our weekly newsletter. We've got some exciting updates and promos for you this week!</p><!-- Add more content here --><p>Don't forget to check out our latest promos and updates. Stay connected, stay informed!</p></div><div class=\"footer\"><p>Thank you for being a part of WorkFriends.</p><p>Unsubscribe | Update Preferences</p></div></div></body></html>",
  "tags": "promo",
  "created_at": "2020-07-10 13:00:00.000",
  "updated_at": "2024-02-04 17:00:00.000"
}

このテンプレート情報を確認した後、WorkFriendsは/templates/email/update エンドポイントを使用して、APIを通じてメールテンプレートを更新することもできます。Brazeダッシュボードのメールテンプレートにはこれらの編集内容が反映されます。
New Stuff!