APIおよびSDKエンドポイント

Brazeインスタンスに対応する正しいダッシュボードURL、REST APIエンドポイント、SDKエンドポイントを確認できます。ログイン、API呼び出し、SDKの統合にこれらのURLが必要です。

Brazeでは、ダッシュボード、SDK、RESTエンドポイント用に複数のインスタンスを管理しており、これらを「クラスター」と呼んでいます。Brazeのオンボーディングマネージャーが、お客様がどのクラスターに属しているかをお知らせします。Braze SDKの詳細については、Braze 101 Braze Learningコースをご覧ください。

dashboard.braze.comにログインすると、自動的に正しいクラスターアドレスに移動します。

重要

SDKを統合する際は、SDKエンドポイントを使用してください。REST APIを呼び出す際は、RESTエンドポイントを使用してください。

APIへのアクセスの詳細については、APIの概要に関する記事をご覧ください。

カスタム URL

クラスターの標準SDKエンドポイントの代わりに、プロキシやカスタムドメインなどのカスタム URL にネットワークリクエストを送信するよう Braze SDKを設定できます。カスタム URL をサポートしている SDKは次のとおりです。

• Braze Swift SDK:バージョン 11.8.0 以降
• Braze Android SDK:バージョン 2.11 以降

カスタム URL の設定

SDKの初期化時に SDKエンドポイントを設定する箇所で、カスタム URL を設定します。統合の詳しいステップについては、Braze SDKの統合を参照してください。

• swift
• android

1
2
3
4
5
6

let configuration = Braze.Configuration(
  apiKey: "YOUR_APP_IDENTIFIER_API_KEY",
  endpoint: "YOUR_CUSTOM_URL"
)
let braze = Braze(configuration: configuration)
AppDelegate.braze = braze

1
2
3
4

BRZConfiguration *configuration = [[BRZConfiguration alloc] initWithApiKey:@"YOUR_APP_IDENTIFIER_API_KEY"
                                                                  endpoint:@"YOUR_CUSTOM_URL"];
Braze *braze = [[Braze alloc] initWithConfiguration:configuration];
AppDelegate.braze = braze;

1
2
3
4
5

<?xml version="1.0" encoding="utf-8"?>
<resources>
  <string translatable="false" name="com_braze_api_key">YOUR_APP_IDENTIFIER_API_KEY</string>
  <string translatable="false" name="com_braze_custom_endpoint">YOUR_CUSTOM_URL</string>
</resources>

1
2
3
4
5

BrazeConfig brazeConfig = new BrazeConfig.Builder()
  .setApiKey("YOUR_APP_IDENTIFIER_API_KEY")
  .setCustomEndpoint("YOUR_CUSTOM_URL")
  .build();
Braze.configure(this, brazeConfig);

1
2
3
4
5

val brazeConfig = BrazeConfig.Builder()
  .setApiKey("YOUR_APP_IDENTIFIER_API_KEY")
  .setCustomEndpoint("YOUR_CUSTOM_URL")
  .build()
Braze.configure(this, brazeConfig)

プロキシ設定のテスト

アプリを本番環境にリリースする前に、プロキシが想定どおりに動作することをテストしてください。SDKがカスタム URL にリクエストを送信していることを確認するには、詳細ログを使用します。

1. SDKを初期化する前に、開発ビルドで詳細ログを有効にします。各 SDKのコードについては、詳細ログを参照してください。
2. テストデバイスまたはシミュレーターでアプリを実行します。SDKはセッションの開始時にリクエストを送信します。
3. ログでリクエストのエントリを見つけ、リクエスト URL がカスタム URL と一致していることを確認します。
4. プロキシが SDK からのリクエストを受信していることを確認します。

Android でカスタム URL へのリクエストが表示されない場合は、API キーとエンドポイントの設定を確認してください。ログ内のリクエストエントリの例については、詳細ログの読み方を参照してください。

重要

アプリを本番環境にリリースする前に、詳細ログを無効にしてください。