Synesty Docs

Cloudinary

Mit dem Add-On für die Cloudinary APIopen in new window können Sie Ihre Bilder bearbeiten, hochlanden und Cloudinary als CDN (Content Delivery Network) nutzen.

Zugangsdaten

Um das Cloudinary Addon nutzen zu können benötigen Sie den API Key, API Secret (Settings->Accountopen in new window) sowie den Cloud Name (Settings->Access Keysopen in new window). Optional kann noch der API Endpoint (api.cloudinary.com (weltweit) oder api-eu.cloudinary.com (Europa)) festgelegt werden.

Allgemeines zu Prozess

In der Regel werden zuerst die Medien in den Cloudinary Speicher geladen. Diese Originale können dann später beim herunterladen transformiert werden. Es besteht auch die Möglichkeit die Bilder direkt beim hochladen in den Speicher zu transformieren. Hierbei werden dann aber die bereits bearbeiteten Medien in der Cloud gespeichert und es sind keine in Ihrer Cloud Originale vorhanden.

Wenn Ihre medien auf Ihren Cloudinary Account hochgeladen werde wird als Antwort wird für jede Datei eine asset_id ausgegeben. Die asset_id ist die interne Referenz die später von anderen Steps verwendet wird.

Unterstützte Bild-Formate

Step: CloudinaryUploadResources

Dieser Step läd eine Liste von Bildern in Ihren Cloudinary-Account. Im Output-Spreadsheet wird dann ein Spreadsheet mit asset_id's ausgegeben welche für die anderen Cloudinary-Steps benötigt werden.

Außerdem werden diverse Meta-Daten der jeweiligen Bilder mit ausgegeben.

files

  • Datei oder Datei-Liste mit Bildern im unterstützten Format

folder

  • Der Ordner, in den die Bilder geladen werden sollen. (wird neu angelegt falls nicht vorhanden)

limit

  • legt fest, wie viele Dateien der Dateiliste verarbeitet werden sollen
  • sinnvoll zu Testzwecken bei einer Dateiliste mit vielen Dateien

Outputs:

result

Spreadsheet mit den erfolgreich hochgeladenen Medien.

  • hier finden sich die asset_id's der Hochgeladenen Bilder
  • in der Spalte url wird die direkte URL zum hochgeladenen Bild geliefert (kann später in anderen Steps verwendet werden)

failed

Spreadsheet mit den Uploads die fehlgeschlagen sind.

In der Spalte error_message ist eine detaillierte Fehlerbeschreibung zu finden.

Step: CloudinaryTransformUpload

Dieser Step läd eine Liste von Bildern in Ihren Cloudinary-Account. Im gegensatz zum CloudinaryUploadResources-Step können hier direkt beim upload parameter angegeben werden welche die Bilder transformiert und dann in der Cloud speichert.

Dieser Step bietet 2 Möglichkeiten, wie die Bilder transformiert werden können. Zum einen können globale Parameter gesetzt werden mit denen alle Bilder der übergebene Datei-Liste gleichermaßen transformiert werden. Zum anderen kann auch ein Spreadsheet mitgegeben werden mit dem verschiedene Parameter pro Datei gesetzt werden können. Voraussetzung ist, das die Dateinamen der separat zu verarbeitenden Dateien im Spreadsheet vorhanden sein. Sind die Dateinamen nicht im Spreadsheet vorhanden, werden die globalen Parameter verwendet.

Output-Spreadsheet wird dann wieder ein Spreadsheet mit asset_id's ausgegeben.

files

  • Datei oder Datei-Liste mit Bildern im unterstützten Format

file transformations

  • Spreadsheet mit Dateinamen und Parametern
  • im Spreadsheet können mehr Parameter gesetzt werden als in den globalen Optionen

