# PayPal に対する接続
PayPal は、顧客とオンラインベンダー間の送金など、当事者間のオンライン送金を容易にする支払いシステムです。PayPal ユーザーの場合、アカウントには支払者、日付、ステータスなど、トランザクションに関するデータが含まれます。AWS Glue を使用して、PayPal から特定の AWS サービスや他のサポートされているアプリケーションにデータを転送できます。
**Topics**
+ [PayPal 向けの AWS Glue サポート](paypal-support.md)
+ [接続を作成および使用するための API オペレーションを含むポリシー](paypal-configuring-iam-permissions.md)
+ [PayPal の設定](paypal-configuring.md)
+ [PayPal 接続の設定](paypal-configuring-connections.md)
+ [PayPal エンティティからの読み取り](paypal-reading-from-entities.md)
+ [PayPal の接続オプション](paypal-connection-options.md)
+ [PayPal コネクタの制限事項と注意事項](paypal-connector-limitations.md)
# PayPal 向けの AWS Glue サポート
AWS Glue は、次のように PayPal をにサポートします。
**ソースとしてサポートされていますか?**
はい。AWS Glue ETL ジョブを使用して、PayPal からデータをクエリできます。
**ターゲットとしてサポートされていますか?**
いいえ。
**サポートされている PayPal API バージョン**
次の PayPal API バージョンがサポートされています。
+ v1
# 接続を作成および使用するための 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 コンソールのユーザーにアタッチされています。
# PayPal の設定
AWS Glue を使用して PayPal からデータを転送できるようにするには、次の要件を満たす必要があります。
## 最小要件
以下に、最小要件を示します。
+ クライアント認証情報を持つ PayPal アカウントがある。
+ PayPal アカウントに、有効なライセンスを持つ API アクセスがある。
これらの要件を満たすと、PayPal アカウントに AWS Glue を接続する準備が整います。一般的な接続では、PayPal で他に何もする必要はありません。
# PayPal 接続の設定
PayPal は、OAuth2 の CLIENT CREDENTIALS 許可タイプをサポートしています。
+ このグラントタイプは、クライアントがユーザーのコンテキスト外でアクセストークンを取得するために使用するため、2-legged の OAuth 2.0 と見なされます。AWS Glue は、クライアント ID とクライアントシークレットを使用して、定義したカスタムサービスによって提供される PayPal API を認証できます。
+ 各カスタムサービスは、特定のアクションを実行することをサービスに許可する一連のロールとアクセス許可を持つ API 専用ユーザーによって所有されます。アクセストークンは 1 つのカスタムサービスに関連付けられています。
+ このグラントタイプは、有効期間が短いアクセストークンになり、`/v2/oauth2/token` エンドポイントを再び呼び出すことで更新される場合があります。
+ クライアント認証情報を使用した OAuth 2.0 の PayPal の公開ドキュメントについては、[「認証](https://developer.paypal.com/api/rest/authentication/)」を参照してください。
PayPal 接続を設定するには:
1. AWS Secrets Manager で、次の詳細を含むシークレットを作成します。
1. カスタマーマネージド接続アプリケーションの場合、シークレットには、`USER_MANAGED_CLIENT_APPLICATION_CLIENT_SECRET` を使用して接続されたアプリケーションのコンシューマーシークレットをキーとして含める必要があります。
1. 注: AWS Glue で接続にシークレットを作成する必要があります。
1. AWS Glue Glue Studio で、以下の手順に従って **[データ接続]** の下に接続を作成します。
1. **[接続タイプ]** を選択する際に、[PayPal] を選択します。
1. 接続先の PayPal インスタンスの `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` を読み取るアクセス許可を付与します。
## OAuth 2.0 認証情報の取得
Rest API を呼び出すには、クライアント ID とクライアントシークレットをアクセストークンと交換する必要があります。詳細については、「[PayPal REST API の使用を開始する](https://developer.paypal.com/api/rest/)」を参照してください。
# PayPal エンティティからの読み取り
**前提条件**
読み取り元の PayPal オブジェクト。オブジェクト名 `transaction` が必要になります。
**ソースに対応するエンティティ**:
| エンティティ | フィルタリング可能 | 制限をサポートする | Order By をサポートする | Select \$1 をサポートする | パーティション分割をサポートする |
| --- | --- | --- | --- | --- | --- |
| トランザクション | はい | あり | なし | あり | あり |
**例**:
```
paypal_read = glueContext.create_dynamic_frame.from_options(
connection_type="paypal",
connection_options={
"connectionName": "connectionName",
"ENTITY_NAME": "transaction",
"API_VERSION": "v1",
"INSTANCE_URL": "https://api-m.paypal.com"
}
```
**PayPal エンティティとフィールドの詳細**:
静的メタデータを持つエンティティ:
[\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/ja_jp/glue/latest/dg/paypal-reading-from-entities.html)
## パーティショニングクエリ
Spark で同時実行を使用する場合は、追加の Spark オプション `PARTITION_FIELD`、`LOWER_BOUND`、`UPPER_BOUND`、および `NUM_PARTITIONS` を指定できます。これらのパラメータを使用すると、元のクエリは Spark タスクで同時に実行できるサブクエリの `NUM_PARTITIONS` の数に分割されます。
+ `PARTITION_FIELD`: クエリのパーティション化に使用するフィールドの名前。
+ `LOWER_BOUND`: 選択したパーティションフィールドの**包括的な**下限値。
Datetime フィールドでは、ISO 形式の値を受け入れます。
有効な値の例は次のとおりです:
```
"2024-07-01T00:00:00.000Z"
```
+ `UPPER_BOUND`: 選択したパーティションフィールドの**排他的**上限値。
+ `NUM_PARTITIONS`: パーティション数。
次のフィールドは、エンティティ単位のパーティション分割でサポートされています。
| エンティティ名 | パーティション分割フィールド | データ型 |
| --- | --- | --- |
| トランザクション | transaction\$1initiation\$1date | DateTime |
例:
```
paypal_read = glueContext.create_dynamic_frame.from_options(
connection_type="paypal",
connection_options={
"connectionName": "connectionName",
"ENTITY_NAME": "transaction",
"API_VERSION": "v1",
"PARTITION_FIELD": "transaction_initiation_date"
"LOWER_BOUND": "2024-07-01T00:00:00.000Z"
"UPPER_BOUND": "2024-07-02T00:00:00.000Z"
"NUM_PARTITIONS": "10"
}
```
# PayPal の接続オプション
PayPal の接続オプションは次のとおりです。
+ `ENTITY_NAME`(文字列) – (必須) 読み取りに使用されます。PayPal のオブジェクトの名前。
+ `API_VERSION`(文字列) – (必須) 読み取りに使用されます。使用する PayPal 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。読み込みに使用されます。読み取り用のパーティションの数です。
# PayPal コネクタの制限事項と注意事項
PayPal コネクタの制限事項または注意事項は次のとおりです。
+ [PayPal トランザクションドキュメント](https://developer.paypal.com/docs/api/transaction-search/v1/#search_get)では、実行されたトランザクションがトランザクション一覧の呼び出しに表示されるまでに最大 3 時間かかることが示されています。ただし、[https://developer.paypal.com/docs/api/transaction-search/v1/#search_get:~:text=last_refreshed_datetime](https://developer.paypal.com/docs/api/transaction-search/v1/#search_get:~:text=last_refreshed_datetime) によってはそれよりも時間がかかることが確認されています。ここで、`last_refreshed_datetime` は API からデータが利用可能になるまでの時間。
+ `last_refreshed_datetime` がリクエストされた `end_date` よりも小さい場合、`end_date` は `last_refreshed_datetime` に等しくなります。これは、その時点までのデータしかないためです。
+ `transaction_initiation_date` フィールドは `transaction` エンティティに提供する必須のフィルターであり、このフィールドで[サポートされる最大](https://developer.paypal.com/docs/transaction-search/#:~:text=The%20maximum%20supported%20date%20range%20is%2031%20days.)日付範囲は 31 日です。
+ `transaction_initiation_date` フィールド以外のフィルター (クエリパラメータ) を使用して `transaction` エンティティ API リクエストを呼び出すと、[https://developer.paypal.com/docs/api/transaction-search/v1/#search_get:~:text=If%20you%20specify%20one%20or%20more%20optional%20query%20parameters%2C%20the%20ending_balance%20response%20field%20is%20empty.](https://developer.paypal.com/docs/api/transaction-search/v1/#search_get:~:text=If%20you%20specify%20one%20or%20more%20optional%20query%20parameters%2C%20the%20ending_balance%20response%20field%20is%20empty.) フィールドの値がレスポンスで取得されないことが予想されます。