データ収集を管理する

Appleのプライバシーマニフェスト

トラッキングデータとは？

Appleは「トラッキングデータ」を、アプリ内でエンドユーザーやデバイスについて収集され、サードパーティのデータ（ターゲット広告など）やデータブローカーにリンクされたデータと定義しています。完全な定義と例については、Apple: Trackingを参照してください。

デフォルトでは、Braze SDKはトラッキングデータを収集しません。ただし、Braze SDKの設定によっては、アプリのプライバシーマニフェストにBraze固有のデータを記載する必要がある場合があります。

プライバシーマニフェストとは？

プライバシーマニフェストは、アプリとサードパーティSDKがデータを収集する理由と、そのデータ収集方法を説明するXcodeプロジェクト内のファイルです。データをトラッキングするサードパーティSDKには、それぞれ独自のプライバシーマニフェストが必要です。アプリのプライバシーレポートを作成すると、これらのプライバシーマニフェストファイルは自動的に1つのレポートに集約されます。

APIトラッキングデータドメイン

iOS 17.2以降、AppleはエンドユーザーがAd Tracking Transparency (ATT) プロンプトを受け入れるまで、アプリ内で宣言されたすべてのトラッキングエンドポイントをブロックします。Brazeはトラッキングデータをルーティングするためのトラッキングエンドポイントを提供しており、トラッキング以外のファーストパーティデータは元のエンドポイントにルーティングすることもできます。

Brazeトラッキングデータの宣言

ヒント

完全なウォークスルーについては、プライバシートラッキングデータチュートリアルを参照してください。

前提条件

この機能を実装するには、以下のBraze SDKバージョンが必要です。

ステップ1：現在のポリシーを確認する

Braze SDKの現在のデータ収集ポリシーを法務チームと一緒に確認し、アプリがAppleの定義するトラッキングデータを収集しているかどうかを判断します。トラッキングデータを収集していない場合、現時点ではBraze SDKのプライバシーマニフェストをカスタマイズする必要はありません。Braze SDKのデータ収集ポリシーの詳細については、SDKデータ収集を参照してください。

重要

Braze以外のSDKがトラッキングデータを収集している場合は、それらのポリシーを個別に確認する必要があります。

ステップ2：プライバシーマニフェストを作成する

まず、XcodeプロジェクトでPrivacyInfo.xcprivacyファイルを検索して、プライバシーマニフェストが既に存在するかどうかを確認します。このファイルが既にある場合は、次のステップに進むことができます。ない場合は、Apple: プライバシーマニフェストの作成を参照してください。

ステップ3：プライバシーマニフェストにエンドポイントを追加する

Xcodeプロジェクトで、アプリのPrivacyInfo.xcprivacyファイルを開き、テーブルを右クリックしてRaw Keys and Valuesにチェックを入れます。

App Privacy Configurationで、NSPrivacyTrackingを選択し、その値をYESに設定します。

App Privacy Configurationで、NSPrivacyTrackingDomainsを選択します。ドメイン配列に新しい要素を追加し、以前にAppDelegateに追加したエンドポイントの先頭にsdk-trackingを付けた値を設定します。

ステップ4：トラッキングデータを宣言する

次に、AppDelegate.swiftを開き、静的または動的なトラッキングリストを作成して、宣言する各トラッキングプロパティをリストします。AppleはエンドユーザーがそのユーザーのATTプロンプトを承認するまでこれらのプロパティをブロックするため、あなたと法務チームがトラッキングと見なすプロパティのみをリストしてください。例：

• 静的な例
• 動的な例

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
import UIKit
import BrazeKit

@main
class AppDelegate: UIResponder, UIApplicationDelegate {

  static var braze: Braze? = nil

  func application(
    _ application: UIApplication,
    didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]?
  ) -> Bool {
    let configuration = Braze.Configuration(apiKey: brazeApiKey, endpoint: brazeEndpoint)
    // Declare which types of data you wish to collect for user tracking.
    configuration.api.trackingPropertyAllowList = [
      .dateOfBirth,
      .customEvent(["event-1"]),
      .customAttribute(["attribute-1", "attribute-2"])
    ]
    let braze = Braze(configuration: configuration)
    AppDelegate.braze = braze
    return true
  }
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
func sceneDidBecomeActive(_ scene: UIScene) {
  // Request and check your user's tracking authorization status.
  ATTrackingManager.requestTrackingAuthorization { status in
    // Let Braze know whether user data is allowed to be collected for tracking.
    let enableAdTracking = status == .authorized
    AppDelegate.braze?.set(adTrackingEnabled: enableAdTracking)

    // Add the `.firstName` and `.lastName` properties, while removing the `.everything` configuration.
    AppDelegate.braze?.updateTrackingAllowList(
      adding: [.firstName, .lastName],
      removing: [.everything]
    )
  }
}

