5 min read

Source: Roblox Creator Hub · CC BY 4.0 · View source · Code samples: MIT Imported 2026-10-03. Formatting adapted for this site.

Roblox.AdConfiguration.Api.SponsoredCampaignModel — openapi

A response model represents an Ad with complete information, including infos from its associated campaign and ad set

Properties

Complete Schema

{
  "description": "A response model represents an Ad with complete information, including infos from its associated campaign and ad set",
  "type": "object",
  "properties": {
    "adId": {
      "format": "int64",
      "description": "The id of the ad",
      "type": "integer"
    },
    "adSetId": {
      "format": "int64",
      "description": "The id of the ad set",
      "type": "integer"
    },
    "adName": {
      "description": "The name of the Ad",
      "type": "string"
    },
    "adStatus": {
      "format": "int32",
      "description": "The status of the ad ['Undefined' = 0, 'Draft' = 1, 'PendingApproval' = 2, 'Approved' = 3, 'Moderated' = 4]",
      "enum": [
        0,
        1,
        2,
        3,
        4
      ],
      "type": "integer"
    },
    "creativeType": {
      "format": "int32",
      "description": "The type of the creative associated with the Ad ['Undefined' = 0, 'Image' = 1, 'Video' = 2]",
      "enum": [
        0,
        1,
        2
      ],
      "type": "integer"
    },
    "creativeTargetId": {
      "format": "int64",
      "description": "The target id of the creative associated with the Ad",
      "type": "integer"
    },
    "bidAmountInRobux": {
      "format": "int64",
      "description": "The bid amount of the Ad in Robux",
      "type": "integer"
    },
    "budgetInRobux": {
      "format": "int64",
      "description": "The budget of the ad set in Robux",
      "type": "integer"
    },
    "adSetStatus": {
      "format": "int32",
      "description": "The status of the ad set ['Undefined' = 0, 'Draft' = 1, 'Scheduled' = 2, 'Running' = 3, 'Paused' = 4, 'Stopped' = 5, 'Completed' = 6]",
      "enum": [
        0,
        1,
        2,
        3,
        4,
        5,
        6
      ],
      "type": "integer"
    },
    "startDate": {
      "format": "date-time",
      "description": "The start date of the ad set",
      "type": "string"
    },
    "endDate": {
      "format": "date-time",
      "description": "The end date of the ad set",
      "type": "string"
    },
    "targetGender": {
      "format": "int32",
      "description": "The target gender of the ad set ['Undefined' = 1, 'Male' = 2, 'Female' = 4]",
      "enum": [
        1,
        2,
        4
      ],
      "type": "integer"
    },
    "targetAgeBracket": {
      "format": "int32",
      "description": "The target age bracket of the ad set ['Undefined' = 1, 'AgeUnder13' = 2, 'Age13OrOver' = 4, 'Age13To16' = 8, 'Age17OrOver' = 16]",
      "enum": [
        1,
        2,
        4,
        8,
        16
      ],
      "type": "integer"
    },
    "targetDeviceType": {
      "format": "int32",
      "description": "The target device type of the ad set ['Undefined' = 1, 'Computer' = 2, 'Phone' = 4, 'Tablet' = 8, 'Console' = 16, 'VR' = 32]",
      "enum": [
        1,
        2,
        4,
        8,
        16,
        32
      ],
      "type": "integer"
    },
    "campaignTargetType": {
      "format": "int32",
      "description": "The target type of the campaign ['Undefined' = 0, 'Universe' = 1, 'Asset' = 2, 'ImmersiveAd' = 3]",
      "enum": [
        0,
        1,
        2,
        3
      ],
      "type": "integer"
    },
    "campaignTargetId": {
      "format": "int64",
      "description": "The target id of the campaign",
      "type": "integer"
    },
    "totalSpendInRobux": {
      "format": "int64",
      "description": "The total spend of the ad set in Robux",
      "type": "integer"
    },
    "totalImpressions": {
      "format": "int64",
      "description": "The total number of impressions generated by the ad",
      "type": "integer"
    },
    "totalClicks": {
      "format": "int64",
      "description": "The total number of clicks generated by the ad",
      "type": "integer"
    },
    "totalConversions": {
      "format": "int64",
      "description": "The total number of conversions generated by the ad",
      "type": "integer"
    },
    "impressionConversions": {
      "format": "int64",
      "description": "The number of conversions by ad impression generated by the ad",
      "type": "integer"
    },
    "clickConversions": {
      "format": "int64",
      "description": "The number of conversions by ad click generated by the ad",
      "type": "integer"
    }
  },
  "additionalProperties": false
}