目次 x
    API - Shortform
      • 印刷する
      目次

      API - Shortform

        • 印刷する
        記事の要約

        再生 - ショートフォーム詳細画面

        ShopLiveShortform.play(requestData : ShopLiveShortformCollectionData?)

        ショートフォームの詳細画面を再生します。(ShopLiveShortformCollectionDataに関連付けられたプレイリスト)

        ShopLiveShortformCollectionDataに1つ以上のフィールド値を入力すると、関連するプレイリストが詳細画面で再生されます。

        ShopLiveShortformCollectionData が null の場合、すべての動画が詳細画面で再生されます。

        ShopLiveShortformCollectionData

        フィールド

        型

        説明

        shortsId

        String?

        ショートフォームごとのユニーク ID

        shortsSrn

        String?

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

        tags

        [String]?

        関連タグでショートフォームを検索

        tagSearchOperator

        ShopLiveTagSearchOperator?

        タグ検索オプション

        OR : OR条件で検索

        AND : AND条件で検索

        brands

        [String]?

        関連ブランドでショートフォームを検索 (ブランド名、ブランドIDをどちらも検索)

        shuffle

        Bool? // default = false

        シャッフル再生 (デフォルト: false)

        referrer

        String?

        詳細画面の参照元情報

        ショートフォームの詳細画面を再生 - すべての動画

        let requestCollectionData = ShopLiveShortformCollectionData()
ShopLiveShortform.play(requestData: requestCollectionData)

        ショートフォームの詳細画面を再生 - 一覧をクリックして再生

        let requestCollectionData = ShopLiveShortformCollectionData()
requestCollectionData.shortsId = "{YOUR_SHORTS_ID}"
requestCollectionData.shortsSrn = "{YOUR_SHORTS_SRN}"
ShopLiveShortform.play(requestData: requestCollectionData)

        ショートフォームの詳細画面を再生 - 関連タグ一覧をクリックして再生

        let requestCollectionData = ShopLiveShortformCollectionData()
requestCollectionData.shortsId = "{YOUR_SHORTS_ID}"
requestCollectionData.shortsSrn = "{YOUR_SHORTS_SRN}"
requestCollectionData.tags = ["testTag1","testTag2"]
requestCollectionData.tagSearchOperator = .OR
ShopLiveShortform.play(requestData: requestCollectionData)

        ショートフォームの詳細画面を再生 - 関連するブランド一覧をクリックして再生

        let requestCollectionData = ShopLiveShortformCollectionData()
requestCollectionData.shortsId = "{YOUR_SHORTS_ID}"
requestCollectionData.shortsSrn = "{YOUR_SHORTS_SRN}"
requestCollectionData.brands = ["brand1","brand2"]
ShopLiveShortform.play(requestData: requestCollectionData)

        ショートフォームの詳細画面を再生 - 指定したタグを持つ動画を再生

        let requestCollectionData = ShopLiveShortformCollectionData()
requestCollectionData.tags = ["testTag1","testTag2"]
requestCollectionData.tagSearchOperator = .OR
ShopLiveShortform.play(requestData: requestCollectionData)

        ショートフォームの詳細画面を再生 - 指定したブランドを持つ動画を再生

        let requestCollectionData = ShopLiveShortformCollectionData()
