Administrar la recopilación de datos

El manifiesto de privacidad de Apple

¿Qué son los datos de seguimiento?

Apple define los “datos de seguimiento” como los datos recopilados en tu aplicación sobre un usuario final o dispositivo que están vinculados a datos de terceros (como publicidad dirigida), o a un intermediario de datos. Para una definición completa con ejemplos, consulta Apple: Seguimiento.

De manera predeterminada, el SDK de Braze no recopila datos de seguimiento. Sin embargo, dependiendo de la configuración de tu SDK de Braze, es posible que tengas que incluir datos específicos de Braze en el manifiesto de privacidad de tu aplicación.

¿Qué es un manifiesto de privacidad?

Un manifiesto de privacidad es un archivo de tu proyecto Xcode que describe el motivo por el que tu aplicación y los SDK de terceros recopilan datos, junto con sus métodos de recopilación de datos. Cada uno de tus SDK de terceros que hace un seguimiento de datos requiere su propio manifiesto de privacidad. Cuando creas el informe de privacidad de tu aplicación, estos archivos de manifiesto de privacidad se agregan automáticamente en un único informe.

Dominios de datos de seguimiento de la API

A partir de iOS 17.2, Apple bloqueará todos los endpoints de seguimiento declarados en tu aplicación hasta que el usuario final acepte un aviso de Transparencia de seguimiento de anuncios (ATT). Braze proporciona endpoints de seguimiento para dirigir tus datos de seguimiento, a la vez que te permite dirigir datos propios que no son de seguimiento al endpoint original.

Declarar datos de seguimiento de Braze

Consejo

Para un tutorial completo, consulta el tutorial de datos de seguimiento de privacidad.

Requisitos previos

Se requiere la siguiente versión del SDK de Braze para implementar esta característica:

Paso 1: Revisa tus políticas actuales

Revisa las políticas actuales de recopilación de datos del SDK de Braze con tu equipo legal para determinar si tu aplicación recopila datos de seguimiento según la definición de Apple. Si no estás recopilando ningún dato de seguimiento, no necesitas personalizar tu manifiesto de privacidad para el SDK de Braze en este momento. Para más información sobre las políticas de recopilación de datos del SDK de Braze, consulta Recopilación de datos del SDK.

Importante

Si alguno de tus SDK que no son de Braze recopila datos de seguimiento, deberás revisar esas políticas por separado.

Paso 2: Crea un manifiesto de privacidad

Primero, comprueba si ya tienes un manifiesto de privacidad buscando un archivo PrivacyInfo.xcprivacy en tu proyecto de Xcode. Si ya tienes este archivo, puedes continuar con el siguiente paso. De lo contrario, consulta Apple: Crear un manifiesto de privacidad.

Paso 3: Añade tu endpoint al manifiesto de privacidad

En tu proyecto de Xcode, abre el archivo PrivacyInfo.xcprivacy de tu aplicación, luego haz clic derecho en la tabla y marca Raw Keys and Values.

En App Privacy Configuration, elige NSPrivacyTracking y establece su valor en YES.

En App Privacy Configuration, elige NSPrivacyTrackingDomains. En el arreglo de dominios, añade un nuevo elemento y establece su valor en el endpoint que añadiste previamente a tu AppDelegate con el prefijo sdk-tracking.

Paso 4: Declara tus datos de seguimiento

A continuación, abre AppDelegate.swift y lista cada propiedad de seguimiento que desees declarar creando una lista de seguimiento estática o dinámica. Ten en cuenta que Apple bloqueará estas propiedades hasta que el usuario final acepte el aviso de ATT, así que solo lista las propiedades que tú y tu equipo legal consideren como datos de seguimiento. Por ejemplo:

• ejemplo estático
• ejemplo dinámico

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]
    )
  }
}

Paso 5: Evita bucles de reintento infinitos

Para evitar que el SDK entre en un bucle de reintento infinito, usa el método set(adTrackingEnabled: enableAdTracking) para gestionar los permisos de ATT. La propiedad adTrackingEnabled en tu método de SceneDelegate.swift debe gestionarse de forma similar a lo siguiente:

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)
    }
}

