CreateCampaignRequest

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/kaminari-ad/json-schema/kaminari-ad-create-campaign-request-schema.json",
  "title": "CreateCampaignRequest",
  "description": "Request body to create a campaign.",
  "x-generated": "2026-11-13",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/kaminari-ad-openapi.json#/components/schemas/CreateCampaignRequest",
  "properties": {
    "name": {
      "type": "string",
      "maxLength": 200,
      "minLength": 1,
      "title": "Name"
    },
    "campaign_type": {
      "type": "string",
      "title": "Campaign Type",
      "default": "url"
    },
    "url": {
      "anyOf": [
        {
          "type": "string",
          "minLength": 1,
          "format": "uri"
        },
        {
          "type": "null"
        }
      ],
      "title": "Url"
    },
    "ad_tag": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Ad Tag",
      "description": "Ad tag to check: an HTML snippet OR an http(s) URL of a page with the creative already rendered. Required for ad_tag campaigns."
    },
    "vast_tag": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Vast Tag",
      "description": "VAST video tag: an http(s) URL of a VAST endpoint OR raw VAST XML. Required for vast campaigns."
    },
    "referrer": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 2048,
          "minLength": 1,
          "format": "uri"
        },
        {
          "type": "null"
        }
      ],
      "title": "Referrer",
      "description": "Optional http(s) page URL every scan of this campaign is checked from. For ad_tag and vast campaigns it is the page the tag is embedded in: the browser commits the harness document on this URL without fetching the publisher, so the creative is embedded exactly as it would be on that page. For url and ad_discovery campaigns it is where the visitor came from and travels as the Referer of the page request. Cross-origin subrequests receive the origin only (https://publisher.example/, no path) under Chromium's default strict-origin-when-cross-origin policy — same as on a real publisher. Must be a publicly routable host, carry no credentials, and stay within 2048 characters once normalised."
    },
    "ignore_first_n_domains": {
      "type": "integer",
      "maximum": 5.0,
      "minimum": 0.0,
      "title": "Ignore First N Domains",
      "description": "Skips detection and tagging on the first N unique domains of the redirect chain, counted from the entry point. Use it to exclude your own click/tracking domains so they don't trigger tags or alerts. Domains fold to their registrable form, so www.example.com and example.com count as one. Any other request to one of those domains is excluded too, wherever in the page it was made from. Default 0 (nothing skipped). Maximum 5.",
      "default": 0
    },
    "max_discovered_ads": {
      "anyOf": [
        {
          "type": "integer",
          "maximum": 25.0,
          "minimum": 1.0
        },
        {
          "type": "null"
        }
      ],
      "title": "Max Discovered Ads",
      "description": "How many ad blocks to look for on each publisher page before stopping. Each detected ad becomes its own scan with its own report, and is billed as a separate check. Only valid when campaign_type is 'ad_discovery'. Omit to use the platform default; on update, send null to go back to it. Maximum 25."
    },
    "ad_formats": {
      "anyOf": [
        {
          "items": {
            "$ref": "#/$defs/DiscoveryAdFormat"
          },
          "type": "array",
          "maxItems": 3,
          "minItems": 1
        },
        {
          "type": "null"
        }
      ],
      "title": "Ad Formats",
      "description": "Which ad formats each discovery run captures: banner, video and/or pop (pop covers both pop-unders and tab-unders), each at most once. A format left out is neither captured nor billed — e.g. ['pop'] checks the page's pops without screenshotting or clicking its banners; a tab-under the page forces on its own is still reported as a pop. Only valid when campaign_type is 'ad_discovery'. Omit to capture every format; on update, send null to go back to every format."
    },
    "country_codes": {
      "items": {
        "type": "string"
      },
      "type": "array",
      "minItems": 1,
      "title": "Country Codes"
    },
    "group_id": {
      "anyOf": [
        {
          "type": "string",
          "format": "uuid"
        },
        {
          "type": "null"
        }
      ],
      "title": "Group Id"
    },
    "emulator_categories": {
      "items": {
        "type": "string"
      },
      "type": "array",
      "title": "Emulator Categories"
    },
    "emulator_specific_ids": {
      "items": {
        "type": "string"
      },
      "type": "array",
      "title": "Emulator Specific Ids"
    },
    "emulator_mode": {
      "type": "string",
      "title": "Emulator Mode",
      "default": "random"
    },
    "proxy_type": {
      "type": "string",
      "title": "Proxy Type",
      "default": "residential"
    },
    "proxy_region": {
      "type": "string",
      "title": "Proxy Region",
      "default": ""
    },
    "proxy_city": {
      "type": "string",
      "title": "Proxy City",
      "default": ""
    },
    "proxy_isp": {
      "type": "string",
      "title": "Proxy Isp",
      "default": ""
    },
    "repeat_count": {
      "type": "integer",
      "minimum": 1.0,
      "title": "Repeat Count",
      "default": 1
    },
    "repeat_mode": {
      "$ref": "#/$defs/RepeatMode",
      "default": "isolated"
    },
    "retry_max_attempts": {
      "type": "integer",
      "minimum": 0.0,
      "title": "Retry Max Attempts",
      "default": 0
    },
    "labels": {
      "additionalProperties": {
        "type": "string"
      },
      "type": "object",
      "title": "Labels"
    },
    "policy_set_id": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Policy Set Id",
      "description": "Policy set to bind. Omit the field to use the organization's default policy set, or leave the campaign unbound if none is set. Send JSON null to create the campaign unbound so it does not generate alerts."
    },
    "schedule_type": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Schedule Type"
    },
    "schedule_weekly": {
      "anyOf": [
        {
          "additionalProperties": {
            "items": {
              "type": "integer"
            },
            "type": "array"
          },
          "type": "object"
        },
        {
          "type": "null"
        }
      ],
      "title": "Schedule Weekly"
    },
    "schedule_interval_seconds": {
      "anyOf": [
        {
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "title": "Schedule Interval Seconds"
    },
    "schedule_enabled": {
      "anyOf": [
        {
          "type": "boolean"
        },
        {
          "type": "null"
        }
      ],
      "title": "Schedule Enabled"
    },
    "schedule_timezone": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Schedule Timezone"
    },
    "notifications": {
      "anyOf": [
        {
          "$ref": "#/$defs/CampaignNotificationsRequest"
        },
        {
          "type": "null"
        }
      ],
      "description": "Alert-notification settings for the new campaign. Omit to inherit the organization's default destinations. Requires the alert_notifications.manage permission."
    }
  },
  "type": "object",
  "required": [
    "name",
    "country_codes"
  ],
  "$defs": {
    "CampaignNotificationsRequest": {
      "properties": {
        "mode": {
          "type": "string",
          "enum": [
            "inherit",
            "override",
            "silence"
          ],
          "title": "Mode",
          "description": "inherit: the organization's default destinations. override: only destination_ids. silence: no notifications."
        },
        "destination_ids": {
          "items": {
            "type": "string",
            "format": "uuid"
          },
          "type": "array",
          "title": "Destination Ids",
          "description": "Destinations for mode=override. Must be empty for other modes."
        },
        "routing_label_key": {
          "anyOf": [
            {
              "type": "string",
              "maxLength": 64
            },
            {
              "type": "null"
            }
          ],
          "title": "Routing Label Key",
          "description": "Route by this scan label key on top of inherit or override: destinations with a label rule on the key receive only scans whose label value matches. Not allowed with silence."
        }
      },
      "type": "object",
      "required": [
        "mode"
      ],
      "title": "CampaignNotificationsRequest",
      "description": "Where alerts of this campaign are sent, saved together with the campaign."
    },
    "DiscoveryAdFormat": {
      "type": "string",
      "enum": [
        "banner",
        "pop",
        "video"
      ],
      "title": "DiscoveryAdFormat",
      "description": "An ad format a discovery campaign captures.\n\n``banner`` and ``video`` are ad slots on the page; ``pop`` covers both\npop-unders and tab-unders."
    },
    "RepeatMode": {
      "type": "string",
      "enum": [
        "isolated",
        "shared"
      ],
      "title": "RepeatMode",
      "description": "How the repeats of one ``url x country x device`` relate to each other.\n\nValue-compatible with scanning's ``RepeatModeType`` — campaigns owns\nits own copy because the write side must not import another domain's\npackage (``check-imports``), and only the value crosses the boundary."
    }
  }
}