requestCollectionData.brands = ["brand1","brand2"]
ShopLiveShortform.play(requestData: requestCollectionData)

        再生 - ショートフォームプレビュー画面

        ShopLiveShortform.showPreview(requestData: ShopLiveShortformRelatedData?)

        ショートフォームのプレビューを再生します。(ShopLiveShortformRelatedDataに関連付けられたプレイリスト)

        ShopLiveShortformRelatedDataにフィールド値を少なくとも1つ入力すると、関連する動画がプレビュー画面で再生されます。

        ShopLiveShortformRelatedData

        フィールド

        型

        説明

        productId

        String?

        商品のユニーク ID。商品登録時にShopliveが自動的に発行したもの。

        sku

        String?

        商品固有のSKU （商品ID／商品登録時に指定したもの）

        name

        String?

        商品名

        url

        String?

        商品 URL

        tags

        [String]?

        商品タグで検索できる機能

        tagSearchOperator

        ShopLiveTagSearchOperator?

        タグ検索オプション

        OR : OR条件で検索

        AND : AND条件で検索

        brands

        [String]?

        ブランドでショートフォームを検索 (ブランド名、ブランドIDどちらも検索)

        shuffle

        Boolean? //default = false

        シャッフル再生 (デフォルト: false)

        referrer

        String?

        プレビュー画面の参照元情報

        ショートフォームの プレビュー再生 - ProductId を指定

        let requestRelatedData = ShopLiveShortformRelatedData()
requestRelatedData.productId = "{YOUR_PRODUCT_ID}"
ShopLiveShortform.showPreview(requestData: requestRelatedData)

        ショートフォームの プレビュー再生 - SKU（商品ID）を指定

        let requestRelatedData = ShopLiveShortformRelatedData()
requestRelatedData.sku = "{YOUR_PRODUCT_SKU}"
ShopLiveShortform.showPreview(requestData: requestRelatedData)

        ショートフォームの プレビュー再生 - タグを指定して再生

        let requestRelatedData = ShopLiveShortformRelatedData()
requestRelatedData.tags = ["tag1","tag2"]
requestRelatedData.tagSearchOperator = .OR
ShopLiveShortform.showPreview(requestData: requestRelatedData)

        ショートフォームの プレビュー再生 - ブランドを指定して再生

        let requestRelatedData = ShopLiveShortformRelatedData()
requestRelatedData.brands = ["brand1","brand2"]
ShopLiveShortform.showPreview(requestData: requestRelatedData)

        ショートフォームの詳細画面 / プレビューの終了

        ShopLiveShortform.close()

        現在実行中のショートフォームの詳細画面またはプレビューを閉じます。

        ShopLiveShortform.close()

        詳細画面のボタンを非表示にする

        ショートフォームの詳細画面でボタンを表示するかどうかを設定します。

        ShopLiveShortfromVisibleFullTypeData

        フィールド

        型

        説明

        isLikeButtonVisible

        Bool

        「いいね!」ボタンを隠す(デフォルト: true )

        isCommentButtonVisible

        Bool

        コメントを隠すボタン(デフォルト: true )

        isShareButtonVisible

        Bool

        共有ボタンを隠す(デフォルト: true )

        isBookmarkVisible

        Bool

        ブックマークを隠すボタン(デフォルト: true )

         var option = ShopLiveShortformVisibleFullTypeData()
 option.isLikeButtonVisible = true
 option.isCommentButtonVisible = true
 option.isShareButtonVisible = true
 option.isBookMarkVisible = true
 ShopLiveShortform.setVisibileFullTypeViews(options: option)

        ハイブリッド環境のための接続 API

        ShopLiveShortform.BridgeInterface.connect(_ webview: WKWebView)

        ハイブリッド環境でWeb と SDK を接続します。

        ShopLiveShortform.BridgeInterface.connect(webview)

        ShopLiveShortform.ShortsReceiveInterface.setHandler(_ handler: ShopLiveShortformReceiveHandlerDelegate?)

        ハイブリッド環境では、Web と SDK でメッセージを送受信します。

        ShopLiveShortform.ShortsReceiveInterface.setHandler(self)

        class CustomerViewController : UIViewController,  ShopLiveShortformReceiveHandlerDelegate {
    func handleShare(shareUrl: String) {
        // Do something
    }
    func onError(error: Error) {
        // Do something
    }
    
    func onEvent(command: String, payload: String?) {
        // Do something
    }
    
    func onDidDisAppear() {
        // Do something
    }
    
    func onDidAppear() {
        // Do something
    }
}

        What's Next