Spalten:

  • filename - Dateinamen der im Parameter files übergebenen Bilder (Pflichtspalte)
  • asset_folder - Ordner, in den die Bilder abgelegt werden sollen
  • upload_preset - Name eines Upload-Presets
  • tags - Komma-Separierte Liste mit Tags (Bsp: "Sommer,Wiese")
  • context Kontextuelle Meta-daten welche an die Bilder gehängt werden, Pipe-Separierte Schlüssel-Wert-Paare (Bsp: Jahreszeit=Sommer|Ort=Wiese")
  • metadata - Pipe-Separierte Liste von Meta-Data-Feldern (Bsp: "stock_id=20|media_id=12")
  • crop_mode - Wenn die angeforderten Bild-Dimensionen eine andere Grüße als das Original haben werden die Crop-Modi verwendet
  • resize_mode - ändern der Bild-Größe ohne etwas aus dem Bild herauszuschneiden
  • gravity_mode - wenn ein Crop-Modus genutzt wird legt der gravity_mode den zu erhaltenden Bildbereich fest
  • quality - legt die Bild-Qualität (Kompressionsrate) der Ziel-Dateien fest
  • width - legt die Bildbreite in Verbindung mit dem resize_mode fest
  • height - legt die Bildhöhe in Verbindung mit dem resize_mode fest
  • aspect_ratio - legt das neue Seitenverhältnis fest
  • opacity - legt die Deckkraft fest (Werte von 0-100 (%))
  • content_aware_padding - setzt automatisch (abhängig vom Bildinhalt) die Auffüll-Farbe in Verbindung mit den crop_mode's
  • background_color - legt eine benutzerdefinierte Auffüll-Farbe in Verbindung mit den crop_mode's fest
  • borders - fügt einen Bildrand fest, Schreibweise angelehnt an CSS (Bsp: " bo_5px_solid_red" -> Rand von 5 Pixeln, durchgängig, rot)
  • artistic_filter - setzt fest definierte künstlerische Filter
  • target_format - legt Zielformat der Bilder fest
  • custom_properties - setzt benutzerdefinierte Transformations-Operationen, alle anderen Spalten werden dann aber ignoriert (bis auf target_format)

Alle möglichen Operationen können hieropen in new window eingesehen werden. Im Gegensatz zu den globalen Optionen müssen hier die Präfixe mit gesetzt werden.

limit

  • legt fest, wie viele Dateien der Dateiliste verarbeitet werden sollen

upload preset

  • Name des zu verwendenden Upload-Presets (muss bereits in Ihrem Cloudinary-Account hinterlegt sein)

Wichtig:

Die Parameter haben normalerweise ein Präfix (zB. c_ für crop, g_ für gravity etc..). Der besseren Darstellung wegen wurde diese in den Stop-Optionen weg gelassen. Werden transformation custom properties gesetzt, müssen die Parameter in originaler Schreibweise mit Präfix gesetzt werden.


transformation quality

  • legt die Qualität der Zieldatei fest

Optionen:

  • disabled (wie Original)
  • auto
  • best
  • good
  • eco
  • low
  • 100 (%)
  • 80 (%)
  • 50 (%)
  • 35 (%)
  • 20 (%)

transformation width

  • legt die Bild-Breite fest (in Pixel)

transformation height

  • legt die Bild-Breite fest (in Pixel)

transformation cropping mode

  • legt fest, welche Abmessungen oder welches Seitenverhältnis die Bilder haben sollen
  • Informationen zu den möglichen Crop-Modes in Verbindung mit den Resize-Modes sind hieropen in new window einzusehen.

Optionen:

  • none
  • fill
  • lfill
  • fill_pad
  • crop
  • thumb

transformation resize mode

  • legt fest, wie und ob die Bilder zugeschnitten werden
  • Informationen zu den möglichen Crop-Modes in Verbindung mit den Resize-Modes sind hieropen in new window einzusehen.

Optionen:

  • none
  • scale
  • fit
  • limit
  • mfit
  • pad
  • lpad
  • mpad

transformation gravity mode

  • legt fest, welche Bild-Teile erhalten bleiben sollen, wenn ein Crop-Modus genutzt wird und der beizubehaltende Teil kleiner als das original sind
  • Informationen zu den möglichen Gravity-Modes in Verbindung mit den Crop-Modes sind hieropen in new window einzusehen.

Optionen:

  • none
  • auto
  • face
  • center
  • north_east
  • north
  • north_west
  • west
  • south_west
  • south
  • south_east
  • east

transformation custom properties

  • hier lasen sich die Parameter selbst zusammenstellen und individuell anpassen

  • es werden alle Transformations-Parameter unterstützt

  • legt fest, welche Bild-Teile erhalten bleiben sollen, wenn ein Crop-Modus genutzt wird und der beizubehaltende Teil kleiner als das Original sind

  • wenn dieser Parameter gesetzt wird, werden alle anderen Parameter ignoriert

  • Informationen zu den möglichen Parametern sind hieropen in new window einzusehen.

Beispiel:

Original Bild:

Beispiele:

c_crop,h_200,w_200

Das Bild wird auf eine Größe von 200px x 200px gebracht und der Überstand weg geschnitten.

b_black,c_pad,h_200,w_200

Das Bild wird auf eine Größe von 200px x 200px gebracht Hier wird aber das Bild auf die angegebene Breite skaliert und der entstandene Überstand mit schwarz aufgefüllt.

c_scale,h_200,w_200

Das Bild wird auf eine Grüße von 200px x 200px skaliert.

transformation target format

  • legt das Zielformat (anhand der Datei-Endung) fest

Optionen:

  • default (wie Original)
  • auto select
  • BMP
  • GIF
  • HEIF
  • JPEG
  • JPEG 2000
  • JPEG XR
  • PNG
  • SVG
  • TIFF
  • WebP

Outputs:

result

Spreadsheet mit den erfolgreich hochgeladenen Medien.

  • hier finden sich die asset_id's der Hochgeladenen Bilder
  • in der Spalte url wird die direkte URL zum hochgeladenen Bild geliefert (kann später in anderen Steps verwendet werden)

failed

Spreadsheet mit den Uploads die fehlgeschlagen sind.

In der Spalte error_message ist eine detaillierte Fehlerbeschreibung zu finden.

result filelist

Dateiliste mit den transformierten Bildern

Step: CloudinaryGetResources

Dieser Step läd eine Liste von Bildern in Ihren Cloudinary-Account. Es können verschiedene Filter angewendet werden.

Es können entweder public_ids ODER asset_ids ODER tags angegeben werden. Sind public_ids UND asset_ids gesetzt, werden die public_ids bevorzugt. Um nach tags zu filtern müssen public_ids UND asset_ids leer sein.

max_results

  • maximale Anzahl von Assets die geladen werden sollen (maximal 500)

public_ids

  • Komma separierte Liste mit public_ids (maximal 100)

asset_ids

  • Komma separierte Liste mit asset_ids

tags

  • Komma separierte Liste mit tags

Outputs:

result

Spreadsheet mit den erfolgreich hochgeladenen Medien.

  • hier finden sich die asset_id's der Hochgeladenen Bilder
  • in der Spalte url wird die direkte URL zum hochgeladenen Bild geliefert (kann später in anderen Steps verwendet werden)

assets

Dateiliste mit den geladenen Bildern

Step: CloudinarySearchResources

Dieser Step können die eigenen Assets nach diversen Parametern durchsucht und geladen werden.

expression

  • der Filterausdruck der Search-API

Die Filterausdrückeopen in new window können hier eingesehen werden.

max_results

  • maximale Anzahl von Assets die geladen werden sollen (maximal 500)

with_field

  • Komma-separierte Liste der Namen der zusätzlichen Attribute der Assets

Optionen:

  • context
  • tags

Zusätzlich bei einen erweiterten Cloudinary Account (Tier 2):

  • metadata
  • image_metadata
  • image_analysis

aggregate

  • nur für einen erweiterten (Tier 2) Account!
  • der Name eines Attribut-Feldes

Outputs:

result

Spreadsheet mit den erfolgreich hochgeladenen Medien.

  • hier finden sich die asset_id's der Hochgeladenen Bilder
  • in der Spalte url wird die direkte URL zum hochgeladenen Bild geliefert (kann später in anderen Steps verwendet werden)

assets

Dateiliste mit den geladenen Bildern

Step: CloudinaryCreateFolder

Dieser Step fügt Ihrem Cloudinary Speicher einen neuen Ordner hinzu.

path

  • neuer Ordner bzw. Pfad (Ordnerstruktur wird angelegt)

Step: CloudinaryListFolders

Dieser Step listet die Ordner Ihres Cloudinary Speichers.

folder

  • Basis-Ordner der aufgelistet werden soll
  • leer lassen um das ROOT Verzeichnis auszuwählen

Outputs:

folders

Spreadsheet mit den gefundenen Ordnern.

Step: CloudinaryGetUploadPresets

Dieser Step läd ein vorhandenes Upload-Preset und gibt die Einstellungen aus.

name

  • Name des Upload-Presets

Outputs:

settings spreadsheet

Spreadsheet mit den vorhandenen Einstellungen.

settings

Die Einstellungen im Key-Value Text-Format.

Step: CloudinaryUpdateUploadPreset

Dieser Step aktualisiert die einstellungen eines vorhandenen upload-Presets.

name

  • Name des Upload-Presets

settings

  • die Einstellungen im Key-Value Text-Format.

Mögliche Parameter sind in der Cloudinary Upload Referenzopen in new window zu finden.

Step: CloudinaryCreateUploadPreset

Dieser Step legt ein neues Upload-Presets an.

name

  • Name des neuen Upload-Presets

settings

  • die Einstellungen im Key-Value Text-Format.

Mögliche Parameter sind in der Cloudinary Upload Referenzopen in new window zu finden.

Step: CloudinaryListUploadPresets

Dieser Step legt ein neues Upload-Presets an.

Dieser Step hat keine weiteren Einstellmöglichkeiten da alle Presets ungefiltert geladen werden.

Outputs:

presets

Spreadsheet mit den gefundenen Presets und deren Einstellungen (im JSON-Format).

Steps im Cloudinary Add-On

Weitere Informationen

Impressum | Datenschutzhinweise
© Synesty GmbH, 2024 - No Code - Low Code Integration Platform - Schnittstellen & API-Anbindungen