Skip to content

Commit 9321d13

Browse files
authored
Merge pull request #211 from mbhatiai/mbhatia/ads-api-budget-optimization-line-item
docs: ads-api campaigns use LINE_ITEM budget optimization only
2 parents 2449e29 + 9ee4d0e commit 9321d13

1 file changed

Lines changed: 22 additions & 23 deletions

File tree

x-ads-api/campaign-management/reference.mdx

Lines changed: 22 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -954,7 +954,7 @@ Retrieve details for some or all campaigns associated with the current account.
954954
"data": [
955955
{
956956
"name": "test",
957-
"budget_optimization": "CAMPAIGN",
957+
"budget_optimization": "LINE_ITEM",
958958
"reasons_not_servable": [
959959
"PAUSED_BY_ADVERTISER",
960960
"INCOMPLETE"
@@ -965,7 +965,7 @@ Retrieve details for some or all campaigns associated with the current account.
965965
"daily_budget_amount_local_micro": 10000000,
966966
"funding_instrument_id": "lygyi",
967967
"duration_in_days": null,
968-
"standard_delivery": false,
968+
"standard_delivery": null,
969969
"total_budget_amount_local_micro": null,
970970
"id": "8wku2",
971971
"entity_status": "PAUSED",
@@ -1015,7 +1015,7 @@ Retrieve a specific campaign associated with the current account.
10151015
},
10161016
"data": {
10171017
"name": "test",
1018-
"budget_optimization": "CAMPAIGN",
1018+
"budget_optimization": "LINE_ITEM",
10191019
"reasons_not_servable": [
10201020
"PAUSED_BY_ADVERTISER",
10211021
"INCOMPLETE"
@@ -1026,7 +1026,7 @@ Retrieve a specific campaign associated with the current account.
10261026
"daily_budget_amount_local_micro": 10000000,
10271027
"funding_instrument_id": "lygyi",
10281028
"duration_in_days": null,
1029-
"standard_delivery": false,
1029+
"standard_delivery": null,
10301030
"total_budget_amount_local_micro": null,
10311031
"id": "8wku2",
10321032
"entity_status": "PAUSED",
@@ -1061,9 +1061,9 @@ Create a new campaign associated with the current account.
10611061
The name for the campaign. Maximum length: 255 characters.
10621062
</ParamField>
10631063

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

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

10831083
<ParamField query="standard_delivery" type="boolean" default="true">
1084-
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`.
1084+
**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.
10851085
</ParamField>
10861086

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

10911091
**Example Request**
10921092

1093-
`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`
1093+
`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`
10941094

10951095
**Example Response**
10961096

@@ -1099,17 +1099,16 @@ Create a new campaign associated with the current account.
10991099
"request": {
11001100
"params": {
11011101
"name": "demo",
1102-
"budget_optimization": "CAMPAIGN",
1102+
"budget_optimization": "LINE_ITEM",
11031103
"daily_budget_amount_local_micro": 140000000,
11041104
"funding_instrument_id": "lygyi",
1105-
"standard_delivery": false,
11061105
"entity_status": "PAUSED",
11071106
"account_id": "18ce54d4x5t"
11081107
}
11091108
},
11101109
"data": {
11111110
"name": "demo",
1112-
"budget_optimization": "CAMPAIGN",
1111+
"budget_optimization": "LINE_ITEM",
11131112
"reasons_not_servable": [
11141113
"PAUSED_BY_ADVERTISER",
11151114
"INCOMPLETE"
@@ -1120,7 +1119,7 @@ Create a new campaign associated with the current account.
11201119
"daily_budget_amount_local_micro": 140000000,
11211120
"funding_instrument_id": "lygyi",
11221121
"duration_in_days": null,
1123-
"standard_delivery": false,
1122+
"standard_delivery": null,
11241123
"total_budget_amount_local_micro": null,
11251124
"id": "hwtbm",
11261125
"entity_status": "PAUSED",
@@ -1178,7 +1177,7 @@ Batch API responses return an ordered collection of items. Otherwise, they are i
11781177
"funding_instrument_id":"lygyi",
11791178
"daily_budget_amount_local_micro":140000000,
11801179
"entity_status":"PAUSED",
1181-
"budget_optimization":"CAMPAIGN"
1180+
"budget_optimization":"LINE_ITEM"
11821181
}
11831182
}
11841183
]
@@ -1191,7 +1190,7 @@ Batch API responses return an ordered collection of items. Otherwise, they are i
11911190
"data": [
11921191
{
11931192
"name": "batch campaigns",
1194-
"budget_optimization": "CAMPAIGN",
1193+
"budget_optimization": "LINE_ITEM",
11951194
"reasons_not_servable": [
11961195
"PAUSED_BY_ADVERTISER",
11971196
"INCOMPLETE"
@@ -1202,7 +1201,7 @@ Batch API responses return an ordered collection of items. Otherwise, they are i
12021201
"daily_budget_amount_local_micro": 140000000,
12031202
"funding_instrument_id": "lygyi",
12041203
"duration_in_days": null,
1205-
"standard_delivery": false,
1204+
"standard_delivery": null,
12061205
"total_budget_amount_local_micro": null,
12071206
"id": "8yn7m",
12081207
"entity_status": "PAUSED",
@@ -1220,7 +1219,7 @@ Batch API responses return an ordered collection of items. Otherwise, they are i
12201219
"funding_instrument_id": "lygyi",
12211220
"daily_budget_amount_local_micro": 140000000,
12221221
"entity_status": "PAUSED",
1223-
"budget_optimization":"CAMPAIGN",
1222+
"budget_optimization":"LINE_ITEM",
12241223
"account_id": "18ce54d4x5t"
12251224
},
12261225
"operation_type": "Create"
@@ -1245,9 +1244,9 @@ Update the specified campaign associated with the current account.
12451244
A reference to the campaign you are operating with in the request.
12461245
</ParamField>
12471246

1248-
<ParamField query="budget_optimization" type="string" default="CAMPAIGN">
1247+
<ParamField query="budget_optimization" type="string" default="LINE_ITEM">
12491248
Select the type of budget optimization to be applied.<br/><br/>
1250-
Possible values: `CAMPAIGN`, `LINE_ITEM`
1249+
Possible values: `LINE_ITEM`
12511250
</ParamField>
12521251

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

12711270
<ParamField query="standard_delivery" type="boolean" default="true">
1272-
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`.
1271+
**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.
12731272
</ParamField>
12741273

12751274
<ParamField query="total_budget_amount_local_micro" type="long" optional>
@@ -1293,7 +1292,7 @@ Update the specified campaign associated with the current account.
12931292
},
12941293
"data": {
12951294
"name": "test",
1296-
"budget_optimization": "CAMPAIGN",
1295+
"budget_optimization": "LINE_ITEM",
12971296
"reasons_not_servable": [
12981297
"PAUSED_BY_ADVERTISER",
12991298
"INCOMPLETE"
@@ -1304,7 +1303,7 @@ Update the specified campaign associated with the current account.
13041303
"daily_budget_amount_local_micro": 140000000,
13051304
"funding_instrument_id": "lygyi",
13061305
"duration_in_days": null,
1307-
"standard_delivery": false,
1306+
"standard_delivery": null,
13081307
"total_budget_amount_local_micro": null,
13091308
"id": "8wku2",
13101309
"entity_status": "PAUSED",
@@ -1351,15 +1350,15 @@ Delete the specified campaign belonging to the current account.
13511350
},
13521351
"data": {
13531352
"name": "test",
1354-
"budget_optimization": "CAMPAIGN",
1353+
"budget_optimization": "LINE_ITEM",
13551354
"reasons_not_servable": [],
13561355
"servable": null,
13571356
"purchase_order_number": null,
13581357
"effective_status": "RUNNING",
13591358
"daily_budget_amount_local_micro": 140000000,
13601359
"funding_instrument_id": "lygyi",
13611360
"duration_in_days": null,
1362-
"standard_delivery": false,
1361+
"standard_delivery": null,
13631362
"total_budget_amount_local_micro": null,
13641363
"id": "8yn7m",
13651364
"entity_status": "PAUSED",

0 commit comments

Comments
 (0)