Shortform API

    Shortform API


    記事の要約

    Installing a short-form

    https://pub.dev/packages/shoplive_player/install

    Depend on it

    Run this command:

    With Flutter:

     $ flutter pub add shoplive_player

    This will add a line like this to your package's pubspec.yaml (and run an implicit flutter pub get):

    dependencies:
      shoplive_player: ^1.6.5

    Alternatively, your editor might support flutter pub get. Check the docs for your editor to learn more.

    Import it

    Now in your Dart code, you can use:

    import 'package:shoplive_player/shoplive_player.dart';


    ショートフォームを実行する

    void play({required ShopLiveShortformCollectionData data})を押して、ショートフォームの詳細を再生します。

    • ShopLiveShortformCollectionDataに 1 つ以上のフィールド値を入力すると、関連する詳細画面を再生できます。

    ShopLiveShortformCollectionData

    プロパティ名

    種類

    形容

    ショートシッド

    糸。

    短い形式の一意の ID

    ショートコレクションID

    糸。

    短い形式のグループ ID

    ショーツSrn

    糸。

    ショート・フォームに割り当てるリソースを管理するためのグローバル・リソース名。これは、ShopLive が内部で使用する値です。

    タグ

    [文字列]?

    関連タグを検索できる値

    タグ検索演算子

    ShopLiveTagSearchオペレーター?

    タグ検索オプション

    • OR : 統合検索

    • AND : クロスサーチ

    ブランド

    [文字列]?

    関連ブランドで検索できる値(タイトル、すべての識別子)

    シャッフル

    ブール?デフォルト = false

    シャッフル可能な値(デフォルト: false)

    リファラー

    糸。

    トレースできる値

    イズミュート

    ブール?

    短縮形をミュート (デフォルト: false)

    代表

    ShopLiveShortformReceiveHandlerDelegate?

    ShopLiveShortformからさまざまなイベントを受け取るように委任します

    late final _shopLiveShortformPlugin = ShopLiveShortform();
    _shopLiveShortformPlugin.play(data: data);


    ショートフォームの終了

    void close()をクリックして、Shortformの詳細画面を終了します。

    late final _shopLiveShortformPlugin = ShopLiveShortform();
    _shopLiveShortformPlugin.close();


    短い形式の製品をクリックする機能

    Stream<ShopLiveShortformProductData> onClickProductShoplive Shortformで直接商品のクリックを開発します。 Create a product ガイドを参照してください。

    ShopLiveShortform製品データ

    財産

    種類

    形容

    ブランド

    糸。

    製品のブランド情報

    通貨

    糸。

    商品の通貨

    形容

    糸。

    製品の説明

    discount価格

    複。

    商品の割引価格

    割引率

    複。

    商品の割引率

    画像URL

    糸。

    商品画像URL

    名前

    糸。

    商品名

    オリジナル価格

    複。

    商品の通常価格

    製品ID

    長い。

    製品の一意の ID。製品登録時に自動発行

    ショープライス

    ブーリアン

    商品の目に見える価格

    SKUの

    糸。

    商品固有のSKU情報

    関連URL

    糸。

    商品詳細ページのURL

    late final _shopLiveShortformPlugin = ShopLiveShortform();
    _shopLiveShortformPlugin.onClickProduct.listen((data) {
      _showToast("onClickProduct : ${data.productId} ");
    });


    ショートフォームバナーのクリック可能性

    Stream<ShopliveShortformUrlData> onClickBannerShopliveを通じて、Shortformで直接バナーのクリックを開発します。 Create a productガイドを参照してください。

    ShopLiveShortform製品データ

    財産

    種類

    形容

    ブランド

    糸。

    製品のブランド情報

    通貨

    糸。

    商品の通貨

    形容

    糸。

    製品の説明

    discount価格

    複。

    商品の割引価格

    割引率

    複。

    商品の割引率

    画像URL

    糸。

    商品画像URL

    名前

    糸。

    商品名

    オリジナル価格

    複。

    商品の通常価格

    製品ID

    長い。

    製品の一意の ID。製品登録時に自動発行

    ショープライス

    ブーリアン

    商品の目に見える価格

    SKUの

    糸。

    商品固有のSKU情報

    関連URL

    糸。

    商品詳細ページのURL

    late final _shopLiveShortformPlugin = ShopLiveShortform();
    _shopLiveShortformPlugin.onClickBanner.listen((data) {
      _showToast("onClickBanner : ${data.url} ");
    });


    クリックして短いフォームを共有する

    Stream<ShopLiveShortformShareData> onShareShoplive Shortformから直接シェアクリック機能を開発します。

    late final _shopLiveShortformPlugin = ShopLiveShortform();
    _shopLiveShortformPlugin.onShare.listen((data) {
      _showToast("onClickShare : ${data.shortsId}, ${data.title}  ");
    });


    ショートフォームスタート通知機能

    Stream<ShopLiveBaseData> onStartShoplive Shortformが開始されたかどうかをお知らせします。

    late final _shopLiveShortformPlugin = ShopLiveShortform();
    _shopLiveShortformPlugin.onStart.listen((data) {
      _showToast("onShortformStarted");
    });


    ショートフォーム終了通知機能

    Stream<ShopLiveBaseData> onCloseは、Shopliveショートフォームがシャットダウンされたかどうかを通知します。

    late final _shopLiveShortformPlugin = ShopLiveShortform();
    _shopLiveShortformPlugin.onClose.listen((data) {
      _showToast("onShortformClosed");
    });


    短い形式のログ機能

    Stream<ShopliveShortformLogData> logShoplive Shortformがログを確認できるようにします。

    late final _shopLiveShortformPlugin = ShopLiveShortform();
    _shopLiveShortformPlugin.log.listen((data) {
      _showToast("onShortformEventLog : ${data.command}, ${data.payload} ");
    });


    What's Next