Adobe CommerceのCatalog Serviceを試す〜前編

前回はAdobe Commerceで利用できる「Catalog Service」の概要についてご紹介しました。
今回はCatalog ServiceをAdobe Commerceにセットアップしてみたいと思います。

Catalog Serviceを使うには

Adobe CommerceでCatalog Serviceを使うには、以下の手順に沿って行います。

  1. エクステンションのインストールと有効化
  2. APIキーの取得
  3. APIキーの設定
  4. IndexerまたはCronの実行
  5. Data Management Dashboardで確認

では、順番に解説していきましょう。

エクステンションのインストールと有効化

まず最初はエクステンションのインストールです。

composer require magento/catalog-service

を実行し、Catalog Serviceとそれに必要なエクステンション群をインストールします。
Product RecommendationsやLive Searchをインストール済みの場合、インストールするエクステンション数が少なく済む可能性があります。

composerコマンドが正しく実行できたら、あとはエクステンションを有効化してデータベースを最新化しておきましょう。
（このあたりの操作はAdobe Commerce / Magento Open Sourceではいつものお作法なので割愛します）

APIキーの取得

Live Searchの紹介でも触れましたが、Catalog ServiceでもAPIキーが必要になります。
Live SearchやProduct Recommendationsが既にセットアップ済みの環境の場合はスキップしていただいて構いません。

まだAPIキーが未取得の場合は、account.magento.comにログインし、API Portalからキーを発行してください。

APIキーの設定

APIキーが取得できたら、利用する環境の

システム ＞ Commerce Services Connector

にアクセスし、

  • Sandbox Keys
  • Production Keys

にそれぞれ公開鍵と秘密鍵をセットします。

これでCatalog Serviceを使い始める準備は完了です。

IndexerまたはCronの実行

設定完了後は商品データなどをCatalog Serviceに同期します。この処理は通常CronまたはIndexer経由で行います。

Catalog Serviceを有効にしていると、下図のように通常よりもIndexerの数が増えます。
（翻訳されていないものがCatalog Serviceの利用するIndexerです）

 Indexer一覧

Indexer由来の負荷が増える可能性があるため、サーバースペックについては余裕を持っておくことをおすすめします。

Data Management Dashboardで確認

データ同期が無事に成功すると、Data Management Dashboardで同期状態を確認できるようになります。

 Catalog Serviceのデータ同期状態

この機能では、Product RecommendationsやLive Searchに連携しているデータも合わせて確認できます。

Product Recommendationsの同期状態

Live Searchの同期状態

もし、商品データが同期されない場合は

  1. もう少し待ってみる
  2. Cronが動いているか確認する
  3. Cronでエラーがでていないか確認する
  4. Adobe Commerceのログを確認する
  5. どうしてもわからない場合はAdobeのサポートに問い合わせる

という流れになります。

まとめと次回予告

今回のまとめです。

  • Catalog Serviceを利用したい場合は、専用のモジュールをインストールする
  • Catalog Serviceの初期設定は、Live SearchやProduct Recommendationsと同じ手順で行う
  • 初期設定後、データ同期はIndexerが行う。同期完了までには少し時間がかかる

次回はこの同期できたデータを利用して、実際にCatalog ServiceにGraphQLクエリを投げてみたいと思います。