campaigns

Get campaign delivery estimates

Get delivery estimates for an ads campaign

This endpoint is currently in beta and is not available to all apps Learn more.

post/ad_accounts/{ad_account_id}/campaigns/delivery_estimates

Path parameters

ad_account_idstring required

Unique identifier of an ad account.

Request body

budget_duration_type'FIXED_DAILY' | 'FLEXIBLE_DAILY' | 'LIFETIME' required

Budget duration type for delivery estimates.

daily_spend_capinteger

Campaign daily spend cap. When the budget_duration_type is FIXED_DAILY or FLEXIBLE_DAILY, this field is required.

end_datestring

End date of the date range for an ad campaign, pattern YYYY-MM-DD. Required when budget_duration_type is LIFETIME.

lifetime_spend_capinteger

Campaign total spending cap. When the budget_duration_type is LIFETIME, this field is required. The end date field is also required for lifetime spending.

objective_type'AWARENESS' | 'CONSIDERATION' | 'CATALOG_SALES' | 'WEB_CONVERSION' required

Objective type for delivery estimates.

start_datestring required

Start date of the date range for an ad campaign, pattern YYYY-MM-DD.

Example request

[
  {
    "ad_groups": [
      {
        "keywords": [
          {
            "match_type": "BROAD"
          }
        ],
        "placement_group": "ALL",
        "targeting_spec": {
          "SHOPPING_RETARGETING": [
            {
              "lookback_window": 30,
              "exclusion_window": 14,
              "tag_types": [
                0,
                6
              ]
            }
          ]
        }
      }
    ],
    "daily_spend_cap": 50000000,
    "lifetime_spend_cap": 500000000
  }
]

Response

The request has succeeded.

max_potential_spendinteger

Maximum potential spend estimate.

Example response

{
  "curves": [
    {
      "points": [
        {
          "budget": 5000000,
          "double_y": 10.68,
          "max_y": 2000,
          "min_y": 1000,
          "y": 1500
        }
      ]
    }
  ],
  "derived_metrics": {
    "cpc": 0.56,
    "cpc_lower": 0.47,
    "cpc_upper": 0.65,
    "cpm": 10,
    "cpm_lower": 8,
    "cpm_upper": 12,
    "weekly_click": 1000,
    "weekly_click_lower": 800,
    "weekly_click_upper": 1200,
    "weekly_frequency": 3,
    "weekly_frequency_lower": 2.5,
    "weekly_frequency_upper": 3.5,
    "weekly_impression": 400000,
    "weekly_impression_lower": 350000,
    "weekly_impression_upper": 450000,
    "weekly_reach": 102074.85050444445,
    "weekly_reach_lower": 90000,
    "weekly_reach_upper": 150000
  },
  "max_potential_spend": 50000000
}