Ir al contenido

Esta página fue traducida automáticamente y puede contener errores. Para informar de un error de traducción, usa el componente de comentarios situado bajo el sumario, a la derecha de la página.

Establecer atributos del usuario

Aprende a establecer los atributos de usuario a través del SDK de Braze.

Nota

Para los SDK envolventes que no aparecen en la lista, utiliza el método nativo de Android o Swift correspondiente.

Requisitos previos

Antes de poder utilizar esta característica, tendrás que integrar el SDK Web de Braze.

Atributos predeterminados del usuario

Métodos predefinidos

Braze proporciona métodos predefinidos para configurar los siguientes atributos de usuario dentro de la clase User:

Nombre
Apellido
Idioma
País
Fecha de nacimiento
Correo electrónico
Género
Ciudad natal
Número de teléfono

Configuración de atributos predeterminados

usando métodos
google tag manager

Para establecer un atributo predeterminado de un usuario, llama al método getUser() en tu instancia de Braze para obtener una referencia al usuario actual de tu aplicación. A continuación, puedes llamar a los métodos para establecer un atributo de usuario.

braze.getUser().setFirstName("SomeFirstName");

braze.getUser().setGender(braze.User.Genders.FEMALE);

braze.getUser().setDateOfBirth(2000, 12, 25);

Al usar Google Tag Manager, los atributos estándar del usuario (como el nombre del usuario) deben registrarse de la misma manera que los atributos personalizados del usuario. Asegúrate de que los valores que estás pasando para los atributos estándar coincidan con el formato esperado especificado en la documentación de la clase User.

Por ejemplo, el atributo de género puede aceptar cualquiera de los siguientes valores: "m" | "f" | "o" | "u" | "n" | "p". Por lo tanto, para establecer el género de un usuario como femenino, crea una etiqueta HTML personalizada con el siguiente contenido:

<script>
window.braze.getUser().setGender("f")
</script>

Desactivar atributos predeterminados

Puedes eliminar o desactivar un atributo de usuario a través del código de tu aplicación, una solicitud a la REST API o un paso de actualización de usuario en Canvas. Para atributos de tipo arreglo y booleano, utiliza null. Para otros tipos de datos, utiliza una cadena vacía ("").

Para desactivar un atributo predeterminado del usuario con el SDK Web, pasa null al método correspondiente. Por ejemplo:

braze.getUser().setFirstName(null);

braze.getUser().setGender(null);

braze.getUser().setDateOfBirth(null, null, null);

Atributos personalizados del usuario

Además de los métodos predeterminados de atributos de usuario, también puedes establecer atributos personalizados para tus usuarios. Para conocer las especificaciones completas de los métodos, consulta nuestro JSDocs.

Para establecer un atributo personalizado con un valor string:

braze.getUser().setCustomUserAttribute(
  YOUR_ATTRIBUTE_KEY_STRING,
  YOUR_STRING_VALUE
);

Para establecer un atributo personalizado con un valor integer:

braze.getUser().setCustomUserAttribute(
  YOUR_ATTRIBUTE_KEY_STRING,
  YOUR_INT_VALUE
);

// Integer attributes may also be incremented using code like the following
braze.getUser().incrementCustomUserAttribute(
  YOUR_ATTRIBUTE_KEY_STRING,
  THE_INTEGER_VALUE_BY_WHICH_YOU_WANT_TO_INCREMENT_THE_ATTRIBUTE
);

Para establecer un atributo personalizado con un valor date:

braze.getUser().setCustomUserAttribute(
  YOUR_ATTRIBUTE_KEY_STRING,
  YOUR_DATE_VALUE
);

// This method will assign the current time to a custom attribute at the time the method is called
braze.getUser().setCustomUserAttribute(
  YOUR_ATTRIBUTE_KEY_STRING,
  new Date()
);

// This method will assign the date specified by secondsFromEpoch to a custom attribute
braze.getUser().setCustomUserAttribute(
  YOUR_ATTRIBUTE_KEY_STRING,
  new Date(secondsFromEpoch * 1000)
);

La cantidad máxima de elementos en un arreglo es 500 de forma predeterminada. Puedes actualizar la cantidad máxima de arreglos en el panel de Braze, en Configuración de datos > Atributos personalizados. Los arreglos que superen la cantidad máxima de elementos se truncan para contener la cantidad máxima de elementos.

Para establecer un atributo personalizado con un valor array:

braze.getUser().setCustomUserAttribute(YOUR_ATTRIBUTE_KEY_STRING, YOUR_ARRAY_OF_STRINGS);

// Adding a new element to a custom attribute with an array value
braze.getUser().addToCustomAttributeArray(YOUR_ATTRIBUTE_KEY_STRING, "new string");

// Removing an element from a custom attribute with an array value
braze.getUser().removeFromCustomAttributeArray(YOUR_ATTRIBUTE_KEY_STRING, "value to be removed");

Importante

Las fechas pasadas a Braze con este método deben ser objetos JavaScript Date.

Importante

Las claves y los valores de los atributos personalizados solo pueden tener un máximo de 255 caracteres. Para obtener más información sobre los valores válidos de atributos personalizados, consulta la documentación de referencia.

Los atributos personalizados de usuario no están disponibles debido a una limitación en el lenguaje de scripting de Google Tag Manager. Para registrar atributos personalizados, crea una etiqueta HTML personalizada con el siguiente contenido:

