Visão geral
Classe de nível superior do Google Analytics para iOS.
Possibilita a criação de rastreadores e a definição de sinalizadores comportamentais.
Herda o NSObject.
Métodos de instância | |
(id< GAITracker >) | - trackerWithName:trackingId: |
Cria ou recupera uma implementação do GAITracker com o nome e o ID de acompanhamento especificados. Mais... | |
(id< GAITracker >) | - trackerWithTrackingId: |
Cria ou recupera uma implementação do GAITracker com o nome igual ao ID de acompanhamento especificado. Mais... | |
(void) | - removeTrackerByName: |
Remove um rastreador do dicionário de rastreadores. Mais... | |
(void) | - dispatch |
Envia as informações de acompanhamento pendentes. Mais... | |
(void) | - dispatchWithCompletionHandler: |
Envia o próximo beacon de acompanhamento da fila, chamando completionHandler depois que o beacon de acompanhamento é enviado (retornando kGAIDispatchGood) ou após um erro (retornando kGAIDispatchError). Mais... | |
Métodos da classe | |
(GAI *) | + sharedInstance |
Acessa a instância compartilhada da classe do Google Analytics para iOS. Mais... | |
Propriedades | |
id< GAITracker > | defaultTracker |
Por conveniência, essa classe expõe uma instância do rastreador padrão. Mais... | |
id< GAILogger > | logger |
O GAILogger a ser usado. Mais... | |
BOOL | optOut |
Quando é verdadeiro, nenhuma informação de acompanhamento é coletada. O acompanhamento de chamadas deixará de funcionar. Mais... | |
NSTimeInterval | dispatchInterval |
Se esse valor for positivo, as informações de acompanhamento serão enviadas automaticamente a cada segundo de dispatchInterval. Mais... | |
BOOL | trackUncaughtExceptions |
Quando definido como verdadeiro, o SDK grava o manipulador de exceções não identificadas atualmente registrado e depois grava um manipulador de exceções não identificadas que acompanha as exceções ocorridas com a utilização do defaultTracker. Mais... | |
BOOL | dryRun |
Quando é "SIM", nenhuma informação de acompanhamento é enviada. Mais... | |
Documentação do método
+ (GAI *) sharedInstance |
Acessa a instância compartilhada da classe do Google Analytics para iOS.
- (id<GAITracker>) trackerWithName: | (NSString *) | name | |
trackingId: | (NSString *) | trackingId | |
Cria ou recupera uma implementação do GAITracker com o nome e o ID de acompanhamento especificados.
Se o rastreador do nome especificado ainda não existir, ele será criado e retornado. Caso contrário, o rastreador existente será retornado. Se o rastreador existente do respectivo nome tiver outro ID de acompanhamento, tal ID não será alterado por esse método. Se defaultTracker não estiver definido, ele será definido como a instância do rastreador retornada aqui.
- Parâmetros
-
name Nome desse rastreador. Ele não pode ser nil
ou vazio.trackingID ID de acompanhamento a ser usado para esse rastreador. Ele deve estar no formato UA-xxxxx-y
.
- Retorna
- Um GAITracker associado ao nome especificado. O rastreador pode ser usado para enviar dados de acompanhamento ao Google Analytics. Na primeira vez que esse método é chamado com um nome específico, o rastreador desse nome é retornado, e as chamadas subsequentes com o mesmo nome retornam a mesma instância. Não é necessário manter o rastreador, pois ele será mantido internamente pela biblioteca.
Se ocorrer um erro ou o nome não for válido, esse método retornará nil
.
- (id<GAITracker>) trackerWithTrackingId: | (NSString *) | trackingId |
Cria ou recupera uma implementação do GAITracker com o nome igual ao ID de acompanhamento especificado.
Se o rastreador do respectivo nome ainda não existir, ele será criado, terá seu ID de acompanhamento definido como |trackingId| e será retornado. Caso contrário, o rastreador existente será retornado. Se o rastreador existente do respectivo nome tiver outro ID de acompanhamento, tal ID não será alterado por esse método. Se defaultTracker não estiver definido, ele será definido como a instância do rastreador retornada aqui.
- Parâmetros
-
trackingID ID de acompanhamento a ser usado para esse rastreador. Ele deve estar no formato UA-xxxxx-y
. O nome do rastreador é o mesmo de trackingID.
- Retorna
- Um GAITracker associado ao trackingID especificado. O rastreador pode ser usado para enviar dados de acompanhamento ao Google Analytics. Na primeira vez que esse método é chamado com um trackingID específico, o rastreador do respectivo nome é retornado, e as chamadas subsequentes com o mesmo trackingID retornam a mesma instância. Não é necessário manter o rastreador, pois ele será mantido internamente pela biblioteca.
Se ocorrer um erro ou o trackingID não for válido, esse método retornará nil
.
- (void) removeTrackerByName: | (NSString *) | name |
Remove um rastreador do dicionário de rastreadores.
Se for o rastreador padrão, ele também será limpo.
- Parâmetros
-
name Nome do rastreador.
- (void) dispatch |
Envia as informações de acompanhamento pendentes.
Ele não afeta dispatchInterval e pode ser usado em conjunto com o envio periódico.
- (void) dispatchWithCompletionHandler: | (void(^)(GAIDispatchResult result)) | completionHandler |
Envia o próximo beacon de acompanhamento da fila, chamando completionHandler depois que o beacon de acompanhamento é enviado (retornando kGAIDispatchGood) ou após um erro (retornando kGAIDispatchError).
Se não houver conexão de rede ou não houver dados a serem enviados, kGAIDispatchNoData será retornado.
Chamar esse método com um completionHandler diferente de zero desativa o envio periódico. Para reativar o envio periódico, defina o dispatchInterval como um número positivo quando o aplicativo for retomado do segundo plano.
Chamar esse método com um completionHandler igual a zero é o mesmo que chamar o envio acima.
Esse método pode ser usado para busca de dados de segundo plano no iOS 7.0 ou mais recente. Convém chamá-lo quando o aplicativo está saindo para iniciar o envio de informações de acompanhamento não enviadas.
- Parâmetros
-
completionHandler O bloco a ser executado após uma única solicitação de envio. O parâmetro GAIDispatchResult indica se o envio foi bem-sucedido, apresentou um erro ou não tinha hits a serem enviados.
Documentação da propriedade
|
(readwrite, nonatomic, assign) |
Por conveniência, essa classe expõe uma instância do rastreador padrão.
Ele é inicializado como nil
e será definido como o primeiro rastreador instanciado no trackerWithTrackingId:. Ele pode ser substituído conforme desejado.
Por padrão, a classe do GAITrackedViewController usa essa instância do rastreador.
|
(readwrite, nonatomic, assign) |
Quando é verdadeiro, nenhuma informação de acompanhamento é coletada. O acompanhamento de chamadas deixará de funcionar.
Quando definido como "true", todas as informações com upload pendente são excluídas. O valor dessa sinalização será persistido automaticamente pelo SDK. Os desenvolvedores têm a opção de usá-la para implementar uma configuração de desativação no aplicativo de modo a permitir que os usuários desativem o acompanhamento do Google Analytics.
Ele é definido como NO
na primeira vez que o SDK do Google Analytics é usado em um dispositivo e é persistido depois disso.
|
(readwrite, nonatomic, assign) |
Se esse valor for positivo, as informações de acompanhamento serão enviadas automaticamente a cada segundo de dispatchInterval.
Caso contrário, é necessário enviar as informações de acompanhamento manualmente chamando o envio.
Por padrão, ele é definido como 120
, o que indica que as informações de acompanhamento devem ser enviadas automaticamente a cada 120 segundos.
|
(readwrite, nonatomic, assign) |
Quando definido como verdadeiro, o SDK grava o manipulador de exceções não identificadas atualmente registrado e depois grava um manipulador de exceções não identificadas que acompanha as exceções ocorridas com a utilização do defaultTracker.
Se defaultTracker não for nil
, essa função acompanhará a exceção no rastreador e tentará enviar as informações de acompanhamento pendentes por cinco segundos. Então, ela chamará o manipulador de exceções registrado anteriormente, se houver. Quando definido novamente como falso, o manipulador de exceções não identificadas registrado anteriormente será restaurado.
|
(readwrite, nonatomic, assign) |
Quando é "SIM", nenhuma informação de acompanhamento é enviada.
O padrão é "NÃO".