Skip to content

Definição das atribuições do usuário

Saiba como definir as atribuições do usuário por meio do Braze SDK.

Pré-requisitos

Antes de poder usar esse recurso, você precisará integrar o Android Braze SDK.

Atribuições padrão do usuário

Métodos predefinidos

O Braze fornece métodos predefinidos para definir os seguintes atributos de usuário dentro da classe BrazeUser. Para especificações de método, consulte nosso KDoc.

  • Nome
  • Sobrenome
  • País
  • Idioma
  • Data de nascimento
  • E-mail
  • Gênero
  • Cidade natal
  • Número de telefone

Definindo atributos padrão

Para definir um atributo padrão para um usuário, chame o método getCurrentUser() na sua instância do Braze para obter uma referência ao usuário atual do seu app. Então você pode chamar métodos para definir um atributo de usuário.

1
2
3
4
5
6
Braze.getInstance(context).getCurrentUser(new IValueCallback<BrazeUser>() {
  @Override
  public void onSuccess(BrazeUser brazeUser) {
    brazeUser.setFirstName("first_name");
  }
}
1
2
3
Braze.getInstance(context).getCurrentUser { brazeUser ->
  brazeUser.setFirstName("first_name")
}

Removendo atributos padrão

Para remover um atributo de usuário, passe null para o método relevante.

1
2
3
4
5
6
Braze.getInstance(context).getCurrentUser(new IValueCallback<BrazeUser>() {
  @Override
  public void onSuccess(BrazeUser brazeUser) {
    brazeUser.setFirstName(null);
  }
}
1
2
3
Braze.getInstance(context).getCurrentUser { brazeUser ->
  brazeUser.setFirstName(null)
}

Atributos personalizados do usuário

Além dos atributos de usuário padrão, o Braze também permite que você defina atributos personalizados usando vários tipos de dados diferentes. Para mais informações sobre a opção de segmentação de cada atributo, veja coleta de dados de usuários.

Definindo atributos personalizados

Para definir um atributo personalizado com um valor string:

1
2
3
4
5
6
Braze.getInstance(context).getCurrentUser(new IValueCallback<BrazeUser>() {
  @Override
  public void onSuccess(BrazeUser brazeUser) {
    brazeUser.setCustomUserAttribute("your_attribute_key", "your_attribute_value");
  }
}
1
2
3
Braze.getInstance(context).getCurrentUser { brazeUser ->
  brazeUser.setCustomUserAttribute("your_attribute_key", "your_attribute_value")
}

Para definir um atributo personalizado com um valor int:

1
2
3
4
5
6
7
8
9
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);
  }
}
1
2
3
4
5
6
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 definir um atributo personalizado com um valor inteiro long:

1
2
3
4
5
6
Braze.getInstance(context).getCurrentUser(new IValueCallback<BrazeUser>() {
  @Override
  public void onSuccess(BrazeUser brazeUser) {
    brazeUser.setCustomUserAttribute("your_attribute_key", YOUR_LONG_VALUE);
  }
});
1
2
3
Braze.getInstance(context).getCurrentUser { brazeUser ->
  brazeUser.setCustomUserAttribute("your_attribute_key", YOUR_LONG_VALUE)
}

Para definir um atributo personalizado com um valor float:

1
2
3
4
5
6
Braze.getInstance(context).getCurrentUser(new IValueCallback<BrazeUser>() {
  @Override
  public void onSuccess(BrazeUser brazeUser) {
    brazeUser.setCustomUserAttribute("your_attribute_key", YOUR_FLOAT_VALUE);
  }
});
1
2
3
Braze.getInstance(context).getCurrentUser { brazeUser ->
  brazeUser.setCustomUserAttribute("your_attribute_key", YOUR_FLOAT_VALUE)
}

Para definir um atributo personalizado com um valor double:

1
2
3
4
5
6
Braze.getInstance(context).getCurrentUser(new IValueCallback<BrazeUser>() {
  @Override
  public void onSuccess(BrazeUser brazeUser) {
    brazeUser.setCustomUserAttribute("your_attribute_key", YOUR_DOUBLE_VALUE);
  }
});
1
2
3
Braze.getInstance(context).getCurrentUser { brazeUser ->
  brazeUser.setCustomUserAttribute("your_attribute_key", YOUR_DOUBLE_VALUE)
}

