ヘルプ
ログイン

アプリ拡張機能と関数

一部のアプリは、拡張機能や関数を使用してストアに機能を追加します。拡張機能と関数はアプリ開発者によって設定され、アプリをインストールして有効にすると利用できるようになります。

拡張機能によって、オンラインストア、チェックアウト、お客様アカウント、POS などの領域にアプリが機能を追加できるようになります。たとえば、アプリによって、チェックアウトページにカスタムフィールドを追加したり、オンラインストアでチャットボットを開いたり、お客様アカウントにロイヤルティポイントを表示したりできます。

Functions を使用すると、アプリでストアのバックエンドロジックをカスタマイズできます。たとえば、アプリは Functions を利用して、カスタムディスカウントのタイプを作成したり、チェックアウト時に配送オプションを調整したり、特定の決済ルールを適用したりできます。Functions は、アプリを設定した後、ストアの運用の一環として自動的に実行されます。

管理画面の設定 > アプリから、インストール済みアプリの拡張機能と Functions を表示・管理できます。アプリの概要ページの拡張機能カードと Functions カードには、現在有効な数と、ストア内で利用できるエリアを表示します。エリアのテキストにカーソルを合わせると、有効になっている場所を確認できます。拡張機能では「チェックアウト」、「お客様アカウント」、「オンラインストア」、「POS」など、Functions では「チェックアウト」、「ディスカウント」、「決済」、「配送と配達」などが該当します。

拡張機能または Functions をクリックすると、そのアプリの全一覧を表示できます。拡張機能ページまたは Functions ページでは、有効タブと無効タブを切り替えて、現在稼働している拡張機能や Functions を確認できます。拡張機能または Functions をクリックすると、その項目が開きます。拡張機能によっては、ストア内でその拡張機能を有効化・管理できるエリア、または拡張機能の正常性の詳細に移動します。

アプリ開発者の場合は、技術ドキュメントとして、拡張機能に関する Shopify dev docs および Functions に関する Shopify dev docs を参照してください。

このページの内容

拡張機能と Functions を有効にする

拡張機能と Functions の有効化や無効化は、Shopify 管理画面でそれらが使用される領域で行います。アプリの設定の [拡張機能] ページまたは [Functions] ページから、拡張機能または Functions の名前をクリックして、管理可能な領域に移動します。拡張機能または Functions を有効にすると、アプリの [概要] ページで [有効] と表示されます。

拡張機能の正常性の詳細を確認できる場合は、チェックアウトまたはお客様アカウントの拡張機能をクリックすると、エディターの代わりに正常性の詳細が開きます。これらの拡張機能のエディターを開くには、拡張機能の行にカーソルを合わせ、エディターで開く アイコンをクリックします。

拡張機能

拡張機能は、Shopify 管理画面の以下の領域で有効にすることができます。

Functions

Functions は、Shopify 管理画面の以下の領域で有効にすることができます。

拡張機能からのアプリエベント

アプリは、チェックアウトやお客様アカウントの拡張機能を使用して、Shopify にアプリエベントを送信できます。アプリエベントは、お客様がオファーを閲覧した際など、拡張機能でのアクションを記録します。Shopify はアプリエベントを使用して、お客様によるアプリの利用状況をストアの分析に表示します。アプリ開発者もこれらのイベントを閲覧し、独自の分析目的を含め、アプリの監視やサポートに役立てることができます。

チェックアウトやお客様アカウントでのアプリエベントは、お客様プライバシー設定でお客様が分析を許可した場合にのみ送信されます。マーチャントの分析用として、訪問者 ID とセッション ID に関連する集約された情報が、開発者のアプリエベントに付加されて Shopify からマーチャントに返される場合があります。ストアフロントでアプリにアプリエベントを送信させないようにするには、そのアプリをアンインストールしてください。

拡張機能の正常性について

拡張機能の正常性は、アプリのチェックアウトやお客様アカウントの拡張機能が、お客様の画面でどれだけ安定して読み込まれているかを示します。アプリ拡張機能の読み込みに失敗すると、お客様は、カスタムフィールドやロイヤリティポイントなど、その拡張機能がチェックアウトやお客様アカウントに追加する機能を利用できません。

拡張機能の正常性に関する考慮事項

アプリの拡張機能の正常性を表示する前に、以下の考慮事項を確認してください。

  • 正常性は、チェックアウトとお客様アカウントで有効になっている拡張機能についてのみ測定します。
  • オンラインストアや POS など、その他のエリアの拡張機能や Functions については、正常性を測定しません。
  • 失敗率は控えめに推定するため、読み込み回数が少ない拡張機能では、少数の失敗だけで問題ありと判定することは少なくなります。

拡張機能の正常性の表示方法

チェックアウトとお客様アカウントの各拡張機能には、以下のいずれかの正常性ステータスを表示します。

  • 良好：拡張機能の継続的な読み込み失敗は検出していません。
  • 警告：過去 7 日間の拡張機能の読み込みのうち 5% 超が失敗し、失敗率が 5% を超える状態が 72 時間続いています。
  • 重大：過去 7 日間の拡張機能の読み込みのうち 50% 超が失敗し、失敗率が 50% を超える状態が 48 時間続いています。
  • データ不足：拡張機能の正常性を測定するためのデータが不足しています。過去 7 日間の拡張機能の読み込み回数が 10 回未満の場合や、現在のバージョンにまだ十分な履歴がない場合に、このステータスを表示します。正常性は拡張機能のバージョンごとに測定するため、最近更新した拡張機能では、読み込み回数が多くても、新しいバージョンの稼働実績が 7 日間以上になるまで、このステータスを表示することがあります。

各拡張機能には詳細ページもあり、正常性のステータスと、過去 7 日間の以下の指標を表示します。

  • 失敗率：拡張機能の読み込みのうち、失敗した割合です。
  • 読み込み失敗：アプリの問題が原因で拡張機能を読み込めなかった回数です。
  • 拡張機能の読み込み回数：拡張機能を読み込んだ回数です。

拡張機能の正常性を確認

  1. 管理画面で、設定 > アプリに移動します。

  2. 確認するアプリをクリックします。

  3. 拡張機能をクリックします。

  4. 有効タブで、チェックアウトとお客様アカウントの各拡張機能の正常性列を確認します。

  5. 任意：詳細を確認するには、拡張機能名をクリックします。

拡張機能の読み込み失敗への対処

拡張機能のステータスが警告または重大の場合、拡張機能の詳細ページのバナーに、失敗の原因がアプリの問題であることと、アプリ開発者に通知済みであることを表示します。拡張機能をエディターで開くには、チェックアウトで開くまたはお客様アカウントで開くをクリックします。拡張機能についてサポートが必要な場合は、アプリ開発者にお問い合わせください。

拡張機能のステータスが重大になると、拡張機能の正常性を確認できるスタッフに、ストアのアラートフィードでアラートが届きます。アラートをクリックすると、拡張機能の詳細ページが開きます。

Functions エラーのトラブルシューティング

Functions でエラーが発生すると、アプリの [概要] ページにある [Functions] カードや Functions ページに警告が表示されます。そのカードには、通常の利用可能な領域の数の代わりに [[number] の領域でエラー] と表示され、警告には最新のエラーが検出された日時が示されます。

関数ページでは、エラーが発生している関数が Warning アイコンで強調表示されます。関数にエラーがある場合は、アプリ開発者に連絡してサポートを受けてください。場合によっては、エラーがすでに解決されていることもあります。また、関数ログを共有することで、開発者による問題のトラブルシューティングを支援することもできます。