Utiliser des composants

L'API Embed fournit aux développeurs plusieurs composants intégrés pour interroger et afficher les données de rapport. Tous les composants reposent sur une base commune et partagent donc bon nombre des mêmes méthodes. Cette section explique comment utiliser ces méthodes partagées. Pour en savoir plus sur les composants individuels, consultez la documentation de référence sur les composants.

Options du composant

Les options des composants sont définies au moment de la création via la fonction constructeur en appelant la méthode set sur l'instance. Pour obtenir l'état d'une instance de composant à tout moment, vous pouvez appeler get et ses options actuelles seront renvoyées.

Interaction avec le composant

Les composants émettent des événements lorsqu'un événement important se produit, permettant à d'autres composants de répondre lorsqu'ils se produisent. Pour enregistrer un gestionnaire avec un événement particulier, appelez simplement la méthode on. Vous pouvez également utiliser la méthode once, qui est semblable à on, mais son gestionnaire ne sera appelé que la première fois, puis sera automatiquement supprimé. Pour supprimer un gestionnaire, vous pouvez utiliser la méthode off.

En règle générale, vous n'écoutez que les événements par défaut émis par les composants, mais si vous devez émettre votre propre événement, vous pouvez le faire via la méthode emit.

Bibliothèque cliente Analytics

L'API Embed charge également la bibliothèque cliente Google Analytics, qui vous permet d'accéder à de nombreuses autres API Google Analytics si vous en avez besoin.

Les API suivantes sont disponibles dans ces espaces de noms:

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