冗長なログを読む

このページでは、Braze SDKからの詳細ログ出力を解釈する方法を説明する。各メッセージングチャネルについて、確認すべき主要なログエントリ、その意味、および注意すべき一般的な問題点を以下に示す。

始める前に、詳細ログ記録のイネーブルメントを有効にしていることと、自分のプラットフォームでログを収集する方法を知っていることを確認せよ。

セッション

セッションはBrazeの分析とメッセージ配信の基盤である。多くのメッセージング機能——アプリ内メッセージやコンテンツカードを含む——は、機能する前に有効なセッションが開始されている必要がある。セッションが正しく記録されていない場合、まずこれを調査せよ。セッショントラッキングのイネーブルメントに関する詳細については、ステップ5を参照せよ。ユーザーセッションのトラッキングを有効にする。

主要なログエントリ

• swift
• android

1
Started user session (id: <SESSION_ID>)

1
2
3
4
5
Ended user session (id: <SESSION_ID>, duration: <DURATION>s)
Logged event:
- userId: <USER_ID>
- sessionId: <SESSION_ID>
- data: sessionEnd(duration: <DURATION>)

1
2
3
4
New session created with ID: <SESSION_ID>
Session start event for new session received
Completed the openSession call
Opened session with activity: <ACTIVITY_NAME>

1
2
3
Closed session with activity: <ACTIVITY_NAME>
Closed session with session ID: <SESSION_ID>
Requesting data flush on internal session close flush timer.

確認すべき事項

• アプリ起動時にセッション開始ログが表示されることを確認せよ。
• セッションが開始されない場合は、SDKが正しく初期化されていることと、(openSessionAndroid)が呼び出されていることを確認せよ。
• Androidでは、Brazeエンドポイントへのネットワークリクエストが行われていることを確認する。これが見えない場合は、API キーとエンドポイントの設定を確認せよ。

プッシュ通知

プッシュ通知ログは、デバイストークンが登録されていること、通知が配信されていること、クリックイベントがトラッキングされていることを確認するのに役立つ。

トークン登録

セッションが開始されると、SDKはデバイスのプッシュトークンをBrazeに登録する。

• swift
• android

1
2
3
4
Updated push notification authorization:
- authorization: authorized

Received remote notifications device token: <PUSH_TOKEN>

1
2
3
4
5
6
"attributes": [
  {
    "push_token": "<PUSH_TOKEN>",
    "user_id": "<USER_ID>"
  }
]

1
2
3
4
"device": {
  "ios_push_auth": "authorized",
  "remote_notification_enabled": 1
}

1
Registering for Firebase Cloud Messaging token using sender id: <SENDER_ID>

確認すべき事項

• リクエスト本文に が欠けているpush_token場合、トークンは取得されなかった。アプリの設定でプッシュ通知の設定を確認せよ。
• 表示がdenied またはios_push_auth の場合provisional、ユーザーは完全なプッシュ権限を許可していない。
• Androidでは、FCM送信者IDがFirebaseプロジェクトと一致するように更新する必要があるSENDER_ID_MISMATCH。

配達を急がせる

プッシュ通知がタップされると、SDKは処理とクリックイベントを記録する。

• swift
• android

1
2
3
4
5
6
7
8
9
10
11
12
13
Processing push notification:
- date: <TIMESTAMP>
- silent: false
- userInfo: {
  "ab": { ... },
  "ab_uri": "<DEEP_LINK_OR_URL>",
  "aps": {
    "alert": {
      "body": "<MESSAGE_BODY>",
      "title": "<MESSAGE_TITLE>"
    }
  }
}

1
2
3
4
Logged event:
- userId: <USER_ID>
- sessionId: <SESSION_ID>
- data: pushClick(campaignId: ...)

1
2
3
4
Opening '<URL>':
- channel: notification
- useWebView: false
- isUniversalLink: false

1
BrazeFirebaseMessagingService: Got Remote Message from FCM

