API de Marketing

Orçamentos

Defina um orçamento diário ou total no nível do conjunto de anúncios. Os valores definidos para lance e orçamento estão no nível mínimo de denominação das moedas da conta de anúncios, como centavos por dólar americano. Os anúncios veiculados nesse conjunto não excederão o limite de gastos:

  • daily_budget : o valor médio que você se dispõe a usar em um conjunto de anúncios ou campanha a cada dia. Com o Gerenciador de Anúncios, você obterá um orçamento diário aproximado dos resultados que você otimizou para cada dia. No entanto, pode ser que, em alguns dias, oportunidades melhores sejam disponibilizadas. Nesses dias, podem ser gastos até 25% acima do orçamento diário. Por exemplo, se o orçamento diário for US$ 10,00, poderemos gastar até US$ 12,50 em um determinado dia.
  • orçamento total: o valor que você está disposto a gastar ao longo de todo o tempo de veiculação de um conjunto de anúncios ou de uma campanha. A menos que você altere suas configurações de veiculação, não cobraremos mais do que seu orçamento total para os resultados do seu conjunto de anúncios. Caso seu conjunto de anúncios esteja sendo veiculado por cinco dias e tenha um orçamento vitalício de US$ 250,00, é possível gastar US$ 50 por dia nos dois primeiros dias. No terceiro dia, se houver muitos resultados disponíveis, é possível gastar US$ 75. Então, se não houver muitas oportunidades disponíveis, é possível gastar U$ 25 no quarto dia e U$ 50 no quinto dia.

Para definir um orçamento diário de 20 dólares:

curl -X POST \
  -F 'name="My First Adset"' \
  -F 'daily_budget=2000' \
  -F 'start_time="2024-10-31T18:06:43-0700"' \
  -F 'end_time="2024-11-07T18:06:43-0800"' \
  -F 'campaign_id="<AD_CAMPAIGN_ID>"' \
  -F 'bid_amount=100' \
  -F 'billing_event="LINK_CLICKS"' \
  -F 'optimization_goal="LINK_CLICKS"' \
  -F 'targeting={
       "facebook_positions": [
         "feed"
       ],
       "geo_locations": {
         "countries": [
           "US"
         ]
       }
     }' \
  -F 'status="PAUSED"' \
  -F 'access_token=<ACCESS_TOKEN>' \
  https://graph.facebook.com/v21.0/act_<AD_ACCOUNT_ID>/adsets
Open In Graph API Explorer
'use strict';
const bizSdk = require('facebook-nodejs-business-sdk');
const AdAccount = bizSdk.AdAccount;
const AdSet = bizSdk.AdSet;

const access_token = '<ACCESS_TOKEN>';
const app_secret = '<APP_SECRET>';
const app_id = '<APP_ID>';
const id = '<AD_ACCOUNT_ID>';
const api = bizSdk.FacebookAdsApi.init(access_token);
const showDebugingInfo = true; // Setting this to true shows more debugging info.
if (showDebugingInfo) {
  api.setDebug(true);
}

const logApiCallResult = (apiCallName, data) => {
  console.log(apiCallName);
  if (showDebugingInfo) {
    console.log('Data:' + JSON.stringify(data));
  }
};

let fields, params;
fields = [
];
params = {
  'name' : 'My First Adset',
  'daily_budget' : '2000',
  'start_time' : '2024-07-29T17:54:47-0700',
  'end_time' : '2024-08-05T17:54:47-0700',
  'campaign_id' : '<adCampaignLinkClicksID>',
  'bid_amount' : '100',
  'billing_event' : 'LINK_CLICKS',
  'optimization_goal' : 'LINK_CLICKS',
  'targeting' : {'facebook_positions':['feed'],'geo_locations':{'countries':['US']}},
  'status' : 'PAUSED',
};
const adsets = (new AdAccount(id)).createAdSet(
  fields,
  params
);
logApiCallResult('adsets api call complete.', adsets);
Open In Graph API Explorer
require __DIR__ . '/vendor/autoload.php';

use FacebookAds\Object\AdAccount;
use FacebookAds\Object\AdSet;
use FacebookAds\Api;
use FacebookAds\Logger\CurlLogger;

