MuleSoft Connector for Facebook Ads

Build 21.0.7930

Campaigns

Query information about a Campaign or the Campaigns on a specific Ad Account. Accessing Campaign information requires the ads_read permission.

Table Specific Information

Campaigns in Facebook represent advertising campaigns that individual Ads or AdSets may be a part of.

Select

When querying campaigns, either the Id or Target must be used to filter results. The Target must be an ad account. For instance:

SELECT * FROM Campaigns WHERE Target = 'act_123456'

Columns

Name Type Description
ID [KEY] String The Id of Campaign.
Target String The target or Ad Account Id to get Campaigns.
Name String The name of the Campaign.
BuyingType String This field will help Facebook make future optimizations to delivery, pricing, and limits. All ad sets in this campaign must match the buying type.

The allowed values are AUCTION, FIXED_CPM, RESERVED.

ConfiguredStatus String If this status is PAUSED, all its active ad sets and ads will be paused and have an effective status CAMPAIGN_PAUSED. Prefer using 'status' instead of this.

The allowed values are ACTIVE, PAUSED, DELETED, ARCHIVED.

EffectiveStatus String The effective status of this campaign. For example, when all Ad Sets beneath the campaign are paused, the effective status is ADSET_PAUSED..

The allowed values are ACTIVE, PAUSED, DELETED, PENDING_REVIEW, DISAPPROVED, PREAPPROVED, PENDING_BILLING_INFO, CAMPAIGN_PAUSED, ARCHIVED, ADSET_PAUSED.

Status String If this status is PAUSED, all its active ad sets and ads will be paused and have an effective status CAMPAIGN_PAUSED. The field returns the same value as 'configured_status', and is the suggested one to use.

The allowed values are ACTIVE, PAUSED, DELETED, ARCHIVED.

CreatedTime Datetime When the campaign was created.
Objective String Objective of this ad campaign. If it is specified the API will validate that any ad groups created under the campaign match that objective.

The allowed values are CANVAS_APP_ENGAGEMENT, CANVAS_APP_INSTALLS, EVENT_RESPONSES, MOBILE_APP_ENGAGEMENT, MOBILE_APP_INSTALLS, NONE, OFFER_CLAIMS, PAGE_LIKES, POST_ENGAGEMENT, VIDEO_VIEWS, WEBSITE_CLICKS, WEBSITE_CONVERSIONS.

SpendCap Int A spend cap for the campaign, such that it will not spend more than this cap. Expressed as integer value of the subunit in your currency.
DailyBudget Int The daily budget of the campaign.
BudgetRemaining Int The remaining budget of the campaign.
LifetimeBudget Int The lifetime budget of the campaign.
BidStrategy String The bid strategy of the campaign. May be one of LOWEST_COST_WITHOUT_CAP, LOWEST_COST_WITH_BID_CAP, COST_CAP.
StartTime Datetime When the Campaign was started.
StopTime Datetime When the Campaign was stopped.
UpdatedTime Datetime When the Campaign was last updated.

Copyright (c) 2021 CData Software, Inc. - All rights reserved.
Build 21.0.7930