Retrieving List of Ad Categories

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

Overview

This API allows you to retrieve the list of all the ad categories present in the PubMatic system.

Request

         

URIhttp://{domainName}/common/adCategory?pageSize=20&pageNumber=1
HTTP MethodGET

Request Headers

                 

Header Name

Type

Value

Required

Description

Authorization

String

Bearer ${access_token}

Yes

Need to send the access token generating for authentication at the place of ${access_token}.
For more information about access tokens, refer to Getting Started with PubMatic APIs.

Request Query Parameters

                     

Parameter Name
Type
Required
Description
pageNumber
Integer
Optional
Page number to be fetched in case of multiple pages.
Its default value is 1.
pageSize
Integer
Optional
Maximum number of rows to be included in the response.
Its default value is 100.

Response

Response Headers

           

Response Header NameType
Content-typeapplication-json

Response Body

                       

Response Body Parameter
Type
Description
metaData
Object
adCategoryId
Integer
Unique ID of the ad category.
name
String
Name of the ad category.

Sample Response JSON


{
     "metaData": {
     "startIndex": 1,
     "request": {
       "pageSize": 3,
       "pageNumber": 1
     },
     "totalRecords": 18,
     "endIndex": 3
   },
   "items": [
     {
       "adCategoryId": 1,
       "name": "Alcohol"
     },
     {
       "adCategoryId": 2,
       "name": "Audio: user initiated"
     },
     {
       "adCategoryId": 3,
       "name": "Caution Banner"
     }
   ]
  }

Attachments

    Outcomes