# 连接到 Productboard
<a name="connecting-to-productboard"></a>

Productboard 是一种产品管理系统，有助于产品团队更快地将合适的产品推向市场。3000 多家以产品为主导的现代企业（例如 Zendesk、UiPath 和 Microsoft）都使用 Productboard 来了解用户的真正需求，确定待构建内容的优先级，以及让所有人都凝聚在企业的路线图周围。

**Topics**
+ [AWS Glue 对 Productboard 的支持](productboard-support.md)
+ [包含创建和使用连接的 API 操作的策略](productboard-configuring-iam-permissions.md)
+ [配置 Productboard](productboard-configuring.md)
+ [配置 Productboard 连接](productboard-configuring-connections.md)
+ [从 Productboard 实体中读取](productboard-reading-from-entities.md)
+ [Productboard 连接选项](productboard-connection-options.md)
+ [创建 Productboard 账户](productboard-create-account.md)
+ [限制](productboard-connector-limitations.md)

# AWS Glue 对 Productboard 的支持
<a name="productboard-support"></a>

AWS Glue 对 Productboard 的支持情况如下：

**是否支持作为来源？**  
是。可以使用 AWS Glue ETL 作业查询 Productboard 中的数据。

**是否支持作为目标？**  
否。

**支持的 Productboard API 版本**  
 v1 

# 包含创建和使用连接的 API 操作的策略
<a name="productboard-configuring-iam-permissions"></a>

以下示例策略描述了创建和使用连接所需的 AWS 权限。如果您要创建新角色，请创建包含以下内容的策略：

------
#### [ JSON ]

****  

```
{
  "Version":"2012-10-17",		 	 	 
  "Statement": [
    {
      "Effect": "Allow",
      "Action": [
        "glue:ListConnectionTypes",
        "glue:DescribeConnectionType",
        "glue:RefreshOAuth2Tokens",
        "glue:ListEntities",
        "glue:DescribeEntity"
      ],
      "Resource": "*"
    }
  ]
}
```

------

