Ad Network/Ad Placement Management API

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

Description

This API caters to needs related to Ad Networks.

 

The resources currently exposed are:

  • AdNetwork
  • PublisherAdNetwork
  • AdNetworkPlacement
  • Additional resource for Download

Context Root

/networkmanagement

 

Methods

                                                                                             

Method PathHTTP Method TypeDescriptionLink to Definition
/publisherAdNetwork/extendedSearchGETThis method is used to get all the ad networks linked to the publisher.Get Publisher Ad Network
/publisherAdNetwork/{id}GETThis method is used to get details for a particular ad network linked to the publisher.Get Publisher Ad Network by Id

/publisherAdNetwork

POSTThis method is used to link an ad network to the publisher.Link a Network to Publisher
/publisherAdNetworkPUTThis method is used to update properties of an already linked ad network.Update Publisher Ad Network
/adNetworksGETThis method will get all ad networks present in the system based on the values passed in the query.Get Ad Networks
/adNetworks/extendedSearchGETThis method is used to get all ad networks based on supported filter attributes.Search Ad Networks
/adNetworks/{id}GETThis method will get the ad networks by Id.Get Ad Network by Id
/download/adnetworkPlacementsGETThis method is used to download all the placements linked to the particular publisher.Download
/adNetworkPlacementPOSTThis method is used to create placement.Create Ad Network Placement
/adNetworkPlacement/{id}PUTThis method is used to update/edit placementUpdate Ad Network Placement
/adNetworkPlacement/{id}DELETEThis method is used to delete placementDelete Ad Network Placement
/adNetworkPlacementGETThis method is used to get ad network placements of publisher.Get Ad Network Placement
/adNetworkPlacement/searchGETThis method is used to get all Ad Network placements for supported filter attributes.Search Ad Network Placement
/adNetworkPlacement/{id}GETThis method is used to get Ad Network Placement by Id for a Publisher.Get Ad Network Placement details by Placement Id

 

Get Publisher Ad Network

Overview

Request

Response

Error Codes

Overview

This method is used to get information about all Ad Networks linked to the Publisher.

  • This can be used to check if an Ad Network is linked to the Publisher. 
  • It can be used to filter out linked Ad Networks using name or Id.
  • It can provide a list of:
    • Ad Networks with 0 or more Ad Tags
    • Ad Networks paused or live
    • Ad Networks as per type (Manually Integrated, Semi Integrated, PubMatic Group Integrated)
    • Semi Integrated Ad Networks running as Indirect(Manually Integrated)
    • Passback Ad Networks
    • Ad Networks linked to Ad Tags using specific PubMatic Site
    • Ad Networks linked to specific Ad Tags
    • Ad Networks linked to specific Geos

Request

URI${URI_PREFIX}/networkmanagement
HTTP MethodGET

Request Headers                        

Header Name

Type

Required

Value

Description

Content-typeStringYesMust be application/jsonMedia type that is to be returned in search/sort operation.

PubToken

String

Yes

Bearer ${access_token}

Need to send the access token generating for authentication at the place of ${access_token}.

For more information about access token, refer the Getting Started with PubMatic APIs.

Request Query Parameters                                                                                            

ParameterTypeRequiredValidationsDescription
publisherIdLongYesPublisher Id should exist & active in PubMatic System

Id of the Publisher to which Ad Network needs to be linked.

activeAdTagCountLongNo 

Used to filter Ad Networks based on the Ad Tags linked.

isActiveBooleanNofalse=paused, true = activeUsed to filter Ad Networks based on their status as paused or active.
adNetworkTypeIntegerNo

1=Manually Integrated
2=Semi Integrated
3=Fully Integrated
5=PubMatic Group Integrated

Used to filter Ad Networks based on their Integration Type.
adNetWorkIdLongNo Used to filter Ad Networks based on Ad Network Id.
nameStringNo Used to filter Ad Networks based on Ad Network name.
credentialsAvailableBooleanNofalse=Running in IN mode, true = Running in Semi Integrated modeUsed to filter Semi-Integrated Ad Networks running in Manually integrated mode.
isPassbackBooleanNotrue=Passback Ad NetworkUsed to filter Passback Ad Networks.
siteIdLongNoPubMatic Site IdUsed to filter Ad Networks linked to particular Ad Tag.
adTagIdLongNoPubMatic Ad Tag IdUsed to filter Ad Networks linked to particular Ad Tag.
geoIdLongNoPubMatic Geo IdUsed to filter Ad Networks linked to a particular country
dimensionsStringNo Used for Sorting
sortStringNo Used for Sorting (sort=name will sort result in descending order of Ad Netorks name.)

Note: Sorting is provided on activeAdTagCount, placementCount, adNetworkType, geoCount, name.

networkType ENUM Identifiers for different Ad Network Integration modes

                            

Integration ModenetworkTypenetworkTypeId
Manually IntegratedIN1
Semi Integrated INW2
Fully IntegratedPCI3
PubMatic Group IntegratedPCGH4

Examples

Sample Request URLs

Get 1st 10 Ad Networks linked to the Publisher in descending order of name : 

http://localhost/networkmanagement/publisherAdNetwork/extendedSearch?dimensions=name&filters=publisherId+eq+2685&pageNumber=1&pageSize=10&sort=-name

Get Ad Networks Linked to Ad Tag Id - 28152 : 

http://localhost/networkmanagement/publisherAdNetwork/extendedSearch?dimensions=name&filters=publisherId+eq+2685&filters=adTagId eq 28152

Get Linked Ad Networks that are in paused state :

http://localhost:8080/networkmanagement/publisherAdNetwork/extendedSearch?filters=publisherId eq 2685&filters=isActive eq false

Get 1st 10 IN Ad Networks linked to the Publishers :

http://localhost:8080/networkmanagement/publisherAdNetwork/extendedSearch?filters=publisherId eq 2685&filters=adNetworkType eq 1

Response

Sample Response JSON:    

