Referencia de la clase GAIDictionaryBuilder

Descripción general

Clase auxiliar para crear un diccionario de parámetros y valores de hit.


Ejemplos:

id<GAITracker> t = // get a tracker.
[t send:[[[GAIDictionaryBuilder createEventWithCategory:@"EventCategory"
                                                 action:@"EventAction"
                                                  label:nil
                                                  value:nil]
    set:"dimension1" forKey:[GAIFields customDimensionForIndex:1]] build]];

Enviará un tipo de hit de evento con los parámetros especificados y un parámetro de dimensión personalizada.
Si quieres enviar un parámetro con todos los hits, configúralo en GAITracker directamente.

[t set:kGAIScreenName value:@"Home"];
[t send:[[GAIDictionaryBuilder createSocialWithNetwork:@"Google+"
                                                action:@"PlusOne"
                                                target:@"SOME_URL"] build]];
[t send:[[GAIDictionaryBuilder createSocialWithNetwork:@"Google+"
                                                action:@"Share"
                                                target:@"SOME_POST"] build]];
[t send:[[GAIDictionaryBuilder createSocialWithNetwork:@"Google+"
                                                action:@"HangOut"
                                                target:@"SOME_CIRCLE"]
    build]];

Puedes anular un valor configurado en el objeto de seguimiento agregándolo al diccionario.

[t set:kGAIScreenName value:@"Home"];
[t send:...];
[t send[[[GAIDictionaryBuilder createEventWithCategory:@"click"
                                                action:@"popup"
                                                 label:nil
                                                 value:nil]
    set:@"popup title" forKey:kGAIScreenName] build]];

Los valores configurados mediante [GAIDictionaryBuilder set] o [GAIDictionaryBuilder setAll] anularán los valores del objeto GAIDictionaryBuilder (es decir, inicializado por [GAIDictionaryBuilder createXYZ]). Por ejemplo:

GAIDictionaryBuilder *m =
    GAIDictionaryBuilder createTimingWithCategory:@"category"
                                         interval:@0
                                             name:@"name"
                                            label:nil];
[t send:[m.set:@"10" forKey:kGAITimingVar] build];
[t send:[m.set:@"20" forKey:kGAITimingVar] build];

Hereda NSObject.

Métodos de instancia

(GAIDictionaryBuilder *) - setAll:
 Copia todos los pares nombre-valor de los parámetros en los objetos, ignorando las claves que sean del tipo NSString y los valores que no sean NSString ni NSNull. Más...
 
(NSString *) - get:
 Devuelve el valor del parámetro de entrada paramName, o nil si no está paramName. Más...
 
(NSMutableDictionary *) - build
 Devuelve un objeto NSMutableDictionary con todos los parámetros configurados como este valor. Más...
 
(GAIDictionaryBuilder *) - setCampaignParametersFromUrl:
 Analiza y traduce los parámetros de campaña utm en parámetros de campaña de Analytics y los devuelve como una asignación. Más...
 
(GAIDictionaryBuilder *) - setProductAction:
 Configura el campo de acción de producto de este hit. Más...
 
(GAIDictionaryBuilder *) - addProduct:
 Agrega un producto a este hit. Más...
 
(GAIDictionaryBuilder *) - addProductImpression:impressionList:impressionSource:
 Agrega una impresión de producto a este hit. Más...
 
(GAIDictionaryBuilder *) - addPromotion:
 Añade una promoción a este hit. Más...
 

Métodos de clase

("Usa createScreenView en su lugar.") + createAppView
 Devuelve un objeto GAIDictionaryBuilder con parámetros específicos de un hit de aplicación vista. Más...
 
(GAIDictionaryBuilder *) + createScreenView
 Devuelve un objeto GAIDictionaryBuilder con parámetros específicos de un hit de pantalla vista. Más...
 
(GAIDictionaryBuilder *) + createEventWithCategory:action:label:value:
 Devuelve un objeto GAIDictionaryBuilder con parámetros específicos de un hit de evento. Más...
 
(GAIDictionaryBuilder *) + createExceptionWithDescription:withFatal:
 Devuelve un objeto GAIDictionaryBuilder con parámetros específicos de un hit de excepción. Más...
 
(GAIDictionaryBuilder *) + createItemWithTransactionId:name:sku:category:price:quantity:currencyCode:
 Devuelve un objeto GAIDictionaryBuilder con parámetros específicos de un hit de elemento. Más...
 
(GAIDictionaryBuilder *) + createSocialWithNetwork:action:target:
 Devuelve un objeto GAIDictionaryBuilder con parámetros específicos de un hit social. Más...
 
(GAIDictionaryBuilder *) + createTimingWithCategory:interval:name:label:
 Devuelve un objeto GAIDictionaryBuilder con parámetros específicos de un hit de tiempos. Más...
 
