ROroblox
Advertising

Get campaign options

Changed on

Returns the values accepted when creating a campaign: supported objectives, payment types, ad formats, and targeting dimensions. 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.

get/ads-management/v1/campaign-options

Request

  • Base URL
    https://apis.roblox.com
  • URL
    https://apis.roblox.com/ads-management/v1/campaign-options
  • Auth
    • API key in cookie .ROBLOSECURITY
    • or API key in header x-api-key
    • or OAuth 2
      Authorization code: https://apis.roblox.com/oauth/v1/authorize
      Token URL: https://apis.roblox.com/oauth/v1/token scopes: ad.campaign:read

Query parameters

universeIdstring

Universe ID to check eligibility for

objective'PLAYS' | 'ENGAGEMENT'

Objective filter (PLAYS or ENGAGEMENT)

Response

OK

objectivesstring[]

The campaign objectives you can create. Values can be PLAYS or ENGAGEMENT.

paymentTypesstring[]

The payment types available for the caller's account. Values can be CREDIT_CARD, ADS_CREDIT, or INVOICE.

Changes

  • 93616db823f3Revision changes
    • info

      added to the response property allOf list for the response status

    • info

      removed from the response property allOf list for the response status

  • 1454b4b32362Revision changes
    • info

      added to the response property allOf list for the response status

    • info

      removed from the response property allOf list for the response status