ステップ5：無限リトライループを防止する

SDKが無限リトライループに入るのを防ぐには、set(adTrackingEnabled: enableAdTracking)メソッドを使用してATT権限を処理します。SceneDelegate.swiftメソッドのadTrackingEnabledプロパティは、以下のように処理する必要があります。

1
2
3
4
5
6
7
8
func sceneDidBecomeActive(_ scene: UIScene) {
    // Request and check your user's tracking authorization status.
    ATTrackingManager.requestTrackingAuthorization { status in
      // Let Braze know whether user data is allowed to be collected for tracking.
      let enableAdTracking = status == .authorized
      AppDelegate.braze?.set(adTrackingEnabled: enableAdTracking)
    }
}

データトラッキングを無効にする

Swift SDKのデータトラッキングアクティビティを無効にするには、Brazeインスタンスのenabledプロパティをfalseに設定します。enabledがfalseに設定されている場合、Braze SDKはパブリックAPIへのすべての呼び出しを無視します。また、SDKはネットワークリクエストやイベント処理など、進行中のすべてのアクションもキャンセルします。

以前に保存されたデータを消去する

wipeData()メソッドを使用して、ユーザーのデバイスにローカル保存されたSDKデータを完全に消去できます。

Braze Swiftバージョン7.0.0以降では、SDKとwipeData()メソッドはデバイスIDとしてランダムなUUIDを生成します。ただし、useUUIDAsDeviceIdがfalseに設定されている場合、または Swift SDKバージョン5.7.0以前を使用している場合は、Identifier for Vendors（IDFV）がそのユーザーのデバイスIDとして自動的に使用されるため、/users/deleteへのポストリクエストも行う必要があります。

手動プッシュ連携を使用していて、アプリがwipeData()を呼び出した後、同じアプリ実行中にSDKを再度有効にする場合は、Brazeが更新されたデバイストークンを受信できるようにregisterForRemoteNotifications()を再度呼び出してください。詳細については、プッシュ通知の設定を参照してください。

データトラッキングを再開する

データ収集を再開するには、enabledをtrueに設定します。以前に消去されたデータは復元されないことに注意してください。

ログアウトとプッシュ登録解除

Braze SDKは、ユーザーがプッシュ通知の登録を解除したりログアウトしたりする際に、デバイスへのターゲティングを停止するためのメソッドを提供しています。これらのメソッドは、BrazeサーバーおよびSDKから現在のユーザーのプッシュ登録データを削除するため、Brazeはそのユーザーに今後のプッシュ通知キャンペーンを送信しなくなります。

ログアウト

ユーザーがアプリケーションからログアウトする際に、SDKのlogoutメソッドを呼び出して、現在のユーザーからデバイスのプッシュ登録を削除し、SDK上のクリーンアップアクションを自動的に実行します。logoutメソッドは以下を実行します。

• Brazeサーバー上の現在のユーザーから、デバイスのプッシュトークンおよびすべてのLive Activitiesのpush-to-startトークンの登録を解除します。
• 登録解除の呼び出しが成功した場合、SDKはローカルに保存されたSDKデータを消去し、SDKを無効にします。
• 失敗した場合、エラーとisRetriableフラグを発生させ、インテグレーターがアクションを取れるようにします。

• swift
• objective-c

1
2
3
4
5
6
7
8
9
// Completion handler
AppDelegate.braze?.logout { result in
  switch result {
  case .success:
    print("Logout successful")
  case .failure(let error):
    print("Logout failed: \(error.message), isRetriable: \(error.isRetriable)")
  }
}

1
2
3
4
5
6
7
// Async/await
do {
  try await AppDelegate.braze?.logout()
  print("Logout successful")
} catch let error as Braze.LogoutErrorResult {
  print("Logout failed: \(error.message), isRetriable: \(error.isRetriable)")
}

