API識別子タイプ

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

次の識別子を使用して、Braze外部APIからテンプレート、キャンバス、キャンペーン、またはセグメントにアクセスできます。すべてのメッセージは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統計、セッション開始統計の取得など、さまざまなことが可能です。

ヒント

app_idの入力を求められても、アプリを扱っていない場合があります。これは特定のプラットフォームに固有のレガシーフィールドであるため、この必須パラメーターのプレースホルダーとして任意の文字列を含めることで、このフィールドを省略できます。

複数のアプリ識別子

SDKのセットアップ時に、複数のアプリ識別子の最も一般的なユースケースは、デバッグビルドとリリースビルドのバリアントでそれぞれ識別子を分けることです。

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

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

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>

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

テンプレート識別子

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

テンプレートは、キャンペーン用のHTMLデザインを外部に委託している場合に非常に便利です。テンプレートが作成されると、特定のキャンペーンに限定されず、ニュースレターのように一連のキャンペーンに適用できるテンプレートが手に入ります。

どこで確認できますか？

テンプレートIDは次の2つの方法で確認できます。

• テンプレート
• apiキー

何に使用できますか？

• APIを使用してテンプレートを更新する
• 特定のテンプレートに関する情報を取得する

キャンバス識別子

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

バリアントを持つキャンバスがある場合、全体のキャンバスIDに加えて、メインキャンバスの下にネストされた個別のバリアントキャンバスIDも存在することに留意してください。

どこで確認できますか？

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

何に使用できますか？

• 特定のメッセージの分析を追跡する
• キャンバスのパフォーマンスに関する高レベルの集計統計を取得する
• 特定のキャンバスの詳細を取得する
• Currentsと組み合わせて、キャンバスに対する「全体像」アプローチとしてユーザーレベルのデータを取り込む
• APIトリガー配信と組み合わせて、トランザクションメッセージの統計を収集する

キャンペーン識別子

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

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

どこで確認できますか？

キャンペーンIDは次の2つの方法で確認できます。

• キャンペーン
• apiキー

何に使用できますか？

• 特定のメッセージの分析をトラッキングする
• キャンペーンパフォーマンスに関する高レベルの集計統計を取得する
• 特定のキャンペーンの詳細を取得する
• Currentsと組み合わせて、キャンペーンに対する「全体像」アプローチのためのユーザーレベルのデータを取り込む
• APIトリガー配信と組み合わせて、トランザクションメッセージの統計を収集する
• キャンペーンページでフィルター api_id:YOUR_API_ID を使用して特定のキャンペーンを検索する

セグメント識別子

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

どこで確認できますか？

セグメントIDは、以下の2つの方法で確認できます。

• segments
• api keys

何に使用できますか？

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

送信識別子

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

どこで確認できますか？

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

何に使用できますか？

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

購読グループ識別子

購読グループ識別子（購読グループID）は、特定の購読グループに対してBrazeが生成するキーです。IDは各購読グループに固有であり、APIを通じて購読グループを参照するために使用できます。

どこで確認できますか？

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

何に使用できますか？

• ユーザーの購読グループを一覧表示する
• ユーザーの購読グループステータスを取得する
• ユーザーの購読グループステータスを更新する