zaraz_base-tool

APIs.ioEngineeringPlatform

Properties

Name Type Description
blockingTriggers array List of blocking trigger IDs
defaultFields object Default fields for tool's actions
defaultPurpose string Default consent purpose ID
enabled boolean Whether tool is enabled
name string Tool's name defined by the user
vendorName string Vendor name for TCF compliant consent modal, required for Custom Managed Components and Custom HTML tool with a defaultPurpose assigned
vendorPolicyUrl string Vendor's Privacy Policy URL for TCF compliant consent modal, required for Custom Managed Components and Custom HTML tool with a defaultPurpose assigned
View JSON Schema on GitHub

JSON Schema

apis-io-engineering-platform-zaraz-base-tool-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/zaraz_base-tool",
  "title": "zaraz_base-tool",
  "properties": {
    "blockingTriggers": {
      "description": "List of blocking trigger IDs",
      "items": {
        "type": "string"
      },
      "type": "array"
    },
    "defaultFields": {
      "additionalProperties": {
        "anyOf": [
          {
            "type": "string"
          },
          {
            "type": "boolean"
          }
        ]
      },
      "description": "Default fields for tool's actions",
      "type": "object"
    },
    "defaultPurpose": {
      "description": "Default consent purpose ID",
      "type": "string"
    },
    "enabled": {
      "description": "Whether tool is enabled",
      "type": "boolean"
    },
    "name": {
      "description": "Tool's name defined by the user",
      "type": "string"
    },
    "vendorName": {
      "description": "Vendor name for TCF compliant consent modal, required for Custom Managed Components and Custom HTML tool with a defaultPurpose assigned",
      "type": "string"
    },
    "vendorPolicyUrl": {
      "description": "Vendor's Privacy Policy URL for TCF compliant consent modal, required for Custom Managed Components and Custom HTML tool with a defaultPurpose assigned",
      "type": "string"
    }
  },
  "required": [
    "enabled",
    "blockingTriggers",
    "name",
    "defaultFields"
  ],
  "type": "object"
}