Lines¶
Abstract¶
Describes GET, PUT, and POST lines when Yahoo Native campaigns are translated to Yahoo DSP Lines.
Overview¶
In Yahoo DSP, a line is subcomponent of a campaign that specifies an advertising strategy. DSP defines each line by one or more ads, a goal type, and a set of budgetary and targeting parameters.

Each line item should represent a distinct targeting strategy. Using lines, a campaign can independently target diverse exchanges, deals, locations, demographics, ad positions, frequency, audiences, devices, days of the week, apps, URLs, page relevancy, mobile carriers, and languages.
Although you can specify budgets at both the campaign and line level, flight dates, frequency caps, and budgets specified at the campaign level override line-level configurations.
The action taken depends on the HTTP method and the parameters specified.
Use the
GET
method to read an existing line.Use the
POST
method to create a new line.
Native Specific Fields¶
Name |
Type |
Allowed Values |
---|---|---|
supplyType |
String |
Yahoo Native Third Party null *null indicates Display |
language |
String |
|
isNativeEnabled |
Boolean |
True |
POST Line¶
Endpoint:
https://dspapi.admanagerplus.yahoo.com/traffic/lines
Method: POST
Header:
Content-Type: application/json X-Auth-Token: access_token X-Auth-Method: OAUTH2
Body
{
"name": "Test Native Line",
"orderId": 1234,
"bidPrice": 1,
"goalAmount": 1,
"maxGoal": 1,
"marginGoal": 25,
"billingPrice": 22,
"completionThreshold": 0,
"isNativeEnabled": true,
"status": "NOT_STARTED",
"pacingModeType": "EVEN",
"mediaType": "DISPLAY",
"goalModeType": "HARD",
"goalType": "CPC",
"billingMethodType": "CPC_WITH_MARGIN",
"marginType": "TOTAL_BUDGET",
"budgetType": "CURRENCY",
"schedules": [
{
"budget": 100,
"dailyBudgetType": "AUTO_ALLOCATED",
"startDateStr": "2021-02-01T08:00:00Z",
"endDateStr": "2021-20-06T07:59:59Z"
}
],
"feeList": [],
"conversionList": [],
"supplyType": "VERIZON_MEDIA",
"language": "ENGLISH"
}
GET Line¶
Endpoint:
https://dspapi.admanagerplus.yahoo.com/traffic/lines/lineId
Method: GET
Header:
Content-Type: application/json X-Auth-Token: access_token X-Auth-Method: OAUTH2
Curl:
curl --location --request GET 'https://dspapi.admanagerplus.yahoo.com/traffic/lines/lineId' \
--header 'X-Auth-Method: OAUTH2' \
--header 'X-Auth-Token: access_token' \
--header 'Content-Type: application/json'
Response
{
"response": {
"id": 1385116,
"name": "Venkatesh test O&O Native Line",
"orderId": 273813,
"bidPrice": 1.0,
"goalAmount": 1.0,
"maxGoal": 1.0,
"marginGoal": 25.0,
"billingPrice": 22.0,
"completionThreshold": 0.0,
"isNativeEnabled": true,
"status": "INACTIVE",
"pacingModeType": "EVEN",
"mediaType": "DISPLAY",
"goalModeType": "HARD",
"goalType": "CPC",
"billingMethodType": "CPC_WITH_MARGIN",
"marginType": "TOTAL_BUDGET",
"budgetType": "CURRENCY",
"schedules": [
{
"id": 1396325,
"budget": 250.0,
"startDateStr": "2020-12-14T08:00:00Z",
"endDateStr": "2020-12-27T07:59:59Z",
"dailyBudgetType": "AUTO_ALLOCATED"
}
],
"feeList": [],
"conversionList": [],
"supplyType": "VERIZON_MEDIA",
"language": "ENGLISH"
},
"errors": null,
"timeStamp": "2021-02-21T04:01:55.045Z"
}
PUT Line¶
Endpoint:
https://dspapi.admanagerplus.yahoo.com/traffic/lines/lineId
Method: PUT
Header:
Content-Type: application/json X-Auth-Token: access_token X-Auth-Method: OAUTH2
Body:
{
"schedules": [
{
"budget": 200,
"startDateStr": "2022-03-01T08:00:00Z",
"endDateStr": "2022-04-25T07:59:59Z"
}
]
}
Curl:
curl --location --request PUT 'https://dspapi.admanagerplus.yahoo.com/traffic/lines/lineId' \
--header 'X-Auth-Method: OAUTH2' \
--header 'X-Auth-Token: access_token' \
--header 'Content-Type: application/json' \
--data-raw '{
"schedules": [
{
"budget": 200,
"startDateStr": "2021-03-01T08:00:00Z",
"endDateStr": "2021-04-25T07:59:59Z"
}
]
}'