ROroblox
Advertising

Get a campaign

Changed on

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 is not owned by the caller.

get/ads-management/v1/campaigns/{id}

Request

  • Base URL
    https://apis.roblox.com
  • URL
    https://apis.roblox.com/ads-management/v1/campaigns/{id}
  • 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

Path parameters

idstring required

Campaign ID

Response

OK

billingAccountIdstring

The billing account that owns and funds the campaign.

createTimestring

The time the campaign was created, as an RFC 3339 UTC timestamp.

creativeAssetIdsstring[]

The Open Cloud image asset IDs the campaign advertises, as decimal strings.

deliveryStatus'SERVING' | 'IN_REVIEW' | 'NOT_SERVING' | 'REJECTED'

The current serving state, derived by the system (read-only). Can be SERVING, IN_REVIEW, NOT_SERVING, or REJECTED.

deliveryStatusReasonsstring[]

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.

idstring

The server-assigned unique identifier of the campaign.

namestring

The display name of the campaign.

objective'PLAYS' | 'ENGAGEMENT' | 'AWARENESS' | 'REACH' | 'VIDEO_VIEWS' | 'ROBUX_SPEND'

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, or ROBUX_SPEND.

paymentType'CREDIT_CARD' | 'ADS_CREDIT' | 'INVOICE'

How the campaign is paid for. Fixed when the campaign is created. Can be CREDIT_CARD, ADS_CREDIT, or INVOICE.

status'ACTIVE' | 'PAUSED' | 'CANCELLED'

The lifecycle state you control through update requests. Can be ACTIVE, PAUSED, or CANCELLED. CANCELLED is permanent.

targetUniverseIdstring

The identifier of the experience the campaign advertises.

updateTimestring

The time the campaign was last updated, as an RFC 3339 UTC timestamp.

Changes

  • 1454b4b32362Revision changes
    • warning

      added the new ENGAGEMENT enum value to the response property for the response status

    • info

      removed the ENGAGED_PLAYS enum value from the response property for the response status

  • 85e5f0ce799dRevision changes
    • warning

      added the new AWARENESS enum value to the response property for the response status

    • warning

      added the new ENGAGED_PLAYS enum value to the response property for the response status

    • warning

      added the new PLAYS enum value to the response property for the response status

    • warning

      added the new REACH enum value to the response property for the response status

    • warning

      added the new ROBUX_SPEND enum value to the response property for the response status

    • warning

      added the new VIDEO_VIEWS enum value to the response property for the response status

    • info

      removed the ENGAGEMENT enum value from the response property for the response status