Skip to main content

プラグインの構造

Plugin SDKを使用してプラグインを作成すると、AI Marketerは/src/plugins/my-pluginフォルダに以下のようなボイラープレート構造を生成します。

AI Marketerのプラグインは2つの部分に分かれており、それぞれ異なるフォルダに配置され、異なるAPIを提供します。

プラグインの部分説明フォルダAPI
管理パネル管理パネルに表示される要素(コンポーネント、ナビゲーション、設定など)を含みますadmin/管理パネルAPI
バックエンドサーバーバックエンドサーバーに関連するもの(コンテンツタイプ、コントローラー、ミドルウェアなど)を含みますserver/サーバーAPI

✏️ 特定のユースケースにおける各部分の有用性について
  • サーバー専用プラグイン: APIを拡張するためにサーバー部分だけを使用するプラグインを作成できます。このようなプラグインには、表示または非表示のコンテンツタイプ、コントローラーアクション、および特定のユースケースに役立つルートが含まれている場合があります。この場合、プラグインに管理パネル用のインターフェースが必要ありません。

  • 管理パネルプラグイン vs. アプリケーション固有のカスタマイズ: 管理パネルにコンポーネントを注入するプラグインを作成できますが、/src/admin/index.js ファイルを作成して bootstrap ライフサイクル関数を呼び出すことでコンポーネントを注入することも可能です。この場合、プラグインを作成するかどうかは、そのコードを再利用して配布する予定があるか、または特定のAI Marketerアプリケーションにのみ役立つかによって決定されます。


:::AI Marketer 次に読むべきものは? AI Marketerプラグイン開発の次のステップでは、AI MarketerのプラグインAPIのいずれかを使用する必要があります。

プラグインAPIの使用方法を理解するための2つのリソースタイプがあります:

  • 管理パネルAPIおよびサーバーAPIのリファレンスドキュメントでは、AI Marketerプラグインでできることの概要を説明しています。
  • ガイドでは、特定のユースケースに基づく例をいくつか紹介しています。 :::