確認すべき事項

• プッシュペイロードに、期待される title,body , およびディープリンク（ab_uri）が含まれていることを確認せよ。
• タップ後にイベントpushClickが記録されたことを確認する。
• クリックイベントが欠落している場合、アプリデリゲートまたは通知ハンドラーがプッシュイベントをBraze SDKに正しく転送しているか確認せよ。

アプリ内メッセージ

アプリ内メッセージのログは、その全ライフサイクルを示す。サーバーからの配信、イベントに基づくトリガー、表示、インプレッションの記録、クリックのトラッキングまでだ。

メッセージング

ユーザーがセッションを開始し、アプリ内メッセージの受信資格がある場合、SDKはサーバーからメッセージペイロードを受信する。

• swift
• android

1
2
3
4
5
6
7
8
9
"templated_message": {
  "data": {
    "message": "...",
    "type": "HTML",
    "message_close": "SWIPE",
    "trigger_id": "<TRIGGER_ID>"
  },
  "type": "inapp"
}

1
Triggering action: <CAMPAIGN_BSON_ID>

メッセージ表示とインプレッション

• swift
• android

1
2
3
In-app message ready for display:
- triggerId: (campaignId: <CAMPAIGN_ID>, ...)
- extras: { ... }

1
2
3
4
Logged event:
- userId: <USER_ID>
- sessionId: <SESSION_ID>
- data: inAppMessageImpression(triggerIds: [...])

1
handleExistingInAppMessagesInStackWithDelegate:: Displaying in-app message

クリックとボタンのイベント

ユーザーがボタンをタップするか、メッセージを閉じると：

• swift
• android

1
2
3
4
Logged event:
- userId: <USER_ID>
- sessionId: <SESSION_ID>
- data: inAppMessageButtonClick(triggerIds: [...], buttonId: "<BUTTON_ID>")

1
No matching trigger for event.

確認すべき事項

• アプリ内メッセージが表示されない場合、まずセッション開始が記録されているか確認せよ。
• 設定済みのBrazeエンドポイントからの応答をフィルターでフィルタリングし、メッセージペイロードが配信されたことを確認する。
• インプレッションが記録されていない場合、記録を抑制するinAppMessageDisplayカスタムデリゲートを実装していないか確認せよ。
• 「イベントに一致するトリガーがありません」と表示される場合、これは正常であり、そのイベントに対して追加のアプリ内メッセージが設定されていないことを示している。

コンテンツカードによって促進された

コンテンツカードのログは、カードがデバイスに同期され、ユーザーに表示され、インタラクション（インプレッション、クリック、非表示操作）がトラッキングされていることを確認するのに役立つ。

カード同期

コンテンツカードはセッション開始時と手動更新が要求された時に同期する。セッションが記録されていない場合、コンテンツカードは表示されない。

• swift
• android

1
2
3
4
5
6
7
8
9
10
11
"cards": [
  {
    "id": "<CARD_ID>",
    "tt": "<CARD_TITLE>",
    "ds": "<CARD_DESCRIPTION>",
    "tp": "short_news",
    "v": 0,
    "cl": 0,
    "p": 1
  }
]

1
Requesting content cards sync.

インプレッション、クリック、および非表示

• swift
• android

1
2
3
4
Logged event:
- userId: <USER_ID>
- sessionId: <SESSION_ID>
- data: contentCardImpression(cardIds: [...])

1
2
3
4
Logged event:
- userId: <USER_ID>
- sessionId: <SESSION_ID>
- data: contentCardClick(cardIds: [...])

1
2
3
Opening '<URL>':
- channel: contentCard
- useWebView: true

1
2
3
4
Logged event:
- userId: <USER_ID>
- sessionId: <SESSION_ID>
- data: contentCardDismissed(cardIds: [...])

確認すべき事項

