Skip to content

A powerful BoothSDK designed to efficiently extract comprehensive product information from Booth.pm, a leading e-commerce platform. This toolkit streamlines the process of accessing and integrating product data, making it ideal for developers looking to enhance their applications with Booth.pm

Notifications You must be signed in to change notification settings

thisoverride/BoothSDK

Repository files navigation

はじめに

English version Here

Booth SDKは、人気のあるeコマースプラットフォームBooth.pmからさまざまな商品情報を抽出するためのウェブスクレイピングツールです。サイト上のすべての無料および有料商品の詳細情報を取得でき、無料商品のダウンロードも可能です。

貢献

Booth SDKの機能と使いやすさを向上させるための貢献を心より歓迎します。バグを見つけた場合、機能のリクエストがある場合、またはコードに貢献したい場合は、貢献ガイドラインに従ってください。

使用例

以下は、Booth SDKの使用例です。

import type { BoothProductOverview } from './@types/services/dto/Dto';
import type { BoothProductCollection } from './@types/services/ProductService';
import BoothPm from './core/BoothPm';

void (async () => {
  const booth = new BoothPm({ lang: 'en' });

  const listResult: BoothProductCollection = await booth.listProducts(0, {
    sortBy: BoothPm.FILTERS.LOVES,
    category: BoothPm.CATEGORIES.MODELS_3D,
    onlyFreeProducts: true
  });
  console.log(listResult);
  const { productId }: BoothProductOverview = listResult.items[8];
  const product = await booth.getProduct(productId);
  await booth.save({ boothProduct: product, path: './downloads' });
})();

API リファレンス

商品

  • listProducts(index: number = 1, filterOn?: ProductSearchFilter): 商品のリストを取得します。インデックスはページインデックスを指定し、デフォルトは1です。filterOnを使用して商品リストにフィルターを適用できます。
  • getProduct(productId: number): 特定の商品IDの詳細を取得します。
  • find(term: string, filterOn?: ProductSearchFilter): 指定された検索用語を使用して商品を検索します。filterOnで追加のフィルタリングが可能です。
  • autocomplete(query: string): クエリに基づいてオートコンプリートの提案を提供します。
  • save(downloadableData: DownloadableData): 指定された商品をダウンロードします。商品情報を含むdownloadableDataオブジェクトが必要です。

ウィッシュリスト

  • addToWishlist(productId: number, productName: string): 商品をウィッシュリストに追加します。
  • getWishlistItems(): ウィッシュリスト内のすべてのアイテムを取得します。
  • clearWishlist(): ウィッシュリストをクリアします。
  • removeFromWishlist(productId: number): 商品IDでウィッシュリストから商品を削除します。

ライセンス

このプロジェクトはMITライセンスの下でライセンスされています。詳細についてはLICENSEファイルをご参照ください。

About

A powerful BoothSDK designed to efficiently extract comprehensive product information from Booth.pm, a leading e-commerce platform. This toolkit streamlines the process of accessing and integrating product data, making it ideal for developers looking to enhance their applications with Booth.pm

Topics

Resources

Stars

Watchers

Forks

Packages

No packages published