Détails des entités et des champs Kustomer Requêtes de partitionnement

Lecture à partir d’entités Kustomer

Prérequis

Un objet Kustomer à partir duquel vous souhaitez lire. Vous aurez besoin du nom de l’objet, comme Brands ou Cards. Le tableau suivant présente les entités prises en charge.

Entités prises en charge pour la source :

Entité	Peut être filtré	Limit prise en charge	Order by prise en charge	Select prise en charge*	Partitionnement pris en charge
Brands	Non	Oui	Non	Oui	Non
Cards	Non	Oui	Non	Oui	Non
Chat Settings	Non	Non	Non	Oui	Non
Companies	Oui	Oui	Oui	Oui	Oui
Conversations	Oui	Oui	Oui	Oui	Oui
Customers	Oui	Oui	Oui	Oui	Oui
Customer Searches Pinned	Non	Oui	Non	Oui	Non
Customer Searches Position	Non	Non	Non	Oui	Non
Email Hooks	Non	Oui	Non	Oui	Non
Web Hooks	Non	Oui	Non	Oui	Non
KB Articles	Non	Oui	Non	Oui	Non
KB Categories	Non	Oui	Non	Oui	Non
KB Forms	Non	Oui	Non	Oui	Non
KB Routes	Non	Oui	Non	Oui	Non
KB Tags	Non	Oui	Non	Oui	Non
KB Templates	Non	Oui	Non	Oui	Non
KB Themes	Non	Oui	Non	Oui	Non
Klasses	Non	Oui	Non	Oui	Non
KViews	Non	Oui	Non	Oui	Non
Messages	Oui	Oui	Oui	Oui	Oui
Remarques	Oui	Oui	Oui	Oui	Oui
Notifications	Non	Oui	Non	Oui	Non

Exemple :


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

Détails des entités et des champs Kustomer

Pour plus d’informations sur les entités et de détails sur les champs, consultez :

API Kustomer v1

Entité	Champ	Type de données	Opérateurs pris en charge
Brands	id	String	N/A
	name	String	N/A
	iconUrl	String	N/A
	createdAt	DateTime	N/A
	updatedAt	DateTime	N/A
	modifiedAt	DateTime	N/A
	default	Booléen	N/A
Cards	id	String	N/A
	name	String	N/A
	createdAt	DateTime	N/A
	updatedAt	DateTime	N/A
	modifiedAt	DateTime	N/A
	description	String	N/A
	url	String	N/A
	contexts	List	N/A
Chat Settings	id	String	N/A
	settingsVersion	Entier	N/A
	widgetType	String	N/A
	version	Entier	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
	enabled	Booléen	N/A
	outboundChatEnabled	Booléen	N/A
	updatedAt	DateTime	N/A
	modifiedAt	DateTime	N/A
	offhoursMessage	String	N/A
	offhoursImageUrl	String	N/A
	closableChat	Booléen	N/A
	noHistory	Booléen	N/A
	disableAttachments	Booléen	N/A
	volumeControl	Struct	N/A
	singleSessonChat	Booléen	N/A
	showTypingIndicatorWeb	Booléen	N/A
Companies	id	String	N/A
	name	String	=, !=, CONTAINS
	createdAt	DateTime	N/A
	updatedAt	DateTime	N/A
	modifiedAt	DateTime	=, !=, <, <=, >, >=, BETWEEN
	tags	List	N/A
	domains	List	N/A
	emails	List	N/A
	phones	List	N/A
	whatsapps	List	N/A
	socials	List	N/A
	urls	List	N/A
	locations	List	N/A
	roleGroupVersions	List	N/A
	rev	Entier	N/A
Conversations	id	String	N/A
	name	String	=, !=, CONTAINS
	preview	String	N/A
	canaux	List	N/A
	status	String	=, !=, CONTAINS
	messageCount	Entier	=, !=, >, >=, <, <=
	noteCount	Entier	=, !=, >, >=, <, <=
	satisfaction	Entier	=, !=, >, >=, <, <=
	satisfactionLevel	Struct	N/A
	createdAt	DateTime	=, !=, <, <=, >, >=, BETWEEN
	updatedAt	DateTime	=, !=, <, <=, >, >=, BETWEEN
	modifiedAt	DateTime	=, !=, <, <=, >, >=, BETWEEN
	lastActivityAt	DateTime	N/A
	spam	Booléen	N/A
	ended	Booléen	=, !=
	endedAt	DateTime	=, !=, <, <=, >, >=, BETWEEN
	endedReason	String	CONTAINS
	endedByType	String	N/A
	importedAt	String	N/A
	tags	List	N/A
	suggestedTags	List	N/A
	sentiment	String	N/A
	prédictions	List	N/A
	suggestedShortcuts	List	N/A
	firstMessageIn	Struct	N/A
	firstMessageOut	Struct	N/A
	lastMessageIn	Struct	N/A
	lastMessageOut	Struct	N/A
	lastMessageAt	DateTime	=, !=, <, <=, >, >=, BETWEEN
	lastMessageUnrespondedÀ	Struct	N/A
	lastMessageUnrespondedToSinceLastDone	Struct	N/A
	assignedUsers	List	N/A
	assignedTeams	List	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	Entier	N/A
	inboundMessageCount	Entier	N/A
	rev	Entier	N/A
	priority	Entier	=, !=, >, >=, <, <=
	roleGroupVersions	List	N/A
	accessOverride	List	N/A
	assistant	Struct	N/A
	phase	String	N/A
	Skills	List	N/A
	matchedTimeBasedRègles	List	N/A
