English version Here
Booth SDKは、人気のあるeコマースプラットフォームBooth.pmからさまざまな商品情報を抽出するためのウェブスクレイピングツールです。サイト上のすべての無料および有料商品の詳細情報を取得でき、無料商品のダウンロードも可能です。
Booth SDKの機能と使いやすさを向上させるための貢献を心より歓迎します。バグを見つけた場合、機能のリクエストがある場合、またはコードに貢献したい場合は、貢献ガイドラインに従ってください。
以下は、Booth SDKの使用例です。
import BoothSDK, { type BoothProductOverview, type BoothProductCollection } from 'booth-pm-sdk';
void (async () => {
const booth = new BoothSDK({ lang: 'en' });
const listResult: BoothProductCollection = await booth.listProducts(0, {
sortBy: BoothSDK.FILTERS.LOVES,
category: BoothSDK.CATEGORIES.MODELS_3D,
onlyFreeProducts: true
});
const { productId }: BoothProductOverview = listResult.items[8];
const product = await booth.getProduct(productId);
await booth.save({ boothProduct: product, path: './downloads' });
})();出力結果 :
{
id: 3652121,
description: 'Pastel Balayage Color Hair Textures and highlight sets. 9 colors. Each can be used separately. The Vroid beta version is compatible. According to terms of use, individual editing and use are possible. If you have any questions about the use of our products, please contact BOOTH store. If you want to use it commercially, please purchase the file you are selling under a commercial license on this link. Only licenses are different, and the contents of the file are the same. ▶ https://honeyrosy.booth.pm/items/4378160 Please check the Terms of Use and then check it. ▶ https://honeyrosy.fanbox.cc/posts/3391912 You can download the thumnail model eyes texture from this URL. ▶ https://honeyrosy.booth.pm/items/3653967',
category: {
id: 212,
name: 'VRoid'
},
name: '[無料/Free]【VRoid】Pastel Balayage Hair Textures&Highlight 髪のテクスチャ&ハイライト',
price: '0 JPY',
images: [
{
original: 'https://booth.pximg.net/45f6a0ab-9644-4b2f-af0f-8336e5564073/i/3652121/784bcd7b-bdf5-4554-aaa1-65a0680f05ea_base_resized.jpg',
resized: 'https://booth.pximg.net/c/72x72_a2_g5/45f6a0ab-9644-4b2f-af0f-8336e5564073/i/3652121/784bcd7b-bdf5-4554-aaa1-65a0680f05ea_base_resized.jpg'
},
{
original: 'https://booth.pximg.net/45f6a0ab-9644-4b2f-af0f-8336e5564073/i/3652121/9aadcb4b-169c-4f74-b629-e8d9e106f767_base_resized.jpg',
resized: 'https://booth.pximg.net/c/72x72_a2_g5/45f6a0ab-9644-4b2f-af0f-8336e5564073/i/3652121/9aadcb4b-169c-4f74-b629-e8d9e106f767_base_resized.jpg'
},
{
original: 'https://booth.pximg.net/45f6a0ab-9644-4b2f-af0f-8336e5564073/i/3652121/452d9d2e-4616-44f9-88dc-acda4b8025ec_base_resized.jpg',
resized: 'https://booth.pximg.net/c/72x72_a2_g5/45f6a0ab-9644-4b2f-af0f-8336e5564073/i/3652121/452d9d2e-4616-44f9-88dc-acda4b8025ec_base_resized.jpg'
},
{
original: 'https://booth.pximg.net/45f6a0ab-9644-4b2f-af0f-8336e5564073/i/3652121/2b698f96-edd1-4665-86ea-20fb07a54e59_base_resized.jpg',
resized: 'https://booth.pximg.net/c/72x72_a2_g5/45f6a0ab-9644-4b2f-af0f-8336e5564073/i/3652121/2b698f96-edd1-4665-86ea-20fb07a54e59_base_resized.jpg'
}
],
shop: {
name: 'HoneyRosy',
subdomain: 'honeyrosy',
thumbnail: 'https://booth.pximg.net/c/48x48/users/11512009/icon_image/a7f9d289-1a8e-401d-bcd5-ea8615578fd6_base_resized.jpg',
url: 'https://honeyrosy.booth.pm/'
},
isAdult: false,
liked: 10415,
downloadable: [
{
fileName: 'Pastel_Balayage_Color_Hair_Texture',
fileExtension: '.zip',
fileSize: '3.92 MB',
name: 'Pastel_Balayage_Color_Hair_Texture.zip',
url: 'https://booth.pm/downloadables/2336025'
}
]
};lang:'en' | 'ja'。必須。cookies:Record<string, string>（任意）。通常の商品閲覧には不要ですが、年齢確認済みのセッションを持つ場合など、特定のケースでリクエストに独自のCookieを送りたいときに使用します。
const booth = new BoothSDK({ lang: 'en', cookies: { my_cookie: 'value' } });自分のpixivアカウントでログインしたい場合は、SDKインスタンスのlogin()/disconnect()を使用できます。実際のブラウザウィンドウが開き、あなた自身がいつも通りログインします（パスワードをSDKに渡すことはありません）。
この機能はオプションの依存関係puppeteerを必要とします。使う場合のみ、別途インストールしてください。
npm install puppeteerimport BoothSDK from 'booth-pm-sdk';
const booth = new BoothSDK({ lang: 'en' });
await booth.login(); // 初回はブラウザが開くので、いつも通りpixivでログインしてください
const wished = await booth.getProduct(3563200); // 以降は認証済みセッションでリクエストされます
await booth.disconnect(); // セッションを破棄し、以降は未認証状態に戻ります（公開リソースへのアクセスは引き続き可能です）メールアドレスとパスワードを直接渡して自動化ブラウザ（puppeteer-extra + ステルスプラグイン）でログインするloginWithCredentials()も存在しますが、login()とは性質が大きく異なります：
- SDKがあなたのパスワードを（メモリ上のみで）扱います。ディスクへの書き込みは行いません。
- pixivのログインページにはCloudflareとreCAPTCHA Enterpriseによるボット対策が確認されており、この関数はそれを回避するステルスモードで自動入力を行います。これはpixivの利用規約に抵触する可能性があり、アカウントが制限される場合があります。
- CAPTCHAが検出された場合は、それを突破しようとせず明確なエラーで失敗します。
- デフォルトはヘッドレス実行です（
headless: falseでブラウザを表示可能）。
特別な理由がない限りlogin()を使用してください。使う場合は追加のオプション依存関係が必要です：
npm install puppeteer puppeteer-extra puppeteer-extra-plugin-stealthimport { loginWithCredentials } from 'booth-pm-sdk';
const cookies = await loginWithCredentials({ email: 'you@example.com', password: '...' });
const booth = new BoothSDK({ lang: 'en', cookies });booth.login(options?: { timeoutMs?: number; forceRelogin?: boolean; cachePath?: string }): 初回はブラウザウィンドウを開き、ユーザーのログイン完了を待ちます（デフォルトのタイムアウトは5分）。取得したセッションCookieは~/.booth-pm-sdk/session.json（cachePathで変更可、パーミッションは0600）に保存され、2回目以降の呼び出しはこのキャッシュを再利用してブラウザを開かずに即座に完了します。forceRelogin: trueを指定するとキャッシュを無視して必ずブラウザでの再ログインを行います。booth.disconnect(): キャッシュされたセッションを削除し、インスタンス生成時に渡したcookies（未指定なら空）に戻します。ログアウト後もSDKは引き続き公開リソースに正常にアクセスできます。- スタンドアロン関数の
login()/disconnect()（import { login, disconnect } from 'booth-pm-sdk'）も同じキャッシュ機構を使用しており、Cookieを自分で管理したい場合に利用できます。
login(options?): pixivでログインします（初回のみブラウザが開き、以降はキャッシュされたセッションを再利用します）。「ログイン (任意)」セクションを参照してください。disconnect(): キャッシュされたセッションを削除し、デフォルトのCookie状態に戻します。
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でウィッシュリストから商品を削除します。
このSDKはBooth.pmの公開HTMLをスクレイピングしているため、サイト側のマークアップ変更によって壊れる可能性があります。
- 年齢確認の壁（成人向けコンテンツ）が出た場合、
listProducts/findはエラーを投げます。ただし、listProducts/findの一覧結果に含まれる各商品のisAdultフラグ（一覧表示のバッジ由来）は、年齢確認済みセッション下でのみ検証されており、未検証です。確実な判定が必要な場合はgetProductが返すisAdult（API由来の値）を利用してください。 login()はbooth.pmのログインページ上のボタンのCSSセレクタに依存しています。他のスクレイピング部分と同様、Booth側がこのページのマークアップを変更すると動作しなくなる可能性があります。
このプロジェクトはMITライセンスの下でライセンスされています。詳細についてはLICENSEファイルをご参照ください。