Para definir um atributo personalizado com um valor boolean:

1
2
3
4
5
6
Braze.getInstance(context).getCurrentUser(new IValueCallback<BrazeUser>() {
  @Override
  public void onSuccess(BrazeUser brazeUser) {
    brazeUser.setCustomUserAttribute("your_attribute_key", YOUR_BOOLEAN_VALUE);
  }
});
1
2
3
Braze.getInstance(context).getCurrentUser { brazeUser ->
  brazeUser.setCustomUserAttribute("your_attribute_key", YOUR_BOOLEAN_VALUE)
}
1
2
3
4
5
6
7
8
9
10
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);
  }
});
1
2
3
4
5
6
7
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)
}

O número máximo de elementos em matrizes de atributos personalizados tem como padrão 25. O máximo para vetores individuais pode ser aumentado para até 100 no dashboard da Braze, em Configurações de dados > Atributos personalizados). As matrizes que excederem o número máximo de elementos serão truncadas para conter o número máximo de elementos. Para saber mais sobre matrizes de atributos personalizados e seu comportamento, consulte nossa documentação sobre matrizes.

1
2
3
4
5
6
7
8
9
10
11
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");
  }
});
1
2
3
4
5
6
7
8
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")
}

Removendo atributos personalizados

Para remover um atributo personalizado, passe a chave do atributo relevante para o método unsetCustomUserAttribute.

1
2
3
4
5
6
Braze.getInstance(context).getCurrentUser(new IValueCallback<BrazeUser>() {
  @Override
  public void onSuccess(BrazeUser brazeUser) {
    brazeUser.unsetCustomUserAttribute("your_attribute_key");
  }
});
1
2
3
Braze.getInstance(context).getCurrentUser { brazeUser ->
  brazeUser.unsetCustomUserAttribute("your_attribute_key")
}

Aninhando atributos personalizados

Você também pode aninhar propriedades dentro de atributos personalizados. No exemplo a seguir, um objeto favorite_book com propriedades aninhadas é definido como um atributo personalizado no perfil do usuário. Para mais detalhes, consulte Nested Custom Attributes.

1
2
3
4
5
6
7
8
9
10
11
12
13
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;
});
1
2
3
4
5
6
7
8
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)
}

Usando a API REST

Você também pode usar nossa API REST para definir ou remover atributos de usuários. Para saber mais, consulte User Data Endpoints.

Definindo assinaturas de usuários

Para configurar uma inscrição para seus usuários (envio de e-mail ou push), chame as funções setEmailNotificationSubscriptionType() ou setPushNotificationSubscriptionType(), respectivamente. Ambas as funções usam o tipo de enum NotificationSubscriptionType como argumentos. Esse tipo tem três estados diferentes:

Configuração de envios de e-mail

1
2
3
4
5
6
Braze.getInstance(context).getCurrentUser(new IValueCallback<BrazeUser>() {
  @Override
  public void onSuccess(BrazeUser brazeUser) {
    brazeUser.setEmailNotificationSubscriptionType(emailNotificationSubscriptionType);
  }
});
1
2
3
Braze.getInstance(context).getCurrentUser { brazeUser ->
  brazeUser.setEmailNotificationSubscriptionType(emailNotificationSubscriptionType)
}

Configuração da inscrição de notificações por push

1
2
3
4
5
6
Braze.getInstance(context).getCurrentUser(new IValueCallback<BrazeUser>() {
  @Override
  public void onSuccess(BrazeUser brazeUser) {
    brazeUser.setPushNotificationSubscriptionType(pushNotificationSubscriptionType);
  }
});
1
2
3
Braze.getInstance(context).getCurrentUser { brazeUser ->
  brazeUser.setPushNotificationSubscriptionType(pushNotificationSubscriptionType)
}

Pré-requisitos

Antes de usar este recurso, você precisará integrar o SDK Swift Braze.

Atribuições padrão do usuário

Atribuições suportadas

Os seguintes atributos devem ser definidos no objeto Braze.User:

  • firstName
  • lastName
  • email
  • dateOfBirth
  • country
  • language
  • homeCity
  • phone
  • gender

Definindo atributos padrão

Para definir um atributo de usuário padrão, defina o campo apropriado no objeto compartilhado Braze.User. A seguir está um exemplo de configuração do atributo nome:

1
AppDelegate.braze?.user.set(firstName: "Alex")
1
[AppDelegate.braze.user setFirstName:@"Alex"];

Removendo atributos padrão

Para remover um atributo de usuário padrão, passe nil para o método relevante.

1
AppDelegate.braze?.user.set(firstName: nil)
1
[AppDelegate.braze.user setFirstName:nil];

Atributos personalizados do usuário

Além dos atributos de usuário padrão, a Braze também permite que você defina atributos personalizados usando vários tipos de dados diferentes. Para mais informações sobre a opção de segmentação de cada atributo, consulte Coleta de dados de usuários.

Definindo atributos personalizados

Para definir um atributo personalizado com um valor string:

1
AppDelegate.braze?.user.setCustomAttribute(key: "your_attribute_key", value: "your_attribute_value")
1
[AppDelegate.braze.user setCustomAttributeWithKey:@"your_attribute_key" stringValue:"your_attribute_value"];

Para definir um atributo personalizado com um valor integer:

1
AppDelegate.braze?.user.setCustomAttribute(key: "your_attribute_key", value: yourIntegerValue)
1
[AppDelegate.braze.user setCustomAttributeWithKey:@"your_attribute_key" andIntegerValue:yourIntegerValue];

Braze trata os valores float e double da mesma forma em nosso banco de dados. Para definir um atributo personalizado com um valor duplo:

1
AppDelegate.braze?.user.setCustomAttribute(key: "your_attribute_key", value: yourDoubleValue)
1
[AppDelegate.braze.user setCustomAttributeWithKey:@"your_attribute_key" andDoubleValue:yourDoubleValue];

Para definir um atributo personalizado com um valor boolean:

1
AppDelegate.braze?.user.setCustomAttribute("your_attribute_key", value: yourBoolValue)
1
[AppDelegate.braze.user setCustomAttributeWithKey:@"your_attribute_key" andBOOLValue:yourBOOLValue];

Para definir um atributo personalizado com um valor date:

1
AppDelegate.braze?.user.setCustomAttribute("your_attribute_key", dateValue:yourDateValue)
1
[AppDelegate.braze.user setCustomAttributeWithKey:@"your_attribute_key" andDateValue:yourDateValue];

O número máximo de elementos em arrays de atributos personalizados é 25 por padrão. As matrizes que excederem o número máximo de elementos serão truncadas para conter o número máximo de elementos. O máximo para matrizes individuais pode ser aumentado para até 100. Se você gostaria que esse máximo fosse aumentado, entre em contato com seu gerente de atendimento ao cliente.

Para definir um atributo personalizado com um valor array:

1
2
3
4
5
6
// 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")
1
2
3
4
5
6
7
8
// 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];

Incrementando ou decrementando atributos personalizados

Este código é um exemplo de um atributo personalizado incrementando. Você pode incrementar o valor de um atributo personalizado por qualquer valor integer ou long:

1
AppDelegate.braze?.user.incrementCustomUserAttribute(key: "your_attribute_key", by: incrementIntegerValue)
1
[AppDelegate.braze.user incrementCustomUserAttribute:@"your_attribute_key" by:incrementIntegerValue];

Removendo atributos personalizados

Para remover um atributo personalizado, passe a chave do atributo relevante para o método unsetCustomAttribute.

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

Para remover um atributo personalizado, passe a chave do atributo relevante para o método unsetCustomAttributeWithKey.

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

Aninhando atributos personalizados

Você também pode aninhar propriedades dentro de atributos personalizados. No exemplo a seguir, um objeto favorite_book com propriedades aninhadas é definido como um atributo personalizado no perfil do usuário. Para mais detalhes, consulte Nested Custom Attributes.

1
2
3
4
5
6
7
let favoriteBook: [String: Any?] = [
  "title": "The Hobbit",
  "author": "J.R.R. Tolkien",
  "publishing_date": "1937"
]

braze.user.setCustomAttribute(key: "favorite_book", dictionary: favoriteBook)
1
2
3
4
5
6
7
NSDictionary *favoriteBook = @{
  @"title": @"The Hobbit",
  @"author": @"J.R.R. Tolkien",
  @"publishing_date": @"1937"
};

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

Usando a API REST

Você também pode usar nossa API REST para definir ou remover atributos de usuários. Para saber mais, consulte User Data Endpoints.

Definindo assinaturas de usuários