<script>
  // Note: If using SDK version 3.x or below, use `window.appboy` instead of `window.braze`
  // Version 4 or greater should use `window.braze`
window.braze.getUser().setCustomUserAttribute("attribute name", "attribute value");
</script>

Importante

La plantilla de GTM no admite propiedades anidadas en eventos o compras. Puedes usar el HTML anterior para registrar cualquier evento o compra que requiera propiedades anidadas.

Desactivar atributos personalizados

Para desactivar un atributo personalizado, pasa null al método correspondiente.

braze.getUser().setCustomUserAttribute(YOUR_ATTRIBUTE_KEY_STRING, null);

Anidar atributos personalizados

También puedes anidar propiedades dentro de atributos personalizados. En el siguiente ejemplo, un objeto favorite_book con propiedades anidadas se establece como un atributo personalizado en el perfil de usuario. Para más detalles, consulta Atributos personalizados anidados.

import * as braze from "@braze/web-sdk";

const favoriteBook = {
  title: "The Hobbit",
  author: "J.R.R. Tolkien",
  publishing_date: "1937"
};

braze.getUser().setCustomUserAttribute("favorite_book", favoriteBook);

Usar la REST API

También puedes usar nuestra REST API para establecer o desactivar atributos de usuario. Para obtener más información, consulta Endpoints de datos de usuario.

Configurar las suscripciones de usuario

Para configurar una suscripción para tus usuarios (ya sea de correo electrónico o push), llama a las funciones setEmailNotificationSubscriptionType() o setPushNotificationSubscriptionType(), respectivamente. Ambas funciones toman el tipo enum braze.User.NotificationSubscriptionTypes como argumento. Este tipo tiene tres estados diferentes:

Estado de suscripción	Definición
`braze.User.NotificationSubscriptionTypes.OPTED_IN`	Suscrito y con adhesión voluntaria explícita
`braze.User.NotificationSubscriptionTypes.SUBSCRIBED`	Suscrito, pero sin adhesión voluntaria explícita
`braze.User.NotificationSubscriptionTypes.UNSUBSCRIBED`	Dado de baja o con exclusión voluntaria explícita

Cuando un usuario se registra para push, el navegador le obliga a elegir entre permitir o bloquear las notificaciones, y si elige permitir push, se establece como OPTED_IN de forma predeterminada.

Visita Gestión de las suscripciones de usuario para obtener más información sobre la implementación de suscripciones y adhesiones voluntarias explícitas.

Cancelar la suscripción de correo electrónico de un usuario

braze.getUser().setEmailNotificationSubscriptionType(braze.User.NotificationSubscriptionTypes.UNSUBSCRIBED);

Cancelar la suscripción push de un usuario

braze.getUser().setPushNotificationSubscriptionType(braze.User.NotificationSubscriptionTypes.UNSUBSCRIBED);

Requisitos previos

Antes de poder utilizar esta característica, tendrás que integrar el SDK de Braze para Android.

Atributos predeterminados del usuario

Métodos predefinidos

Braze proporciona métodos predefinidos para configurar los siguientes atributos de usuario dentro de la clase BrazeUser. Para conocer las especificaciones de los métodos, consulta nuestro KDoc.

Nombre
Apellido
País
Idioma
Fecha de nacimiento
Correo electrónico
Género
Ciudad natal
Número de teléfono

Nota

Todos los valores de cadena como nombre, apellidos, país y ciudad natal están limitados a 255 caracteres.

Configuración de atributos predeterminados

Para establecer un atributo predeterminado de un usuario, llama al método getCurrentUser() en tu instancia de Braze para obtener una referencia al usuario actual de tu aplicación. A continuación, puedes llamar a los métodos para establecer un atributo de usuario.

java
kotlin

