Skip to main content

CampaignDto

An advertising campaign belonging to a network.

idstring

Unique identifier of the campaign

Example: 7Hb2Kp9QvL3mNx0R8tZ4
network_idstring

Identifier of the network that owns the campaign

Example: 9Fc4Lm2RtN6pQx1S7wZ3
created_atdate-time

Timestamp when the campaign was created

Example: 2026-01-15T09:30:00Z
updated_atdate-time

Timestamp when the campaign was last updated

Example: 2026-01-15T09:30:00Z
platformstring

Ad-serving platform the campaign targets

Possible values: [adbridge, adswizz, megaphone]

Example: adswizz
adswizz objectnullable

Link to the campaign in Adswizz; present only when platform is adswizz

campaign_idstring

Identifier of the linked campaign in Adswizz

Example: az_8421907
advertiser_idstringnullable

Identifier of the advertiser this campaign runs for, if assigned

Example: 3Kd7Np5RvM9qWx2T8yZ6
advertiser objectnullable

The campaign's advertiser; present only when ?expand=advertiser was requested.

idstring

Unique identifier of the advertiser

Example: 3Kd7Np5RvM9qWx2T8yZ6
namestring

Name of the advertiser

Example: Acme Corp
namestring

Human-readable name of the campaign

Example: Spring Launch 2026
brand_namestring

Brand being advertised in the campaign

Example: Acme Corp
product_namestring

Product being advertised in the campaign

Example: Acme Pro Headphones
product_categorystring

Category the advertised product belongs to

Example: Consumer Electronics
start_datedate-timenullable

Date the campaign is scheduled to start running

Example: 2026-01-15T09:30:00Z
end_datedate-timenullable

Date the campaign is scheduled to stop running

Example: 2026-03-15T09:30:00Z
budgetdoublenullable

Total campaign budget in US dollars

Example: 50000
cpmdoublenullable

Cost per thousand impressions (CPM) in US dollars

Example: 25
categoriesstring[]

Content categories the campaign is eligible to run against

ad_variants object[]

Ad variants (copy and configuration) defined for the campaign

  • Array [
    • idstring

    Unique identifier of the ad-copy variant.

    Example: 2Bx6Rk9LtN5mZq8Wv4G
    namestring

    Human-readable name of the variant.

    Example: Holiday promo
    ad_copystring

    The ad copy text for this variant.

    Example: This episode is brought to you by Acme...
  • ]
    • excluded_podcast_idsstring[]

    Identifiers of podcasts explicitly excluded from this campaign

    targeting objectnullable

    Free-form targeting parameters for the campaign (e.g. geo). Structure is open and platform-defined.

    property name*object
    tracking objectnullable

    Free-form tracking configuration for the campaign (e.g. a tracking pixel). Structure is open and platform-defined.

    property name*object
    targeting_csv objectnullable

    CSV file listing the campaign's targeting, if uploaded

    filenamestring

    Original filename of the uploaded CSV

    Example: spring-targets.csv
    urlstring

    URL where the stored CSV can be downloaded

    Example: https://cdn.example.com/campaigns/7Hb2Kp9QvL3mNx0R8tZ4/targets.csv
    sizeint64

    Size of the CSV file in bytes

    Example: 2048
    uploaded_atstring

    Timestamp when the CSV was uploaded (ISO-8601)

    Example: 2026-01-15T09:30:00Z
    tracking_csv objectnullable

    CSV file listing the campaign's tracking, if uploaded

    filenamestring

    Original filename of the uploaded CSV

    Example: spring-targets.csv
    urlstring

    URL where the stored CSV can be downloaded

    Example: https://cdn.example.com/campaigns/7Hb2Kp9QvL3mNx0R8tZ4/targets.csv
    sizeint64

    Size of the CSV file in bytes

    Example: 2048
    uploaded_atstring

    Timestamp when the CSV was uploaded (ISO-8601)

    Example: 2026-01-15T09:30:00Z
    statusstring

    Campaign lifecycle status

    Possible values: [pending, active, completed, cancelled, archived]

    CampaignDto
    {
      "id": "7Hb2Kp9QvL3mNx0R8tZ4",
      "network_id": "9Fc4Lm2RtN6pQx1S7wZ3",
      "created_at": "2026-01-15T09:30:00Z",
      "updated_at": "2026-01-15T09:30:00Z",
      "platform": "adswizz",
      "adswizz": {
        "campaign_id": "az_8421907"
      },
      "advertiser_id": "3Kd7Np5RvM9qWx2T8yZ6",
      "advertiser": {
        "id": "3Kd7Np5RvM9qWx2T8yZ6",
        "name": "Acme Corp"
      },
      "name": "Spring Launch 2026",
      "brand_name": "Acme Corp",
      "product_name": "Acme Pro Headphones",
      "product_category": "Consumer Electronics",
      "start_date": "2026-01-15T09:30:00Z",
      "end_date": "2026-03-15T09:30:00Z",
      "budget": 50000,
      "cpm": 25,
      "categories": [
        "string"
      ],
      "ad_variants": [
        {
          "id": "2Bx6Rk9LtN5mZq8Wv4G",
          "name": "Holiday promo",
          "ad_copy": "This episode is brought to you by Acme..."
        }
      ],
      "excluded_podcast_ids": [
        "string"
      ],
      "targeting": {},
      "tracking": {},
      "targeting_csv": {
        "filename": "spring-targets.csv",
        "url": "https://cdn.example.com/campaigns/7Hb2Kp9QvL3mNx0R8tZ4/targets.csv",
        "size": 2048,
        "uploaded_at": "2026-01-15T09:30:00Z"
      },
      "tracking_csv": {
        "filename": "spring-targets.csv",
        "url": "https://cdn.example.com/campaigns/7Hb2Kp9QvL3mNx0R8tZ4/targets.csv",
        "size": 2048,
        "uploaded_at": "2026-01-15T09:30:00Z"
      },
      "status": "pending"
    }