Taxonomy API ドキュメント

タクソノミー API(Taxonomy API)

Taxonomy API は、販売者が在庫品を販売できる最も適切な eBay カテゴリと、購入者が購入する品物を閲覧または検索できる最も適切なカテゴリを見つけることができます。さらに、リストに含める必要のあるカテゴリの側面(アスペクト)と推奨されるカテゴリの側面に関するメタデータを提供し、部品の互換性情報を取得するための操作も備えています。

バージョン: v1.1.1

ベースURL: https://api.ebay.com/commerce/taxonomy/v1

認証(OAuth スコープ)

この API は クライアント資格情報(Client Credentials) フローを使用します。ユーザー認証は不要で、アプリケーショントークンのみで呼び出し可能です。

スコープ 説明
https://api.ebay.com/oauth/api_scope eBay の公開データを表示
https://api.ebay.com/oauth/api_scope/metadata.insights アスペクトの関連性などのメタデータインサイトを表示

リソース一覧

Taxonomy API は以下の 2 リソースカテゴリ、合計 9 エンドポイント(すべて GET)で構成されています。

リソース 説明
category_treeカテゴリツリーの取得・サブツリー・推奨カテゴリ・アスペクト・互換性プロパティ・期限切れカテゴリ8
get_default_category_tree_idマーケットプレイスのデフォルトカテゴリツリー ID を取得1

category_tree — カテゴリツリー管理(8 エンドポイント)

category_tree リソースは、eBay カテゴリツリーの取得、サブツリーの取得、推奨カテゴリの検索、アスペクト情報の取得、および部品互換性情報の取得を提供します。

GET /category_tree/{category_tree_id}

getCategoryTreecategory_tree_id で識別される完全なカテゴリツリーを取得します。応答には、指定された eBay カテゴリツリーのすべてのノードの詳細と、このカテゴリツリーを使用する eBay マーケットプレイスが含まれます。

注: このメソッドは非常に大きなペイロードを返す可能性があるため、gzip 圧縮がサポートされています。Accept-Encoding: gzip ヘッダーを含めてください。

パラメータ場所必須説明
category_tree_idパス必須eBay カテゴリツリーの一意の識別子。getDefaultCategoryTreeId で取得可能。
Accept-Encodingヘッダー任意圧縮エンコーディング。値は gzip に設定。

レスポンス: 200 → CategoryTree / 400 / 404 / 500

GET /category_tree/{category_tree_id}/fetch_item_aspects

fetchItemAspects — eBay マーケットプレイスに属するすべてのリーフカテゴリのアスペクトの完全なリストを返します。

注: 応答は content-type: application/octet-stream で gzip 圧縮された JSON ファイルとして返されます。ファイルは 100 MB を超える場合があります。.gz を処理するユーティリティで解凍してください。オープンソースの Taxonomy SDK を使用すると、バージョン間の変更を比較できます。

パラメータ場所必須説明
category_tree_idパス必須eBay カテゴリツリーの一意の識別子。

レスポンス: 200 → GetCategoriesAspectResponse(gzip 圧縮バイナリ)/ 400 / 404 / 500

GET /category_tree/{category_tree_id}/get_category_subtree

getCategorySubtree — カテゴリツリーの指定されたカテゴリの下にあるサブツリーのすべてのノードの詳細を取得します。

注: gzip 圧縮がサポートされています。Accept-Encoding: gzip ヘッダーを含めてください。

パラメータ場所必須説明
category_tree_idパス必須eBay カテゴリツリーの一意の識別子。
category_idクエリ必須サブツリーの最上位にあるカテゴリの ID。リーフノードの場合、そのノードのみが返されます。
Accept-Encodingヘッダー任意圧縮エンコーディング。値は gzip に設定。

レスポンス: 200 → CategorySubtree / 400 / 404 / 500

GET /category_tree/{category_tree_id}/get_category_suggestions

