# 连接到 PayPal
PayPal 是一种支付系统，旨在方便各方进行在线转账，例如客户和在线供应商之间的转账。如果是 PayPal 用户，则账户包含有关交易的数据，例如付款人、付款日期和付款状态。可以使用 AWS Glue 将数据从 PayPal 传输到某些 AWS 服务或其他受支持的应用程序。
**Topics**
+ [AWS Glue 支持 PayPal](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)
# AWS Glue 支持 PayPal
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 访问权限和有效许可证。
如果满足这些要求，就可以将 AWS Glue 连接到 PayPal 账户。对于常见连接，无需在 PayPal 中执行其他操作。
# 配置 PayPal 连接
PayPal 支持 OAuth2 的客户端凭证授权类型。
+ 此授权类型被视为双足型 OAuth 2.0，因为客户端将其用于在用户环境之外获取访问令牌。AWS Glue 能够使用客户端 ID 和客户端密钥对由您定义的自定义服务提供的 PayPal API 进行身份验证。
+ 每项自定义服务均归仅限 API 的用户所有，该用户拥有一组角色和权限，可授权该服务执行特定操作。访问令牌与单项自定义服务相关联。
+ 这种授权类型会生成一个短期访问令牌，并且可以通过再次调用 `/v2/oauth2/token` 端点来续订。
+ 有关包含客户端凭证的 OAuth 2.0 的 PayPal 公共文档，请参阅 [Authentication](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 和客户端密钥交换访问令牌。有关更多信息，请参阅 [Get started with PayPal REST APIs](https://developer.paypal.com/api/rest/)。
# 从 PayPal 实体读取内容
**先决条件**
要从中读取内容的 PayPal 对象。需要对象名称 `transaction`。
**源支持的实体**：
| 实体 | 可以筛选 | 支持限制 | 支持排序依据 | 支持 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/zh_cn/glue/latest/dg/paypal-reading-from-entities.html)
## 对查询进行分区
如果您想在 Spark 中利用并发，可以提供其他 Spark 选项：`PARTITION_FIELD`、`LOWER_BOUND`、`UPPER_BOUND` 和 `NUM_PARTITIONS`。使用这些参数，原始查询将被拆分为 `NUM_PARTITIONS` 个子查询，这些子查询可以由 Spark 任务同时执行。
+ `PARTITION_FIELD`：用于对查询进行分区的字段的名称。
+ `LOWER_BOUND`：所选分区字段的**包含**下限值。
对于“日期时间”字段，我们接受 ISO 格式的值。
有效值示例：
```
"2024-07-01T00:00:00.000Z"
```
+ `UPPER_BOUND`：所选分区字段的**排除**上限值。
+ `NUM_PARTITIONS`：分区的数量。
以下字段支持基于实体的分区：
| 实体名称 | 分区字段 | 数据类型 |
| --- | --- | --- |
| 交易 | transaction\$1initiation\$1date | 日期时间 |
示例：
```
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`（列表<字符串>）–默认：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)中提到，已执行的交易最多需要三个小时才能在列表交易调用中显示。然而，据观察，实际花费的时间比文中提到的时间更长，具体取决于 [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.) 字段的值。