Skip to content

docs: ads-api campaigns use LINE_ITEM budget optimization only #211

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
mbhatiai merged 1 commit into from
Jun 28, 2026
+22 −23
Merged

docs: ads-api campaigns use LINE_ITEM budget optimization only #211

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
45 changes: 22 additions & 23 deletions x-ads-api/campaign-management/reference.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -954,7 +954,7 @@ Retrieve details for some or all campaigns associated with the current account.
"data": [
{
"name": "test",
"budget_optimization": "CAMPAIGN",
"budget_optimization": "LINE_ITEM",
"reasons_not_servable": [
"PAUSED_BY_ADVERTISER",
"INCOMPLETE"
Expand All @@ -965,7 +965,7 @@ Retrieve details for some or all campaigns associated with the current account.
"daily_budget_amount_local_micro": 10000000,
"funding_instrument_id": "lygyi",
"duration_in_days": null,
"standard_delivery": false,
"standard_delivery": null,
"total_budget_amount_local_micro": null,
"id": "8wku2",
"entity_status": "PAUSED",
Expand Down Expand Up @@ -1015,7 +1015,7 @@ Retrieve a specific campaign associated with the current account.
},
"data": {
"name": "test",
"budget_optimization": "CAMPAIGN",
"budget_optimization": "LINE_ITEM",
"reasons_not_servable": [
"PAUSED_BY_ADVERTISER",
"INCOMPLETE"
Expand All @@ -1026,7 +1026,7 @@ Retrieve a specific campaign associated with the current account.
"daily_budget_amount_local_micro": 10000000,
"funding_instrument_id": "lygyi",
"duration_in_days": null,
"standard_delivery": false,
"standard_delivery": null,
"total_budget_amount_local_micro": null,
"id": "8wku2",
"entity_status": "PAUSED",
Expand Down Expand Up @@ -1061,9 +1061,9 @@ Create a new campaign associated with the current account.
The name for the campaign. Maximum length: 255 characters.
</ParamField>

<ParamField query="budget_optimization" type="string" default="CAMPAIGN">
<ParamField query="budget_optimization" type="string" default="LINE_ITEM">
Select the type of budget optimization to be applied.<br/><br/>
Possible values: `CAMPAIGN`, `LINE_ITEM`
Possible values: `LINE_ITEM`
</ParamField>

<ParamField query="daily_budget_amount_local_micro" type="long" optional>
Expand All @@ -1081,7 +1081,7 @@ Create a new campaign associated with the current account.
</ParamField>

<ParamField query="standard_delivery" type="boolean" default="true">
Enable standard or accelerated delivery. See [Budget Pacing](/x-ads-api/campaign-management/reference#budget-pacing) for more information on standard versus accelerated delivery. Only available when `budget_optimization` is set to `CAMPAIGN`.
**Deprecated at the campaign level.** Since budget optimization is always `LINE_ITEM`, standard versus accelerated delivery is configured on the line item via its `standard_delivery` parameter. See [Budget Pacing](/x-ads-api/campaign-management/reference#budget-pacing) for more information.
</ParamField>

<ParamField query="total_budget_amount_local_micro" type="long" optional>
Expand All @@ -1090,7 +1090,7 @@ Create a new campaign associated with the current account.

**Example Request**

`POST https://ads-api.x.com/12/accounts/18ce54d4x5t/campaigns?funding_instrument_id=lygyi&name=demo&daily_budget_amount_local_micro=140000000&entity_status=PAUSED&budget_optimization=CAMPIAGN&standard_delivery=false`
`POST https://ads-api.x.com/12/accounts/18ce54d4x5t/campaigns?funding_instrument_id=lygyi&name=demo&daily_budget_amount_local_micro=140000000&entity_status=PAUSED&budget_optimization=LINE_ITEM`

**Example Response**

Expand All @@ -1099,17 +1099,16 @@ Create a new campaign associated with the current account.
"request": {
"params": {
"name": "demo",
"budget_optimization": "CAMPAIGN",
"budget_optimization": "LINE_ITEM",
"daily_budget_amount_local_micro": 140000000,
"funding_instrument_id": "lygyi",
"standard_delivery": false,
"entity_status": "PAUSED",
"account_id": "18ce54d4x5t"
}
},
"data": {
"name": "demo",
"budget_optimization": "CAMPAIGN",
"budget_optimization": "LINE_ITEM",
"reasons_not_servable": [
"PAUSED_BY_ADVERTISER",
"INCOMPLETE"
Expand All @@ -1120,7 +1119,7 @@ Create a new campaign associated with the current account.
"daily_budget_amount_local_micro": 140000000,
"funding_instrument_id": "lygyi",
"duration_in_days": null,
"standard_delivery": false,
"standard_delivery": null,
"total_budget_amount_local_micro": null,
"id": "hwtbm",
"entity_status": "PAUSED",
Expand Down Expand Up @@ -1178,7 +1177,7 @@ Batch API responses return an ordered collection of items. Otherwise, they are i
"funding_instrument_id":"lygyi",
"daily_budget_amount_local_micro":140000000,
"entity_status":"PAUSED",
"budget_optimization":"CAMPAIGN"
"budget_optimization":"LINE_ITEM"
}
}
]
Expand All @@ -1191,7 +1190,7 @@ Batch API responses return an ordered collection of items. Otherwise, they are i
"data": [
{
"name": "batch campaigns",
"budget_optimization": "CAMPAIGN",
"budget_optimization": "LINE_ITEM",
"reasons_not_servable": [
"PAUSED_BY_ADVERTISER",
"INCOMPLETE"
Expand All @@ -1202,7 +1201,7 @@ Batch API responses return an ordered collection of items. Otherwise, they are i
"daily_budget_amount_local_micro": 140000000,
"funding_instrument_id": "lygyi",
"duration_in_days": null,
"standard_delivery": false,
"standard_delivery": null,
"total_budget_amount_local_micro": null,
"id": "8yn7m",
"entity_status": "PAUSED",
Expand All @@ -1220,7 +1219,7 @@ Batch API responses return an ordered collection of items. Otherwise, they are i
"funding_instrument_id": "lygyi",
"daily_budget_amount_local_micro": 140000000,
"entity_status": "PAUSED",
"budget_optimization":"CAMPAIGN",
"budget_optimization":"LINE_ITEM",
"account_id": "18ce54d4x5t"
},
"operation_type": "Create"
Expand All @@ -1245,9 +1244,9 @@ Update the specified campaign associated with the current account.
A reference to the campaign you are operating with in the request.
</ParamField>

<ParamField query="budget_optimization" type="string" default="CAMPAIGN">
<ParamField query="budget_optimization" type="string" default="LINE_ITEM">
Select the type of budget optimization to be applied.<br/><br/>
Possible values: `CAMPAIGN`, `LINE_ITEM`
Possible values: `LINE_ITEM`
</ParamField>

<ParamField query="daily_budget_amount_local_micro" type="long" optional>
Expand All @@ -1269,7 +1268,7 @@ Update the specified campaign associated with the current account.
</ParamField>

<ParamField query="standard_delivery" type="boolean" default="true">
Enable standard or accelerated delivery. See [Budget Pacing](/x-ads-api/campaign-management/reference#budget-pacing) for more information on standard versus accelerated delivery. Only available when `budget_optimization` is set to `CAMPAIGN`.
**Deprecated at the campaign level.** Since budget optimization is always `LINE_ITEM`, standard versus accelerated delivery is configured on the line item via its `standard_delivery` parameter. See [Budget Pacing](/x-ads-api/campaign-management/reference#budget-pacing) for more information.
</ParamField>

<ParamField query="total_budget_amount_local_micro" type="long" optional>
Expand All @@ -1293,7 +1292,7 @@ Update the specified campaign associated with the current account.
},
"data": {
"name": "test",
"budget_optimization": "CAMPAIGN",
"budget_optimization": "LINE_ITEM",
"reasons_not_servable": [
"PAUSED_BY_ADVERTISER",
"INCOMPLETE"
Expand All @@ -1304,7 +1303,7 @@ Update the specified campaign associated with the current account.
"daily_budget_amount_local_micro": 140000000,
"funding_instrument_id": "lygyi",
"duration_in_days": null,
"standard_delivery": false,
"standard_delivery": null,
"total_budget_amount_local_micro": null,
"id": "8wku2",
"entity_status": "PAUSED",
Expand Down Expand Up @@ -1351,15 +1350,15 @@ Delete the specified campaign belonging to the current account.
},
"data": {
"name": "test",
"budget_optimization": "CAMPAIGN",
"budget_optimization": "LINE_ITEM",
"reasons_not_servable": [],
"servable": null,
"purchase_order_number": null,
"effective_status": "RUNNING",
"daily_budget_amount_local_micro": 140000000,
"funding_instrument_id": "lygyi",
"duration_in_days": null,
"standard_delivery": false,
"standard_delivery": null,
"total_budget_amount_local_micro": null,
"id": "8yn7m",
"entity_status": "PAUSED",
Expand Down