Gmail¶
The Gmail connector is a Palantir-provided driver for Gmail.
To create a new Gmail source, follow the standard setup flow for Palantir-provided drivers, then use the sections below for Gmail-specific configuration and networking. For the complete property reference, see the official Gmail driver documentation ↗.
Configuration¶
The properties below are mandatory or recommended.
| Property | Required? | Description | Default |
|---|---|---|---|
Schema ↗ |
Mandatory | Used to specify what Gmail Api to use, either REST (default) or IMAP. | REST |
AuthScheme ↗ |
Recommended | The type of authentication to use when connecting to Gmail. | OAuthJWT |
InitiateOAuth ↗ |
Recommended | Specifies the process for obtaining or refreshing the OAuth access token, which maintains user access while an authenticated, authorized user is working. | GETANDREFRESH |
OAuthClientId ↗ |
Recommended | Specifies the client ID (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication. | — |
OAuthClientSecret ↗ |
Recommended | Specifies the client secret assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server. | — |
OAuthJWTCert ↗ |
Recommended | Supplies the name of the client certificate's JWT Certificate store. | — |
OAuthJWTCertType ↗ |
Recommended | Identifies the type of key store containing the JWT Certificate. | GOOGLEJSONBLOB |
OAuthJWTSubject ↗ |
Recommended | The user subject for which the application is requesting delegated access. | — |
Networking¶
The table below lists the domains that the source needs to be able to access in order to successfully run.
For each domain, add a corresponding egress policy. If the source is hosted on-premises and not directly reachable from Foundry, use an agent proxy egress policy instead; the agent host itself must also be able to reach the listed domains. See using an agent as a proxy for details.
| Domain | Required |
|---|---|
| accounts.google.com | Always. Required for OAuth |
| googleapis.com | Always |
中文翻译¶
Gmail¶
Gmail 连接器是 Palantir 提供的用于 Gmail 的驱动程序。
要创建新的 Gmail 数据源，请遵循 Palantir 提供驱动程序的标准设置流程，然后使用以下各节进行 Gmail 特定的配置和网络设置。有关完整的属性参考，请参阅官方 Gmail 驱动程序文档 ↗。
配置¶
以下属性为必填或推荐项。
| 属性 | 是否必填 | 描述 | 默认值 |
|---|---|---|---|
Schema ↗ |
必填 | 用于指定要使用的 Gmail API，可以是 REST（默认）或 IMAP。 | REST |
AuthScheme ↗ |
推荐 | 连接到 Gmail 时使用的身份验证类型。 | OAuthJWT |
InitiateOAuth ↗ |
推荐 | 指定获取或刷新 OAuth 访问令牌的过程，该令牌在已认证的授权用户工作时维持其用户访问权限。 | GETANDREFRESH |
OAuthClientId ↗ |
推荐 | 指定分配给您的自定义 OAuth 应用程序的客户端 ID（也称为消费者密钥）。此 ID 用于在身份验证过程中向 OAuth 授权服务器标识应用程序。 | — |
OAuthClientSecret ↗ |
推荐 | 指定分配给您的自定义 OAuth 应用程序的客户端密钥。此机密值用于向 OAuth 授权服务器验证应用程序的身份。 | — |
OAuthJWTCert ↗ |
推荐 | 提供客户端证书的 JWT 证书存储名称。 | — |
OAuthJWTCertType ↗ |
推荐 | 标识包含 JWT 证书的密钥存储类型。 | GOOGLEJSONBLOB |
OAuthJWTSubject ↗ |
推荐 | 应用程序请求委托访问的用户主体。 | — |
网络设置¶
下表列出了数据源为成功运行而需要能够访问的域名。
对于每个域名，请添加相应的出站策略。如果数据源部署在本地且无法直接从 Foundry 访问，请改用代理出站策略；代理主机本身也必须能够访问列出的域名。有关详细信息，请参阅使用代理作为代理。
| 域名 | 是否必需 |
|---|---|
| accounts.google.com | 始终必需。OAuth 所需 |
| googleapis.com | 始终必需 |