---
updatedAt: 2025-12-10T02:55:20.000Z
agentTools:
  projectIndex: https://docs.sauce.im/v1.2/llms.txt
---

# Payload ガイド

# bridge一覧

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

# sauceclipEnter

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

| Payload | Description  |
| ------- | ------------ |
| void    | 空の値で呼び出されます。 |

# sauceclipMoveExit

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

| Payload | Description  |
| ------- | ------------ |
| void    | 空の値で呼び出されます。 |

# [sauceclipMoveProduct](https://docs.sauce.im/v1.2/docs/clip-share-bridge-jp)

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

| Payload           | Type    | Description  |
| ----------------- | ------- | :----------- |
| clipIdx           | String  | クリップID情報     |
| externalProductId | String  | 商品コード        |
| linkUrl           | String  | 商品リンク        |
| productId         | Integer | 商品ID（ユニーク番号） |

# sauceclipAddCart

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

| Payload     | Type    | Description  |
| :---------- | :------ | :----------- |
| clipIdx     | String  | クリップID情報     |
| optionCode  | String  | 商品オプションコード   |
| price       | String  | 商品価格         |
| productCode | String  | 商品コード        |
| productId   | Integer | 商品ID（ユニーク番号） |
| productImg  | String  | 商品画像リンク      |
| productName | String  | 商品名          |

# sauceclipMoveCart

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

| Payload | Description  |
| ------- | ------------ |
| void    | 空の値で呼び出されます。 |

# sauceclipOnShare

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

| Payload      | Type      | Description  |
| ------------ | --------- | :----------- |
| clipId       | String    | クリップID       |
| curationId   | String    | キュレーションID    |
| linkUrl      | String    | 共有用リンク       |
| partnerId    | String    | パートナーID      |
| tags         | String\[] | クリップのタグリスト   |
| thumbnailUrl | String    | クリップのサムネイル画像 |
| title        | String    | クリップタイトル     |

# [sauceclipPlayerError](https://docs.sauce.im/v1.2/docs/clip-error-bridge-payload-jp)

エラー状態の際に呼び出されます。詳細は [ブリッジエラーメッセージPayload](https://docs.sauce.im/v1.2/docs/clip-error-bridge-payload-jp) をご参照ください。

| Payload      | Type           | Description |
| :----------- | :------------- | :---------- |
| errorCode    | String         | エラーコード      |
| errorDetails | String         | エラーの詳細内容    |
| errorType    | String ('api') | エラータイプ      |

# sauceclipTogglePlay

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

| Payload | Description  |
| ------- | ------------ |
| void    | 空の値で呼び出されます。 |