{
  "metaData": {
  "startIndex": 1,
  "totalRecords": 159,
  "endIndex": 10
  },
  "items": [
  {
  "id": 2830,
  "publisherAdServerAccountId": 51821,
  "publisherId": 2685,
  "userName": "test@pubmatic.com",
  "credentialsAvailable": true,
  "adNetworkType": "INW",
  "name": "Zucks Japan MWeb INW",
  "adServerPublisherId": "test",
  "isActive": true,
  "modificationDate": "2016-04-12 14:29:11",
  "isPassback": false,
  "adNetwork": {
   "name": "Zucks Japan MWeb INW",
   "indirectCampaignFlag": false,
   "guaranteedDelivery": false,
   "restrictedVisibility": false,
   "id": 2830,
   "coppaCompliant": false
  },
  "publisherAdNetworkDealTypeInformation": {
  "id": 18186,
  "publisherId": 2685,
  "adNetworkId": 2830,
  "dealTypeId": 4,
  "revDealTypeId": 1,
  "dealSourceId": 1,
  "margin": 0,
  "modificationTime": "2016-04-12 14:29:11"
  },
  "fcapStatus": false,
  "icapStatus": false,
  "lastEcpmUpdateTime": "2015-04-27 12:51:48",
  "ecpmUpdateRequired": true,
  "activeAdTagCount": 1,
  "placementCount": 5,
  "geoCount": 0,
  "fixedDeal": false
  },
{
  "id": 1279,
  "publisherAdServerAccountId": 37127,
  "publisherId": 2685,
  "userName": "test",
  "credentialsAvailable": false,
  "adNetworkType": "PCI",
  "name": "ZetaNet PCI",
  "adServerPublisherId": "test",
  "isActive": true,
  "modificationDate": "2016-04-11 16:20:57",
  "isPassback": false,
  "adNetwork": {
  "name": "ZetaNet PCI",
  "indirectCampaignFlag": false,
  "guaranteedDelivery": false,
  "restrictedVisibility": true,
  "id": 1279,
  "coppaCompliant": false
  },
  "publisherAdNetworkDealTypeInformation": {
  "id": 18179,
  "publisherId": 2685,
  "adNetworkId": 1279,
  "dealTypeId": 3,
  "revDealTypeId": 2,
  "dealSourceId": 1,
  "margin": 0,
  "modificationTime": "2016-04-11 16:20:57"
  },
  "fcapStatus": false,
  "icapStatus": false,
  "activeAdTagCount": 1,
  "placementCount": 0,
  "geoCount": 0,
  "fixedDeal": false
  },...
  }
]
}

 Error Codes

Error CodeError Description
filters=credentialsAvailable eq 1Either the filter is not provided or parameters are not passed to filters in expected formats.e.g., credentialsAvailable filter is expecting Boolean parameter and if Integer is passed then error will be thrown

 

Get Publisher Ad Network by ID

Overview

Request

Response

 

Overview

This method is used to retrieve details related to a particular ad network linked to the publisher by providing an Id for that network.

Request         

URI${URI_PREFIX}/networkmanagement
HTTP MethodGET

Request Headers               

Header Name

Type

Required

Value

Description

Content-typeStringYesMust be application/jsonMedia type that is to be returned in search/sort operation.

PubToken

String

Yes

Bearer ${access_token}

Need to send the access token generating for authentication at the place of ${access_token}.

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

Request Query Parameters             

ParameterTypeRequiredValidationsDescription
pubIdLongYes 

Used to fetch Ad Network linked to the Publisher.

Example

Sample Request URL

http://localhost:8081/networkmanagement/publisherAdNetwork/165?pubId=586

Response

Sample Response JSON:

{
  "id": 2142,
  "publisherAdServerAccountId": 44659,
  "publisherId": 586,
  "userName": "test",
  "credentialsAvailable": true,
  "adNetworkType": "INW",
  "name": "Adjust Japan INW",
  "associated": 1,
  "isPassback": false,
  "isLastLive": false,
  "adNetwork": {
  "indirectCampaignFlag": false,
  "interfaceId": 2142,
  "id": 2142
  },
  "fixedDeal": false
}

Link Ad Network to Publisher

Overview

Request

Response

Error Codes

Overview

This API is used to link the provided Ad Network to the Publisher.

When credentials are provided (In the case of Fully Integrated & Semi Integrated) then internally automated scripts are called to verify the credentials by logging in to the Ad Network or using the Ad Network's API. If automated scripts are able to log in to the Ad Network's UI or get expected response from Ad Network's API then only credentials are updated else Error 'UNABLE_TO_LOGIN' is thrown.

Request         

URI${URI_PREFIX}/networkmanagement
HTTP MethodPOST

Request Headers  

Header Name

Type

Required

Value

Description

Content-typeStringYesMust be application/jsonMedia type that is to be returned in search/sort operation.

PubToken

String

Yes

Bearer ${access_token}

Need to send the access token generating for authentication at the place of ${access_token}.

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

Request Body Parameters                          

ParameterTypeRequiredValidationsDescription
idLongYesAd Network Id should exist and be active in the PubMatic system.Id of Ad Network to be linked.
publisherIdLongYesPublisher Id should exist and be active in the PubMatic system.

Id of the Publisher to which the Ad Network needs to be linked.

userNameStringYes (Not required in the case of PubMatic Group Integrated & Manually Integrated)If provided, it should not be NULL in case of Fully Integrated and Semi Integrated.

Username used to Login into Ad Network's account.

passwordStringYes (Not required in the case of PubMatic Group Integrated & Manually Integrated)If provided, it should not be NULL in case of Fully Integrated and Semi Integrated.Password used to Log in  to Ad Network's account
fixedDealBooleanNo (Not required in case of Manually Integrated, Fully Integrated & PubMatic Group Integrated)

 

Used to mark Ad Network as Fixed Deal

Examples

Sample Request URL

http://localhost/networkmanagement/publisherAdNetwork

Sample Request JSON:

{
  "id":2201,
   "publisherId":2685,
   "userName":"test",
   "password":"test"
}

Response

Sample Response JSON:

{
  "id": 2201,
  "publisherAdServerAccountId": 56179,
  "publisherId": 2685,
  "accountStatusId": 1,
  "userName": "test",
  "password": "test",
  "credentialsAvailable": true,
  "name": "152 Media 100% INW UK",
  "adServerPublisherId": "test",
  "associated": 1,
  "isActive": true,
  "creationDate": "2016-06-24 18:54:52",
  "modificationDate": "2016-06-24 18:54:52",
  "fixedDeal": false
}

Error Codes

Error CodeError Description
CC01_0002Either the Ad Network Id or Publisher Id provided is invalid (Does not exist or deactivated in the PubMatic system).
UNABLE_TO_LOGINEither the credentials are not provided or automated scripts are unable to validate credentials.

 

Update Publisher Ad Network

