Embed API 为开发者提供了多个内置组件,方便其用于查询和显示报告数据。所有组件均基于共同的基础构建,因此会共享许多相同的方法。本节概述了如何使用这些共享方法。有关各个组件的更多信息,请参阅组件参考。
组件选项
您可以利用构造器函数,通过调用实例中的 set 方法在创建组件时设置组件选项。要获取组件实例在任意时间点的状态,您可以调用 get
,此组件的当前选项将在随后返回。
组件交互
组件会在发生重要情况时发出事件,以便其他组件在此类事件发生时作出响应。要注册特定事件的处理程序,只需调用 on
方法即可。另外,您也可以使用 once
方法,此方法与 on
方法相似,但其处理程序只会在事件第一次发生时被调用,然后便会被自动移除。要移除处理程序,您可以使用 off
方法。
通常来说,您只需要监听由相应组件发出的默认事件,但如果您需要发出自己的事件,则可以采用 emit
方法。
Google Analytics(分析)客户端库
Embed API 还加载了 Google Analytics(分析)客户端库,方便您在需要时访问多种其他 Google Analytics(分析)API。
以下 API 将通过相应命名空间提供:
gapi.client.analytics.data.ga gapi.client.analytics.data.mcf gapi.client.analytics.data.realtime gapi.client.analytics.management gapi.client.analytics.metadata