Trabalho com componentes

A API de incorporação fornece aos desenvolvedores diversos componentes integrados para consultar e exibir dados de relatórios. Todos os componentes são integrados em uma base comum e, dessa forma, compartilham muitos dos mesmos métodos. Esta seção fornece uma visão geral de como usar esses métodos compartilhados. Para mais informações sobre os componentes individuais, consulte a referência de componentes.

Opções de componentes

As opções de componentes são definidas no momento da criação por meio da função de construtor, invocando o método set na instância. Para ver o estado da instância de um componente a qualquer momento, chame o método get para retornar suas opções atuais.

Interação de componentes

Os componentes emitem eventos quando algo importante acontece. Isso permite que outros componentes respondam quando esses eventos acontecem. Para registrar um gerenciador em um evento específico, chame o método on. Como opção, você pode usar o método once, que é semelhante ao on, mas o gerenciador dele será invocado somente na primeira vez e, depois, será removido automaticamente. Para remover um gerenciador, você pode usar o método off.

Em geral, você registrará somente os eventos padrão emitidos pelos componentes. No entanto, se você precisar emitir seu próprio evento, poderá fazer isso pelo método emit.

Biblioteca cliente do Google Analytics Client Library

A API de incorporação também carrega a biblioteca cliente do Google Analytics, que permite a você acessar muitas das outras Google Analytics APIs caso precise delas.

As APIs a seguir estão disponíveis nesses namespaces:

gapi.client.analytics.data.ga
gapi.client.analytics.data.mcf
gapi.client.analytics.data.realtime
gapi.client.analytics.management
gapi.client.analytics.metadata