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つあります。

• app identifiers
• app settings

どのように使用できますか？

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

ヒント

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

複数のアプリ識別子

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>

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

テンプレート識別子

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

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

どこで見つけられますか？

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

• templates
• api keys

どのように使用できますか？

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

キャンバス識別子

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

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

どこで見つけられますか？

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

どのように使用できますか？

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

キャンペーン識別子

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

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

どこで見つけられますか？

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

• キャンペーン
• api keys

どのように使用できますか？

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

セグメント識別子

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

どこで見つけられますか？

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

• セグメント
• api keys

どのように使用できますか？

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

送信識別子

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

どこで見つけられますか？

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

どのように使用できますか？

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

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

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

どこで見つけられますか？

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

どのように使用できますか？

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