オンボーディングとインストール
カタログサービスをインストールして、 カタログサービス GraphQL APIを使用してCommerce インスタンスから製品データをリクエストおよび受信します。 カタログサービスは、repo.magento.com リポジトリからコンポーザーPHP メタパッケージとして配信されます。
必要システム構成
必要ソフトウェア構成
- Adobe Commerce 2.4.4以降
- PHP 8.1、8.2、8.3、8.4
- コンポーザー:2.x
サポートされているプラットフォーム
- Adobe Commerce on cloud インフラストラクチャ:2.4.4以降
- Adobe Commerce オンプレミス:2.4.4以降
エンドポイント
Catalog Serviceには、オンボーディングに使用できる2つのエンドポイントがあります。
- サンドボックス (
https://catalog-service-sandbox.adobe.io/graphql) – 本番稼働前のテストと検証に使用 - 実稼動(
https://catalog-service.adobe.io/graphql) - Commerce マーチャントおよびweb サイトのライブトラフィックに使用されます
すべてのCommerce テストインスタンスは、サンドボックスエンドポイントを使用します。
サンドボックスエンドポイントですべての読み込みテストを実行します。 読み込みテストを開始する前に、 サポートチケット を送信して、サービスチームが追加のサーバートラフィックを予測できるようにします。
インストールと設定
Adobe CommerceのCatalog Serviceを使い始めるには、次の手順が必要です。
- カタログサービス拡張機能(
magento/catalog-service)をインストールします - サービスとデータ書き出しの設定
- サービスへのアクセス
カタログサービス拡張機能のインストール
前提条件
-
repo.magento.comにアクセスして、拡張機能をインストールします。 キーの生成と必要な権限の取得については、認証キーの取得を参照してください。 クラウドインストールについては、Commerce on Cloud Infrastructure Guideを参照してください
-
Adobe Commerce アプリケーションサーバーのコマンドラインにアクセスします。
Adobe Commerce バージョン 2.4.4以降を実行しているAdobe Commerce インスタンスに、最新バージョンのカタログサービス拡張機能(magento/catalog-service)をインストールします。 カタログサービスは、repo.magento.com リポジトリからコンポーザーのメタパッケージとして配信されます。
Commerce Cloud インスタンスのCatalog Serviceをインストールするには、この方法を使用します。
-
ローカルワークステーションで、Adobe Commerce on cloud infrastructure プロジェクトのプロジェクトディレクトリに移動します。
note note NOTE Commerce プロジェクト環境のローカル管理について詳しくは、Adobe Commerce on Cloud Infrastructure ユーザーガイド の「CLIを使用した分岐の管理」を参照してください。 -
Adobe Commerce Cloud CLIを使用して更新する環境ブランチを確認します。
code language-shell magento-cloud environment:checkout <environment-id> -
カタログサービスモジュールを追加します。
code language-bash composer require magento/catalog-service --no-update -
パッケージの依存関係を更新します。
code language-bash composer update "magento/catalog-service" -
composer.jsonおよびcomposer.lockファイルのコード変更を追加、コミット、クラウド環境にプッシュします。code language-shell git add -A git commit -m "Add catalog service module" git push origin <branch-name>更新をクラウド環境にプッシュすると、Commerce クラウド デプロイメント プロセス が開始され、変更が適用されます。 デプロイ ログ のデプロイメント ステータスを確認します。
オンプレミス インスタンスのCatalog Serviceをインストールするには、この方法を使用します。
-
Composerを使用して、カタログサービスモジュールをプロジェクトに追加します。
code language-bash composer require magento/catalog-service --no-update -
依存関係を更新し、拡張機能をインストールします。
code language-bash composer update "magento/catalog-service" -
Adobe Commerceのアップグレード:
code language-bash bin/magento setup:upgrade -
キャッシュをクリアします。
code language-bash bin/magento cache:cleannote tip TIP 場合によっては、特に実稼動環境にデプロイする場合は、コンパイル済みコードの消去は時間がかかることがあるため、避けた方がよいでしょう。 変更を加える前に、システムを必ずバックアップしてください。
サービスとデータ書き出しの設定
Catalog Serviceをインストールしたら、次のタスクを実行して、カタログサービスをAdobe Commerce インスタンスと統合します。 この統合により、Commerce インスタンス、カタログサービス、およびその他のサポートサービス間のデータ同期と通信が可能になります。 データの同期は、SaaS データ書き出し拡張機能によって処理されます。
-
API キーを指定し、SaaS データスペースを選択して、Commerce サービスコネクタ を設定します。
Commerce Services Connectorの設定は、カタログサービス、ライブサーチ、商品レコメンデーションなどのAdobe Commerce サービスを使用するために必要な1回限りのプロセスです。 別のサービス用にコネクタを既に設定している場合は、この手順をスキップしてください。
-
データ管理ダッシュボード から最初のデータ同期を実行します。
カタログのサイズによっては、最初の同期に数分から数時間かかる場合があります。 同期ステータスは、データ管理ダッシュボードから監視できます。 最初の同期後、カタログは継続的に製品データを書き出して、サービスを最新の状態に保ちます。
note note NOTE また、Commerce CLIを使用して、コマンドラインから最初の同期を開始することもできます。 SaaS データ書き出しガイド の_初期同期_を参照してください。
カタログの書き出しが正しく実行されていることを確認するには:
- cron ジョブが実行中であることを確認します。
- インデックスが管理者から実行されているか、またはCommerce CLI コマンド
bin/magento indexer:infoを使用して実行されていることを確認します。 Catalog Attributes Feed, Product Feed, Product Overrides FeedおよびProduct Variant FeedのインデクサーがUpdate by Scheduleに設定されていることを確認します。
データ同期の監視とトラブルシューティング
Commerce Adminから、Data Management Dashboardを使用して同期プロセスをモニターできます。 Commerce CLIとログを使用して、プロセスの管理とトラブルシューティングを行います。