本文為英文版的機器翻譯版本，如內容有任何歧義或不一致之處，概以英文版為準。
# 連線至 Freshsales
Freshsales 是一種直覺式 CRM，可協助銷售代表擺脫銷售的猜測。使用內建電話和電子郵件、任務、預約及備註，銷售代表不需要在索引標籤之間切換，即可追蹤潛在客戶。您可以使用管道檢視更好地管理您的交易，並推動更多交易完成。如果您是 Freshsales 使用者，您可以 AWS Glue 連線到您的 Freshsales 帳戶。您可以使用 Freshsales 作為 ETL 任務中的資料來源。執行這些任務，將資料從 Freshsales 傳輸到 AWS 服務或其他支援的應用程式。
**Topics**
+ [AWS Glue 支援 Freshsales](freshsales-support.md)
+ [包含用於建立和使用連線的 API 操作的政策](freshsales-configuring-iam-permissions.md)
+ [設定 Freshsales](freshsales-configuring.md)
+ [設定 Freshsales 連線](freshsales-configuring-connections.md)
+ [從 Freshsales 實體中讀取](freshsales-reading-from-entities.md)
+ [Freshsales 連線選項](freshsales-connection-options.md)
+ [Freshsales 限制](freshsales-connection-limitations.md)
# AWS Glue 支援 Freshsales
AWS Glue 支援 Freshsales，如下所示：
**支援作為來源？**
是。您可以使用 AWS Glue ETL 任務來查詢來自 Freshsales 的資料。
**支援作為目標？**
否。
**支援的 Freshsales API 版本**
支援下列 Freshsales API 版本：
+ v1.0
# 包含用於建立和使用連線的 API 操作的政策
下列範例政策說明建立和使用 連線所需的 AWS IAM 許可。如果您要建立新角色，請建立包含下列項目的政策：
------
#### [ 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 主控台的使用者。
# 設定 Freshsales
您必須先符合下列要求，才能使用 從 Freshsales AWS Glue 傳輸資料：
## 最低需求
以下是最低要求：
+ 您具有 Freshsales 帳戶。
+ 您具有使用者 API 金鑰。
如果您符合這些要求，就可以 AWS Glue 連線到您的 Freshsales 帳戶。對於一般連線，您不需要在 Freshsales 中執行任何其他操作。
# 設定 Freshsales 連線
Freshsales 支援自訂身分驗證。
如需產生自訂身分驗證所需 API 金鑰的公有 Freshsales 文件，請參閱[身分驗證](https://developer.freshsales.io/api/#authentication)。
若要設定 Freshsales 連線，請執行以下操作：
1. 在 AWS Secrets Manager 中，使用下列詳細資訊建立秘密：
1. 對於客戶管理的連線應用程式 – 機密應包含以 `apiSecretKey` 作為金鑰的連線應用程式 API 金鑰。機密也需要包含另一個金鑰值對，其中包含 `apiKey` 作為金鑰和 `token` 作為值。
1. 注意：您必須為 中的連線建立秘密 AWS Glue。
1. 在 AWS Glue Glue Studio 中，依照下列步驟在**資料連線下建立連線**：
1. 選取**資料來源**時，選取 Freshsales。
1. 提供您要連線的 Freshsales 帳戶的 `INSTANCE_URL`。
1. 選取 AWS Glue 可以擔任並具有下列動作許可的 AWS IAM 角色：
------
#### [ JSON ]
****
```
{
"Version":"2012-10-17",
"Statement": [
{
"Effect": "Allow",
"Action": [
"secretsmanager:DescribeSecret",
"secretsmanager:GetSecretValue",
"secretsmanager:PutSecretValue",
"ec2:CreateNetworkInterface",
"ec2:DescribeNetworkInterfaces",
"ec2:DeleteNetworkInterface"
],
"Resource": "*"
}
]
}
```
------
1. 選取您要用於此連線`secretName`的 AWS Glue ，以放置字符。
1. 如果想要使用您的網路，請選取網路選項。
1. 授予與您的 AWS Glue 任務相關聯的 IAM 角色讀取 的許可`secretName`。
# 從 Freshsales 實體中讀取
**必要條件**
您想要從中讀取的 Freshdesk 物件。將需要物件名稱。
**來源的支援實體**：
| 實體 | 可以篩選 | 支援限制 | 支援排序依據 | 支援選取 \$1 | 支援分區 |
| --- | --- | --- | --- | --- | --- |
| 帳戶 | 是 | 是 | 是 | 是 | 是 |
| 聯絡人 | 是 | 是 | 是 | 是 | 是 |
**範例**：
```
freshSales_read = glueContext.create_dynamic_frame.from_options(
connection_type="freshsales",
connection_options={
"connectionName": "connectionName",
"ENTITY_NAME": "entityName",
"API_VERSION": "v1.0"
}
```
**Freshsales 實體和欄位詳細資訊**：
Freshsales 提供端點，可動態擷取支援實體的中繼資料。因此，運算子支援是在資料類型層級擷取的。
[\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/zh_tw/glue/latest/dg/freshsales-reading-from-entities.html)
## 分區查詢
**基於篩選條件的分區**：
如果想要在 Spark 中使用並行，可以提供其他 Spark 選項 `PARTITION_FIELD`、`LOWER_BOUND`、`UPPER_BOUND` 和 `NUM_PARTITIONS`。使用這些參數，原始查詢會分區為可由 Spark 任務並行執行的子查詢的 `NUM_PARTITIONS` 數目。
+ `PARTITION_FIELD`：用來分區查詢的欄位名稱。
+ `LOWER_BOUND`：所選分區欄位的**包含**下限值。
對於 Datetime 欄位，接受 ISO 格式的值。
有效值的範例：
```
"2024-09-30T01:01:01.000Z"
```
+ `UPPER_BOUND`：所選分區欄位的**唯一**上限值。
+ `NUM_PARTITIONS`：分區數目。
範例：
```
freshSales_read = glueContext.create_dynamic_frame.from_options(
connection_type="freshsales",
connection_options={
"connectionName": "connectionName",
"ENTITY_NAME": "entityName",
"API_VERSION": "v1",
"PARTITION_FIELD": "Created_Time"
"LOWER_BOUND": " 2024-10-15T21:16:25Z"
"UPPER_BOUND": " 2024-10-20T21:25:50Z"
"NUM_PARTITIONS": "10"
}
```
# Freshsales 連線選項
以下是 Freshsales 的連線選項：
+ `ENTITY_NAME`(String) - (必要) 用於讀取。Freshsales 中的物件名稱。
+ `API_VERSION`(String) - (必要) 用於讀取。您想要使用的 Freshsales Rest API 版本。
+ `SELECTED_FIELDS`(List) - 預設：empty(SELECT \$1)。用於讀取。您要為物件選取的資料欄。
+ `FILTER_PREDICATE`(String) - 預設：空白。用於讀取。其應該為 Spark SQL 格式。
+ `QUERY`(String) - 預設：空白。用於讀取。完整的 Spark SQL 查詢。
+ `PARTITION_FIELD`(String) - 用於讀取。用於分區查詢的欄位。
+ `LOWER_BOUND`(String) - 用於讀取。所選分區欄位的包含下限值。
+ `UPPER_BOUND`(String) - 用於讀取。所選分區欄位的唯一上限值。
+ `NUM_PARTITIONS`(Integer) - 預設：1。用於讀取。要讀取的分區數目。
+ `INSTANCE_URL`(String) - 用於讀取。有效的 Freshsales 執行個體 URL。
# Freshsales 限制
以下是 Freshsales 的限制或備註：
+ 在 Freshsales 中，API 速率限制為每個帳戶每小時 1,000 個 API 請求 (請參閱[錯誤](https://developer.freshsales.io/api/#error))。但此限制可透過企業訂閱計劃進行擴展 (請參閱[計劃比較](https://www.freshworks.com/crm/pricing-compare/))。