GuidesAPI Reference

API - Shortform

Suggest Edits

상세화면 재생

ShopLiveShortform.play(requestData : ShopLiveShortformCollectionData?)

Short-form 상세화면을 재생합니다. (ShopLiveShortformCollectionData에 연관된 재생 목록)

ShopLiveShortformCollectionData의 필드 값 중 하나 이상 넣으면 관련 상세화면을 재생할 수 있습니다.

ShopLiveShortformCollectionData이 null이라면 전체 상세화면을 재생할 수 있습니다.

ShopLiveShortformCollectionData

fieldtypedescription
shortsIdString?Short-form 고유의 아이디
shortsSrnString?shortsId 보다 많은 Short-form 정보가 포함된 값. shortsId 기반의 player를 원할 때 함께 parameter 전달하면 정확한 Short-form play 가능 (optional)
tags[String]?관련 Tag 검색을 할 수 있는 값
tagSearchOperatorShopLiveTagSearchOperator?Tag 검색 옵션
OR : Tag 통합 검색
AND : Tag 교차 검색
brands[String]?관련 Brand 검색을 할 수 있는 값 (제목, 식별자 모두 검색) 브랜드 생성 및 설정하기
shuffleBool? // default = false무작위 재생할 수 있는 값
기본값 : false
referrerString?경로를 추적할 수 있는 값 (데이터 인사이트에서 확인 가능)

전체 상세 재생

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?)

Short-form 미리보기를 재생합니다. ( ShopLiveShortformRelatedData에 연관된 재생 목록 )

ShopLiveShortformRelatedData의 필드 값 중 하나 이상 넣으면 관련 미리보기를 재생 할 수 있습니다.

ShopLiveShortformRelatedData

fieldtypedescription
productIdString?상품 고유의 아이디. 상품 등록 시 자동으로 발급 상품 생성하기
skuString?고객사에서 관리하는 상품 고유의 아이디를 설정할 수 있는 값 상품 생성하기
nameString?상품 이름
urlString?상품 URL
tags[String]?관련 Tag 검색을 할 수 있는 값
tagSearchOperatorShopLiveTagSearchOperator?Tag 검색 옵션
OR : Tag 통합 검색
AND : Tag 교차 검색
brands[String]?관련 Brand 검색을 할 수 있는 값 (제목, 식별자 모두 검색) 브랜드 생성 및 설정하기
shuffleBoolean? //default = false무작위 재생할 수 있는 값
기본값 : false
referrerString?경로를 추적할 수 있는 값 (데이터 인사이트에서 확인 가능)

ProductId 기반 미리보기 재생

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

Sku 기반 미리보기 재생

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()

실행 중인 Short-form 상세화면, 미리보기를 닫습니다.

ShopLiveShortform.close()

상세화면 버튼 숨김처리

Short-form 상세 화면의 버튼을 보여주게 할지 설정합니다.

ShopLiveShortformVisibleDetailData

fieldtypedescription
isLikeButtonVisibleBool좋아요 버튼을 숨김 처리할 수 있습니다. 기본값: true
isCommentButtonVisibleBool댓글 버튼을 숨김 처리할 수 있습니다. 기본값: true
isShareButtonVisibleBool공유 버튼을 숨김 처리할 수 있습니다. 기본값: true
isBookmarkVisibleBool북마크 버튼을 숨김 처리할 수 있습니다. 기본값: true
 var option = ShopLiveShortformVisibleDetailData()
 option.isLikeButtonVisible = true
 option.isCommentButtonVisible = true
 option.isShareButtonVisible = true
 option.isBookMarkVisible = true
 ShopLiveShortform.setVisibileDetailViews(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
    }
}

Updated about 2 months ago