getCategorySuggestions — クエリ文字列に最も近いと判断されるカテゴリツリーのリーフノードの配列を返します。各推奨ノードのローカライズされた名前と、カテゴリの各祖先ノードの詳細が返されます。

重要: この呼び出しはサンドボックス環境ではサポートされていません。サンドボックスでは categoryName にランダムテキストが返されます。

パラメータ場所必須説明
category_tree_idパス必須eBay カテゴリツリーの一意の識別子。
qクエリ必須販売されている商品の説明または特徴を示す文字列。フレーズやキーワードの任意の組み合わせ。

レスポンス: 200 → CategorySuggestionResponse / 204 / 400 / 404 / 500

GET /category_tree/{category_tree_id}/get_compatibility_properties

getCompatibilityProperties — 自動車部品またはアクセサリと互換性のある自動車を定義するために使用される互換性プロパティ(メーカー、モデル、年式、エンジン、トリムなど)を取得します。

対応マーケットプレイス: eBay US (0)、eBay Motors US (100)、eBay Canada (2)、eBay UK (3)、eBay Germany (77)、eBay Australia (15)、eBay France (71)、eBay Italy (101)、eBay Spain (186)

パラメータ場所必須説明
category_tree_idパス必須カテゴリツリーの一意の識別子(対応マーケットプレイスの ID を使用)。
category_idクエリ必須部品互換性をサポートする eBay カテゴリの ID。

レスポンス: 200 → GetCompatibilityMetadataResponse / 204 / 400 / 404 / 500

GET /category_tree/{category_tree_id}/get_compatibility_property_values

getCompatibilityPropertyValues — 指定された eBay マーケットプレイス、カテゴリ、およびフィルターに基づいて、適用可能な互換性プロパティ値を取得します。compatibility_property で取得するプロパティを指定し、filter で結果を絞り込みます。

使用例: 2018 年型トヨタ カムリのトリムを取得する場合: compatibility_property=Trim&filter=Year:2018,Make:Toyota,Model:Camry

パラメータ場所必須説明
category_tree_idパス必須カテゴリツリーの一意の識別子。
compatibility_propertyクエリ必須取得する互換性プロパティ名(例: TrimEngine)。getCompatibilityProperties の応答から取得。
category_idクエリ必須部品互換性をサポートする eBay カテゴリの ID。
filterクエリ任意互換性プロパティ名/値のペアでフィルタリング。コロン (:) で名前と値を区切り、カンマ (,) で複数ペアを区切る。値にカンマが含まれる場合はバックスラッシュでエスケープ。

レスポンス: 200 → GetCompatibilityPropertyValuesResponse / 204 / 400 / 404 / 500

GET /category_tree/{category_tree_id}/get_expired_categories

getExpiredCategories — 指定されたカテゴリツリー内の期限切れのリーフカテゴリと、対応するアクティブなリーフカテゴリとのマッピングを取得します。複数の期限切れカテゴリが 1 つのアクティブカテゴリにマッピングされる場合があります。

注: このメソッドはマッピングされたカテゴリ(結合/分割カテゴリ)に関する情報のみ返します。対応するアクティブカテゴリがない期限切れカテゴリの情報は返しません。

パラメータ場所必須説明
category_tree_idパス必須eBay カテゴリツリーの一意の識別子。

レスポンス: 200 → ExpiredCategories / 204 / 400 / 404 / 500

GET /category_tree/{category_tree_id}/get_item_aspects_for_category

getItemAspectsForCategory — 指定されたリーフカテゴリ内のアイテムを正確に記述するのに適切または必要なアスペクトのリストを返します。各アスペクトのメタデータには以下が含まれます:

  • データ型、形式、入力モード
  • リストへの必須/推奨の区別
  • バリエーションでの使用可否
  • 複数値の受け入れ可否
  • 許可される値のリスト
