Line Item Pace API (UAS)

Document created by pubmatic-archivist on Mar 27, 2017Last modified by catherine.racette on Aug 28, 2017
Version 7Show Document
  • View in full screen mode

Description

The Line Item Pace API enables you to retrieve supported line item paces and perform a search on supported dimensions.

For more information about UAS Line Item Management Services, refer to Line Item Management Services (UAS)

Supported Operations

Service Name: /lineitempaces/

                     

Method PathHTTP Method TypeDescriptionLink to Definition
/lineitempaces/{id}GET

Retrieves the details of a specific Line Item Page for the requested id.

Currently, the following pace values are supported:

  • Even
  • ASAP (as soon as possible)
  • Front Loaded
Retrieve the Details of a Line Item Pace
/lineitempaces/GET

Retrieves a list of all supported Line Item Paces.

In the query, you can also apply supported dimensions, filters and sorting options to retrieve a list of Ad Units with a specific set of details according to your requirements.

Retrieve a List of Line Item Paces

 

Retrieve the Details of a Line Item Pace

 

Overview

This API enables you to retrieve the details of a LIne Item Pace.

In the query, you can also apply supported dimensions, filters and sorting options to retrieve a list with a specific set of details according to your requirements.

 

Refer to Common Request Query Parameters for more information about using dimensions, filters and sorting, 

Request

           

Request Headers

                        

Header nameType ValueRequiredDescription
Content-TypeStringapplication/jsonYesMedia type for request.
pubTokenString${access_token}Yes

Publisher Token to authenticate and authorize the user calling the Unified Ad Server API. Send the access token generated for authentication at the place of ${access_token} in the request.

 

For more information about access tokens, refer to Getting Started with PubMatic APIs.

Request Body Parameters

                        

Parameter NameTypeRequiredValidationsDescription
nameStringYes

Name can be a maximum of 32 characters.

Name should be unique for your account.

Name for the Line Item Pace 
descriptionStringNo

Description can be a maximum of 1024 characters.

Line Item Pace description (if any)

Request Sample URL

https://api.pubmatic.com/v1/uas/lineitempaces/1 

Response

Sample Response JSON

    

{
    "id": 1,
    "name": "Absolute",
    "description": "Represents absolute value"
}

Retrieve a List of Line Item Paces

 

Overview

This API enables you to retrieve a list of Line Item Paces

In the query, you can also apply supported dimensions, filters and sorting options to retrieve a list with a specific set of details according to your requirements.

 

Refer to Common Request Query Parameters for more information about using dimensions, filters and sorting, 

Request

           

Request Headers

                        

Header nameType ValueRequiredDescription
Content-TypeStringapplication/jsonYesMedia type for request.
pubTokenString${access_token}Yes

Publisher Token to authenticate and authorize the user calling the Unified Ad Server API. Send the access token generated for authentication at the place of ${access_token} in the request.

 

For more information about access tokens, refer to Getting Started with PubMatic APIs.

Request Body Parameters

                        

Parameter NameTypeRequiredValidationsDescription
nameStringYes

Name can be a maximum of 32 characters.

Name should be unique for your account.

Name for the Line Item Pace 
descriptionStringNo

Description can be a maximum of 1024 characters.

Line Item Pace description (if any)

Request Sample URL

https://api.pubmatic.com/v1/uas/lineitempaces/ 

Response

Sample Response JSON

    

This will return a list of supported Line Item Paces.

Error Codes for Line Item Pace

             

Sr. NoError CodesDescription
1.PH_MISSING_OR_INVALID_PARAMETERThis error occurs when the id for the requested goal unit does not exist or is invalid.

 

 

Unified Ad Server References

Common Request Query Parameters for Web Services

Supported Operations for Filters

HTTP Status Codes

Unified Ad Server Specific Error Codes

 

 

Version 0.1

Attachments

    Outcomes