タクソノミー 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 エンドポイント)
category_tree リソースは、eBay カテゴリツリーの取得、サブツリーの取得、推奨カテゴリの検索、アスペクト情報の取得、および部品互換性情報の取得を提供します。
GET /category_tree/{category_tree_id}
getCategoryTree — category_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 | クエリ | 必須 | 取得する互換性プロパティ名(例: Trim、Engine)。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
| フィールド | 型 | 説明 |
categoryTreeId | string | カテゴリツリーの一意の識別子 |
categoryTreeVersion | string | カテゴリツリーのバージョン |
applicableMarketplaceIds | array[string] | このツリーを使用する eBay マーケットプレイス ID |
rootCategoryNode | CategoryTreeNode | ツリーのルートカテゴリノード |
CategoryTreeNode
| フィールド | 型 | 説明 |
category | Category | カテゴリ情報(ID と名前) |
categoryTreeNodeLevel | integer | ツリー内のノードのレベル(ルート = 0) |
childCategoryTreeNodes | array[CategoryTreeNode] | 子カテゴリノードの配列 |
leafCategoryTreeNode | boolean | リーフノードかどうか |
parentCategoryTreeNodeHref | string | 親ノードの URI |
Category
| フィールド | 型 | 説明 |
categoryId | string | カテゴリの一意の識別子 |
categoryName | string | カテゴリのローカライズされた名前 |
BaseCategoryTree
| フィールド | 型 | 説明 |
categoryTreeId | string | カテゴリツリーの一意の識別子 |
categoryTreeVersion | string | カテゴリツリーのバージョン |
CategorySubtree
| フィールド | 型 | 説明 |
categorySubtreeNode | CategoryTreeNode | サブツリーのルートノード |
categoryTreeId | string | カテゴリツリー ID |
categoryTreeVersion | string | カテゴリツリーバージョン |
カテゴリ候補
CategorySuggestionResponse
| フィールド | 型 | 説明 |
categorySuggestions | array[CategorySuggestion] | 推奨カテゴリの配列 |
categoryTreeId | string | カテゴリツリー ID |
categoryTreeVersion | string | カテゴリツリーバージョン |
CategorySuggestion
| フィールド | 型 | 説明 |
category | Category | 推奨カテゴリ |
categoryTreeNodeAncestors | array[AncestorReference] | 祖先ノードの配列(親からルートまで) |
categoryTreeNodeLevel | integer | ツリー内のレベル |
relevancy | string | クエリとの関連性 |
AncestorReference
| フィールド | 型 | 説明 |
categoryId | string | 祖先カテゴリ ID |
categoryName | string | 祖先カテゴリ名 |
categorySubtreeNodeHref | string | サブツリーノードの URI |
categoryTreeNodeLevel | integer | ツリー内のレベル |
アスペクト
AspectMetadata
| フィールド | 型 | 説明 |
aspects | array[Aspect] | カテゴリのアスペクト配列 |
Aspect
| フィールド | 型 | 説明 |
localizedAspectName | string | ローカライズされたアスペクト名 |
aspectConstraint | AspectConstraint | アスペクトの制約情報 |
aspectValues | array[AspectValue] | 許可される値の配列 |
relevanceIndicator | RelevanceIndicator | アスペクトの関連性指標 |
AspectConstraint
| フィールド | 型 | 説明 |
aspectApplicableTo | array[string] | 適用対象(ITEM / PRODUCT) |
aspectDataType | string | データ型: STRING, NUMBER, DATE, STRING_ARRAY |
aspectEnabledForVariations | boolean | バリエーションで使用可能かどうか |
aspectFormat | string | 値のフォーマットヒント |
aspectMaxLength | integer | 値の最大文字数 |
aspectMode | string | 入力モード: FREE_TEXT, SELECTION_ONLY |
aspectRequired | boolean | リストへの必須かどうか |
aspectUsage | string | 使用方法: RECOMMENDED, OPTIONAL |
expectedRequiredByDate | string | 必須化の予定日 |
itemToAspectCardinality | string | カーディナリティ: SINGLE, MULTI |
aspectAdvancedDataType | string | 高度なデータ型 |
AspectValue
| フィールド | 型 | 説明 |
localizedValue | string | ローカライズされた値 |
valueConstraints | array[ValueConstraint] | 値の制約(依存関係) |
ValueConstraint
| フィールド | 型 | 説明 |
applicableForLocalizedAspectName | string | 適用先のアスペクト名 |
applicableForLocalizedAspectValues | array[string] | 適用先のアスペクト値 |
RelevanceIndicator
| フィールド | 型 | 説明 |
searchCount | string | 検索件数に基づく関連性指標 |
GetCategoriesAspectResponse
| フィールド | 型 | 説明 |
categoryTreeId | string | カテゴリツリー ID |
categoryTreeVersion | string | カテゴリツリーバージョン |
categoryAspects | array[CategoryAspect] | カテゴリごとのアスペクト配列 |
CategoryAspect
| フィールド | 型 | 説明 |
category | Category | カテゴリ情報 |
aspects | array[Aspect] | そのカテゴリのアスペクト配列 |
互換性
GetCompatibilityMetadataResponse
| フィールド | 型 | 説明 |
compatibilityProperties | array[CompatibilityProperty] | 互換性プロパティの配列 |
CompatibilityProperty
| フィールド | 型 | 説明 |
name | string | プロパティ名(例: Make, Model, Year) |
localizedName | string | ローカライズされたプロパティ名 |
GetCompatibilityPropertyValuesResponse
| フィールド | 型 | 説明 |
compatibilityPropertyValues | array[CompatibilityPropertyValue] | 互換性プロパティ値の配列 |
CompatibilityPropertyValue
| フィールド | 型 | 説明 |
value | string | プロパティ値(例: Toyota, Camry, 2018) |
期限切れカテゴリ
ExpiredCategories
| フィールド | 型 | 説明 |
expiredCategories | array[ExpiredCategory] | 期限切れカテゴリのマッピング配列 |
ExpiredCategory
| フィールド | 型 | 説明 |
fromCategoryId | string | 期限切れカテゴリ ID |
toCategoryId | string | マッピング先のアクティブカテゴリ ID |
共通スキーマ
Error
| フィールド | 型 | 説明 |
category | string | エラーカテゴリ |
domain | string | エラードメイン |
errorId | integer | エラー ID |
message | string | 短いメッセージ |
longMessage | string | 詳細メッセージ |
inputRefIds | array[string] | 入力参照 ID |
outputRefIds | array[string] | 出力参照 ID |
parameters | array[ErrorParameter] | エラーパラメータ |
subdomain | string | エラーサブドメイン |
ErrorParameter
| フィールド | 型 | 説明 |
name | string | パラメータ名 |
value | string | パラメータ値 |
エンドポイント一覧(全 9 エンドポイント)
| メソッド |
エンドポイント |
operationId |
説明 |
| GET | /category_tree/{category_tree_id} | getCategoryTree | 完全なカテゴリツリーを取得 |
| GET | /category_tree/{category_tree_id}/fetch_item_aspects | fetchItemAspects | 全リーフカテゴリのアスペクトを一括取得 |
| GET | /category_tree/{category_tree_id}/get_category_subtree | getCategorySubtree | カテゴリサブツリーを取得 |
| GET | /category_tree/{category_tree_id}/get_category_suggestions | getCategorySuggestions | クエリに基づく推奨カテゴリを取得 |
| GET | /category_tree/{category_tree_id}/get_compatibility_properties | getCompatibilityProperties | 互換性プロパティを取得 |
| GET | /category_tree/{category_tree_id}/get_compatibility_property_values | getCompatibilityPropertyValues | 互換性プロパティ値を取得 |
| GET | /category_tree/{category_tree_id}/get_expired_categories | getExpiredCategories | 期限切れカテゴリのマッピングを取得 |
| GET | /category_tree/{category_tree_id}/get_item_aspects_for_category | getItemAspectsForCategory | カテゴリのアスペクトメタデータを取得 |
| GET | /get_default_category_tree_id | getDefaultCategoryTreeId | デフォルトカテゴリツリー ID を取得 |