1
2
3
4
5
6
[AppDelegate.braze logoutWithCompletion:^(NSError * _Nullable error) {
  if (error) {
    NSNumber *isRetriable = error.userInfo[BRZLogoutErrorUserInfoKey.isRetriable];
    NSLog(@"Logout failed: %@, isRetriable=%@", error.localizedDescription, isRetriable);
  }
}];

logout後にトラッキングとプッシュを再有効化する

logoutが成功した後、enabledをtrueに戻し、Swiftプッシュ設定に従ってオペレーティングシステム（OS）またはプッシュプロバイダーで通知を再登録してください。

即時の登録解除呼び出しを避ける

OSまたはプッシュプロバイダーでプッシュ通知を登録した直後にlogoutまたはunregisterPushを呼び出すことは避けてください。非同期のサーバー処理により、まれにプッシュトークンがBrazeユーザーに再追加される可能性があります。

プッシュ登録解除

追加の自動クリーンアップなしにデバイスへのプッシュ送信を停止するには、unregisterPushメソッドを使用します。これにより、Brazeサーバー上の現在のユーザーからデバイスのプッシュトークンが削除され、ローカルに保存されたトークンがクリアされます。

• swift
• objective-c

1
2
3
4
5
6
7
8
9
// Completion handler
AppDelegate.braze?.notifications.unregisterPush { result in
  switch result {
  case .success:
    print("Push unregistered successfully")
  case .failure(let error):
    print("Push unregistration failed: \(error.message), isRetriable: \(error.isRetriable)")
  }
}

1
2
3
4
5
6
7
// Async/await
do {
  try await AppDelegate.braze?.notifications.unregisterPush()
  print("Push unregistered successfully")
} catch let error as Braze.PushUnregistrationError {
  print("Push unregistration failed: \(error.message), isRetriable: \(error.isRetriable)")
}

1
2
3
4
5
6
7
8
[AppDelegate.braze.notifications unregisterPushWithCompletion:^(NSError * _Nullable error) {
  if (error) {
    NSNumber *isRetriable = error.userInfo[BRZPushUnregistrationErrorUserInfoKey.isRetriable];
    NSNumber *statusCode = error.userInfo[BRZPushUnregistrationErrorUserInfoKey.httpStatusCode];
    NSLog(@"Push unregistration failed: %@, isRetriable=%@ status=%@",
          error.localizedDescription, isRetriable, statusCode);
  }
}];

unregisterPush後にプッシュを再登録する

unregisterPushを呼び出した後、Brazeプッシュ通知を再度送信する前に、Swiftプッシュ設定に従ってOSまたはプッシュプロバイダーで通知を再登録してください。

即時の登録解除呼び出しを避ける

OSまたはプッシュプロバイダーでプッシュ通知を登録した直後にlogoutまたはunregisterPushを呼び出すことは避けてください。非同期のサーバー処理により、まれにプッシュトークンがBrazeユーザーに再追加される可能性があります。

Live Activitiesのpush-to-startトークンの登録解除

Live Activitiesは、push-to-startトークンを使用してリモートで開始できます。Brazeがデバイス上でLive Activitiesをリモートで開始することを停止するには、unregisterPushToStartメソッドを呼び出して、現在登録されているすべてのタイプ（デフォルト）または指定されたActivityタイプのリストの登録を解除します。

現在実行中のLive Activitiesは引き続き更新を受信し、このメソッドは新しいアクティビティをリモートで開始する機能のみを削除します。Live Activitiesの詳細については、Live Activitiesを参照してください。

注

Live ActivityのregisterPushToStartを呼び出した直後にlogoutまたはunregisterPushToStartを呼び出すことは避けてください。非同期のサーバー処理の性質上、まれにpush-to-startトークンがBrazeユーザーに再追加される可能性があります。

以下の例は、すべてのpush-to-startアクティビティタイプの登録を解除する方法を示しています。サインアウトしたユーザーがリモートで開始される新しいLive Activitiesを受信しないようにする場合に使用してください。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
// Unregister all currently-registered activity types
// Completion handler
AppDelegate.braze?.liveActivities.unregisterPushToStart { result in
  switch result {
  case .success:
    print("Push-to-start unregistered successfully")
  case .failure(let error):
    print("Push-to-start unregistration failed: \(error.message), isRetriable: \(error.isRetriable)")
  }
}

