Page tree



Before using PubMatic APIs, first generate the API Token. For more information, refer to  Getting Started with PubMatic APIs.

Agency Type lets you retrieve the various types of agencies supported by the Universal Ad Server. 

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

Supported Operations

Service Name: /agencytype/

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

Retrieves the Agency Type details using the Agency Type Id.

The following are supported Agency Type:

IDName
1Media Buyer
2Advertiser Direct
3Advertising Agency
Retrieve Details of an Agency Type
/agencytype/GET

Retrieve the list of supported Agency Types.

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.

See Common Request Query Parameters for more information about using dimensions, filters and sorting.
Retrieve a List of Agency Types


Retrieve Details of an Agency Type

This API lets you retrieve the details of an Agency Type.

Request



Request Headers

Header nameType ValueRequiredDescription
Content-TypeStringapplication/jsonYesMedia type for request.
AuthorizationStringBearer ${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.


Sample Request URL

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

Response

Response Body Parameters


Parameter NameTypeDescription
idNumericAgency Identifier
nameStringAgency Type Name


Sample Response JSON

{
    "id": 1,
    "name": "Media Buyer"
}‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍


Retrieve a List of Agency Types

This API lets you retrieve a list of Agency Types. In the query, you can also apply supported dimensions, filters and sorting options to retrieve specific results. (See Generic Search below.)

See Common Request Query Parameters to learn more about using dimensions, sort and filter options.

Request



Request Headers

Header nameType ValueRequiredDescription
Content-TypeStringapplication/jsonYesMedia type for request.
AuthorizationStringBearer ${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.


Sample Request URL

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

Response

Response Body Parameters


Parameter NameTypeDescription
idNumericAgency Identifier
nameStringAgency Type Name


Sample Response


This will return all Agency Types associated with your account.


Generic Search

See Common Request Query Parameters to learn more about using dimensions, sort and filter options.   



Sample Request URL

https://api.pubmatic.com/v1/uas/agencytype?dimensions=name&filters=id eq 1

Sample Response


This will return Agency Types associated with your account based on the filter criteria.


Error Codes for Agency Type

Sr. NoError CodesDescription
1.MISSING_OR_INVALID_PARAMETERRequested details for Agency Type with an ID that does not exist or is invalid.

⇧ Top