Overview

Request

Response

Error Codes

Overview

This method is used to update properties of an already-linked Ad Network using a PubMatic API.

It can be used to :

  • Pause/Resume Ad Network
  • Ad Network can be paused only if it is not the last live Ad Network linked to any of the Ad Tags
  • Mark/Unmark Ad Network as fixed deal
  • Update Credentials of Semi Integrated & Fully Integrated Ad Networks
  • If credentials are provided (In case of Fully Integrated & Semi Integrated) then internally automated scripts are called to verify the credentials by logging into the Ad Network or hitting Ad Network's API. If automated scripts are able to log into the Ad Network's UI or get expected response from Ad Network's API then only credentials are updated else Error 'UNABLE_TO_LOGIN' is thrown.
  • Mark Semi Integrated Ad Network to run in Manually Integrated mode and vice-versa
  • Enable or Disable Semi Integrated mode of Ad Network

Request

URI${URI_PREFIX}/networkmanagement
HTTP MethodPUT

Request Headers   

Header Name

Type

Required

Value

Description

Content-typeStringYesMust be application/jsonMedia type that is to be returned in search/sort operation.

PubToken

String

Yes

Bearer ${access_token}

Need to send the access token generating for authentication at the place of ${access_token}.

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

Request Query Parameters   

Parameter Name

Type

Required

Value

Description

pauseAdNetworkBooleanNo Used to pause or resume Ad Network (false = Pause the Ad Network)

enableDisableINW

Boolean

No

 

Used to enable or disable Semi Integrated mode of Semi Integrated Ad Network.

 

Request Body Parameters                           

ParameterTypeRequiredValidationsDescription
idLongYesAd Network Id should exist and be active in the PubMatic system.Id of Ad Network to be linked.
publisherIdLongYesPublisher Id should exist and be active in the PubMatic system.

Id of the Publisher to which the Ad Network needs to be linked.

userNameStringNo (Not required in the case of PubMatic Group Integrated & Manually Integrated)If provided, it should not be NULL in case of Fully Integrated and Semi Integrated.

Username used to Login into Ad Network's account.

passwordStringNo (Not required in the case of PubMatic Group Integrated & Manually Integrated)If provided, it should not be NULL in case of Fully Integrated and Semi Integrated.Password used to Log in  to Ad Network's account
fixedDealBooleanNo (Not required in case of Manually Integrated, Fully Integrated & PubMatic Group Integrated)

 

Used to mark Ad Network as Fixed Deal

Examples

Sample Request URLs

Update PublisherAdNetwork association properties: http://localhost/networkmanagement/publisherAdNetwork

Pause or Resume Ad Network: http://localhost/networkmanagement/publisherAdNetwork?pauseAdNetwork=false

Sample Request JSON:

{
    "id": 2343,
    "publisherId": 2685,
    "userName": "test",
    "password": "test",
    "fixedDeal": false
  }


Response

Sample Response JSON:

{
    "id": 2256,
    "publisherAdServerAccountId": 46082,
    "publisherId": 2685,
    "userName": "test",
    "credentialsAvailable": true,
    "adNetworkType": "INW",
    "name": "YieldOne Japan INW",
    "associated": 1,
    "adNetwork": {
       "indirectCampaignFlag": false,
       "interfaceId": 2256,
       "id": 2256
    },
    "fixedDeal": true
  }


Error Codes

Error CodeError Description
CC02_0006User is not allowed to enable or disable Semi Integrated mode.
CC01_0002Either the Ad Network Id or Publisher Id provided is invalid (Does not exist or deactivated in the PubMatic system).
UNABLE_TO_LOGINEither the credentials are not provided or automated scripts are unable to validate credentials.
LAST_LIVE_ADNETWORKIf the Ad Network requested to be paused is the only Ad Network linked to any of the Ad Tags.

 

Get Ad Networks

Overview

Request

Response

Error Codes

Overview

This method is used to get all the Ad Networks present in the system. This API is consumed by Bulk Placement Operations.

Request

URI${URI_PREFIX}/networkmanagement/adNetworks
HTTP MethodGET

Request Headers      

Header Name

Type

Required

Value

Description

Content-typeStringYesMust be application/jsonMedia type that is to be returned in search/sort operation.

PubToken

String

Yes

Bearer ${access_token}

Need to send the access token generating for authentication at the place of ${access_token}.

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

Request Query Parameters

Parameter Name

Type

Required

Value

Description

networkTypeStringYes 

Valid values to be passed depending upon type of network required are

  • INDIRECT(1), INDIRECT_WITH_WRAPPERS(2), PCI(3), PCG(4), PCGH(5)

E.g., To get all IN and INW present in the system

networkType=INDIRECT&networkType=INDIRECT_WITH_WRAPPERS

Needs to be passed as query parameter.

Example

Sample Request URL

http://localhost:8081/networkmanagement/adNetworks?networkType=INDIRECT&networkType=INDIRECT_WITH_WRAPPERS

Response

Sample Response JSON:

{  "metaData": {
    "startIndex": 1,
    "totalRecords": 2247,
    "endIndex": 100
  },
  "items":
    {
      "id": 1850,
      "name": "01_ITC_47654::Genome",
      "networkType": "INDIRECT"
    },
    {
      "id": 11,
      "name": "121Media",
      "networkType": "INDIRECT"
    },
    {
      "id": 2202,
      "name": "152 Media 100% INW International",
      "networkType": "INDIRECT"
    },
    {
      "id": 2201,
      "name": "152 Media 100% INW UK",
      "networkType": "INDIRECT"
    },
    {
      "id": 1688,
      "name": "152Media AU 100% Fill",
      "networkType": "INDIRECT"
    },
    {
      "id": 1689,
      "name": "152Media DE 100% Fill",
      "networkType": "INDIRECT"
    },
    {
      "id": 1690,
      "name": "152Media FR 100% Fill",
      "networkType": "INDIRECT"
    },
    {
      "id": 1691,
      "name": "152Media IT 100% Fill",
      "networkType": "INDIRECT"
    },
    {
      "id": 2177,
      "name": "152Media Mobile Web CA 100% Fill",
      "networkType": "INDIRECT"
    },
    {
      "id": 2179,
      "name": "152Media Mobile Web INTL 100% Fill",
      "networkType": "INDIRECT"
    },..
]}

Notes:

  • Attaching partial response as response is too long.
  • Currently pagination is not being used. If required, it can be modified in a future iteration.
  •    
   

