Configuration par lots batch-configuration
Utilisez les options de configuration par lots de la section Destination SDK pour permettre aux utilisateurs de personnaliser les noms des fichiers exportés et de configurer le planning d’exportation en fonction de leurs préférences.
Lorsque vous créez des destinations basées sur des fichiers via Destination SDK, vous pouvez configurer les noms de fichiers et les plannings d’exportation par défaut, ou permettre aux utilisateurs de configurer ces paramètres à partir de l’interface utilisateur de Experience Platform. Par exemple, vous pouvez configurer des comportements tels que :
- Insérez des informations spécifiques dans le nom du fichier, telles que des identifiants d’audience, des identifiants de destination ou des informations personnalisées.
- Permet aux utilisateurs de personnaliser le nom des fichiers à partir de l’interface utilisateur Experience Platform.
- Configurer des exportations de fichiers à des intervalles de temps définis.
- Définissez les options de dénomination de fichiers et de planning d’exportation que les utilisateurs peuvent voir dans l’interface utilisateur de Experience Platform.
Les paramètres de configuration par lots font partie de la configuration de destination pour les destinations basées sur des fichiers.
Pour comprendre la place de ce composant dans une intégration créée avec Destination SDK, consultez le diagramme de la documentation options de configuration ou consultez le guide sur la utilisation de Destination SDK pour configurer une destination basée sur des fichiers.
Vous pouvez configurer les noms de fichiers et les paramètres du planning d’exportation via le point d’entrée /authoring/destinations. Pour obtenir des exemples d’appels API détaillés dans lesquels vous pouvez configurer les composants affichés sur cette page, consultez les pages de référence de l’API suivantes.
Cet article décrit toutes les options de configuration par lots prises en charge que vous pouvez utiliser pour la destination et montre ce que la clientèle verra dans l’interface utilisateur d’Experience Platform.
Types d’intégration pris en charge supported-integration-types
Pour en savoir plus sur les types d’intégration qui prennent en charge les fonctionnalités décrites sur cette page, consultez le tableau ci-dessous.
batchConfig ou datasetBatchConfig batchconfig-vs-datasetbatchconfig
Cette page décrit deux objets de configuration associés, mais distincts :
batchConfig: contrôle la dénomination des fichiers et les paramètres du planning d’exportation pour les destinations qui exportent des audiences audiences (audiences de personnes, de comptes ou de prospects).datasetBatchConfig: objet imbriqué dansbatchConfigqui contrôle les noms de dossier et les paramètres de planning d’exportation spécifiquement pour les destinations qui exportent des jeux de données. Utilisez cette option lorsque la destination prend en charge les exportations de jeux de données (c’est-à-dire lorsque la"sources": ["DATASETS"]est définie dans la configuration de destination).
Paramètres pris en charge supported-parameters
Les valeurs que vous configurez ici sont affichées à l’étape Planifier l’exportation d’audiences du workflow d’activation des destinations basées sur des fichiers.
"batchConfig":{
"allowMandatoryFieldSelection":true,
"allowDedupeKeyFieldSelection":true,
"defaultExportMode":"DAILY_FULL_EXPORT",
"allowedExportModes":[
"DAILY_FULL_EXPORT",
"FIRST_FULL_THEN_INCREMENTAL"
],
"allowedScheduleFrequency":[
"DAILY",
"EVERY_3_HOURS",
"EVERY_6_HOURS",
"EVERY_8_HOURS",
"EVERY_12_HOURS",
"ONCE",
"WEEKLY",
"MONTHLY"
],
"defaultFrequency":"DAILY",
"defaultStartTime":"00:00",
"filenameConfig":{
"allowedFilenameAppendOptions":[
"SEGMENT_NAME",
"DESTINATION_INSTANCE_ID",
"DESTINATION_INSTANCE_NAME",
"ORGANIZATION_NAME",
"SANDBOX_NAME",
"DATETIME",
"CUSTOM_TEXT"
],
"defaultFilenameAppendOptions":[
"DATETIME"
],
"defaultFilename":"%DESTINATION%_%SEGMENT_ID%"
},
"segmentGroupingEnabled": true
}
allowMandatoryFieldSelectiontrue afin de permettre la spécification des attributs de profil obligatoires. La valeur par défaut est false. Pour plus d’informations, consultez la section Attributs obligatoires.allowDedupeKeyFieldSelectiontrue afin de permettre la spécification des clés de déduplication. La valeur par défaut est false. Pour plus d’informations, consultez la section Clés de déduplication.defaultExportModeDéfinit le mode d’exportation de fichier par défaut. Valeurs prises en charge :
DAILY_FULL_EXPORTFIRST_FULL_THEN_INCREMENTAL
La valeur par défaut est DAILY_FULL_EXPORT. Pour plus d’informations sur la planification des exportations de fichiers, consultez la documentation sur l’activation par lots.
allowedExportModesDéfinit les modes d’exportation de fichiers disponibles pour les clients. Valeurs prises en charge :
DAILY_FULL_EXPORTFIRST_FULL_THEN_INCREMENTAL
allowedScheduleFrequencyDéfinit la fréquence d’exportation des fichiers disponible pour les clients. Valeurs prises en charge :
ONCEEVERY_3_HOURSEVERY_6_HOURSEVERY_8_HOURSEVERY_12_HOURSDAILYWEEKLYMONTHLY
defaultFrequencyDéfinit la fréquence d’exportation du fichier par défaut.Valeurs prises en charge :
ONCEEVERY_3_HOURSEVERY_6_HOURSEVERY_8_HOURSEVERY_12_HOURSDAILYWEEKLYMONTHLY
La valeur par défaut est DAILY.
defaultStartTimefilenameConfig.allowedFilenameAppendOptionsObligatoire. Liste des macros de nom de fichier disponibles. Cela détermine les éléments qui sont ajoutés aux noms de fichier exportés (identifiant d’audience, nom de l’organisation, date et heure de l’exportation, etc.). Quand vous définissez defaultFilename, veillez à ne pas dupliquer les macros.
Valeurs prises en charge :
DESTINATIONSEGMENT_IDSEGMENT_NAMEDESTINATION_INSTANCE_IDDESTINATION_INSTANCE_NAMEORGANIZATION_NAMESANDBOX_NAMEDATETIMECUSTOM_TEXT
Quel que soit l’ordre dans lequel vous définissez les macros, l’interface utilisateur d’Experience Platform les affiche toujours dans l’ordre présenté ici.
Si defaultFilename est vide, la liste allowedFilenameAppendOptions doit contenir au moins une macro.
filenameConfig.defaultFilenameAppendOptionsLes macros de cette liste sont un sous-ensemble de celles définies dans
allowedFilenameAppendOptions.filenameConfig.defaultFilenameToute macro définie par
allowedFilenameAppendOptions sera ajoutée après les macros defaultFilename.Si
defaultFilename est vide, vous devez définir au moins une macro dans allowedFilenameAppendOptions.segmentGroupingEnabledDéfinit si les audiences activées doivent être exportées dans un ou plusieurs fichiers, selon la politique de fusion des audiences. Valeurs prises en charge :
true: exporte un fichier par politique de fusion.false: exporte un fichier par audience, quelle que soit la politique de fusion. Il s’agit du comportement par défaut. Vous pouvez obtenir le même résultat en omettant complètement ce paramètre.
Configuration du nom du fichier file-name-configuration
Utilisez les macros de configuration des noms de fichiers pour définir les noms de fichiers exportés à inclure. Les macros du tableau ci-dessous décrivent les éléments figurant dans l’interface utilisateur de l’écran configuration du nom du fichier.
SEGMENT_ID dans les noms de fichiers exportés. Les identifiants de segment sont uniques. Ainsi, la meilleure manière de s’assurer que les noms de fichiers sont également uniques est de les inclure dans le nom du fichier.DESTINATIONSEGMENT_IDSEGMENT_NAMEDESTINATION_INSTANCE_IDDESTINATION_INSTANCE_NAMEORGANIZATION_NAMESANDBOX_NAMEDATETIME / TIMESTAMPDATETIME et TIMESTAMP définissent tous deux le moment où le fichier a été généré, mais dans des formats différents.
DATETIMEutilise le format suivant : AAAAMMJJ_HHMMSS.TIMESTAMPutilise le format Unix à 10 chiffres.
DATETIME et TIMESTAMP s’excluent mutuellement et ne peuvent pas être utilisés simultanément.
DATETIME: 20220509_210543TIMESTAMP: 1652131584
CUSTOM_TEXTdefaultFilename.TIMESTAMPMERGE_POLICY_IDsegmentGroupingEnabled:true.MERGE_POLICY_NAMEsegmentGroupingEnabled:true.Exemple de configuration de nom de fichier file-name-configuration-example
L’exemple de configuration ci-dessous montre la correspondance entre la configuration utilisée dans l’appel API et les options affichées dans l’interface utilisateur.
"filenameConfig":{
"allowedFilenameAppendOptions":[
"CUSTOM_TEXT",
"SEGMENT_ID",
"DATETIME"
],
"defaultFilenameAppendOptions":[
"SEGMENT_ID",
"DATETIME"
],
"defaultFilename": "%DESTINATION%"
}
Configuration de l’exportation des jeux de données dataset-export-configuration
Utilisez l’objet datasetBatchConfig, imbriqué dans batchConfig, pour configurer les noms de dossier et les plannings d’exportation pour les destinations qui prennent en charge les exportations de jeux de données.
"sources": ["DATASETS"]. Consultez Configurer le type de données d’audience pour obtenir l’exemple de configuration de destination complet, ou suivez le guide détaillé pour configurer une destination d’exportation de jeu de données."batchConfig":{
"datasetBatchConfig":{
"allowedFoldernameAppendOptions":[
"DESTINATION",
"DATASET_ID",
"DATASET_NAME",
"EXPORT_TIME",
"DESTINATION_INSTANCE_ID",
"DESTINATION_INSTANCE_NAME",
"ORGANIZATION_NAME",
"SANDBOX_NAME",
"DATETIME",
"CUSTOM_TEXT"
],
"defaultFoldernameAppendOptions":[
"DATASET_ID",
"EXPORT_TIME"
],
"allowedExportModes":[
"DAILY_FULL_EXPORT",
"FIRST_FULL_THEN_INCREMENTAL"
],
"allowedScheduleFrequency":[
"DAILY",
"EVERY_3_HOURS",
"EVERY_6_HOURS",
"EVERY_8_HOURS",
"EVERY_12_HOURS",
"ONCE"
]
}
}
datasetBatchConfig.allowedFoldernameAppendOptionsObligatoire. Liste des macros de nom de dossier disponibles. Ceux-ci déterminent quels éléments sont ajoutés au chemin du dossier d’exportation. Si defaultFoldernameAppendOptions est vide, au moins une macro doit être spécifiée ici. Valeurs prises en charge :
DESTINATIONDATASET_IDDATASET_NAMEEXPORT_TIMEDESTINATION_INSTANCE_IDDESTINATION_INSTANCE_NAMEORGANIZATION_NAMESANDBOX_NAMEDATETIMECUSTOM_TEXT
datasetBatchConfig.defaultFoldernameAppendOptionsallowedFoldernameAppendOptions.datasetBatchConfig.allowedExportModesDéfinit les modes d’exportation disponibles pour les utilisateurs pour les exportations de jeux de données. Valeurs prises en charge :
DAILY_FULL_EXPORTFIRST_FULL_THEN_INCREMENTAL
datasetBatchConfig.allowedScheduleFrequencyDéfinit les options de fréquence d’exportation disponibles pour les utilisateurs pour les exportations de jeux de données. Valeurs prises en charge :
ONCEEVERY_3_HOURSEVERY_6_HOURSEVERY_8_HOURSEVERY_12_HOURSDAILY
Macros de nom de dossier folder-name-macros
Les macros du tableau ci-dessous peuvent être utilisées dans allowedFoldernameAppendOptions et defaultFoldernameAppendOptions pour définir la structure du chemin du dossier d’exportation du jeu de données.
DESTINATIONDATASET_IDDATASET_NAMEEXPORT_TIMEexportTime=YYYYMMDDHHMM.DESTINATION_INSTANCE_IDDESTINATION_INSTANCE_NAMEORGANIZATION_NAMESANDBOX_NAMEDATETIMEYYYYMMDD_HHMMSS.CUSTOM_TEXTÉtapes suivantes next-steps
Vous êtes arrivé au bout de cet article. À présent, vous devriez mieux comprendre comment configurer les noms de fichiers et la planification des exportations pour vos destinations basées sur les fichiers.
Pour en savoir plus sur les autres composants de destination, consultez les articles suivants :
- Configuration de l’authentification du client
- Autorisation OAuth2
- Champs de données client
- Attributs de l’interface utilisateur
- Configuration du schéma
- Configuration de l’espace de noms d’identité
- Configurations de mappage prises en charge
- Diffusion de destination
- Configuration des métadonnées d’audience
- Politique d’agrégation
- Qualifications des profils historiques