# Freshsales に対する接続
Freshsales は直感的に使用できる CRM のため、販売担当者は営業の手間を省くことができます。電話と E メール、タスク、予約、メモが組み込まれているため、営業担当者は見込み客をフォローアップするためにタブを切り替える必要はありません。パイプラインビューを使用して取引をより適切に管理し、より多くの取引を成約に導くことができます。Freshsales ユーザーの場合は、AWS Glue を Freshsales アカウントに接続できます。その後、Freshsales を ETL ジョブのデータソースとして使用できます。これらのジョブを実行して、Freshsales から AWS サービス、またはその他のサポートされているアプリケーションにデータを転送します。
**Topics**
+ [Freshsales の AWS Glue サポート](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)
# Freshsales の AWS Glue サポート
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 の設定
AWS Glue を使用して Freshsales からデータを転送できるようにするには、次の要件を満たす必要があります。
## 最小要件
以下に、最小要件を示します。
+ Freshsales アカウントがある。
+ ユーザー API キーがある。
これらの要件を満たすと、Freshsales アカウントに AWS Glue を接続する準備が整います。一般的な接続では、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. AWS Glue でこの接続に使用する `secretName` を選択して、トークンを配置します。
1. ネットワークを使用する場合は、ネットワークオプションを選択します。
1. AWS Glue ジョブに関連付けられている IAM ロールに `secretName` を読み取るアクセス許可を付与します。
# Freshsales エンティティからの読み取り
**前提条件**
読み取り元の Freshsales オブジェクト。オブジェクト名が必要になります。
**ソースに対応するエンティティ**:
| エンティティ | フィルタリング可能 | 制限をサポートする | Order By をサポートする | Select \$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/ja_jp/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`(文字列) – (必須) 読み取りに使用されます。Freshsales のオブジェクトの名前。
+ `API_VERSION`(文字列) – (必須) 読み取りに使用されます。使用する Freshsales Rest API バージョン。
+ `SELECTED_FIELDS`(List) – Default: empty(SELECT \$1). 読み込みに使用されます。オブジェクトに選択する列です。
+ `FILTER_PREDICATE`(文字列) – デフォルト: 空 読み込みに使用されます。Spark SQL 形式である必要があります。
+ `QUERY`(文字列) - デフォルト: 空 読み込みに使用されます。完全な Spark SQL クエリです。
+ `PARTITION_FIELD`(文字列) - 読み取りに使用されます。クエリをパーティション化するために使用するフィールドです。
+ `LOWER_BOUND`(文字列) - 読み取りに使用されます。選択したパーティションフィールドの包括的な下限値。
+ `UPPER_BOUND` (文字列) - 読み取りに使用されます。選択したパーティションフィールドの排他的上限値。
+ `NUM_PARTITIONS`(整数) – デフォルト: 1。読み込みに使用されます。読み取り用のパーティションの数です。
+ `INSTANCE_URL`(文字列) - 読み取りに使用されます。有効な Freshsales インスタンス URL。
# Freshsales の制限事項
Freshsales の制限事項または注意事項は次のとおりです。
+ Freshsales では、API レート制限はアカウントあたり 1 時間ごとに 1000 件の API リクエストです (「[エラー](https://developer.freshsales.io/api/#error)」を参照。ただし、この制限はエンタープライズサブスクリプションプランで拡張できます (「[プランの比較](https://www.freshworks.com/crm/pricing-compare/)」を参照)。