Customers	id	String	N/A
	name	String	=, !=, CONTAINS
	displayName	String	N/A
	displayColor	String	N/A
	displayIcon	String	N/A
	externalId	String	=, !=, CONTAINS
	externalIds	List	N/A
	sharedExternalIds	List	N/A
	emails	List	N/A
	sharedEmails	List	N/A
	phones	List	N/A
	sharedPhones	List	N/A
	whatsapps	List	N/A
	facebookIds	List	N/A
	instagramIds	List	N/A
	socials	List	N/A
	sharedSocials	List	N/A
	urls	List	N/A
	locations	List	N/A
	activeUsers	List	N/A
	watchers	List	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
	deleted	Booléen	N/A
	lastConversation	Struct	N/A
	conversationCounts	Struct	N/A
	preview	Struct	N/A
	tags	List	N/A
	progressiveStatus	String	=, !=, CONTAINS
	verified	Booléen	N/A
	rev	Entier	N/A
	recentItems	List	N/A
	defaultLang	String	=, !=, CONTAINS
	satisfactionLevel	Struct	N/A
	roleGroupVersions	List	N/A
	accessOverride	List	N/A
	companyName	String	N/A
	firstName	String	N/A
	lastName	String	N/A
Customer Searches Pinned	id	String	N/A
	search	String	N/A
	createdAt	DateTime	N/A
Customer Searches Positions	id	String	N/A
	positions	List	N/A
	children	List	N/A
	createdAt	DateTime	N/A
	updatedAt	DateTime	N/A
	modifiedAt	DateTime	N/A
	rev	Entier	N/A
Email Hooks	id	String	N/A
	description	String	N/A
	debug	Booléen	N/A
	e-mail	String	N/A
	eventName	String	N/A
	title	String	N/A
	hachage	String	N/A
	key	String	N/A
	createdAt	DateTime	N/A
	modifiedAt	DateTime	N/A
	updatedAt	DateTime	N/A
Web Hooks	id	String	N/A
	description	String	N/A
	eventName	String	N/A
	hachage	String	N/A
	url	String	N/A
	createdAt	DateTime	N/A
	modifiedAt	DateTime	N/A
	updatedAt	DateTime	N/A
	title	String	N/A
	version	Entier	N/A
	debug	Booléen	N/A
KB Articles	id	String	N/A
	hachage	String	N/A
	title	String	N/A
	source	String	N/A
	status	String	N/A
	scope	String	N/A
	createdAt	DateTime	N/A
	updatedAt	DateTime	N/A
	deleted	Booléen	N/A
	deletedAt	DateTime	N/A
	modifiedAt	DateTime	N/A
	publishedAt	DateTime	N/A
	tags	List	N/A
	categories	List	N/A
	knowledgeBases	List	N/A
	metaTitle	String	N/A
	metaDescription	String	N/A
	metaKeywords	List	N/A
	langVersions	Struct	N/A
	latestLangs	Struct	N/A
KB Categories	id	String	N/A
	hachage	String	N/A
	createdAt	DateTime	N/A
	modifiedAt	DateTime	N/A
	updatedAt	DateTime	N/A
	published	Booléen	N/A
	positions	List	N/A
	categoryPositions	List	N/A
	racine	Booléen	N/A
	langs	Struct	N/A
KB Forms	id	String	N/A
	name	String	N/A
	slug	String	N/A
	hachage	String	N/A
	body	String	N/A
	layout	List	N/A
	layoutV2	List	N/A
	componentsV2	Struct	N/A
	conditions	Struct	N/A
	advanced	Booléen	N/A
	createdAt	DateTime	N/A
	updatedAt	DateTime	N/A
	publishedAt	DateTime	N/A
	modifiedAt	String	N/A
	published	Booléen	N/A
	snippets	List	N/A
	recaptcha	Booléen	N/A
	klass	String	N/A
	channel	String	N/A
	deflection	Booléen	N/A
	formHookEnabled	Booléen	N/A
	replyFrom	String	N/A
	wcag	Booléen	N/A
KB Routes	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 Tags	id	String	N/A
	name	String	N/A
	createdAt	DateTime	N/A
	updatedAt	DateTime	N/A
	modifiedAt	DateTime	N/A
