GET All Bidding Templates
Overview
The following table contains important information about the GET method in regards to receiving all bidding templates.
| GET All Bidding Templates | |
|---|---|
| Method | GET |
| URL or Endpoint | /api/projects/projectId/bidding-templates |
| Headers | Authorization |
| Parameters | projectId |
| Body | Not Applicable |
The description of the URL parameter is as follows:
| projectId URL Parameter | |
|---|---|
| URL Parameter Name | projectId |
| Mandatory | Yes |
| Type | string |
| Description | Unique Id of the project |
Request Body
The request does not contain a request body.
Response
{
"success": true,
"errors": [],
"messages": [],
"result": [
{
"name": "Bidding type 1 - u ",
"publicId": "bqevmvtn",
"mediationOptionId": 1,
"biddingTemplateBidders": [
{
"id": 61,
"biddingTemplatePublicId": "bqevmvtn",
"bidderId": 4,
"name": "Gjirafa",
"bidParamValues": [
{
"id": 7,
"biddingTemplateBidderId": 61,
"bidParamId": 7,
"value": "Gjir"
},
{
"id": 8,
"biddingTemplateBidderId": 61,
"bidParamId": 8,
"value": "Afa"
}
]
}
]
},
{
"name": "njomza",
"publicId": "bqevmvto",
"mediationOptionId": 1,
"biddingTemplateBidders": [
{
"id": 38,
"biddingTemplatePublicId": "bqevmvto",
"bidderId": 11,
"name": "Appnexus",
"bidParamValues": []
},
{
"id": 39,
"biddingTemplatePublicId": "bqevmvto",
"bidderId": 2,
"name": "MallTv",
"bidParamValues": []
},
{
"id": 40,
"biddingTemplatePublicId": "bqevmvto",
"bidderId": 5,
"name": "AdSpirit",
"bidParamValues": []
}
]
},
{
"name": "Mall Bidder Update ",
"publicId": "bqevmvts",
"mediationOptionId": 1,
"biddingTemplateBidders": [
{
"id": 41,
"biddingTemplatePublicId": "bqevmvts",
"bidderId": 2,
"name": "MallTv",
"bidParamValues": [
{
"id": 16,
"biddingTemplateBidderId": 41,
"bidParamId": 16,
"value": "asddsa"
},
{
"id": 17,
"biddingTemplateBidderId": 41,
"bidParamId": 17,
"value": "asddsa"
}
]
}
]
},
{
"name": "Bidding type 1",
"publicId": "bqevmvtz",
"mediationOptionId": 1,
"biddingTemplateBidders": [
{
"id": 78,
"biddingTemplatePublicId": "bqevmvtz",
"bidderId": 4,
"name": "Gjirafa",
"bidParamValues": [
{
"id": 37,
"biddingTemplateBidderId": 78,
"bidParamId": 4,
"value": "sgdf"
},
{
"id": 38,
"biddingTemplateBidderId": 78,
"bidParamId": 4,
"value": "adfha"
}
]
},
{
"id": 47,
"biddingTemplatePublicId": "bqevmvtz",
"bidderId": 2,
"name": "MallTv",
"bidParamValues": [
{
"id": 18,
"biddingTemplateBidderId": 47,
"bidParamId": 3,
"value": "asda"
},
{
"id": 19,
"biddingTemplateBidderId": 47,
"bidParamId": 4,
"value": "dasdas"
}
]
}
]
},
{
"name": "test idding 2 ad partners - update",
"publicId": "bqevmvue",
"mediationOptionId": 1,
"biddingTemplateBidders": [
{
"id": 62,
"biddingTemplatePublicId": "bqevmvue",
"bidderId": 2,
"name": "MallTv",
"bidParamValues": [
{
"id": 20,
"biddingTemplateBidderId": 62,
"bidParamId": 3,
"value": "Mall"
},
{
"id": 21,
"biddingTemplateBidderId": 62,
"bidParamId": 4,
"value": "TV"
}
]
},
{
"id": 63,
"biddingTemplatePublicId": "bqevmvue",
"bidderId": 4,
"name": "Gjirafa",
"bidParamValues": [
{
"id": 22,
"biddingTemplateBidderId": 63,
"bidParamId": 7,
"value": "Gjir"
},
{
"id": 23,
"biddingTemplateBidderId": 63,
"bidParamId": 8,
"value": "Afa"
}
]
}
]
},
{
"name": "test bidding temp",
"publicId": "bqevmvuf",
"mediationOptionId": 1,
"biddingTemplateBidders": [
{
"id": 65,
"biddingTemplatePublicId": "bqevmvuf",
"bidderId": 2,
"name": "MallTv",
"bidParamValues": [
{
"id": 24,
"biddingTemplateBidderId": 65,
"bidParamId": 3,
"value": "Mall"
},
{
"id": 25,
"biddingTemplateBidderId": 65,
"bidParamId": 4,
"value": "Tv"
}
]
}
]
},
{
"name": "Bidding template test add",
"publicId": "bqevmvug",
"mediationOptionId": 1,
"biddingTemplateBidders": [
{
"id": 68,
"biddingTemplatePublicId": "bqevmvug",
"bidderId": 2,
"name": "MallTv",
"bidParamValues": [
{
"id": 26,
"biddingTemplateBidderId": 68,
"bidParamId": 3,
"value": "Mall"
},
{
"id": 27,
"biddingTemplateBidderId": 68,
"bidParamId": 4,
"value": "Tv"
}
]
}
]
},
{
"name": "ylber test bidding template",
"publicId": "bqevmvuh",
"mediationOptionId": 1,
"biddingTemplateBidders": [
{
"id": 69,
"biddingTemplatePublicId": "bqevmvuh",
"bidderId": 2,
"name": "MallTv",
"bidParamValues": [
{
"id": 28,
"biddingTemplateBidderId": 69,
"bidParamId": 3,
"value": "Mall"
},
{
"id": 29,
"biddingTemplateBidderId": 69,
"bidParamId": 4,
"value": "Tv"
}
]
},
{
"id": 77,
"biddingTemplatePublicId": "bqevmvuh",
"bidderId": 4,
"name": "Gjirafa",
"bidParamValues": [
{
"id": 35,
"biddingTemplateBidderId": 77,
"bidParamId": 4,
"value": "Gjir"
},
{
"id": 36,
"biddingTemplateBidderId": 77,
"bidParamId": 4,
"value": "afa"
}
]
}
]
},
{
"name": "",
"publicId": "bqevmvtk",
"mediationOptionId": 1,
"biddingTemplateBidders": []
},
{
"name": "Test Player Bidding",
"publicId": "bqevmvtl",
"mediationOptionId": 1,
"biddingTemplateBidders": [
{
"id": 25,
"biddingTemplatePublicId": "bqevmvtl",
"bidderId": 2,
"name": "MallTv",
"bidParamValues": [
{
"id": 11,
"biddingTemplateBidderId": 25,
"bidParamId": 3,
"value": "105135"
},
{
"id": 12,
"biddingTemplateBidderId": 25,
"bidParamId": 4,
"value": "846836"
}
]
},
{
"id": 28,
"biddingTemplatePublicId": "bqevmvtl",
"bidderId": 12,
"name": "Adform",
"bidParamValues": [
{
"id": 15,
"biddingTemplateBidderId": 28,
"bidParamId": 17,
"value": "930181"
}
]
}
]
},
{
"name": "Gentiana",
"publicId": "bqevmvtm",
"mediationOptionId": 1,
"biddingTemplateBidders": []
}
],
"resultInfo": null,
"statusCode": 200
}
Information about the fields that appear when you receive the response are displayed in the table below.
| Field Name | Type | Description |
|---|---|---|
| success | bool | If the response is successful it will return true. Otherwise will return false. |
| errors | array[] | Indicates if there was an error. |
| messages | array[] | Returns the response message from back-end. |
| result | array[Object] | Returns the response object. |
| name | string | The name of the bidding template |
| publicId | string | The id of the bidder. |
| mediaOptionId | integer($int32) | The id of the media option. |
| biddingTemplateBidders | array[Object] | Returns the bidding template bidders as an array of objects. |
| id | integer($int32) | The id of the bidder. |
| biddingTemplatePublicId | string | The id of the bidder. |
| bidderId | integer($int32) | The id of the bidder. |
| name | string | The name of the bidder |
| bidParamValues | array[Object] | Returns the bidder parameter values as an array of objects. |
| id | integer($int32) | The id of the bidder parameter value. |
| biddingTemplateBidderId | integer($int32) | The id of the bidding template bidder. |
| bidParamId | integer($int32) | The id of the bidder parameter value. |
| value | string | The value of the bidder parameter. |
| resultInfo | string | Returns extra information about the result. |
| statusCode | integer($int32) | Returns the HTTP Status Code. |
If the action is successful, the service sends back an HTTP 200 or 201 response.
Errors
For information about the errors that are common to all actions, see Common Errors:
HTTP Status Code 400: Bad Request
HTTP Status Code 401: Unauthorized
HTTP Status Code 403: Forbidden
HTTP Status Code 404: Result Not Found
HTTP Status Code 500: Internal Server Error
HTTP Status Code 503: Backend Fetch Failed