API 識別子 タイプ

このリファレンスガイドでは、Brazeダッシュボード内で見つけることができるさまざまな種類のAPI識別子、それらの目的、それらを見つける場所、およびそれらが通常どのように使用されるかについて説明します。REST APIキーまたはワークスペースAPIキーに関する情報については、API概要を参照してください。

次の識別子を使用して、Braze外部APIからテンプレート、キャンバス、キャンペーン、Segment、送信、またはカードにアクセスできます。すべてのメッセージは UTF-8 エンコーディングに従う必要があります。

アプリ識別子

アプリ識別子またはapp_idは、ワークスペース内の特定のアプリとアクティビティを関連付けるパラメータです。これにより、ワークスペース内のどのアプリと対話するかが指定されます。例えば、iOSアプリのためのapp_id、Androidアプリのためのapp_id、Web統合のためのapp_idが見つかるでしょう。Brazeでは、Brazeがサポートするさまざまなプラットフォームタイプにわたって、同じプラットフォーム用の複数のアプリを持っていることがあります。

ぞれはどこにありますか。

あなたのapp_idを見つける方法は2つあります:

• アプリケーション識別子
• アプリ設定

どんなことに使えますか?

Braze のアプリ識別子は、SDK を統合するときに使用され、REST API 呼び出しで特定のアプリを参照するのにも使用されます。app_id を使用すると、特定のアプリで発生したカスタムイベントのデータを引き出したり、特定のアプリのアンインストール統計、新規ユーザー統計、DAU 統計、セッション開始統計などを取得したりすることができます。

複数のアプリ識別子

SDK のセットアップ中、複数のアプリ識別子の最も一般的な用途は、デバッグビルドバリアントとリリースビルドバリアントの識別子を分離することです。

ビルド内の複数のアプリ識別子を簡単に切り替えるには、関連するビルドバリアントごとに個別の braze.xml ファイルを作成することをお勧めします。ビルドバリアントは、ビルドタイプと製品フレーバーの組み合わせです。デフォルトでは、新しいAndroid プロジェクトはdebug およびrelease ビルドタイプで構成され、製品フレーバーはありません。

関連するビルドバリアントごとに、新しい braze.xml を src/<build variant name>/res/values/ で作成します。

1
2
3
4
<?xml version="1.0" encoding="utf-8"?>
<resources>
<string name="com_braze_api_key">{YOUR_BUILD_VARIANT_API_KEY}</string>
</resources>

ビルドバリアントがコンパイルされると、新しい識別子が使用されます。

テンプレート 識別子

ダッシュボード内の特定のテンプレートに対してBrazeによって生成されたランダムキーがテンプレート識別子またはテンプレートIDです。テンプレートIDは各テンプレートごとに一意であり、APIを通じてテンプレートを参照するために使用できます。

テンプレートは、会社がキャンペーンのためにHTMLデザインを外注する場合に最適です。テンプレートが作成された後、特定のキャンペーンに限定されないテンプレートができあがりますが、ニュースレターのような一連のキャンペーンに適用することができます。

ぞれはどこにありますか。

テンプレートIDを見つける方法は2つあります。

• テンプレート
• apiキー

どんなことに使えますか?

• API経由でテンプレートを更新
• 特定のテンプレートに関する情報を取得する

キャンバス 識別子

キャンバス識別子またはキャンバス ID は、ダッシュボード内の特定のキャンバスに対して Braze によって生成されるランダムキーです。キャンバス ID は各キャンバスに固有であり、API を介してキャンバスを参照するために使用できます。

バリアントを含むキャンバスがある場合は、全体的なキャンバスID と、メインキャンバスの下にネストされた個々のバリアントキャンバスID が存在することに注意してください。

ぞれはどこにありますか。

ダッシュボードでキャンバス ID を見つけることができます。メッセージング > キャンバス に移動し、既存のキャンバスを選択します。キャンバスがまだ存在しない場合は、作成して保存してください。個々のキャンバスページの下部で、Analyze Variantsをクリックします。ウィンドウが表示され、キャンバス API 識別子が下部にあります。

どんなことに使えますか?