KB Templates	id	String	N/A
	title	String	N/A
	description	String	N/A
	beta	Booléen	N/A
	manifeste	Struct	N/A
	jsxSnippets	List	N/A
	images	List	N/A
	version	String	N/A
	createdAt	DateTime	N/A
	updatedAt	DateTime	N/A
KB Themes	id	String	N/A
	name	String	N/A
	actif	Booléen	N/A
	default	Booléen	N/A
	lastfileUpdatedAt	DateTime	N/A
	personnalisé	Booléen	N/A
	status	String	N/A
	templateVersionId	String	N/A
	templateTitle	String	N/A
	templateVersion	String	N/A
	manifeste	Struct	N/A
	configSnippets	List	N/A
	jsxSnippets	List	N/A
	createdAt	DateTime	N/A
	updatedAt	DateTime	N/A
	modifiedAt	DateTime	N/A
	rev	Entier	N/A
Klasses	id	String	N/A
	name	String	N/A
	icon	String	N/A
	color	String	N/A
	appDisabled	Booléen	N/A
	status	String	N/A
	updatedAt	DateTime	N/A
	createdAt	DateTime	N/A
	s3 DataUrl	String	N/A
KViews	id	String	N/A
	ressource	String	N/A
	modèle	String	N/A
	contexte	String	N/A
	meta	Struct	N/A
	appDisabled	Booléen	N/A
	enabled	Booléen	N/A
	advanced	Booléen	N/A
	layout	List	N/A
	components	Struct	N/A
	conditions	Struct	N/A
	rev	Entier	N/A
	createdAt	DateTime	N/A
	modifiedAt	DateTime	N/A
	updatedAt	DateTime	N/A
Notifications	id	String	N/A
	name	String	N/A
	status	String	N/A
	event	Struct	N/A
	createdAt	DateTime	N/A
	updatedAt	DateTime	N/A
Messages	id	String	N/A
	externalId	String	N/A
	channel	String	=, !=, CONTAINS
	app	String	N/A
	size	Entier	=, !=, >, >=, <, <=
	direction	String	=, !=, CONTAINS
	preview	String	N/A
	subject	String	N/A
	meta	Struct	N/A
	status	String	=, !=, CONTAINS
	directionType	String	=, !=, CONTAINS
	assignedTeams	List	N/A
	assignedUsers	List	N/A
	errorAt	DateTime	=, !=, <, <=, >, >=, BETWEEN
	auto	Booléen	=, !=
	sentAt	DateTime	=, !=, <, <=, >, >=, BETWEEN
	createdAt	DateTime	=, !=, <, <=, >, >=, BETWEEN
	updatedAt	DateTime	N/A
	modifiedAt	DateTime	N/A
	redacted	Booléen	N/A
	createdByTeams	List	N/A
	rev	Entier	N/A
	reactions	List	N/A
	intentDetections	List	N/A
Remarques	id	String	N/A
	body	String	CONTAINS
	createdAt	DateTime	=, !=, <, <=, >, >=, BETWEEN
	updatedAt	DateTime	=, !=, <, <=, >, >=, BETWEEN
	modifiedAt	DateTime	=, !=, <, <=, >, >=, BETWEEN
	createdByTeams	List	N/A

Requêtes de partitionnement

Partitionnement basé sur les champs

Vous pouvez indiquer les options Spark supplémentaires PARTITION_FIELD, LOWER_BOUND, UPPER_BOUND et NUM_PARTITIONS si vous souhaitez utiliser la simultanéité dans Spark. Avec ces paramètres, la requête d’origine serait divisée en NUM_PARTITIONS nombres de sous-requêtes pouvant être exécutées simultanément par les tâches Spark.

PARTITION_FIELD : le nom du champ à utiliser pour partitionner la requête.
LOWER_BOUND : une valeur limite inférieure inclusive du champ de partition choisi.

Pour le DateTime champ, nous acceptons la valeur au format ISO.

Exemple de valeur valide :
```
"2023-01-15T11:18:39.205Z"
```
UPPER_BOUND : une valeur limite supérieure exclusive du champ de partition choisi.
NUM_PARTITIONS : le nombre de partitions.

Les détails relatifs à la prise en charge des champs de partitionnement par entité sont présentés dans le tableau suivant :

Nom de l'entité	Champs de partitionnement	Type de données
Companies	modifiedAt	DateTime
Conversations	CreatedAt, UpdatedAt, ModifiedAt, EndedAt, lastMessageAt	DateTime
	messageCount, noteCount	BigInteger
	priority	Entier
Customers	createdAt, updatedAt, modifiedAt	DateTime
Messages	errorAt, sentAt, createdAt	DateTime
Messages	size	BigInteger
Remarques	createdAt, updatedAt, modifiedAt	DateTime

Exemple :


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

Avertissement JavaScript est désactivé ou n'est pas disponible dans votre navigateur.

Pour que vous puissiez utiliser la documentation AWS, Javascript doit être activé. Vous trouverez des instructions sur les pages d'aide de votre navigateur.

Conventions de rédaction

Configuration de connexions Kustomer

Options de connexion Kustomer