Braze.getInstance(context).getCurrentUser(new IValueCallback<BrazeUser>() {
  @Override
  public void onSuccess(BrazeUser brazeUser) {
    brazeUser.setFirstName("first_name");
  }
}

Braze.getInstance(context).getCurrentUser { brazeUser ->
  brazeUser.setFirstName("first_name")
}

Desactivar atributos predeterminados

Para desactivar un atributo de usuario, pasa null al método correspondiente.

java
kotlin

Braze.getInstance(context).getCurrentUser(new IValueCallback<BrazeUser>() {
  @Override
  public void onSuccess(BrazeUser brazeUser) {
    brazeUser.setFirstName(null);
  }
}

Braze.getInstance(context).getCurrentUser { brazeUser ->
  brazeUser.setFirstName(null)
}

Atributos personalizados del usuario

Además de los atributos predeterminados del usuario, Braze también te permite definir atributos personalizados utilizando distintos tipos de datos. Para obtener más información sobre las opciones de segmentación de cada atributo, consulta Recopilación de datos de usuario.

Establecer atributos personalizados

Para establecer un atributo personalizado con un valor string:

java
kotlin

Braze.getInstance(context).getCurrentUser(new IValueCallback<BrazeUser>() {
  @Override
  public void onSuccess(BrazeUser brazeUser) {
    brazeUser.setCustomUserAttribute("your_attribute_key", "your_attribute_value");
  }
}

Braze.getInstance(context).getCurrentUser { brazeUser ->
  brazeUser.setCustomUserAttribute("your_attribute_key", "your_attribute_value")
}

Para establecer un atributo personalizado con un valor int:

java
kotlin

Braze.getInstance(context).getCurrentUser(new IValueCallback<BrazeUser>() {
  @Override
  public void onSuccess(BrazeUser brazeUser) {
    brazeUser.setCustomUserAttribute("your_attribute_key", YOUR_INT_VALUE);

    // Integer attributes may also be incremented using code like the following:
    brazeUser.incrementCustomUserAttribute("your_attribute_key", YOUR_INCREMENT_VALUE);
  }
}

Braze.getInstance(context).getCurrentUser { brazeUser ->
  brazeUser.setCustomUserAttribute("your_attribute_key", YOUR_INT_VALUE)

  // Integer attributes may also be incremented using code like the following:
  brazeUser.incrementCustomUserAttribute("your_attribute_key", YOUR_INCREMENT_VALUE)
}

Para establecer un atributo personalizado con un valor entero long:

java
kotlin

Braze.getInstance(context).getCurrentUser(new IValueCallback<BrazeUser>() {
  @Override
  public void onSuccess(BrazeUser brazeUser) {
    brazeUser.setCustomUserAttribute("your_attribute_key", YOUR_LONG_VALUE);
  }
});

Braze.getInstance(context).getCurrentUser { brazeUser ->
  brazeUser.setCustomUserAttribute("your_attribute_key", YOUR_LONG_VALUE)
}

Para establecer un atributo personalizado con un valor float:

java
kotlin

Braze.getInstance(context).getCurrentUser(new IValueCallback<BrazeUser>() {
  @Override
  public void onSuccess(BrazeUser brazeUser) {
    brazeUser.setCustomUserAttribute("your_attribute_key", YOUR_FLOAT_VALUE);
  }
});

Braze.getInstance(context).getCurrentUser { brazeUser ->
  brazeUser.setCustomUserAttribute("your_attribute_key", YOUR_FLOAT_VALUE)
}

Para establecer un atributo personalizado con un valor double:

java
kotlin

Braze.getInstance(context).getCurrentUser(new IValueCallback<BrazeUser>() {
  @Override
  public void onSuccess(BrazeUser brazeUser) {
    brazeUser.setCustomUserAttribute("your_attribute_key", YOUR_DOUBLE_VALUE);
  }
});

Braze.getInstance(context).getCurrentUser { brazeUser ->
  brazeUser.setCustomUserAttribute("your_attribute_key", YOUR_DOUBLE_VALUE)
}

Para establecer un atributo personalizado con un valor boolean:

java
kotlin

Braze.getInstance(context).getCurrentUser(new IValueCallback<BrazeUser>() {
  @Override
  public void onSuccess(BrazeUser brazeUser) {
    brazeUser.setCustomUserAttribute("your_attribute_key", YOUR_BOOLEAN_VALUE);
  }
});

Braze.getInstance(context).getCurrentUser { brazeUser ->
  brazeUser.setCustomUserAttribute("your_attribute_key", YOUR_BOOLEAN_VALUE)
}

java
kotlin

Braze.getInstance(context).getCurrentUser(new IValueCallback<BrazeUser>() {
  @Override
  public void onSuccess(BrazeUser brazeUser) {
    brazeUser.setCustomUserAttribute("your_attribute_key", YOUR_DATE_VALUE);
    // This method will assign the current time to a custom attribute at the time the method is called:
    brazeUser.setCustomUserAttributeToNow("your_attribute_key");
    // This method will assign the date specified by SECONDS_FROM_EPOCH to a custom attribute:
    brazeUser.setCustomUserAttributeToSecondsFromEpoch("your_attribute_key", SECONDS_FROM_EPOCH);
  }
});

Braze.getInstance(context).getCurrentUser { brazeUser ->
  brazeUser.setCustomUserAttribute("your_attribute_key", YOUR_DATE_VALUE)
  // This method will assign the current time to a custom attribute at the time the method is called:
  brazeUser.setCustomUserAttributeToNow("your_attribute_key")
  // This method will assign the date specified by SECONDS_FROM_EPOCH to a custom attribute:
  brazeUser.setCustomUserAttributeToSecondsFromEpoch("your_attribute_key", SECONDS_FROM_EPOCH)
}

Advertencia

Las fechas pasadas a Braze con este método deben estar en formato ISO 8601 (por ejemplo, 2013-07-16T19:20:30+01:00) o en el formato yyyy-MM-dd'T'HH:mm:ss:SSSZ (por ejemplo, 2016-12-14T13:32:31.601-0800).

La cantidad predeterminada y máxima de elementos en un array es 500. Puedes actualizar la cantidad máxima de arrays en el panel de Braze, en Configuración de datos > Atributos personalizados. Los arrays que excedan la cantidad máxima de elementos se truncarán para contener la cantidad máxima de elementos. Para obtener más información sobre los arrays de atributos personalizados y su comportamiento, consulta Arrays.

java
kotlin

Braze.getInstance(context).getCurrentUser(new IValueCallback<BrazeUser>() {
  @Override
  public void onSuccess(BrazeUser brazeUser) {
    // Setting a custom attribute with an array value
    brazeUser.setCustomAttributeArray("your_attribute_key", testSetArray);
    // Adding to a custom attribute with an array value
    brazeUser.addToCustomAttributeArray("your_attribute_key", "value_to_add");
    // Removing a value from an array type custom attribute
    brazeUser.removeFromCustomAttributeArray("your_attribute_key", "value_to_remove");
  }
});

Braze.getInstance(context).getCurrentUser { brazeUser ->
  // Setting a custom attribute with an array value
  brazeUser.setCustomAttributeArray("your_attribute_key", testSetArray)
  // Adding to a custom attribute with an array value
  brazeUser.addToCustomAttributeArray("your_attribute_key", "value_to_add")
  // Removing a value from an array type custom attribute
  brazeUser.removeFromCustomAttributeArray("your_attribute_key", "value_to_remove")
}

Desactivar atributos personalizados

Para desactivar un atributo personalizado, pasa la clave del atributo correspondiente al método unsetCustomUserAttribute.

java
kotlin

Braze.getInstance(context).getCurrentUser(new IValueCallback<BrazeUser>() {
  @Override
  public void onSuccess(BrazeUser brazeUser) {
    brazeUser.unsetCustomUserAttribute("your_attribute_key");
  }
});

Braze.getInstance(context).getCurrentUser { brazeUser ->
  brazeUser.unsetCustomUserAttribute("your_attribute_key")
}

Anidar atributos personalizados

También puedes anidar propiedades dentro de atributos personalizados. En el siguiente ejemplo, se establece un objeto favorite_book con propiedades anidadas como atributo personalizado en el perfil de usuario. Para obtener más detalles, consulta Atributos personalizados anidados.

java
kotlin

JSONObject favoriteBook = new JSONObject();
try {
  favoriteBook.put("title", "The Hobbit");
  favoriteBook.put("author", "J.R.R. Tolkien");
  favoriteBook.put("publishing_date", "1937");
} catch (JSONException e) {
  e.printStackTrace();
}

braze.getCurrentUser(user -> {
  user.setCustomUserAttribute("favorite_book", favoriteBook);
  return null;
});

val favoriteBook = JSONObject()
  .put("title", "The Hobbit")
  .put("author", "J.R.R. Tolkien")
  .put("publishing_date", "1937")

braze.getCurrentUser { user ->
  user.setCustomUserAttribute("favorite_book", favoriteBook)
}

Uso de la REST API

También puedes usar nuestra REST API para establecer o desactivar atributos de usuario. Para obtener más información, consulta Endpoints de datos de usuario.

Configurar las suscripciones de usuario

Para configurar una suscripción para tus usuarios (ya sea de correo electrónico o push), llama a las funciones setEmailNotificationSubscriptionType() o setPushNotificationSubscriptionType(), respectivamente. Ambas funciones toman el tipo de enumeración NotificationSubscriptionType como argumento. Este tipo tiene tres estados diferentes:

Estado de suscripción	Definición
`OPTED_IN`	Suscrito y con adhesión voluntaria explícita
`SUBSCRIBED`	Suscrito, pero sin adhesión voluntaria explícita
`UNSUBSCRIBED`	Cancelada la suscripción o con exclusión voluntaria explícita

Importante

Android no requiere una adhesión voluntaria explícita para enviar notificaciones push a los usuarios. Cuando un usuario se registra para push, se establece como SUBSCRIBED en lugar de OPTED_IN de forma predeterminada. Consulta gestionar las suscripciones de usuario para obtener más información sobre la implementación de suscripciones y adhesiones voluntarias explícitas.

Configurar suscripciones de correo electrónico

java
kotlin

Braze.getInstance(context).getCurrentUser(new IValueCallback<BrazeUser>() {
  @Override
  public void onSuccess(BrazeUser brazeUser) {
    brazeUser.setEmailNotificationSubscriptionType(emailNotificationSubscriptionType);
  }
});

Braze.getInstance(context).getCurrentUser { brazeUser ->
  brazeUser.setEmailNotificationSubscriptionType(emailNotificationSubscriptionType)
}

Configurar la suscripción a notificaciones push

java
kotlin

Braze.getInstance(context).getCurrentUser(new IValueCallback<BrazeUser>() {
  @Override
  public void onSuccess(BrazeUser brazeUser) {
    brazeUser.setPushNotificationSubscriptionType(pushNotificationSubscriptionType);
  }
});

Braze.getInstance(context).getCurrentUser { brazeUser ->
  brazeUser.setPushNotificationSubscriptionType(pushNotificationSubscriptionType)
}

Requisitos previos

Antes de poder utilizar esta característica, tendrás que integrar el SDK Swift de Braze.

Atributos predeterminados del usuario

Atributos admitidos

Los siguientes atributos deben establecerse en el objeto Braze.User:

firstName
lastName
email
dateOfBirth
country
language
homeCity
phone
gender

Configuración de atributos predeterminados

Para establecer un atributo predeterminado del usuario, configura el campo correspondiente en el objeto compartido Braze.User. A continuación se muestra un ejemplo de configuración del atributo de nombre:

swift
objective-c

AppDelegate.braze?.user.set(firstName: "Alex")

[AppDelegate.braze.user setFirstName:@"Alex"];

Desactivar atributos predeterminados

Para desactivar un atributo predeterminado del usuario, pasa nil al método correspondiente.

swift
objective-c

AppDelegate.braze?.user.set(firstName: nil)

[AppDelegate.braze.user setFirstName:nil];

Atributos personalizados del usuario

Importante

Los valores de los atributos personalizados tienen una longitud máxima de 255 caracteres; los valores más largos se truncarán. Para obtener más información, consulta Braze.User.

Establecer atributos personalizados

Para establecer un atributo personalizado con un valor string:

swift
objective-c

AppDelegate.braze?.user.setCustomAttribute(key: "your_attribute_key", value: "your_attribute_value")

[AppDelegate.braze.user setCustomAttributeWithKey:@"your_attribute_key" stringValue:"your_attribute_value"];

Para establecer un atributo personalizado con un valor integer:

swift
objective-c

AppDelegate.braze?.user.setCustomAttribute(key: "your_attribute_key", value: yourIntegerValue)

[AppDelegate.braze.user setCustomAttributeWithKey:@"your_attribute_key" andIntegerValue:yourIntegerValue];

Braze trata los valores float y double de la misma manera dentro de nuestra base de datos. Para establecer un atributo personalizado con un valor double:

swift
objective-c

AppDelegate.braze?.user.setCustomAttribute(key: "your_attribute_key", value: yourDoubleValue)

[AppDelegate.braze.user setCustomAttributeWithKey:@"your_attribute_key" andDoubleValue:yourDoubleValue];

Para establecer un atributo personalizado con un valor boolean:

swift
objective-c

AppDelegate.braze?.user.setCustomAttribute("your_attribute_key", value: yourBoolValue)

[AppDelegate.braze.user setCustomAttributeWithKey:@"your_attribute_key" andBOOLValue:yourBOOLValue];

Para establecer un atributo personalizado con un valor date:

swift
objective-c

AppDelegate.braze?.user.setCustomAttribute("your_attribute_key", dateValue:yourDateValue)

[AppDelegate.braze.user setCustomAttributeWithKey:@"your_attribute_key" andDateValue:yourDateValue];

La cantidad predeterminada y máxima de elementos en un arreglo es de 500. Puedes actualizar la cantidad máxima de arreglos en el panel de Braze, en Configuración de datos > Atributos personalizados. Los arreglos que excedan la cantidad máxima de elementos se truncarán para contener la cantidad máxima de elementos.

Para establecer un atributo personalizado con un valor array:

swift
objective-c

// Setting a custom attribute with an array value
AppDelegate.braze?.user.setCustomAttributeArray(key: "array_name", array: ["value1",  "value2"])
// Adding to a custom attribute with an array value
AppDelegate.braze?.user.addToCustomAttributeArray(key: "array_name", value: "value3")
// Removing a value from an array type custom attribute
AppDelegate.braze?.user.removeFromCustomAttributeArray(key: "array_name", value: "value2")

// Setting a custom attribute with an array value
[AppDelegate.braze.user setCustomAttributeArrayWithKey:@"array_name" array:@[@"value1",  @"value2"]];
// Adding to a custom attribute with an array value
[AppDelegate.braze.user addToCustomAttributeArrayWithKey:@"array_name" value:@"value3"];
// Removing a value from an array type custom attribute
[AppDelegate.braze.user removeFromCustomAttributeArrayWithKey:@"array_name" value:@"value2"];
// Removing an entire array and key
[AppDelegate.braze.user setCustomAttributeArrayWithKey:@"array_name" array:nil];

Incrementar o decrementar atributos personalizados

Este código es un ejemplo de un atributo personalizado que se incrementa. Puedes incrementar el valor de un atributo personalizado con cualquier valor integer o long:

swift
objective-c

AppDelegate.braze?.user.incrementCustomUserAttribute(key: "your_attribute_key", by: incrementIntegerValue)

[AppDelegate.braze.user incrementCustomUserAttribute:@"your_attribute_key" by:incrementIntegerValue];

Desactivar atributos personalizados

swift
objective-c

Para desactivar un atributo personalizado, pasa la clave de atributo correspondiente al método unsetCustomAttribute.

AppDelegate.braze?.user.unsetCustomAttribute(key: "your_attribute_key")

Para desactivar un atributo personalizado, pasa la clave de atributo correspondiente al método unsetCustomAttributeWithKey.

[AppDelegate.braze.user unsetCustomAttributeWithKey:@"your_attribute_key"];

Anidar atributos personalizados

swift
objective-c

let favoriteBook: [String: Any?] = [
  "title": "The Hobbit",
  "author": "J.R.R. Tolkien",
  "publishing_date": "1937"
]

braze.user.setCustomAttribute(key: "favorite_book", dictionary: favoriteBook)

NSDictionary *favoriteBook = @{
  @"title": @"The Hobbit",
  @"author": @"J.R.R. Tolkien",
  @"publishing_date": @"1937"
};

[AppDelegate.braze.user setCustomAttributeWithKey:@"favorite_book" dictionary:favoriteBook];

Uso de la REST API

También puedes utilizar nuestra REST API para establecer o desactivar atributos de usuario. Para obtener más información, consulta Endpoints de datos de usuario.

Configuración de suscripciones de usuario

Para configurar una suscripción para tus usuarios (ya sea de correo electrónico o push), llama a las funciones set(emailSubscriptionState:) o set(pushNotificationSubscriptionState:), respectivamente. Ambas funciones toman el tipo de enumeración Braze.User.SubscriptionState como argumento. Este tipo tiene tres estados diferentes:

Estado de suscripción	Definición
`optedIn`	Suscrito y con adhesión voluntaria explícita
`subscribed`	Suscrito, pero sin adhesión voluntaria explícita
`unsubscribed`	Dado de baja o con exclusión voluntaria explícita

Los usuarios que otorgan permiso a una aplicación para enviarles notificaciones push tienen de forma predeterminada el estado optedIn, ya que iOS requiere una adhesión voluntaria explícita.

Los usuarios se configurarán como subscribed automáticamente al recibir una dirección de correo electrónico válida; sin embargo, te sugerimos que establezcas un proceso de adhesión voluntaria explícito y configures este valor como optedIn cuando recibas el consentimiento explícito de tu usuario. Consulta Gestión de suscripciones de usuario para más detalles.

Configuración de suscripciones de correo electrónico

swift
objective-c

AppDelegate.braze?.user.set(emailSubscriptionState: Braze.User.SubscriptionState)

[AppDelegate.braze.user setEmailSubscriptionState: BRZUserSubscriptionState]

Configuración de suscripciones de notificaciones push

swift
objective-c

AppDelegate.braze?.user.set(pushNotificationSubscriptionState: Braze.User.SubscriptionState)

[AppDelegate.braze.user setPushNotificationSubscriptionState: BRZUserSubscriptionState]

Consulta Gestión de suscripciones de usuario para más detalles.

Requisitos previos

Antes de poder utilizar esta característica, tendrás que integrar el SDK de Flutter de Braze.

Atributos predeterminados del usuario

Atributos admitidos

Se admiten los siguientes atributos:

Nombre
Apellido
Género
Fecha de nacimiento
Ciudad natal
País
Número de teléfono
Idioma
Correo electrónico

Importante

Todos los valores de cadena como nombre, apellidos, país y ciudad de residencia están limitados a 255 caracteres.

Configuración de atributos predeterminados

Para configurar los atributos de usuario recogidos automáticamente por Braze, puedes utilizar los métodos de configuración incluidos en el SDK.

braze.setFirstName('Name');

Atributos personalizados del usuario

Establecer atributos personalizados

Además de los atributos de usuario predeterminados, Braze también te permite definir atributos personalizados utilizando distintos tipos de datos:

Para establecer un atributo personalizado con un valor string:

braze.setStringCustomUserAttribute("custom string attribute", "string custom attribute");

Para establecer un atributo personalizado con un valor integer:

// Set Integer Attribute
braze.setIntCustomUserAttribute("custom int attribute key", integer);
// Increment Integer Attribute
braze.incrementCustomUserAttribute("key", integer);

Para establecer un atributo personalizado con un valor double:

braze.setDoubleCustomUserAttribute("custom double attribute key", double);

Para establecer un atributo personalizado con un valor boolean:

braze.setBoolCustomUserAttribute("custom boolean attribute key", boolean);

Para establecer un atributo personalizado con un valor date:

braze.setDateCustomUserAttribute("custom date attribute key", date);

Para establecer un atributo personalizado con un valor array:

// Adding to an Array
braze.addToCustomAttributeArray("key", "attribute");
// Removing an item from an Array
braze.removeFromCustomAttributeArray("key", "attribute");

Importante

Los valores de atributos personalizados tienen una longitud máxima de 255 caracteres; los valores más largos se truncarán.

Desactivar atributos personalizados

Para desactivar un atributo personalizado, pasa la clave del atributo correspondiente al método unsetCustomUserAttribute.

braze.unsetCustomUserAttribute('attribute_key');

Requisitos previos

Antes de poder utilizar esta característica, tendrás que integrar el SDK de Roku de Braze.

Atributos predeterminados del usuario

Métodos predefinidos

Braze proporciona métodos predefinidos para configurar los siguientes atributos de usuario utilizando el objeto m.Braze.

FirstName
LastName
Email
Gender
DateOfBirth
Country
Language
HomeCity
PhoneNumber

Configuración de atributos predeterminados

Para establecer un atributo predeterminado, llama al método correspondiente en el objeto m.Braze.

m.Braze.setFirstName("Alex")

m.Braze.setLastName("Smith")

m.Braze.setEmail("[email protected]")

m.Braze.setGender("m") ' Accepts: "m", "f", "o", "n", "u", "p"

m.Braze.setDateOfBirth(1990, 5, 15) ' Year, month, day

m.Braze.setCountry("United States")

m.Braze.setLanguage("en")

m.Braze.setHomeCity("New York")

m.Braze.setPhoneNumber("+1234567890")

Atributos personalizados del usuario

Además de los atributos predeterminados del usuario, Braze también te permite definir atributos personalizados utilizando distintos tipos de datos.

Configuración de atributos personalizados

Para establecer un atributo personalizado con un valor string:

m.Braze.setCustomAttribute("stringAttribute", "stringValue")

Para establecer un atributo personalizado con un valor integer:

m.Braze.setCustomAttribute("intAttribute", 5)

Braze trata los valores float y double exactamente de la misma manera. Para establecer un atributo personalizado con cualquiera de estos valores:

m.Braze.setCustomAttribute("floatAttribute", 3.5)

Para establecer un atributo personalizado con un valor boolean:

m.Braze.setCustomAttribute("boolAttribute", true)

Para establecer un atributo personalizado con un valor date:

dateAttribute = CreateObject("roDateTime")
dateAttribute.fromISO8601String("1992-11-29 00:00:00.000")
m.Braze.setCustomAttribute("dateAttribute", dateAttribute)

Para establecer un atributo personalizado con un valor array:

stringArray = createObject("roArray", 3, true)
stringArray.Push("string1")
stringArray.Push("string2")
stringArray.Push("string3")
m.Braze.setCustomAttribute("arrayAttribute", stringArray)

Importante

Los valores de atributos personalizados tienen una longitud máxima de 255 caracteres; los valores más largos se truncarán.

Incrementar y decrementar atributos personalizados

Este código es un ejemplo de un atributo personalizado que se incrementa. Puedes incrementar el valor de un atributo personalizado con cualquier valor entero positivo o negativo.

m.Braze.incrementCustomUserAttribute("intAttribute", 3)

Desactivar atributos personalizados

Para desactivar un atributo personalizado, pasa la clave del atributo correspondiente al método unsetCustomAttribute.

m.Braze.unsetCustomAttribute("attributeName")

Uso de la REST API

También puedes utilizar nuestra REST API para establecer o desactivar atributos de usuario. Para obtener más información, consulta Endpoints de datos de usuario.

Configurar las suscripciones de correo electrónico

Puedes establecer los siguientes estados de suscripción de correo electrónico para tus usuarios de forma programática a través del SDK.

Estado de suscripción	Definición
`OptedIn`	Suscrito y con adhesión voluntaria explícita
`Subscribed`	Suscrito, pero sin adhesión voluntaria explícita
`UnSubscribed`	Dado de baja o con exclusión voluntaria explícita

Nota

Estos tipos se encuentran en BrazeConstants().SUBSCRIPTION_STATES.

El método para configurar el estado de suscripción de correo electrónico es setEmailSubscriptionState(). Los usuarios se establecerán automáticamente como Subscribed al recibir una dirección de correo electrónico válida; sin embargo, te recomendamos que establezcas un proceso de adhesión voluntaria explícita y configures este valor como OptedIn cuando recibas el consentimiento explícito de tu usuario. Para más detalles, visita Gestión de las suscripciones de usuario.

m.Braze.setEmailSubscriptionState(BrazeConstants().SUBSCRIPTION_STATES.OPTED_IN)

Requisitos previos

Antes de poder utilizar esta característica, tendrás que integrar el SDK de Unity de Braze.

Atributos predeterminados del usuario

Métodos predefinidos

Braze proporciona métodos predefinidos para configurar los siguientes atributos de usuario utilizando el objeto BrazeBinding. Para más información, consulta el archivo de declaración de Braze Unity.

Nombre
Apellido
Correo electrónico del usuario
Género
Fecha de nacimiento
País del usuario
Ciudad natal del usuario
Suscripción de correo electrónico del usuario
Suscripción push del usuario
Número de teléfono del usuario

Configuración de atributos predeterminados

Para establecer un atributo predeterminado, llama al método correspondiente en el objeto BrazeBinding.

BrazeBinding.SetUserFirstName("first name");

BrazeBinding.SetUserLastName("last name");

BrazeBinding.SetUserEmail("[email protected]");

BrazeBinding.SetUserGender(Appboy.Models.Gender);

BrazeBinding.SetUserDateOfBirth("year(int)", "month(int)", "day(int)");

BrazeBinding.SetUserCountry("country name");

BrazeBinding.SetUserHomeCity("city name");

BrazeBinding.SetUserEmailNotificationSubscriptionType(AppboyNotificationSubscriptionType);

BrazeBinding.SetUserPushNotificationSubscriptionType(AppboyNotificationSubscriptionType);

BrazeBinding.SetUserPhoneNumber("phone number");

Desactivar atributos predeterminados

Para desactivar un atributo predeterminado del usuario, pasa null al método correspondiente.

BrazeBinding.SetUserFirstName(null);

Atributos personalizados del usuario

Además de los atributos predeterminados del usuario, Braze también te permite definir atributos personalizados utilizando distintos tipos de datos. Para más información sobre las opciones de segmentación de cada atributo, consulta Recopilación de datos de usuario.

Configuración de atributos personalizados

Para configurar un atributo personalizado, utiliza el método correspondiente para el tipo de atributo:

AppboyBinding.SetCustomUserAttribute("custom string attribute key", "string custom attribute");

// Set Integer Attribute
AppboyBinding.SetCustomUserAttribute("custom int attribute key", 'integer value');
// Increment Integer Attribute
AppboyBinding.IncrementCustomUserAttribute("key", increment(int))

AppboyBinding.SetCustomUserAttribute("custom float attribute key", 'float value');

AppboyBinding.SetCustomUserAttribute("custom double attribute key", 'double value');

AppboyBinding.SetCustomUserAttribute("custom boolean attribute key", 'boolean value');

AppboyBinding.SetCustomUserAttributeToNow("custom date attribute key");

AppboyBinding.SetCustomUserAttributeToSecondsFromEpoch("custom date attribute key", 'integer value');

Nota

Las fechas que se pasen a Braze deben estar en formato ISO 8601 (como 2013-07-16T19:20:30+01:00) o en el formato yyyy-MM-dd'T'HH:mm:ss:SSSZ (como 2016-12-14T13:32:31.601-0800).

// Setting An Array
AppboyBinding.SetCustomUserAttributeArray("key", array(List), sizeOfTheArray(int))
// Adding to an Array
AppboyBinding.AddToCustomUserAttributeArray("key", "Attribute")
// Removing an item from an Array
AppboyBinding.RemoveFromCustomUserAttributeArray("key", "Attribute")

Puedes configurar atributos personalizados que contengan objetos anidados (disponible en el SDK de Unity 5.1.0 y versiones posteriores). Para más información, consulta Atributos personalizados anidados. Los siguientes ejemplos muestran cómo configurar un atributo de objeto anidado, fusionar actualizaciones en un objeto existente y configurar una matriz de objetos anidados.

AppboyBinding.SetCustomUserAttribute("custom object attribute key", dictionary(Dictionary<string, object>));

Para actualizar un objeto anidado existente, utiliza el parámetro de fusión:

AppboyBinding.SetCustomUserAttribute("custom object attribute key", dictionary(Dictionary<string, object>), merge(bool));

También puedes configurar una matriz de objetos anidados:

AppboyBinding.SetCustomUserAttribute("custom object array attribute key", list(List<Dictionary<string, object>>));

Importante

Los valores de los atributos personalizados tienen una longitud máxima de 255 caracteres; los valores más largos se truncarán.

Desactivar atributos personalizados

Para desactivar un atributo personalizado, pasa la clave del atributo correspondiente al método UnsetCustomUserAttribute.

AppboyBinding.UnsetCustomUserAttribute("custom attribute key");

Uso de la REST API

También puedes utilizar nuestra REST API para configurar o desactivar atributos de usuario. Para más información, consulta Endpoints de datos de usuario.

Configuración de suscripciones de usuario

Para configurar una suscripción de correo electrónico o push para tus usuarios, llama a una de las siguientes funciones.

// Email notifications
AppboyBinding.SetUserEmailNotificationSubscriptionType()

// Push notifications
AppboyBinding.SetPushNotificationSubscriptionType()`

Ambas funciones toman Appboy.Models.AppboyNotificationSubscriptionType como argumento, que tiene tres estados diferentes:

Estado de suscripción	Definición
`OPTED_IN`	Suscrito y con adhesión voluntaria explícita
`SUBSCRIBED`	Suscrito, pero sin adhesión voluntaria explícita
`UNSUBSCRIBED`	Dado de baja o con exclusión voluntaria explícita

Nota

Windows no requiere una adhesión voluntaria explícita para enviar notificaciones push a los usuarios. Cuando un usuario se registra para push, se establece como SUBSCRIBED en lugar de OPTED_IN de forma predeterminada. Para obtener más información, consulta nuestra documentación sobre implementación de suscripciones y adhesión voluntaria explícita.

Tipo de suscripción Descripción

EmailNotificationSubscriptionType Los usuarios se establecerán como SUBSCRIBED automáticamente al recibir una dirección de correo electrónico válida. Sin embargo, te sugerimos que establezcas un proceso de adhesión voluntaria explícita y configures este valor como OPTED_IN cuando recibas el consentimiento explícito de tu usuario. Visita nuestra documentación sobre cambio de suscripciones de usuario para obtener más detalles.

PushNotificationSubscriptionType Los usuarios se establecerán como SUBSCRIBED automáticamente tras un registro push válido. Sin embargo, te sugerimos que establezcas un proceso de adhesión voluntaria explícita y configures este valor como OPTED_IN cuando recibas el consentimiento explícito de tu usuario. Visita nuestra documentación sobre cambio de suscripciones de usuario para obtener más detalles.

Tipo de suscripción	Descripción
`EmailNotificationSubscriptionType`	Los usuarios se establecerán como `SUBSCRIBED` automáticamente al recibir una dirección de correo electrónico válida. Sin embargo, te sugerimos que establezcas un proceso de adhesión voluntaria explícita y configures este valor como `OPTED_IN` cuando recibas el consentimiento explícito de tu usuario. Visita nuestra documentación sobre cambio de suscripciones de usuario para obtener más detalles.
`PushNotificationSubscriptionType`	Los usuarios se establecerán como `SUBSCRIBED` automáticamente tras un registro push válido. Sin embargo, te sugerimos que establezcas un proceso de adhesión voluntaria explícita y configures este valor como `OPTED_IN` cuando recibas el consentimiento explícito de tu usuario. Visita nuestra documentación sobre cambio de suscripciones de usuario para obtener más detalles.

Nota

Estos tipos se encuentran en Appboy.Models.AppboyNotificationSubscriptionType.

Configuración de suscripciones de correo electrónico

AppboyBinding.SetUserEmailNotificationSubscriptionType(AppboyNotificationSubscriptionType.OPTED_IN);

Configuración de suscripciones de notificaciones push

AppboyBinding.SetUserPushNotificationSubscriptionType(AppboyNotificationSubscriptionType.OPTED_IN);

Requisitos previos

Antes de poder utilizar esta característica, tendrás que integrar el SDK de React Native de Braze.

Registro de atributos personalizados

Braze proporciona métodos para asignar atributos a los usuarios. Podrás filtrar y segmentar a tus usuarios según estos atributos en el panel.

Atributos predeterminados del usuario

Para configurar los atributos de usuario recogidos automáticamente por Braze, puedes utilizar los métodos de configuración incluidos en el SDK.

Braze.setFirstName("Name");

Se admiten los siguientes atributos:

Nombre
Apellido
Género
Fecha de nacimiento
Ciudad natal
País
Número de teléfono
Idioma
Correo electrónico

Todos los valores de cadena como nombre, apellidos, país y ciudad natal están limitados a 255 caracteres.

Atributos personalizados del usuario

Además de los métodos predefinidos de atributos de usuario, Braze también proporciona atributos personalizados para rastrear datos de tus aplicaciones.

Braze.setCustomUserAttribute("attribute_key", "attribute_value", function(){
    // optional onResult callback
});

Desactivar atributos personalizados

Braze.unsetCustomUserAttribute("attribute_key", function(){
    // optional onResult callback
});

Arreglos de atributos personalizados

// Adds a string to a custom attribute string array, or creates that array if one doesn't exist.
Braze.addToCustomUserAttributeArray("my-attribute-array", "new or existing value", optionalCallback);

// Removes a string from a custom attribute string array.

Braze.removeFromCustomUserAttributeArray("my-attribute-array", "existing value", optionalCallback);

New Stuff!