Para configurar uma inscrição para seus usuários (envio de e-mail ou push), chame as funções set(emailSubscriptionState:) ou set(pushNotificationSubscriptionState:), respectivamente. Ambas as funções usam o tipo de enum Braze.User.SubscriptionState como argumentos. Esse tipo tem três estados diferentes:

Os usuários que concedem permissão para um app enviar notificações por push têm o status padrão de optedIn, pois o iOS exige uma aceitação explícita.

Os usuários serão configurados para subscribed automaticamente após o recebimento de um endereço de e-mail válido; no entanto, sugerimos que você estabeleça um processo de aceitação explícita e defina este valor para optedIn após o recebimento do consentimento explícito do seu usuário. Para saber mais, consulte Gerenciar inscrições de usuários.

Configuração de envios de e-mail

1
AppDelegate.braze?.user.set(emailSubscriptionState: Braze.User.SubscriptionState)
1
[AppDelegate.braze.user setEmailSubscriptionState: BRZUserSubscriptionState]

Configuração de inscrições de notificação por push

1
AppDelegate.braze?.user.set(pushNotificationSubscriptionState: Braze.User.SubscriptionState)
1
[AppDelegate.braze.user setPushNotificationSubscriptionState: BRZUserSubscriptionState]

Para saber mais, consulte Gerenciar inscrições de usuários.

Prerequisites

Before you can use this feature, you’ll need to integrate the Web Braze SDK.

Atribuições padrão do usuário

Métodos predefinidos

O Braze fornece métodos predefinidos para configurar as seguintes atribuições de usuário na classeUser:

  • Nome
  • Sobrenome
  • Idioma
  • País
  • Data de nascimento
  • E-mail
  • Gênero
  • Cidade
  • Número de telefone

Definindo atributos padrão

Para definir um atributo padrão para um usuário, chame o método getUser() na sua instância Braze para obter uma referência ao usuário atual do seu app. Então você pode chamar métodos para definir um atributo do usuário.

1
braze.getUser().setFirstName("SomeFirstName");
1
braze.getUser().setGender(braze.User.Genders.FEMALE);
1
braze.getUser().setDateOfBirth(2000, 12, 25);

Usando o Google Tag Manager, atributos padrão do usuário (como o primeiro nome de um usuário) devem ser registrados da mesma forma que atributos personalizados do usuário. Certifique-se de que os valores que está passando para as atribuições padrão correspondam ao formato esperado especificado na documentação da classe User.

Por exemplo, o atributo gender pode aceitar qualquer um dos seguintes valores: "m" | "f" | "o" | "u" | "n" | "p". Portanto, para definir o gênero de um usuário como feminino, crie uma tag HTML personalizada com o seguinte conteúdo:

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

Removendo atributos padrão

Para remover um atributo padrão do usuário, passe null para o método relacionado. Por exemplo:

1
braze.getUser().setFirstName(null);
1
braze.getUser().setGender(null);
1
braze.getUser().setDateOfBirth(null, null, null);

Atributos personalizados do usuário

Definindo atributos personalizados

Além dos métodos de atributos padrão do usuário, você também pode definir atributos personalizados para seus usuários. Especificações completas dos métodos, veja nossos JSDocs.

Para definir um atributo personalizado com um valor string:

1
2
3
4
braze.getUser().setCustomUserAttribute(
  YOUR_ATTRIBUTE_KEY_STRING,
  YOUR_STRING_VALUE
);

Para definir um atributo personalizado com um valor integer:

1
2
3
4
5
6
7
8
9
10
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 definir um atributo personalizado com um valor date:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
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)
);

Você pode ter até 25 elementos em arrays de atributos personalizados. Arrays individuais que são definidos manualmente (não detectados automaticamente) para Tipo de Dados podem ser aumentados até 100 no painel Braze em Configurações de Dados > Atributos Personalizados. Se você quiser que esse máximo seja aumentado, entre em contato com seu gerente de conta Braze.

As matrizes que excederem o número máximo de elementos serão truncadas para conter o número máximo de elementos.

Para definir um atributo personalizado com um valor array:

1
2
3
4
5
6
7
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");

Os atributos personalizados do usuário não estão disponíveis devido a uma limitação na linguagem de script do Google Tag Manager. Para registrar atributos personalizados, crie uma tag HTML personalizada com o seguinte conteúdo:

1
2
3
4
5
<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>

