從 Kustomer 實體中讀取
必要條件
您要從中讀取的 Kustomer 物件。您將需要物件名稱,例如品牌或卡片。下表顯示支援的實體。
來源的支援實體:
| 實體 | 可以篩選 | 支援限制 | 支援排序依據 | 支援選取 * | 支援分區 |
|---|---|---|---|---|---|
| 品牌 | 否 | 是 | 否 | 是 | 否 |
| 卡 | 否 | 是 | 否 | 是 | 否 |
| 聊天設定 | 否 | 否 | 否 | 是 | 否 |
| 公司 | 是 | 是 | 是 | 是 | 是 |
| 對話 | 是 | 是 | 是 | 是 | 是 |
| 客戶 | 是 | 是 | 是 | 是 | 是 |
| 客戶搜尋已鎖定 | 否 | 是 | 否 | 是 | 否 |
| 客戶搜尋位置 | 否 | 否 | 否 | 是 | 否 |
| 電子郵件勾點 | 否 | 是 | 否 | 是 | 否 |
| Web 勾點 | 否 | 是 | 否 | 是 | 否 |
| KB 文章 | 否 | 是 | 否 | 是 | 否 |
| KB 類別 | 否 | 是 | 否 | 是 | 否 |
| KB 表單 | 否 | 是 | 否 | 是 | 否 |
| KB 路由 | 否 | 是 | 否 | 是 | 否 |
| KB 標籤 | 否 | 是 | 否 | 是 | 否 |
| KB 範本 | 否 | 是 | 否 | 是 | 否 |
| KB 主題 | 否 | 是 | 否 | 是 | 否 |
| 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
| 實體 | 欄位 | 資料類型 | 支援的運算子 |
|---|---|---|---|
| 品牌 | id | String | N/A |
| name | String | N/A | |
| iconUrl | String | N/A | |
| createdAt | DateTime | N/A | |
| updatedAt | DateTime | N/A | |
| modifiedAt | DateTime | N/A | |
| 預設 | Boolean | N/A | |
| 卡 | id | String | N/A |
| name | String | N/A | |
| createdAt | DateTime | N/A | |
| updatedAt | DateTime | N/A | |
| modifiedAt | DateTime | N/A | |
| 描述 | String | N/A | |
| url | String | N/A | |
| contexts | 清單 | N/A | |
| 聊天設定 | id | String | N/A |
| settingsVersion | Integer | N/A | |
| widgetType | String | N/A | |
| version | Integer | N/A | |
| teamName | String | N/A | |
| greeting | String | N/A | |
| autoreply | String | N/A | |
| embedIconUrl | String | N/A | |
| embedIconColor | String | N/A | |
| fallbackEmailSubject | String | N/A | |
| fallbackEmailIntroduction | String | N/A | |
| 啟用 | Boolean | N/A | |
| outboundChatEnabled | Boolean | N/A | |
| updatedAt | DateTime | N/A | |
| modifiedAt | DateTime | N/A | |
| offhoursMessage | String | N/A | |
| offhoursImageUrl | String | N/A | |
| closableChat | Boolean | N/A | |
| noHistory | Boolean | N/A | |
| disableAttachments | Boolean | N/A | |
| volumeControl | Struct | N/A | |
| singleSessonChat | Boolean | N/A | |
| showTypingIndicatorWeb | Boolean | N/A | |
| 公司 | id | String | N/A |
| name | String | =, !=, CONTAINS | |
| createdAt | DateTime | N/A | |
| updatedAt | DateTime | N/A | |
| modifiedAt | DateTime | =, !=, >, >=, <, <=, BETWEEN | |
| 標籤 | 清單 | N/A | |
| domains | 清單 | N/A | |
| emails | 清單 | N/A | |
| phones | 清單 | N/A | |
| whatsapps | 清單 | N/A | |
| social | 清單 | N/A | |
| urls | 清單 | N/A | |
| locations | 清單 | N/A | |
| roleGroupVersions | 清單 | N/A | |
| rev | Integer | N/A | |
| 對話 | id | String | N/A |
| name | String | =, !=, CONTAINS | |
| preview | String | N/A | |
| 頻道 | 清單 | N/A | |
| status | String | =, !=, CONTAINS | |
| messageCount | Integer | =, !=, >, >=, <, <= | |
| noteCount | Integer | =, !=, >, >=, <, <= | |
| satisfaction | Integer | =, !=, >, >=, <, <= | |
| satisfactionLevel | Struct | N/A | |
| createdAt | DateTime | =, !=, >, >=, <, <=, BETWEEN | |
| updatedAt | DateTime | =, !=, >, >=, <, <=, BETWEEN | |
| modifiedAt | DateTime | =, !=, >, >=, <, <=, BETWEEN | |
| lastActivityAt | DateTime | N/A | |
| 垃圾郵件 | Boolean | N/A | |
| ended | Boolean | =, != | |
| endedAt | DateTime | =, !=, >, >=, <, <=, BETWEEN | |
| endedReason | String | CONTAINS | |
| endedByType | String | N/A | |
| importedAt | String | N/A | |
| 標籤 | 清單 | N/A | |
| suggestedTags | 清單 | N/A | |
| sentiment | String | N/A | |
| 預測 | 清單 | N/A | |
| suggestedShortcuts | 清單 | N/A | |
| firstMessageIn | Struct | N/A | |
| firstMessageOut | Struct | N/A | |
| lastMessageIn | Struct | N/A | |
| lastMessageOut | Struct | N/A | |
| lastMessageAt | DateTime | =, !=, >, >=, <, <=, BETWEEN | |
| lastMessageUnrespondedTo | Struct | N/A | |
| lastMessageUnrespondedToSinceLastDone | Struct | N/A | |
| assignedUsers | 清單 | N/A | |
| assignedTeams | 清單 | N/A | |
| firstResponse | Struct | N/A | |
| firstResponseSinceLastDone | Struct | N/A | |
| lastResponse | Struct | N/A | |
| firstDone | Struct | N/A | |
| lastDone | Struct | N/A | |
| direction | String | =, !=, CONTAINS | |
| lastMessageDirection | String | N/A | |
| outboundMessageCount | Integer | N/A | |
| inboundMessageCount | Integer | N/A | |
| rev | Integer | N/A | |
| priority | Integer | =, !=, >, >=, <, <= | |
| roleGroupVersions | 清單 | N/A | |
| accessOverride | 清單 | N/A | |
| assistant | Struct | N/A | |
| phase | String | N/A | |
| 技能 | 清單 | N/A | |
| matchedTimeBasedRules | 清單 | N/A | |
| 客戶 | id | String | N/A |
| name | String | =, !=, CONTAINS | |
| displayName | String | N/A | |
| displayColor | String | N/A | |
| displayIcon | String | N/A | |
| externalId | String | =, !=, CONTAINS | |
| externalIds | 清單 | N/A | |
| sharedExternalIds | 清單 | N/A | |
| emails | 清單 | N/A | |
| sharedEmails | 清單 | N/A | |
| phones | 清單 | N/A | |
| sharedPhones | 清單 | N/A | |
| whatsapps | 清單 | N/A | |
| facebookIds | 清單 | N/A | |
| instagramIds | 清單 | N/A | |
| social | 清單 | N/A | |
| sharedSocials | 清單 | N/A | |
| urls | 清單 | N/A | |
| locations | 清單 | N/A | |
| activeUsers | 清單 | N/A | |
| watchers | 清單 | N/A | |
| recentLocation | Struct | N/A | |
| locale | String | =, !=, CONTAINS | |
| timeZone | String | N/A | |
| gender | String | =, !=, CONTAINS | |
| createdAt | DateTime | =, !=, >, >=, <, <=, BETWEEN | |
| updatedAt | DateTime | =, !=, >, >=, <, <=, BETWEEN | |
| modifiedAt | DateTime | =, !=, >, >=, <, <=, BETWEEN | |
| lastActivityAt | DateTime | N/A | |
| 已刪除 | Boolean | N/A | |
| lastConversation | Struct | N/A | |
| conversationCounts | Struct | N/A | |
| preview | Struct | N/A | |
| 標籤 | 清單 | N/A | |
| progressiveStatus | String | =, !=, CONTAINS | |
| verified | Boolean | N/A | |
| rev | Integer | N/A | |
| recentItems | 清單 | N/A | |
| defaultLang | String | =, !=, CONTAINS | |
| satisfactionLevel | Struct | N/A | |
| roleGroupVersions | 清單 | N/A | |
| accessOverride | 清單 | N/A | |
| companyName | String | N/A | |
| firstName | String | N/A | |
| lastName | String | N/A | |
| 客戶搜尋已鎖定 | id | String | N/A |
| search | String | N/A | |
| createdAt | DateTime | N/A | |
| 客戶搜尋位置 | id | String | N/A |
| positions | 清單 | N/A | |
| children | 清單 | N/A | |
| createdAt | DateTime | N/A | |
| updatedAt | DateTime | N/A | |
| modifiedAt | DateTime | N/A | |
| rev | Integer | N/A | |
| 電子郵件勾點 | id | String | N/A |
| 描述 | String | N/A | |
| 偵錯 | Boolean | N/A | |
| String | N/A | ||
| eventName | String | N/A | |
| 標題 | String | N/A | |
| hash | String | N/A | |
| 金鑰 | String | N/A | |
| createdAt | DateTime | N/A | |
| modifiedAt | DateTime | N/A | |
| updatedAt | DateTime | N/A | |
| Web 勾點 | id | String | N/A |
| 描述 | String | N/A | |
| eventName | String | N/A | |
| hash | String | N/A | |
| url | String | N/A | |
| createdAt | DateTime | N/A | |
| modifiedAt | DateTime | N/A | |
| updatedAt | DateTime | N/A | |
| 標題 | String | N/A | |
| version | Integer | N/A | |
| 偵錯 | Boolean | N/A | |
| KB 文章 | id | String | N/A |
| hash | String | N/A | |
| 標題 | String | N/A | |
| source | String | N/A | |
| status | String | N/A | |
| scope | String | N/A | |
| createdAt | DateTime | N/A | |
| updatedAt | DateTime | N/A | |
| 已刪除 | Boolean | N/A | |
| deletedAt | DateTime | N/A | |
| modifiedAt | DateTime | N/A | |
| publishedAt | DateTime | N/A | |
| 標籤 | 清單 | N/A | |
| categories | 清單 | N/A | |
| knowledgeBases | 清單 | N/A | |
| metaTitle | String | N/A | |
| metaDescription | String | N/A | |
| metaKeywords | 清單 | N/A | |
| langVersions | Struct | N/A | |
| latestLangs | Struct | N/A | |
| KB 類別 | id | String | N/A |
| hash | String | N/A | |
| createdAt | DateTime | N/A | |
| modifiedAt | DateTime | N/A | |
| updatedAt | DateTime | N/A | |
| published | Boolean | N/A | |
| positions | 清單 | N/A | |
| categoryPositions | 清單 | N/A | |
| 根 | Boolean | N/A | |
| langs | Struct | N/A | |
| KB 表單 | id | String | N/A |
| name | String | N/A | |
| slug | String | N/A | |
| hash | String | N/A | |
| 本文 | String | N/A | |
| layout | 清單 | N/A | |
| layoutV2 | 清單 | N/A | |
| componentsV2 | Struct | N/A | |
| conditions | Struct | N/A | |
| advanced | Boolean | N/A | |
| createdAt | DateTime | N/A | |
| updatedAt | DateTime | N/A | |
| publishedAt | DateTime | N/A | |
| modifiedAt | String | N/A | |
| published | Boolean | N/A | |
| snippets | 清單 | N/A | |
| recaptcha | Boolean | N/A | |
| klass | String | N/A | |
| 通道 | String | N/A | |
| deflection | Boolean | N/A | |
| formHookEnabled | Boolean | N/A | |
| replyFrom | String | N/A | |
| wcag | Boolean | N/A | |
| KB 路由 | id | String | N/A |
| url | String | N/A | |
| routableType | String | N/A | |
| routableId | String | N/A | |
| createdAt | DateTime | N/A | |
| updatedAt | DateTime | N/A | |
| modifiedAt | DateTime | N/A | |
| KB 標籤 | id | String | N/A |
| name | String | N/A | |
| createdAt | DateTime | N/A | |
| updatedAt | DateTime | N/A | |
| modifiedAt | DateTime | N/A | |
| KB 範本 | id | String | N/A |
| 標題 | String | N/A | |
| 描述 | String | N/A | |
| beta | Boolean | N/A | |
| 資訊清單 | Struct | N/A | |
| jsxSnippets | 清單 | N/A | |
| images | 清單 | N/A | |
| version | String | N/A | |
| createdAt | DateTime | N/A | |
| updatedAt | DateTime | N/A | |
| KB 主題 | id | String | N/A |
| name | String | N/A | |
| active | Boolean | N/A | |
| 預設 | Boolean | N/A | |
| lastfileUpdatedAt | DateTime | N/A | |
| 自訂 | Boolean | N/A | |
| status | String | N/A | |
| templateVersionId | String | N/A | |
| templateTitle | String | N/A | |
| templateVersion | String | N/A | |
| 資訊清單 | Struct | N/A | |
| configSnippets | 清單 | N/A | |
| jsxSnippets | 清單 | N/A | |
| createdAt | DateTime | N/A | |
| updatedAt | DateTime | N/A | |
| modifiedAt | DateTime | N/A | |
| rev | Integer | N/A | |
| Klasses | id | String | N/A |
| name | String | N/A | |
| icon | String | N/A | |
| color | String | N/A | |
| appDisabled | Boolean | N/A | |
| status | String | N/A | |
| updatedAt | DateTime | N/A | |
| createdAt | DateTime | N/A | |
| s3DataUrl | String | N/A | |
| KViews | id | String | N/A |
| 資源 | String | N/A | |
| template | String | N/A | |
| context | String | N/A | |
| meta | Struct | N/A | |
| appDisabled | Boolean | N/A | |
| 啟用 | Boolean | N/A | |
| advanced | Boolean | N/A | |
| layout | 清單 | N/A | |
| components | Struct | N/A | |
| conditions | Struct | N/A | |
| rev | Integer | N/A | |
| createdAt | DateTime | N/A | |
| modifiedAt | DateTime | N/A | |
| updatedAt | DateTime | N/A | |
| 通知 | id | String | N/A |
| name | String | N/A | |
| status | String | N/A | |
| 事件 | Struct | N/A | |
| createdAt | DateTime | N/A | |
| updatedAt | DateTime | N/A | |
| 訊息 | id | String | N/A |
| externalId | String | N/A | |
| 通道 | String | =, !=, CONTAINS | |
| 應用程式 | String | N/A | |
| size | Integer | =, !=, >, >=, <, <= | |
| direction | String | =, !=, CONTAINS | |
| preview | String | N/A | |
| subject | String | N/A | |
| meta | Struct | N/A | |
| status | String | =, !=, CONTAINS | |
| directionType | String | =, !=, CONTAINS | |
| assignedTeams | 清單 | N/A | |
| assignedUsers | 清單 | N/A | |
| errorAt | DateTime | =, !=, >, >=, <, <=, BETWEEN | |
| auto | Boolean | =, != | |
| sentAt | DateTime | =, !=, >, >=, <, <=, BETWEEN | |
| createdAt | DateTime | =, !=, >, >=, <, <=, BETWEEN | |
| updatedAt | DateTime | N/A | |
| modifiedAt | DateTime | N/A | |
| redacted | Boolean | N/A | |
| createdByTeams | 清單 | N/A | |
| rev | Integer | N/A | |
| reactions | 清單 | N/A | |
| intentDetections | 清單 | N/A | |
| 備註 | id | String | N/A |
| 本文 | String | CONTAINS | |
| createdAt | DateTime | =, !=, >, >=, <, <=, BETWEEN | |
| updatedAt | DateTime | =, !=, >, >=, <, <=, BETWEEN | |
| modifiedAt | DateTime | =, !=, >, >=, <, <=, BETWEEN | |
| createdByTeams | 清單 | N/A |
分區查詢
欄位型分區
如果想要在 Spark 中使用並行,可以提供其他 Spark 選項 PARTITION_FIELD、LOWER_BOUND、UPPER_BOUND 和 NUM_PARTITIONS。使用這些參數,原始查詢會分區為可由 Spark 任務並行執行的子查詢的 NUM_PARTITIONS 數目。
PARTITION_FIELD:用來分區查詢的欄位名稱。LOWER_BOUND:所選分區欄位的包含下限值。對於 DateTime 欄位,接受 ISO 格式的值。
有效值範例:
"2023-01-15T11:18:39.205Z"UPPER_BOUND:所選分區欄位的唯一上限值。NUM_PARTITIONS:分區數目。
實體分區欄位支援詳細資訊如下表所示:
| 實體名稱 | 分區欄位 | 資料類型 |
|---|---|---|
| 公司 | modifiedAt | DateTime |
| 對話 | createdAt, updatedAt, modifiedAt, endedAt, lastMessageAt | DateTime |
| messageCount, noteCount | BigInteger | |
| priority | Integer | |
| 客戶 | createdAt, updatedAt, modifiedAt | DateTime |
| 訊息 | errorAt, sentAt, createdAt | DateTime |
| size | BigInteger | |
| 備註 | createdAt, updatedAt, modifiedAt | DateTime |
範例:
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" }