Skip to main content
MoEngage Catalog API を使用すると、商品やアイテムのカタログを管理できます。これらのエンドポイントを使用して、新しいカタログを作成し、カスタムスキーマを定義し、アイテムの取り込み、更新、削除を一括で実行できます。
  • ファイルベースのカタログと API ベースのカタログには相互運用性はありません。ファイルベースのカタログを API で更新したり、API ベースのカタログをファイルアップロードで更新したりすることはできません。
  • MoEngage では、カタログを設定する際に、id フィールドとして Variation ID ではなく Item ID を使用することをお勧めします。ユースケース上、識別子として Variation ID が必要な場合は、カスタマーサクセスマネージャーにお問い合わせください。

​
エンドポイント

Catalog API は、次のエンドポイントで構成されています。
  • Create Catalog: 一意の名前を持つ新しいカタログを作成します。
  • Add Catalog Attributes: カタログに新しい属性を追加します。
  • Add Items: 既存のカタログにアイテムを取り込みます。
  • Get Items: アイテムの属性の詳細を取得します。
  • Update Items: アイテムを新しい属性値で更新します。
  • Delete Items: 指定したカタログ内の既存のアイテムを削除します。

​
よくある質問

​
カタログの管理

API は、エラーコード duplicate-catalog-name とともに 409 Conflict エラーを返します。カタログ名はワークスペース内で一意である必要があります。
はい。Add Catalog Attributes (PATCH) エンドポイントを使用できます。スキーマに既に存在する属性を送信した場合、それらは無視され、レスポンスの duplicate-item-attributes 配列に一覧表示されます。
4 つの必須属性を含め、カタログごとに最大 50 個の属性を定義できます。
API カタログでは、価格や数量などのリアルタイム更新を自動化できます。処理スケジュールのたびにファイル全体を置き換える必要があるファイルベースのカタログとは異なり、特定の商品のみを更新するため、効率性とスケーラビリティが向上します。これらの API には任意の場所からアクセスして更新に使用できます。
各エラーコードは、エラーの種類を表す一意に定義された短縮表現です。事前に定義された一連のエラー条件に基づいて、問題の診断、トラブルシューティング、対処に使用できるクイックリファレンスとなります。
いいえ。カタログで属性が定義された後は、データ型を変更できません。必要に応じて、異なるデータ型で新しい属性をカタログに追加できます。
カタログには最大 50 個の属性を追加できます。
既存のアイテムを新しい属性で更新する前に、まず ‘Add catalog attribute’ API を使用して新しい属性をカタログスキーマに追加する必要があります。そうして初めて、新しい属性を含む更新リクエストが成功します。
リクエストは正常に処理され、そのようなアイテムは無効としてマークされます。レスポンスには、これらの無効なアイテム ID の数が含まれます。

​
アイテムの取り込みと更新

API は詳細な内訳とともに 200 OK を返します。レスポンス本文には、valid の件数と invalid の件数、およびどの document_ids がなぜ失敗したか (データ型の不一致や属性の欠落など) を示す details 配列が含まれます。
いいえ。id は主キーです。ID を変更するには、既存のアイテムを削除し、新しいアイテムとして取り込む必要があります。
はい。一括削除エンドポイントでは、1 回のリクエストあたり最大 50 個のアイテム ID がサポートされています。
MoEngage のカタログ API はすべて同期的に動作します。つまり、すべてのカタログ API リクエストはリアルタイムで処理され、変更をすぐに確認できます。

​
アイテムの詳細の取得

各エラーコードは、エラーの種類を表す一意に定義された短縮表現です。事前に定義された一連のエラー条件に基づいて、問題の診断、トラブルシューティング、対処に使用できるクイックリファレンスとなります。
いいえ。カタログで属性が定義された後は、データ型を変更できません。必要に応じて、Add new catalog attribute API を使用して、異なるデータ型で新しい属性をカタログに追加できます。

​
Postman コレクション

Postman コレクションを使用して、これらのエンドポイントをすぐにテストできます。Postman コレクションを表示