Removendo atributos personalizados

Para remover um atributo personalizado, passe null para o método relacionado.

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

Aninhando atributos personalizados

Você também pode aninhar propriedades dentro de atributos personalizados. No exemplo a seguir, um objeto favorite_book com propriedades aninhadas é definido como um atributo personalizado no perfil do usuário. Para mais detalhes, consulte Attributes Personalizados Aninhados.

1
2
3
4
5
6
7
8
9
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);

Usando a API REST

Você também pode usar nossa API REST para definir ou remover atributos de usuários. Para saber mais, consulte Pontos de Extremidade de Dados de Usuários.

Definindo assinaturas de usuários

Para configurar uma inscrição para seus usuários (envio de e-mail ou push), chame as funções setEmailNotificationSubscriptionType() ou setPushNotificationSubscriptionType(), respectivamente. Ambas as funções aceitam o tipo enum braze.User.NotificationSubscriptionTypes como argumentos. Esse tipo tem três estados diferentes:

Quando um usuário é registrado para receber notificações por push, o navegador o obriga a optar por permitir ou bloquear notificações e, se ele optar por permitir o push, será definido como OPTED_IN por padrão.

Visite Gerenciar inscrições de usuários para saber mais sobre a implementação de inscrições e aceitação explícita.

Cancelando a inscrição de um usuário por e-mail

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

Cancelando a inscrição de um usuário de push

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

Pré-requisitos

Antes de poder usar esse recurso, você precisará integrar o Unity Braze SDK.

Atribuições padrão do usuário

Métodos predefinidos

O Braze fornece métodos predefinidos para configurar as seguintes atribuições de usuário usando o objeto BrazeBinding. Para saber mais, consulte o arquivo de declaração do Braze Unity.

  • Nome
  • Sobrenome
  • E-mail do usuário
  • Gênero
  • Data de nascimento
  • País do usuário
  • Cidade de origem do usuário
  • Envio de e-mail para o usuário
  • Inscrição push do usuário
  • Número de telefone do usuário

Definição de atribuições padrão

Para definir uma atribuição padrão, chame o método relevante no objeto BrazeBinding.

1
BrazeBinding.SetUserFirstName("first name");
1
BrazeBinding.SetUserLastName("last name");
1
BrazeBinding.SetUserGender(Appboy.Models.Gender);
1
BrazeBinding.SetUserDateOfBirth("year(int)", "month(int)", "day(int)");
1
BrazeBinding.SetUserCountry("country name");
1
BrazeBinding.SetUserHomeCity("city name");
1
BrazeBinding.SetUserEmailNotificationSubscriptionType(AppboyNotificationSubscriptionType);
1
BrazeBinding.SetUserPushNotificationSubscriptionType(AppboyNotificationSubscriptionType);
1
BrazeBinding.SetUserPhoneNumber("phone number");

Desativação de atribuições padrão

Para cancelar a definição de uma atribuição de usuário padrão, passe null para o método relevante.

1
BrazeBinding.SetUserFirstName(null);

Atributos personalizados do usuário

Além dos atributos padrão de usuários, o Braze também permite definir atributos personalizados usando vários tipos de dados diferentes. Para saber mais sobre a opção de segmentação de cada atributo, consulte Coleta de dados de usuários.

Definindo atributos personalizados

Para definir um atributo personalizado, use o método correspondente para o tipo de atributo:

1
AppboyBinding.SetCustomUserAttribute("custom string attribute key", "string custom attribute");
1
2
3
4
// Set Integer Attribute
AppboyBinding.SetCustomUserAttribute("custom int attribute key", 'integer value');
// Increment Integer Attribute
AppboyBinding.IncrementCustomUserAttribute("key", increment(int))
1
AppboyBinding.SetCustomUserAttribute("custom double attribute key", 'double value');
1
AppboyBinding.SetCustomUserAttribute("custom boolean attribute key", 'boolean value');
1
AppboyBinding.SetCustomUserAttributeToNow("custom date attribute key");
1
AppboyBinding.SetCustomUserAttributeToSecondsFromEpoch("custom date attribute key", 'integer value');
1
2
3
4
5
6
// 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")

Desativação de atributos personalizados

Para cancelar a definição de um atributo personalizado, passe a chave do atributo relevante para o método UnsetCustomUserAttribute.

