3 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.Models.CreateSponsoredCampaignRequest — openapi

A request model for creating a sponsored game

Properties

NameTypeRequiredDescription
campaignTargetIdintegerfalseThe ID of the campaign target
campaignTargetTypeintegerfalseThe type of the campaign target ['Undefined' = 0, 'Universe' = 1, 'Asset' = 2, 'ImmersiveAd' = 3]
targetGenderintegerfalseTargeting gender(s) of the ad set ['Undefined' = 1, 'Male' = 2, 'Female' = 4]
targetAgeBracketintegerfalseTargeting age bracket(s) of the ad set ['Undefined' = 1, 'AgeUnder13' = 2, 'Age13OrOver' = 4, 'Age13To16' = 8, 'Age17OrOver' = 16]
startDatestringfalseThe start date of the ad set
endDatestringfalseThe end date of the ad set
targetDeviceTypeintegerfalseTargeting device type(s) of the ad set ['Undefined' = 1, 'Computer' = 2, 'Phone' = 4, 'Tablet' = 8, 'Console' = 16, 'VR' = 32]
campaignNamestringfalseThe name of the Campaign / Ad
dailyBidAmountInRobuxintegerfalseThe daily bid amount for the campaign / ad, in Robux
placementLocationintegerfalseThe location to place the campaign ['Undefined' = 1, 'GameSort' = 2, 'AvatarShop' = 4, 'ItemDetails' = 8, 'HomePage' = 16, 'Billboard300x250' = 32, 'Billboard600x300' = 64, 'Billboard300x600' = 128]
creativeModel#/components/schemas/Roblox.AdConfiguration.Api.CreativeModelfalse

Complete Schema

{
  "description": "A request model for creating a sponsored game",
  "type": "object",
  "properties": {
    "campaignTargetId": {
      "format": "int64",
      "description": "The ID of the campaign target",
      "type": "integer",
      "example": 1
    },
    "campaignTargetType": {
      "format": "int32",
      "description": "The type of the campaign target ['Undefined' = 0, 'Universe' = 1, 'Asset' = 2, 'ImmersiveAd' = 3]",
      "enum": [
        0,
        1,
        2,
        3
      ],
      "type": "integer",
      "example": 2
    },
    "targetGender": {
      "format": "int32",
      "description": "Targeting gender(s) of the ad set ['Undefined' = 1, 'Male' = 2, 'Female' = 4]",
      "enum": [
        1,
        2,
        4
      ],
      "type": "integer",
      "example": 4
    },
    "targetAgeBracket": {
      "format": "int32",
      "description": "Targeting age bracket(s) of the ad set ['Undefined' = 1, 'AgeUnder13' = 2, 'Age13OrOver' = 4, 'Age13To16' = 8, 'Age17OrOver' = 16]",
      "enum": [
        1,
        2,
        4,
        8,
        16
      ],
      "type": "integer",
      "example": 4
    },
    "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"
    },
    "targetDeviceType": {
      "format": "int32",
      "description": "Targeting device type(s) 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",
      "example": 2
    },
    "campaignName": {
      "description": "The name of the Campaign / Ad",
      "type": "string"
    },
    "dailyBidAmountInRobux": {
      "format": "int64",
      "description": "The daily bid amount for the campaign / ad, in Robux",
      "type": "integer",
      "example": 101
    },
    "placementLocation": {
      "format": "int32",
      "description": "The location to place the campaign ['Undefined' = 1, 'GameSort' = 2, 'AvatarShop' = 4, 'ItemDetails' = 8, 'HomePage' = 16, 'Billboard300x250' = 32, 'Billboard600x300' = 64, 'Billboard300x600' = 128]",
      "enum": [
        1,
        2,
        4,
        8,
        16,
        32,
        64,
        128
      ],
      "type": "integer",
      "example": 4
    },
    "creativeModel": {
      "$ref": "#/components/schemas/Roblox.AdConfiguration.Api.CreativeModel"
    }
  },
  "additionalProperties": false
}