- 印刷する
API - Shortform
- 印刷する
再生 - ショートフォームの詳細画面
ShopLiveShortform.play(context:Context, requestData: ShopLiveShortformCollectionData? = null)
ショートフォームの詳細画面を再生します。(ShopLiveShortformCollectionDataに関連付けられたプレイリスト)
ShopLiveShortformCollectionDataに1つ以上のフィールド値を入力すると、関連するショートフォームを詳細画面で再生できます。
ShopLiveShortformCollectionData が null の場合、登録されたすべてのショートフォーム動画が詳細画面で再生されます。
ShopLiveShortformCollectionData
フィールド
タイプ
説明
shortsId
String?
ショートフォームのユニークなID
shortsSrn
String?
ショートフォームに割り当てるリソースを管理するためのグローバルリソース名。これは、ShopLive が内部で使用する値です。
tags
List?
関連タグ検索に使用
tagSearchOperator
ShopLiveShortformTagSearchOperator?
タグ検索オプション
OR
: OR条件でタグを検索
AND
: AND条件でタグを検索brands
List?
ブランドを検索できる値(ブランド名、ブランドID(識別子)がどちらも検索対象)
shuffle
Boolean?
シャッフルするかどうかを選択 (デフォルト:
false
)referrer
String?
参照元情報についての値
ショートフォームの詳細画面を再生 - すべての動画
ショートフォームの詳細画面を再生 - 一覧をクリックして再生
ショートフォームの詳細画面を再生 - 関連タグ一覧をクリックして再生
ショートフォームの詳細画面を再生 - 関連するブランド一覧をクリックして再生
ショートフォームの詳細表示 - 指定したタグを持つ動画を再生
簡略形式の詳細表示 - 指定したブランドを持つ動画を再生
ShopLiveShortform.intent(context: Context, requestData: ShopLiveShortformCollectionData? = null)
ショートフォームの詳細画面を再生できるインテントを提供します。(ShopLiveShortformCollectionDataに関連付けられたプレイリスト)
ShopLiveShortformCollectionDataに1つ以上のフィールド値を入力すると、詳細画面で関連するショートフォームを再生できます。
ShopLiveShortformCollectionData が null の場合、詳細画面ですべてのショートフォームを再生できます。
ShopLiveShortformCollectionData
フィールド | タイプ | 説明 |
---|---|---|
shortsId | String? | ショートフォームのユニークID |
shortsSrn | String? | ショートフォームに割り当てるリソースを管理するためのグローバルリソース名。これは、Shoplive が内部で使用する値です。 |
tags | List? | タグで検索できる機能 |
tagSearchOperator | ShopLiveShortformTagSearchOperator? | タグ検索オプション
|
brands | List? | ブランドでショートフォームを検索(ブランド名、ブランドIDどちらも検索) |
shuffle | Boolean? | シャッフル再生 (デフォルト: |
referrer | String? | 参照元情報 |
ショートフォームの詳細画面 - 一覧をクリックして再生
val intent = ShopLiveShortform.intent(context, ShopLiveShortformCollectionData().apply {
shortsId = "{CLICKED_IN_LIST_SHORTS_ID}"
shortsSrn = "{CLICKED_IN_LIST_SHORTS_SRN}"
})
startActivity(intent)
ショートフォームの詳細画面 - 関連タグ一覧をクリックして再生
val intent = ShopLiveShortform.intent(context, ShopLiveShortformCollectionData().apply {
shortsId = "{CLICKED_IN_LIST_SHORTS_ID}"
shortsSrn = "{CLICKED_IN_LIST_SHORTS_SRN}"
tags = "{CLICKED_IN_LIST_TAGS}"
tagSearchOperator = "{CLICKED_IN_LIST_TAG_SEARCH_OPERATOR}"
})
startActivity(intent)
ショートフォームの詳細画面 - 関連するブランド一覧をクリックして再生
val intent = ShopLiveShortform.intent(context, ShopLiveShortformCollectionData().apply {
shortsId = "{CLICKED_IN_LIST_SHORTS_ID}"
shortsSrn = "{CLICKED_IN_LIST_SHORTS_SRN}"
brands = "{CLICKED_IN_LIST_BRANDS}"
})
startActivity(intent)
ショートフォームの詳細画面 - 指定したタグを持つ動画を再生
val intent = ShopLiveShortform.intent(context, ShopLiveShortformCollectionData().apply {
tags = "{YOUR_TAGS}"
tagSearchOperator = "{YOUR_SEARCH_OPERATOR}"
})
startActivity(intent)
ショートフォームの詳細画面 - 指定したブランドを持つ動画を再生
val intent = ShopLiveShortform.intent(context, ShopLiveShortformCollectionData().apply {
brands = "{YOUR_BRANDS}"
})
startActivity(intent)
詳細画面を閉じる
ショートフォームの詳細ビューを閉じます。
ShopLiveShortform.close()
詳細画面のボタンを非表示にする
ショートフォームの詳細のボタンを表示するかどうかを設定します。
ShopLiveShortfromVisibleFullTypeData
フィールド | タイプ | 説明 |
---|---|---|
isLikeButtonVisible | Boolean | 「いいね!」ボタンを非表示(デフォルト: |
isCommentButtonVisible | Boolean | コメントボタンを非表示(デフォルト: |
isShareButtonVisible | Boolean | 共有ボタンを非表示(デフォルト: |
isBookmarkVisible | Boolean | ブックマークを非表示(デフォルト: |
ショートフォームのプレビュー画面で再生する
ShopLiveShortform.showPreview(activity: Activity, data: ShopLiveShortformRelatedData)
ショートフォームのプレビューを再生します。(ShopLiveShortformRelatedDataに関連付けられたプレイリスト)
ShopLiveShortformRelatedDataにフィールド値を少なくとも1つ入力すると、関連するショートフォームをプレビュー画面で再生できます。
ShopLiveShortformRelatedData
フィールド | タイプ | 説明 |
---|---|---|
productId | Long? | 商品のユニークID。商品登録時に自動発行 |
sku | String? | 商品固有のSKU について |
name | String? | 商品名 |
URL | String? | 商品URL |
tags | List? | 関連タグを検索できる値 |
tagSearchOperator | ShopLiveShortformTagSearchOperator? | タグ検索オプション
|
brands | List? | ブランドでショートフォームを検索(ブランド名、ブランドIDどちらも検索) |
shuffle | Boolean | シャッフル再生 (デフォルト: |
referrer | String? | プレビュー画面の参照元情報 |
ショートフォームの プレビュー再生 - ProductIdを指定
ショートフォームのプレビュー再生 - SKU(商品ID)を指定
ショートフォームのプレビュー再生 - タグを指定
ショートフォームのプレビュー再生 - ブランドを指定して再生
コレクションの結果は、コールバックの形式で確認できます。
アプリケーション
再利用可能なRecyclerViewで事前にデータを受信して処理できます
ShopLiveShortformCollectionData
フィールド
タイプ
説明
shortsId
String?
ショートフォームのユニークID
shortsSrn
String?
短縮形に割り当てるリソースを管理するためのグローバルリソース名。これは、Shoplive が内部で使用する値です。
tags
List?
タグでショートフォームを検索
tagSearchOperator
ShopLiveShortformTagSearchOperator?
タグ検索オプション
OR
: OR条件で検索
AND
: AND条件で検索brands
List?
ブランドでショートフォームを検索(ブランド名、ブランドIDどちらも検索)
shuffle
Boolean?
シャッフル再生 (デフォルト:
false
)referrer
String?
参照元情報
ShopLiveShortformCollectionListener
機能
説明
onData(response: ShopLiveShortformCollectionResponse)
ShopLiveShortform.getが成功すると、Responseを受信して処理できます。
onError(e: Exception)
ShopLiveShortform.getが失敗した場合の例外を処理できます。
コレクションの結果は、コールバックの形式で確認できます。
アプリケーション
再利用可能なRecyclerViewで事前にデータを受信して処理できます
ShopLiveShortformCollectionData
フィールド
タイプ
説明
shortsId
String?
ショートフォームのユニークID
shortsSrn
String?
短縮形に割り当てるリソースを管理するためのグローバルリソース名。これは、Shoplive が内部で使用する値です。
tags
List?
タグでショートフォームを検索
tagSearchOperator
ShopLiveShortformTagSearchOperator?
タグ検索オプション
OR
: OR条件で検索
AND
: AND条件で検索brands
List?
ブランドでショートフォームを検索(ブランド名、ブランドIDどちらも検索)
shuffle
Boolean?
シャッフル再生 (デフォルト:
false
)referrer
String?
参照元情報
ShopLiveShortformCollectionListener
機能
説明
onData(response: ShopLiveShortformCollectionResponse)
ShopLiveShortform.getが成功すると、Responseを受信して処理できます。
onError(e:Exception)
ShopLiveShortform.getが失敗した場合の例外を処理できます。
val data = ShopLiveShortformCollectionData()
ShopLiveShortform.get(context, data, object : ShopLiveShortformCollectionListener {
// In background thread
override fun onData(response: ShopLiveShortformCollectionResponse) {
// Do something
}
override fun onError(e: Exception) {
// Handle error
}
})