Metaframeのメソッドとイベントを探る

window.metaframeオブジェクト

スクリプトがロードされると、metaframeオブジェクトは、アプリケーションのグローバルなwindowオブジェクトで利用できるようになります。Metaframeオブジェクトには、ウェブアプリケーションでMetaframeを管理するのに必要なメソッドのリストが含まれています。

window.metaframe.createメソッド

メソッド署名：

window.metaframe.create: (parameters: {
 loginProjectId: string,
 merchantId?: number,
 projectId?: number,
 orbsApiHostId?: string,
 isMobile?: boolean,

}) => void;

ウェブアプリケーションのMetaframeを初期化します。このメソッドは、Metaframeの実行に必要な以下のパラメータを持つparametersオブジェクトを受け取ります：

window.metaframe.setIsMobileメソッド

メソッド署名：

window.metaframe.setIsMobile(isMobile: boolean)

Metaframeをデスクトップ版からモバイル版に、またはその逆に切り替えます。

window.metaframe.partnerActionsオブジェクト

オブジェクトにはMetaframeでアクションをトリガーするメソッドが含まれます。

このオブジェクトのメソッドを使用する前に、Metaframeが完全にロードされていることを確認する必要があります。これを行うには、Metaframeのロードイベントをサブスクリプします。イベントが処理されると、このオブジェクトのメソッドが使用可能になります。

Metaframeのロードイベントにリスナーを設定する例：

window.addEventListener("@metaframe-partner-events:app-loaded", () => {

 //Here you can use partner actions

});

window.metaframe.partnerActions.openBackpackItemPageメソッド

メソッド署名：

window.metaframe.partnerActions.openBackpackItemPage(itemId: string)

Backpackセクションで指定したアイテムのページを開きます。

このメソッドが正しく機能するためには、次の条件を満たす必要があります：

• アドミンページで「バックパック」機能が有効になっています。
• ユーザーはMetaframeに認証されます。

イベントの追跡

次のMetaframeイベントをサブスクライブできます：

カスタムセクションのイベントの追跡

Metaframeには、「アクション」タイプでカスタムセクションを追加できます。このセクションはボタンとして表示され、クリックするとウェブサイトを開くなどのアクションを実行します。

カスタムセクションをクリックしたイベントを追跡するには、@metaframe:custom-action:<ACTION_ID>イベントを登録する必要があります。<ACTION_ID>はカスタムセクション設定時にアドミンページで生成されたアクションIDです。

カスタムセクションクリックイベントのリスナーを設定する例：

document.addEventListener("@metaframe:custom-action:00000000-0000-0000-0000-000000000000", () => {

 // Your code here...

})