PublisherAdNetworkService

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

This interface allows you to add, retrieve, modify and delete the primary and placement information of the publisher's ad network from the PubMatic system.

It includes the following methods:

                           

Method

Description

getAdNetworks

This method allows you to retrieve the ad networks' details for a specific publisher.

getAdNetworkPlacements

This method allows you to retrieve the ad network's placement details for a specific publisher.

createNonIntegratedAdNetworkPlacement

This method allows you to add a non-integrated ad network's placement details for

a specific publisher.

deleteNonIntegratedAdNetworkPlacement

This method allows you to delete a non-integrated ad network's placement details

for a specific publisher.

updateNonIntegratedAdNetworkPlacement

This method allows you to modify a non-integrated ad network's placement details

for a specific publisher.

 

getAdNetworks

This method allows you to retrieve the ad networks' details for a specific publisher.

Input Parameters

Parameters

Type

Status

Description

accessToken

String

Mandatory

Indicates the access token, which you have obtained from PubMatic. For more information, refer to Getting Started with PubMatic APIs 

publisherId

Long

Mandatory

Indicates the ID of the publisher whose information you want to retrieve.

adNetworkType

AdNetworkType

Mandatory

Indicates the type of ad network whose information you want to retrieve.

adNetworkIds

List of Long

Optional

Indicates a list of IDs of the ad networks whose information you want to retrieve.

Note: If this value is not specified, then this method retrieves the details of all the ad networks associated with the specified publisher from the PubMatic system.

 

Output

This method generates the output data as a list of AdNetwork beans.

AdNetworkType Enum

This enum indicates the type of ad network.

It supports the following values:

 

Values

Description

INTEGRATED

Indicates an ad network integrated with the PubMatic system.

NON-INTEGRATED

Indicates an ad network which is not integrated with the PubMatic system.

GROUP

Indicates an ad network which is associated with a group of ad networks.

 

AdNetwork Bean

This bean contains the details of an ad network.

 

Members

                         

Field

Type

Description

adNetworkId

Long

Indicates the ID of the ad network.

adNetworkType

AdNetworkType

Indicates the type of ad network.

name

String

Indicates the name of the ad network.

 

getAdNetworkPlacements

 

This method allows you to retrieve the ad network's placement details for a specific publisher.

Input Parameters

Parameters

Type

Status

Description

accessToken

String

Mandatory

Indicates the access token, which you have obtained from PubMatic. For more information, refer to Getting Started with PubMatic APIs 

publisherId

Long

Mandatory

Indicates the ID of the publisher whose information you want to retrieve.

adNetworkId

Long

Mandatory

Indicates the ID of the ad network associated with the publisher whose information you want to retrieve.

placementIds

List of Long

Optional

Indicates a list of IDs of the ad network's placements whose information you want to retrieve.

Note: If this value is not specified, then this method retrieves the details of all the placements associated with the specified ad network from the PubMatic system.

 

Output

This method generates the output data as a list of Placement beans.

 

Placement Bean

 

This bean contains the details of an ad network's placement.

Members

  

Field

Type

Description

adNetworkId

Long

Indicates the ID of the ad network whose placement details are provided.

Note: This field's value should not be modified while updating a placement's details using updateNonIntegratedAdNetworkPlacement.

adNetworkName

String

Indicates the name of the ad network.

Note: This field is optional while creating a new placement (using createNonIntegratedAdNetworkPlacement) or updating a placement's details (using updateNonIntegratedAdNetworkPlacement).

adScript

String

Indicates the details of the ad tag script.

adSizeId

Long

Indicates the ID of the ad size.

Note: This field's value should not be modified while updating a placement's details using updateNonIntegratedAdNetworkPlacement.

currencyType

Currency

Indicates the type of currency used to indicate the below-mentioned eCPM.

ecpm

Double

Indicates the eCPM value configured between the ad network and the publisher.

name

String

Indicates the name of the placement.

placementId

Long

Indicates the unique ID of the placement.

Note:
This field should be set to 0 while creating a new placement using createNonIntegratedAdNetworkPlacement.

 

This field's value should not be modified while updating a placement's details using updateNonIntegratedAdNetworkPlacement.

channelId

String

Indicates the ID of the channel for the placement.

Note: This field is optional while creating a new placement (using createNonIntegratedAdNetworkPlacement) or updating a placement's details (using updateNonIntegratedAdNetworkPlacement).

channelName

String

Indicates the name of the channel for the placement.

Note: This field is optional while creating a new placement (using createNonIntegratedAdNetworkPlacement) or updating a placement's details (using updateNonIntegratedAdNetworkPlacement).

 

Currency Enum

This enum indicates the currency details.

It supports the following values:

                                   

Values

Description

AUD

Indicates Australian Dollar

CAD

Indicates Canadian Dollar

CHF

Indicates Swiss Franc

EURO

Indicates Euro

GBP

Indicates British Pound

SEK

Indicates Swedish Krona

USD

Indicates U.S. Dollar

 

createNonIntegratedAdNetworkPlacement

This method allows you to add a non-integrated ad network's placement details for a specific publisher.

Input Parameters

Parameters

Type

Status

Description

accessToken

String

Mandatory

Indicates the access token, which you have obtained from PubMatic. For more information, refer to Getting Started with PubMatic APIs 

publisherId

Long

Mandatory

Indicates the ID of the publisher whose information you want to update.

placement

Placement

Mandatory

Indicates the placement details of the non-integrated ad network.

 

Output

This method generates the output data as a Placement bean.

 

deleteNonIntegratedAdNetworkPlacement

This method allows you to delete a non-integrated ad network's placement details for a specific publisher.

Input Parameters

Parameters

Type

Status

Description

accessToken

String

Mandatory

Indicates the access token, which you have obtained from PubMatic. For more information, refer to Getting Started with PubMatic APIs 

publisherId

Long

Mandatory

Indicates the ID of the publisher whose information you want to update.

adNetworkId

Long

Mandatory

Indicates the ID of the non-integrated ad network whose placement you want to delete.

placementId

Long

Mandatory

Indicates the ID of the placement that you want to delete.

 

Output

This method generates the output data as a Placement bean.

 

updateNonIntegratedAdNetworkPlacement

This method allows you to modify a non-integrated ad network's placement details for a specific publisher.

Input Parameters

Parameters

Type

Status

Description

accessToken

String

Mandatory

Indicates the access token, which you have obtained from PubMatic. For more information, refer to Getting Started with PubMatic APIs 

publisherId

Long

Mandatory

Indicates the ID of the publisher whose information you want to update.

placement

Placement

Mandatory

Indicates the placement details of the non-integrated ad network.

 

Output

This method generates the output data as a Placement bean.

 

Exception

This method generates the APIException class as an exception if there is any issue.

Attachments

    Outcomes