(GAIDictionaryBuilder *) + createTransactionWithId:affiliation:revenue:tax:shipping:currencyCode:
 Devuelve un objeto GAIDictionaryBuilder con parámetros específicos de un hit de transacción. Más...
 

Documentación de métodos

- (GAIDictionaryBuilder *) setAll: (NSDictionary *)  params

Copia todos los pares nombre-valor de los parámetros en los objetos, ignorando las claves que sean del tipo NSString y los valores que no sean NSString ni NSNull.

- (NSString *) get: (NSString *)  paramName

Devuelve el valor del parámetro de entrada paramName, o nil si no está paramName.

- (NSMutableDictionary *) build

Devuelve un objeto NSMutableDictionary con todos los parámetros configurados como este valor.

- (GAIDictionaryBuilder *) setCampaignParametersFromUrl: (NSString *)  urlString

Analiza y traduce los parámetros de campaña utm en parámetros de campaña de Analytics y los devuelve como una asignación.

Parámetros
paramsURL que contiene los parámetros de campaña utm.

Los parámetros de campaña válidos son:

  • utm_id
  • utm_campaign
  • utm_content
  • utm_medium
  • utm_source
  • utm_term
  • dclid
  • gclid
  • gmob_t
  • aclid
  • anid

Ejemplo: http://my.site.com/index.html?utm_campaign=wow&utm_source=source utm_campaign=wow&utm_source=source.

Para obtener más información sobre el etiquetado automático y manual, consulta Ventajas del etiquetado automático.

+ (GAIDictionaryBuilder *) createAppView

Devuelve un objeto GAIDictionaryBuilder con parámetros específicos de un hit de aplicación vista.

Ten en cuenta que usar este método no configurará el nombre de pantalla para los hits posteriores. Para ello, tienes que llamar a set:kGAIDescription value:<screenName> en la instancia de GAITracker.

Este método ya no está disponible. Usa createScreenView en su lugar.

+ (GAIDictionaryBuilder *) createScreenView

Devuelve un objeto GAIDictionaryBuilder con parámetros específicos de un hit de pantalla vista.

Ten en cuenta que usar este método no configurará el nombre de pantalla para los hits posteriores. Para ello, tienes que llamar a set:kGAIDescription value:<screenName> en la instancia de GAITracker.

+ (GAIDictionaryBuilder *) createEventWithCategory: (NSString *)  category
action: (NSString *)  action
label: (NSString *)  label
value: (NSNumber *)  value 

Devuelve un objeto GAIDictionaryBuilder con parámetros específicos de un hit de evento.

+ (GAIDictionaryBuilder *) createExceptionWithDescription: (NSString *)  description
withFatal: (NSNumber *)  fatal 

Devuelve un objeto GAIDictionaryBuilder con parámetros específicos de un hit de excepción.

+ (GAIDictionaryBuilder *) createItemWithTransactionId: (NSString *)  transactionId
name: (NSString *)  name
sku: (NSString *)  sku
category: (NSString *)  category
price: (NSNumber *)  price
quantity: (NSNumber *)  quantity
currencyCode: (NSString *)  currencyCode 

Devuelve un objeto GAIDictionaryBuilder con parámetros específicos de un hit de elemento.

+ (GAIDictionaryBuilder *) createSocialWithNetwork: (NSString *)  network
action: (NSString *)  action
target: (NSString *)  target 

Devuelve un objeto GAIDictionaryBuilder con parámetros específicos de un hit social.

+ (GAIDictionaryBuilder *) createTimingWithCategory: (NSString *)  category
interval: (NSNumber *)  intervalMillis
name: (NSString *)  name
label: (NSString *)  label 

Devuelve un objeto GAIDictionaryBuilder con parámetros específicos de un hit de tiempos.

+ (GAIDictionaryBuilder *) createTransactionWithId: (NSString *)  transactionId
affiliation: (NSString *)  affiliation
revenue: (NSNumber *)  revenue
tax: (NSNumber *)  tax
shipping: (NSNumber *)  shipping
currencyCode: (NSString *)  currencyCode 

Devuelve un objeto GAIDictionaryBuilder con parámetros específicos de un hit de transacción.

- (GAIDictionaryBuilder *) setProductAction: (GAIEcommerceProductAction *)  productAction

Configura el campo de acción de producto de este hit.

- (GAIDictionaryBuilder *) addProduct: (GAIEcommerceProduct *)  product

Agrega un producto a este hit.

- (GAIDictionaryBuilder *) addProductImpression: (GAIEcommerceProduct *)  product
impressionList: (NSString *)  name
impressionSource: (NSString *)  source 

Agrega una impresión de producto a este hit.

- (GAIDictionaryBuilder *) addPromotion: (GAIEcommercePromotion *)  promotion

Añade una promoción a este hit.