BoothMate API Documentation - v0.4.0
    Preparing search index...
    Index

    Constructors

    Methods

    Constructors

    Methods

    • 商品を検索します。

      キーワードと検索条件を指定して商品を検索できます。 条件を省略すると全ての商品一覧を取得できます。

      Parameters

      • query: string

        検索キーワード

      • Optionalfilter: SearchFilter

        検索条件(カテゴリ、価格範囲など)

      Returns Promise<SearchResult>

      検索結果(商品リストとページネーション情報を含む)

      セッショントークン sessionToken は任意です。 指定すると、スキリストに追加済みかどうかの情報も各商品に含まれます。

      // すべての商品を取得
      await client.item.search();

      // キーワードのみで検索
      await client.item.search('VRChat');

      // キーワードとフィルタを指定して検索
      await client.item.search('VRChat', { sort: SortOrder.NEWEST });

      // 1番目の商品の商品IDを取得
      const result = await client.item.search('VRChat');
      const firstItemId = result.items[0].id;
    • 商品を検索します。

      検索条件のみを指定して商品を検索できます。 条件を省略すると全ての商品一覧を取得できます。

      Parameters

      • Optionalfilter: SearchFilter

        検索条件(カテゴリ、価格範囲など)

      Returns Promise<SearchResult>

      検索結果(商品リストとページネーション情報を含む)

      セッショントークン sessionToken は任意です。 指定すると、スキリストに追加済みかどうかの情報も各商品に含まれます。

      // すべての商品を取得
      await client.item.search();

      // フィルタのみで検索
      await client.item.search({ sort: SortOrder.NEWEST });

      // キーワードとフィルタを指定して検索
      await client.item.search({ query: 'VRChat', sort: SortOrder.NEWEST });

      // 1番目の商品の商品IDを取得
      const result = await client.item.search({ query: 'VRChat' });
      const firstItemId = result.items[0].id;
    • 商品の存在確認を行います。

      指定されたIDの商品が存在するかを確認します。item.getの戻り値で判断するより高速です。

      Parameters

      • itemId: number

        確認する商品のID

      Returns Promise<boolean>

      商品が存在する場合true、存在しない場合false

      // 商品ID 12345 が存在するか確認
      const exists = await client.item.exists(12345);
      if (exists) {
      console.log('商品は存在します');
      }
    • 商品の詳細情報を取得します。

      Parameters

      • itemId: number

        取得する商品のID

      • OptionalincludeContents: false

        コンテンツ情報を含めるかどうか(デフォルト: false) - true: 段落の内容とイベント名も含める(追加のHTTPリクエストが発生します) - false: 上記を除外した詳細情報を取得

      Returns Promise<undefined | Item>

      商品の詳細情報(存在しない場合はundefined)

      セッショントークン sessionToken は任意です。

      指定すると、スキリストに追加済みかどうかの情報も含まれます。

      // 商品ID 12345 の詳細情報を取得
      const item = await client.item.get(12345);
      if (item) {
      console.log(item.name);
      }

      // コンテンツ情報も含めて取得
      const itemWithContents = await client.item.get(12345, true);
      if (itemWithContents) {
      // 1段落目の内容を表示
      const paragraphs = itemWithContents.contents.filter(c => c.is_paragraph);
      console.log(paragraphs[0].text);
      }
    • 商品の詳細情報を取得します。

      Parameters

      • itemId: number

        取得する商品のID

      • OptionalincludeContents: true

        コンテンツ情報を含めるかどうか(デフォルト: false) - true: 段落の内容とイベント名も含める(追加のHTTPリクエストが発生します) - false: 上記を除外した詳細情報を取得

      Returns Promise<undefined | ItemWithContents>

      商品の詳細情報(存在しない場合はundefined)

      セッショントークン sessionToken は任意です。

      指定すると、スキリストに追加済みかどうかの情報も含まれます。

      // 商品ID 12345 の詳細情報を取得
      const item = await client.item.get(12345);
      if (item) {
      console.log(item.name);
      }

      // コンテンツ情報も含めて取得
      const itemWithContents = await client.item.get(12345, true);
      if (itemWithContents) {
      // 1段落目の内容を表示
      const paragraphs = itemWithContents.contents.filter(c => c.is_paragraph);
      console.log(paragraphs[0].text);
      }