// Async/await
do {
  try await AppDelegate.braze?.liveActivities.unregisterPushToStart()
  print("Push-to-start unregistered successfully")
} catch let error as Braze.PushUnregistrationError {
  print("Push-to-start unregistration failed: \(error.message), isRetriable: \(error.isRetriable)")
}

以下の例は、特定のアクティビティタイプの登録を解除する方法を示しています。選択したLive Activitiesのみリモートでの開始を停止する場合に使用してください。

1
2
3
4
5
6
7
8
9
// Unregister specific activity types
AppDelegate.braze?.liveActivities.unregisterPushToStart(types: ["ActivityType1", "ActivityType2"]) { result in
  switch result {
  case .success:
    print("Push-to-start unregistered successfully")
  case .failure(let error):
    print("Push-to-start unregistration failed: \(error.message), isRetriable: \(error.isRetriable)")
  }
}

注

unregisterPushToStartにはOBJECTIVE-C APIがありません。Live ActivitiesはSwift専用の型に依存しているためです。

IDFVの収集

以前のバージョンのBraze iOS SDKでは、IDFV（Identifier for Vendor）フィールドはユーザーのデバイスIDとして自動的に収集されていました。Swift SDK v5.7.0以降、IDFVフィールドはオプションで無効化でき、代わりにBrazeがランダムなUUIDをデバイスIDとして設定するようになりました。Swift SDK v7.0.0以降、IDFVフィールドはデフォルトでは収集されず、代わりにUUIDがデバイスIDとして設定されます。

useUUIDAsDeviceId機能は、Swift SDKがデバイスIDをUUIDとして設定するように構成します。従来、iOS SDKはAppleが生成したIDFV値と同じデバイスIDを割り当てていました。この機能がiOSアプリでデフォルトで有効になっている場合、SDKを通じて作成されたすべての新規ユーザーには、UUIDと同じデバイスIDが割り当てられます。

IDFVを個別に収集したい場合は、set(identifierforvendor:)を使用できます。

注

braze.deviceIdの読み取りは、SDKが初期化後の処理を完了するまで呼び出しスレッドをブロックします。メインスレッドやレイテンシに敏感なコンテキストでは、代わりにノンブロッキングの代替手段を使用してください。

• swift
• objective-c

1
2
3
4
5
6
7
// Completion handler — always delivers on the main thread.
AppDelegate.braze?.getDeviceId { deviceId in
  print("Device ID:", deviceId)
}

// Async/await (iOS 13.0+, tvOS 13.0+, watchOS 6.0+, macOS 10.15+)
let deviceId = await AppDelegate.braze?.getDeviceId()

1
2
3
4
// Completion handler — always delivers on the main thread.
[AppDelegate.braze getDeviceIdWithCompletion:^(NSString *deviceId) {
  NSLog(@"Device ID: %@", deviceId);
}];

考慮事項

SDKバージョン

Swift SDK v7.0.0+では、useUUIDAsDeviceIdが有効（デフォルト）の場合、新規に作成されたすべてのユーザーにランダムなデバイスIDが割り当てられます。既存のすべてのユーザーは、IDFVであった可能性のある同じデバイスID値を維持します。

この機能が有効でない場合、デバイスには引き続き作成時にIDFVが割り当てられます。

ダウンストリーム

テクノロジーパートナー：この機能が有効な場合、BrazeデバイスIDからIDFV値を取得しているテクノロジーパートナーは、このデータにアクセスできなくなります。パートナー連携にデバイスから取得したIDFV値が必要な場合は、この機能をfalseに設定することをお勧めします。

Currents：useUUIDAsDeviceIdをtrueに設定すると、Currentsで送信されるデバイスIDはIDFV値と一致しなくなります。

よくある質問

この変更はBrazeの既存ユーザーに影響しますか？

いいえ。この機能を有効にしても、Brazeのユーザーデータは上書きされません。新しいUUIDデバイスIDは、新しいデバイスまたはwipedata()が呼び出された場合にのみ作成されます。

この機能を有効にした後に無効にできますか？

はい、この機能はいつでもオンとオフを切り替えることができます。以前に保存されたデバイスIDが上書きされることはありません。

Brazeの他の場所でIDFV値を取得することはできますか？

はい、Swift SDKを通じてIDFVをオプションで収集することは引き続き可能です（デフォルトでは収集は無効になっています）。