Guides

Payload ガイド

bridge一覧

NameDescription
sauceclipEnterクリップ進入時のブリッジ呼び出し
sauceclipMoveExitクリップ進入時のブリッジ呼び出し
sauceclipMoveProduct商品ページ遷移クリック時のブリッジ呼び出し
sauceclipAddCartカート追加クリック時のブリッジ呼び出し
sauceclipMoveCartカートページ遷移クリック時のブリッジ呼び出し
sauceclipOnShare共有クリック時のブリッジ呼び出し
sauceclipPlayerErrorエラー情報に関するブリッジ
sauceclipTogglePlayフローティング状態での再生/停止トグルのブリッジ呼び出し

sauceclipEnter

クリップに進入した際に呼び出されます。

PayloadDescription
void空の値で呼び出されます。

sauceclipMoveExit

Xボタンをクリックする時に呼び出されます。

PayloadDescription
void空の値で呼び出されます。

商品プレビューまたは商品クリック時に呼び出されます。

PayloadTypeDescription
clipIdxStringクリップID情報
externalProductIdString商品コード
linkUrlString商品リンク
productIdInteger商品ID(ユニーク番号)

sauceclipAddCart

カートクリック時に呼び出されます。

PayloadTypeDescription
clipIdxStringクリップID情報
optionCodeString商品オプションコード
priceString商品価格
productCodeString商品コード
productIdInteger商品ID(ユニーク番号)
productImgString商品画像リンク
productNameString商品名

sauceclipMoveCart

カートを見るクリック時に呼び出されます。

PayloadDescription
void空の値で呼び出されます。

sauceclipOnShare

共有をクリックすると呼び出されます。

PayloadTypeDescription
clipIdStringクリップID
curationIdStringキュレーションID
linkUrlString共有用リンク
partnerIdStringパートナーID
tagsString[]クリップのタグリスト
thumbnailUrlStringクリップのサムネイル画像
titleStringクリップタイトル

エラー状態の際に呼び出されます。詳細は ブリッジエラーメッセージPayload をご参照ください。

PayloadTypeDescription
errorCodeStringエラーコード
errorDetailsStringエラーの詳細内容
errorTypeString ('api')エラータイプ

sauceclipTogglePlay

フローティング状態で「再生/停止」クリック時に呼び出されます。
通常の iframe では使用されませんが、ライブラリをWebViewとして使用する場合に適用可能です。

PayloadDescription
void空の値で呼び出されます。