標準 API 直接連携

標準API直接連携は、顧客の製品情報をAPIを通じてgenserに直接送信する方式です。
genserの直接連携APIは、データの拡張性と相互運用性のために次のようなグローバル技術標準を準拠します。
JSON-LD & Schema.org: データに意味を与える構造化データフォーマットを使用し、Vertex AIが製品の文脈を完全に理解できるように支援します。
CloudEvents: すべての製品情報の変更を「イベント」として扱い、システム間の信頼性のあるデータ交換を保証します。
商品データを送信する (Send Data)
新規商品を登録する場合や、既存商品の情報(価格、在庫など)が変更されたときに以下の形式でデータを送信します。 JSON-LD および CloudEvents 標準規格に従います。
リクエスト本文 (Request Body)
商品収集APIを呼び出す際に本文(Body)に含めるべき最上位フィールドです。詳細な商品情報は @graph オブジェクトに入れて送信します。
@context
文字列
推奨
JSON-LDデータの基準辞書定義(値: https://schema.org/)
specversion
文字列
推奨
CloudEventsスペックバージョン(値: 1.0)
id
文字列
推奨
リクエストごとの固有識別子(UUIDなど)
type
文字列
推奨
イベントタイプ(例: create_product)
agent
オブジェクト
必須
データを送信する主体(システム)の識別値
@graph
オブジェクト
必須
実際の製品情報を含むProductオブジェクトのリスト
リソースオブジェクト (Resource Objects)
@type
文字列
必須
オブジェクトタイプ定義(値: Product)
sku
文字列
必須
社内で商品を区別する管理コード(例: A001-Red)
name
文字列
必須
顧客に表示される実際の商品の名前
category
オブジェクト
必須
サイトに陳列されるカテゴリ分類(例: 服 > メンズ > Tシャツ)
└ @type
文字列
必須
オブジェクトタイプ定義(値: CategoryCode)
└ name
文字列
必須
カテゴリ名称(例: スニーカー、アウター)
└ code
文字列
推奨
カテゴリ分類コード
brand
オブジェクト
必須
この商品を作ったブランド情報
└ @type
文字列
任意
オブジェクトタイプ定義(値: Brand)
└ id
文字列
必須
ブランドID
└ name
オブジェクト
必須
ブランド名、ブランド名の表記言語コード(例: ko)
description
オブジェクト
必須
商品説明、言語コード、商品説明の付加情報等
offers
オブジェクト
必須
価格および在庫情報オブジェクト
└ @type
文字列
任意
オブジェクトタイプ定義(値: Offer)
└ sku
文字列
必須
販売用SKU
└ gtin
文字列
必須
世界的に通用する製品固有番号(例: 880で始まるバーコード、EAN/UPC)
└ mpn
文字列
必須
メーカーが付与した部品番号や型番
└ price
数値
必須
顧客が実際に支払う最終販売金額
└ priceCurrency
文字列
必須
支払い通貨の基準(韓国はKRW、米国はUSDなど)
└ availability
文字列
必須
現在購入可能かどうか(値: InStock, OutOfStock, PreOrder)
└ availabilityStarts
日付
必須
商品販売が開始される日時(2025-11-28T10:00:00Z)
└ availabilityEnds
日付
必須
商品販売を終了する日時(2025-11-28T10:00:00Z)
└ shippingDetails
オブジェクト
任意
配送情報
└ image
オブジェクト
必須
商品画像
additionalProperty
配列
任意
関税申告用のHSコードやエコタグなど特殊な追加情報
└ @type
文字列
任意
情報がどのような形式かを定義(値: PropertyValue)
└ propertyID
文字列
任意
情報のラベル(ID)
html: ウェブ用のHTML説明seo_title: 検索表示用タイトルhsCode: 通関用関税コードsustainabilityTags: 環境配慮タグ
└ value
文字列
任意
ラベルに対応する実際の内容(例: ラベルが hsCodeなら、値は 851762)
多言語情報連携 (Multi-language Support)
単一のリクエストで複数言語の製品情報を同時に登録できます。グローバル販売のために商品名、ブランド、カテゴリなどのテキスト情報に多言語値を設定するには、該当フィールドをJSON配列(配列)に変更し、言語コード(@language)で区別して入力してください。
基本原則
単一言語: Object形式
{ "@value": "...", "@language": "ko" }多言語: 配列形式
[ { "ko" データ }, { "en" データ } ]
対応フィールド:
name,brand.name,category.name,positiveNotes,material,urlなど注意事項:
descriptionフィールドはinLanguage属性を使用して区別します。
レスポンスを確認する (Check Response)
API呼び出し後にHTTPステータスコードを確認して送信の成否を判断します。
ステータスコード (HTTP Status Codes)
最初に確認すべき応答ステータスコードです。
200 OK
成功
成功です。翌日00:15のバッチで反映されます。
400 Bad Request
リクエスト形式エラー
JSON構文が誤っているか、必須値(sku, name など)が欠落していないか確認してください。
401 Unauthorized
認証失敗
ヘッダーの apiKey 値が正しいか、空白がないか確認してください。
500 Internal Error
サーバーエラー
一時的な障害である可能性があります。しばらくしてから再試行(Retry)ロジックを実行してください。
最終更新
役に立ちましたか?
