创建/更新连接
- Activepieces 版本 0.34.5 或更高
- SDK 版本 0.3.2 或更高
我们保留相同的参数名称以实现向后兼容,任何从 \< 0.35.1 升级实例的用户不会遇到相关问题。
如果您的 Activepieces 实例版本 \< 0.45.0 并且(您正在使用嵌入 SDK 的 connect 方法,且需要在用户创建后返回连接的外部 ID,或者您想要重新连接具有特定外部 ID 的连接),您必须将实例升级到 >= 0.45.0。
- 您可以在 SaaS 中使用嵌入式 SDK,让用户创建连接并将其存储在 Activepieces 中。
```html theme={null}
<script>
activepieces.connect({pieceName:'@activepieces/piece-google-sheets'});
</script>
```
**Connect 参数:**
| 参数名称 | 必需 | 类型 | 描述 |
| -------------- | ---- | ----------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| pieceName | ✅ | string | 您要创建连接的 Piece 名称。 |
| connectionName | ❌ | string | 连接的外部 ID(您可以通过将鼠标悬停在连接表格中的连接名称上获取),提供后创建/更新的连接将使用此作为外部 ID 和显示名称。 |
| newWindow | ❌ | \{ width?: number, height?: number, top?: number, left?: number } | 如果设置,连接对话框将在新窗口中打开,而不是在占据整个页面的 iframe 中打开。 |
**Connect 结果**
`connect` 方法返回一个 `promise`,resolve 为以下内容:
```ts theme={null}
{
connection?: {
id: string,
name: string
}
}
```
<Info>
`name` 是连接的外部 ID。
如果用户关闭对话框且未创建连接,则 `connection` 为 undefined。
</Info>
<Tip>
您可以在 Builder 中使用 `connections` Piece 通过名称检索已创建的连接。
<img src="https://mintcdn.com/activepieces/ki8mFooo8mAmhMdP/resources/screenshots/connections-piece.png?fit=max&auto=format&n=ki8mFooo8mAmhMdP&q=85&s=9382f3f1a86808f5ed0bc606a35e45e5" alt="Builder 中的连接" width="1420" height="900" data-path="resources/screenshots/connections-piece.png" />
<img src="https://mintcdn.com/activepieces/ki8mFooo8mAmhMdP/resources/screenshots/connections-piece-usage.png?fit=max&auto=format&n=ki8mFooo8mAmhMdP&q=85&s=c422128afe4962d0ab2bc573ba6f1611" alt="Builder 中的连接使用" width="1420" height="900" data-path="resources/screenshots/connections-piece-usage.png" />
</Tip>