Search Ad Networks

Overview

Request

Response

Error Codes

Overview

This method is used to get all Ad Networks based on supported filter attributes.

If the Ad Network is already associated with the Publisher then PublisherAdNetwork association details are also returned in the response.

Request

URI${URI_PREFIX}/networkmanagement
HTTP MethodGET

Request Headers           

Header Name

Type

Required

Value

Description

Content-typeStringYesMust be application/jsonMedia type that is to be returned in search/sort operation.

PubToken

String

Yes

Bearer ${access_token}

Need to send the access token generating for authentication at the place of ${access_token}.

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

Request Query Parameters                                   

ParameterTypeRequiredValidationsDescription
publisherIdLongNo 

If the Ad Network is already linked to the Publisher then this parameter is used to get PublisherAdNetwork association properties.

networkTypeIntegerNo

 

Used to filter Ad Networks based on their Ad Network Type.
adNetworkIdLongNo Used to get details of a particular Ad Network
nameStringNo Used to filter Ad Networks based on Ad Network name.
dimensionsStringNo Used to support pagination
pageNumberIntegerNo Used to support pagination
pageSizeIntegerNo Used to support pagination
sortStringNo Used to sort fetched Ad Networks

networkType ENUM Identifiers for different Ad Network Integration modes

                            

Integration ModenetworkTypenetworkTypeId
Manually IntegratedIN1
Semi Integrated INW2
Fully IntegratedPCI3
PubMatic Group IntegratedPCGH4

Examples

Sample Request URLs

Filter Fully Integrated Ad Networks:

http://localhost/networkmanagement/adNetworks/extendedSearch?dimensions=name&filters=networkType+eq+3&pageNumber=1&pageSize=10&publisherId=2685&sort=name

Filter Ad Networks having names containing 'passback':

http://localhost/networkmanagement/adNetworks/extendedSearch?dimensions=name&filters=name like *passback*&filters=networkType+eq+2&pageNumber=1&pageSize=10&publisherId=2685&sort=name

Response

Sample Response JSON:


{
"metaData": {
"startIndex": 1,
"totalRecords": 7,
"endIndex": 7
},
"items": [{
"adNetwork": {
"name": "ClickBooth 100% fill Mobile Web",
"networkType": "INW",
"indirectCampaignFlag": false,
"guaranteedDelivery": true,
"restrictedVisibility": false,
"groupId": 171,
"interfaceId": 1821,
"id": 2233,
"coppaCompliant": false
}
}, {
"adNetwork": {
"name": "ClickBooth 3rd Party 100% fill INW",
"networkType": "INW",
"indirectCampaignFlag": false,
"guaranteedDelivery": true,
"restrictedVisibility": false,
"groupId": 171,
"interfaceId": 1870,
"id": 2349,
"coppaCompliant": true
}
}, {
"adNetwork": {
"name": "ClickBooth 3rd Party CA 100% fill INW",
"networkType": "INW",
"indirectCampaignFlag": false,
"guaranteedDelivery": true,
"restrictedVisibility": false,
"groupId": 171,
"interfaceId": 1870,
"id": 2373,
"coppaCompliant": true
}
}, {
"adNetwork": {
"name": "ClickBooth 3rd Party Mobile 100% fill INW",
"networkType": "INW",
"indirectCampaignFlag": false,
"guaranteedDelivery": true,
"restrictedVisibility": false,
"groupId": 171,
"interfaceId": 1870,
"id": 2366,
"coppaCompliant": true
}
}, {
"adNetwork": {
"name": "ClickBooth 3rd Party UK 100% fill INW",
"networkType": "INW",
"indirectCampaignFlag": false,
"guaranteedDelivery": true,
"restrictedVisibility": false,
"groupId": 171,
"interfaceId": 1870,
"id": 2372,
"coppaCompliant": true
}
}, {
"adNetwork": {
"name": "Clickbooth INW",
"networkType": "INW",
"indirectCampaignFlag": false,
"guaranteedDelivery": false,
"restrictedVisibility": false,
"groupId": 171,
"interfaceId": 1870,
"id": 1879,
"coppaCompliant": true
}
}, {
"adNetwork": {
"name": "ClickBooth INW 100% fill",
"networkType": "INW",
"indirectCampaignFlag": false,
"guaranteedDelivery": true,
"restrictedVisibility": false,
"groupId": 171,
"interfaceId": 1870,
"id": 1870,
"coppaCompliant": true
},
"publisherAdNetwork": {
"id": 1870,
"publisherAdServerAccountId": 41694,
"publisherId": 586,
"accountStatusId": 1,
"credentialsAvailable": true,
"name": "ClickBooth INW 100% fill",
"adServerPublisherId": "Match Media RS",
"associated": 1,
"isActive": true,
"fixedDeal": false
}
}]
}


Error Codes

Error CodeError Description
filters=guaranteedDelivery eq trueEither filter is not supported or expected value is not passed to filter. e.g.
guaranteedDelivery filter requires Integer parameter so if Boolean parameter is passed then error will be thrown

 

Get Ad Networks by Ids

Overview

Request

Response

Overview

This method enables you to get details of an Ad Network based on its Id.

Request

URI${URI_PREFIX}/networkmanagement
HTTP MethodGET

Request Headers

Header Name

Type

Required

Value

Description

Content-typeStringYesMust be application/jsonMedia type that is to be returned in search/sort operation.

PubToken

String

Yes

Bearer ${access_token}

Need to send the access token generating for authentication at the place of ${access_token}.

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

Example

Sample Request URL

http://localhost:8081/networkmanagement/adNetworks/1850

 

Response

Response Body

                       

Response Body ParameterTypeDescription
IdLongNetwork Id
nameStringName of the network
networkTypeString

Type of network based on the integrations. Valid types include:

Manually Integrated (1), Semi Integrated (2), Fully Integrated (3), PubMatic Group Integrated (5)

Sample Response JSON:

{
      "id": 1850,
      "name": "01_ITC_47654::Genome",
      "networkType": "IN"
}

Download API

Overview

Request

Response

 

Overview

This is a generic API which will be to cater all download requirements of Ad Network API. Currently download option is provided only for adnetwork placements.

Different URI can be created based on resource to which download functionality is to be extended.

Request         

URI${URI_PREFIX}/networkmanagement/download/adnetworkPlacements‰ÛÜ
HTTP MethodGET

