Schickler Drive Integration

automatically transmit article data to drive when articles are published or updated in purple publishing what is schickler drive? drive is a content analysis and optimization platform developed by schickler that helps publishers understand and improve their content performance prerequisites before setup, you must have active drive account with schickler api token from schickler publisher id from schickler drive api url (typically https //api drive news de/api/v2/articles ) configuration publication property setup access purple manager and add a custom property to your publication name drive config type json configuration parameters parameter type required description token string yes api token from schickler url string yes drive api endpoint publisher string yes publisher id assigned by schickler userneedpropertynames array of strings no content property names used to populate user needs extraproperties object no maps content property keys to additional drive fields includemodifiedtime boolean no send the article's last modified timestamp as update timestamp defaults to false only enable if your drive version supports this field articlesegmentseditorialcategory string no when set, maps article categories to editorial article segment in the drive payload the value is used as the editorial category for each segment entry (e g "ressort" , "geo" , "audience" , "other" ) excludedposttypes array of strings no list of post types to exclude from drive sync articles whose post type matches any entry in this list are silently skipped and not sent to drive stripscriptsandiframes boolean no when true , removes all \<script> and \<iframe> elements (and their contents) from the article html ( article text ) before it is sent to drive defaults to false enable when the drive endpoint rejects article html that contains inline scripts or embeds minimal example { "token" "your api token", "url" "https //api drive news de/api/v2/articles", "publisher" "your publisher id" } full example { "token" "your api token", "url" "https //api drive news de/api/v2/articles", "publisher" "your publisher id", "userneedpropertynames" \["drive userneeds"], "extraproperties" { "my cms property" "drive field name" }, "includemodifiedtime" true, "articlesegmentseditorialcategory" "ressort", "excludedposttypes" \["page"], "stripscriptsandiframes" true } user needs setup (optional) to enable user need categorization create an advanced custom field (acf) named drive userneeds set field type to dropdown configure options (e g inspiration, lösung, unterhaltung, alltagshilfe, neuigkeit, hintergrund) apply the acf to your content templates add "drive userneeds" to userneedpropertynames in your drive config the acf name must match the value in userneedpropertynames post type filter (optional) when excludedposttypes is configured, articles whose post type matches any entry in the list are not sent to drive the article is silently skipped — no error is raised and no data is transmitted this is useful when certain content types should not be analyzed by drive, for example pages that are not editorially relevant articles { "token" "your api token", "url" "https //api drive news de/api/v2/articles", "publisher" "your publisher id", "excludedposttypes" \["page"] } the filter only applies when the article has a post type set articles without a post type are always processed normally category segment mapping (optional) when articlesegmentseditorialcategory is configured, the integration maps article categories from the taxonomy to the editorial article segment field in the drive payload each category produces one segment entry with the category name as level 1 example segment output "editorial article segment" \[ { "level 1" "graubünden", "editorial category" "ressort" } ] the field is omitted entirely from the payload when articlesegmentseditorialcategory is not set, ensuring compatibility with older drive versions script and iframe stripping (optional) when stripscriptsandiframes is set to true , all \<script> and \<iframe> elements — together with their contents — are removed from the article html ( article text ) before the article is sent to drive when the flag is false (the default), the content is sent unchanged enable this flag when the configured drive endpoint rejects article html that contains inline \<script> or \<iframe> embeds stripping these elements lets the article be accepted { "token" "your api token", "url" "https //api drive news de/api/v2/articles", "publisher" "your publisher id", "stripscriptsandiframes" true } note the trade off interactive embeds such as charts and videos are removed from the drive copy of the article the flag is opt in per publication — existing publications are unaffected unless they set it how it works new articles once configured, the integration automatically detects article publication or updates extracts article data, user needs, and category taxonomies formats the data per drive api specifications transmits it securely to drive logs the result in the system historical articles to send previously published content, contact your purple support team example payload { "article id" "abc123", "article title" "graubünden neue massnahmen angekündigt", "article teaser" "der kanton graubünden hat heute neue massnahmen bekannt gegeben ", "article text" "der kanton graubünden ", "authors" \["max mustermann"], "publish timestamp" "2024 03 15t13 00 00", "update timestamp" "2024 03 15t12 00 00 000z", "tags" { "tags" \["politik", "graubünden"], "categories" \["graubünden"] }, "extra info" {}, "publisher" "purple", "article user need publisher" \["neuigkeit"], "editorial article segment" \[ { "level 1" "graubünden", "editorial category" "ressort" } ] } deactivating the integration log in to purple manager navigate to your publication settings remove the drive config custom property optionally deactivate the drive userneeds acf