Desactivar el seguimiento de datos

Para desactivar la actividad de seguimiento de datos en el SDK de Swift, establece la propiedad enabled en false en tu instancia de Braze. Cuando enabled se establece en false, el SDK de Braze ignora cualquier llamada a la API pública. El SDK también cancela todas las acciones en curso, como solicitudes de red, procesamiento de eventos, etc.

Borrar datos almacenados previamente

Puedes usar el método wipeData() para borrar completamente los datos del SDK almacenados localmente en el dispositivo de un usuario.

Para las versiones 7.0.0 y posteriores de Braze Swift, el SDK y el método wipeData() generan aleatoriamente un UUID para el ID de dispositivo. Sin embargo, si tu useUUIDAsDeviceId está configurado como false o estás usando la versión 5.7.0 o anterior del SDK de Swift, también necesitarás hacer una solicitud post a /users/delete ya que tu identificador de proveedores (IDFV) se usará automáticamente como el ID de dispositivo de ese usuario.

Si usas la integración push manual y tu aplicación llama a wipeData() y posteriormente vuelve a habilitar el SDK en la misma ejecución de la aplicación, llama a registerForRemoteNotifications() de nuevo para que Braze pueda recibir un token de dispositivo actualizado. Para más información, consulta configurar notificaciones push.

Reanudación del seguimiento de datos

Para reanudar la recopilación de datos, establece enabled en true. Ten en cuenta que esto no restaurará ningún dato previamente borrado.

Cierre de sesión y cancelación del registro push

El SDK de Braze proporciona métodos para dejar de dirigirse a un dispositivo cuando un usuario cancela su registro de notificaciones push o cierra sesión. Estos métodos eliminan los datos de registro push del usuario actual en el servidor de Braze y en el SDK, de modo que Braze ya no envía futuras Campaigns de notificaciones push a ese usuario.

Cierre de sesión

Cuando un usuario cierra sesión en una aplicación, llama al método logout del SDK para eliminar el registro push del dispositivo del usuario actual y realizar automáticamente acciones de limpieza en el SDK. El método logout realiza lo siguiente:

• Cancela el registro del token push del dispositivo, y cualquier token push-to-start de Live Activities, del usuario actual en el servidor de Braze.
• Si la llamada de cancelación de registro tiene éxito, el SDK borra los datos del SDK almacenados localmente y desactiva el SDK.
• En caso de fallo, genera un error y una bandera isRetriable para permitir al integrador tomar acción.

• 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);
  }
}];

Reactivar el seguimiento y push después de logout

Después de un logout exitoso, establece enabled de nuevo en true, luego vuelve a registrarte para notificaciones con tu sistema operativo (SO) o proveedor push siguiendo la configuración push de Swift.

Evitar llamadas de cancelación de registro inmediatas

Evita llamar a logout o unregisterPush directamente después de registrarte para notificaciones push con el SO o proveedor push. Debido al procesamiento asíncrono del servidor, esto puede, en raras ocasiones, volver a agregar el token push al usuario de Braze.

Cancelar el registro push

Para dejar de enviar push a un dispositivo sin limpieza automatizada adicional, usa el método unregisterPush. Esto elimina el token push del dispositivo del usuario actual en el servidor de Braze y borra el token almacenado localmente.

• 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);
  }
}];

Volver a registrar push después de unregisterPush

Después de llamar a unregisterPush, vuelve a registrarte para notificaciones con tu SO o proveedor push siguiendo la configuración push de Swift antes de enviar notificaciones push de Braze nuevamente.

Evitar llamadas de cancelación de registro inmediatas

Evita llamar a logout o unregisterPush directamente después de registrarte para notificaciones push con el SO o proveedor push. Debido al procesamiento asíncrono del servidor, esto puede, en raras ocasiones, volver a agregar el token push al usuario de Braze.

Cancelar el registro de tokens push-to-start para Live Activities

Las Live Activities pueden iniciarse de forma remota usando tokens push-to-start. Para evitar que Braze inicie remotamente Live Activities en un dispositivo, llama al método unregisterPushToStart para cancelar el registro de todos los tipos registrados actualmente (predeterminado) o de una lista específica de tipos de Activity.