如果不想使用前述方法，也可以使用以下托管 IAM 策略：
+  [AWSGlueServiceRole](https://console.aws.amazon.com/iam/home#policies/arn:aws:iam::aws:policy/service-role/AWSGlueServiceRole)：授予对各种 AWS Glue 进程代表您运行所需的资源的访问权限。这些资源包括 AWS Glue、Amazon S3、IAM、CloudWatch Logs 和 Amazon EC2。如果您遵循此策略中指定的资源的命名约定，则 AWS Glue 进程具有所需的权限。此策略通常附加到在定义爬网程序、作业和开发终端节点时指定的角色。
+  [AWSGlueConsoleFullAccess](https://console.aws.amazon.com/iam/home#policies/arn:aws:iam::aws:policy/AWSGlueConsoleFullAccess)：策略所附加到的身份使用 AWS 管理控制台时，授予对 AWS Glue 资源的完全访问权限。如果遵循此策略中指定的资源的命名约定，则用户具有完全控制台功能。此策略通常附加到 AWS Glue 控制台的用户。

# 配置 Productboard
<a name="productboard-configuring"></a>

必须满足以下要求，才能使用 AWS Glue 从 Productboard 传输数据：

## 最低要求
<a name="productboard-configuring-min-requirements"></a>
+ 拥有一个 Productboard 账户以及相应的电子邮件地址和密码。有关创建账户的更多信息，请参阅 [Creating a Productboard account](productboard-create-account.md)。
+  必须创建一个可以访问 AWS Glue 服务的 AWS 账户。
+ 拥有 Productboard 账户的身份验证详细信息：如果想使用自定义身份验证，可以使用 JWT 令牌；如果想使用 OAuth2.0，可以使用客户端 ID 和密钥。
+ 如果用户想使用 `OAuth2.0`，请[在 Productboard 上注册应用程序](https://app.productboard.com/oauth2/applications/new)，然后按照 [How to integrate with Productboard via OAuth2 – 开发人员文档](https://developer.productboard.com/docs/how-to-integrate-with-productboard-via-oauth2-developer-documentation)中的说明设置应用程序。

如果满足这些要求，就可以将 AWS Glue 连接到 Productboard 账户。对于常见连接，无需在 Productboard 中执行其他操作。

# 配置 Productboard 连接
<a name="productboard-configuring-connections"></a>

 

Productboard 支持自定义身份验证和 `OAuth2.0`。对于 `OAuth2.0`，Productboard 支持 `AUTHORIZATION_CODE` 授权类型。
+ 此授权类型为“三足型”`OAuth`，因其依赖于将用户重定向到第三方授权服务器来对用户进行身份验证。它用于通过 AWS Glue 控制台创建连接。默认情况下，创建连接的用户可以依赖于 AWS Glue 拥有的关联应用程序，在该应用程序中，除了 Productboard Client ID 和客户端密钥之外，用户无需提供任何与 `OAuth` 相关的信息。AWS Glue 控制台会将用户重定向到 Productboard，用户必须登录并向 AWS Glue 授予所请求的权限，以访问其 Productboard 实例。
+ 用户仍然可以选择在 Productboard 中创建自己的关联应用程序，并在通过 AWS Glue 控制台创建连接时，提供自己的客户端 ID 和客户端密钥。在这种情况下，他们仍会重定向到 Productboard，以便登录并授权 AWS Glue 访问其资源。
+ 此授权类型会生成刷新令牌和访问令牌。访问令牌的有效期很短，可以通过刷新令牌在不需要用户干预的情况下自动刷新。
+ 有关为 `AUTHORIZATION_CODE OAuth` 流创建关联应用程序的 Productboard 公共文档，请参阅 [How to integrate with Productboard via OAuth2 - developer documentation](https://developer.productboard.com/docs/how-to-integrate-with-productboard-via-oauth2-developer-documentation)。

要配置 Productboard 连接，请执行以下操作：

1. 在 AWS Secrets Manager 中，创建一个包含以下详细信息的密钥：
   + 对于 `OAuth` 身份验证：对于客户托管的关联应用程序：密钥应包含关联应用程序的使用者密钥，并将 `USER_MANAGED_CLIENT_APPLICATION_CLIENT_SECRET` 作为键。
   + 对于 `Custom auth`：对于客户托管的关联应用程序：密钥应包含关联应用程序的 `JWT token`，并将 `access_token` 作为键。
**注意**  
必须在 AWS Glue 中为每个连接创建密钥。

1. 在 AWS Glue Studio 中，按照以下步骤在**数据连接**下创建连接：

   1. 选择**数据来源**时，请选择 Productboard。

   1. 选择 AWS Glue 可以代入并有权执行以下操作的 IAM 角色：

------
#### [ JSON ]

****  

      ```
      {
        "Version":"2012-10-17",		 	 	 
        "Statement": [
          {
            "Effect": "Allow",
            "Action": [
              "secretsmanager:DescribeSecret",
              "secretsmanager:GetSecretValue",
              "secretsmanager:PutSecretValue",
              "ec2:CreateNetworkInterface",
              "ec2:DescribeNetworkInterfaces",
              "ec2:DeleteNetworkInterface"
            ],
            "Resource": "*"
          }
        ]
      }
      ```

------

   1. 选择身份验证类型以连接到数据来源：
      + 对于 `OAuth` 身份验证：提供 `Token URL` 和 Productboard 应用程序的 `User Managed Client Application ClientId`。

   1. 在 AWS Glue 中选择您要用于此连接的 `secretName`，然后放置令牌。

   1.  如果要使用网络，请选择网络选项。

1. 向与您的 AWS Glue 作业关联的 IAM 角色授予读取 `secretName` 的权限。

1. 在 AWS Glue 作业配置中，提供 `connectionName` 作为附加网络连接。

# 从 Productboard 实体中读取
<a name="productboard-reading-from-entities"></a>

 **先决条件** 

要从中读取内容的 Productboard 对象。请参阅下面的支持的实体表，查看可用的实体。

 **支持的实体** 
+ [Abuse-reports](https://productboard.com/developer/marketing/api/campaign-abuse/)
+ [自动化](https://productboard.com/developer/marketing/api/automation/list-automations/)
+ [活动](https://productboard.com/developer/marketing/api/campaigns/list-campaigns/)
+ [Click-details](https://productboard.com/developer/marketing/api/link-clickers/)
+ [Lists](https://productboard.com/developer/marketing/api/link-clickers/)
+ [成员](https://productboard.com/developer/marketing/api/list-segment-members/)
+ [Open-details](https://productboard.com/developer/marketing/api/list-members/)
+ [Segments](https://productboard.com/developer/marketing/api/list-segments/)
+ [Stores](https://productboard.com/developer/marketing/api/ecommerce-stores/list-stores/)
+ [Unsubscribed](https://productboard.com/developer/marketing/api/unsub-reports/)


| 实体 | 可以筛选 | 支持限制 | 支持排序依据 | 支持 Select \$1 | 支持分区 | 
| --- | --- | --- | --- | --- | --- | 
|  功能  | 支持 | 是 | 否 | 是 | 是 | 
|  组件  | 否 | 是 | 否 | 是 | 否 | 
|  产品  | 否 | 是 | 否 | 是 | 否 | 
|  Feature Statuses  | 否 | 是 | 否 | 是 | 是 | 
|  Custom Field Definitions  | 否 | 是 | 否 | 是 | 否 | 
|  Custom Field Values  | 支持 | 是 | 否 | 是 | 否 | 

 **示例** 

```
Productboard_read = glueContext.create_dynamic_frame.from_options(
    connection_type="Productboard",
    connection_options={
        "connectionName": "connectionName",
        "ENTITY_NAME": "feature",
        "API_VERSION": "1"
    }
```

 **Productboard entity and field details** 
+ [功能](https://developer.productboard.com/#tag/features)
+ [组件](https://developer.productboard.com/#tag/components)
+ [Feature statuses](https://developer.productboard.com/#tag/statuses)
+ [产品](https://developer.productboard.com/#tag/products)
+ [Custom fields definitions](https://developer.productboard.com/#tag/hierarchyEntitiesCustomFields)
+ [Custom fields values](https://developer.productboard.com/#tag/hierarchyEntitiesCustomFieldsValues)

# Productboard 连接选项
<a name="productboard-connection-options"></a>

以下是 Productboard 的连接选项：
+  `ENTITY_NAME`（字符串）：（必填）用于读取/写入。Productboard 中对象的名称。
+ `API_VERSION`（字符串）：（必填）用于读取。要使用的 Productboard Engage Rest API 版本。例如：3.0。
+ `SELECTED_FIELDS`（列表<字符串>）–默认：empty(SELECT \$1)。用于读取。您想要为对象选择的列。
+ `FILTER_PREDICATE`（字符串）– 默认：空。用于读取。应采用 Spark SQL 格式。
+ `QUERY`（字符串）– 默认：空。用于读取。完整的 Spark SQL 查询。

# 创建 Productboard 账户
<a name="productboard-create-account"></a>

1. 导航到 [Productboard 注册页面](https://app.productboard.com/)，输入电子邮件 ID 和密码，然后选择**登录**。

1. 在**账户名称**字段中，输入 Productboard 账户名称，然后选择**我同意隐私政策**复选框。

1. 在**立即创建工作区**页面上的**工作区 URL** 字段中，输入新工作区的 URL。然后选择**继续**进入下一页并提供其余的详细信息。

   这会创建试用账户。可免费试用试用账户 15 天。试用期到期后，可以购买付费套餐。记下电子邮件地址、密码和工作区 URL。之后将需要这些信息来访问账户。

**注册 `OAuth2.0` 应用程序**

1. 导航到 [Productboard 登录页面](https://login.productboard.com/?locale=en)，输入电子邮件 ID 和密码，然后选择**登录**。

1. 选择右上角的**用户**图标，然后从下拉菜单中选择**账户和计费**。

1. 选择**其他**，然后从下拉菜单中选择**已注册的应用程序**。

1. 查找并选择**注册应用程序**。

1. 输入以下详细信息：
   + **应用程序名称**：应用程序的名称。
   + **公司/组织**：您的公司或组织名称。
   + **应用程序网站**：应用程序的网站。
   + **重定向 URI**：重定向 URI 模式是一个 URI 路径（或以逗号分隔的路径列表）；在登录流程完成后，Productboard 可以重定向（如果请求）到此路径。例如，`https://ap-southeast-2\\.console\\.aws\\.amazon\\.com`

1. 选择**创建**。

1. 将会显示**客户端 ID** 和**客户端密钥**。复制并将其保存在安全位置。然后选择**完成**。
**注意**  
使用 AppFlow 或 AWS Glue 期间，客户端 ID 和客户端密钥字符串是用于与此连接器建立连接的凭证。

**检索 CustomAuth 凭证**

1. 导航到 [Productboard 登录页面](https://app.productboard.com/)，输入电子邮件 ID 和密码，然后选择**登录**。

   您将重定向至主页。

1. 在主页上，导航到**工作区设置** > **集成** > **公有 API** > **访问令牌**。
**注意**  
如果**公有 API** 部分不可见，则您的账户可能购买了基础套餐。访问 API 令牌至少需要购买专业版套餐。套餐功能和名称可能会随时更改。有关套餐的更多信息，请参阅 [Productboard 定价](https://www.productboard.com/pricing/)。

1. 选择 **\$1** 生成新令牌，并确保将其安全存储，以备将来参考。

**创建 `OAuth2.0` 凭证**

要使用 Productboard 连接器进行 `OAuth2.0` 身份验证，需要在 Productboard 平台上注册应用程序并生成 `Client ID` 和 `Client Secret`。

1. 导航到 [Productboard 登录页面](https://app.productboard.com/)，输入电子邮件 ID 和密码，然后选择**登录**。

1. 要使用 Productboard 账户注册新的 OAuth2 应用程序，请导航到 [Producboard](to register new OAuth2 application with your Productboard account) 页面。

1. 填写必填字段，并为要访问的每个实体选择必要的范围。
**注意**  
您已选择以下四个范围，这四个范围是六个受支持的实体的必要范围。

1. **重定向 URL** 必须采用以下格式：`https://ap-southeast-2\\.console\\.aws\\.amazon\\.com`
**注意**  
Appflow 重定向 URL 可能会随时更改。一旦可用，请更新 AWS Glue 平台的重定向 URL。

1. 将会显示**客户端 ID** 和**客户端密钥**。复制并将其保存在安全位置。

1. 可以按照 [How to Integrate with Productboard via OAuth2](https://developer.productboard.com/docs/how-to-integrate-with-productboard-via-oauth2-developer-documentation) 开发人员文档中的步骤设置和验证 `OAuth2`。

# 限制
<a name="productboard-connector-limitations"></a>

以下是 Productboard 连接器的限制：
+ Productboard 不支持基于字段的分区或基于记录的分区。