Campaign
The Campaign object represents an advertising campaign in the Uber Ads platform.
¶ Properties
| Property | Type | Description |
|---|---|---|
campaign_id |
string | Unique campaign identifier |
name |
string | Campaign name |
created_at |
string | Creation timestamp (RFC 3339) |
updated_at |
string | Last update timestamp (RFC 3339) |
created_by_email |
string | Email of user who created the campaign |
updated_by_email |
string | Email of user who last updated the campaign |
budget |
Budget | Budget configuration for the campaign |
ad_groups |
list | Summary of ad groups in this campaign |
configured_status |
string | Status configured by the user |
effective_status |
string | Status representing deliverability of the campaign |
effective_status_reasons |
array[string] | Reasons why the campaign is not eligible to be served |
version |
integer | Version number of the campaign |
¶ Configured Status Values
| Value | Description |
|---|---|
CAMPAIGN_CONFIGURED_STATUS_INVALID |
Invalid status |
CAMPAIGN_CONFIGURED_STATUS_DRAFT |
Campaign is in draft state |
CAMPAIGN_CONFIGURED_STATUS_ACTIVE |
Campaign is active and running |
CAMPAIGN_CONFIGURED_STATUS_PAUSED |
Campaign is paused by the user |
CAMPAIGN_CONFIGURED_STATUS_DELETED |
Campaign is deleted |
¶ Effective Status Values
| Value | Description |
|---|---|
CAMPAIGN_EFFECTIVE_STATUS_INVALID |
Invalid status |
CAMPAIGN_EFFECTIVE_STATUS_DRAFT |
Campaign is in draft state |
CAMPAIGN_EFFECTIVE_STATUS_SCHEDULED |
Campaign is scheduled to start |
CAMPAIGN_EFFECTIVE_STATUS_ACTIVE |
Campaign is active and serving ads |
CAMPAIGN_EFFECTIVE_STATUS_COMPLETED |
Campaign has completed |
CAMPAIGN_EFFECTIVE_STATUS_PAUSED |
Campaign is paused |
CAMPAIGN_EFFECTIVE_STATUS_DELETED |
Campaign is deleted |
CAMPAIGN_EFFECTIVE_STATUS_WITH_ISSUES |
Campaign has issues preventing delivery |