Ten en cuenta que las Live Activities que se están ejecutando actualmente siguen recibiendo actualizaciones y que este método solo elimina la capacidad de iniciar nuevas actividades de forma remota. Para más información sobre Live Activities, consulta Live Activities.

Nota

Evita llamar a logout o unregisterPushToStart directamente después de llamar a registerPushToStart para una Live Activity. Debido a la naturaleza asíncrona del procesamiento del servidor, en raras ocasiones, esto puede provocar que el token push-to-start se vuelva a agregar al usuario de Braze.

El siguiente ejemplo muestra cómo cancelar el registro de todos los tipos de actividad push-to-start. Úsalo cuando un usuario que ha cerrado sesión ya no deba recibir nuevas Live Activities iniciadas de forma remota.

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)")
}

El siguiente ejemplo muestra cómo cancelar el registro de tipos de actividad específicos. Úsalo cuando solo determinadas Live Activities deban dejar de iniciarse de forma remota.

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)")
  }
}

Nota

unregisterPushToStart no tiene una API de Objective-C, ya que las Live Activities dependen de tipos exclusivos de Swift.

Recopilación de IDFV

En versiones anteriores del SDK de Braze para iOS, el campo IDFV (Identifier for Vendor) se recopilaba automáticamente como el ID de dispositivo del usuario. A partir del SDK Swift v5.7.0, el campo IDFV podía deshabilitarse opcionalmente y, en su lugar, Braze establecía un UUID aleatorio como ID de dispositivo. A partir del SDK Swift v7.0.0, el campo IDFV no se recopila de forma predeterminada y, en su lugar, se establece un UUID como ID de dispositivo.

La característica useUUIDAsDeviceId configura el SDK Swift para establecer el ID de dispositivo como un UUID. Tradicionalmente, el SDK de iOS asignaba el ID de dispositivo igual al valor IDFV generado por Apple. Con esta característica habilitada de forma predeterminada en tu aplicación iOS, a todos los nuevos usuarios creados a través del SDK se les asignará un ID de dispositivo igual a un UUID.

Si aún deseas recopilar el IDFV por separado, puedes usar set(identifierforvendor:).

Nota

La lectura de braze.deviceId bloquea el hilo de llamada hasta que el SDK haya completado sus operaciones posteriores a la inicialización. Para contextos del hilo principal o sensibles a la latencia, usa las alternativas no bloqueantes en su lugar.

• 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);
}];

Consideraciones

Versión del SDK

En el SDK Swift v7.0.0+, cuando useUUIDAsDeviceId está habilitado (predeterminado), a todos los nuevos usuarios creados se les asignará un ID de dispositivo aleatorio. Todos los usuarios existentes previamente mantendrán su mismo valor de ID de dispositivo, que puede haber sido IDFV.

Cuando esta característica no está habilitada, los dispositivos seguirán recibiendo IDFV asignado en el momento de la creación.

Impacto posterior

Partners tecnológicos: cuando esta característica está habilitada, cualquier partner tecnológico que derive el valor IDFV del ID de dispositivo de Braze ya no tendrá acceso a estos datos. Si el valor IDFV derivado del dispositivo es necesario para tu integración del partner, te recomendamos que establezcas esta característica en false.

Currents: useUUIDAsDeviceId establecido en true significa que el ID de dispositivo enviado en Currents ya no será igual al valor IDFV.

Preguntas frecuentes

¿Este cambio afectará a mis usuarios existentes en Braze?

No. Cuando está habilitada, esta característica no sobrescribirá ningún dato de usuario en Braze. Los nuevos ID de dispositivo UUID solo se crearán para nuevos dispositivos o cuando se llame a wipedata().

¿Puedo desactivar esta característica después de activarla?

Sí, esta característica se puede activar y desactivar a tu discreción. Los ID de dispositivo almacenados previamente nunca se sobrescribirán.

¿Puedo seguir capturando el valor IDFV a través de Braze en otro lugar?

Sí, aún puedes recopilar opcionalmente el IDFV a través del SDK Swift (la recopilación está deshabilitada de forma predeterminada).