---
name: "Advertising"
last_updated: 2026-11-18T23:17:02Z
type: feature
api_base_url: "https://apis.roblox.com"
endpoints: 37
auth: [api-key, oauth2, cookie]
description: "Create and manage advertising on Roblox"
---

# Advertising

Create and manage advertising on Roblox. [Estimate campaign audiences](#CreateAudienceEstimate), [performance](#CreatePerformanceEstimate), and [recommendations](#CreateCampaignRecommendation), then [validate campaign settings](#ValidateCampaign). [Create](#CreateCreative), [retrieve](#GetCreative), and [update](#UpdateCreative) creatives, and [list](#ListCampaignAds), [retrieve](#GetCampaignAd), and [update](#UpdateCampaignAd) ads in a campaign. Experience advertising drives engagement to your experiences through the Ads API, and item advertising promotes Marketplace items through sponsored campaigns. See the [Advertising guide](https://create.roblox.com/docs/cloud/guides/advertising) for Open Cloud setup and usage.

> **Getting started:** See [Advertising with the Ads API](/docs/en-us/cloud/guides/advertising.md) for a complete walkthrough with working examples.

**Base URL:** `https://apis.roblox.com`

    ## Authentication

    Each endpoint requires one of the following authentication methods:

    - **API Key**: Pass your key in the `x-api-key` HTTP header. Create keys at [Creator Dashboard](https://create.roblox.com/dashboard/credentials).
- **OAuth 2.0**: Use Bearer token in the `Authorization` header. Authorization URL: `https://apis.roblox.com/oauth/v1/authorize`, Token URL: `https://apis.roblox.com/oauth/v1/token`
- **Cookie** *(not recommended)*: `.ROBLOSECURITY` cookie. Do not use in production.

    ```
    # API Key example
    curl -H "x-api-key: YOUR_API_KEY" https://apis.roblox.com/...

    # OAuth 2.0 example
    curl -H "Authorization: Bearer YOUR_ACCESS_TOKEN" https://apis.roblox.com/...
    ```

## Endpoints

### GET `/ads-management/v1/advertisable-universes` [BETA]

List advertisable universes

Returns the universe IDs of every experience the billing account is eligible to advertise. The complete list is returned in a single response; this endpoint is not paginated. Use these IDs to set targetUniverseId when creating a campaign, and resolve experience names with the Open Cloud Universe API. With groupId, the list is limited to experiences owned by that group.

**Auth:** Cookie (`.ROBLOSECURITY`) or API Key (`x-api-key` header) or OAuth 2.0 Bearer token

**Scopes:** `ad.campaign:read`

**Parameters:**

| Name | In | Type | Required | Description |
|------|-----|------|----------|-------------|
| `groupId` | query | `string` | No | Use the group's advertising context instead of the caller's personal one. groupId selects the group ads account; absent groupId selects the personal ads account |

**Responses:**

- `200`: OK → `ListAdvertisableUniversesResponse`
- `400`: Invalid groupId → `ErrorEnvelope`
- `403`: Permission denied → `ErrorEnvelope`
- `429`: Rate limit exceeded → `ErrorEnvelope`
- `500`: Internal server error → `ErrorEnvelope`

**Response fields** (`ListAdvertisableUniversesResponse`)

See [ListAdvertisableUniversesResponse](#listadvertisableuniversesresponse) in Models.

**Response example:**
```json
{
  "advertisableUniverses": [
    {
      "universeId": "..."
    }
  ]
}
```

**Error handling:** `429`: Retry with exponential backoff (start at 1s). `403`: Verify your API key has the required scopes listed above. 

**Rate Limits:** perApiKeyOwner: 120/minute, perOauth2Authorization: 120/minute

**Example:**
```bash
curl -H "x-api-key: $ROBLOX_API_KEY" \
  "https://apis.roblox.com/ads-management/v1/advertisable-universes"
```

### POST `/ads-management/v1/audience-estimates` [EXPERIMENTAL]

Estimate the addressable audience

Returns a non-binding range of users reachable with the proposed targeting. campaignContext has the same shape as performance estimates, but accepts every creatable objective (PLAYS, ENGAGEMENT, ROBUX_SPEND). targeting accepts the same values and combinations as CreateCampaign, including regions.

**Auth:** Cookie (`.ROBLOSECURITY`) or API Key (`x-api-key` header) or OAuth 2.0 Bearer token

**Scopes:** `ad.campaign:read`

**Request Body:** `application/json` — Type: `AudienceEstimateRequest`

See [AudienceEstimateRequest](#audienceestimaterequest) in Models.

**Request example:**
```json
{
  "campaignContext": {
    "objective": "PLAYS",
    "targetUniverseId": "string",
    "targeting": {
      "ageGroups": "...",
      "audienceType": "...",
      "countries": "...",
      "devices": "...",
      "regions": "..."
    }
  }
}
```

**Responses:**

- `200`: OK → `AudienceEstimateResponse`
- `400`: Invalid request → `ErrorEnvelope`
- `403`: Permission denied → `ErrorEnvelope`
- `429`: Rate limit exceeded → `ErrorEnvelope`
- `500`: Internal server error → `ErrorEnvelope`

**Response fields** (`AudienceEstimateResponse`)

See [AudienceEstimateResponse](#audienceestimateresponse) in Models.

**Response example:**
```json
{
  "lowerBound": 0,
  "upperBound": 0
}
```

**Error handling:** `429`: Retry with exponential backoff (start at 1s). `403`: Verify your API key has the required scopes listed above. 

**Rate Limits:** perApiKeyOwner: 60/minute, perOauth2Authorization: 60/minute

**Example:**
```bash
curl -X POST -H "x-api-key: $ROBLOX_API_KEY" \
  "https://apis.roblox.com/ads-management/v1/audience-estimates" \
  -H "Content-Type: application/json" \
  -d '{
  "campaignContext": {
    "objective": "PLAYS",
    "targetUniverseId": "string",
    "targeting": {
      "ageGroups": "...",
      "audienceType": "...",
      "countries": "...",
      "devices": "...",
      "regions": "..."
    }
  }
}'
```

### GET `/ads-management/v1/billing-accounts` [BETA]

List billing accounts

Lists the billing accounts owned by the authenticated user, or by the group in groupId. Each account includes its type, status, time zone, create/update timestamps, creator, and funding state (paymentStatus, supportedPaymentTypes, balances, paymentMethods). Group accounts support only ADS_CREDIT. Funding state belongs to the account, not to any experience, so this response alone answers whether each account can pay for campaigns; GET /campaign-options with universeId only narrows which of these accounts a campaign for that experience can use. Results are paginated with a cursor (pageToken).

**Auth:** Cookie (`.ROBLOSECURITY`) or API Key (`x-api-key` header)

**Scopes:** `ad.billing:read`

**Parameters:**

| Name | In | Type | Required | Description |
|------|-----|------|----------|-------------|
| `groupId` | query | `string` | No | Group ID whose billing accounts to list. groupId selects the group ads account; absent groupId selects the personal ads account |
| `maxPageSize` | query | `integer` | No | Maximum results per page (1-100, default 50) |
| `pageToken` | query | `string` | No | Opaque cursor from a prior nextPageToken |

**Responses:**

- `200`: OK → `ListBillingAccountsResponse`
- `400`: Invalid groupId, maxPageSize, or pageToken → `ErrorEnvelope`
- `403`: Permission denied → `ErrorEnvelope`
- `429`: Rate limit exceeded → `ErrorEnvelope`
- `500`: Internal server error → `ErrorEnvelope`

**Response fields** (`ListBillingAccountsResponse`)

See [ListBillingAccountsResponse](#listbillingaccountsresponse) in Models.

**Response example:**
```json
{
  "billingAccounts": [
    {
      "adCreditBalanceMicros": "...",
      "createTime": "...",
      "creator": "...",
      "displayName": "...",
      "failedPaymentBalanceMicros": "...",
      "id": "..."
    }
  ],
  "nextPageToken": "string"
}
```

**Error handling:** `429`: Retry with exponential backoff (start at 1s). `403`: Verify your API key has the required scopes listed above. 

**Rate Limits:** perApiKeyOwner: 120/minute

**Example:**
```bash
curl -H "x-api-key: $ROBLOX_API_KEY" \
  "https://apis.roblox.com/ads-management/v1/billing-accounts"
```

### GET `/ads-management/v1/billing-accounts/{id}` [BETA]

Get a billing account

Returns a single billing account accessible to the authenticated user (including group accounts where the caller has group advertising permission). Includes masked card details, verification state, and a payment-status reason when the account is not ready. Returns 404 if the account does not exist or is not accessible to the caller.

**Auth:** Cookie (`.ROBLOSECURITY`) or API Key (`x-api-key` header)

**Scopes:** `ad.billing:read`

**Parameters:**

| Name | In | Type | Required | Description |
|------|-----|------|----------|-------------|
| `id` | path | `string` | Yes | Billing account ID |

**Responses:**

- `200`: OK → `BillingAccount`
- `403`: Permission denied → `ErrorEnvelope`
- `404`: Billing account not found → `ErrorEnvelope`
- `429`: Rate limit exceeded → `ErrorEnvelope`
- `500`: Internal server error → `ErrorEnvelope`

**Response fields** (`BillingAccount`)

See [BillingAccount](#billingaccount) in Models.

**Response example:**
```json
{
  "adCreditBalanceMicros": "string",
  "createTime": "2024-01-01T00:00:00Z",
  "creator": {
    "groupId": "string",
    "userId": "string"
  },
  "displayName": "string",
  "failedPaymentBalanceMicros": "string",
  "id": "string"
}
```

**Error handling:** `429`: Retry with exponential backoff (start at 1s). `403`: Verify your API key has the required scopes listed above. 

**Rate Limits:** perApiKeyOwner: 120/minute

**Example:**
```bash
curl -H "x-api-key: $ROBLOX_API_KEY" \
  "https://apis.roblox.com/ads-management/v1/billing-accounts/{ID}"
```

### POST `/ads-management/v1/billing-accounts/{id}/ad-credit-conversions:preview` [EXPERIMENTAL]

Preview a Robux-to-ad-credit conversion

Calculates the other side of a conversion from either a Robux amount or an ad credit amount, using the account's current Robux balances and rates. An amount the account cannot afford or outside the allowed range returns 200 with valid=false and a reason.

**Auth:** Cookie (`.ROBLOSECURITY`) or API Key (`x-api-key` header)

**Scopes:** `ad.billing:read`

**Parameters:**

| Name | In | Type | Required | Description |
|------|-----|------|----------|-------------|
| `id` | path | `string` | Yes | Billing account ID |

**Request Body:** `application/json` — Type: `PreviewAdCreditConversionRequest`

See [PreviewAdCreditConversionRequest](#previewadcreditconversionrequest) in Models.

**Request example:**
```json
{
  "adCreditAmountMicros": "string",
  "robuxAmount": "string"
}
```

**Responses:**

- `200`: OK → `AdCreditConversionPreview`
- `400`: Validation error → `ErrorEnvelope`
- `403`: Permission denied → `ErrorEnvelope`
- `404`: Billing account not found → `ErrorEnvelope`
- `429`: Rate limit exceeded → `ErrorEnvelope`
- `500`: Internal server error → `ErrorEnvelope`

**Response fields** (`AdCreditConversionPreview`)

See [AdCreditConversionPreview](#adcreditconversionpreview) in Models.

**Response example:**
```json
{
  "adCreditAmountMicros": "string",
  "effectiveO18Robux": "string",
  "effectiveStandardRobux": "string",
  "reason": {
    "code": "string",
    "message": "string",
    "remediation": "string",
    "resource": "string"
  },
  "robuxAmount": "string",
  "tierBreakdown": [
    {
      "adCreditAmountMicros": "...",
      "adCreditPerRobux": "...",
      "robuxAmount": "...",
      "tier": "..."
    }
  ]
}
```

**Error handling:** `429`: Retry with exponential backoff (start at 1s). `403`: Verify your API key has the required scopes listed above. 

**Rate Limits:** perApiKeyOwner: 60/minute

**Example:**
```bash
curl -X POST -H "x-api-key: $ROBLOX_API_KEY" \
  "https://apis.roblox.com/ads-management/v1/billing-accounts/{ID}/ad-credit-conversions:preview" \
  -H "Content-Type: application/json" \
  -d '{
  "adCreditAmountMicros": "string",
  "robuxAmount": "string"
}'
```

### GET `/ads-management/v1/billing-accounts/{id}/payment-activities` [EXPERIMENTAL]

List scoped payment activity

Lists one ledger, newest first. AD_CREDIT includes the source transaction type and initiator when available. CARD charge rows include the latest associated card settlement time when available. CARD requires type=CHARGE or type=REFUND. CHARGE and AD_CREDIT use cursor pagination; filtered pages can be short or empty and still have a nextPageToken. REFUND requires startTime (inclusive) and endTime (exclusive), returns complete results without pagination, and rejects ranges containing more than 100 refund requests, including non-card requests. Requests without payment details are retained; known non-card payments are excluded.

**Auth:** Cookie (`.ROBLOSECURITY`) or API Key (`x-api-key` header)

**Scopes:** `ad.billing:read`

**Parameters:**

| Name | In | Type | Required | Description |
|------|-----|------|----------|-------------|
| `id` | path | `string` | Yes | Billing account ID |
| `ledger` | query | `CARD \| AD_CREDIT` | Yes | Payment activity ledger (CARD or AD_CREDIT) Valid values: `CARD`, `AD_CREDIT` |
| `type` | query | `CHARGE \| REFUND` | No | Required for CARD: CHARGE or REFUND. Unsupported for AD_CREDIT. Valid values: `CHARGE`, `REFUND` |
| `startTime` | query | `string` | No | Required for REFUND: inclusive RFC 3339 request time. Unsupported for other scopes. |
| `endTime` | query | `string` | No | Required for REFUND: exclusive RFC 3339 request time, after startTime. Unsupported for other scopes. |
| `maxPageSize` | query | `integer` | No | CHARGE and AD_CREDIT only: maximum records per page (1-100, default 50) |
| `pageToken` | query | `string` | No | CHARGE and AD_CREDIT only: opaque cursor from a prior nextPageToken |

**Responses:**

- `200`: OK → `ListPaymentActivitiesResponse`
- `400`: Invalid scope, pagination, or time range; REFUND_WINDOW_TOO_LARGE requires a narrower range → `ErrorEnvelope`
- `403`: Permission denied → `ErrorEnvelope`
- `404`: Billing account not found → `ErrorEnvelope`
- `429`: Rate limit exceeded → `ErrorEnvelope`
- `500`: Internal server error → `ErrorEnvelope`

**Response fields** (`ListPaymentActivitiesResponse`)

See [ListPaymentActivitiesResponse](#listpaymentactivitiesresponse) in Models.

**Response example:**
```json
{
  "activities": [
    {
      "actorUserId": "...",
      "adCreditTransactionType": "...",
      "amountMicros": "...",
      "campaignId": "...",
      "campaignName": "...",
      "cardLastFourDigits": "..."
    }
  ],
  "nextPageToken": "string"
}
```

**Error handling:** `429`: Retry with exponential backoff (start at 1s). `403`: Verify your API key has the required scopes listed above. 

**Rate Limits:** perApiKeyOwner: 120/minute

**Example:**
```bash
curl -H "x-api-key: $ROBLOX_API_KEY" \
  "https://apis.roblox.com/ads-management/v1/billing-accounts/{ID}/payment-activities?ledger={VALUE}"
```

### GET `/ads-management/v1/campaign-options` [BETA]

Get campaign options

Returns the values accepted when creating a campaign: supported objectives, payment types, ad formats, and targeting dimensions. Call this before CreateCampaign. When universeId is supplied, the response also includes an eligibility block indicating whether that experience can currently be advertised, along with the reasons when it cannot. universeId is optional; without it, account-level options are returned without eligibility or billing-account resolution, and paymentTypes is a static menu that does not check payment setup. A caller without permission to advertise the supplied experience gets 403 with reason UNIVERSE_NOT_ADVERTISABLE. It works without a billing account and lists in billingAccounts the accounts you can create a campaign for the experience in, each with the payment types it can use now: CREDIT_CARD only for your own account with a verified card, ADS_CREDIT only with activated ad credit of at least the minimum daily budget, and only ADS_CREDIT for a group's account. paymentTypes is then the payment types at least one of those accounts can use, and is empty when there are none. Each account also has paymentStatus, paymentStatusReason, and paymentSetupUrl. Create also checks that the ad credit balance covers the daily budget. Sponsored video tiles follow the billing account's owner: video is present when the request's account or at least one listed billing account allows video, and mutableFields lists video only when a campaign's video can be changed.

**Auth:** Cookie (`.ROBLOSECURITY`) or API Key (`x-api-key` header) or OAuth 2.0 Bearer token

**Scopes:** `ad.campaign:read`

**Parameters:**

| Name | In | Type | Required | Description |
|------|-----|------|----------|-------------|
| `universeId` | query | `string` | No | Universe ID to check eligibility for |
| `objective` | query | `PLAYS \| ENGAGEMENT \| ROBUX_SPEND` | No | Objective filter (PLAYS, ENGAGEMENT, or ROBUX_SPEND) Valid values: `PLAYS`, `ENGAGEMENT`, `ROBUX_SPEND` |

**Responses:**

- `200`: OK → `CampaignOptionsResponse`
- `400`: Invalid objective or universeId → `ErrorEnvelope`
- `403`: Permission denied, or the caller can't advertise the experience → `ErrorEnvelope`
- `429`: Rate limit exceeded → `ErrorEnvelope`
- `500`: Internal server error → `ErrorEnvelope`

**Response fields** (`CampaignOptionsResponse`)

See [CampaignOptionsResponse](#campaignoptionsresponse) in Models.

**Response example:**
```json
{
  "adFormats": [
    {
      "format": "...",
      "height": "...",
      "width": "..."
    }
  ],
  "billingAccounts": [
    {
      "creator": "...",
      "displayName": "...",
      "id": "...",
      "maximumDailyBudgetMicros": "...",
      "paymentSetupUrl": "...",
      "paymentStatus": "..."
    }
  ],
  "budgetConstraints": [
    {
      "budgetType": "...",
      "maximumAmountMicros": "...",
      "maximumDurationInDays": "...",
      "minimumAmountMicros": "..."
    }
  ],
  "creativeRequirements": {
    "acceptedAssetTypes": [
      "..."
    ],
    "maximumCount": 0,
    "minimumCount": 0
  },
  "eligibility": {
    "details": [
      "..."
    ],
    "eligible": false,
    "reasons": [
      "..."
    ],
    "universeId": "string"
  },
  "mutableFields": [
    "string"
  ]
}
```

**Error handling:** `429`: Retry with exponential backoff (start at 1s). `403`: Verify your API key has the required scopes listed above. 

**Rate Limits:** perApiKeyOwner: 120/minute, perOauth2Authorization: 120/minute

**Example:**
```bash
curl -H "x-api-key: $ROBLOX_API_KEY" \
  "https://apis.roblox.com/ads-management/v1/campaign-options"
```

### POST `/ads-management/v1/campaign-recommendations` [EXPERIMENTAL]

Recommend budget and duration

Returns non-binding daily budget and duration suggestions for the proposed campaign. campaignContext accepts every creatable objective (PLAYS, ENGAGEMENT, ROBUX_SPEND). targetUniverseId and targeting.audienceType influence the result; RETENTION and REACTIVATION get budget recommendations for that audience. targeting accepts only audienceType: ageGroups, countries, regions, and devices return 400 with reason UNSUPPORTED_VALUE.

**Auth:** Cookie (`.ROBLOSECURITY`) or API Key (`x-api-key` header) or OAuth 2.0 Bearer token

**Scopes:** `ad.campaign:read`

**Request Body:** `application/json` — Type: `CampaignRecommendationRequest`

See [CampaignRecommendationRequest](#campaignrecommendationrequest) in Models.

**Request example:**
```json
{
  "campaignContext": {
    "objective": "PLAYS",
    "targetUniverseId": "string",
    "targeting": {
      "ageGroups": "...",
      "audienceType": "...",
      "countries": "...",
      "devices": "...",
      "regions": "..."
    }
  }
}
```

**Responses:**

- `200`: OK → `CampaignRecommendationResponse`
- `400`: Invalid request → `ErrorEnvelope`
- `403`: Permission denied → `ErrorEnvelope`
- `429`: Rate limit exceeded → `ErrorEnvelope`
- `500`: Internal server error → `ErrorEnvelope`

**Response fields** (`CampaignRecommendationResponse`)

See [CampaignRecommendationResponse](#campaignrecommendationresponse) in Models.

**Response example:**
```json
{
  "budgetOptionsMicros": [
    "string"
  ],
  "budgetType": "DAILY",
  "durationOptionsInDays": [
    0
  ],
  "recommendedBudgetMicros": "string"
}
```

**Error handling:** `429`: Retry with exponential backoff (start at 1s). `403`: Verify your API key has the required scopes listed above. 

**Rate Limits:** perApiKeyOwner: 120/minute, perOauth2Authorization: 120/minute

**Example:**
```bash
curl -X POST -H "x-api-key: $ROBLOX_API_KEY" \
  "https://apis.roblox.com/ads-management/v1/campaign-recommendations" \
  -H "Content-Type: application/json" \
  -d '{
  "campaignContext": {
    "objective": "PLAYS",
    "targetUniverseId": "string",
    "targeting": {
      "ageGroups": "...",
      "audienceType": "...",
      "countries": "...",
      "devices": "...",
      "regions": "..."
    }
  }
}'
```

### GET `/ads-management/v1/campaigns` [BETA]

List campaigns

Lists the campaigns in the caller's billing account. Results are paginated with a cursor (pageToken); each page returns up to maxPageSize campaigns (default 50, max 100). groupId lists a group's billing account instead, and targetUniverseIds lists the campaigns of those experiences across billing accounts; campaigns that ended more than 730 days ago aren't included, and a page can hold fewer than maxPageSize campaigns while more remain. When nextPageToken is present, use it to continue even if the current page is empty.

**Auth:** Cookie (`.ROBLOSECURITY`) or API Key (`x-api-key` header) or OAuth 2.0 Bearer token

**Scopes:** `ad.campaign:read`

**Parameters:**

| Name | In | Type | Required | Description |
|------|-----|------|----------|-------------|
| `groupId` | query | `string` | No | Use the group's billing account instead of the caller's personal one. Can't be combined with targetUniverseIds. groupId selects the group ads account; absent groupId selects the personal ads account |
| `targetUniverseIds` | query | `string[]` | No | List these experiences' campaigns across billing accounts (up to 10 universe IDs, including duplicates); more than 10 returns 400. Requires permission to advertise each. Repeat the parameter for each ID, for example targetUniverseIds=1&targetUniverseIds=2; a comma-separated list returns 400 |
| `endedAfter` | query | `string` | No | Include campaigns with no end time or an end time at or after this RFC 3339 timestamp. Must not be in the future or more than 730 days ago. Omitted: no account time filter; a 730-day lookback for targetUniverseIds. |
| `maxPageSize` | query | `integer` | No | Maximum results per page (1-100, default 50) |
| `pageToken` | query | `string` | No | Opaque cursor from a prior nextPageToken. Keep endedAfter and the ordered targetUniverseIds selector the same on subsequent pages. |

**Responses:**

- `200`: OK → `ListCampaignsResponse`
- `400`: Invalid maxPageSize, pageToken, endedAfter, or targetUniverseIds → `ErrorEnvelope`
- `403`: Permission denied → `ErrorEnvelope`
- `429`: Rate limit exceeded → `ErrorEnvelope`
- `500`: Internal server error → `ErrorEnvelope`

**Response fields** (`ListCampaignsResponse`)

See [ListCampaignsResponse](#listcampaignsresponse) in Models.

**Response example:**
```json
{
  "campaigns": [
    {
      "autoReloadAdCreditEnabled": "...",
      "billingAccountId": "...",
      "budget": "...",
      "createTime": "...",
      "creativeAssetIds": "...",
      "creator": "..."
    }
  ],
  "nextPageToken": "string"
}
```

**Error handling:** `429`: Retry with exponential backoff (start at 1s). `403`: Verify your API key has the required scopes listed above. 

**Rate Limits:** perApiKeyOwner: 600/minute, perOauth2Authorization: 600/minute

**Example:**
```bash
curl -H "x-api-key: $ROBLOX_API_KEY" \
  "https://apis.roblox.com/ads-management/v1/campaigns"
```

### POST `/ads-management/v1/campaigns` [BETA]

Create a campaign

Creates an ad campaign in the billing account. Before creating, call GetCampaignOptions with universeId to confirm the experience is eligible and to choose values it accepts. The creatives you reference must already exist as Open Cloud image assets that you have permission to use; they are validated and saved to your account's reusable creatives when the campaign is created. On success the campaign is returned with deliveryStatus IN_REVIEW, meaning it is queued for ad-policy review and not yet serving, or NOT_SERVING with reason SCHEDULED when startTime is in the future — poll the campaign (or campaigns:batchGetStatus) until this changes. budget.amountMicros is the budget in micro-USD as a decimal string (e.g. "5000000" = $5.00). It must be at least the minimum campaign budget; an amount below the minimum returns 400 with the required minimum stated in the error message. schedule.durationInDays must not exceed 3650 (~10 years). The optional idempotencyKey body field must be a UUID when non-empty. If it is omitted or empty, creation runs without deduplication; retries can create duplicate campaigns. Generate a new key for each new campaign and whenever you change the request body, including the name. Reuse a key only to retry the same body. Within 24 hours, a completed request's key returns the original campaign (200). If the body differs, the API ignores the changes; 200 does not mean they were applied, and this case does not return 409. A retry while the first request is still in progress returns 429. Use PATCH /campaigns/{id} to edit an existing campaign. A body field that the request does not define returns 400 with reason UNKNOWN_FIELD and the field path in field.

**Auth:** Cookie (`.ROBLOSECURITY`) or API Key (`x-api-key` header) or OAuth 2.0 Bearer token

**Scopes:** `ad.campaign:write`

**Responses:**

- `200`: Campaign created, or idempotent replay of a prior create with the same key → `Campaign`
- `400`: Validation error, invalid asset, endTime sent, or campaign limit reached → `ErrorEnvelope`
- `403`: Cannot manage account, universe not advertisable, or USE-permission denied → `ErrorEnvelope`
- `409`: Conflicting concurrent write → `ErrorEnvelope`
- `429`: Rate limit exceeded, or a replay of a request still in progress → `ErrorEnvelope`
- `500`: Internal server error → `ErrorEnvelope`

**Response fields** (`Campaign`)

See [Campaign](#campaign) in Models.

**Response example:**
```json
{
  "autoReloadAdCreditEnabled": false,
  "billingAccountId": "string",
  "budget": {
    "amountMicros": "string",
    "scheduledAmountMicros": "string",
    "scheduledEffectiveTime": "2024-01-01T00:00:00Z",
    "type": "DAILY"
  },
  "createTime": "2024-01-01T00:00:00Z",
  "creativeAssetIds": [
    "string"
  ],
  "creator": {
    "groupId": "string",
    "userId": "string"
  }
}
```

**Error handling:** `429`: Retry with exponential backoff (start at 1s). `403`: Verify your API key has the required scopes listed above. 

**Rate Limits:** perApiKeyOwner: 60/minute, perOauth2Authorization: 60/minute

**Example:**
```bash
curl -X POST -H "x-api-key: $ROBLOX_API_KEY" \
  "https://apis.roblox.com/ads-management/v1/campaigns" \
  -H "Content-Type: application/json" \
  -d '{"key": "value"}'
```

### GET `/ads-management/v1/campaigns/{campaignId}/ads` [EXPERIMENTAL]

List a campaign's ads

Lists every ad the campaign has had, one per creative, including PAUSED and REMOVED ads, in creation order (oldest first). id matches the ad ID reported by analytics-query-api.

**Auth:** Cookie (`.ROBLOSECURITY`) or API Key (`x-api-key` header) or OAuth 2.0 Bearer token

**Scopes:** `ad.campaign:read`

**Parameters:**

| Name | In | Type | Required | Description |
|------|-----|------|----------|-------------|
| `campaignId` | path | `string` | Yes | Campaign ID |
| `maxPageSize` | query | `integer` | No | Maximum results per page (1-100, default 50) |
| `pageToken` | query | `string` | No | Opaque cursor from a prior nextPageToken |

**Responses:**

- `200`: OK → `ListCampaignAdsResponse`
- `400`: Invalid maxPageSize or pageToken → `ErrorEnvelope`
- `403`: Permission denied → `ErrorEnvelope`
- `404`: Campaign not found → `ErrorEnvelope`
- `429`: Rate limit exceeded → `ErrorEnvelope`
- `500`: Internal server error → `ErrorEnvelope`

**Response fields** (`ListCampaignAdsResponse`)

See [ListCampaignAdsResponse](#listcampaignadsresponse) in Models.

**Response example:**
```json
{
  "ads": [
    {
      "creativeAssetId": "...",
      "deliveryStatus": "...",
      "id": "...",
      "removeTime": "...",
      "reviewIssues": "...",
      "reviewStatus": "..."
    }
  ],
  "nextPageToken": "string"
}
```

**Error handling:** `429`: Retry with exponential backoff (start at 1s). `403`: Verify your API key has the required scopes listed above. 

**Rate Limits:** perApiKeyOwner: 120/minute, perOauth2Authorization: 120/minute

**Example:**
```bash
curl -H "x-api-key: $ROBLOX_API_KEY" \
  "https://apis.roblox.com/ads-management/v1/campaigns/{CAMPAIGNID}/ads"
```

### GET `/ads-management/v1/campaigns/{campaignId}/ads/{adId}` [EXPERIMENTAL]

Get one ad

Returns one ad in a campaign. Returns 404 if the campaign or ad does not exist, the caller cannot manage the campaign, or adId does not belong to campaignId.

**Auth:** Cookie (`.ROBLOSECURITY`) or API Key (`x-api-key` header) or OAuth 2.0 Bearer token

**Scopes:** `ad.campaign:read`

**Parameters:**

| Name | In | Type | Required | Description |
|------|-----|------|----------|-------------|
| `campaignId` | path | `string` | Yes | Campaign ID |
| `adId` | path | `string` | Yes | Ad ID |

**Responses:**

- `200`: OK → `CampaignAd`
- `400`: Invalid request → `ErrorEnvelope`
- `403`: Permission denied → `ErrorEnvelope`
- `404`: Campaign or ad not found → `ErrorEnvelope`
- `429`: Rate limit exceeded → `ErrorEnvelope`
- `500`: Internal server error → `ErrorEnvelope`

**Response fields** (`CampaignAd`)

See [CampaignAd](#campaignad) in Models.

**Response example:**
```json
{
  "creativeAssetId": "string",
  "deliveryStatus": "SERVING",
  "id": "string",
  "removeTime": "2024-01-01T00:00:00Z",
  "reviewIssues": [
    {
      "code": "...",
      "message": "...",
      "remediation": "...",
      "resource": "..."
    }
  ],
  "reviewStatus": "IN_REVIEW"
}
```

**Error handling:** `429`: Retry with exponential backoff (start at 1s). `403`: Verify your API key has the required scopes listed above. 

**Rate Limits:** perApiKeyOwner: 600/minute, perOauth2Authorization: 600/minute

**Example:**
```bash
curl -H "x-api-key: $ROBLOX_API_KEY" \
  "https://apis.roblox.com/ads-management/v1/campaigns/{CAMPAIGNID}/ads/{ADID}"
```

### PATCH `/ads-management/v1/campaigns/{campaignId}/ads/{adId}` [EXPERIMENTAL]

Toggle one ad on or off

Sets one ad's status to ACTIVE or PAUSED while leaving the campaign's creative set, targeting, and other ads unchanged. Returns 400 FAILED_PRECONDITION for REMOVED ads and for campaigns that have ended or been cancelled.

**Auth:** Cookie (`.ROBLOSECURITY`) or API Key (`x-api-key` header) or OAuth 2.0 Bearer token

**Scopes:** `ad.campaign:write`

**Parameters:**

| Name | In | Type | Required | Description |
|------|-----|------|----------|-------------|
| `campaignId` | path | `string` | Yes | Campaign ID |
| `adId` | path | `string` | Yes | Ad ID |

**Request Body:** `application/json` — Type: `UpdateCampaignAdRequest`

See [UpdateCampaignAdRequest](#updatecampaignadrequest) in Models.

**Request example:**
```json
{
  "status": "ACTIVE"
}
```

**Responses:**

- `200`: OK → `CampaignAd`
- `400`: Validation error or failed precondition → `ErrorEnvelope`
- `403`: Permission denied → `ErrorEnvelope`
- `404`: Campaign or ad not found → `ErrorEnvelope`
- `409`: Concurrent modification conflict → `ErrorEnvelope`
- `429`: Rate limit exceeded → `ErrorEnvelope`
- `500`: Internal server error → `ErrorEnvelope`

**Response fields** (`CampaignAd`)

See [CampaignAd](#campaignad) in Models.

**Response example:**
```json
{
  "creativeAssetId": "string",
  "deliveryStatus": "SERVING",
  "id": "string",
  "removeTime": "2024-01-01T00:00:00Z",
  "reviewIssues": [
    {
      "code": "...",
      "message": "...",
      "remediation": "...",
      "resource": "..."
    }
  ],
  "reviewStatus": "IN_REVIEW"
}
```

**Error handling:** `429`: Retry with exponential backoff (start at 1s). `403`: Verify your API key has the required scopes listed above. 

**Rate Limits:** perApiKeyOwner: 60/minute, perOauth2Authorization: 60/minute

**Example:**
```bash
curl -X PATCH -H "x-api-key: $ROBLOX_API_KEY" \
  "https://apis.roblox.com/ads-management/v1/campaigns/{CAMPAIGNID}/ads/{ADID}" \
  -H "Content-Type: application/json" \
  -d '{
  "status": "ACTIVE"
}'
```

### GET `/ads-management/v1/campaigns/{id}` [BETA]

Get a campaign

Returns a single campaign, including its status (the lifecycle state you control: ACTIVE, PAUSED, or CANCELLED) and its deliveryStatus (whether it is currently serving: SERVING, IN_REVIEW, NOT_SERVING, or REJECTED). deliveryStatusReasons lists any reasons that affect delivery — for example why a campaign is not serving or was rejected, or that a serving campaign is still in its initial learning period. Returns 404 if the campaign does not exist or the caller can't manage it. A campaign owned by a group is readable by any member with advertising permission on the campaign's experience, without groupId.

**Auth:** Cookie (`.ROBLOSECURITY`) or API Key (`x-api-key` header) or OAuth 2.0 Bearer token

**Scopes:** `ad.campaign:read`

**Parameters:**

| Name | In | Type | Required | Description |
|------|-----|------|----------|-------------|
| `id` | path | `string` | Yes | Campaign ID |

**Responses:**

- `200`: OK → `Campaign`
- `400`: Invalid campaign ID → `ErrorEnvelope`
- `403`: Permission denied → `ErrorEnvelope`
- `404`: Campaign not found → `ErrorEnvelope`
- `429`: Rate limit exceeded → `ErrorEnvelope`
- `500`: Internal server error → `ErrorEnvelope`

**Response fields** (`Campaign`)

See [Campaign](#campaign) in Models.

**Response example:**
```json
{
  "autoReloadAdCreditEnabled": false,
  "billingAccountId": "string",
  "budget": {
    "amountMicros": "string",
    "scheduledAmountMicros": "string",
    "scheduledEffectiveTime": "2024-01-01T00:00:00Z",
    "type": "DAILY"
  },
  "createTime": "2024-01-01T00:00:00Z",
  "creativeAssetIds": [
    "string"
  ],
  "creator": {
    "groupId": "string",
    "userId": "string"
  }
}
```

**Error handling:** `429`: Retry with exponential backoff (start at 1s). `403`: Verify your API key has the required scopes listed above. 

**Rate Limits:** perApiKeyOwner: 600/minute, perOauth2Authorization: 600/minute

**Example:**
```bash
curl -H "x-api-key: $ROBLOX_API_KEY" \
  "https://apis.roblox.com/ads-management/v1/campaigns/{ID}"
```

### PATCH `/ads-management/v1/campaigns/{id}` [BETA]

Update a campaign

Updates the mutable fields of a campaign. You can change: name, budget.amountMicros, schedule.startTime and schedule.durationInDays (schedule changes are only allowed before the campaign starts), status, and creativeAssetIds. New creative asset IDs are appended; IDs already attached to the campaign are ignored, and an empty list is a successful no-op. Set status to ACTIVE to run or resume the campaign, PAUSED to pause it, or CANCELLED to cancel it permanently. Setting CANCELLED on a campaign that is already cancelled returns the campaign unchanged, so a retried cancel succeeds; any other edit to a cancelled or ended campaign returns 400 FAILED_PRECONDITION. budget.type cannot be changed — only the amount. A budget increase takes effect immediately, but a budget decrease on a running campaign is scheduled for the next midnight in the account's time zone; while a decrease is pending, the response reports it in budget.scheduledAmountMicros and budget.scheduledEffectiveTime. The fields objective, paymentType, targeting, and bid are fixed after creation and return 400 if included. The updated campaign is returned with its recomputed deliveryStatus. You can also change video (every ad is updated before the response returns) and autoReloadAdCreditEnabled. Video availability follows the campaign's billing account, as on create, and a request with video returns 400 when the account doesn't allow it; billingAccountId and targetUniverseId are fixed after creation, and immutable-field errors carry field and reason IMMUTABLE_FIELD. A body field that the request does not define returns 400 with reason UNKNOWN_FIELD. A campaign owned by a group can be updated by any member with advertising permission on the campaign's experience, without groupId; raising the spend of another user's campaign, including setting status to ACTIVE, is limited to its owner.

**Auth:** Cookie (`.ROBLOSECURITY`) or API Key (`x-api-key` header) or OAuth 2.0 Bearer token

**Scopes:** `ad.campaign:write`

**Parameters:**

| Name | In | Type | Required | Description |
|------|-----|------|----------|-------------|
| `id` | path | `string` | Yes | Campaign ID |

**Request Body:** `application/json` — Type: `UpdateCampaignRequest`

See [UpdateCampaignRequest](#updatecampaignrequest) in Models.

**Request example:**
```json
{
  "autoReloadAdCreditEnabled": false,
  "budget": {
    "amountMicros": "string"
  },
  "creativeAssetIds": [
    "string"
  ],
  "name": "string",
  "schedule": {
    "durationInDays": 0,
    "endTime": "2024-01-01T00:00:00Z",
    "startTime": "2024-01-01T00:00:00Z"
  },
  "status": "ACTIVE"
}
```

**Responses:**

- `200`: OK → `Campaign`
- `400`: Validation error or immutable field supplied → `ErrorEnvelope`
- `403`: Permission denied → `ErrorEnvelope`
- `404`: Campaign not found → `ErrorEnvelope`
- `409`: Conflicting concurrent change, including a video change already in progress → `ErrorEnvelope`
- `429`: Rate limit exceeded → `ErrorEnvelope`
- `500`: Internal server error → `ErrorEnvelope`

**Response fields** (`Campaign`)

See [Campaign](#campaign) in Models.

**Response example:**
```json
{
  "autoReloadAdCreditEnabled": false,
  "billingAccountId": "string",
  "budget": {
    "amountMicros": "string",
    "scheduledAmountMicros": "string",
    "scheduledEffectiveTime": "2024-01-01T00:00:00Z",
    "type": "DAILY"
  },
  "createTime": "2024-01-01T00:00:00Z",
  "creativeAssetIds": [
    "string"
  ],
  "creator": {
    "groupId": "string",
    "userId": "string"
  }
}
```

**Error handling:** `429`: Retry with exponential backoff (start at 1s). `403`: Verify your API key has the required scopes listed above. 

**Rate Limits:** perApiKeyOwner: 60/minute, perOauth2Authorization: 60/minute

**Example:**
```bash
curl -X PATCH -H "x-api-key: $ROBLOX_API_KEY" \
  "https://apis.roblox.com/ads-management/v1/campaigns/{ID}" \
  -H "Content-Type: application/json" \
  -d '{
  "autoReloadAdCreditEnabled": false,
  "budget": {
    "amountMicros": "string"
  },
  "creativeAssetIds": [
    "string"
  ],
  "name": "string",
  "schedule": {
    "durationInDays": 0,
    "endTime": "2024-01-01T00:00:00Z",
    "startTime": "2024-01-01T00:00:00Z"
  },
  "status": "ACTIVE"
}'
```

### POST `/ads-management/v1/campaigns:batchGetStatus` [BETA]

Batch get campaign status

Returns the status (lifecycle state) and deliveryStatus (whether the campaign is currently serving), along with deliveryStatusReasons, for up to 100 campaigns in a single call. This is the recommended way to poll the review and serving state of many campaigns at once. Provide the campaign IDs in campaignIds; any ID that is not found or that the caller can't manage is returned in the failures array with reason NOT_FOUND. A campaign owned by a group is returned to any member with advertising permission on the campaign's experience, without groupId.

**Auth:** Cookie (`.ROBLOSECURITY`) or API Key (`x-api-key` header) or OAuth 2.0 Bearer token

**Scopes:** `ad.campaign:read`

**Request Body:** `application/json` — Type: `BatchGetStatusRequest`

See [BatchGetStatusRequest](#batchgetstatusrequest) in Models.

**Request example:**
```json
{
  "campaignIds": [
    "string"
  ]
}
```

**Responses:**

- `200`: OK → `BatchGetStatusResponse`
- `400`: Invalid request or exceeds 100 IDs → `ErrorEnvelope`
- `403`: Permission denied → `ErrorEnvelope`
- `429`: Rate limit exceeded → `ErrorEnvelope`
- `500`: Internal server error → `ErrorEnvelope`

**Response fields** (`BatchGetStatusResponse`)

See [BatchGetStatusResponse](#batchgetstatusresponse) in Models.

**Response example:**
```json
{
  "failures": [
    {
      "id": "...",
      "reason": "..."
    }
  ],
  "statuses": [
    {
      "deliveryStatus": "...",
      "deliveryStatusReasons": "...",
      "id": "...",
      "status": "..."
    }
  ]
}
```

**Error handling:** `429`: Retry with exponential backoff (start at 1s). `403`: Verify your API key has the required scopes listed above. 

**Rate Limits:** perApiKeyOwner: 120/minute, perOauth2Authorization: 120/minute

**Example:**
```bash
curl -X POST -H "x-api-key: $ROBLOX_API_KEY" \
  "https://apis.roblox.com/ads-management/v1/campaigns:batchGetStatus" \
  -H "Content-Type: application/json" \
  -d '{
  "campaignIds": [
    "string"
  ]
}'
```

### POST `/ads-management/v1/campaigns:validate` [EXPERIMENTAL]

Validate a campaign without creating it

Runs the same validation, permission, eligibility, and billing-account resolution as CreateCampaign, without creating anything. HTTP 200 means validation ran; read valid and errors, which match the errors CreateCampaign would return for the same body. resolvedBillingAccountId is the account the campaign would be created in. Malformed JSON, account-resolution failures, and dependency failures return the usual error envelope. The optional idempotencyKey body field is validated but does not reserve a key.

**Auth:** Cookie (`.ROBLOSECURITY`) or API Key (`x-api-key` header) or OAuth 2.0 Bearer token

**Scopes:** `ad.campaign:write`

**Responses:**

- `200`: Validation ran → `ValidateCampaignResponse`
- `400`: Malformed request body → `ErrorEnvelope`
- `403`: Cannot resolve a billing account for this context → `ErrorEnvelope`
- `429`: Rate limit exceeded → `ErrorEnvelope`
- `500`: Internal server error → `ErrorEnvelope`

**Response fields** (`ValidateCampaignResponse`)

See [ValidateCampaignResponse](#validatecampaignresponse) in Models.

**Response example:**
```json
{
  "errors": [
    {
      "actionUrl": "...",
      "code": "...",
      "field": "...",
      "message": "...",
      "reason": "...",
      "remediation": "..."
    }
  ],
  "resolvedBillingAccountId": "string",
  "valid": false,
  "warnings": [
    {
      "code": "...",
      "message": "...",
      "remediation": "...",
      "resource": "..."
    }
  ]
}
```

**Error handling:** `429`: Retry with exponential backoff (start at 1s). `403`: Verify your API key has the required scopes listed above. 

**Rate Limits:** perApiKeyOwner: 120/minute, perOauth2Authorization: 120/minute

**Example:**
```bash
curl -X POST -H "x-api-key: $ROBLOX_API_KEY" \
  "https://apis.roblox.com/ads-management/v1/campaigns:validate" \
  -H "Content-Type: application/json" \
  -d '{"key": "value"}'
```

### GET `/ads-management/v1/creatives` [BETA]

List creatives

Lists the reusable creatives saved to the caller's billing account. Each creative includes its assetId, name, moderation status, dimensions, and source. Use each creative's assetId (a decimal string) in GET /creatives/{id} and PATCH /creatives/{id}. The separate id field is a library registration UUID and cannot be used in those paths; it returns 404. Use isArchived to filter by archive state. Results are paginated with a cursor (pageToken). A filtered page can be short or empty while more results remain; continue until nextPageToken is absent.

**Auth:** Cookie (`.ROBLOSECURITY`) or API Key (`x-api-key` header) or OAuth 2.0 Bearer token

**Scopes:** `ad.campaign:read`

**Parameters:**

| Name | In | Type | Required | Description |
|------|-----|------|----------|-------------|
| `groupId` | query | `string` | No | Select the group ads account; absent groupId selects the personal ads account. Requires group advertising permission |
| `universeId` | query | `string` | No | Filter the selected ads account's creatives by experience; requires permission to advertise it. Can be combined with groupId |
| `isArchived` | query | `boolean` | No | Filter by archived status |
| `assetType` | query | `IMAGE` | No | Asset type filter. Only IMAGE exists Valid values: `IMAGE` |
| `maxPageSize` | query | `integer` | No | Maximum results per page (1-500, default 50) |
| `pageToken` | query | `string` | No | Opaque cursor from a prior nextPageToken |

**Responses:**

- `200`: OK → `ListCreativesResponse`
- `400`: Invalid maxPageSize or pageToken → `ErrorEnvelope`
- `403`: Permission denied → `ErrorEnvelope`
- `429`: Rate limit exceeded → `ErrorEnvelope`
- `500`: Internal server error → `ErrorEnvelope`

**Response fields** (`ListCreativesResponse`)

See [ListCreativesResponse](#listcreativesresponse) in Models.

**Response example:**
```json
{
  "creatives": [
    {
      "assetId": "...",
      "assetName": "...",
      "assetType": "...",
      "billingAccountId": "...",
      "createTime": "...",
      "height": "..."
    }
  ],
  "nextPageToken": "string"
}
```

**Error handling:** `429`: Retry with exponential backoff (start at 1s). `403`: Verify your API key has the required scopes listed above. 

**Rate Limits:** perApiKeyOwner: 120/minute, perOauth2Authorization: 120/minute

**Example:**
```bash
curl -H "x-api-key: $ROBLOX_API_KEY" \
  "https://apis.roblox.com/ads-management/v1/creatives"
```

### POST `/ads-management/v1/creatives` [EXPERIMENTAL]

Add an asset to the creative library

Saves an existing Open Cloud image asset to the creative library ahead of campaign creation. Dimensions and moderation state are derived by the service. Registering an asset that is already active in the selected billing account's library returns 409 ALREADY_EXISTS, regardless of the supplied universeId. You cannot change an active entry's universeId by re-registering the asset. Archived entries are unarchived and updated with the supplied fields.

**Auth:** Cookie (`.ROBLOSECURITY`) or API Key (`x-api-key` header) or OAuth 2.0 Bearer token

**Scopes:** `ad.campaign:write`

**Parameters:**

| Name | In | Type | Required | Description |
|------|-----|------|----------|-------------|
| `groupId` | query | `string` | No | Select the group ads account; absent groupId selects the personal ads account. Requires group advertising permission |

**Request Body:** `application/json` — Type: `CreateCreativeRequest`

See [CreateCreativeRequest](#createcreativerequest) in Models.

**Request example:**
```json
{
  "assetId": "string",
  "universeId": "string"
}
```

**Responses:**

- `201`: Creative created → `Creative`
- `400`: Invalid request or asset not usable → `ErrorEnvelope`
- `403`: Permission denied → `ErrorEnvelope`
- `409`: Asset already registered in the selected billing account's library → `ErrorEnvelope`
- `429`: Rate limit exceeded → `ErrorEnvelope`
- `500`: Internal server error → `ErrorEnvelope`

**Response fields** (`Creative`)

See [Creative](#creative) in Models.

**Response example:**
```json
{
  "assetId": "string",
  "assetName": "string",
  "assetType": "IMAGE",
  "billingAccountId": "string",
  "createTime": "2024-01-01T00:00:00Z",
  "height": 0
}
```

**Error handling:** `429`: Retry with exponential backoff (start at 1s). `403`: Verify your API key has the required scopes listed above. 

**Rate Limits:** perApiKeyOwner: 60/minute, perOauth2Authorization: 60/minute

**Example:**
```bash
curl -X POST -H "x-api-key: $ROBLOX_API_KEY" \
  "https://apis.roblox.com/ads-management/v1/creatives" \
  -H "Content-Type: application/json" \
  -d '{
  "assetId": "string",
  "universeId": "string"
}'
```

### GET `/ads-management/v1/creatives/{id}` [BETA]

Get a creative

Returns the Roblox asset registered in the selected ads account. The path id is Creative.assetId, a decimal Roblox asset ID, not Creative.id (the library registration UUID). For example, assetId "1234567890" uses /creatives/1234567890. A registration UUID returns 404. groupId selects the group ads account; absent groupId selects the personal ads account. The caller needs group advertising permission. Unknown and inaccessible creatives return the same 404.

**Auth:** Cookie (`.ROBLOSECURITY`) or API Key (`x-api-key` header) or OAuth 2.0 Bearer token

**Scopes:** `ad.campaign:read`

**Parameters:**

| Name | In | Type | Required | Description |
|------|-----|------|----------|-------------|
| `id` | path | `string` | Yes | Roblox asset ID (Creative.assetId) in the group ads account selected by groupId, or the personal ads account when absent |
| `groupId` | query | `string` | No | Select the group ads account; absent groupId selects the personal ads account. Requires group advertising permission |

**Responses:**

- `200`: OK → `Creative`
- `404`: Creative not found → `ErrorEnvelope`
- `429`: Rate limit exceeded → `ErrorEnvelope`
- `500`: Internal server error → `ErrorEnvelope`

**Response fields** (`Creative`)

See [Creative](#creative) in Models.

**Response example:**
```json
{
  "assetId": "string",
  "assetName": "string",
  "assetType": "IMAGE",
  "billingAccountId": "string",
  "createTime": "2024-01-01T00:00:00Z",
  "height": 0
}
```

**Error handling:** `429`: Retry with exponential backoff (start at 1s). 

**Rate Limits:** perApiKeyOwner: 600/minute, perOauth2Authorization: 600/minute

**Example:**
```bash
curl -H "x-api-key: $ROBLOX_API_KEY" \
  "https://apis.roblox.com/ads-management/v1/creatives/{ID}"
```

### PATCH `/ads-management/v1/creatives/{id}` [BETA]

Update a creative

Archives or unarchives a creative, or changes its associated experience. isArchived=true must be the only field in the request; combining it with another field returns 400 without writing. Archiving returns 409 if an enabled ad uses the asset; pause or archive that ad first. Set universeId to null to clear the association; omitted fields remain unchanged. An empty object returns the current creative without writing. The asset is resolved only in the group ads account selected by groupId, or the caller's personal account when omitted. Unknown assets and inaccessible accounts return the same 404. The caller must have advertising permission for a new experience association.

**Auth:** Cookie (`.ROBLOSECURITY`) or API Key (`x-api-key` header) or OAuth 2.0 Bearer token

**Scopes:** `ad.campaign:write`

**Parameters:**

| Name | In | Type | Required | Description |
|------|-----|------|----------|-------------|
| `id` | path | `string` | Yes | Roblox asset ID in the group ads account selected by groupId, or the caller's personal account when omitted |
| `groupId` | query | `string` | No | Roblox group ID as a decimal string. Selects that group's ads account; requires group advertising permission. Omit for the caller's personal account. |

**Request Body:** `application/json` — Type: `UpdateCreativeRequest`

See [UpdateCreativeRequest](#updatecreativerequest) in Models.

**Request example:**
```json
{
  "isArchived": false,
  "universeId": "string"
}
```

**Responses:**

- `200`: OK → `Creative`
- `400`: Invalid request → `ErrorEnvelope`
- `403`: Permission denied for the new experience → `ErrorEnvelope`
- `404`: Creative not found → `ErrorEnvelope`
- `409`: Creative is used by an enabled ad, or conflicting concurrent change → `ErrorEnvelope`
- `429`: Rate limit exceeded → `ErrorEnvelope`
- `500`: Internal server error → `ErrorEnvelope`

**Response fields** (`Creative`)

See [Creative](#creative) in Models.

**Response example:**
```json
{
  "assetId": "string",
  "assetName": "string",
  "assetType": "IMAGE",
  "billingAccountId": "string",
  "createTime": "2024-01-01T00:00:00Z",
  "height": 0
}
```

**Error handling:** `429`: Retry with exponential backoff (start at 1s). `403`: Verify your API key has the required scopes listed above. 

**Rate Limits:** perApiKeyOwner: 60/minute, perOauth2Authorization: 60/minute

**Example:**
```bash
curl -X PATCH -H "x-api-key: $ROBLOX_API_KEY" \
  "https://apis.roblox.com/ads-management/v1/creatives/{ID}" \
  -H "Content-Type: application/json" \
  -d '{
  "isArchived": false,
  "universeId": "string"
}'
```

### POST `/ads-management/v1/performance-estimates` [EXPERIMENTAL]

Create a performance estimate

Estimates an objective from a budget, or the budget required for a target outcome, for an experience the caller can advertise. Results are not cached.

**Auth:** Cookie (`.ROBLOSECURITY`) or API Key (`x-api-key` header) or OAuth 2.0 Bearer token

**Scopes:** `ad.campaign:read`

**Request Body:** `application/json` — Type: `PerformanceEstimateRequest`

See [PerformanceEstimateRequest](#performanceestimaterequest) in Models.

**Request example:**
```json
{
  "campaignContext": {
    "objective": "PLAYS",
    "targetUniverseId": "string"
  },
  "forecastInput": {
    "budget": {
      "amountMicroUsd": "..."
    },
    "targetOutcome": {
      "outcomeType": "...",
      "value": "..."
    }
  },
  "forecastScope": {
    "budgetType": "DAILY",
    "durationInDays": 0
  }
}
```

**Responses:**

- `200`: OK → `PerformanceEstimateResponse`
- `400`: Invalid request → `ErrorEnvelope`
- `403`: Permission denied → `ErrorEnvelope`
- `404`: Not available → `ErrorEnvelope`
- `500`: Internal server error → `ErrorEnvelope`
- `504`: Timed out → `ErrorEnvelope`

**Response fields** (`PerformanceEstimateResponse`)

See [PerformanceEstimateResponse](#performanceestimateresponse) in Models.

**Response example:**
```json
{
  "budget": {
    "dailyAmountMicroUsd": "string",
    "dailyAmountMicroUsdRange": {
      "lowerBound": "...",
      "upperBound": "..."
    },
    "lifetimeAmountMicroUsd": "string",
    "lifetimeAmountMicroUsdRange": {
      "lowerBound": "...",
      "upperBound": "..."
    }
  },
  "derivedMetrics": {
    "costPerOutcomeMicroUsd": "string",
    "costPerOutcomeMicroUsdRange": {
      "lowerBound": "...",
      "upperBound": "..."
    }
  },
  "outcome": {
    "dailyValue": 0,
    "dailyValueRange": {
      "lowerBound": "...",
      "upperBound": "..."
    },
    "lifetimeValue": 0,
    "lifetimeValueRange": {
      "lowerBound": "...",
      "upperBound": "..."
    },
    "outcomeType": "PLAYS"
  },
  "predicted": "OUTCOME"
}
```

**Error handling:** `403`: Verify your API key has the required scopes listed above. 

**Rate Limits:** perApiKeyOwner: 60/minute, perOauth2Authorization: 60/minute

**Example:**
```bash
curl -X POST -H "x-api-key: $ROBLOX_API_KEY" \
  "https://apis.roblox.com/ads-management/v1/performance-estimates" \
  -H "Content-Type: application/json" \
  -d '{"campaignContext":{"objective":"PLAYS","targetUniverseId":"string"},"forecastInput":{"budget":{"amountMicroUsd":"..."},"targetOutcome":{"outcomeType":"...","value":"..."}},"forecastScope":{"budgetType":"DAILY","durationInDays":0}}'
```

### POST `/v1/ads-tracking/click`

Records an ad click.

**Server:** `https://ads.roblox.com`

**Auth:** Cookie (`.ROBLOSECURITY`)

**Request Body:** `application/json` — Type: `Roblox.Ads.Api.RecordClickRequest`

See [Roblox.Ads.Api.RecordClickRequest](#roblox-ads-api-recordclickrequest) in Models.

**Request example:**
```json
{
  "encryptedAdTrackingData": "string",
  "campaignTargetType": 0,
  "placementLocation": 1
}
```

**Responses:**

- `200`: OK → `Roblox.Web.WebAPI.ApiEmptyResponseModel`
- `401`: 0: Authorization has been denied for this request.
- `403`: 0: Token Validation Failed

**Response fields** (`Roblox.Web.WebAPI.ApiEmptyResponseModel`)

See [Roblox.Web.WebAPI.ApiEmptyResponseModel](#roblox-web-webapi-apiemptyresponsemodel) in Models.

**Error handling:** `401`: Check that your API key/token is valid and not expired. `403`: Verify your API key has the required scopes listed above. 

**Example:**
```bash
curl -X POST -b ".ROBLOSECURITY=$ROBLOSECURITY" \
  "https://ads.roblox.com/v1/ads-tracking/click" \
  -H "Content-Type: application/json" \
  -d '{
  "encryptedAdTrackingData": "string",
  "campaignTargetType": 0,
  "placementLocation": 1
}'
```

### POST `/v1/sponsored-games/click`

Records clicks for sponsored games.

**Server:** `https://ads.roblox.com`

**Auth:** Cookie (`.ROBLOSECURITY`)

**Request Body:** `application/json` — Type: `string`

**Responses:**

- `200`: OK → `Roblox.Web.WebAPI.ApiEmptyResponseModel`
- `401`: 0: Authorization has been denied for this request.
- `403`: 0: Token Validation Failed

**Response fields** (`Roblox.Web.WebAPI.ApiEmptyResponseModel`)

See [Roblox.Web.WebAPI.ApiEmptyResponseModel](#roblox-web-webapi-apiemptyresponsemodel) in Models.

**Error handling:** `401`: Check that your API key/token is valid and not expired. `403`: Verify your API key has the required scopes listed above. 

**Example:**
```bash
curl -X POST -b ".ROBLOSECURITY=$ROBLOSECURITY" \
  "https://ads.roblox.com/v1/sponsored-games/click" \
  -H "Content-Type: application/json" \
  -d '"string"'
```

### GET `/v1/sponsored-pages`

Retrieves sponsored pages to serve to a user on a specific device type in a specific country.

**Server:** `https://ads.roblox.com`

**Auth:** Cookie (`.ROBLOSECURITY`)

**Responses:**

- `200`: OK → `Roblox.Web.WebAPI.Models.ApiArrayResponse_Roblox.Ads.Api.Models.Response.SponsoredPageResponse_`
- `401`: 0: Authorization has been denied for this request.

**Response fields** (`Roblox.Web.WebAPI.Models.ApiArrayResponse_Roblox.Ads.Api.Models.Response.SponsoredPageResponse_`)

See [Roblox.Web.WebAPI.Models.ApiArrayResponse_Roblox.Ads.Api.Models.Response.SponsoredPageResponse_](#roblox-web-webapi-models-apiarrayresponse-roblox-ads-api-models-response-sponsoredpageresponse-) in Models.

**Response example:**
```json
{
  "data": [
    {
      "name": "...",
      "title": "...",
      "logoImageUrl": "...",
      "pageType": "...",
      "pagePath": "..."
    }
  ]
}
```

**Error handling:** `401`: Check that your API key/token is valid and not expired. 

**Example:**
```bash
curl -b ".ROBLOSECURITY=$ROBLOSECURITY" \
  "https://ads.roblox.com/v1/sponsored-pages"
```

### GET `/v1/sponsored/catalog-assets/{targetId}/create`

Returns the asset information for creating a new sponsored campaign.

**Server:** `https://ads.roblox.com`

**Auth:** Cookie (`.ROBLOSECURITY`)

**Parameters:**

| Name | In | Type | Required | Description |
|------|-----|------|----------|-------------|
| `targetId` | path | `integer` | Yes | The target of the campaign |

**Responses:**

- `200`: OK → `Roblox.Ads.Api.Models.Response.CreateSponsoredItemCampaignResponse`
- `401`: 0: Authorization has been denied for this request.

**Response fields** (`Roblox.Ads.Api.Models.Response.CreateSponsoredItemCampaignResponse`)

See [Roblox.Ads.Api.Models.Response.CreateSponsoredItemCampaignResponse](#roblox-ads-api-models-response-createsponsoreditemcampaignresponse) in Models.

**Response example:**
```json
{
  "creatorTargetId": 0,
  "creatorType": "string",
  "creatorName": "string"
}
```

**Error handling:** `401`: Check that your API key/token is valid and not expired. 

**Example:**
```bash
curl -b ".ROBLOSECURITY=$ROBLOSECURITY" \
  "https://ads.roblox.com/v1/sponsored/catalog-assets/{TARGETID}/create"
```

### GET `/v2/sponsored-campaigns` [EXPERIMENTAL]

Gets a page of Roblox.AdConfiguration.Api.SponsoredCampaignModel with specified input parameters.

**Server:** `https://adconfiguration.roblox.com`

**Auth:** Cookie (`.ROBLOSECURITY`)

**Parameters:**

| Name | In | Type | Required | Description |
|------|-----|------|----------|-------------|
| `campaignTargetType` | query | `0 \| 1 \| 2 \| 3` | Yes | The campaign target type enum value Valid values: `0`, `1`, `2`, `3` |
| `campaignTargetId` | query | `integer` | Yes | The id of the campaign target |
| `includeReportingStats` | query | `boolean` | No | Indicates whether to include reporting stats in the response |
| `isArchived` | query | `boolean` | No | Indicates whether to retrieve archived ads |
| `pageCursor` | query | `string` | No | The cursor of the page to retrieve. If empty, fetches the first page |

**Responses:**

- `200`: OK → `Roblox.AdConfiguration.Api.GetSponsoredCampaignsResponse`
- `400`: 22: Invalid campaign target ID. 23: Invalid campaign target type.
- `401`: 0: Authorization has been denied for this request.
- `503`: 1: This feature is disabled.

**Response fields** (`Roblox.AdConfiguration.Api.GetSponsoredCampaignsResponse`)

See [Roblox.AdConfiguration.Api.GetSponsoredCampaignsResponse](#roblox-adconfiguration-api-getsponsoredcampaignsresponse) in Models.

**Response example:**
```json
{
  "sponsoredCampaigns": [
    {
      "adId": "...",
      "adSetId": "...",
      "adName": "...",
      "adStatus": "...",
      "creativeType": "...",
      "creativeTargetId": "..."
    }
  ],
  "previousPageCursor": "string",
  "nextPageCursor": "string"
}
```

**Error handling:** `401`: Check that your API key/token is valid and not expired. 

**Example:**
```bash
curl -b ".ROBLOSECURITY=$ROBLOSECURITY" \
  "https://adconfiguration.roblox.com/v2/sponsored-campaigns?campaignTargetType={VALUE}&campaignTargetId={VALUE}"
```

### POST `/v2/sponsored-campaigns/create` [EXPERIMENTAL]

Creates a complete ad. Including ad campaign, ad set, escrow, and the ad.
Currently intended for creation of sponsorships only.

**Server:** `https://adconfiguration.roblox.com`

**Auth:** Cookie (`.ROBLOSECURITY`)

**Request Body:** `application/json` — Type: `Roblox.AdConfiguration.Api.Models.CreateSponsoredCampaignRequest`

See [Roblox.AdConfiguration.Api.Models.CreateSponsoredCampaignRequest](#roblox-adconfiguration-api-models-createsponsoredcampaignrequest) in Models.

**Request example:**
```json
{
  "campaignTargetId": 0,
  "campaignTargetType": 0,
  "targetGender": 1,
  "targetAgeBracket": 1,
  "startDate": "2024-01-01T00:00:00Z",
  "endDate": "2024-01-01T00:00:00Z"
}
```

**Responses:**

- `200`: OK → `integer`
- `400`: 2: Daily budget is lower than minimum allowed. 3: Total budget must be greater than 0. 4: Ad name cannot be empty. 5: Start date must not be a future date. 6: End date must be a future date. 7: Start date must be earlier than end date. 8: Total budget does not match daily spend and number of days being scheduled 9: Cannot load the universe for the specified universe id. 11: Invalid target age bracket. 12: Invalid target gender. 13: Invalid target device type. 14: Invalid ad set id. 15: Ad name cannot exceed 255 characters. 16: Insufficient Robux balance. 17: Name has already been taken. 18: Daily budget is higher than maximum allowed. 19: Invalid group id. 20: Number of days scheduled exceeded maximum days allowed. 21: Your experience is currently not eligible for advertising. 22: Invalid campaign target ID. 23: Invalid campaign target type. 24: Invalid creative ID. 25: Invalid creative type. 28: Total budget must be campaign duration * daily bid 29: The target is not eligible for new campaigns 30: Invalid user ID
- `401`: 0: Authorization has been denied for this request. 10: Insufficient permissions.
- `403`: 0: Token Validation Failed
- `500`: 0: An unknown error occurred. 31: Internal server error
- `503`: 1: This feature is disabled.

**Error handling:** `401`: Check that your API key/token is valid and not expired. `403`: Verify your API key has the required scopes listed above. 

**Example:**
```bash
curl -X POST -b ".ROBLOSECURITY=$ROBLOSECURITY" \
  "https://adconfiguration.roblox.com/v2/sponsored-campaigns/create" \
  -H "Content-Type: application/json" \
  -d '{
  "campaignTargetId": 0,
  "campaignTargetType": 0,
  "targetGender": 1,
  "targetAgeBracket": 1,
  "startDate": "2024-01-01T00:00:00Z",
  "endDate": "2024-01-01T00:00:00Z"
}'
```

### GET `/v2/sponsored-campaigns/eligible-asset-type-ids` [EXPERIMENTAL]

Get all asset type IDs that are eligible to be sponsored.

**Server:** `https://adconfiguration.roblox.com`

**Auth:** Cookie (`.ROBLOSECURITY`)

**Responses:**

- `200`: OK → `integer[]`
- `401`: 0: Authorization has been denied for this request.
- `403`: 10: Insufficient permissions.

**Error handling:** `401`: Check that your API key/token is valid and not expired. `403`: Verify your API key has the required scopes listed above. 

**Example:**
```bash
curl -b ".ROBLOSECURITY=$ROBLOSECURITY" \
  "https://adconfiguration.roblox.com/v2/sponsored-campaigns/eligible-asset-type-ids"
```

### POST `/v2/sponsored-campaigns/eligible-campaign-targets` [EXPERIMENTAL]

Returns a collection of Roblox.AdConfiguration.Api.Models.CampaignTargetModel that the user is authorized to sponsor, ordered by most recently advertised

**Server:** `https://adconfiguration.roblox.com`

**Auth:** Cookie (`.ROBLOSECURITY`)

**Request Body:** `application/json` — Type: `Roblox.AdConfiguration.Api.Models.GetEligibleCampaignTargetsRequest`

See [Roblox.AdConfiguration.Api.Models.GetEligibleCampaignTargetsRequest](#roblox-adconfiguration-api-models-geteligiblecampaigntargetsrequest) in Models.

**Request example:**
```json
{
  "campaignTargetTypes": [
    0
  ],
  "groupId": 0
}
```

**Responses:**

- `200`: OK → `Roblox.AdConfiguration.Api.Models.GetCampaignTargetsResponse`
- `400`: 19: Invalid group id.
- `401`: 0: Authorization has been denied for this request.
- `403`: 0: Token Validation Failed 10: Insufficient permissions.

**Response fields** (`Roblox.AdConfiguration.Api.Models.GetCampaignTargetsResponse`)

See [Roblox.AdConfiguration.Api.Models.GetCampaignTargetsResponse](#roblox-adconfiguration-api-models-getcampaigntargetsresponse) in Models.

**Response example:**
```json
{
  "campaignTargetModels": [
    {
      "campaignTargetType": "...",
      "campaignTargetId": "...",
      "name": "..."
    }
  ]
}
```

**Error handling:** `401`: Check that your API key/token is valid and not expired. `403`: Verify your API key has the required scopes listed above. 

**Example:**
```bash
curl -X POST -b ".ROBLOSECURITY=$ROBLOSECURITY" \
  "https://adconfiguration.roblox.com/v2/sponsored-campaigns/eligible-campaign-targets" \
  -H "Content-Type: application/json" \
  -d '{
  "campaignTargetTypes": [
    0
  ],
  "groupId": 0
}'
```

### GET `/v2/sponsored-campaigns/multi-get-can-user-sponsor` [EXPERIMENTAL]

Checks whether the targets are eligible for sponsorship, and
if the user is authorized to sponsor the targets.

**Server:** `https://adconfiguration.roblox.com`

**Auth:** Cookie (`.ROBLOSECURITY`)

**Parameters:**

| Name | In | Type | Required | Description |
|------|-----|------|----------|-------------|
| `campaignTargetType` | query | `0 \| 1 \| 2 \| 3` | Yes | Ads.Management.Service.CampaignTargetType. Valid values: `0`, `1`, `2`, `3` |
| `campaignTargetIds` | query | `integer[]` | Yes | The IDs of the campaign targets. |

**Responses:**

- `200`: OK → `object`
- `400`: Bad Request
- `401`: 0: Authorization has been denied for this request.
- `403`: Forbidden
- `500`: Internal Server Error

**Error handling:** `401`: Check that your API key/token is valid and not expired. `403`: Verify your API key has the required scopes listed above. 

**Example:**
```bash
curl -b ".ROBLOSECURITY=$ROBLOSECURITY" \
  "https://adconfiguration.roblox.com/v2/sponsored-campaigns/multi-get-can-user-sponsor?campaignTargetType={VALUE}&campaignTargetIds={VALUE}"
```

### POST `/v2/sponsored-campaigns/stop` [EXPERIMENTAL]

Stops a sponsored campaign / ad (ad set) from running. Initiated by a user.

**Server:** `https://adconfiguration.roblox.com`

**Auth:** Cookie (`.ROBLOSECURITY`)

**Request Body:** `application/json` — Type: `Roblox.AdConfiguration.Api.Models.StopSponsoredCampaignRequest`

See [Roblox.AdConfiguration.Api.Models.StopSponsoredCampaignRequest](#roblox-adconfiguration-api-models-stopsponsoredcampaignrequest) in Models.

**Request example:**
```json
{
  "adSetId": 0
}
```

**Responses:**

- `200`: OK → `integer`
- `400`: 10: Insufficient permissions. 14: Invalid ad set id. 31: Internal server error
- `401`: 0: Authorization has been denied for this request.
- `403`: 0: Token Validation Failed
- `503`: 1: This feature is disabled.

**Error handling:** `401`: Check that your API key/token is valid and not expired. `403`: Verify your API key has the required scopes listed above. 

**Example:**
```bash
curl -X POST -b ".ROBLOSECURITY=$ROBLOSECURITY" \
  "https://adconfiguration.roblox.com/v2/sponsored-campaigns/stop" \
  -H "Content-Type: application/json" \
  -d '{
  "adSetId": 0
}'
```

### GET `/v2/sponsored-games` [EXPERIMENTAL]

Gets a page of Roblox.AdConfiguration.Api.SponsoredGameV2Model with specified input parameters.

**Server:** `https://adconfiguration.roblox.com`

**Auth:** Cookie (`.ROBLOSECURITY`)

**Parameters:**

| Name | In | Type | Required | Description |
|------|-----|------|----------|-------------|
| `universeId` | query | `integer` | Yes | The universe id of the ad campaign. |
| `includeReportingStats` | query | `boolean` | No | Indicates whether to include reporting stats in the response. |
| `isArchived` | query | `boolean` | No | Indicates whether to retrieve archived ads. |
| `pageCursor` | query | `string` | No | The cursor of the page to retrieve. |

**Responses:**

- `200`: OK → `Roblox.AdConfiguration.Api.GetSponsoredGamesResponse`
- `400`: 9: Cannot load the universe for the specified universe id. 9: Cannot load the universe for the specified universe id.
- `401`: 0: Authorization has been denied for this request.
- `503`: 1: This feature is disabled.

**Response fields** (`Roblox.AdConfiguration.Api.GetSponsoredGamesResponse`)

See [Roblox.AdConfiguration.Api.GetSponsoredGamesResponse](#roblox-adconfiguration-api-getsponsoredgamesresponse) in Models.

**Response example:**
```json
{
  "sponsoredGames": [
    {
      "adId": "...",
      "adSetId": "...",
      "adName": "...",
      "adStatus": "...",
      "creativeType": "...",
      "creativeTargetId": "..."
    }
  ],
  "previousPageCursor": "string",
  "nextPageCursor": "string"
}
```

**Error handling:** `401`: Check that your API key/token is valid and not expired. 

**Example:**
```bash
curl -b ".ROBLOSECURITY=$ROBLOSECURITY" \
  "https://adconfiguration.roblox.com/v2/sponsored-games?universeId={VALUE}"
```

### POST `/v2/sponsored-games/create` [EXPERIMENTAL]

Creates a new sponsored game ad with specified input parameters.

**Server:** `https://adconfiguration.roblox.com`

**Auth:** Cookie (`.ROBLOSECURITY`)

**Request Body:** `application/json` — Type: `Roblox.AdConfiguration.Api.CreateSponsoredGameV2Request`

See [Roblox.AdConfiguration.Api.CreateSponsoredGameV2Request](#roblox-adconfiguration-api-createsponsoredgamev2request) in Models.

**Request example:**
```json
{
  "universeId": 0,
  "targetGender": 1,
  "targetAgeBracket": 1,
  "budgetInRobux": 0,
  "startDate": "2024-01-01T00:00:00Z",
  "endDate": "2024-01-01T00:00:00Z"
}
```

**Responses:**

- `200`: OK → `Roblox.Web.WebAPI.ApiEmptyResponseModel`
- `400`: 2: Daily budget is lower than minimum allowed. 3: Total budget must be greater than 0. 4: Ad name cannot be empty. 5: Start date must not be a future date. 6: End date must be a future date. 7: Start date must be earlier than end date. 8: Total budget does not match daily spend and number of days being scheduled 9: Cannot load the universe for the specified universe id. 11: Invalid target age bracket. 12: Invalid target gender. 13: Invalid target device type. 14: Invalid ad set id. 15: Ad name cannot exceed 255 characters. 16: Insufficient Robux balance. 17: Name has already been taken. 18: Daily budget is higher than maximum allowed. 19: Invalid group id. 20: Number of days scheduled exceeded maximum days allowed. 21: Your experience is currently not eligible for advertising. 22: Invalid campaign target ID. 23: Invalid campaign target type. 24: Invalid creative ID. 25: Invalid creative type. 28: Total budget must be campaign duration * daily bid 29: The target is not eligible for new campaigns 30: Invalid user ID
- `401`: 0: Authorization has been denied for this request. 10: Insufficient permissions.
- `403`: 0: Token Validation Failed
- `500`: 0: An unknown error occurred. 31: Internal server error
- `503`: 1: This feature is disabled.

**Response fields** (`Roblox.Web.WebAPI.ApiEmptyResponseModel`)

See [Roblox.Web.WebAPI.ApiEmptyResponseModel](#roblox-web-webapi-apiemptyresponsemodel) in Models.

**Error handling:** `401`: Check that your API key/token is valid and not expired. `403`: Verify your API key has the required scopes listed above. 

**Example:**
```bash
curl -X POST -b ".ROBLOSECURITY=$ROBLOSECURITY" \
  "https://adconfiguration.roblox.com/v2/sponsored-games/create" \
  -H "Content-Type: application/json" \
  -d '{
  "universeId": 0,
  "targetGender": 1,
  "targetAgeBracket": 1,
  "budgetInRobux": 0,
  "startDate": "2024-01-01T00:00:00Z",
  "endDate": "2024-01-01T00:00:00Z"
}'
```

### POST `/v2/sponsored-games/stop` [EXPERIMENTAL]

To stop a sponsored-game ad (ad set) from running, initiated by a user.

**Server:** `https://adconfiguration.roblox.com`

**Auth:** Cookie (`.ROBLOSECURITY`)

**Request Body:** `application/json` — Type: `Roblox.AdConfiguration.Api.Models.StopSponsoredGameV2Request`

See [Roblox.AdConfiguration.Api.Models.StopSponsoredGameV2Request](#roblox-adconfiguration-api-models-stopsponsoredgamev2request) in Models.

**Request example:**
```json
{
  "adSetId": 0
}
```

**Responses:**

- `200`: OK → `Roblox.Web.WebAPI.ApiEmptyResponseModel`
- `400`: 14: Invalid ad set id.
- `401`: 0: Authorization has been denied for this request.
- `403`: 0: Token Validation Failed 10: Insufficient permissions.
- `503`: 1: This feature is disabled.

**Response fields** (`Roblox.Web.WebAPI.ApiEmptyResponseModel`)

See [Roblox.Web.WebAPI.ApiEmptyResponseModel](#roblox-web-webapi-apiemptyresponsemodel) in Models.

**Error handling:** `401`: Check that your API key/token is valid and not expired. `403`: Verify your API key has the required scopes listed above. 

**Example:**
```bash
curl -X POST -b ".ROBLOSECURITY=$ROBLOSECURITY" \
  "https://adconfiguration.roblox.com/v2/sponsored-games/stop" \
  -H "Content-Type: application/json" \
  -d '{
  "adSetId": 0
}'
```

### GET `/v2/sponsored-games/universes` [EXPERIMENTAL]

Gets a list of universes for the authenticated user, or the given group, ordered by most recently created sponsored game ads.

**Server:** `https://adconfiguration.roblox.com`

**Auth:** Cookie (`.ROBLOSECURITY`)

**Parameters:**

| Name | In | Type | Required | Description |
|------|-----|------|----------|-------------|
| `groupId` | query | `integer` | No | The group id, if applicable. |

**Responses:**

- `200`: OK → `Roblox.AdConfiguration.Api.Models.GetRecentAdsRankedUniversesResponse`
- `400`: 19: Invalid group id.
- `401`: 0: Authorization has been denied for this request.
- `403`: 10: Insufficient permissions.

**Response fields** (`Roblox.AdConfiguration.Api.Models.GetRecentAdsRankedUniversesResponse`)

See [Roblox.AdConfiguration.Api.Models.GetRecentAdsRankedUniversesResponse](#roblox-adconfiguration-api-models-getrecentadsrankeduniversesresponse) in Models.

**Response example:**
```json
{
  "universes": [
    {
      "id": "...",
      "name": "..."
    }
  ]
}
```

**Error handling:** `401`: Check that your API key/token is valid and not expired. `403`: Verify your API key has the required scopes listed above. 

**Example:**
```bash
curl -b ".ROBLOSECURITY=$ROBLOSECURITY" \
  "https://adconfiguration.roblox.com/v2/sponsored-games/universes"
```

### POST `/v2/tracking/click`

Records an ad click.

**Server:** `https://adconfiguration.roblox.com`

**Auth:** Cookie (`.ROBLOSECURITY`)

**Request Body:** `application/json` — Type: `Roblox.AdConfiguration.Api.RecordClickRequest`

See [Roblox.AdConfiguration.Api.RecordClickRequest](#roblox-adconfiguration-api-recordclickrequest) in Models.

**Request example:**
```json
{
  "encryptedAdTrackingData": "string",
  "campaignTargetType": 0,
  "placementLocation": 1,
  "adTrackingData": "string"
}
```

**Responses:**

- `200`: OK → `Roblox.Web.WebAPI.ApiEmptyResponseModel`
- `401`: 0: Authorization has been denied for this request.
- `403`: 0: Token Validation Failed

**Response fields** (`Roblox.Web.WebAPI.ApiEmptyResponseModel`)

See [Roblox.Web.WebAPI.ApiEmptyResponseModel](#roblox-web-webapi-apiemptyresponsemodel) in Models.

**Error handling:** `401`: Check that your API key/token is valid and not expired. `403`: Verify your API key has the required scopes listed above. 

**Example:**
```bash
curl -X POST -b ".ROBLOSECURITY=$ROBLOSECURITY" \
  "https://adconfiguration.roblox.com/v2/tracking/click" \
  -H "Content-Type: application/json" \
  -d '{
  "encryptedAdTrackingData": "string",
  "campaignTargetType": 0,
  "placementLocation": 1,
  "adTrackingData": "string"
}'
```

## Models

### ListAdvertisableUniversesResponse

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `advertisableUniverses` | `AdvertisableUniverse[]` | Yes | The complete set of experiences the caller can advertise. This endpoint is not paginated; the full list is returned in one response. |

### ErrorEnvelope

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `detail` | `string` | Yes | A human-readable explanation of this specific failure. |
| `errors` | `PublicError[]` | Yes | The individual errors. There is at least one entry; each has a code and message. |
| `status` | `integer` | Yes | The HTTP status code, repeated here for convenience. |
| `title` | `string` | Yes | A short summary of the error class. |

### AudienceEstimateRequest

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `campaignContext` | `PlanningCampaignContext` | Yes | The proposed campaign to estimate the reachable audience for. |

### AudienceEstimateResponse

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `lowerBound` | `integer` | Yes | Estimated lower bound of reachable users. |
| `upperBound` | `integer` | Yes | Estimated upper bound of reachable users. |

### ListBillingAccountsResponse

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `billingAccounts` | `BillingAccount[]` | No | The page of billing accounts. |
| `nextPageToken` | `string` | No | The cursor for the next page. Pass it as pageToken to fetch the next page. Absent on the last page. |

### BillingAccount

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `adCreditBalanceMicros` | `string` | No | Available ad credit balance in micro-USD, as a decimal string. |
| `createTime` | `string` | No | The time the account was created, as an RFC 3339 UTC timestamp. |
| `creator` | `Creator` | No | The user or group that created the account. |
| `displayName` | `string` | No | The human-readable name of the account. |
| `failedPaymentBalanceMicros` | `string` | No | Total of failed credit card charges in micro-USD, as a decimal string. |
| `id` | `string` | No | The unique identifier of the billing account. Use it as the {id} path parameter. |
| `limits` | `BillingAccountLimits` | No | Credit card limits for the account. They don't apply to ADS_CREDIT or INVOICE campaigns. |
| `organizationId` | `string` | No | The identifier of the organization that owns the account. |
| `outstandingBalanceMicros` | `string` | No | Unbilled credit card spend in micro-USD, as a decimal string. |
| `paymentMethods` | `PaymentMethod[]` | No | Masked payment methods on file. Read-only; cards are added and updated in Ads Manager. |
| `paymentSetupUrl` | `string` | No | Ads Manager page to add a payment method, buy ad credit, or resolve a failed payment. On a READY account it is informational: offer it, but do not stop for it. When paymentStatus is ACTION_REQUIRED or PAST_DUE, show it to the user and check again after they say they are done. Omitted when no setup applies and for disabled accounts. Never collect payment details through the API or in chat. |
| `paymentStatus` | `READY \| ACTION_REQUIRED \| PAST_DUE \| DISABLED` | No | Whether the account can fund a new campaign. Can be `READY`, `ACTION_REQUIRED`, `PAST_DUE`, or `DISABLED`. READY means at least one payment type in supportedPaymentTypes can fund a campaign. ACTION_REQUIRED means no payment type can. PAST_DUE means a card payment failed or a failed charge is unpaid; create succeeds only with a payment type listed in supportedPaymentTypes, which can be empty. DISABLED accounts list no payment types. |
| `paymentStatusReason` | `NO_PAYMENT_METHOD \| PROFILE_NOT_VERIFIED \| TRANSACTION_FAILURE \| ACCOUNT_DISABLED` | No | Machine-readable reason for a paymentStatus other than READY. NO_PAYMENT_METHOD means that no payment type can fund a campaign: no usable card and no usable ad credit. A group's account can pay only with ad credit, so for a group it means the ad credit balance is below the minimum daily budget; buy ad credit with paymentSetupUrl. PROFILE_NOT_VERIFIED means the same, but a card exists and needs verification. |
| `status` | `ACTIVE \| DISABLED \| ARCHIVED` | No | The current state of the account. Can be `ACTIVE`, `DISABLED`, or `ARCHIVED`. |
| `supportedPaymentTypes` | `CREDIT_CARD \| ADS_CREDIT \| INVOICE[]` | No | Campaign payment types that can fund a new campaign now. CREDIT_CARD needs a verified card and a daily spend limit (limits.maximumDailyBudgetMicros) of at least the minimum daily budget. ADS_CREDIT needs activated ad credit with a balance of at least the minimum daily budget. Create also checks that the ad credit balance covers the campaign's daily budget. Group accounts can use only ADS_CREDIT. |
| `timeZone` | `string` | No | The IANA time zone the account's reporting dates and budget schedules are interpreted in. Example: `America/Los_Angeles`. |
| `type` | `SELF_SERVICE \| MANAGED \| INTERNAL` | No | The account category. External advertisers are always SELF_SERVICE; MANAGED and INTERNAL are Roblox-operated accounts. Can be `SELF_SERVICE`, `MANAGED`, or `INTERNAL`. |
| `updateTime` | `string` | No | The time the account was last updated, as an RFC 3339 UTC timestamp. |

### PreviewAdCreditConversionRequest

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `adCreditAmountMicros` | `string` | No | Ad credit wanted, at most cent precision; the preview returns the Robux it costs. |
| `robuxAmount` | `string` | No | Robux to spend; the preview returns the ad credit it buys. |

### AdCreditConversionPreview

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `adCreditAmountMicros` | `string` | Yes | Ad credit that would be granted, in micro-USD. |
| `effectiveO18Robux` | `string` | No | Portion of robuxAmount drawn from 18+ eligible Robux, which converts at the higher rate first. |
| `effectiveStandardRobux` | `string` | No | Portion of robuxAmount drawn from standard Robux. |
| `reason` | `Reason` | No | Why valid is false. Omitted when valid. |
| `robuxAmount` | `string` | Yes | Robux that would be charged. |
| `tierBreakdown` | `AdCreditConversionTierBreakdown[]` | No | One entry per rate tier used, in the order Robux are drawn. |
| `valid` | `boolean` | Yes | False when the account can't afford the amount or it's outside the allowed range. |

### ListPaymentActivitiesResponse

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `activities` | `PaymentActivity[]` | Yes | Payment activities for the selected scope; REFUND returns the complete time range. |
| `nextPageToken` | `string` | No | Opaque cursor for the next page of CHARGE or AD_CREDIT. Absent on the last page and for REFUND. |

### CampaignOptionsResponse

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `adFormats` | `AdFormat[]` | No | The recommended creative image sizes, in pixels. Images in other sizes are accepted, but these sizes fit the tile best. |
| `billingAccounts` | `BillingAccountOption[]` | No | The billing accounts you can create a campaign for this experience in: your own, then the owning group's for a group-owned experience. Pass one as billingAccountId when creating the campaign. |
| `budgetConstraints` | `BudgetConstraint[]` | No | The minimum budget per budget type. Without universeId, also includes the personal account's maximum daily budget for CREDIT_CARD. With universeId, read maximumDailyBudgetMicros on the selected billing account. |
| `creativeRequirements` | `CreativeRequirements` | No | The creative count and asset type constraints for create. |
| `eligibility` | `PublicUniverseEligibility` | No | The eligibility result for the requested experience. Present only when universeId was supplied in the request. |
| `mutableFields` | `string[]` | No | The campaign fields accepted by UpdateCampaign. Lists `video` only when the video of a campaign can be changed. |
| `objectiveOptions` | `ObjectiveOption[]` | No | Per-objective availability and targeting support. Filtered to the objective query parameter when supplied. |
| `objectives` | `PLAYS \| ENGAGEMENT \| ROBUX_SPEND[]` | No | The campaign objectives you can create. Values can be `PLAYS`, `ENGAGEMENT`, or `ROBUX_SPEND`. objectiveOptions tells you whether each one is available for the experience. |
| `paymentTypes` | `CREDIT_CARD \| ADS_CREDIT \| INVOICE[]` | No | The payment types a campaign may choose. Values can be `CREDIT_CARD`, `ADS_CREDIT`, or `INVOICE`. With universeId, the payment types at least one of billingAccounts can use now; empty when there are none. Without universeId, this is a static menu based on the caller's account type. It does not check card setup, ad credit activation, or balance; supply universeId for that. |
| `targetingDimensions` | `TargetingDimensions` | No |  |
| `video` | `VideoOptions` | No | The sponsored video tile capability. Omitted when sponsored video tiles aren't enabled for the advertising context. With universeId, present when at least one of billingAccounts allows video. |

### CampaignRecommendationRequest

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `campaignContext` | `PlanningCampaignContext` | Yes | The experience and targeting.audienceType influence the result. Other targeting fields are not accepted. |

### CampaignRecommendationResponse

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `budgetOptionsMicros` | `string[]` | Yes | A lower, the recommended, and a higher daily budget in micro-USD, as decimal strings in ascending order. |
| `budgetType` | `DAILY` | Yes | Recommendations are always daily budgets. |
| `durationOptionsInDays` | `integer[]` | Yes | Suggested campaign lengths for a duration picker, in ascending order. |
| `recommendedBudgetMicros` | `string` | Yes | The suggested daily budget in micro-USD, as a decimal string. Always one of budgetOptionsMicros. |

### ListCampaignsResponse

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `campaigns` | `Campaign[]` | No | The page of campaigns. |
| `nextPageToken` | `string` | No | The cursor for the next page. Pass it as pageToken to fetch the next page. Absent on the last page. |

### Campaign

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `autoReloadAdCreditEnabled` | `boolean` | No | Whether ad credit is reloaded automatically when it runs low. |
| `billingAccountId` | `string` | No | The billing account that owns and funds the campaign. |
| `budget` | `Budget` | No |  |
| `createTime` | `string` | No | The time the campaign was created, as an RFC 3339 UTC timestamp. |
| `creativeAssetIds` | `string[]` | No | The Roblox image asset IDs the campaign advertises, as decimal strings. These are the same values as Creative.assetId. |
| `creator` | `Creator` | No | The user who created the campaign (read-only). |
| `deliveryStatus` | `SERVING \| IN_REVIEW \| NOT_SERVING \| REJECTED` | No | The current serving state, derived by the system (read-only). Can be `SERVING`, `IN_REVIEW`, `NOT_SERVING`, or `REJECTED`. |
| `deliveryStatusReasons` | `string enum (14 values)[]` | No | The reasons behind the current deliveryStatus, such as why a campaign is not serving or was rejected, or `LEARNING` while a serving campaign ramps up. Omitted when there are none. Values: SCHEDULED, INSUFFICIENT_AD_CREDIT, PAUSED, INACTIVE, COMPLETED, EXPIRED, CANCELLED, MODERATED, CLICK_BAIT, GAME_FILTERED, PRIVATE, PLACE_JOIN_RESTRICTED, LEARNING, QPP_AUTO_PAUSED |
| `id` | `string` | No | The server-assigned unique identifier of the campaign. |
| `name` | `string` | No | The display name of the campaign. |
| `objective` | `string enum (7 values)` | No | The advertising goal of the campaign. `PLAYS` or `ENGAGEMENT` for campaigns created via this API; campaigns from other surfaces may report `AWARENESS`, `REACH`, `VIDEO_VIEWS`, `ROBUX_SPEND`, or `HIGH_VALUE_ACTION`. Values: PLAYS, ENGAGEMENT, AWARENESS, REACH, VIDEO_VIEWS, ROBUX_SPEND, HIGH_VALUE_ACTION |
| `paymentType` | `CREDIT_CARD \| ADS_CREDIT \| INVOICE` | No | How the campaign is paid for. Fixed when the campaign is created. Can be `CREDIT_CARD`, `ADS_CREDIT`, or `INVOICE`. |
| `schedule` | `Schedule` | No |  |
| `status` | `ACTIVE \| PAUSED \| CANCELLED` | No | The lifecycle state you control through update requests. Can be `ACTIVE`, `PAUSED`, or `CANCELLED`. `CANCELLED` is permanent. |
| `targetUniverseId` | `string` | No | The identifier of the experience the campaign advertises. |
| `targeting` | `Targeting` | No |  |
| `updateTime` | `string` | No | The time the campaign was last updated, as an RFC 3339 UTC timestamp. |
| `video` | `CampaignVideo` | No | The campaign's video setting, applied to every ad. Omitted for campaigns created before the setting existed. |

### ListCampaignAdsResponse

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `ads` | `CampaignAd[]` | Yes | The page of campaign ads. |
| `nextPageToken` | `string` | No | The cursor for the next page. Pass it as pageToken to fetch the next page. Absent on the last page. |

### CampaignAd

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `creativeAssetId` | `string` | Yes | The Roblox image asset ID this ad serves, as a decimal string. This is the same value as Creative.assetId. |
| `deliveryStatus` | `SERVING \| IN_REVIEW \| NOT_SERVING \| REJECTED` | Yes | Per-ad serving state (`SERVING`, `IN_REVIEW`, `NOT_SERVING`, or `REJECTED`). |
| `id` | `string` | Yes | Stable ad ID; matches the ad ID in analytics-query-api. |
| `removeTime` | `string` | No | Set when status is `REMOVED`, as an RFC 3339 UTC timestamp. |
| `reviewIssues` | `Reason[]` | No | Structured review issues, when applicable. |
| `reviewStatus` | `IN_REVIEW \| APPROVED \| REJECTED` | Yes | Combined result of the creative's review and the experience's review (`IN_REVIEW`, `APPROVED`, or `REJECTED`). |
| `status` | `ACTIVE \| PAUSED \| REMOVED` | Yes | Lifecycle intent for this ad (`ACTIVE`, `PAUSED`, or `REMOVED`). |

### UpdateCampaignAdRequest

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `status` | `ACTIVE \| PAUSED` | Yes | Target lifecycle status (`ACTIVE` or `PAUSED`). |

### UpdateCampaignRequest

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `autoReloadAdCreditEnabled` | `boolean` | No | Turns automatic ad credit reload on or off. |
| `budget` | `UpdateBudget` | No | A budget change. Only the amount is mutable; the budget type is fixed at creation, so it is not part of this object. Sending `type` returns 400. |
| `creativeAssetIds` | `string[]` | No | New assets are appended to the campaign. Existing asset IDs are ignored. These are Roblox asset IDs, the same values as Creative.assetId. |
| `name` | `string` | No | A new display name for the campaign. |
| `schedule` | `UpdateSchedule` | No | A partial schedule change. Allowed only before the campaign starts. |
| `status` | `ACTIVE \| PAUSED \| CANCELLED` | No | A lifecycle transition: `ACTIVE` to run or resume, `PAUSED` to pause, or `CANCELLED` to cancel permanently. |
| `targeting` | `Targeting` | No | Immutable; including it returns 400. |
| `video` | `CampaignVideo` | No | A new video setting for every ad. Allowed sources are listed by campaign-options `video.sources`. Every ad is updated before the response returns. |

### BatchGetStatusRequest

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `campaignIds` | `string[]` | Yes | The campaign IDs to look up. Required. At most 100 per request. |

### BatchGetStatusResponse

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `failures` | `CampaignIDFailure[]` | No | The IDs that could not be resolved. Omitted when every ID resolved. |
| `statuses` | `CampaignStatus[]` | No | One entry per successfully resolved campaign. |

### ValidateCampaignResponse

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `errors` | `PublicError[]` | Yes | The errors CreateCampaign would return for this request, in the same order. Empty when valid. |
| `resolvedBillingAccountId` | `string` | No | The billing account the campaign would be created in. |
| `valid` | `boolean` | Yes | Whether CreateCampaign would accept this request. |
| `warnings` | `Reason[]` | Yes | Non-blocking notes about the request. |

### ListCreativesResponse

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `creatives` | `Creative[]` | No | The page of creatives. |
| `nextPageToken` | `string` | No | The cursor for the next page. Pass it as pageToken to fetch the next page. Absent on the last page. |

### CreateCreativeRequest

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `assetId` | `string` | Yes | The Roblox image asset ID to save to the selected ads account, as a decimal string. groupId selects the group ads account; absent groupId selects the personal ads account. |
| `universeId` | `string` | No | Optional experience to associate the creative with, as a decimal string. |

### Creative

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `assetId` | `string` | No | The Roblox asset ID identifying this creative, as a decimal string. Use this assetId in GET and PATCH /creatives/{id}, not the registration UUID in id. groupId selects the group ads account; absent groupId selects the personal ads account. |
| `assetName` | `string` | No | The display name of the underlying asset. |
| `assetType` | `IMAGE` | No | The media type of the asset. Only `IMAGE` is supported. |
| `billingAccountId` | `string` | No | The billing account whose library holds this entry. |
| `createTime` | `string` | No | The time the creative was added to the library, as an RFC 3339 UTC timestamp. |
| `height` | `integer` | No | The height of the asset in pixels. Omitted when unknown. |
| `id` | `string` | No | The UUID identifying this creative registration. GET and PATCH paths use assetId, not this UUID. |
| `isArchived` | `boolean` | No | Whether the creative has been archived (soft-deleted). |
| `moderationStatus` | `PENDING_REVIEW \| APPROVED \| REJECTED` | No | The content-review outcome for the asset. Can be `PENDING_REVIEW`, `APPROVED`, or `REJECTED`. |
| `source` | `UPLOAD \| IN_HOUSE_GEN_AI` | No | How the asset was produced. Can be `UPLOAD` or `IN_HOUSE_GEN_AI`. |
| `universeId` | `string` | No | The identifier of the experience the creative is associated with, if any, as a decimal string. Omitted when not associated with an experience. |
| `updateTime` | `string` | No | The time the creative was last updated, as an RFC 3339 UTC timestamp. |
| `width` | `integer` | No | The width of the asset in pixels. Omitted when unknown. |

### UpdateCreativeRequest

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `isArchived` | `boolean` | No | Archive or unarchive the creative. Archiving must be the only field and requires no enabled ad to use the asset. |
| `universeId` | `string` | No | Set the associated experience, or use null to clear it. Omit to keep it unchanged. |

### PerformanceEstimateRequest

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `campaignContext` | `PerformanceEstimateCampaignContext` | Yes |  |
| `forecastInput` | `PerformanceEstimateForecastInput` | Yes |  |
| `forecastScope` | `PerformanceEstimateScope` | Yes |  |

### PerformanceEstimateResponse

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `budget` | `PerformanceEstimateBudget` | No |  |
| `derivedMetrics` | `PerformanceEstimateDerivedMetrics` | No |  |
| `outcome` | `PerformanceEstimateOutcome` | No |  |
| `predicted` | `OUTCOME \| BUDGET` | No | Which side was calculated: OUTCOME from a budget, or BUDGET from a target outcome. |

### Roblox.Ads.Api.RecordClickRequest

A request model for an ad click.

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `encryptedAdTrackingData` | `string` | No | The encrypted tracking data |
| `campaignTargetType` | `0 \| 1 \| 2 \| 3` | No | The campaign target type ['Undefined' = 0, 'Universe' = 1, 'Asset' = 2, 'ImmersiveAd' = 3] |
| `placementLocation` | `integer enum (8 values)` | No | The placement location ['Undefined' = 1, 'GameSort' = 2, 'AvatarShop' = 4, 'ItemDetails' = 8, 'HomePage' = 16, 'Billboard300x250' = 32, 'Billboard600x300' = 64, 'Billboard300x600' = 128] Values: 1, 2, 4, 8, 16, 32, 64, 128 |

### Roblox.Web.WebAPI.Models.ApiArrayResponse_Roblox.Ads.Api.Models.Response.SponsoredPageResponse_

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `data` | `Roblox.Ads.Api.Models.Response.SponsoredPageResponse[]` | No |  |

### Roblox.Ads.Api.Models.Response.CreateSponsoredItemCampaignResponse

The response model for serving a sponsored game.

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `creatorTargetId` | `integer` | No | Id of the universe that is being sponsored. |
| `creatorType` | `string` | No | Type of the creator. |
| `creatorName` | `string` | No | Name of the creator. |

### Roblox.AdConfiguration.Api.GetSponsoredCampaignsResponse

A response model for retrieving a page of Roblox.AdConfiguration.Api.SponsoredCampaignModel.

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `sponsoredCampaigns` | `Roblox.AdConfiguration.Api.SponsoredCampaignModel[]` | No | A collection of Roblox.AdConfiguration.Api.SponsoredCampaignModel. |
| `previousPageCursor` | `string` | No | The cursor for retrieving the previous page, if present. |
| `nextPageCursor` | `string` | No | The cursor for retrieving the next page, if present. |

### Roblox.AdConfiguration.Api.Models.CreateSponsoredCampaignRequest

A request model for creating a sponsored game

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `campaignTargetId` | `integer` | No | The ID of the campaign target |
| `campaignTargetType` | `0 \| 1 \| 2 \| 3` | No | The type of the campaign target ['Undefined' = 0, 'Universe' = 1, 'Asset' = 2, 'ImmersiveAd' = 3] |
| `targetGender` | `1 \| 2 \| 4` | No | Targeting gender(s) of the ad set ['Undefined' = 1, 'Male' = 2, 'Female' = 4] |
| `targetAgeBracket` | `1 \| 2 \| 4 \| 8 \| 16` | No | Targeting age bracket(s) of the ad set ['Undefined' = 1, 'AgeUnder13' = 2, 'Age13OrOver' = 4, 'Age13To16' = 8, 'Age17OrOver' = 16] |
| `startDate` | `string` | No | The start date of the ad set |
| `endDate` | `string` | No | The end date of the ad set |
| `targetDeviceType` | `integer enum (6 values)` | No | Targeting device type(s) of the ad set ['Undefined' = 1, 'Computer' = 2, 'Phone' = 4, 'Tablet' = 8, 'Console' = 16, 'VR' = 32] Values: 1, 2, 4, 8, 16, 32 |
| `campaignName` | `string` | No | The name of the Campaign / Ad |
| `dailyBidAmountInRobux` | `integer` | No | The daily bid amount for the campaign / ad, in Robux |
| `placementLocation` | `integer enum (8 values)` | No | The location to place the campaign ['Undefined' = 1, 'GameSort' = 2, 'AvatarShop' = 4, 'ItemDetails' = 8, 'HomePage' = 16, 'Billboard300x250' = 32, 'Billboard600x300' = 64, 'Billboard300x600' = 128] Values: 1, 2, 4, 8, 16, 32, 64, 128 |
| `creativeModel` | `Roblox.AdConfiguration.Api.CreativeModel` | No |  |

### Roblox.AdConfiguration.Api.Models.GetEligibleCampaignTargetsRequest

A model represents a request to stop a sponsored campaign / ad.

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `campaignTargetTypes` | `0 \| 1 \| 2 \| 3[]` | No | The list of campaign types we want to include in the results |
| `groupId` | `integer` | No | The group id, if applicable. |

### Roblox.AdConfiguration.Api.Models.GetCampaignTargetsResponse

The response model which returns a collection of Roblox.AdConfiguration.Api.Models.CampaignTargetModel

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `campaignTargetModels` | `Roblox.AdConfiguration.Api.Models.CampaignTargetModel[]` | No | Gets or sets a collection of Roblox.AdConfiguration.Api.Models.CampaignTargetModel |

### Roblox.AdConfiguration.Api.Models.StopSponsoredCampaignRequest

A model represents a request to stop a sponsored campaign / ad.

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `adSetId` | `integer` | No | The ID of the ad set to stop. |

### Roblox.AdConfiguration.Api.GetSponsoredGamesResponse

A response model for retrieving a page of Roblox.AdConfiguration.Api.SponsoredGameV2Model.

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `sponsoredGames` | `Roblox.AdConfiguration.Api.SponsoredGameV2Model[]` | No | A collection of Roblox.AdConfiguration.Api.SponsoredGameV2Model. |
| `previousPageCursor` | `string` | No | The cursor for retrieving the previous page, if present. |
| `nextPageCursor` | `string` | No | The cursor for retrieving the next page, if present. |

### Roblox.AdConfiguration.Api.CreateSponsoredGameV2Request

A request model for creating a sponsored game

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `universeId` | `integer` | No | The target universe id |
| `targetGender` | `1 \| 2 \| 4` | No | Targeting gender(s) of the ad set ['Undefined' = 1, 'Male' = 2, 'Female' = 4] |
| `targetAgeBracket` | `1 \| 2 \| 4 \| 8 \| 16` | No | Targeting age bracket(s) of the ad set ['Undefined' = 1, 'AgeUnder13' = 2, 'Age13OrOver' = 4, 'Age13To16' = 8, 'Age17OrOver' = 16] |
| `budgetInRobux` | `integer` | No | The budget in Robux |
| `startDate` | `string` | No | The start date of the ad set |
| `endDate` | `string` | No | The end date of the ad set |
| `targetDeviceType` | `integer enum (6 values)` | No | Targeting device type(s) of the ad set ['Undefined' = 1, 'Computer' = 2, 'Phone' = 4, 'Tablet' = 8, 'Console' = 16, 'VR' = 32] Values: 1, 2, 4, 8, 16, 32 |
| `adName` | `string` | No | The name of the Ad |
| `bidAmountInRobux` | `integer` | No | The bid amount of the Ad in Robux |

### Roblox.AdConfiguration.Api.Models.StopSponsoredGameV2Request

A model represents a request to stop a sponsored game ad.

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `adSetId` | `integer` | No | Gets the ID of the ad set to stop. |

### Roblox.AdConfiguration.Api.Models.GetRecentAdsRankedUniversesResponse

The response model for getting a list of recent-ads-ranked universes.

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `universes` | `Roblox.AdConfiguration.Api.Models.UniverseModel[]` | No | Gets or sets a list of Roblox.AdConfiguration.Api.Models.UniverseModel. |

### Roblox.AdConfiguration.Api.RecordClickRequest

A request model for an ad click.

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `encryptedAdTrackingData` | `string` | No | The encrypted tracking data. IsRequired will be set to false temporarily until AdTrackingData is removed. |
| `campaignTargetType` | `0 \| 1 \| 2 \| 3` | No | The campaign target type ['Undefined' = 0, 'Universe' = 1, 'Asset' = 2, 'ImmersiveAd' = 3] |
| `placementLocation` | `integer enum (8 values)` | No | The placement location ['Undefined' = 1, 'GameSort' = 2, 'AvatarShop' = 4, 'ItemDetails' = 8, 'HomePage' = 16, 'Billboard300x250' = 32, 'Billboard600x300' = 64, 'Billboard300x600' = 128] Values: 1, 2, 4, 8, 16, 32, 64, 128 |
| `adTrackingData` | `string` | No | DO NOT USE. This field is temporary. Will be removed. |

### Roblox.AdConfiguration.Api.Models.UniverseModel

Represents a universe in API endpoint results.

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `id` | `integer` | No | The universe Id. |
| `name` | `string` | No | The name of the universe |

### Roblox.AdConfiguration.Api.SponsoredGameV2Model

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

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `adId` | `integer` | No | The id of the ad |
| `adSetId` | `integer` | No | The id of the ad set |
| `adName` | `string` | No | The name of the Ad |
| `adStatus` | `0 \| 1 \| 2 \| 3 \| 4` | No | The status of the ad ['Undefined' = 0, 'Draft' = 1, 'PendingApproval' = 2, 'Approved' = 3, 'Moderated' = 4] |
| `creativeType` | `0 \| 1 \| 2` | No | The type of the creative associated with the Ad ['Undefined' = 0, 'Image' = 1, 'Video' = 2] |
| `creativeTargetId` | `integer` | No | The target id of the creative associated with the Ad |
| `creativeUrl` | `string` | No | The Url of the creative |
| `bidAmountInRobux` | `integer` | No | The bid amount of the Ad in Robux |
| `budgetInRobux` | `integer` | No | The budget of the ad set in Robux |
| `adSetStatus` | `integer enum (7 values)` | No | The status of the ad set ['Undefined' = 0, 'Draft' = 1, 'Scheduled' = 2, 'Running' = 3, 'Paused' = 4, 'Stopped' = 5, 'Completed' = 6] Values: 0, 1, 2, 3, 4, 5, 6 |
| `startDate` | `string` | No | The start date of the ad set |
| `endDate` | `string` | No | The end date of the ad set |
| `targetGender` | `1 \| 2 \| 4` | No | The target gender of the ad set ['Undefined' = 1, 'Male' = 2, 'Female' = 4] |
| `targetAgeBracket` | `1 \| 2 \| 4 \| 8 \| 16` | No | The target age bracket of the ad set ['Undefined' = 1, 'AgeUnder13' = 2, 'Age13OrOver' = 4, 'Age13To16' = 8, 'Age17OrOver' = 16] |
| `targetDeviceType` | `integer enum (6 values)` | No | The target device type of the ad set ['Undefined' = 1, 'Computer' = 2, 'Phone' = 4, 'Tablet' = 8, 'Console' = 16, 'VR' = 32] Values: 1, 2, 4, 8, 16, 32 |
| `campaignTargetType` | `0 \| 1 \| 2 \| 3` | No | The target type of the campaign ['Undefined' = 0, 'Universe' = 1, 'Asset' = 2, 'ImmersiveAd' = 3] |
| `campaignTargetId` | `integer` | No | The target id of the campaign |
| `totalSpendInRobux` | `integer` | No | The total spend of the ad set in Robux |
| `totalImpressions` | `integer` | No | The total number of impressions generated by the ad |
| `totalClicks` | `integer` | No | The total number of clicks generated by the ad |
| `totalConversions` | `integer` | No | The total number of conversions generated by the ad |
| `impressionConversions` | `integer` | No | The number of conversions by ad impression generated by the ad |
| `clickConversions` | `integer` | No | The number of conversions by ad click generated by the ad |

### Roblox.AdConfiguration.Api.Models.CampaignTargetModel

Represents a sponsored ad campaign target

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `campaignTargetType` | `0 \| 1 \| 2 \| 3` | No | The campaign target type ['Undefined' = 0, 'Universe' = 1, 'Asset' = 2, 'ImmersiveAd' = 3] |
| `campaignTargetId` | `integer` | No | The ID of the campaign target |
| `name` | `string` | No | The name of the campaign target (i.e. the asset name, universe name, group name, etc.) |

### Roblox.AdConfiguration.Api.CreativeModel

A model representing an Ad Creative (for example, an ad thumbnail).

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `creativeId` | `integer` | No | The ID of the creative. Typically, a thumbnail's imageId. |
| `creativeType` | `0 \| 1 \| 2` | No | The type of the ad creative. Typically, CreativeType.Image. ['Undefined' = 0, 'Image' = 1, 'Video' = 2] |

### Roblox.AdConfiguration.Api.SponsoredCampaignModel

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

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `adId` | `integer` | No | The id of the ad |
| `adSetId` | `integer` | No | The id of the ad set |
| `adName` | `string` | No | The name of the Ad |
| `adStatus` | `0 \| 1 \| 2 \| 3 \| 4` | No | The status of the ad ['Undefined' = 0, 'Draft' = 1, 'PendingApproval' = 2, 'Approved' = 3, 'Moderated' = 4] |
| `creativeType` | `0 \| 1 \| 2` | No | The type of the creative associated with the Ad ['Undefined' = 0, 'Image' = 1, 'Video' = 2] |
| `creativeTargetId` | `integer` | No | The target id of the creative associated with the Ad |
| `bidAmountInRobux` | `integer` | No | The bid amount of the Ad in Robux |
| `budgetInRobux` | `integer` | No | The budget of the ad set in Robux |
| `adSetStatus` | `integer enum (7 values)` | No | The status of the ad set ['Undefined' = 0, 'Draft' = 1, 'Scheduled' = 2, 'Running' = 3, 'Paused' = 4, 'Stopped' = 5, 'Completed' = 6] Values: 0, 1, 2, 3, 4, 5, 6 |
| `startDate` | `string` | No | The start date of the ad set |
| `endDate` | `string` | No | The end date of the ad set |
| `targetGender` | `1 \| 2 \| 4` | No | The target gender of the ad set ['Undefined' = 1, 'Male' = 2, 'Female' = 4] |
| `targetAgeBracket` | `1 \| 2 \| 4 \| 8 \| 16` | No | The target age bracket of the ad set ['Undefined' = 1, 'AgeUnder13' = 2, 'Age13OrOver' = 4, 'Age13To16' = 8, 'Age17OrOver' = 16] |
| `targetDeviceType` | `integer enum (6 values)` | No | The target device type of the ad set ['Undefined' = 1, 'Computer' = 2, 'Phone' = 4, 'Tablet' = 8, 'Console' = 16, 'VR' = 32] Values: 1, 2, 4, 8, 16, 32 |
| `campaignTargetType` | `0 \| 1 \| 2 \| 3` | No | The target type of the campaign ['Undefined' = 0, 'Universe' = 1, 'Asset' = 2, 'ImmersiveAd' = 3] |
| `campaignTargetId` | `integer` | No | The target id of the campaign |
| `totalSpendInRobux` | `integer` | No | The total spend of the ad set in Robux |
| `totalImpressions` | `integer` | No | The total number of impressions generated by the ad |
| `totalClicks` | `integer` | No | The total number of clicks generated by the ad |
| `totalConversions` | `integer` | No | The total number of conversions generated by the ad |
| `impressionConversions` | `integer` | No | The number of conversions by ad impression generated by the ad |
| `clickConversions` | `integer` | No | The number of conversions by ad click generated by the ad |

### Roblox.Ads.Api.Models.Response.SponsoredPageResponse

The response model for serving a sponsored game.

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `name` | `string` | No | The name of the sponsored page. |
| `title` | `string` | No | The title of the sponsored page. |
| `logoImageUrl` | `string` | No | The logo image hash of the sponsored page. |
| `pageType` | `0 \| 1` | No | The type of the sponsored page. ['Event' = 0, 'Sponsored' = 1] |
| `pagePath` | `string` | No | The path of the sponsored page. |

### PerformanceEstimateBudget

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `dailyAmountMicroUsd` | `string` | No | Daily budget in micro-USD, as a decimal string. |
| `dailyAmountMicroUsdRange` | `PerformanceEstimateMoneyRange` | No | Optional range around the daily budget. |
| `lifetimeAmountMicroUsd` | `string` | No | Lifetime budget in micro-USD, as a decimal string. Omitted for a daily budget. |
| `lifetimeAmountMicroUsdRange` | `PerformanceEstimateMoneyRange` | No | Optional range around the lifetime budget. Omitted for a daily budget. |

### PerformanceEstimateDerivedMetrics

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `costPerOutcomeMicroUsd` | `string` | No | Cost per outcome in micro-USD, as a decimal string. |
| `costPerOutcomeMicroUsdRange` | `PerformanceEstimateMoneyRange` | No | Optional range around the cost per outcome. |

### PerformanceEstimateOutcome

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `dailyValue` | `integer` | No | Daily outcome. |
| `dailyValueRange` | `PerformanceEstimateValueRange` | No | Optional range around the daily outcome. |
| `lifetimeValue` | `integer` | No | Lifetime outcome. Omitted for a daily budget. |
| `lifetimeValueRange` | `PerformanceEstimateValueRange` | No | Optional range around the lifetime outcome. Omitted for a daily budget. |
| `outcomeType` | `PLAYS` | No | The outcome measured. Always PLAYS. |

### PerformanceEstimateValueRange

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `lowerBound` | `integer` | No | Inclusive lower bound. |
| `upperBound` | `integer` | No | Inclusive upper bound. |

### PerformanceEstimateMoneyRange

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `lowerBound` | `string` | No | Inclusive lower bound in micro-USD, as a decimal string. |
| `upperBound` | `string` | No | Inclusive upper bound in micro-USD, as a decimal string. |

### PerformanceEstimateCampaignContext

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `objective` | `PLAYS` | Yes | The advertising goal. Only PLAYS is supported. |
| `targetUniverseId` | `string` | Yes | The experience to estimate, as a decimal string. |

### PerformanceEstimateForecastInput

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `budget` | `PerformanceEstimateBudgetInput` | No | Set to estimate the outcome this budget delivers. |
| `targetOutcome` | `PerformanceEstimateTargetOutcome` | No | Set to estimate the budget needed to reach this outcome. |

### PerformanceEstimateScope

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `budgetType` | `DAILY \| LIFETIME` | Yes | DAILY or LIFETIME. |
| `durationInDays` | `integer` | No | Required and positive for LIFETIME. Must be 0 for DAILY. |

### PerformanceEstimateBudgetInput

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `amountMicroUsd` | `string` | No | Daily or lifetime total, matching forecastScope.budgetType, in micro-USD as a decimal string. |

### PerformanceEstimateTargetOutcome

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `outcomeType` | `PLAYS` | No | The outcome to reach. Only PLAYS is supported. |
| `value` | `integer` | No | Daily or lifetime total, matching forecastScope.budgetType. |

### PublicError

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `actionUrl` | `string` | No | Ads Manager page that a human opens to fix this error. Show this URL to the user and check again after they say they are done. Never collect payment details through the API or in chat. |
| `code` | `string` | Yes | A stable, machine-readable error code (for example, `INVALID_ARGUMENT`, `NOT_FOUND`, `PERMISSION_DENIED`, or `RATE_LIMITED`). |
| `field` | `string` | No | Request field path, when the error is tied to a specific field. |
| `message` | `string` | Yes | A human-readable description of the error. |
| `reason` | `string` | No | Specific machine-readable sub-reason, when applicable. |
| `remediation` | `string` | No | Actionable guidance for resolving the error. |
| `retryable` | `boolean` | No | Whether the caller should retry the request. |

### Reason

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `code` | `string` | Yes | A stable, machine-readable code. |
| `message` | `string` | Yes | A human-readable explanation. |
| `remediation` | `string` | No | What the caller can do to resolve it. |
| `resource` | `string` | No | The related resource, for example `billing-accounts/123`. |

### CampaignIDFailure

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `id` | `string` | No | The campaign ID that could not be resolved. |
| `reason` | `NOT_FOUND` | No | Why the ID could not be resolved. `NOT_FOUND` means the campaign does not exist or the caller can't manage it. |

### CampaignStatus

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `deliveryStatus` | `SERVING \| IN_REVIEW \| NOT_SERVING \| REJECTED` | No | The current serving state. Can be `SERVING`, `IN_REVIEW`, `NOT_SERVING`, or `REJECTED`. |
| `deliveryStatusReasons` | `string enum (14 values)[]` | No | The reasons behind the current deliveryStatus. Omitted when there are none. Values: SCHEDULED, INSUFFICIENT_AD_CREDIT, PAUSED, INACTIVE, COMPLETED, EXPIRED, CANCELLED, MODERATED, CLICK_BAIT, GAME_FILTERED, PRIVATE, PLACE_JOIN_RESTRICTED, LEARNING, QPP_AUTO_PAUSED |
| `id` | `string` | No | The campaign identifier. |
| `status` | `ACTIVE \| PAUSED \| CANCELLED` | No | The lifecycle state. Can be `ACTIVE`, `PAUSED`, or `CANCELLED`. |

### UpdateBudget

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `amountMicros` | `string` | Yes | The new budget amount in micro-USD, as a decimal string (for example, `5000000` = $5.00). Money is sent as a string so large values keep full precision in every client. Must be a numeric string of micro-USD. Uses the same payment-specific limits as Budget.amountMicros: ADS_CREDIT budgets are checked against the available ad credit balance after unbilled spend. maximumDailyBudgetMicros does not limit ADS_CREDIT or INVOICE campaigns. |

### UpdateSchedule

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `durationInDays` | `integer` | No | The new duration from startTime, in days. Zero means the campaign has no end date. |
| `endTime` | `string` | No | End time is read-only and is rejected when supplied in a request. |
| `startTime` | `string` | No | The new campaign start time, as an RFC 3339 timestamp. UTC (`Z`) is recommended. |

### Targeting

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `ageGroups` | `AGE_13_17 \| AGE_18_24 \| AGE_25_PLUS[]` | No | The age brackets to deliver to. Empty means all ages. Values can be `AGE_13_17`, `AGE_18_24`, or `AGE_25_PLUS`. |
| `audienceType` | `ALL_PLAYERS \| NEW_USERS \| RETENTION \| REACTIVATION` | No | Omitted or `ALL_PLAYERS` delivers to all players. Other values restrict delivery to a retargeting audience of the target experience. For `ENGAGEMENT`, only omission or `ALL_PLAYERS` is accepted; other targeting fields are rejected. Responses always include the resolved value. |
| `countries` | `string[]` | No | The ISO 3166-1 alpha-2 country codes to deliver to (for example, `US`). Empty means all countries. Use this field to target single countries. Can't be combined with the region `ALL`, or with the region that contains the country. |
| `devices` | `PHONE \| TABLET \| DESKTOP \| CONSOLE[]` | No | The device types to deliver to. Empty means all devices. Values can be `PHONE`, `TABLET`, `DESKTOP`, or `CONSOLE`. |
| `regions` | `string enum (11 values)[]` | No | The aggregate geographic regions to deliver to, or `ALL`. Empty means all regions. Use only the values in campaign-options `targetingDimensions.regions`. `ALL` can't be combined with other regions or with countries. Values: ALL, WESTERN_EUROPE, EASTERN_EUROPE, EAST_ASIA, SOUTHEAST_ASIA, MIDDLE_EAST, LATIN_AMERICA, AFRICA, ANZ, ROW, UAC |

### CampaignVideo

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `previewVideoAssetId` | `string` | No | When source is `PREVIEW_VIDEO`, the experience's current preview video asset ID, as a decimal string (read-only). Omitted when the experience has no eligible preview video, in which case the tile shows the image creative. Also omitted when sponsored video tiles aren't enabled for the campaign's billing account. |
| `source` | `IMAGE_ONLY \| PREVIEW_VIDEO` | Yes | The video shown on the sponsored tile. Values can be `IMAGE_ONLY` or `PREVIEW_VIDEO`. |

### Budget

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `amountMicros` | `string` | Yes | The budget amount in micro-USD, as a decimal string (for example, `5000000` = $5.00). Money is sent and returned as a string so large values keep full precision in every client. On a request it must be a numeric string of micro-USD. For ADS_CREDIT, the daily budget must not exceed the available ad credit balance after unbilled spend. For LIFETIME, compare amountMicros divided by the number of campaign days with that balance. maximumDailyBudgetMicros does not limit ADS_CREDIT or INVOICE campaigns. |
| `scheduledAmountMicros` | `string` | No | The queued lower budget for a pending decrease, in micro-USD as a decimal string (same format as amountMicros). A budget increase takes effect immediately, but a decrease on a running campaign is applied at the next midnight in the account's time zone; until then the campaign keeps serving on amountMicros (the current, higher budget). Omitted when no decrease is pending. |
| `scheduledEffectiveTime` | `string` | No | The time a pending budget decrease takes effect, as an RFC 3339 UTC timestamp. Omitted when no decrease is pending. |
| `type` | `DAILY \| LIFETIME` | Yes | The budget cadence. Fixed when the campaign is created. Can be `DAILY` or `LIFETIME`. |

### Creator

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `groupId` | `string` | No | The creator group's ID. |
| `userId` | `string` | No | The creator user's ID. |

### Schedule

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `durationInDays` | `integer` | Yes | How long the campaign runs from startTime, in days. Must not exceed 3650 (about 10 years). Zero means the campaign has no end date and runs until you pause or cancel it; endTime is then omitted. A LIFETIME budget needs an end date, so it needs a positive value. |
| `endTime` | `string` | No | The instant the campaign stops, as an RFC 3339 UTC timestamp (read-only): one second before local midnight at the end of day durationInDays in the account's time zone. Not accepted on requests; supplying it returns 400. Use durationInDays to set when the campaign ends. |
| `startTime` | `string` | Yes | The time the campaign starts serving, as an RFC 3339 timestamp. UTC (`Z`) is recommended. On a create request it must not be in the past. |

### PlanningCampaignContext

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `objective` | `PLAYS \| ENGAGEMENT \| ROBUX_SPEND` | Yes | The advertising goal. Can be `PLAYS`, `ENGAGEMENT`, or `ROBUX_SPEND`. |
| `targetUniverseId` | `string` | Yes | The experience to plan for, as a decimal string. |
| `targeting` | `Targeting` | No | Optional proposed targeting. audience-estimates accepts the same targeting as campaign creation. campaign-recommendations accepts only audienceType. |

### AdFormat

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `format` | `string` | No | The creative asset type, for example `IMAGE`. |
| `height` | `integer` | No | The format height in pixels. |
| `width` | `integer` | No | The format width in pixels. |

### BillingAccountOption

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `creator` | `Creator` | Yes | The user or group that created the account. |
| `displayName` | `string` | Yes | The human-readable name of the account. |
| `id` | `string` | Yes | The billing account ID. Pass it as billingAccountId when creating a campaign. |
| `maximumDailyBudgetMicros` | `string` | No | The maximum daily budget for CREDIT_CARD campaigns in this account, in micro-USD. A non-positive value means no positive CREDIT_CARD budget is allowed. For LIFETIME, multiply by the schedule's number of days. Omitted when no verified card bills the account. Returned even when it is too low for CREDIT_CARD to be usable. Does not limit ADS_CREDIT or INVOICE campaigns. |
| `paymentSetupUrl` | `string` | No | Ads Manager page to add a payment method, buy ad credit, or resolve a failed payment. Informational on a READY account. Same as on GET /billing-accounts/{id}. Never collect payment details in chat. |
| `paymentStatus` | `READY \| ACTION_REQUIRED \| PAST_DUE \| DISABLED` | No | Whether the account can fund a new campaign: READY, ACTION_REQUIRED, PAST_DUE, or DISABLED. Same as on GET /billing-accounts/{id}. |
| `paymentStatusReason` | `NO_PAYMENT_METHOD \| PROFILE_NOT_VERIFIED \| TRANSACTION_FAILURE \| ACCOUNT_DISABLED` | No | Reason for a paymentStatus other than READY. Same as on GET /billing-accounts/{id}. For a group's account, NO_PAYMENT_METHOD means that its ad credit balance is too low, not that a payment method is missing. |
| `paymentTypes` | `CREDIT_CARD \| ADS_CREDIT \| INVOICE[]` | Yes | The payment types that can fund a new campaign in this account now. This matches supportedPaymentTypes on GET /billing-accounts/{id}: CREDIT_CARD needs a verified card and a daily spend limit of at least the minimum daily budget, ADS_CREDIT needs activated ad credit with at least the minimum daily budget, and a group's account can use only ADS_CREDIT. `INVOICE` is for a managed account. |
| `status` | `ACTIVE \| DISABLED \| ARCHIVED` | Yes | The current state of the account. Can be `ACTIVE`, `DISABLED`, or `ARCHIVED`. |
| `type` | `SELF_SERVICE \| MANAGED \| INTERNAL` | Yes | The account category. Can be `SELF_SERVICE`, `MANAGED`, or `INTERNAL`. |

### BudgetConstraint

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `budgetType` | `DAILY \| LIFETIME` | Yes | The budget type. Values can be `DAILY` or `LIFETIME`. |
| `maximumAmountMicros` | `string` | No | The personal account's maximum DAILY budget for CREDIT_CARD, in micro-USD. Omitted for other payment types and when universeId is supplied. |
| `maximumDurationInDays` | `integer` | No | The longest schedule allowed, in days. |
| `minimumAmountMicros` | `string` | Yes | The minimum budget in micro-USD, as a decimal string. For `LIFETIME`, this is the minimum per day of the schedule. |

### CreativeRequirements

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `acceptedAssetTypes` | `IMAGE[]` | No | The creative asset types accepted. Values can be `IMAGE`. |
| `maximumCount` | `integer` | No | The most creatives a campaign can have. |
| `minimumCount` | `integer` | No | The fewest creatives a campaign can have. |

### PublicUniverseEligibility

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `details` | `Reason[]` | No | Structured reasons with remediation, one per entry in reasons. |
| `eligible` | `boolean` | No | Whether the experience can currently be advertised. |
| `reasons` | `NO_PERMISSION \| BLOCKED \| OBJECTIVE_NOT_SUPPORTED[]` | No | The reasons the experience is not eligible. Omitted when eligible. Values can be `NO_PERMISSION`, `BLOCKED`, or `OBJECTIVE_NOT_SUPPORTED`. `OBJECTIVE_NOT_SUPPORTED` appears only with the objective query parameter, when the experience can't use that objective. |
| `universeId` | `string` | No | The identifier of the experience that was checked. |

### ObjectiveOption

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `audienceTypes` | `ALL_PLAYERS \| NEW_USERS \| RETENTION \| REACTIVATION[]` | Yes | Accepted targeting.audienceType values. Only ALL_PLAYERS for ENGAGEMENT, which rejects targeting restrictions. |
| `available` | `boolean` | Yes | Whether the objective can currently be used. |
| `objective` | `PLAYS \| ENGAGEMENT \| ROBUX_SPEND` | Yes | The objective. Values can be `PLAYS`, `ENGAGEMENT`, or `ROBUX_SPEND`. |
| `supportsTargeting` | `boolean` | Yes | Whether create accepts targeting restrictions for this objective. False only for `ENGAGEMENT`. |
| `unavailableReasons` | `Reason[]` | No | Why the objective is unavailable. Present only when available is false. |

### TargetingDimensions

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `ageGroups` | `AGE_13_17 \| AGE_18_24 \| AGE_25_PLUS[]` | No | The selectable age brackets. Values can be `AGE_13_17`, `AGE_18_24`, or `AGE_25_PLUS`. |
| `countries` | `string[]` | No | The selectable ISO 3166-1 alpha-2 country codes (for example, `US`). |
| `devices` | `PHONE \| TABLET \| DESKTOP \| CONSOLE[]` | No | The selectable device types. Values can be `PHONE`, `TABLET`, `DESKTOP`, or `CONSOLE`. |
| `regions` | `string enum (11 values)[]` | No | The selectable geographic regions: `ALL` and the aggregate region codes. To target a single country, use countries. Values: ALL, WESTERN_EUROPE, EASTERN_EUROPE, EAST_ASIA, SOUTHEAST_ASIA, MIDDLE_EAST, LATIN_AMERICA, AFRICA, ANZ, ROW, UAC |

### VideoOptions

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `previewVideo` | `PreviewVideo` | No | Whether the experience has a preview video. Present only when universeId was supplied. |
| `sources` | `IMAGE_ONLY \| PREVIEW_VIDEO[]` | Yes | The values accepted in `CampaignVideo.source`. Values can be `IMAGE_ONLY` or `PREVIEW_VIDEO`. |

### PreviewVideo

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `available` | `boolean` | Yes | Whether the experience has a preview video eligible to be shown. |
| `videoAssetId` | `string` | No | The preview video's asset ID, as a decimal string. Present only when available is true. |

### PaymentActivity

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `actorUserId` | `string` | No | Roblox user who initiated the AD_CREDIT transaction, when available, for user and group accounts. |
| `adCreditTransactionType` | `string enum (6 values)` | No | Source transaction type for AD_CREDIT rows. The broader type remains available. Values: DEPOSIT, AUTO_DEPOSIT, DEBIT, REFUND, ADJUSTMENT, PROMOTION |
| `amountMicros` | `string` | Yes | Amount actually charged, refunded, granted, or spent, in micro-USD. |
| `campaignId` | `string` | No | Associated campaign ID, when applicable. |
| `campaignName` | `string` | No | Associated campaign name, present when campaignId is set. |
| `cardLastFourDigits` | `string` | No | Last four digits of the card used (`CHARGE` and `REFUND` only). |
| `chargeTime` | `string` | No | Latest associated card charge settlement timestamp as an RFC 3339 UTC string, when available (`CHARGE` only). |
| `createTime` | `string` | Yes | Creation timestamp as an RFC 3339 UTC string. |
| `currencyCode` | `string` | No | ISO 4217 currency of the card charge (`CHARGE` and `REFUND` only). |
| `description` | `string` | No | Optional human-readable description. |
| `id` | `string` | No | Stable payment identifier, when available. Absent for requests without a payment identifier. |
| `o18RobuxAmount` | `string` | No | Portion of robuxAmount debited from 18+ eligible Robux (`ROBUX_CONVERSION` only). |
| `requestAmountMicros` | `string` | No | Amount originally requested, in micro-USD (`CHARGE` and `REFUND` only). |
| `robuxAmount` | `string` | No | Total Robux debited (`ROBUX_CONVERSION` only). |
| `state` | `PENDING \| SUCCEEDED \| FAILED \| REVERSED` | Yes | The settlement state (`PENDING`, `SUCCEEDED`, `FAILED`, or `REVERSED`). |
| `type` | `CHARGE \| REFUND \| AD_CREDIT_GRANT \| AD_CREDIT_SPEND \| ROBUX_CONVERSION` | Yes | The activity type (`CHARGE`, `REFUND`, `AD_CREDIT_GRANT`, `AD_CREDIT_SPEND`, or `ROBUX_CONVERSION`). |

### AdCreditConversionTierBreakdown

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `adCreditAmountMicros` | `string` | Yes | Ad credit granted from this tier, in micro-USD. |
| `adCreditPerRobux` | `number` | Yes | USD of ad credit per Robux in this tier. |
| `robuxAmount` | `string` | Yes | Robux converted in this tier. |
| `tier` | `O18_ELIGIBLE_ROBUX \| STANDARD_ROBUX` | Yes | Rate tier (`O18_ELIGIBLE_ROBUX` or `STANDARD_ROBUX`). |

### BillingAccountLimits

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `billingThresholdMicros` | `string` | No | Card billing threshold in micro-USD: when outstandingBalanceMicros reaches this amount, accrued charges are billed to the card on file. Applies only to CREDIT_CARD spend: ADS_CREDIT spends from the balance, and INVOICE accounts are billed monthly. Can be present before a card is on file. Omitted when the account has no threshold. |
| `maximumDailyBudgetMicros` | `string` | No | The maximum daily budget for CREDIT_CARD campaigns in this account, in micro-USD. A non-positive value means no positive CREDIT_CARD budget is allowed. For LIFETIME, multiply by the schedule's number of days. Omitted when no verified card bills the account. Returned even when it is too low for CREDIT_CARD to be usable. Does not limit ADS_CREDIT or INVOICE campaigns. |

### PaymentMethod

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `cardBrand` | `PaymentMethodCardBrand` | No | Normalized card brand; unrecognized networks use OTHER. Values: VISA, MASTERCARD, AMEX, DISCOVER, JCB, DINERS, UNIONPAY, OTHER |
| `displayLabel` | `string` | Yes | Masked human-readable label (for example, `Visa ending in 4242`). |
| `expirationMonth` | `integer` | No | Card expiration month (1-12). |
| `expirationYear` | `integer` | No | Card expiration year (four-digit year). |
| `id` | `string` | Yes | The payment method ID. |
| `lastFourDigits` | `string` | No | Last four digits of the card. |
| `status` | `ACTIVE \| ACTION_REQUIRED \| EXPIRED \| DISABLED` | Yes | The current status of the payment method. Can be `ACTIVE`, `ACTION_REQUIRED`, `EXPIRED`, or `DISABLED`. |
| `type` | `CARD \| INVOICE` | Yes | The payment method category. Can be `CARD` or `INVOICE`. |
| `verificationState` | `VERIFIED \| UNVERIFIED \| CHALLENGE_PENDING` | No | Card verification state, independent of expiration. |

### PaymentMethodCardBrand

Values: `VISA`, `MASTERCARD`, `AMEX`, `DISCOVER`, `JCB`, `DINERS`, `UNIONPAY`, `OTHER`

### AdvertisableUniverse

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `universeId` | `string` | Yes | The identifier of an experience the caller can advertise, as a decimal string. Resolve its name via the Open Cloud Universe API. |