Presets
Using presets, you can preconfigure plugin instances so that your team using the UI only has to fill in the fields that are relevant to them.
For instance, you can make a Google DDP connector feed preset and hard set your Google company identifier and the Google platform you are using, so that marketing type users in your organisation only have to fill in the Google segment code to feed each time they want to create a new feed.
Though theorically available for all types of plugins, presets are mostly useful for feeds as they will appear in the UI.
You need to have the
ORGANISATION_ADMIN
role to create a preset on an organisation
Create a preset
POST
https://api.mediarithmics.com/v1/plugins/:plugin_id/versions/:version_id/presets
Path Parameters
Name | Type | Description |
---|---|---|
version_id | string | The ID of the plugin version. |
plugin_id | integer | The ID of the plugin. |
Request Body
Name | Type | Description |
---|---|---|
properties | array | An array of the properties as defined with the plugin version. Values can be overriden to provide a default, not editable value. See Property type objects. |
plugin_type | string | The plugin type. For feeds, use |
organisation_id | string | The ID for the organisation. |
description | string | Description for the preset. |
name | string | Name for the preset. |
Get presets
GET
https://api.mediarithmics.com/v1/plugins.versions.presets
Query Parameters
Name | Type | Description |
---|---|---|
organisation_id | string | The ID of the organisation. |
plugin_type | string | Enum
|
Last updated