从 Kustomer 实体读取内容
先决条件
要从中读取内容的 Kustomer 对象。需要 Brands 或 Cards 等对象名称。下表显示支持的实体。
源支持的实体:
| 实体 | 可以筛选 | 支持限制 | 支持排序依据 | 支持 Select * | 支持分区 |
|---|---|---|---|---|---|
| Brands | 否 | 是 | 否 | 是 | 否 |
| Cards | 否 | 是 | 否 | 是 | 否 |
| Chat Settings | 否 | 否 | 否 | 是 | 否 |
| 公司 | 支持 | 是 | 是 | 是 | 是 |
| 对话 | 支持 | 是 | 是 | 是 | 是 |
| Customers | 支持 | 是 | 是 | 是 | 是 |
| Customer Searches Pinned | 否 | 是 | 否 | 是 | 否 |
| Customer Searches Position | 否 | 否 | 否 | 是 | 否 |
| Email Hooks | 否 | 是 | 否 | 是 | 否 |
| Web Hooks | 否 | 是 | 否 | 是 | 否 |
| KB Articles | 否 | 是 | 否 | 是 | 否 |
| KB Categories | 否 | 是 | 否 | 是 | 否 |
| KB Forms | 否 | 是 | 否 | 是 | 否 |
| KB Routes | 否 | 是 | 否 | 是 | 否 |
| KB Tags | 否 | 是 | 否 | 是 | 否 |
| KB Templates | 否 | 是 | 否 | 是 | 否 |
| KB Themes | 否 | 是 | 否 | 是 | 否 |
| Klasses | 否 | 是 | 否 | 是 | 否 |
| kViews | 否 | 是 | 否 | 是 | 否 |
| 消息 | 支持 | 是 | 是 | 是 | 是 |
| 备注 | 支持 | 是 | 是 | 是 | 是 |
| 通知 | 否 | 是 | 否 | 是 | 否 |
示例:
Kustomer_read = glueContext.create_dynamic_frame.from_options( connection_type="kustomer", connection_options={ "connectionName": "connectionName", "ENTITY_NAME": "brands", "API_VERSION": "v1" }
Kustomer 实体和字段详细信息
有关实体和字段详细信息的更多信息,请参阅:
Kustomer API v1
| 实体 | 字段 | 数据类型 | 支持的运算符 |
|---|---|---|---|
| Brands | id | 字符串 | 不适用 |
| 名称 | 字符串 | 不适用 | |
| iconUrl | 字符串 | 不适用 | |
| createdAt | 日期时间 | 不适用 | |
| updatedAt | 日期时间 | 不适用 | |
| modifiedAt | 日期时间 | 不适用 | |
| 默认值 | 布尔值 | 不适用 | |
| Cards | id | 字符串 | 不适用 |
| 名称 | 字符串 | 不适用 | |
| createdAt | 日期时间 | 不适用 | |
| updatedAt | 日期时间 | 不适用 | |
| modifiedAt | 日期时间 | 不适用 | |
| description | 字符串 | 不适用 | |
| url | 字符串 | 不适用 | |
| contexts | 列表 | 不适用 | |
| Chat Settings | id | 字符串 | 不适用 |
| settingsVersion | 整数 | 不适用 | |
| widgetType | 字符串 | 不适用 | |
| version | 整数 | 不适用 | |
| teamName | 字符串 | 不适用 | |
| greeting | 字符串 | 不适用 | |
| autoreply | 字符串 | 不适用 | |
| embedIconUrl | 字符串 | 不适用 | |
| embedIconColor | 字符串 | 不适用 | |
| fallbackEmailSubject | 字符串 | 不适用 | |
| fallbackEmailIntroduction | 字符串 | 不适用 | |
| 已启用 | 布尔值 | 不适用 | |
| outboundChatEnabled | 布尔值 | 不适用 | |
| updatedAt | 日期时间 | 不适用 | |
| modifiedAt | 日期时间 | 不适用 | |
| offhoursMessage | 字符串 | 不适用 | |
| offhoursImageUrl | 字符串 | 不适用 | |
| closableChat | 布尔值 | 不适用 | |
| noHistory | 布尔值 | 不适用 | |
| disableAttachments | 布尔值 | 不适用 | |
| volumeControl | 结构体 | 不适用 | |
| singleSessonChat | 布尔值 | 不适用 | |
| showTypingIndicatorWeb | 布尔值 | 不适用 | |
| 公司 | id | 字符串 | 不适用 |
| 名称 | 字符串 | =, !=, CONTAINS | |
| createdAt | 日期时间 | 不适用 | |
| updatedAt | 日期时间 | 不适用 | |
| modifiedAt | 日期时间 | =, !=, <, <=, >, >=, BETWEEN | |
| tags | 列表 | 不适用 | |
| 域 | 列表 | 不适用 | |
| emails | 列表 | 不适用 | |
| phones | 列表 | 不适用 | |
| whatsapps | 列表 | 不适用 | |
| socials | 列表 | 不适用 | |
| urls | 列表 | 不适用 | |
| 位置 | 列表 | 不适用 | |
| roleGroupVersions | 列表 | 不适用 | |
| rev | 整数 | 不适用 | |
| 对话 | id | 字符串 | 不适用 |
| 名称 | 字符串 | =, !=, CONTAINS | |
| preview | 字符串 | 不适用 | |
| 通道 | 列表 | 不适用 | |
| 状态 | 字符串 | =, !=, CONTAINS | |
| messageCount | 整数 | =, !=, >, >=, <, <= | |
| noteCount | 整数 | =, !=, >, >=, <, <= | |
| satisfaction | 整数 | =, !=, >, >=, <, <= | |
| satisfactionLevel | 结构体 | 不适用 | |
| createdAt | 日期时间 | =, !=, <, <=, >, >=, BETWEEN | |
| updatedAt | 日期时间 | =, !=, <, <=, >, >=, BETWEEN | |
| modifiedAt | 日期时间 | =, !=, <, <=, >, >=, BETWEEN | |
| lastActivityAt | 日期时间 | 不适用 | |
| 垃圾电子邮件 | 布尔值 | 不适用 | |
| ended | 布尔值 | =, != | |
| endedAt | 日期时间 | =, !=, <, <=, >, >=, BETWEEN | |
| endedReason | 字符串 | CONTAINS | |
| endedByType | 字符串 | 不适用 | |
| importedAt | 字符串 | 不适用 | |
| tags | 列表 | 不适用 | |
| suggestedTags | 列表 | 不适用 | |
| 情绪 | 字符串 | 不适用 | |
| 预测 | 列表 | 不适用 | |
| suggestedShortcuts | 列表 | 不适用 | |
| firstMessageIn | 结构体 | 不适用 | |
| firstMessageOut | 结构体 | 不适用 | |
| lastMessageIn | 结构体 | 不适用 | |
| lastMessageOut | 结构体 | 不适用 | |
| lastMessageAt | 日期时间 | =, !=, <, <=, >, >=, BETWEEN | |
| lastMessageUnrespondedTo | 结构体 | 不适用 | |
| lastMessageUnrespondedToSinceLastDone | 结构体 | 不适用 | |
| assignedUsers | 列表 | 不适用 | |
| assignedTeams | 列表 | 不适用 | |
| firstResponse | 结构体 | 不适用 | |
| firstResponseSinceLastDone | 结构体 | 不适用 | |
| lastResponse | 结构体 | 不适用 | |
| firstDone | 结构体 | 不适用 | |
| lastDone | 结构体 | 不适用 | |
| 方向 | 字符串 | =, !=, CONTAINS | |
| lastMessageDirection | 字符串 | 不适用 | |
| outboundMessageCount | 整数 | 不适用 | |
| inboundMessageCount | 整数 | 不适用 | |
| rev | 整数 | 不适用 | |
| priority | 整数 | =, !=, >, >=, <, <= | |
| roleGroupVersions | 列表 | 不适用 | |
| accessOverride | 列表 | 不适用 | |
| assistant | 结构体 | 不适用 | |
| phase | 字符串 | 不适用 | |
| 技能 | 列表 | 不适用 | |
| matchedTimeBasedRules | 列表 | 不适用 | |
| Customers | id | 字符串 | 不适用 |
| 名称 | 字符串 | =, !=, CONTAINS | |
| displayName | 字符串 | 不适用 | |
| displayColor | 字符串 | 不适用 | |
| displayIcon | 字符串 | 不适用 | |
| externalId | 字符串 | =, !=, CONTAINS | |
| externalIds | 列表 | 不适用 | |
| sharedExternalIds | 列表 | 不适用 | |
| emails | 列表 | 不适用 | |
| sharedEmails | 列表 | 不适用 | |
| phones | 列表 | 不适用 | |
| sharedPhones | 列表 | 不适用 | |
| whatsapps | 列表 | 不适用 | |
| facebookIds | 列表 | 不适用 | |
| instagramIds | 列表 | 不适用 | |
| socials | 列表 | 不适用 | |
| sharedSocials | 列表 | 不适用 | |
| urls | 列表 | 不适用 | |
| 位置 | 列表 | 不适用 | |
| activeUsers | 列表 | 不适用 | |
| watchers | 列表 | 不适用 | |
| recentLocation | 结构体 | 不适用 | |
| locale | 字符串 | =, !=, CONTAINS | |
| timeZone | 字符串 | 不适用 | |
| gender | 字符串 | =, !=, CONTAINS | |
| createdAt | 日期时间 | =, !=, <, <=, >, >=, BETWEEN | |
| updatedAt | 日期时间 | =, !=, <, <=, >, >=, BETWEEN | |
| modifiedAt | 日期时间 | =, !=, <, <=, >, >=, BETWEEN | |
| lastActivityAt | 日期时间 | 不适用 | |
| 已删除 | 布尔值 | 不适用 | |
| lastConversation | 结构体 | 不适用 | |
| conversationCounts | 结构体 | 不适用 | |
| preview | 结构体 | 不适用 | |
| tags | 列表 | 不适用 | |
| progressiveStatus | 字符串 | =, !=, CONTAINS | |
| verified | 布尔值 | 不适用 | |
| rev | 整数 | 不适用 | |
| recentItems | 列表 | 不适用 | |
| defaultLang | 字符串 | =, !=, CONTAINS | |
| satisfactionLevel | 结构体 | 不适用 | |
| roleGroupVersions | 列表 | 不适用 | |
| accessOverride | 列表 | 不适用 | |
| companyName | 字符串 | 不适用 | |
| firstName | 字符串 | 不适用 | |
| lastName | 字符串 | 不适用 | |
| Customer Searches Pinned | id | 字符串 | 不适用 |
| search | 字符串 | 不适用 | |
| createdAt | 日期时间 | 不适用 | |
| Customer Searches Positions | id | 字符串 | 不适用 |
| positions | 列表 | 不适用 | |
| children | 列表 | 不适用 | |
| createdAt | 日期时间 | 不适用 | |
| updatedAt | 日期时间 | 不适用 | |
| modifiedAt | 日期时间 | 不适用 | |
| rev | 整数 | 不适用 | |
| Email Hooks | id | 字符串 | 不适用 |
| description | 字符串 | 不适用 | |
| debug | 布尔值 | 不适用 | |
| 电子邮件 | 字符串 | 不适用 | |
| eventName | 字符串 | 不适用 | |
| 删除实例快照 | 字符串 | 不适用 | |
| hash | 字符串 | 不适用 | |
| 键 | 字符串 | 不适用 | |
| createdAt | 日期时间 | 不适用 | |
| modifiedAt | 日期时间 | 不适用 | |
| updatedAt | 日期时间 | 不适用 | |
| Web Hooks | id | 字符串 | 不适用 |
| description | 字符串 | 不适用 | |
| eventName | 字符串 | 不适用 | |
| hash | 字符串 | 不适用 | |
| url | 字符串 | 不适用 | |
| createdAt | 日期时间 | 不适用 | |
| modifiedAt | 日期时间 | 不适用 | |
| updatedAt | 日期时间 | 不适用 | |
| 删除实例快照 | 字符串 | 不适用 | |
| version | 整数 | 不适用 | |
| debug | 布尔值 | 不适用 | |
| KB Articles | id | 字符串 | 不适用 |
| hash | 字符串 | 不适用 | |
| 删除实例快照 | 字符串 | 不适用 | |
| 源 | 字符串 | 不适用 | |
| 状态 | 字符串 | 不适用 | |
| 范围 | 字符串 | 不适用 | |
| createdAt | 日期时间 | 不适用 | |
| updatedAt | 日期时间 | 不适用 | |
| 已删除 | 布尔值 | 不适用 | |
| deletedAt | 日期时间 | 不适用 | |
| modifiedAt | 日期时间 | 不适用 | |
| publishedAt | 日期时间 | 不适用 | |
| tags | 列表 | 不适用 | |
| categories | 列表 | 不适用 | |
| knowledgeBases | 列表 | 不适用 | |
| metaTitle | 字符串 | 不适用 | |
| metaDescription | 字符串 | 不适用 | |
| metaKeywords | 列表 | 不适用 | |
| langVersions | 结构体 | 不适用 | |
| latestLangs | 结构体 | 不适用 | |
| KB Categories | id | 字符串 | 不适用 |
| hash | 字符串 | 不适用 | |
| createdAt | 日期时间 | 不适用 | |
| modifiedAt | 日期时间 | 不适用 | |
| updatedAt | 日期时间 | 不适用 | |
| published | 布尔值 | 不适用 | |
| positions | 列表 | 不适用 | |
| categoryPositions | 列表 | 不适用 | |
| root | 布尔值 | 不适用 | |
| langs | 结构体 | 不适用 | |
| KB Forms | id | 字符串 | 不适用 |
| 名称 | 字符串 | 不适用 | |
| 缩略名 | 字符串 | 不适用 | |
| hash | 字符串 | 不适用 | |
| body | 字符串 | 不适用 | |
| layout | 列表 | 不适用 | |
| layoutV2 | 列表 | 不适用 | |
| componentsV2 | 结构体 | 不适用 | |
| 条件 | 结构体 | 不适用 | |
| advanced | 布尔值 | 不适用 | |
| createdAt | 日期时间 | 不适用 | |
| updatedAt | 日期时间 | 不适用 | |
| publishedAt | 日期时间 | 不适用 | |
| modifiedAt | 字符串 | 不适用 | |
| published | 布尔值 | 不适用 | |
| snippets | 列表 | 不适用 | |
| recaptcha | 布尔值 | 不适用 | |
| klass | 字符串 | 不适用 | |
| 渠道 | 字符串 | 不适用 | |
| deflection | 布尔值 | 不适用 | |
| formHookEnabled | 布尔值 | 不适用 | |
| replyFrom | 字符串 | 不适用 | |
| wcag | 布尔值 | 不适用 | |
| KB Routes | id | 字符串 | 不适用 |
| url | 字符串 | 不适用 | |
| routableType | 字符串 | 不适用 | |
| routableId | 字符串 | 不适用 | |
| createdAt | 日期时间 | 不适用 | |
| updatedAt | 日期时间 | 不适用 | |
| modifiedAt | 日期时间 | 不适用 | |
| KB Tags | id | 字符串 | 不适用 |
| 名称 | 字符串 | 不适用 | |
| createdAt | 日期时间 | 不适用 | |
| updatedAt | 日期时间 | 不适用 | |
| modifiedAt | 日期时间 | 不适用 | |
| KB Templates | id | 字符串 | 不适用 |
| 删除实例快照 | 字符串 | 不适用 | |
| description | 字符串 | 不适用 | |
| beta | 布尔值 | 不适用 | |
| 清单 | 结构体 | 不适用 | |
| jsxSnippets | 列表 | 不适用 | |
| 映像 | 列表 | 不适用 | |
| version | 字符串 | 不适用 | |
| createdAt | 日期时间 | 不适用 | |
| updatedAt | 日期时间 | 不适用 | |
| KB Themes | id | 字符串 | 不适用 |
| 名称 | 字符串 | 不适用 | |
| active | 布尔值 | 不适用 | |
| 默认值 | 布尔值 | 不适用 | |
| lastfileUpdatedAt | 日期时间 | 不适用 | |
| 自定义 | 布尔值 | 不适用 | |
| 状态 | 字符串 | 不适用 | |
| templateVersionId | 字符串 | 不适用 | |
| templateTitle | 字符串 | 不适用 | |
| templateVersion | 字符串 | 不适用 | |
| 清单 | 结构体 | 不适用 | |
| configSnippets | 列表 | 不适用 | |
| jsxSnippets | 列表 | 不适用 | |
| createdAt | 日期时间 | 不适用 | |
| updatedAt | 日期时间 | 不适用 | |
| modifiedAt | 日期时间 | 不适用 | |
| rev | 整数 | 不适用 | |
| Klasses | id | 字符串 | 不适用 |
| 名称 | 字符串 | 不适用 | |
| icon | 字符串 | 不适用 | |
| color | 字符串 | 不适用 | |
| appDisabled | 布尔值 | 不适用 | |
| 状态 | 字符串 | 不适用 | |
| updatedAt | 日期时间 | 不适用 | |
| createdAt | 日期时间 | 不适用 | |
| s3DataUrl | 字符串 | 不适用 | |
| kViews | id | 字符串 | 不适用 |
| 资源 | 字符串 | 不适用 | |
| 模板 | 字符串 | 不适用 | |
| context | 字符串 | 不适用 | |
| meta | 结构体 | 不适用 | |
| appDisabled | 布尔值 | 不适用 | |
| 已启用 | 布尔值 | 不适用 | |
| advanced | 布尔值 | 不适用 | |
| layout | 列表 | 不适用 | |
| 组件 | 结构体 | 不适用 | |
| 条件 | 结构体 | 不适用 | |
| rev | 整数 | 不适用 | |
| createdAt | 日期时间 | 不适用 | |
| modifiedAt | 日期时间 | 不适用 | |
| updatedAt | 日期时间 | 不适用 | |
| 通知 | id | 字符串 | 不适用 |
| 名称 | 字符串 | 不适用 | |
| 状态 | 字符串 | 不适用 | |
| 事件 | 结构体 | 不适用 | |
| createdAt | 日期时间 | 不适用 | |
| updatedAt | 日期时间 | 不适用 | |
| 消息 | id | 字符串 | 不适用 |
| externalId | 字符串 | 不适用 | |
| 渠道 | 字符串 | =, !=, CONTAINS | |
| 应用程序 | 字符串 | 不适用 | |
| size | 整数 | =, !=, >, >=, <, <= | |
| 方向 | 字符串 | =, !=, CONTAINS | |
| preview | 字符串 | 不适用 | |
| subject | 字符串 | 不适用 | |
| meta | 结构体 | 不适用 | |
| 状态 | 字符串 | =, !=, CONTAINS | |
| directionType | 字符串 | =, !=, CONTAINS | |
| assignedTeams | 列表 | 不适用 | |
| assignedUsers | 列表 | 不适用 | |
| errorAt | 日期时间 | =, !=, <, <=, >, >=, BETWEEN | |
| 自动 | 布尔值 | =, != | |
| sentAt | 日期时间 | =, !=, <, <=, >, >=, BETWEEN | |
| createdAt | 日期时间 | =, !=, <, <=, >, >=, BETWEEN | |
| updatedAt | 日期时间 | 不适用 | |
| modifiedAt | 日期时间 | 不适用 | |
| redacted | 布尔值 | 不适用 | |
| createdByTeams | 列表 | 不适用 | |
| rev | 整数 | 不适用 | |
| reactions | 列表 | 不适用 | |
| intentDetections | 列表 | 不适用 | |
| 备注 | id | 字符串 | 不适用 |
| body | 字符串 | CONTAINS | |
| createdAt | 日期时间 | =, !=, <, <=, >, >=, BETWEEN | |
| updatedAt | 日期时间 | =, !=, <, <=, >, >=, BETWEEN | |
| modifiedAt | 日期时间 | =, !=, <, <=, >, >=, BETWEEN | |
| createdByTeams | 列表 | 不适用 |
对查询进行分区
基于字段的分区
如果您想在 Spark 中利用并发,可以提供其他 Spark 选项:PARTITION_FIELD、LOWER_BOUND、UPPER_BOUND 和 NUM_PARTITIONS。使用这些参数,原始查询将被拆分为 NUM_PARTITIONS 个子查询,这些子查询可以由 Spark 任务同时执行。
PARTITION_FIELD:用于对查询进行分区的字段的名称。LOWER_BOUND:所选分区字段的包含下限值。对于日期时间字段,我们接受 ISO 格式的值。
有效值示例:
"2023-01-15T11:18:39.205Z"UPPER_BOUND:所选分区字段的排除上限值。NUM_PARTITIONS:分区的数量。
基于实体的分区字段支持详细信息如下表中所示:
| 实体名称 | 分区字段 | 数据类型 |
|---|---|---|
| 公司 | modifiedAt | 日期时间 |
| 对话 | createdAt、updatedAt、modifiedAt、endedAt、lastMessageAt | 日期时间 |
| messageCount、noteCount | BigInteger | |
| priority | 整数 | |
| Customers | createdAt、updatedAt、modifiedAt | 日期时间 |
| 消息 | errorAt、sentAt、createdAt | 日期时间 |
| size | BigInteger | |
| 备注 | createdAt、updatedAt、modifiedAt | 日期时间 |
示例:
Kustomer_read = glueContext.create_dynamic_frame.from_options( connection_type="kustomer", connection_options={ "connectionName": "connectionName", "ENTITY_NAME": "conversation", "API_VERSION": "v1", "PARTITION_FIELD": "createdAt" "LOWER_BOUND": "2023-01-15T11:18:39.205Z" "UPPER_BOUND": "2023-02-15T11:18:39.205Z" "NUM_PARTITIONS": "2" }