Skip to main content

GET All Options of Bidding Templates

Overview


The following table contains important information about the GET method in regards to receiving all options of bidding templates.

GET All Options of Bidding Templates
MethodGET
URL or Endpoint/api/projects/projectId/bidding-templates/select-options
HeadersAuthorization
ParametersprojectId
BodyNot Applicable

The description of the URL parameter is as follows:

projectId URL Parameter
URL Parameter NameprojectId
MandatoryYes
Typestring
DescriptionUnique Id of the project.

Request Body

The request does not contain a request body.

Response

{
"success": true,
"errors": [],
"messages": [],
"result": {
"mediationOptions": [
{
"id": 1,
"name": "Gjirafa Player",
"value": null
}
],
"bidderOptions": [
{
"id": 2,
"name": "MallTv",
"notification": "",
"bidParamValues": [
{
"id": 3,
"name": "propertyId",
"required": true,
"type": "string",
"placeholder": "",
"bidderId": 2
},
{
"id": 4,
"name": "placementId",
"required": true,
"type": "string",
"placeholder": "",
"bidderId": 2
}
]
},
{
"id": 4,
"name": "Gjirafa",
"notification": "",
"bidParamValues": [
{
"id": 7,
"name": "propertyId",
"required": true,
"type": "string",
"placeholder": "",
"bidderId": 4
},
{
"id": 8,
"name": "placementId",
"required": true,
"type": "string",
"placeholder": "",
"bidderId": 4
}
]
},
{
"id": 5,
"name": "AdSpirit",
"notification": "GAM truncates keys to 20 characters.",
"bidParamValues": [
{
"id": 9,
"name": "placementId",
"required": true,
"type": "string",
"placeholder": "placementId",
"bidderId": 5
},
{
"id": 10,
"name": "host",
"required": true,
"type": "string",
"placeholder": "host",
"bidderId": 5
}
]
},
{
"id": 10,
"name": "appnexus",
"notification": "",
"bidParamValues": [
{
"id": 15,
"name": "placementId",
"required": true,
"type": "int",
"placeholder": "placementId",
"bidderId": 10
}
]
},
{
"id": 11,
"name": "Appnexus",
"notification": "string",
"bidParamValues": [
{
"id": 16,
"name": "placementId",
"required": true,
"type": "int",
"placeholder": "PlacementID",
"bidderId": 11
}
]
},
{
"id": 12,
"name": "Adform",
"notification": "",
"bidParamValues": [
{
"id": 17,
"name": "mid",
"required": true,
"type": "int",
"placeholder": "",
"bidderId": 12
}
]
}
]
},
"resultInfo": null,
"statusCode": 200
}

Information about the fields that appear when you receive the response are displayed in the table below.

Field NameTypeDescription
successboolIf the response is successful it will return true. Otherwise will return false.
errorsarray[]Indicates if there was an error.
messagesarray[]Returns the response message from back-end.
resultarray[Object]Returns the response object.
mediaOptionsarray[Object]Returns the media options as an array of objects.
idinteger($int32)The id of media option.
namestringThe name of the media option.
valuestringThe value of the media option.
bidderOptionsarray[Object]Returns the media options as an array of objects.
idinteger($int32)The id of the bidder.
namestringThe name of the bidder
notificationstringThe notification.
bidParamValuesarray[Object]Returns the bidder parameter values as an array of objects.
idinteger($int32)The id of the bidder.
namestringThe name of the bidder parameter
requiredboolIndicates whether this parameter is required
typestringIndicates the type of the parameter
placeholderstringRepresents the name of placeholder.
bidderIdinteger($int32)The id of the bidder.
resultInfostringReturns extra information about the result.
statusCodeinteger($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