Embed API 提供多個內建元件,方便開發人員查詢及顯示報表資料。所有元件皆以通用的基礎為基礎,因此共享許多相同方法。本節將概略說明如何使用這些共用方法。如要進一步瞭解個別元件,請參閱元件參考資料。
元件選項
元件選項可在建立時透過建構函式函式設定,方法是在執行個體上叫用 set 方法。如要在任何時間點取得元件執行個體的狀態,您可以呼叫 get
,然後傳回其目前的選項。
元件互動
元件會在發生重要事件時發出事件,讓其他元件可以在這些事件發生時做出回應。如要註冊特定事件的處理常式,只要呼叫 on
方法即可。您也可以使用 once
方法 (類似於 on
),但系統只會在第一次叫用其處理常式時,自動將其移除。如要移除處理常式,可以使用 off
方法。
通常,您只會監聽元件發出的預設事件,但如果您需要發出自己的事件,可以使用 emit
方法。
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