Lectura de entidades de Kustomer
Requisito previo
Un objeto de Kustomer desde el que desea leer. Necesitará el nombre del objeto, como Marcas o Tarjetas. En la siguiente tabla se muestran las entidades admitidas.
Entidades compatibles como origen:
| Entidad | Se puede filtrar | Admite límite | Admite Ordenar por | Admite Seleccionar * | Admite partición |
|---|---|---|---|---|---|
| Marcas | No | Sí | No | Sí | No |
| Tarjetas | No | Sí | No | Sí | No |
| Configuración del chat | No | No | No | Sí | No |
| Empresas | Sí | Sí | Sí | Sí | Sí |
| Conversaciones | Sí | Sí | Sí | Sí | Sí |
| Clientes | Sí | Sí | Sí | Sí | Sí |
| Búsquedas de clientes ancladas | No | Sí | No | Sí | No |
| Posición de búsquedas de clientes | No | No | No | Sí | No |
| Enlaces de correo | No | Sí | No | Sí | No |
| Enlaces web | No | Sí | No | Sí | No |
| Artículos de KB | No | Sí | No | Sí | No |
| Categorías de KB | No | Sí | No | Sí | No |
| Formularios de KB | No | Sí | No | Sí | No |
| Rutas de KB | No | Sí | No | Sí | No |
| Etiquetas de KB | No | Sí | No | Sí | No |
| Plantillas de KB | No | Sí | No | Sí | No |
| Temas de KB | No | Sí | No | Sí | No |
| Klasses | No | Sí | No | Sí | No |
| KViews | No | Sí | No | Sí | No |
| Mensajes | Sí | Sí | Sí | Sí | Sí |
| Notas | Sí | Sí | Sí | Sí | Sí |
| Notificaciones | No | Sí | No | Sí | No |
Ejemplo:
Kustomer_read = glueContext.create_dynamic_frame.from_options( connection_type="kustomer", connection_options={ "connectionName": "connectionName", "ENTITY_NAME": "brands", "API_VERSION": "v1" }
Detalles de entidades y campos de Kustomer
Para obtener más información acerca de las entidades y los detalles de los campos, consulte:
API v1
| Entidad | Campo | Tipo de datos: | Operadores admitidos |
|---|---|---|---|
| Marcas | id | Cadena | N/A |
| nombre | Cadena | N/A | |
| iconUrl | Cadena | N/A | |
| createdAt | DateTime | N/A | |
| updatedAt | DateTime | N/A | |
| modifiedAt | DateTime | N/A | |
| predeterminado | Booleano | N/A | |
| Tarjetas | id | Cadena | N/A |
| nombre | Cadena | N/A | |
| createdAt | DateTime | N/A | |
| updatedAt | DateTime | N/A | |
| modifiedAt | DateTime | N/A | |
| Descripción | Cadena | N/A | |
| url | Cadena | N/A | |
| contextos | Enumeración | N/A | |
| Configuración del chat | id | Cadena | N/A |
| settingsVersion | Entero | N/A | |
| widgetType | Cadena | N/A | |
| versión | Entero | N/A | |
| teamName | Cadena | N/A | |
| saludo | Cadena | N/A | |
| respuesta automática | Cadena | N/A | |
| embedIconUrl | Cadena | N/A | |
| embedIconColor | Cadena | N/A | |
| fallbackEmailSubject | Cadena | N/A | |
| fallbackEmailIntroduction | Cadena | N/A | |
| enabled | Booleano | N/A | |
| outboundChatEnabled | Booleano | N/A | |
| updatedAt | DateTime | N/A | |
| modifiedAt | DateTime | N/A | |
| offhoursMessage | Cadena | N/A | |
| offhoursImageUrl | Cadena | N/A | |
| closableChat | Booleano | N/A | |
| noHistory | Booleano | N/A | |
| disableAttachments | Booleano | N/A | |
| volumeControl | Struct | N/A | |
| singleSessonChat | Booleano | N/A | |
| showTypingIndicatorWeb | Booleano | N/A | |
| Empresas | id | Cadena | N/A |
| nombre | Cadena | =, !=, CONTAINS | |
| createdAt | DateTime | N/A | |
| updatedAt | DateTime | N/A | |
| modifiedAt | DateTime | =, !=, <, <=, >, >=, BETWEEN | |
| etiquetas | Enumeración | N/A | |
| domains | Enumeración | N/A | |
| correos electrónicos | Enumeración | N/A | |
| teléfonos | Enumeración | N/A | |
| mensajes de WhatsApp | Enumeración | N/A | |
| redes sociales | Enumeración | N/A | |
| url | Enumeración | N/A | |
| ubicaciones | Enumeración | N/A | |
| roleGroupVersions | Enumeración | N/A | |
| rev | Entero | N/A | |
| Conversaciones | id | Cadena | N/A |
| nombre | Cadena | =, !=, CONTAINS | |
| vista previa | Cadena | N/A | |
| canales | Enumeración | N/A | |
| status | Cadena | =, !=, CONTAINS | |
| messageCount | Entero | =, !=, >, >=, <, <= | |
| noteCount | Entero | =, !=, >, >=, <, <= | |
| satisfacción | Entero | =, !=, >, >=, <, <= | |
| satisfactionLevel | Struct | N/A | |
| createdAt | DateTime | =, !=, <, <=, >, >=, BETWEEN | |
| updatedAt | DateTime | =, !=, <, <=, >, >=, BETWEEN | |
| modifiedAt | DateTime | =, !=, <, <=, >, >=, BETWEEN | |
| lastActivityAt | DateTime | N/A | |
| spam | Booleano | N/A | |
| finalizó | Booleano | =, != | |
| endedAt | DateTime | =, !=, <, <=, >, >=, BETWEEN | |
| endedReason | Cadena | CONTAINS | |
| endedByType | Cadena | N/A | |
| importedAt | Cadena | N/A | |
| etiquetas | Enumeración | N/A | |
| suggestedTags | Enumeración | N/A | |
| opinión | Cadena | N/A | |
| predicciones | Enumeración | N/A | |
| suggestedShortcuts | Enumeración | 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 | Enumeración | N/A | |
| assignedTeams | Enumeración | N/A | |
| firstResponse | Struct | N/A | |
| firstResponseSinceLastDone | Struct | N/A | |
| lastResponse | Struct | N/A | |
| firstDone | Struct | N/A | |
| lastDone | Struct | N/A | |
| direction | Cadena | =, !=, CONTAINS | |
| lastMessageDirection | Cadena | N/A | |
| outboundMessageCount | Entero | N/A | |
| inboundMessageCount | Entero | N/A | |
| rev | Entero | N/A | |
| priority | Entero | =, !=, >, >=, <, <= | |
| roleGroupVersions | Enumeración | N/A | |
| accessOverride | Enumeración | N/A | |
| asistente | Struct | N/A | |
| fase | Cadena | N/A | |
| Habilidades | Enumeración | N/A | |
| matchedTimeBasedRules | Enumeración | N/A | |
| Clientes | id | Cadena | N/A |
| nombre | Cadena | =, !=, CONTAINS | |
| displayName | Cadena | N/A | |
| displayColor | Cadena | N/A | |
| displayIcon | Cadena | N/A | |
| externalId | Cadena | =, !=, CONTAINS | |
| externalIds | Enumeración | N/A | |
| sharedExternalIds | Enumeración | N/A | |
| correos electrónicos | Enumeración | N/A | |
| sharedEmails | Enumeración | N/A | |
| teléfonos | Enumeración | N/A | |
| sharedPhones | Enumeración | N/A | |
| mensajes de WhatsApp | Enumeración | N/A | |
| facebookIds | Enumeración | N/A | |
| instagramIds | Enumeración | N/A | |
| redes sociales | Enumeración | N/A | |
| sharedSocials | Enumeración | N/A | |
| url | Enumeración | N/A | |
| ubicaciones | Enumeración | N/A | |
| activeUsers | Enumeración | N/A | |
| monitores | Enumeración | N/A | |
| recentLocation | Struct | N/A | |
| locale | Cadena | =, !=, CONTAINS | |
| timeZone | Cadena | N/A | |
| gender | Cadena | =, !=, CONTAINS | |
| createdAt | DateTime | =, !=, <, <=, >, >=, BETWEEN | |
| updatedAt | DateTime | =, !=, <, <=, >, >=, BETWEEN | |
| modifiedAt | DateTime | =, !=, <, <=, >, >=, BETWEEN | |
| lastActivityAt | DateTime | N/A | |
| eliminado | Booleano | N/A | |
| lastConversation | Struct | N/A | |
| conversationCounts | Struct | N/A | |
| vista previa | Struct | N/A | |
| etiquetas | Enumeración | N/A | |
| progressiveStatus | Cadena | =, !=, CONTAINS | |
| verified | Booleano | N/A | |
| rev | Entero | N/A | |
| recentItems | Enumeración | N/A | |
| defaultLang | Cadena | =, !=, CONTAINS | |
| satisfactionLevel | Struct | N/A | |
| roleGroupVersions | Enumeración | N/A | |
| accessOverride | Enumeración | N/A | |
| companyName | Cadena | N/A | |
| firstName | Cadena | N/A | |
| lastName | Cadena | N/A | |
| Búsquedas de clientes ancladas | id | Cadena | N/A |
| buscar | Cadena | N/A | |
| createdAt | DateTime | N/A | |
| Posición de búsquedas de clientes | id | Cadena | N/A |
| positions | Enumeración | N/A | |
| elemento secundario | Enumeración | N/A | |
| createdAt | DateTime | N/A | |
| updatedAt | DateTime | N/A | |
| modifiedAt | DateTime | N/A | |
| rev | Entero | N/A | |
| Enlaces de correo | id | Cadena | N/A |
| Descripción | Cadena | N/A | |
| depuración | Booleano | N/A | |
| correo electrónico | Cadena | N/A | |
| eventName | Cadena | N/A | |
| título | Cadena | N/A | |
| hash | Cadena | N/A | |
| key | Cadena | N/A | |
| createdAt | DateTime | N/A | |
| modifiedAt | DateTime | N/A | |
| updatedAt | DateTime | N/A | |
| Enlaces web | id | Cadena | N/A |
| Descripción | Cadena | N/A | |
| eventName | Cadena | N/A | |
| hash | Cadena | N/A | |
| url | Cadena | N/A | |
| createdAt | DateTime | N/A | |
| modifiedAt | DateTime | N/A | |
| updatedAt | DateTime | N/A | |
| título | Cadena | N/A | |
| versión | Entero | N/A | |
| depuración | Booleano | N/A | |
| Artículos de KB | id | Cadena | N/A |
| hash | Cadena | N/A | |
| título | Cadena | N/A | |
| origen | Cadena | N/A | |
| status | Cadena | N/A | |
| scope | Cadena | N/A | |
| createdAt | DateTime | N/A | |
| updatedAt | DateTime | N/A | |
| eliminado | Booleano | N/A | |
| deletedAt | DateTime | N/A | |
| modifiedAt | DateTime | N/A | |
| publishedAt | DateTime | N/A | |
| etiquetas | Enumeración | N/A | |
| categories | Enumeración | N/A | |
| knowledgeBases | Enumeración | N/A | |
| metaTitle | Cadena | N/A | |
| metaDescription | Cadena | N/A | |
| metaKeywords | Enumeración | N/A | |
| langVersions | Struct | N/A | |
| latestLangs | Struct | N/A | |
| Categorías de KB | id | Cadena | N/A |
| hash | Cadena | N/A | |
| createdAt | DateTime | N/A | |
| modifiedAt | DateTime | N/A | |
| updatedAt | DateTime | N/A | |
| publicado | Booleano | N/A | |
| positions | Enumeración | N/A | |
| categoryPositions | Enumeración | N/A | |
| root | Booleano | N/A | |
| idiomas | Struct | N/A | |
| Formularios de KB | id | Cadena | N/A |
| nombre | Cadena | N/A | |
| URL amigable | Cadena | N/A | |
| hash | Cadena | N/A | |
| cuerpo | Cadena | N/A | |
| diseño | Enumeración | N/A | |
| layoutV2 | Enumeración | N/A | |
| componentsV2 | Struct | N/A | |
| condiciones | Struct | N/A | |
| avanzado | Booleano | N/A | |
| createdAt | DateTime | N/A | |
| updatedAt | DateTime | N/A | |
| publishedAt | DateTime | N/A | |
| modifiedAt | Cadena | N/A | |
| publicado | Booleano | N/A | |
| fragmentos | Enumeración | N/A | |
| recaptcha | Booleano | N/A | |
| klass | Cadena | N/A | |
| channel | Cadena | N/A | |
| desviación | Booleano | N/A | |
| formHookEnabled | Booleano | N/A | |
| replyFrom | Cadena | N/A | |
| wcag | Booleano | N/A | |
| Rutas de KB | id | Cadena | N/A |
| url | Cadena | N/A | |
| routableType | Cadena | N/A | |
| routableId | Cadena | N/A | |
| createdAt | DateTime | N/A | |
| updatedAt | DateTime | N/A | |
| modifiedAt | DateTime | N/A | |
| Etiquetas de KB | id | Cadena | N/A |
| nombre | Cadena | N/A | |
| createdAt | DateTime | N/A | |
| updatedAt | DateTime | N/A | |
| modifiedAt | DateTime | N/A | |
| Plantillas de KB | id | Cadena | N/A |
| título | Cadena | N/A | |
| Descripción | Cadena | N/A | |
| beta | Booleano | N/A | |
| manifiesto | Struct | N/A | |
| jsxSnippets | Enumeración | N/A | |
| images | Enumeración | N/A | |
| versión | Cadena | N/A | |
| createdAt | DateTime | N/A | |
| updatedAt | DateTime | N/A | |
| Temas de KB | id | Cadena | N/A |
| nombre | Cadena | N/A | |
| activa | Booleano | N/A | |
| predeterminado | Booleano | N/A | |
| lastfileUpdatedAt | DateTime | N/A | |
| personalizado | Booleano | N/A | |
| status | Cadena | N/A | |
| templateVersionId | Cadena | N/A | |
| templateTitle | Cadena | N/A | |
| templateVersion | Cadena | N/A | |
| manifiesto | Struct | N/A | |
| configSnippets | Enumeración | N/A | |
| jsxSnippets | Enumeración | N/A | |
| createdAt | DateTime | N/A | |
| updatedAt | DateTime | N/A | |
| modifiedAt | DateTime | N/A | |
| rev | Entero | N/A | |
| Klasses | id | Cadena | N/A |
| nombre | Cadena | N/A | |
| icono | Cadena | N/A | |
| color | Cadena | N/A | |
| appDisabled | Booleano | N/A | |
| status | Cadena | N/A | |
| updatedAt | DateTime | N/A | |
| createdAt | DateTime | N/A | |
| s3DataUrl | Cadena | N/A | |
| KViews | id | Cadena | N/A |
| recurso | Cadena | N/A | |
| plantilla | Cadena | N/A | |
| context | Cadena | N/A | |
| meta | Struct | N/A | |
| appDisabled | Booleano | N/A | |
| enabled | Booleano | N/A | |
| avanzado | Booleano | N/A | |
| diseño | Enumeración | N/A | |
| componentes | Struct | N/A | |
| condiciones | Struct | N/A | |
| rev | Entero | N/A | |
| createdAt | DateTime | N/A | |
| modifiedAt | DateTime | N/A | |
| updatedAt | DateTime | N/A | |
| Notificaciones | id | Cadena | N/A |
| nombre | Cadena | N/A | |
| status | Cadena | N/A | |
| event | Struct | N/A | |
| createdAt | DateTime | N/A | |
| updatedAt | DateTime | N/A | |
| Mensajes | id | Cadena | N/A |
| externalId | Cadena | N/A | |
| channel | Cadena | =, !=, CONTAINS | |
| aplicación | Cadena | N/A | |
| tamaño | Entero | =, !=, >, >=, <, <= | |
| direction | Cadena | =, !=, CONTAINS | |
| vista previa | Cadena | N/A | |
| subject | Cadena | N/A | |
| meta | Struct | N/A | |
| status | Cadena | =, !=, CONTAINS | |
| directionType | Cadena | =, !=, CONTAINS | |
| assignedTeams | Enumeración | N/A | |
| assignedUsers | Enumeración | N/A | |
| errorAt | DateTime | =, !=, <, <=, >, >=, BETWEEN | |
| auto | Booleano | =, != | |
| sentAt | DateTime | =, !=, <, <=, >, >=, BETWEEN | |
| createdAt | DateTime | =, !=, <, <=, >, >=, BETWEEN | |
| updatedAt | DateTime | N/A | |
| modifiedAt | DateTime | N/A | |
| censurado | Booleano | N/A | |
| createdByTeams | Enumeración | N/A | |
| rev | Entero | N/A | |
| reactions | Enumeración | N/A | |
| intentDetections | Enumeración | N/A | |
| Notas | id | Cadena | N/A |
| cuerpo | Cadena | CONTAINS | |
| createdAt | DateTime | =, !=, <, <=, >, >=, BETWEEN | |
| updatedAt | DateTime | =, !=, <, <=, >, >=, BETWEEN | |
| modifiedAt | DateTime | =, !=, <, <=, >, >=, BETWEEN | |
| createdByTeams | Enumeración | N/A |
Consultas de partición
Partición basada en campos
Puede proporcionar las opciones adicionales de Spark PARTITION_FIELD, LOWER_BOUND, UPPER_BOUND y NUM_PARTITIONS si quiere utilizar la simultaneidad en Spark. Con estos parámetros, la consulta original se dividiría en un número NUM_PARTITIONS de subconsultas que las tareas de Spark pueden ejecutar simultáneamente.
PARTITION_FIELD: el nombre del campo que se utilizará para particionar la consulta.LOWER_BOUND: un valor de límite inferior inclusivo del campo de partición elegido.Para el campo DateTime, aceptamos el valor en formato ISO.
Ejemplo de valor válido:
"2023-01-15T11:18:39.205Z"UPPER_BOUND: un valor límite superior exclusivo del campo de partición elegido.NUM_PARTITIONS: el número de particiones.
En la siguiente tabla se detalla la compatibilidad de los campos de partición por entidad:
| Nombre de la entidad | Campos de partición | Tipo de datos: |
|---|---|---|
| Empresas | modifiedAt | DateTime |
| Conversaciones | createdAt, updatedAt, modifiedAt, endedAt, lastMessageAt | DateTime |
| messageCount, noteCount | BigInteger | |
| priority | Entero | |
| Clientes | createdAt, updatedAt, modifiedAt | DateTime |
| Mensajes | errorAt, sentAt, createdAt | DateTime |
| tamaño | BigInteger | |
| Notas | createdAt, updatedAt, modifiedAt | DateTime |
Ejemplo:
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" }