1
AppboyBinding.UnsetCustomUserAttribute("custom attribute key");

Usando a API REST

Também é possível usar nossa API REST para definir ou cancelar as atribuições do usuário. Para saber mais, consulte Pontos de extremidade de dados de usuários.

Configuração de inscrições de usuários

Para configurar uma inscrição por e-mail ou push para seus usuários, chame uma das seguintes funções.

1
2
3
4
5
// Email notifications
AppboyBinding.SetUserEmailNotificationSubscriptionType()

// Push notifications
AppboyBinding.SetPushNotificationSubscriptionType()`

Ambas as funções recebem Appboy.Models.AppboyNotificationSubscriptionType como argumentos, que tem três estados diferentes:

Configuração de envios de e-mail

1
AppboyBinding.SetUserEmailNotificationSubscriptionType(AppboyNotificationSubscriptionType.OPTED_IN);

Configuração de inscrições de notificação por push

1
AppboyBinding.SetUserPushNotificationSubscriptionType(AppboyNotificationSubscriptionType.OPTED_IN);

Atribuições padrão do usuário

Atribuições suportadas

Os seguintes atributos devem ser definidos no objeto UBrazeUser:

  • SetFirstName
  • SetLastName
  • SetEmail
  • SetDateOfBirth
  • SetCountry
  • SetLanguage
  • SetHomeCity
  • SetPhoneNumber
  • SetGender

Definição de atribuições padrão

Para definir uma atribuição padrão para um usuário, chame o método GetCurrentUser() no objeto compartilhado UBrazeUser para obter uma referência ao usuário atual do seu app. Em seguida, é possível chamar métodos para definir uma atribuição de usuário.

1
2
3
4
5
UBraze->GetCurrentUser([](UBrazeUser* BrazeUser) {
    if (BrazeUser) {
        BrazeUser->SetFirstName(TEXT("Alex"));
    }
});

Atributos personalizados do usuário

Além dos atributos padrão de usuários, o Braze também permite definir atributos personalizados usando vários tipos de dados diferentes. Para saber mais sobre a opção de segmentação de cada atributo, consulte Coleta de dados de usuários.

Para definir um atributo personalizado com um valor string:

1
UBrazeUser->SetCustomUserAttribute(TEXT("your_attribute_key"), TEXT("your_attribute_value"));

Para definir um atributo personalizado com um valor integer:

1
UBrazeUser->SetCustomUserAttribute(TEXT("your_attribute_key"), 42);

Braze trata os valores float e double da mesma forma em nosso banco de dados. Para definir um atributo personalizado com um valor duplo:

1
UBrazeUser->SetCustomUserAttribute(TEXT("your_attribute_key"), 3.14);

Para definir um atributo personalizado com um valor boolean:

1
UBrazeUser->SetCustomUserAttribute(TEXT("your_attribute_key"), true);

Para definir um atributo personalizado com um valor date:

1
2
FDateTime YourDateTime = FDateTime(2023, 5, 10);
UBrazeUser->SetCustomUserAttribute(TEXT("your_attribute_key"), YourDateTime);

Para definir um atributo personalizado com um valor array:

1
2
3
4
5
6
7
8
9
// Setting a custom attribute with an array value
TArray<FString> Values = {TEXT("value1"), TEXT("value2")};
UBrazeUser->SetCustomAttributeArray(TEXT("array_name"), Values);

// Adding to a custom attribute with an array value
UBrazeUser->AddToCustomAttributeArray(TEXT("array_name"), TEXT("value3"));

// Removing a value from an array type custom attribute
UBrazeUser->RemoveFromCustomAttributeArray(TEXT("array_name"), TEXT("value2"));

Configuração de inscrições de usuários

Para configurar uma inscrição por e-mail ou push para seus usuários, use os seguintes métodos.

Configuração do envio de e-mail

1
2
3
4
5
UBraze->GetCurrentUser([](UBrazeUser* BrazeUser) {
    if (BrazeUser) {
        BrazeUser->SetEmailSubscriptionType(EBrazeSubscriptionType::Subscribed);
    }
});

Configuração dos dados de atribuição

1
2
3
4
5
UBraze->GetCurrentUser([](UBrazeUser* BrazeUser) {
    if (BrazeUser) {
        BrazeUser->SetPushSubscriptionType(EBrazeSubscriptionType::OptedIn);
    }
});
New Stuff!