SDK de iOS - Configuración de propiedades globales

Documento

Definición de propiedades globales

Singular SDK permite definir propiedades personalizadas que se enviarán a los servidores de Singular junto con cada sesión y evento enviado desde la aplicación. Estas propiedades pueden representar cualquier información que desee sobre el usuario, el modo/estado de la aplicación o cualquier otra cosa.

Puedes definir hasta 5 propiedades globales. Persisten entre ejecuciones de la aplicación (con el último valor que les haya dado) hasta que las desactive o el usuario desinstale la aplicación.

Casos de uso

Algunos casos de uso para las propiedades globales son:

  • Pasar un identificador desde un SDK de terceros y luego usarlo en un postback desde Singular a dicho tercero para propósitos de emparejamiento.
  • En una app de juegos, puedes definir una propiedad llamada "Nivel" y establecerla inicialmente a "0". Cualquier sesión y evento enviado desde la app será enviado con "Level": "0". Una vez que el usuario suba de nivel, restableces la propiedad a "1" y así sucesivamente.

Notas:

  • Las propiedades globales se reflejan actualmente en los registros de eventos a nivel de usuario de Singular (véase Exportación de registros de atribución) y en los postbacks. En el futuro se añadirá soporte para las propiedades globales en los informes agregados de Singular (la página Informes o la API de informes). Si tiene alguna pregunta sobre esta función o está interesado en las actualizaciones de la compatibilidad con propiedades globales, póngase en contacto con su gestor de éxito de clientes de Singular.
  • El nombre y el valor de cada propiedad pueden tener un máximo de 200 caracteres. Si pasa un nombre o valor de propiedad más largo, se truncará a 200 caracteres.

Configuración de propiedades globales a través del objeto Config

Para establecer propiedades globales antes de inicializar el SDK, utilice el método setGlobalProperty en el objeto Config.

Tenga en cuenta que como las propiedades globales y sus valores persisten entre ejecuciones de la aplicación, la propiedad que está estableciendo puede estar ya establecida en un valor diferente. Utilice el parámetro overrideExisting para indicar al SDK si debe anular una propiedad existente con el nuevo valor o no.

Método setGlobalProperty
Descripción Establece una propiedad global.
Firma (void)setGlobalProperty:(NSString*)key withValue:(NSString*)value overrideExisting:(BOOL)overrideExisiting;
Ejemplo de uso
SwiftObjective-C
func getConfig() -> SingularConfig? {         
  // (Optional) Get 3rd-party identifiers to set in Global Properties:     


  // If 3rd-party SDKs are providing any identifiers to Singular, the


  // respective SDK must be initialized before Singular.     


  let thirdPartyKey = "anonymousID"     
  let thirdPartyID = "2ed20738-059d-42b5-ab80-5aa0c530e3e1"     
  
  // Singular Config Options     


  guard let config = SingularConfig(apiKey: Constants.APIKEY, 
    andSecret: Constants.SECRET) else {
      return nil
      }
  //...     
  // Using Singular Global Properties feature to capture third party identifiers


  config.setGlobalProperty(thirdPartyKey, withValue: thirdPartyID, overrideExisting: true)     
  //...
  return config 
}

Establecer propiedades globales después de la inicialización

Utilice los siguientes métodos para establecer, desestablecer y recuperar propiedades globales en cualquier momento de la ejecución de la aplicación.

Notas:

  • Si la propiedad no existe todavía, y ya hay otras 5 propiedades globales, la propiedad no se añadirá.
  • Si la propiedad ya ha sido establecida, el parámetro overrideExisting determina si el valor existente será anulado.
  • El método devuelve true si la propiedad se ha establecido correctamente o false en caso contrario.
Método setGlobalProperty
Descripción Establece una propiedad global a un valor dado.
Firma (BOOL) setGlobalProperty:(NSString*)key andValue:(NSString*)value overrideExisting:(BOOL)overrideExisting
Ejemplo de uso
SwiftObjective-C
var result = Singular.setGlobalProperty("propertyName",
  andValue: "propertyValue", overrideExisting: true)
Método getGlobalProperties
Descripción Recupera todas las propiedades globales y sus valores actuales como un Map.
Firma NSDictionary*) getGlobalProperties
Ejemplo de uso
SwiftObjective-C
var globalProperties = Singular.getGlobalProperties()
Método unsetGlobalProperty
Descripción Elimina una propiedad global.
Firma (void) unsetGlobalProperty:(NSString*)clave
Ejemplo de uso
SwiftObjective-C
Singular.unsetGlobalProperty("propertyName")
Método clearGlobalProperties
Descripción Elimina todas las propiedades globales.
Firma (void) clearGlobalProperties
Ejemplo de uso
SwiftObjective-C
Singular.clearGlobalProperties()