AppsFlyerLib
Resumen General
AppsFlyerLib
es la clase principal del SDK de AppsFlyer para iOS y encapsula la mayoría de los métodos.
Para importar AppsFlyerLib
:
// AppDelegate.h
#import <AppsFlyerLib/AppsFlyerLib.h>
@interface AppDelegate : UIResponder <UIApplicationDelegate, AppsFlyerLibDelegate>
@end
import AppsFlyerLib
Regresa al índice de referencia del SDK.
Propiedades
advertisingIdentifier (read-only)
Declaración de propiedad
@property(nonatomic, strong, readonly) NSString *advertisingIdentifier
Descripción
El SDK de AppsFlyer recopila de Apple el advertisingIdentifier
if the AdSupport.framework
incluido en el SDK.
Puedes deshabilitar este comportamiento configurando disableAdvertisingIdentifier
to true
.
Tipo | Nombre |
---|---|
NSString | advertisingIdentifier |
anonymizeUser
Declaración de propiedad
@property(atomic) BOOL anonymizeUser;
Descripción
Registro de exclusión opcional para un usuario específico
Tipo | Nombre |
---|---|
bool | anonymizeUser |
appInviteOneLinkID
Declaración de propiedad
@property(nonatomic, strong, nullable, setter = setAppInviteOneLink:) NSString * appInviteOneLinkID
Descripción
Configura tu ID de OneLink desde la configuración de OneLink. Se usa en las invitaciones de usuarios para generar un OneLink.
Tipo | Nombre |
---|---|
NSString | appInviteOneLinkID |
appleAppID
Declaración de propiedad
@property(nonatomic, strong) NSString * appleAppID
Descripción
Esta propiedad se usa para configurar el ID de Apple de tu app (se toma de la página de la app en iTunes Connect)
Tipo | Nombre |
---|---|
NSString | appleAppID |
appsFlyerDevKey
Declaración de propiedad
@property(nonatomic, strong) NSString * appsFlyerDevKey
Descripción
Esta propiedad se usa para configurar tu clave de desarrollador de AppsFlyer.
Tipo | Nombre | Descripción |
---|---|---|
NSString | appsFlyerDevKey | Tu clave de desarrollador de AppsFlyer. |
currencyCode
Declaración de propiedad
@property(nonatomic, strong, nullable) NSString *currencyCode
Descripción
En el caso de eventos de compra in-app, puedes configurar el código de divisa con el que el usuario ha comprado.
El código de divisa es un código de 3 letras según las normas ISO.
Ejemplo de uso
[[AppsFlyerLib shared] setCurrencyCode:@"USD"];
AppsFlyerLib.shared().currencyCode = "USD"
customData
Configuración
customData
before first launch will have the additional data included in installs, sessions, as well as in-app events.
Declaración de propiedad
@property(nonatomic, strong, nullable, setter = setAdditionalData:) NSDictionary * customData
Descripción
Úsalo para agregar datos personalizados a la carga útil de los eventos. Lo recibirás en los reportes de raw data.
Tipo | Nombre |
---|---|
NSDictionary | customData |
customerUserID
Declaración de propiedad
@property(nonatomic, strong, nullable) NSString * customerUserID
Descripción
En caso de que uses tu propio ID de usuario en tu aplicación, puedes configurar esta propiedad en ese ID.
Te permite hacer una referencia cruzada de tu propio ID único con el ID único de AppsFlyer y los ID de otros dispositivos
Tipo | Nombre |
---|---|
NSString | customerUserID |
deepLinkDelegate
Declaración de propiedad
@property(weak, nonatomic) id<AppsFlyerDeepLinkDelegate> deepLinkDelegate
Descripción
Propiedad delegada de un objeto, que se ajusta al protocolo DeepLinkDelegate e implementa sus métodos.
Tipo | Nombre |
---|---|
DeepLinkDelegate | deepLinkDelegate |
Ejemplo de uso
AppsFlyerLib.shared().deepLinkDelegate = self
deepLinkTimeout
Descripción
Tiempo de espera de solicitud para Deferred Deeplinking.
Unidades en milisegundos.
Declaración de propiedad
@property(nonatomic) NSUInteger deepLinkTimeout
Tipo | Nombre |
---|---|
NSUInteger | deepLinkTimeout |
delegate
Descripción
Delegado de AppsFlyer. Consulta AppsFlyerLibDelegate.
Declaración de propiedad
@property (nonatomic, weak) id<AppsFlyerLibDelegate> delegate;
Tipo | Nombre |
---|---|
AppsFlyerLibDelegate | delegate |
disableAdvertisingIdentifier
Declaración de propiedad
@property (nonatomic) int disableAdvertisingIdentifier;
Descripción
si AdSupport.framework
no está deshabilitado, el SDK recopila el advertisingIdentifier
de Apple.
Puedes deshabilitar este comportamiento configurando la siguiente propiedad como YES
.
Tipo | Nombre |
---|---|
NSString | advertisingIdentifier |
disableAppleAdsAttribution
Declaración de propiedad
@property(nonatomic) BOOL disableAppleAdsAttribution
Descripción
Disables AdServices framework-based attribution for Apple Search Ads.
Tipo | Nombre |
---|---|
bool | disableAppleAdsAttribution |
disableCollectASA
Declaración de propiedad
@property(atomic) BOOL disableCollectASA;
Descripción
Disables the collection of data from the iAd Framework. This API has no effect in v6.12.3 and above, where the iAd Framework is no longer in use.
Tipo | Nombre |
---|---|
bool | disableCollectASA |
disableIDFVCollection
Declaración de propiedad
@property(nonatomic) BOOL disableIDFVCollection;
Descripción
Para deshabilitar la recopilación de identificadores de proveedores de aplicaciones (IDFV), configura disableIDFVCollection
to YES
.
Tipo | Nombre |
---|---|
bool | disableIDFVCollection |
disableSKAdNetwork
Declaración de propiedad
@property(nonatomic) BOOL disableSKAdNetwork
Descripción
Tipo | Nombre |
---|---|
bool | disableSKAdNetwork |
facebookDeferredAppLink
Declaración de propiedad
@property (nonatomic, nullable) int *facebookDeferredAppLink;
Descripción
Configura manualmente el enlace diferido de la aplicación de Facebook.
Tipo | Nombre |
---|---|
NSString | advertisingIdentifier |
host (read-only)
Declaración de propiedad
@property(nonatomic, strong, readonly) NSString *host
Descripción
Esta propiedad acepta un valor de secuencia que representa el nombre del host para todos los puntos de conexión. Para establecer el host, utiliza setHost.
Para usar el punto de conexión predeterminado del SDK: establece el valor en nil
.
Tipo | Nombre |
---|---|
NSString | host |
hostPrefix (read-only)
Declaración de propiedad
@property(nonatomic, strong, readonly) NSString *hostPrefix
Descripción
Esta propiedad acepta un valor de secuencia que representa el nombre del host para todos los puntos de conexión. Para establecer el host, utiliza setHost.
Tipo | Nombre |
---|---|
NSString | hostPrefix |
isDebug
Declaración de propiedad
@property(nonatomic) BOOL isDebug;
Descripción
Imprime mensajes del SDK en el registro de la consola. Debería estar deshabilitado para compilaciones de producción.
Tipo | Nombre |
---|---|
bool | isDebug |
isStopped
Declaración de propiedad
@property(atomic) BOOL isStopped;
Reinicio del SDK
Establecido
isStopped = true
y luego configuraisStopped = false
No es necesario llamar a
start()
Descripción
API to shut down all SDK activities. This will disable all requests from the SDK except for those related to fetching SKAd Network data from the server.
Tipo | Nombre |
---|---|
bool | isStopped |
minTimeBetweenSessions
Declaración de propiedad
@property(atomic) NSUInteger minTimeBetweenSessions;
Descripción
Configura un valor personalizado para el tiempo mínimo requerido entre sesiones.
Argumentos de entrada
Tipo | Nombre | Descripción |
---|---|---|
NSUInteger | minTimeBetweenSessions | Establece el tiempo mínimo que debe transcurrir entre dos lanzamientos de la aplicación para que cuenten como dos sesiones separadas. Si no se establece, el tiempo mínimo predeterminado entre sesiones es de 5 segundos |
oneLinkCustomDomains
Declaración de propiedad
@property(nonatomic, nullable) NSArray<NSString *> *oneLinkCustomDomains;
Descripción
Para anunciantes que usan OneLinks personalizados.
Tipo | Nombre |
---|---|
NSArray<NSString *> | oneLinkCustomDomains |
phoneNumber
Declaración de propiedad
@property(nonatomic, nullable) NSString *phoneNumber
Descripción
Tipo | Nombre |
---|---|
NSString | phoneNumber |
resolveDeepLinkURLs
Declaración de propiedad
@property(nonatomic, nullable) NSArray<NSString *> *resolveDeepLinkURLs;
Descripción
Tipo | Nombre |
---|---|
NSArray<NSString *> | resolveDeepLinkURLs |
Ejemplo de uso
Algunos servicios de terceros, como los proveedores de servicios de correo electrónico (ESP), encapsulan enlaces en los correos electrónicos con sus propios dominios de registro de clics. Algunos incluso te permiten configurar tus propios dominios de registro de clics. Si OneLink está encapsulado en tales dominios, su funcionalidad podría verse limitada.
Para superar este problema, usa setResolveDeepLinkURLs
para obtener el OneLink de dominios de clic que inician la aplicación. Asegúrate de llamar a esta API antes de la inicialización del SDK.
Por ejemplo, tienes tres dominios de clic que redirigen a tu OneLink, que es https://mysubdomain.onelink.me/abCD. Utiliza esta API para obtener el OneLink al que redireccionan tus dominios de clic. Este método API recibe una lista de dominios que el SDK resuelve.
[AppsFlyerLib shared].resolveDeepLinkURLs = @[@"example.com",@"click.example.com"];
AppsFlyerLib.shared().resolveDeepLinkURLs = ["example.com", "click.example.com"]
Esto te permite usar tu dominio de clic mientras conservas la funcionalidad de OneLink. Los dominios de clics son responsables de iniciar la aplicación. A su vez, la API obtiene el OneLink de estos dominios de clics y, a continuación, tú puedes usar los datos de este OneLink para establecer enlaces profundos y personalizar el contenido de los usuarios.
sharingFilter
Declaración de propiedad
@property(nonatomic, nullable) NSArray<NSString *> *sharingFilter;
Descripción
Tipo | Nombre |
---|---|
NSArray<NSString *> | sharingFilter |
shouldCollectDeviceName
Declaración de propiedad
@property(nonatomic) BOOL shouldCollectDeviceName;
Descripción
Configura este indicador en YES para recopilar el nombre actual del dispositivo (por ejemplo, "Mi iPhone").
Tipo | Nombre |
---|---|
bool | shouldCollectDeviceName |
useReceiptValidationSandbox
Declaración de propiedad
@property (nonatomic) BOOL useReceiptValidationSandbox;
Descripción
Validación de recibos de compra in-app en el entorno de Apple (producción o entorno de pruebas).
Tipo | Nombre |
---|---|
bool | useReceiptValidationSandbox |
useUninstallSandbox
Declaración de propiedad
@property (nonatomic) BOOL useUninstallSandbox;
Descripción
Configura este indicador para probar la desinstalación en el entorno de Apple (producción o entorno de pruebas).
Tipo | Nombre |
---|---|
bool | useUninstallSandbox |
Métodos
addPushNotificationDeepLinkPath
Firma de método
- (void)addPushNotificationDeepLinkPath:(NSArray<NSString *> *)deepLinkPath;
addPushNotificationDeepLinkPath(deepLinkPath: [String])
Descripción
Agrega un conjunto de claves, que se usan para componer la ruta de la clave para resolver el enlace profundo desde la carga útil de las notificaciones push.
Argumentos de entrada
Tipo | Nombre |
---|---|
NSArray<NSString *> | deepLinkPath |
Devoluciones
void
.
Ejemplo de uso
Configuración básica:
[AppsFlyerLib shared] addPushNotificationDeepLinkPath:@[@"af_push_link"]]
AppsFlyerLib.shared().addPushNotificationDeepLinkPath(["af_push_link"])
Configuración avanzada:
[AppsFlyerLib shared] addPushNotificationDeepLinkPath:@[@"deeply", @"nested", @"deep_link"]]
AppsFlyerLib.shared().addPushNotificationDeepLinkPath(["deeply", "nested", "deep_link"])
Esta llamada coincide con la siguiente estructura de carga útil:
{
"deeply": {
"nested": {
“deep_link”: “https://yourdeeplink2.onelink.me”
}
}
}
appendParametersToDeepLinkingURL
Firma de método
(void)appendParametersToDeepLinkingURLWithString:(NSString *)containsString parameters:(NSDictionary<NSString *, NSString*> *)parameters;
appendParametersToDeeplinkURL(contains: String, parameters: [String : String])
Descripción
Hace coincidir las URL que contienen contains
como una subcadena y les anexa parámetros de consulta. En caso de que la URL no coincida, los parámetros no se anexan a ella.
Llamar a este método antes de llamar a
start
Argumentos de entrada
Tipo | Nombre | Descripción |
---|---|---|
NSString | contains | La secuencia para verificar la URL. |
NSDictionary | parameters | Parámetros para agregar a la URL del enlace profundo después de que pasó la validación. |
Devoluciones
void
.
continue
Firma de método
- (id)continueUserActivity:(id)userActivity
restorationHandler:
(void (^_Nullable)(int *_Nullable))restorationHandler;
AppsFlyerLib.shared().continue(userActivity: NSUserActivity?, restorationHandler: (([Any]?) -> Void)?)
Descripción
Permite que AppsFlyer maneje la restauración desde unNSUserActivity
. Usa este método para manejar enlaces universales.
Argumentos de entrada
Tipo | Nombre | Descripción |
---|---|---|
NSUserActivity | userActivity | The NSUserActivity que se pasó a al delegado de tu aplicación |
void (^_Nullable)(int *_Nullable) | restorationHandler | pass nil |
Devoluciones
void
.
enableFacebookDeferderedApplinks
Firma de método
- (void)enableFacebookDeferredApplinksWithClass:(Class _Nullable)facebookAppLinkUtilityClass;
enableFacebookDeferredApplinks(with:AnyClass?)
Descripción
Habilita la colección de enlaces de aplicaciones diferidos de Facebook.
- Requiere el SDK de Facebook y la aplicación de Facebook en el dispositivo del cliente/objetivo.
- Esta API debe invocarse antes de inicializar el SDK de AppsFlyer para que funcione correctamente.
Argumentos de entrada
Tipo | Nombre | Descripción |
---|---|---|
FBSDKAppLinkUtility | facebookAppLinkUtilityClass |
Devoluciones
void
.
enableTCFDataCollection
Firma de método
- (void)enableTCFDataCollection:(BOOL)flag;
func enableTCFDataCollection(_ flag: Bool)
Descripción
Enables the collection of Transparency and Consent Framework (TCF) data from NSUserDefaults
. The data was placed in UserDefaults
by the device's TCF v2.2 compatible Consent Management Platform (CMP).
Argumentos de entrada
Tipo | Nombre | Descripción |
---|---|---|
Bool | flag | A Boolean value to enable or disable the collection of TCF data. |
Devoluciones
void
.
getAppsFlyerUID
Firma de método
- (NSString *)getAppsFlyerUID;
getAppsFlyerUID()
Descripción
Obtén el ID de dispositivo único de AppsFlyer. El SDK genera un ID de dispositivo único de AppsFlyer tras la instalación de la aplicación. Cuando se inicia el SDK, este ID se registra como el ID de la primera instalación de la aplicación.
Argumentos de entrada
Este método no toma ningún argumento de entrada.
Devoluciones
Tipo | Descripción |
---|---|
NSString | ID interno de AppsFlyer. |
getSDKVersion
Firma de método
- (NSString *)getSDKVersion;
getSDKVersion()
Descripción
Obtiene la versión del SDK.
Argumentos de entrada
Este método no toma ningún argumento de entrada.
Devoluciones
Tipo | Descripción |
---|---|
NSString | La versión del SDK de AppsFlyer. |
handleOpen
Firma de método
- (void)handleOpenUrl:(id)url options:(id)options;
AppsFlyerLib.shared().handleOpen(url: URL?, options: [AnyHashable : Any]?)
Descripción
Llama a este método desde el interior de tu método AppDelegate openURL
method.
This method handles URI-scheme for iOS 9 and above.
Argumentos de entrada
Tipo | Nombre | Descripción |
---|---|---|
NSURL | url | La URL que se pasó al delegado de tu aplicación. |
AnyHashable | options | El diccionario de opciones que se pasó a AppDelegate. |
Devoluciones
void
.
handlePushNotification
Firma de método
- (void)handlePushNotification:(NSDictionary * _Nullable)pushPayload;
AppsFlyerLib.shared().handlePushNotification(pushPayload: [AnyHashable : Any]?)
Descripción
Habilita AppsFlyer para manejar una notificación push.
Argumentos de entrada
Tipo | Nombre | Descripción |
---|---|---|
AnyHashable | pushPayload | The userInfo de la notificación remota recibida. A menos que se utilice addPushNotificationDeepLinkPath , los datos deben estar bajo la clave @“af” . |
Devoluciones
void
.
logAdRevenue
Added in v6.15.0
Firma de método
-(void)logAdRevenue:(AFAdRevenueData *)adRevenueData additionalParameters:(NSDictionary * **_Nullable**)additionalParameters;
Descripción
The method sends an ad revenue event to AppsFlyer. See more information in Ad revenue.
Parámetros de entrada
Nombre | Tipo | Descripción |
---|---|---|
adRevenueData | AFAdRevenueData* | An object that encapsulates all the mandatory parameters of the adRevenue event. The object is passed to the logAdRevenue method. |
additionalParameters | NSDictionary * _Nullable | An optional dictionary containing additional parameters to log with the adRevenue event. |
Devoluciones
void
.
AFAdRevenueData
An object that encapsulates all mandatory adRevenue
data received from the mediation network.
Definition
AFAdRevenueData {
(NSString * **_Nonnull**)monetizationNetwork
(AppsFlyerAdRevenueMediationNetworkType)mediationNetwork
(NSString * **_Nonnull**)currencyIso4217Code
(NSNumber * **_Nonnull**)eventRevenue
}
AFAdRevenueData parameters
Nombre | Tipo | Descripción |
---|---|---|
monetizationNetwork | String | The monetization network name. |
mediationNetwork | AppsFlyerAdRevenueMediationNetworkType | The mediation network enum. |
currencyIso4217Code | String | The ad revenue event currency is a String validated against currencyIso4217Code |
eventRevenue | Double | The ad revenue event amount. |
AppsFlyerAdRevenueMediationNetworkType
Nombre | Tipo | Comments |
---|---|---|
ironsource | String | |
applovinmax | String | |
googleadmob | String | |
fyber | String | |
appodeal | String | |
admost | String | |
topon | String | |
tradplus | String | |
yandex | String | |
chartboost | String | |
unity | String | |
customMediation | String | La solución de mediación no está en la lista de partners de mediación admitidos. |
directMonetizationNetwork | String | La app se integra directamente con las redes de monetización sin mediación. |
logEvent
Firma de método
- (void)logEvent:(NSString *)eventName withValues:(NSDictionary * _Nullable)values;
logEvent(eventName: String, withValues: [AnyHashable : Any]?)
Descripción
Usa este método para registrar un evento con parámetros de evento.
Argumentos de entrada
Tipo | Nombre | Descripción |
---|---|---|
NSString | eventName | Contiene el nombre del evento que se podría proporcionar desde constantes predefinidas |
AnyHashable | withValues | Diccionario de valores para el manejo por backend |
Devoluciones
void
.
logEvent
Firma de método
- (void)logEventWithEventName:(NSString *)eventName
eventValues:(NSDictionary<NSString * , id> * _Nullable)eventValues
completionHandler:(void (^ _Nullable)(NSDictionary<NSString *, id> * _Nullable dictionary, NSError * _Nullable error))completionHandler;
logEvent(eventName: String, withValues: [AnyHashable : Any]?, completionHandler:(([String : Any]?, Error?) -> Void)?)
Descripción
Usa este método para registrar un evento con parámetros de evento y pasar un controlador de finalización para manejar el éxito y el fracaso de los envíos de eventos.
Argumentos de entrada
Tipo | Nombre | Descripción |
---|---|---|
NSString | eventName | Contiene el nombre del evento que se podría proporcionar desde constantes predefinidas |
AnyHashable | withValues | Diccionario de valores para el manejo por backend |
(^ _Nullable)(NSDictionary<NSString _, id> _ _Nullable dictionary, NSError * _Nullable error)) | completionHandler |
Devoluciones
void
.
logLocation
Firma de método
- (void)logLocation:(double)longitude latitude:(double)latitude;
logLocation(longitude: Double, latitude: Double)
Descripción
Para registrar la ubicación de la geolocalización. Hace lo mismo que el código siguiente.
Argumentos de entrada
Tipo | Nombre | Descripción |
---|---|---|
Double | longitude | La longitud de la ubicación |
Double | latitude | La latitud de la ubicación |
Devoluciones
void
.
performOnAppAttribution
Firma de método
- (void)performOnAppAttributionWithURL:(NSURL * _Nullable)URL;
performOnAppAttribution(with:URL?)
Descripción
Se utiliza para activar manualmente el delegado onAppOpenAttribution
delegate.
Argumentos de entrada
Tipo | Nombre | Descripción |
---|---|---|
NSURL | URL | El parámetro para resolver en -[AppsFlyerLibDelegate onAppOpenAttribution:] |
Devoluciones
void
.
registerUninstall
Firma de método
- (void)registerUninstall:(NSData * _Nullable)deviceToken;
registerUninstall(deviceToken: Data?)
Descripción
Registra para desinstalación: debes registrar para la notificación remota y proporcionar a AppsFlyer el token push del dispositivo.
Argumentos de entrada
Tipo | Nombre | Descripción |
---|---|---|
NSData | deviceToken | The deviceToken es de didRegisterForRemoteNotificationsWithDeviceToken . |
Devoluciones
void
.
setConsentData
Firma de método
.setConsentData(afConsent: AppsFlyerConsent)
- (void)setConsentData:(AppsFlyerConsent) afConsent
Descripción
Transfers consent data to the SDK.
Argumentos de entrada
Tipo | Nombre | Descripción |
---|---|---|
AppsFlyerConsent | afConsent | An object containing user consent data |
setCurrentDeviceLanguage
Firma de método
- (void)setCurrentDeviceLanguage:(NSString *)currentDeviceLanguage
Descripción
Usa este método para configurar el idioma del dispositivo en el SDK y pasarlo a AppsFlyer.
Argumentos de entrada
Tipo | Nombre | Descripción |
---|---|---|
NSString | currentDeviceLanguage | Idioma actual del dispositivo. |
Ejemplo de uso
NSString *language = [[NSLocale preferredLanguages] objectAtIndex:0]
[[AppsFlyerLib shared] setCurrentDeviceLanguage: @language];
let language = NSLocale.current.languageCode
AppsFlyerLib.shared().currentDeviceLanguage = language
setHost
Firma de método
(void)setHost:(NSString *)host withHostPrefix:(NSString *)hostPrefix;
setHost(host: String, withHostPrefix: String)
Descripción
Esta función configura el nombre de host y el prefijo del nombre de host para todos los puntos de conexión.
Nota: A partir del SDK V6.11, si el valor del host está vacío o nulo, se ignorará la llamada a la API.
Argumentos de entrada
Tipo | Nombre | Descripción |
---|---|---|
NSString | host | Nombre de host. |
NSString | withHostPrefix | Obligatorio. Prefijo de host. |
Devoluciones
void
.
Ejemplo de uso
[[AppsFlyerLib shared] setHost:@"example.com" withHostPrefix:@"my_host_prefix"];
AppsFlyerLib.shared().setHost("example.com", withHostPrefix: "my_host_prefix")
setPartnerData
Firma de método
- (void)setPartnerDataWithPartnerId:(NSString * _Nullable)partnerId partnerInfo:(NSDictionary<NSString *, id> * _Nullable)partnerInfo;
setPartnerData(partnerId: String?, partnerInfo: [String : Any]?)
Descripción
Permite enviar datos personalizados para fines de integración de partners.
Argumentos de entrada
Tipo | Nombre | Descripción |
---|---|---|
NSString | partnerId | ID del partner (generalmente tiene el sufijo _int ) |
NSDictionary<NSString _, id> _ _Nullable | partnerInfo | Datos del cliente, depende de la naturaleza de integración con un partner específico |
Devoluciones
void
.
Ejemplo de uso
NSDictionary *partnerInfo = @{
@"puid": @"123456789",
};
[[AppsFlyerLib shared] setPartnerDataWithPartnerId: @"test_int" partnerInfo:partnerInfo];
let partnerInfo = [
"puid":"123456789",
]
AppsFlyerLib.shared().setPartnerData(partnerId:"test_int", partnerInfo:partnerInfo)
setSharingFilterForPartners
Agregado en V6.4
Firma de método
- (void)setSharingFilterForPartners:(NSArray<NSString *> * _Nullable)sharingFilter;
This function replaces the deprecated setSharingFilterForAllPartners
Descripción
Te permite configurar qué partners debe excluir el SDK del uso compartido de datos.
Argumentos de entrada
Tipo | Nombre | Descripción |
---|---|---|
NSArray<NSString _> _ _Nullable | sharingFilter | Uno o más identificadores de partners que deseas excluir. Debe incluir solo letras/dígitos y guiones bajos. Longitud máxima del ID de partner: 45 |
Nota:
Make sure to use the exact partner ID (PID). Failing to do so may result in privacy-preservation breaches.
To find out the required partner IDs:
- Ejecuta la API para Obtener las integraciones activas para obtener una lista de todas las integraciones activas.
- Utiliza el método
media_source_name
de la respuesta API como valores de entrada a la matrizpartners
del método.
Excepciones:
- Para Apple Search Ads, usa
Apple Search Ads
(y noiossearchads_int
). - For Twitter, use
twitter
(y notwitter_int
)
Ejemplo de uso
[[AppsFlyerLib shared] setSharingFilterForPartners:@[@"examplePartner1_int"]]; // 1 partner
[[AppsFlyerLib shared] setSharingFilterForPartners:@[@"examplePartner1_int", @"examplePartner2_int"]]; // multiple partners
[[AppsFlyerLib shared] setSharingFilterForPartners:@[@"all"]]; // All partners
[[AppsFlyerLib shared] setSharingFilterForPartners:nil]; // Reset list (default)
AppsFlyerLib.shared().setSharingFilterForPartners(["examplePartner1_int"]) // 1 partner
AppsFlyerLib.shared().setSharingFilterForPartners(["examplePartner2_int", "examplePartner1_int"]) // multiple partners
AppsFlyerLib.shared().setSharingFilterForPartners(["all"]) // All partners
AppsFlyerLib.shared().setSharingFilterForPartners(nil) // Reset list (default)
setSharingFilterForAllPartners
Obsoleto en V6.4
Firma de método
- (void)setSharingFilterForAllPartners;
setSharingFilterForAllPartners()
This function is deprecated and has been replaced by setSharingFilterForPartners
Descripción
Block an event from being shared with integrated partners.
Argumentos de entrada
Este método no toma ningún argumento de entrada.
Devoluciones
void
setUserEmails
Firma de método
- (void)setUserEmails:(NSArray<NSString *> * _Nullable)userEmails withCryptType:(EmailCryptType)type;
setUserEmails(userEmails: [String]?, with: EmailCryptType)
Descripción
Use this to set the user email(s).
Note: MD-5
and SHA-1
encryption types are deprecated starting with SDK V6.9.0. Currently, only SHA-256
and NONE
are supported.
Argumentos de entrada
Tipo | Nombre | Descripción |
---|---|---|
NSArray<NSString *> | userEmails | Matriz de correo electrónico. |
EmailCryptType | type | Tipo de cifrado. |
Devoluciones
void
.
shared
Firma de método
(AppsFlyerLib *)shared;
Descripción
Obtiene la instancia singleton de la clase AppsFlyerLib
, creándola si es necesario.
Ejemplo de uso
AppsFlyerLib.shared()
start
Firma de método
- (void)start;
(void) start()
Descripción
Iniciar el SDK.
Argumentos de entrada
Este método no toma ningún argumento de entrada.
Devoluciones
void
.
start
Firma de método
- (void)startWithCompletionHandler:(void (^ _Nullable)(NSDictionary<NSString *, id> * _Nullable dictionary, NSError * _Nullable error))completionHandler;
start(completionHandler: (([String : Any]?, Error?) -> Void)?)
Descripción
Inicia el SDK con un controlador de finalización.
Argumentos de entrada
Tipo | Nombre | Descripción |
---|---|---|
void (^ _Nullable)(NSDictionary<NSString _, id> _ _Nullable dictionary, NSError * _Nullable error) | completionHandler |
Devoluciones
void
.
validateAndLogInAppPurchase
(Supported from SDK v.6.14.1)
Firma de método
typedef void (^AFSDKValidateAndLogCompletion)(AFSDKValidateAndLogResult * _Nullable result);
- (void)validateAndLogInAppPurchase:(AFSDKPurchaseDetails *)details
extraEventValues:(NSDictionary * _Nullable)extraEventValues
completionHandler:(AFSDKValidateAndLogCompletion)completionHandler NS_AVAILABLE(10_7, 7_0);
Descripción
The method validates a purchase event with the store and if the validation is successful, the SDK sends an af_purchase
event to AppsFlyer.
See detailed instructions in Validate and log in-app purchase.
Parámetros de entrada
Nombre | Tipo | Descripción |
---|---|---|
details * | 'AFSDKPurchaseDetails'* | An object that encapsulates all data related to the purchase provided to the validateAndLogInAppPurchase method. |
extraEventValues | NSDictionary * _Nullable | An optional dictionary containing additional parameters to log with the purchase event. |
completionHandler * | AFSDKValidateAndLogCompletion | A completion handler block that is called with the result of the purchase validation and logging. |
Devoluciones
void
.
AFSDKPurchaseDetails
An object that encapsulates all data related to the purchase provided to the validateAndLogInAppPurchase
.
AFSDKPurchaseDetails parameters
Nombre | Tipo | Descripción |
---|---|---|
productId | String | The product identifier for the purchase. |
price | String | The price of the product. |
currency | String | The currency used for the billing operation. |
transactionId | String | A specific identifier for the transaction. |
validateAndLogInAppPurchase (LEGACY)
(Supported until SDK v.6.14.0)
Firma de método
- (void)validateAndLogInAppPurchase:(id)productIdentifier
price:(id)price
currency:(id)currency
transactionId:(id)transactionId
additionalParameters:(id)params
success:(void (^_Nullable)(int *))successBlock
failure:
(void (^_Nullable)(int *_Nullable,
id _Nullable))failedBlock;
validateAndLog(inAppPurchase: String?, price: String?, currency: String?, transactionId: String?, additionalParameters: [AnyHashable : Any]?, success: ([AnyHashable : Any]) -> Void)?, failure: ((Error?, Any?) -> Void)?)
Descripción
Para registrar y validar las compras in-app puedes llamar a este método desde el método [completeTransaction
] en tu SKPaymentTransactionObserver
.
Argumentos de entrada
Tipo | Nombre | Descripción |
---|---|---|
NSString | productIdentifier | inAppPurchase en Swift. |
NSString | price | |
NSString | currency | |
NSString | transactionId | |
NSDictionary | additionalParameters | |
void (^_Nullable)(int *))successBlock | successBlock | Controlador de finalización para el registro y validación exitosos. |
void (^_Nullable)(int *_Nullable, id _Nullable)) | failedBlock | Controlador de finalización para el registro y la validación fallidos. |
Devoluciones
void
.
waitForATTUserAuthorization
Firma de método
- (void)waitForATTUserAuthorizationWithTimeoutInterval:(id)timeoutInterval;
waitForATTUserAuthorization(timeoutInterval:)
Descripción
Espera la solicitud de autorización del usuario para acceder a los datos relacionados con la aplicación.
Argumentos de entrada
Tipo | Nombre | Descripción |
---|---|---|
NSInteger | timeoutInterval |
Ejemplo de uso
if (@available(iOS 14, *)) {
[[AppsFlyerLib shared] waitForATTUserAuthorizationWithTimeoutInterval:60];
[ATTrackingManager requestTrackingAuthorizationWithCompletionHandler:^(ATTrackingManagerAuthorizationStatus status){
}];
}
if #available(iOS 14, *) {
AppsFlyerLib.shared().waitForATTUserAuthorization(withTimeoutInterval: 60)
ATTrackingManager.requestTrackingAuthorization { (status) in
}
}
Devoluciones
void
.
Actualizado hace 2 meses