Dimensões e métricas personalizadas: SDK para iOS

Este guia do desenvolvedor descreve como implementar as dimensões e métricas personalizadas com o SDK do Google Analytics para iOS v3.

Visão geral

As dimensões personalizadas permitem a associação de metadados a hits, usuários e sessões no Google Analytics, enquanto as métricas personalizadas permitem que você crie e incremente suas próprias métricas no Google Analytics.

  1. Configure a dimensão ou métrica personalizada por meio da interface da Web do Google Analytics. Saiba como configurar uma dimensão ou métrica personalizada (Central de Ajuda).
  2. Defina e envie valores de dimensões e métricas personalizadas de um aplicativo.

As dimensões e métricas personalizadas consistem em dois campos:

  • NSNumber Índice: o índice da dimensão ou métrica personalizada. Esse índice tem base 1.
  • NSString Valor: o valor da dimensão ou métrica personalizada. No caso das métricas, elas serão analisadas como um número inteiro ou um valor decimal com ponto fixo, se forem configuradas para um tipo de moeda.

Configuração e envio de valores

Para definir e enviar um valor de dimensão personalizada:

// May return nil if a tracker has not yet been initialized with a property ID.
id tracker = [[GAI sharedInstance] defaultTracker];

// Set the custom dimension value on the tracker using its index.
[tracker set:[GAIFields customDimensionForIndex:1]
       value:@"Premium user"];

[tracker set:kGAIScreenName
       value:@"Home screen"];

// Send the custom dimension value with a screen view.
// Note that the value only needs to be sent once, so it is set on the Map,
// not the tracker.

// Previous V3 SDK versions.
// [tracker send:[[[GAIDictionaryBuilder createAppView] set:@"premium"
//                                                   forKey:[GAIFields customDimensionForIndex:1]] build]];

// // SDK Version 3.08 and up.
[tracker send:[[[GAIDictionaryBuilder createScreenView] set:@"premium"
                                                     forKey:[GAIFields customDimensionForIndex:1]] build]];

Os valores das dimensões personalizadas podem ser enviados com qualquer tipo de hit do Google Analytics, incluindo exibições de tela, eventos, transações de comércio eletrônico, velocidades dos usuários e interações em redes sociais. O escopo definido da dimensão personalizada determinará, no momento do processamento, quais hits serão associados ao valor da dimensão.

Para definir e enviar um valor de métrica personalizada:

// May return nil if a tracker has not yet been initialized with a property ID.
id tracker = [[GAI sharedInstance] defaultTracker];


// Set the custom metric to be incremented by 5 using its index.
[tracker set:[GAIFields customMetricForIndex:1]
       value:[[NSNumber numberWithInt:5] stringValue]];


[tracker set:kGAIScreenName
       value:@"Home screen"];

// Custom metric value is sent with this screen view.
// [tracker send:[[GAIDictionaryBuilder createAppView] build]];     // Previous V3 SDK versions.
[tracker send:[[GAIDictionaryBuilder createScreenView] build]];     // SDK Version 3.08 and up.

Considerações sobre a implementação

Esta seção descreve considerações adicionais que você deve ter em mente ao implementar dimensões ou métricas personalizadas.

Considerações sobre dimensões personalizadas

Valores com escopo no nível do usuário e da sessão se aplicam a hits anteriores

  • Os valores de dimensões personalizadas com escopo no nível do usuário ou da sessão se aplicam a todos os hits na sessão atual, incluindo hits anteriores. Se você não quiser que um valor de dimensão personalizada com escopo no nível da sessão ou do usuário seja aplicado a hits anteriores na sessão atual, inicie uma nova sessão antes de aplicar o valor a um hit.
  • Por exemplo, se você estiver usando o tipo de associação como uma dimensão personalizada no nível do usuário, e um usuário fizer upgrade da associação dele durante uma sessão, convém iniciar uma nova sessão antes de definir o novo valor da dimensão personalizada. Isso garante que os hits anteriores ao upgrade sejam associados ao valor da associação anterior e os hits novos, ao novo valor.

Filtros de dimensões personalizadas e da vista da propriedade (perfil)

  • Os valores de dimensões personalizadas no nível do usuário ou da sessão continuarão sendo aplicados a todos os hits na sessão atual e/ou nas futuras, mesmo que o hit com o qual eles forem enviados seja filtrado em uma vista da propriedade (perfil).
  • Quando você aplica um filtro a um valor de dimensão personalizada, os hits são filtrados de acordo com o escopo do valor dessa dimensão personalizada. Saiba mais sobre como filtros e valores de dimensões personalizadas interagem quando seus dados são processados.

Considerações sobre métricas personalizadas

Os valores de métricas personalizadas são agregados em relatórios

  • Os valores de métricas personalizadas são agregados em relatórios, assim como outras métricas predefinidas no Google Analytics. Como resultado, você definiria um valor de métrica personalizada de 1 para incrementar o total agregado da métrica nos seus relatórios.

Métricas personalizadas e filtros da vista da propriedade (perfil)

  • Embora geralmente seja possível definir valores de métricas personalizadas sempre que for conveniente, evite definir valores de métricas personalizadas para hits que provavelmente serão filtrados das suas vistas da propriedade (perfis). Se um hit for filtrado por um filtro da vista da propriedade (perfil), todos os valores das métricas personalizadas associadas também serão filtrados. Saiba mais sobre dimensões e métricas personalizadas e filtros da vista da propriedade (perfil).

Definição de valores com a avaliação automática de telas

  • Para aplicar um valor de dimensão personalizada a uma exibição de tela enviada por meio de uma avaliação automática de telas, defina o valor durante o método viewDidAppear: do controlador de vista da propriedade. Por exemplo, o arquivo .m do controlador da sua vista da propriedade pode ter esta aparência:
#import "myViewController.h"
#import "GAI.h"

@implementation myViewController

-(void)viewDidAppear
{
    id<GAITracker> tracker = [[GAI sharedInstance] defaultTracker];  // Get the tracker object.
    [tracker set:[GAIFields customDimensionForIndex:1]
           value:@"premium"];
    [super viewDidAppear:animated];   // Custom dimension value will be sent with the screen view.

}

// The remainder of the implementation is omitted.

Não envie informações de identificação pessoal (PII, na sigla em inglês) como valores

  • Os Termos de Serviço do Google Analytics proíbem o envio de informações de identificação pessoal (PII) aos servidores do Google Analytics. Para mais informações, consulte os Termos de Serviço.