• 特定のメッセージの分析を追跡する
• キャンバスのパフォーマンスに関する集計統計の概要を取得
• 特定のキャンバスの詳細を取得
• Currents を使用して、ユーザー レベルのデータを取り込み、Canvases に対する「大局的な視点」アプローチを実現します。
• APIトリガー配信を使用して、トランザクションメッセージの統計を収集するために

キャンペーン識別子

キャンペーン識別子またはキャンペーンIDは、ダッシュボード内の特定のキャンペーンに対してBrazeによって生成されるランダムキーです。キャンペーンIDは各キャンペーンに固有であり、APIを通じてキャンペーンを参照するために使用できます。

バリアントを含むキャンペーンがある場合は、全体的なキャンペーンID と、メインキャンペーンの下にネストされた個々のバリアントキャンペーンID の両方が存在することに注意してください。

ぞれはどこにありますか。

キャンペーンIDを見つける方法は2つあります:

• キャンペーン
• apiキー

どんなことに使えますか?

• 特定のメッセージの分析を追跡する
• キャンペーンのパフォーマンスに関する高レベルの集計統計を取得
• 特定のキャンペーンに関する詳細を取得する
• Currentsを使用して、ユーザー レベルのデータを取り込み、キャンペーンに対する「大局的な」アプローチを実現します。
• APIトリガー配信により、トランザクションメッセージの統計を収集するため
• 特定のキャンペーンを検索するには、キャンペーンページでフィルターapi_id:YOUR_API_IDを使用します。

Segment 識別子

セグメント識別子またはセグメントIDは、ダッシュボード内の特定のセグメントに対してBrazeによって生成されるランダムキーです。セグメントIDは各セグメントに固有であり、APIを通じてセグメントを参照するために使用できます。

ぞれはどこにありますか。

セグメントIDを見つける方法は2つあります:

• セグメント
• apiキー

どんなことに使えますか?

• 特定のSegmentの詳細を取得する
• 特定のSegmentの分析を取得する
• 特定のSegmentに対してカスタムイベントが記録された回数を取得する
• API内からセグメントのメンバーにキャンペーンを指定して送信します

カード識別子

カード識別子またはカードIDは、ダッシュボード内の特定のニュースフィードカードに対してBrazeによって生成されるランダムキーです。カードIDは各ニュースフィードカードに固有であり、APIを介してカードを参照するために使用できます。

ぞれはどこにありますか。

カードIDを見つける方法は2つあります:

• ニュースフィード
• apiキー

どんなことに使えますか?

• カードに関する関連情報を取得する
• コンテンツカードとエンゲージメントに関連するイベントを追跡する

識別子を送信

送信識別子、または送信 ID は、分析を追跡する必要がある特定のメッセージ送信に対して Braze によって生成されるか、またはユーザーによって作成されるキーです。送信識別子を使用すると、/sends/data_series エンドポイントを介してキャンペーン送信の特定のインスタンスの分析を取得できます。

ぞれはどこにありますか。

API および API トリガーキャンペーンがブロードキャストとして送信される場合、送信識別子が提供されていない場合は自動的に送信識別子が生成されます。独自の送信識別子を指定したい場合は、まず/sends/id/createエンドポイントを通じて作成する必要があります。識別子はすべてASCII文字で、最大64文字である必要があります。同じキャンペーンの複数の送信にわたって送信識別子を再利用して、それらの送信の分析をグループ化することができます。

どんなことに使えますか?

キャンペーンごとに作成することなく、プログラムでメッセージのパフォーマンスを送信および追跡します。

サブスクリプショングループ識別子

サブスクリプショングループ識別子、またはサブスクリプショングループIDは、特定のサブスクリプショングループのためにBrazeによって生成されたキーです。IDは各サブスクリプショングループに固有であり、APIを通じてサブスクリプショングループを参照するために使用できます。

ぞれはどこにありますか。

オーディエンス > サブスクリプショングループ に移動し、該当するサブスクリプショングループの横にあるIDをコピーします。

どんなことに使えますか?

• ユーザーのサブスクリプショングループをリストする
• ユーザーのサブスクリプショングループステータスを取得
• ユーザーのサブスクリプショングループステータスを更新