Request Headers              

Header Name

Type

Required

Value

Description

Content-typeStringYesMust be application/csvMedia type that is to be returned in download operation.

Request Query Parameters                               

ParameterTypeRequiredValidationsPuDescription
PubTokenStringYes This is passed as a query parameter, as Download doesn't support header authentication, therefore, QueryParam Authentication is used.
pubIdLongYes 

Publisher for whom the placements are to be downloaded.

placementsList of LongNo If there are particular placements that need to be exported that can be done by passing their ids in placementIds.

Example

Request URL

http://localhost:8081/networkmanagement/download/adnetworkPlacements?PubToken=adminuser&pubId=586

Response

Sample Download:

Sample download (actual download would be .csv format)

 

Create Ad Network Placement

Overview

Request

Response

Error Codes

Overview

This method is used to create Manually Integrated, Semi Integrated & PubMatic Group Integrated Ad Network placement using the PubMatic API.

For Placement Creation:

  • For Semi Integrated and PubMatic Group Integrated, it internally calls automated scripts for fetching channelId if it is not specified explicitly in JSON.
  • If channelId is specified explicitly in JSON then the automated scripts will not be called to fetch channelId.

 

Request       

URI${URI_PREFIX}/networkmanagement
HTTP MethodPOST

Request Headers   

Header Name

Type

Required

Value

Description

Content-typeStringYesMust be application/jsonMedia type that is to be returned in search/sort operation.

PubToken

String

Yes

Bearer ${access_token}

Need to send the access token generating for authentication at the place of ${access_token}.

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

Request Query Parameters                               

Parameter Name

Type

Required

Value

Description

entityIdLongYes Need to pass the publisher Id in this field for which placement is to be created.

startDate

String

No

 

Used to set Placement start time. By default, PST timestamp is saved.

endDateStringNoShould be today or after today's date.Used to set PST date until which the Placement will be active. If not passed, then the placement will always be active. Not used for PubMatic Group Integrated.

 

Request Body Parameters                                                               

ParameterTypeRequiredValidationsDescription
nameStringYes Placement name
adNetworkIdLongYes Id of Ad Network for which placement needs to be created
adScriptStringYes Ad Script of the Ad Network for which placement needs to be created
ecpmDoubleYes (Not required in case of PubMatic Group Integrated)allowable limit - 999.99 USDeCPM to be used during auctioning
currencyEnumYes (Not required in case of PubMatic Group Integrated)

Valid Values Include:

USD(1), EUR(2), GBP(3), CAD(4), AUD(5), SEK(6), CHF(7), CZK(8), DKK(9), BRL(10), NZD(11), JPY(12),  MYR(13), THB(14), SGD(15), IDR(16), PHP(17), KRW(18), TWD(19), HKD(20), CNY(21), AED(22), SAR(23), NOK(24), PLN(25), ILS(26), TRY(27), ZAR(28), RUB(29), HUF(30), INR(31), ARS(32), CLP(33), KWD(34), MXN(35), BHD(36), VEF(37), COP(38), HRK(39), MUR(40), OMR(41), QAR(42), RON(43)

Whenever new currency is added, update is required of the file. 

common/reporting/enums/Currency.java

adSizeJSON ObjectYes JSON Object of Ad Sizes supported under PubMatic Platform
channelId StringNo (Mandatory in case of Semi Integrated Placement creation) ID of the channel for the placement.
siteIdLongYes for PubMatic Group Integrated PubMatic Id of the Publisher's Site under which placement needs to be created.

Examples

Sample Request URLs

http://localhost/networkmanagement/adNetworkPlacement?entityId=2685&endDate=2016-6-22&startDate=2016-06-21‰ÛÜ 

Sample Request JSON:

For Manually Integrated/Semi Integrated:

{ 
   "name":"Test_Placement_Create",
   "adNetworkId":165,
   "adScript":"<a href=\"http://pubmatic.com\" target=\"_blank\"><img src=\"http://64.106.163.182/test.php?width=300&height=250\" width=\"300\" height=\"250\" border=\"0\" alt=\"\"></a>",
   "ecpm":0.0,
   "currency":"USD",
   "adSize":{
      "id":9
   }
}

For PubMatic Group Integrated:

{
"name":"Test_Placement_PCGH",
"AdNetworkId":1821,
"adScript":"test",
"adSize":{
"id":9
},
"siteId":135757
}

Response

Sample Response JSON:

For Manually Integrated/Semi Integrated:    


{
  "name": "Test_Placement_Create",
  "adNetworkId": 165,
  "adNetworkName": "Publisher Network 100% fill",
  "adScript": "<a href=\"http://pubmatic.com\" target=\"_blank\"><img src=\"http://64.106.163.182/test.php?width=300&height=250\" width=\"300\" height=\"250\" border=\"0\" alt=\"\"></a>",
  "ecpm": 0,
  "currency": "USD",
  "endDate":"2016-06-22 23:59:59",
  "isPaused": 0,
  "creationDate":"2016-06-21 03:17:42",
"modificationDate":"2016-06-21 03:17:42",
"publisherId":2685,
"isPassback":false,
"isLastLive:":false,
"adSize":{
"name":"Sidekick",
"width":300,
"height":250,
"categoryId":1,
"id":9
},
"runIndefinily":false
  "id": 131837
}


  For PubMatic Group Integrated:

{
"name": "Publisher_Passback_Mobile_Android_App_Internal_234x60_test_Create_size",
"adNetworkId": 3107,
"adNetworkName": "Publisher Passback Mobile Android App Internal",
"adScript": "test",
"ecpm": 0.6,
"currency": "INR",
"channelId": "test",
"endDate": "2016-06-22 23:59:59",
"isPaused": 0,
"creationDate": "2016-06-21 03:17:42",
"modificationDate": "2016-06-21 15:47:42",
"publisherId": 2685,
"isPassback": false,
"isLastLive": false,
"adSize":
{
"name": "300x250 - Sidekick",
"width": 300,
"height": 250,
"categoryId": 1,
"id": 9
},
"runIndefinetly":false,
"id": 460156
}


Error Codes

Error CodeError Description
INVALID_ECPMSpecified Publisher eCPM (USD equivalent) exceeds max allowable limit of 999.99 USD
WORKFLOW_009Please select an End date that is on or after today's date

 

Update Ad Network Placement

Overview

Request

Response

Error Codes

Overview

