Skip to content

API 識別子のタイプ

このリファレンスガイドでは、Braze ダッシュボードに表示されるさまざまな種類の API 識別子、その目的、検索場所、一般的な使用方法について説明しています。REST API キーまたはワークスペース API キーについては、API の概要を参照してください

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

アプリ識別子

app_idアプリ識別子またはは、アクティビティをワークスペース内の特定のアプリに関連付けるパラメーターです。ワークスペース内のどのアプリとやり取りするかを指定します。たとえば、app_id iOSアプリ用、Androidアプリ用、app_idおよびWebインテグレーション用があることがわかります。app_idBrazeでは、Brazeがサポートするさまざまなプラットフォームタイプで、同じプラットフォーム用の複数のアプリを使用している場合があります。

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

app_id次の2つの方法で検索できます。

  1. [設定] > [API キー] に移動します。「識別」では、app_idアプリに存在するすべての情報を確認できます。
  2. [設定] > [アプリ設定] に移動します。API キーは、設定セクションの API キーフィールドの横に表示されます

どんな用途に使えますか?

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

複数のアプリ識別子

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

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

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

```xml <?xml version=”1.0” encoding=”utf-8”?>

{YOUR_BUILD_VARIANT_API_KEY}

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

テンプレート識別子

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

テンプレートは、会社がキャンペーン用の HTML デザインを委託する場合に最適です。テンプレートを作成したら、キャンペーン専用ではないが、ニュースレターなどの一連のキャンペーンに適用できるテンプレートができあがりました。

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

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

  1. テンプレート」に移動し、テンプレートページを選択してから、既存のテンプレートを選択します。必要なテンプレートがまだ存在しない場合は、作成して保存します。個々のテンプレートページの下部に、テンプレート識別子が表示されます。

  2. [設定] > [API キー] に移動します。ここで、Brazeは特定の識別子を検索できる追加API識別子検索を提供しています

どんな用途に使えますか?

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


キャンバス識別子

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

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

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

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

どんな用途に使えますか?

  • 特定のメッセージの分析を追跡する
  • Canvasのパフォーマンスに関する高レベルの集計統計を取得
  • 特定のキャンバスの詳細を取得
  • Currentsでユーザーレベルのデータを取り込み、Canvasesの「全体像」へのアプローチを実現
  • トランザクションメッセージの統計情報を収集するためのAPIトリガー配信機能付き


キャンペーン ID

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

キャンペーンにバリエーションがある場合は、メインキャンペーンの下に全体的なキャンペーンIDと個々のバリエーションキャンペーンIDの両方が表示されることに注意してください。

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

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

  1. [メッセージング] > [キャンペーン] に移動し、既存のキャンペーンを選択します。目的のキャンペーンがまだ存在しない場合は、キャンペーンを作成して保存します。個々のキャンペーンページの下部に、キャンペーン API ID が表示されます。

  2. [設定] > [API キー] に移動します。ここで、Brazeは特定の識別子を検索できる追加API識別子検索を提供しています

どんな用途に使えますか?

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


セグメント識別子

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

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

セグメント ID は、次の 2 つの方法のいずれかで確認できます。

  1. オーディエンス > セグメントに移動し、既存のセグメントを選択します。目的のセグメントがまだ存在しない場合は、作成して保存します。個々のセグメントページの下部に、セグメント識別子が表示されます。

  2. [設定] > [API キー] に移動します。ここで、Brazeは特定の識別子を検索できる追加API識別子検索を提供しています

どんな用途に使えますか?

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

カード識別子

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

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

カードIDは、次の2つの方法のいずれかで確認できます。

  1. [メッセージング] > [ニュースフィード] に移動し、既存のニュースフィードを選択します。必要なニュースフィードがまだ存在しない場合は、作成して保存します。個々のニュースフィードページの下部に、固有のカードIDが表示されます。

  2. [設定] > [API キー] に移動します。ここで、Brazeは特定の識別子を検索できる追加API識別子検索を提供しています

どんな用途に使えますか?

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


送信識別子

送信識別子、または送信IDは、特定のメッセージ送信に対してBrazeが生成するか、ユーザーが作成したキーで、分析を追跡する必要があります。送信識別子を使用すると、/sends/data_seriesエンドポイント経由でキャンペーン送信の特定のインスタンスのアナリティクスをプルバックできます

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

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

どんな用途に使えますか?

送信のたびにキャンペーンを作成しなくても、プログラムでメッセージを送信、パフォーマンスを追跡できます。


「このページはどの程度役に立ちましたか?」
New Stuff!