パラメータ場所必須説明
category_tree_idパス必須eBay カテゴリツリーの一意の識別子。
category_idクエリ必須アスペクトを取得するリーフカテゴリの ID。リーフノードでない場合はエラー。

レスポンス: 200 → AspectMetadata / 204 / 400 / 404 / 500

get_default_category_tree_id — デフォルトカテゴリツリー ID(1 エンドポイント)

GET /get_default_category_tree_id

getDefaultCategoryTreeId — 指定された eBay マーケットプレイスに関連付けられたデフォルトのカテゴリツリーへの参照を取得します。応答にはツリーの一意の識別子とバージョンのみが含まれます。

パラメータ場所必須説明
marketplace_idクエリ必須カテゴリツリー ID が要求される eBay マーケットプレイスの識別子。サポートされているマーケットプレイスの一覧は こちら

レスポンス: 200 → BaseCategoryTree / 204 / 400 / 500

スキーマ定義(全 24 スキーマ)

カテゴリツリー

CategoryTree

フィールド説明
categoryTreeIdstringカテゴリツリーの一意の識別子
categoryTreeVersionstringカテゴリツリーのバージョン
applicableMarketplaceIdsarray[string]このツリーを使用する eBay マーケットプレイス ID
rootCategoryNodeCategoryTreeNodeツリーのルートカテゴリノード

CategoryTreeNode

フィールド説明
categoryCategoryカテゴリ情報(ID と名前)
categoryTreeNodeLevelintegerツリー内のノードのレベル(ルート = 0)
childCategoryTreeNodesarray[CategoryTreeNode]子カテゴリノードの配列
leafCategoryTreeNodebooleanリーフノードかどうか
parentCategoryTreeNodeHrefstring親ノードの URI

Category

フィールド説明
categoryIdstringカテゴリの一意の識別子
categoryNamestringカテゴリのローカライズされた名前

BaseCategoryTree

フィールド説明
categoryTreeIdstringカテゴリツリーの一意の識別子
categoryTreeVersionstringカテゴリツリーのバージョン

CategorySubtree

フィールド説明
categorySubtreeNodeCategoryTreeNodeサブツリーのルートノード
categoryTreeIdstringカテゴリツリー ID
categoryTreeVersionstringカテゴリツリーバージョン

カテゴリ候補

CategorySuggestionResponse

フィールド説明
categorySuggestionsarray[CategorySuggestion]推奨カテゴリの配列
categoryTreeIdstringカテゴリツリー ID
categoryTreeVersionstringカテゴリツリーバージョン

CategorySuggestion

フィールド説明
categoryCategory推奨カテゴリ
categoryTreeNodeAncestorsarray[AncestorReference]祖先ノードの配列(親からルートまで)
categoryTreeNodeLevelintegerツリー内のレベル
relevancystringクエリとの関連性

AncestorReference

フィールド説明
categoryIdstring祖先カテゴリ ID
categoryNamestring祖先カテゴリ名
categorySubtreeNodeHrefstringサブツリーノードの URI
categoryTreeNodeLevelintegerツリー内のレベル

アスペクト

AspectMetadata

フィールド説明
aspectsarray[Aspect]カテゴリのアスペクト配列

Aspect

フィールド説明
localizedAspectNamestringローカライズされたアスペクト名
aspectConstraintAspectConstraintアスペクトの制約情報
aspectValuesarray[AspectValue]許可される値の配列
relevanceIndicatorRelevanceIndicatorアスペクトの関連性指標

AspectConstraint

フィールド説明
aspectApplicableToarray[string]適用対象(ITEM / PRODUCT)
aspectDataTypestringデータ型: STRING, NUMBER, DATE, STRING_ARRAY
aspectEnabledForVariationsbooleanバリエーションで使用可能かどうか
aspectFormatstring値のフォーマットヒント
aspectMaxLengthinteger値の最大文字数
aspectModestring入力モード: FREE_TEXT, SELECTION_ONLY
aspectRequiredbooleanリストへの必須かどうか
aspectUsagestring使用方法: RECOMMENDED, OPTIONAL
expectedRequiredByDatestring必須化の予定日
itemToAspectCardinalitystringカーディナリティ: SINGLE, MULTI
aspectAdvancedDataTypestring高度なデータ型