This method is used to update Ad Network placement using the PubMatic API.

This API currently supports update for Manually Integrated, Semi Integrated & PubMatic Group Integrated Ad Network Placements.

In update scenario:

  • Update is allowed for all fields for Manually Integrated (identified by credentials_available=0 in publisher_adserver_account table)
  • If channelId is not passed explicitly in json then internally automated script for fetching channelId is called. In case of Semi Integrated & PubMatic Group Integrated if channelId could not be fetched then error will be thrown as channelId is mandatory.
  • If channelId is passed explicitly in json then in case of Semi Integrated & PubMatic Group Integrated automated scripts will not be called to fetch channelId.
  • If credentials_available=1 in publisher_adserver_account and fixed_deal=1 then it will behave as IN i.e all fields edit will be allowed
  • If credentials_available=1 and fixed_deal=0 then it will be Semi Integrated placement and fields like currency and eCPM will be non-editable.
  • AdSize & StartDate is non-editable in all scenarios.
  • This API will also be used to pause/resume Ad Network Placements.
  • Placement will not be paused if it is the only placement linked to any Ad Tag.

Request         

URI${URI_PREFIX}/networkmanagement/
HTTP MethodPUT

Request Headers                    

Header Name

Type

Required

Value

Description

Content-typeStringYesMust be application/jsonMedia type that is to be returned in search/sort operation.

PubToken

String

Yes

Bearer ${access_token}

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 Query Parameters                                             

Parameter Name

Type

Required

Value

Description

entityIdLongYes Need to pass the publisher Id in this field for which placement is to be created.
adnetworkIdLongYes Id of the Ad Network for which placement needs to be updated.
pausPlacementIntegerNo

0=Resume Placement

1=Pause Placement

Used to pause or resume Ad Network placement.

startDate

String

No

 

Used to set Placement start time. By default, PST timestamp is saved.

endDateStringNoShould be today or after today's date.Used to set PST date until which the Placement will be active. If not passed, then the placement will always be active. Not used for PubMatic Group Integrated.

 

Examples

Sample Request URLs

Update Placement : http://localhost/networkmanagement/adNetworkPlacement/12057?entityId=2685&adnetworkId=1821

Pause Placement : http://localhost/networkmanagement/adNetworkPlacement/8138?entityId=2685&adnetworkId=1821&pausePlacement=1

Resume Placement : http://localhost/networkmanagement/adNetworkPlacement/8138?entityId=2685&adnetworkId=1821&pausePlacement=0

 

Sample Request JSON:

Note : If Ad Network placement needs to paused then request body should be set to 'null'.

   

For Manually Integrated/Semi Integrated:

{
  "name":"passback_TestAdTag_V11466594608285_586732",
  "adNetworkId":165,
  "adScript":"test",
  "channelId":"",
  "adSize":{
     "id":9
   },
   "ecpm":"0.54",
   "currency":"USD"
}

 

For PubMatic Group Integrated:

{
  "name":"ClickBooth_PCGH_100%_fill_250x250",
  "adNetworkId":1821,
  "adScript":"server_publisher_channels = \"123456\"",
  "adSize":{
    "id":2
  },
  "siteId":135757
}

Response

Sample Response JSON:

For Manually Integrated/Semi Integrated:   

{
  "name": "Test_Placement_Update",
  "adNetworkId": 165,
  "adNetworkName": "Publisher Network 100% fill",
  "adScript": "<a href=\"http://pubmatic.com\" target=\"_blank\"><img src=\"http://64.106.163.182/test.php?width=300&height=250\" width=\"300\" height=\"250\" border=\"0\" alt=\"\"></a>",
  "ecpm": 0,
  "currency": "USD",
  "isPaused": 0,
  "adSize": {
    "name": "Sidekick",
    "width": 300,
    "height": 250,
    "id": 9
  }
}

  For PubMatic Group Integrated:

 

{
  "name": "ClickBooth_PCGH_100%_fill_250x250",
  "adNetworkId": 1821,
  "adNetworkName": "ClickBooth PCGH 100% fill",
  "adScript": "server_publisher_channels = \"123456\"",
  "isPaused": 1,
  "creationDate": "2016-06-21 16:07:43",
  "modificationDate": "2016-06-23 19:27:30",
  "siteId": 135757,
  "publisherId": 2685,
  "isPassback": false,
  "isLastLive": false,
  "adSize": {
    "name": "250x250 - Square",
    "width": 250,
    "height": 250,
    "categoryId": 0,
    "id": 2
  },
  "id": 12057,
  "gfill": true
}

 

Error Codes

Error CodeError Description
INVALID_ECPMSpecified Publisher eCPM (USD equivalent) exceeds max allowable limit of 999.99 USD.
WORKFLOW_009Please select an End date that is on or after today's date.
WORKFLOW_004Last live placement cannot be paused.
CC01_0004adSizeId is read only, please do not update it.
CC01_0004eCPM is read only, please do not update it.

 

Delete Ad Network Placement

Overview

Request

Response

Error Codes

Overview

This method is used to delete Ad Network placement using the Pubmatic API.

This API currently supports deletion of IN and INW placements.

Request

URI${URI_PREFIX}/networkmanagement
HTTP MethodDELETE

Request Headers                        

Header Name

Type

Required

Value

Description

Content-typeStringYesMust be application/jsonMedia type that is to be returned in search/sort operation.

PubToken

String

Yes

Bearer ${access_token}

Need to send the access token generating for authentication at the place of ${access_token}.

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

Request Query Parameters                 

Parameter Name

Type

Required

Value

Description

entityIdLongYes Need to pass the publisher Id in this field for which placement is to be created.

 

Examples

Sample Request URL

http://localhost:8081/adnetwork/adNetworkPlacement/131837?entityId=24440‰ÛÜ

Response

Sample Response JSON:

{
  "name": "Test_Placement_Update",
  "adNetworkId": 165,
  "adNetworkName": "Publisher Network 100% fill",
  "adScript": "<a href=\"http://pubmatic.com\" target=\"_blank\"><img src=\"http://64.106.163.182/test.php?width=300&height=250\" width=\"300\" height=\"250\" border=\"0\" alt=\"\"></a>",
  "ecpm": 0,
  "currency": "USD",
  "endDate":"2016-06-22 23:59:59",
  "creationDate":"2016-06-21 03:17:42",
  "modificationDate":"2016-06-21 15:47:42",
  "publisherId":2685,
  "isPaused": 0,
  "adSize": {
    "name": "Sidekick",
    "width": 300,
    "height": 250,
    "id": 9
  },
  "runIndefinetly":false,
  "id": 131837
}

 Error Codes