$access_token = '<ACCESS_TOKEN>';
$app_secret = '<APP_SECRET>';
$app_id = '<APP_ID>';
$id = '<AD_ACCOUNT_ID>';

$api = Api::init($app_id, $app_secret, $access_token);
$api->setLogger(new CurlLogger());

$fields = array(
);
$params = array(
  'name' => 'My First Adset',
  'daily_budget' => '2000',
  'start_time' => '2024-07-29T17:54:47-0700',
  'end_time' => '2024-08-05T17:54:47-0700',
  'campaign_id' => '<adCampaignLinkClicksID>',
  'bid_amount' => '100',
  'billing_event' => 'LINK_CLICKS',
  'optimization_goal' => 'LINK_CLICKS',
  'targeting' => array('facebook_positions' => array('feed'),'geo_locations' => array('countries' => array('US'))),
  'status' => 'PAUSED',
);
echo json_encode((new AdAccount($id))->createAdSet(
  $fields,
  $params
)->exportAllData(), JSON_PRETTY_PRINT);
Open In Graph API Explorer
from facebook_business.adobjects.adaccount import AdAccount
from facebook_business.adobjects.adset import AdSet
from facebook_business.api import FacebookAdsApi

access_token = '<ACCESS_TOKEN>'
app_secret = '<APP_SECRET>'
app_id = '<APP_ID>'
id = '<AD_ACCOUNT_ID>'
FacebookAdsApi.init(access_token=access_token)

fields = [
]
params = {
  'name': 'My First Adset',
  'daily_budget': '2000',
  'start_time': '2024-07-29T17:54:47-0700',
  'end_time': '2024-08-05T17:54:47-0700',
  'campaign_id': '<adCampaignLinkClicksID>',
  'bid_amount': '100',
  'billing_event': 'LINK_CLICKS',
  'optimization_goal': 'LINK_CLICKS',
  'targeting': {'facebook_positions':['feed'],'geo_locations':{'countries':['US']}},
  'status': 'PAUSED',
}
print AdAccount(id).create_ad_set(
  fields=fields,
  params=params,
)
Open In Graph API Explorer
import com.facebook.ads.sdk.*;
import java.io.File;
import java.util.Arrays;

