L'API Embed fournit aux développeurs plusieurs composants intégrés permettant d'interroger et d'afficher des données de rapport. Tous les composants reposent sur une base commune et partagent donc un grand nombre de méthodes identiques. Cette section explique comment utiliser ces méthodes partagées. Pour en savoir plus sur chaque composant, consultez la documentation de référence sur les composants.
Options des composants
Les options du composant 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. Ses options actuelles sont renvoyées.
Interaction avec le composant
Les composants émettent des événements lorsqu'un événement important se produit, ce qui permet à d'autres composants de répondre lorsque ces événements se produisent. Pour enregistrer un gestionnaire avec un événement particulier, il vous suffit d'appeler la méthode on. Vous pouvez également utiliser la méthode once, qui est semblable à on, mais son gestionnaire ne sera appelé qu'une première fois, puis sera automatiquement supprimé. Pour supprimer un gestionnaire, vous pouvez utiliser la méthode off.
En général, vous écoutez uniquement 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 donne accès, si nécessaire, à de nombreuses autres API Google Analytics.
Les API suivantes sont disponibles pour 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