Error CodeError Description
CC03_0003Either the Publisher Id is invalid or does not exist/not active in PubMatic System.
CC01_0002Either Placement Id is already deleted or does not exist in PubMatic System.

 

Get Ad Network Placement

Overview

This method is used to get all Ad Network placements for a given criteria. This API is used by Bulk Placement Operations.

Request         

URI${URI_PREFIX}/networkPlacement
HTTP MethodGET

Request Headers

Header Name

Type

Required

Value

Description

Content-typeStringYesMust be application/jsonMedia type that is to be returned in search/sort operation.

PubToken

String

Yes

Bearer ${access_token}

Need to send the access token generating for authentication at the place of ${access_token}.

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

Request Query Parameters                                                                                    

ParameterTypeRequiredValidationsDescription
pubIdStringYes 

Id of the Publisher for which placement is Created.

adSizeIdStringNo

Used to add filter on AdSize. (e.g., adSizeId=9,7)

adNetworkIdStringNo Used to add filter on AdNetwork. (e.g., adNetworkId=138, 140)
adNetworkNameStringNo 

Used to get placements associated with the Ad Network based on name.

fromDateStringNo

Used for start of date range.

toDateStringNo

Used for end of date range.

pageNumberLongNo Used to support pagination.
pageSizeLongNo Used to support pagination.

 

Examples:

Sample URLs

 

http://localhost:8080/networkmanagement/adNetworkPlacement?pubId=60769&fromDate=1970-01-01&toDate=2014-08-26&pageNumber=1&pageSize=200&adSizeId=9,7&adNetworkId=138

 

*Internal* http://localhost:8080/networkmanagement/adNetworkPlacement?PubToken=<PUBTOKEN>&pubId=60769&fromDate=1970-01-01&toDate=2014-08-26&pageNumber=1&pageSize=200&adSizeId=9,7&adNetworkId=138

 

Error Codes

Error CodeError Description
CCO#_0001NO_RECORDS_FOUND
WORKFLOW_007Invalid Date Range

 

Search Ad Network Placement

Overview

Request

Response

Error Codes

Overview

This method is used to get all Ad Network placements for supported filter attributes.

Request         

URI${URI_PREFIX}/networkmanagement
HTTP MethodGET

Request Headers

Header Name

Type

Required

Value

Description

Content-typeStringYesMust be application/jsonMedia type that is to be returned in search/sort operation.

PubToken

String

Yes

Bearer ${access_token}

Need to send the access token generating for authentication at the place of ${access_token}.

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

Request Query Parameters                                                                                    

ParameterTypeRequiredValidationsDescription
publisherIdLongYes 

Used to get all the placements associated with the Publishers.

placementIdLongNo Used to get a particular placement.
nameStringNo Used to get placements based on the name.
adNetworkIdLongNo Used to get placements associated with the Ad Network based on the Id.
adNetworkNameStringNo 

Used to get placements associated with the Ad Network based on name.

isPausedIntegerNo Used to get placements by the state (paused = 0 & active = 1)
siteIdLongNo

 

Used to get placements associated with the Publisher Site (applicable only for PCGH Ad Networks)
adSizeAdSizeNo Used to get placements based on Ad Size.
pageNumberLongNo Used to support pagination.
pageSizeLongNo Used to support pagination.
sortStringNo Used for Sorting (sort=name will sort result in descending order of Ad Networks name.)

Note: Sorting is provided on modificationDate

   

Examples

Request URL

Fetch 1st 10 placements in descending order :

http://localhost/networkmanagement/adNetworkPlacement/search?dimensions=modificationDate&filters=publisherId+eq+2685&pageNumber=1&pageSize=10&sort=-modificationDate

 

Response

Sample Response JSON:

{
"metaData": {
"startIndex": 1,
"totalRecords": 289,
"endIndex": 100
},
"items": [{
"name": "cpx_international_plcmnt_TestPCGHUpdate",
"adNetworkId": 858,
"adNetworkName": "CPX PCGH International 100% fill",
"adScript": "<!-- BEGIN STANDARD TAG - 300 x 250 - Rev\nShare: Run-of-site - DO NOT MODIFY -->\n<SCRIPT TYPE=\"text/javascript\"\nSRC=\"http://adserving.cpxinteractive.com/st?ad_type=ad&ad_size=300x250&section=1563714\"></SCRIPT>\n",
"isPaused": 0,
"creationDate": "2010-12-09 16:37:16",
"modificationDate": "2016-04-12 14:29:06",
"siteId": 2686,
"isPassback": false,
"isLastLive": true,
"adSize": {
"name": "300x250 - Sidekick",
"width": 300,
"height": 250,
"categoryId": 0,
"id": 9
},
"adTagCount": 2,
"publisherAdNetwork": {
"id": 858,
"publisherAdServerAccountId": 29910,
"publisherId": 2685,
"userName": "PM_ONE_USERNAME",
"credentialsAvailable": false,
"adNetworkType": "PCGH",
"name": "CPX PCGH International 100% fill",
"associated": 0,
"isPassback": false,
"isLastLive": true,
"adNetwork": {
"indirectCampaignFlag": false,
"id": 858
},
"fixedDeal": false
},
"id": 881,
"gfill": true,
"ecpmUpdateRequired": 1
}, {
"name": "test_technorati_new_platform",
"adNetworkId": 921,
"adNetworkName": "Technorati Media PCGH 100% Fill",
"adScript": "<!-- BEGIN UAT - 300x250 - BUZZBox_Media: BuzzBoxMedia_US_300x250 - DO NOT MODIFY -->\n<script type=\"text/javascript\" src=\"http://ad-cdn.technoratimedia.com/00/07/07/uat_10707.js?ad_size=300x250\"></script>\n<!-- END TAG -->",
"isPaused": 0,
"creationDate": "2011-06-28 13:26:28",
"modificationDate": "2011-06-28 13:36:26",
"siteId": 2686,
"isPassback": false,
"isLastLive": true,
"adSize": {
"name": "300x250 - Sidekick",
"width": 300,
"height": 250,
"categoryId": 0,
"id": 9
},
"adTagCount": 3,
"publisherAdNetwork": {
"id": 921,
"publisherAdServerAccountId": 32541,
"publisherId": 2685,
"userName": "PM_ONE_USERNAME",
"credentialsAvailable": false,
"adNetworkType": "PCGH",
"name": "Technorati Media PCGH 100% Fill",
"associated": 0,
"isPassback": false,
"isLastLive": true,
"adNetwork": {
"indirectCampaignFlag": false,
"id": 921
},
"fixedDeal": false
},
"id": 1883,
"gfill": true,
"ecpmUpdateRequired": 1
}, {
"name": "test_technorati_new_platform_1",
"adNetworkId": 921,
"adNetworkName": "Technorati Media PCGH 100% Fill",
"adScript": "<!-- BEGIN UAT - 300x250 - NationalGeographic_Pubmatic: NationalGeographic_Pubmatic - DO NOT MODIFY -->\n<script type=\"text/javascript\" src=\"http://ad-cdn.technoratimedia.com/00/89/35/uat_13589.js?ad_size=300x250\"></script>\n<!-- END TAG -->",
"isPaused": 0,
"creationDate": "2011-06-28 13:28:42",
"modificationDate": "2011-06-28 13:28:42",
"siteId": 2686,
"isPassback": false,
"isLastLive": true,
"adSize": {
"name": "Leaderboard-728X90",
"width": 728,
"height": 90,
"categoryId": 0,
"id": 7
},
"adTagCount": 5,
"publisherAdNetwork": {
"id": 921,
"publisherAdServerAccountId": 32541,
"publisherId": 2685,
"userName": "PM_ONE_USERNAME",
"credentialsAvailable": false,
"adNetworkType": "PCGH",
"name": "Technorati Media PCGH 100% Fill",
"associated": 0,
"isPassback": false,
"isLastLive": true,
"adNetwork": {
"indirectCampaignFlag": false,
"id": 921
},
"fixedDeal": false
},
"id": 1884,
"gfill": true,
"ecpmUpdateRequired": 1
}, {
"name": "clickbooth",
"adNetworkId": 1821,
"adNetworkName": "ClickBooth PCGH 100% fill",
"adScript": "<!-- Begin Ads by Clickbooth Code -->\n<script language=\"javascript\"><!--//\nvar server_client_id = 4561;\nvar server_ad_channel = -1;\nvar server_publisher_channels = \"10715\";\nvar server_media_types = \"hybrid\";\nvar server_integrate_media_types = 0;\nvar server_ad_width = 728;\nvar server_ad_height = 90;\nvar server_ad_style = \"728x90_as\";\nvar server_code_version = \"4\";\nvar server_body_color = \"000000\";\nvar server_ad_color_border = \"F0EFEF\";\nvar server_ad_color_background = \"FFFFFF\";\nvar server_ad_color_headline = \"0066CC\";\nvar server_ad_color_body = \"666666\";\nvar server_ad_color_url = \"0066CC\";\nvar server_ad_color_rollover_description = \"0066CC\";\nvar server_ad_color_rollover_url = \"0066CC\";\nvar server_ad_color_rollover_title = \"0066CC\";\nvar server_ad_color_rollover_start = \"FFFFFF\";\nvar server_ad_color_rollover_end = \"E8F1F6\";\nvar server_ad_color_rollover_fallback = \"FFFFFF\";\nvar server_ad_random = 1;\nvar server_ads_by= \"yes\";\nvar server_target= \"1\";\nvar server_img_rounding= \"no\";\nvar server_title = \"\";\nvar CBV = Math.random();\ndocument.write('<script type=\"text/javascript\" src=\"http://jmp.clickbooth.com/ads/display_ads.php?CBV='+CBV+'\"></sc' + 'ript>');\n//--></script>\n<!-- End Ads by Clickbooth Code -->",
"isPaused": 1,
"creationDate": "2013-05-20 14:20:00",
"modificationDate": "2016-04-12 14:29:07",
"siteId": 30451,
"isPassback": false,
"isLastLive": false,
"adSize": {
"name": "Leaderboard-728X90",
"width": 728,
"height": 90,
"categoryId": 0,
"id": 7
},
"adTagCount": 0,
"publisherAdNetwork": {
"id": 1821,
"publisherAdServerAccountId": 41468,
"publisherId": 2685,
"userName": "PM_ONE_USERNAME",
"credentialsAvailable": false,
"adNetworkType": "PCGH",
"name": "ClickBooth PCGH 100% fill",
"associated": 0,
"isPassback": false,
"isLastLive": true,
"adNetwork": {
"indirectCampaignFlag": false,
"interfaceId": 1821,
"id": 1821
},
"fixedDeal": false
},
"id": 8138,
"gfill": true,
"ecpmUpdateRequired": 1
}...]
}

Error Codes

Error CodeError Description
filters=isPaused eq falseEither the filter is not supported or the parameter is not passed to filters in the expected format. E.g., isPaused filter expects Integer value and if Boolean is passed then it throws an error.

 

Get Ad Network Placement Details by Placement Id

Overview

Request

Response

 

Overview

This method is used to get all the details of a particular Ad Network placement.

Request

URI${URI_PREFIX}/networkmanagement
HTTP MethodGET

Request Headers        

Header Name

Type

Required

Value

Description

Content-typeStringYesMust be application/jsonMedia type that is to be returned in search/sort operation.

PubToken

String

Yes

Bearer ${access_token}

Need to send the access token generating for authentication at the place of ${access_token}.

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

Request Query Parameters

ParameterTypeRequiredValidationsDescription
pubIdLongYes 

Id of the Publisher for which placement is Created.

 

Examples

Sample Request URL

http://localhost/networkmanagement/adNetworkPlacement/460158?pubId=2685&adNetworkId=165

 

Response

Sample Response JSON:

    

{
  "name": "passback_TestAdTag_V11466594608285_586732",
  "adNetworkId": 165,
  "adNetworkName": "Publisher Passback 100% fill",
  "ecpm": 1,
  "currency": "USD",
  "isPaused": 1,
  "creationDate": "2016-06-22 16:53:29",
  "modificationDate": "2016-06-23 17:57:55",
  "isPassback": true,
  "isLastLive": false,
  "adSize": {
    "name": "300x250 - Sidekick",
    "width": 300,
    "height": 250,
    "categoryId": 1,
    "id": 9
  },
  "runIndefinetly": true,
  "id": 460158
}

 

 

Attachments

    Outcomes