Definir propriedades globais

Documento

Definindo propriedades globais

O Singular SDK permite definir propriedades personalizadas adicionais para enviar aos servidores Singular com cada sessão e evento enviado pelo aplicativo. Essas propriedades podem representar qualquer informação que você queira sobre o usuário, o modo ou status do aplicativo ou qualquer outra coisa. Depois de definir essas propriedades, elas ficam disponíveis como dimensões nos seus relatórios e você pode usá-las para dividir seus dados.

Por exemplo, se tiver uma aplicação de jogos, pode definir uma propriedade chamada "Nível" e defini-la inicialmente como "0". Qualquer sessão e evento enviado da aplicação será enviado com "Nível": "0". Quando o utilizador subir de nível, a propriedade é reposta a "1" e assim sucessivamente. Pode então obter os seus relatórios, incluindo sessões, contagens de eventos e dados de receitas, repartidos por nível de utilizador.

  • Pode definir até 5 propriedades globais.
  • Estas propriedades persistem entre execuções da aplicação (com o valor mais recente que lhes atribuiu) até que as desfaça ou o utilizador desinstale a aplicação.
  • Cada nome e valor de propriedade pode ter até 200 caracteres. Se passar um nome ou valor de propriedade mais longo, este será truncado para 200 caracteres.
  • As propriedades globais estão acessíveis e disponíveis em exportações e postbacks ao nível do utilizador. No futuro, será adicionado o suporte a relatórios agregados. Informe seu gerente de sucesso do cliente Singular se tiver alguma dúvida ou se estiver interessado em atualizações do suporte a propriedades globais!

Definindo propriedades globais através do SingularConfig

É possível usar o método withGlobalProperty para definir propriedades globais através do SingularConfig antes de inicializar o SDK.

Observe que, como as propriedades globais e seus valores persistem entre as execuções do aplicativo, a propriedade que você está definindo pode já estar definida com um valor diferente. Use o parâmetro overrideExisting para informar ao SDK se deve substituir uma propriedade existente pelo novo valor ou não.

withGlobalProperty Method
Descrição Define uma propriedade global.
Assinatura .withGlobalProperty(String key, String value, boolean overrideExisting)
Exemplo de utilização
// Set two global properties and override any existing values

SingularConfig config = new SingularConfig("SDK KEY", "SDK SECRET")
  .withGlobalProperty(“MyProperty”, “MyValue”, true)
  .withGlobalProperty(“AnotherProperty”, “AnotherValue”, true);

Definir propriedades globais após a inicialização

Utilize os seguintes métodos para definir, anular e recuperar propriedades globais em qualquer altura da execução da aplicação.

Singular.setGlobalProperty Method
Descrição

Define uma propriedade global para um determinado valor.

Notas:

  • Se a propriedade ainda não existir e já existirem 5 outras propriedades globais, a propriedade não será adicionada.
  • Se a propriedade já tiver sido definida, o parâmetro overrideExisting determina se o valor existente será substituído.
  • O método devolve true se a propriedade tiver sido definida com êxito ou false caso contrário.
Assinatura public static bool setGlobalProperty(String key, String value, boolean overrideExisting)
Exemplo de utilização
boolean result = Singular.setGlobalProperty(“MyProperty”, “MyValue”, true);
Singular.getGlobalProperties Method
Descrição Recupera todas as propriedades globais e os seus valores actuais como um Map.
Assinatura public static Map<String, String> getGlobalProperties()
Exemplo de utilização
Map<String, String> map = Singular.getGlobalProperties();
Singular.unsetGlobalProperty Method
Descrição Remover uma propriedade global.
Assinatura public static void unsetGlobalProperty(String key)
Exemplo de utilização
Singular.unsetGlobalProperty(“MyProperty”);
Método Singular.clearGlobalProperties
Descrição Remove todas as propriedades globais.
Assinatura public static void clearGlobalProperties()
Exemplo de utilização
Singular.clearGlobalProperties();