• カードは表示されていない。セッション開始が記録されていることを確認せよ。コンテンツカードは同期するためにアクティブなセッションが必要だ。
• 新規ユーザー向けのカードが不足している。新規ユーザーは初回セッションではコンテンツカードが表示されない場合がある。次のセッションまで待たなければならない。これは想定通りの動作だ。
• カードのサイズ制限を超えている。2KBを超えるコンテンツカードは表示されず、メッセージは中断される。
• キャンペーンを停止した後もカードは残る。キャンペーンを停止した後、同期が完了したことを確認せよ。同期が成功すると、コンテンツカードはデバイスから削除される。キャンペーンを停止する際は、ユーザーフィードからアクティブなカードを除去するオプションが選択されていることを確認せよ。

ディープリンク

ディープリンクのログは、プッシュ通知、アプリ内メッセージ、コンテンツカードに表示される。ログ構造は、ソースチャネルに関係なく一貫している。

• swift
• android

1
2
3
4
5
Opening '<DEEP_LINK_URL>':
- channel: <SOURCE_CHANNEL>
- useWebView: false
- isUniversalLink: false
- extras: { ... }

1
adb shell am start -W -a android.intent.action.VIEW -d "<YOUR_DEEP_LINK>" "<YOUR_PACKAGE_NAME>"

確認すべき事項

• キャンペーンで設定した内容とディープリンクURLが一致しているか確認せよ。
• あるチャネル（例えばプッシュ通知）ではディープリンクが機能するが、別のチャネル（例えばコンテンツカード）では機能しない場合、ディープリンク処理の実装が全てのチャネルに対応しているか確認せよ。
• iOSでは、ユニバーサルリンクには追加の処理が必要だ。Brazeチャネルからユニバーサルリンクが機能しない場合、アプリがURL処理用のBrazeDelegateプロトコルを実装しているか確認せよ。
• Androidでは、カスタムハンドラーを使用する場合、自動ディープリンク処理が無効になっていることを確認せよ。そうでなければ、デフォルトのハンドラーが実装と競合する可能性がある。

ユーザー識別

ユーザーがSDKによって識別子で識別されるとexternal_id、SDKはユーザー変更イベントを記録する。

• android
• swift

1
changeUser called with: <EXTERNAL_ID>

1
"user_id": "<EXTERNAL_ID>"

ネットワークリクエスト

詳細ログには、SDKがBrazeサーバーと通信する際の完全なHTTPリクエストとレスポンスの詳細が含まれる。これらは接続の問題を診断するのに役立つ。

リクエスト構造

設定済みのBrazeエンドポイント（例：sdk.iad-01.braze.com）へのリクエストをフィルターする。リクエスト構造には以下が含まれる：

• swift
• android

1
2
3
4
5
6
7
[http] request POST: <YOUR_BRAZE_ENDPOINT>
- Headers:
  - Content-Type: application/json
  - X-Braze-Api-Key: <REDACTED>
  - X-Braze-Req-Attempt: 1
  - X-Braze-Req-Tokens-Remaining: <COUNT>
- Body: { ... }

1
Making request(id = <REQUEST_ID>) to <YOUR_BRAZE_ENDPOINT>

確認すべき事項

• APIキー：Verify がワークスペースの API キーと一致することをXBraze-ApiKey確認せよ。
• エンドポイント：リクエストURLが設定済みのSDKエンドポイントと一致していることを確認せよ。
• 再試行回数：1より大きいXBraze-Req-Attempt値は、SDKが失敗したリクエストを再試行していることを示す。これは接続の問題を示している可能性がある。
• レート制限：残りのXBraze-Req-Tokens-Remainingリクエストトークンを表示する。カウント数が低い場合、SDKがレート制限に近づいている可能性がある。
• 要求が不足している。Androidでは、セッション開始後にBrazeエンドポイントへのリクエストが表示されない場合、API キーとエンドポイントの設定を確認せよ。

一般的なイベントの略称

詳細ログのペイロードにおいて、Brazeは省略形のイベント名を使用する。参考までに：