public class SAMPLE_CODE_EXAMPLE {
  public static void main (String args[]) throws APIException {

    String access_token = \"<ACCESS_TOKEN>\";
    String app_secret = \"<APP_SECRET>\";
    String app_id = \"<APP_ID>\";
    String id = \"<AD_ACCOUNT_ID>\";
    APIContext context = new APIContext(access_token).enableDebug(true);

    new AdAccount(id, context).createAdSet()
      .setName(\"My First Adset\")
      .setDailyBudget(2000L)
      .setStartTime(\"2024-07-29T17:54:47-0700\")
      .setEndTime(\"2024-08-05T17:54:47-0700\")
      .setCampaignId(\"<adCampaignLinkClicksID>\")
      .setBidAmount(100L)
      .setBillingEvent(AdSet.EnumBillingEvent.VALUE_LINK_CLICKS)
      .setOptimizationGoal(AdSet.EnumOptimizationGoal.VALUE_LINK_CLICKS)
      .setTargeting(
          new Targeting()
            .setFieldFacebookPositions(Arrays.asList(\"feed\"))
            .setFieldGeoLocations(
              new TargetingGeoLocation()
                .setFieldCountries(Arrays.asList(\"US\"))
            )
        )
      .setStatus(AdSet.EnumStatus.VALUE_PAUSED)
      .execute();

  }
}
Open In Graph API Explorer
require 'facebook_ads'

access_token = '<ACCESS_TOKEN>'
app_secret = '<APP_SECRET>'
app_id = '<APP_ID>'
id = '<AD_ACCOUNT_ID>'

FacebookAds.configure do |config|
  config.access_token = access_token
  config.app_secret = app_secret
end

ad_account = FacebookAds::AdAccount.get(id)
adsets = ad_account.adsets.create({
    name: 'My First Adset',
    daily_budget: '2000',
    start_time: '2024-07-29T17:54:47-0700',
    end_time: '2024-08-05T17:54:47-0700',
    campaign_id: '<adCampaignLinkClicksID>',
    bid_amount: '100',
    billing_event: 'LINK_CLICKS',
    optimization_goal: 'LINK_CLICKS',
    targeting: {'facebook_positions':['feed'],'geo_locations':{'countries':['US']}},
    status: 'PAUSED',
})
Open In Graph API Explorer

Para definir um orçamento total de 200 dólares em uma campanha que será veiculada por 10 dias:

curl -X POST \
  -F 'name="My First Adset"' \
  -F 'lifetime_budget=20000' \
  -F 'start_time="2024-10-31T18:06:43-0700"' \
  -F 'end_time="2024-11-10T18:06:43-0800"' \
  -F 'campaign_id="<AD_CAMPAIGN_ID>"' \
  -F 'bid_amount=100' \
  -F 'billing_event="LINK_CLICKS"' \
  -F 'optimization_goal="LINK_CLICKS"' \
  -F 'targeting={
       "facebook_positions": [
         "feed"
       ],
       "geo_locations": {
         "countries": [
           "US"
         ]
       },
       "publisher_platforms": [
         "facebook",
         "audience_network"
       ]
     }' \
  -F 'status="PAUSED"' \
  -F 'access_token=<ACCESS_TOKEN>' \
  https://graph.facebook.com/v21.0/act_<AD_ACCOUNT_ID>/adsets
Open In Graph API Explorer
'use strict';
const bizSdk = require('facebook-nodejs-business-sdk');
const AdAccount = bizSdk.AdAccount;
const AdSet = bizSdk.AdSet;

const access_token = '<ACCESS_TOKEN>';
const app_secret = '<APP_SECRET>';
const app_id = '<APP_ID>';
const id = '<AD_ACCOUNT_ID>';
const api = bizSdk.FacebookAdsApi.init(access_token);
const showDebugingInfo = true; // Setting this to true shows more debugging info.
if (showDebugingInfo) {
  api.setDebug(true);
}

const logApiCallResult = (apiCallName, data) => {
  console.log(apiCallName);
  if (showDebugingInfo) {
    console.log('Data:' + JSON.stringify(data));
  }
};

let fields, params;
fields = [
];
params = {
  'name' : 'My First Adset',
  'lifetime_budget' : '20000',
  'start_time' : '2024-07-29T17:54:57-0700',
  'end_time' : '2024-08-08T17:54:57-0700',
  'campaign_id' : '<adCampaignLinkClicksID>',
  'bid_amount' : '100',
  'billing_event' : 'LINK_CLICKS',
  'optimization_goal' : 'LINK_CLICKS',
  'targeting' : {'facebook_positions':['feed'],'geo_locations':{'countries':['US']},'publisher_platforms':['facebook','audience_network']},
  'status' : 'PAUSED',
};
const adsets = (new AdAccount(id)).createAdSet(
  fields,
  params
);
logApiCallResult('adsets api call complete.', adsets);
Open In Graph API Explorer
require __DIR__ . '/vendor/autoload.php';

use FacebookAds\Object\AdAccount;
use FacebookAds\Object\AdSet;
use FacebookAds\Api;
use FacebookAds\Logger\CurlLogger;

$access_token = '<ACCESS_TOKEN>';
$app_secret = '<APP_SECRET>';
$app_id = '<APP_ID>';
$id = '<AD_ACCOUNT_ID>';

$api = Api::init($app_id, $app_secret, $access_token);
$api->setLogger(new CurlLogger());

$fields = array(
);
$params = array(
  'name' => 'My First Adset',
  'lifetime_budget' => '20000',
  'start_time' => '2024-07-29T17:54:57-0700',
  'end_time' => '2024-08-08T17:54:57-0700',
  'campaign_id' => '<adCampaignLinkClicksID>',
  'bid_amount' => '100',
  'billing_event' => 'LINK_CLICKS',
  'optimization_goal' => 'LINK_CLICKS',
  'targeting' => array('facebook_positions' => array('feed'),'geo_locations' => array('countries' => array('US')),'publisher_platforms' => array('facebook','audience_network')),
  'status' => 'PAUSED',
);
echo json_encode((new AdAccount($id))->createAdSet(
  $fields,
  $params
)->exportAllData(), JSON_PRETTY_PRINT);
Open In Graph API Explorer
from facebook_business.adobjects.adaccount import AdAccount
from facebook_business.adobjects.adset import AdSet
from facebook_business.api import FacebookAdsApi

access_token = '<ACCESS_TOKEN>'
app_secret = '<APP_SECRET>'
app_id = '<APP_ID>'
id = '<AD_ACCOUNT_ID>'
FacebookAdsApi.init(access_token=access_token)

fields = [
]
params = {
  'name': 'My First Adset',
  'lifetime_budget': '20000',
  'start_time': '2024-07-29T17:54:57-0700',
  'end_time': '2024-08-08T17:54:57-0700',
  'campaign_id': '<adCampaignLinkClicksID>',
  'bid_amount': '100',
  'billing_event': 'LINK_CLICKS',
  'optimization_goal': 'LINK_CLICKS',
  'targeting': {'facebook_positions':['feed'],'geo_locations':{'countries':['US']},'publisher_platforms':['facebook','audience_network']},
  'status': 'PAUSED',
}
print AdAccount(id).create_ad_set(
  fields=fields,
  params=params,
)
Open In Graph API Explorer
import com.facebook.ads.sdk.*;
import java.io.File;
import java.util.Arrays;

public class SAMPLE_CODE_EXAMPLE {
  public static void main (String args[]) throws APIException {

    String access_token = \"<ACCESS_TOKEN>\";
    String app_secret = \"<APP_SECRET>\";
    String app_id = \"<APP_ID>\";
    String id = \"<AD_ACCOUNT_ID>\";
    APIContext context = new APIContext(access_token).enableDebug(true);

    new AdAccount(id, context).createAdSet()
      .setName(\"My First Adset\")
      .setLifetimeBudget(20000L)
      .setStartTime(\"2024-07-29T17:54:57-0700\")
      .setEndTime(\"2024-08-08T17:54:57-0700\")
      .setCampaignId(\"<adCampaignLinkClicksID>\")
      .setBidAmount(100L)
      .setBillingEvent(AdSet.EnumBillingEvent.VALUE_LINK_CLICKS)
      .setOptimizationGoal(AdSet.EnumOptimizationGoal.VALUE_LINK_CLICKS)
      .setTargeting(
          new Targeting()
            .setFieldFacebookPositions(Arrays.asList(\"feed\"))
            .setFieldGeoLocations(
              new TargetingGeoLocation()
                .setFieldCountries(Arrays.asList(\"US\"))
            )
            .setFieldPublisherPlatforms(Arrays.asList(\"facebook\", \"audience_network\"))
        )
      .setStatus(AdSet.EnumStatus.VALUE_PAUSED)
      .execute();

  }
}
Open In Graph API Explorer
require 'facebook_ads'

access_token = '<ACCESS_TOKEN>'
app_secret = '<APP_SECRET>'
app_id = '<APP_ID>'
id = '<AD_ACCOUNT_ID>'

FacebookAds.configure do |config|
  config.access_token = access_token
  config.app_secret = app_secret
end

ad_account = FacebookAds::AdAccount.get(id)
adsets = ad_account.adsets.create({
    name: 'My First Adset',
    lifetime_budget: '20000',
    start_time: '2024-07-29T17:54:57-0700',
    end_time: '2024-08-08T17:54:57-0700',
    campaign_id: '<adCampaignLinkClicksID>',
    bid_amount: '100',
    billing_event: 'LINK_CLICKS',
    optimization_goal: 'LINK_CLICKS',
    targeting: {'facebook_positions':['feed'],'geo_locations':{'countries':['US']},'publisher_platforms':['facebook','audience_network']},
    status: 'PAUSED',
})
Open In Graph API Explorer

Se você escolher a opção de orçamento diário, os gastos serão controlados a uma frequência diária. Já na opção de orçamento total, a regularidade de gastos será aplicada enquanto durar o conjunto de anúncios.

Saiba mais