Referência de classe do GAIDictionaryBuilder

Mantenha tudo organizado com as coleções Salve e categorize o conteúdo com base nas suas preferências.

Visão geral

Classe auxiliar para criar um dicionário de valores e parâmetros de hit.


Exemplos:

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

Desse modo, será enviado um tipo de hit de evento com os parâmetros especificados e um parâmetro de dimensão personalizada.
Se você quer enviar um parâmetro com todos os hits, defina-o diretamente no GAITracker.

[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]];

Você pode substituir um valor definido no rastreador adicionando-o ao dicionário.

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

Os valores definidos por meio de [GAIDictionaryBuilder set] ou de [GAIDictionaryBuilder setAll] modificarão os valores existentes no objeto GAIDictionaryBuilder, como os inicializados por [GAIDictionaryBuilder createXYZ]. Por exemplo:

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];

Herda o NSObject.

Métodos de instância

(GAIDictionaryBuilder *) - setAll:
 Copia todos os pares de nome-valor dos parâmetros para esse objeto, ignorando todas as chaves que não sejam NSString e todos os valores que não sejam NSString ou NSNull. Mais...
 
(NSString *) - get:
 Retorna o valor do parâmetro de entrada paramName ou nil, se paramName não estiver presente. Mais...
 
(NSMutableDictionary *) - build
 Retorna um objeto NSMutableDictionary com todos os parâmetros definidos nele. Mais...
 
(GAIDictionaryBuilder *) - setCampaignParametersFromUrl:
 Analisa e converte parâmetros de campanha utm em parâmetros de campanha do Google Analytics e os retorna como um mapa. Mais...
 
(GAIDictionaryBuilder *) - setProductAction:
 Define o campo de ação do produto para esse hit. Mais...
 
(GAIDictionaryBuilder *) - addProduct:
 Adiciona um produto a esse hit. Mais...
 
(GAIDictionaryBuilder *) - addProductImpression:impressionList:impressionSource:
 Adiciona uma impressão de produto a esse hit. Mais...
 
(GAIDictionaryBuilder *) - addPromotion:
 Adiciona uma promoção a esse hit. Mais...
 

Métodos da classe

("Use createScreenView.") + createAppView
 Retorna um objeto GAIDictionaryBuilder com parâmetros específicos de um hit de visualização do aplicativo. Mais...
 
(GAIDictionaryBuilder *) + createScreenView
 Retorna um objeto GAIDictionaryBuilder com parâmetros específicos de um hit de exibição de tela. Mais...
 
(GAIDictionaryBuilder *) + createEventWithCategory:action:label:value:
 Retorna um objeto GAIDictionaryBuilder com parâmetros específicos de um hit de evento. Mais...
 
(GAIDictionaryBuilder *) + createExceptionWithDescription:withFatal:
 Retorna um objeto GAIDictionaryBuilder com parâmetros específicos de um hit de exceção. Mais...
 
(GAIDictionaryBuilder *) + createItemWithTransactionId:name:sku:category:price:quantity:currencyCode:
 Retorna um objeto GAIDictionaryBuilder com parâmetros específicos de um hit de item. Mais...
 
(GAIDictionaryBuilder *) + createSocialWithNetwork:action:target:
 Retorna um objeto GAIDictionaryBuilder com parâmetros específicos de um hit social. Mais...
 
(GAIDictionaryBuilder *) + createTimingWithCategory:interval:name:label:
 Retorna um objeto GAIDictionaryBuilder com parâmetros específicos de um hit de velocidade. Mais...
 
(GAIDictionaryBuilder *) + createTransactionWithId:affiliation:revenue:tax:shipping:currencyCode:
 Retorna um objeto GAIDictionaryBuilder com parâmetros específicos de um hit de transação. Mais...
 

Documentação do método

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

Copia todos os pares de nome-valor dos parâmetros para esse objeto, ignorando todas as chaves que não sejam NSString e todos os valores que não sejam NSString ou NSNull.

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

Retorna o valor do parâmetro de entrada paramName ou nil, se paramName não estiver presente.

- (NSMutableDictionary *) build

Retorna um objeto NSMutableDictionary com todos os parâmetros definidos nele.

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

Analisa e converte parâmetros de campanha utm em parâmetros de campanha do Google Analytics e os retorna como um mapa.

Parâmetros
paramsURL que contém parâmetros de campanha utm.

São parâmetros de campanha válidos:

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

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

Para mais informações sobre codificação automática e codificação manual, consulte Vantagens da codificação automática.

+ (GAIDictionaryBuilder *) createAppView

Retorna um objeto GAIDictionaryBuilder com parâmetros específicos de um hit de visualização do aplicativo.

O uso desse método não define o nome da tela para os hits seguintes. Para fazer isso, é necessário chamar set:kGAIDescription value:<screenName> na instância do GAITracker.

Esse método está obsoleto. Use createScreenView.

+ (GAIDictionaryBuilder *) createScreenView

Retorna um objeto GAIDictionaryBuilder com parâmetros específicos de um hit de exibição de tela.

O uso desse método não define o nome da tela para os hits seguintes. Para fazer isso, é necessário chamar set:kGAIDescription value:<screenName> na instância do GAITracker.

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

Retorna um objeto GAIDictionaryBuilder com parâmetros específicos de um hit de evento.

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

Retorna um objeto GAIDictionaryBuilder com parâmetros específicos de um hit de exceção.

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

Retorna um objeto GAIDictionaryBuilder com parâmetros específicos de um hit de item.

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

Retorna um objeto GAIDictionaryBuilder com parâmetros específicos de um hit social.

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

Retorna um objeto GAIDictionaryBuilder com parâmetros específicos de um hit de velocidade.

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

Retorna um objeto GAIDictionaryBuilder com parâmetros específicos de um hit de transação.

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

Define o campo de ação do produto para esse hit.

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

Adiciona um produto a esse hit.

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

Adiciona uma impressão de produto a esse hit.

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

Adiciona uma promoção a esse hit.