Skip to content

Properties

idstring
required·

The unique identifier for the campaign.

account_idstring

The unique identifier for the account.

bid_strategyobject

The bid strategy for the campaign.

idstring

The unique identifier for the bid strategy.

namestring

The name of the bid strategy.

Possible values:
lowest_cost_without_caplowest_cost_with_bid_capcost_cap
budgetobject

The budget for the campaign.

daily_maxstring

The daily max budget for the campaign.

idstring

The unique identifier for the budget.

is_rebalance_enabledboolean

Whether budget rebalancing is enabled for the campaign.

is_scheduling_enabledboolean

Whether budget scheduling is enabled for the campaign.

is_sharedboolean

Whether the budget is shared for the campaign with other campaigns.

lifetime_maxstring

The max budget for the campaign.

remainingstring

The remaining budget for the campaign.

buying_typestring

The buying type for the campaign.

Possible values:
auctionreserved
created_atstring · date-time

The date and time the campaign was created.

labelsobject[]

The labels for the campaign.

idstring

The unique identifier for the label.

namestring

The name of the label.

namestring

The name of the campaign.

objectivestring

The objective of the campaign.

Possible values:
app_installsbrand_awarenessconversionsvisitsjob_applicationsevent_responseslead_generationlink_clickslocal_awarenessmessagesoffer_claimsoutcome_app_promotion+ 11 more
primary_attributionstring

The primary attribution for the campaign.

remote_dataRecord<string, any>

Raw data returned from the remote API call.

special_ad_categoriesstring[]

The special ad categories for the campaign.

Possible values:
creditemploymenthousingnonepoliticalsocial_issues
special_ad_categorystring

The special ad category for the campaign.

Possible values:
creditemploymenthousingnonepoliticalsocial_issues
spendobject

The spend for the campaign.

cap_enabledboolean

Whether the cap is enabled for the campaign.

max_capstring

The max cap spend for the campaign.

start_timestring · date-time

The start time for the campaign.

statusstring

The status of the campaign.

Possible values:
activeinactivedraftpauseddeletedarchivedin_processwith_issuescompletedcanceledpending_deletion
stop_timestring · date-time

The stop time for the campaign.

typestring

The type of the campaign

updated_atstring · date-time

The date and time the campaign was last updated.