AspectValue

フィールド説明
localizedValuestringローカライズされた値
valueConstraintsarray[ValueConstraint]値の制約(依存関係)

ValueConstraint

フィールド説明
applicableForLocalizedAspectNamestring適用先のアスペクト名
applicableForLocalizedAspectValuesarray[string]適用先のアスペクト値

RelevanceIndicator

フィールド説明
searchCountstring検索件数に基づく関連性指標

GetCategoriesAspectResponse

フィールド説明
categoryTreeIdstringカテゴリツリー ID
categoryTreeVersionstringカテゴリツリーバージョン
categoryAspectsarray[CategoryAspect]カテゴリごとのアスペクト配列

CategoryAspect

フィールド説明
categoryCategoryカテゴリ情報
aspectsarray[Aspect]そのカテゴリのアスペクト配列

互換性

GetCompatibilityMetadataResponse

フィールド説明
compatibilityPropertiesarray[CompatibilityProperty]互換性プロパティの配列

CompatibilityProperty

フィールド説明
namestringプロパティ名(例: Make, Model, Year)
localizedNamestringローカライズされたプロパティ名

GetCompatibilityPropertyValuesResponse

フィールド説明
compatibilityPropertyValuesarray[CompatibilityPropertyValue]互換性プロパティ値の配列

CompatibilityPropertyValue

フィールド説明
valuestringプロパティ値(例: Toyota, Camry, 2018)

期限切れカテゴリ

ExpiredCategories

フィールド説明
expiredCategoriesarray[ExpiredCategory]期限切れカテゴリのマッピング配列

ExpiredCategory

フィールド説明
fromCategoryIdstring期限切れカテゴリ ID
toCategoryIdstringマッピング先のアクティブカテゴリ ID

共通スキーマ

Error

フィールド説明
categorystringエラーカテゴリ
domainstringエラードメイン
errorIdintegerエラー ID
messagestring短いメッセージ
longMessagestring詳細メッセージ
inputRefIdsarray[string]入力参照 ID
outputRefIdsarray[string]出力参照 ID
parametersarray[ErrorParameter]エラーパラメータ
subdomainstringエラーサブドメイン

ErrorParameter

フィールド説明
namestringパラメータ名
valuestringパラメータ値

エンドポイント一覧(全 9 エンドポイント)

メソッド エンドポイント operationId 説明
GET/category_tree/{category_tree_id}getCategoryTree完全なカテゴリツリーを取得
GET/category_tree/{category_tree_id}/fetch_item_aspectsfetchItemAspects全リーフカテゴリのアスペクトを一括取得
GET/category_tree/{category_tree_id}/get_category_subtreegetCategorySubtreeカテゴリサブツリーを取得
GET/category_tree/{category_tree_id}/get_category_suggestionsgetCategorySuggestionsクエリに基づく推奨カテゴリを取得
GET/category_tree/{category_tree_id}/get_compatibility_propertiesgetCompatibilityProperties互換性プロパティを取得
GET/category_tree/{category_tree_id}/get_compatibility_property_valuesgetCompatibilityPropertyValues互換性プロパティ値を取得
GET/category_tree/{category_tree_id}/get_expired_categoriesgetExpiredCategories期限切れカテゴリのマッピングを取得
GET/category_tree/{category_tree_id}/get_item_aspects_for_categorygetItemAspectsForCategoryカテゴリのアスペクトメタデータを取得
GET/get_default_category_tree_idgetDefaultCategoryTreeIdデフォルトカテゴリツリー ID を取得
トップに戻る