Ad campaigns

Create an ad campaign

fbads.campaign.add(name, campaign_status)

Add a new campaign to the ad account

Parameters:

• name (str) – Campaign name
• campaign_status (str) – CampaignStatus.ACTIVE or CampaignStatus.INACTIVE (from fbads.resources.campaign.CampaignStatus)

Return type:

An ad campaign ID (str)

Example:

from fbads import FBAds
from fbads.resources.campaign import CampaignStatus

api = FBAds(
    account_id='1233',
    access_token='token_with_ads_permission',
)

campaign_id = api.campaign.add(
    name=u'Testing campaign #001',
    campaign_status=CampaignStatus.ACTIVE,
)

print u'Campaign created with ID {0}'.format(campaign_id)

---

List campaigns

fbads.campaign.list([limit])

List all account campaigns.

Parameters:limit (int) – An optional limit Return type:list of CampaignResource

Example:

api = FBAds(
    account_id='1233',
    access_token='token_with_ads_permission',
)

for campaign in api.campaign.list(fields=['name'], limit=10):
    print campaign.name

---

Remove an ad campaign

fbads.campaign.delete(campaign_id)

Remove an ad campaign from the ad account

Parameters:campaign_id (long) – Campaign ID Return type:True

Example:

api = FBAds(
    account_id='1233',
    access_token='token_with_ads_permission',
)

print api.campaign.delete(123456787654321)  # returns True