# Leitura de entidades do Kustomer
<a name="kustomer-reading-from-entities"></a>

**Pré-requisito**

Um objeto do Kustomer do qual você deseja ler. Você precisará do nome do objeto, como Marcas ou Cartões. A tabela a seguir mostra as entidades compatíveis.

**Entidades compatíveis quanto à origem**:


| Entidade | Pode ser filtrada | Oferece suporte a limite | Oferece suporte a Ordenar por | Oferece suporte a Selecionar \$1 | Oferece suporte a particionamento | 
| --- | --- | --- | --- | --- | --- | 
| Marcas | Não | Sim | Não | Sim | Não | 
| Cartões | Não | Sim | Não | Sim | Não | 
| Configurações de chat | Não | Não | Não | Sim | Não | 
| Empresas | Sim | Sim | Sim | Sim | Sim | 
| Conversas | Sim | Sim | Sim | Sim | Sim | 
| Clientes | Sim | Sim | Sim | Sim | Sim | 
| Pesquisas de clientes fixadas | Não | Sim | Não | Sim | Não | 
| Posição das pesquisas de clientes | Não | Não | Não | Sim | Não | 
| Hooks de e-mail | Não | Sim | Não | Sim | Não | 
| Webhooks | Não | Sim | Não | Sim | Não | 
| Artigos da base de conhecimento | Não | Sim | Não | Sim | Não | 
| Categorias da base de conhecimento | Não | Sim | Não | Sim | Não | 
| Formulários da base de conhecimento | Não | Sim | Não | Sim | Não | 
| Rotas da base de conhecimento | Não | Sim | Não | Sim | Não | 
| Tags da base de conhecimento | Não | Sim | Não | Sim | Não | 
| Modelos da base de conhecimento | Não | Sim | Não | Sim | Não | 
| Temas da base de conhecimento | Não | Sim | Não | Sim | Não | 
| Klasses | Não | Sim | Não | Sim | Não | 
| KViews | Não | Sim | Não | Sim | Não | 
| Mensagens | Sim | Sim | Sim | Sim | Sim | 
| Observações | Sim | Sim | Sim | Sim | Sim | 
| Notificações | Não | Sim | Não | Sim | Não | 

**Exemplo:**

```
Kustomer_read = glueContext.create_dynamic_frame.from_options(
    connection_type="kustomer",
    connection_options={
        "connectionName": "connectionName",
        "ENTITY_NAME": "brands",
        "API_VERSION": "v1"
    }
```

## Detalhes das entidades e dos campos do Kustomer
<a name="kustomer-reading-from-entities-field-details"></a>

Para obter mais informações sobre os detalhes das entidades e dos campos, consulte:
+ [Marcas](https://api.kustomerapp.com/v1/brands)
+ [Cartões](https://api.kustomerapp.com/v1/cards)
+ [Configurações de chat](https://api.kustomerapp.com/v1/chat/settings)
+ [Empresas](https://api.kustomerapp.com/v1/companies)
+ [Conversas](https://api.kustomerapp.com/v1/conversations)
+ [Clientes](https://api.kustomerapp.com/v1/customers)
+ [Pesquisas de clientes fixadas](https://api.kustomerapp.com/v1/customers/searches/pinned)
+ [Posições das pesquisas de clientes](https://api.kustomerapp.com/v1/customers/searches/positions)
+ [Hooks de e-mail](https://api.kustomerapp.com/v1/hooks/email)
+ [Webhooks](https://api.kustomerapp.com/v1/hooks/web)
+ [Artigos da base de conhecimento](https://api.kustomerapp.com/v1/kb/articles)
+ [Categorias da base de conhecimento](https://api.kustomerapp.com/v1/kb/categories)
+ [Formulários da base de conhecimento]( https://api.kustomerapp.com/v1/kb/forms)
+ [Rotas da base de conhecimento](https://api.kustomerapp.com/v1/kb/routes)
+ [Tags da base de conhecimento](https://api.kustomerapp.com/v1/kb/tags)
+ [Modelos da base de conhecimento](https://api.kustomerapp.com/v1/kb/templates)
+ [Temas da base de conhecimento](https://api.kustomerapp.com/v1/kb/themes)
+ [Klasses](https://api.kustomerapp.com/v1/klasses)
+ [Kviews](https://api.kustomerapp.com/v1/kviews)
+ [Mensagens](https://api.kustomerapp.com/v1/messages)
+ [Observações](https://api.kustomerapp.com/v1/notes)
+ [Notificações](https://api.kustomerapp.com/v1/notifications)

API do Kustomer v1

[\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/pt_br/glue/latest/dg/kustomer-reading-from-entities.html)

## Particionamento de consultas
<a name="kustomer-reading-from-partitioning"></a>

**Particionamento com base em campo**

É possível fornecer as opções adicionais do Spark `PARTITION_FIELD`, `LOWER_BOUND`, `UPPER_BOUND` e `NUM_PARTITIONS` se quiser utilizar a simultaneidade no Spark. Com esses parâmetros, a consulta original seria dividida em `NUM_PARTITIONS` subconsultas, que poderiam ser executadas pelas tarefas do Spark simultaneamente.
+ `PARTITION_FIELD`: o nome do campo a ser usado para particionar a consulta.
+ `LOWER_BOUND`: um valor limite inferior **inclusivo** do campo de partição escolhido.

  Para o campo DateTime, aceitamos o valor no formato ISO.

  Exemplo de valor válido:

  ```
  "2023-01-15T11:18:39.205Z"
  ```
+ `UPPER_BOUND`: um valor limite superior **exclusivo** do campo de partição escolhido.
+ `NUM_PARTITIONS`: o número de partições.

Os detalhes do suporte do campo de particionamento relativo às entidades são capturados na seguinte tabela:

[\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/pt_br/glue/latest/dg/kustomer-reading-from-entities.html)

Exemplo:

```
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"
    }
```