PublisherAdTagServices

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

This interface allows you to retrieve the primary and ad tag placement information of the publisher's ad tag from the PubMatic system.

It includes the following methods:

               

Method

Description

getAdTagPlacements

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

getAdTags

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

adPlacementToAdTag

This method allows you to add an ad placement to an ad tag for a specific publisher.

createAdTagforSite

This method allows you to create an ad tag for a specific publisher's site.

deleteAdTagForSite

This method allows you to remove an ad tag for a specific publisher's site.

removePlacementFromAdTag

This method allows you to delete an ad placement from an ad tag for a specific publisher.

updateAdTagForSite

This method allows you to modify the details of an ad tag belonging to a specific publisher's site.

updateAdTagPlacement

This method allows you to modify the details of an ad tag's placement for a specific publisher.

 

getAdTagPlacements

This method allows you to retrieve the ad tag'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.

siteId

Long

Mandatory

Indicates the ID of the publisher's Web site whose information you want to retrieve.

adTagId

Long

Mandatory

Indicates the ID of the ad tag whose information you want to retrieve.

 

Output

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

 

AdTagPlacement Bean

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

 

Members

                         

Field

Type

Description

adTagId

Long

Indicates the ID of an ad tag.

geos

Geo

Indicates the details of the geographical locations for which the given ad tag is used.

placement

Placement

Indicates the placement details of the ad tag.

 

Geo Bean

This bean contains the details of a geographical location.

 

Members

  

Field

Type

Description

geoId

Long

Indicates the unique ID of the geographical location.

name

String

Indicates the name of the geographical location.

 

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.

getAdTags

 

This method allows you to retrieve the ad tags' 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.

adtagIds

List of Long

Optional

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

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

 

Output

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

 

AdTag Bean

This bean contains the details of an ad tag.

 

Members

                                                       

Field

Type

Description

adSize

AdSize

Indicates the details of the ad size.

adTagId

Long

Indicates the ID of the ad size.

expansionDirection

ExpansionDirection

Indicates the direction in which an expandable ad will expand.

foldPlacement

FoldPlacement

Indicates the placement of the ad with respect to the fold.

name

String

Indicates the name of the ad tag.

pagePlacement

PagePlacement

Indicates the placement of the ad with respect to the Web page.

platform

Platform

Indicates the platform for which the ad sizes need to be retrieved.

publisherId

Long

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

siteId

Long

Indicates the ID of the publisher's Web site whose information you want to retrieve.

 

AdSize Bean

This bean contains the details of an ad size.

 

Members

                                             

Field

Type

Description

adSizeCategory

AdSizeCategory

Indicates the category of the ad size.

adSizeType

AdType

Indicates the type of ad.

height

Long

Indicates the height of the ad.

id

Long

Indicates the unique ID of the ad.

name

String

Indicates the name of the ad.

platform

Platform

Indicates the platform on which the ad will be displayed.

width

Long

Indicates the width of the ad.

 

AdType Enum

This enum indicates the type of an ad.

It supports the following values:

                                               

Values

Description

FLASH

Indicates a flash ad.

HTML

Indicates an HTML-based ad.

IMAGE_ONLY

Indicates an image ad.

LINK_UNIT

Indicates an ad that contains links to a list of topics related to the content of the Web page on which the ad will be displayed.

TEXT_FLASH

Indicates either a text ad or a flash ad.

TEXT_HTML

Indicates either a text ad or a HTML-based ad.

TEXT_IMAGE

Indicates either a text ad or an image ad.

TEXT_IMAGE_FLASH

Indicates either a text ad, an image ad or a flash ad.

TEXT_IMAGE_FLASH_HTML

Indicates either a text ad, an image ad, a flash ad or a HTML-based ad.

TEXT_ONLY

Indicates a text ad.

 

AdSizeCategory Enum

This enum indicates the category of an ad size. It supports the following values:

                               

Values

Description

HORIZONTAL

Indicates a horizontal ad.

INLINE

Indicates an inline ad.

POP

Indicates a popup ad.

PRE_ROLL_VIDEO

Indicates a pre-roll video ad.

SQUARE

Indicates a square ad.

VERTICAL

Indicates a vertical ad.

 

ExpansionDirection Enum

This enum indicates the direction in which an expandable ad will expand.

It supports the following values:

                       

Values

Description

DOWN

Indicates that the expandable ad will expand in the downward direction.

LEFT

Indicates that the expandable ad will expand in the left direction.

RIGHT

Indicates that the expandable ad will expand in the right direction.

UP

Indicates that the expandable ad will expand in the upward direction.

 

FoldPlacement Enum

This enum indicates the placement of the ad with respect to the fold.

It supports the following values:

                       

Values

Description

ABOVE

Indicates that the ad will be displayed above the fold.

BELOW

Indicates that the ad will be displayed below the fold.

PARTIALLY_ABOVE

Indicates that the ad will be displayed partially above the fold.

UNKNOWN

Indicates that the fold placement of the ad is unknown.

 

PagePlacement Enum

This enum indicates the placement of the ad with respect to the Web page.

It supports the following values:

                               

Values

Description

BOTTOM

Indicates that the ad will be displayed at the bottom of the page.

LEFT

Indicates that the ad will be displayed at the left of the page.

MIDDLE

Indicates that the ad will be displayed at the middle of the page.

NOT_SURE

Indicates that the placement of the ad with respect to the page is not defined.

RIGHT

Indicates that the ad will be displayed at the right of the page.

TOP

Indicates that the ad will be displayed at the top of the page.

 

Platform Enum

This enum indicates the type of platform on which the ad will be served. It supports the following values:

 

Values

Description

MOBILE_WEB

Indicates a Web page viewed on a mobile device.

MOBLIE_APP_IOS

Indicates an iOS-based mobile application.

MOBLIE_APP_ANDROID

Indicates an Android-based mobile application.

WEB

Indicates a Web page viewed on a computer.

 

adPlacementToAdTag

This method allows you to add an ad placement to an ad tag 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 toGetting Started with PubMatic APIs 

publisherId

Long

Mandatory

Indicates the ID of the publisher for which you want to add an ad tag's placement.

siteId

Long

Mandatory

Indicates the ID of the publisher's Web site for which you want to add an ad tag's placement.

adTAdTagPlacement

AdTagPlacement

Mandatory

Indicates the details of the ad tag placement which you want to add.

 

Output

This method generates the output data as a AdTagPlacement bean.

createAdTagforSite

This method allows you to create an ad tag for a specific publisher's Web site.

 

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 for which you want to add an ad tag.

siteId

Long

Mandatory

Indicates the ID of the publisher's Web site for which you want to add an ad tag.

adTag

AdTag

Mandatory

Indicates the details of the ad tag which you want to add.

adTAdTagPlacement

AdTagPlacement

Mandatory

Indicates the details of the ad tag placement for the corresponding ad tag.

 

Output

This method generates the output data as a AdTag bean.

 

deleteAdTagForSite

This method allows you to remove an ad tag for a specific publisher's Web site.

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 for which you want to delete an ad tag.

siteId

Long

Mandatory

Indicates the ID of the publisher's Web site for which you want to delete an ad tag.

adTagId

Long

Mandatory

Indicates the ID of the ad tag which you want to delete.

 

Output

This method generates the output data as a AdTag bean.

 

removePlacementFromAdTag

This method allows you to delete an ad placement from an ad tag 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 for which you want to delete an ad tag's placement.

siteId

Long

Mandatory

Indicates the ID of the publisher's Web site for which you want to delete an ad tag's placement.

adTAdTagPlacement

AdTagPlacement

Mandatory

Indicates the details of the ad tag placement which you want to delete.

 

Output

This method generates the output data as a AdTagPlacement bean.

 

updateAdTagForSite

This method allows you to modify the details of an ad tag belonging to a specific publisher's Web site.

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 for which you want to update an ad tag.

siteId

Long

Mandatory

Indicates the ID of the publisher's Web site whose ad tag's details you want to modify.

adTag

AdTag

Mandatory

Indicates the details of the ad tag which you want to add.

 

Output

This method generates the output data as a AdTag bean.

 

updateAdTagPlacement

This method allows you to modify the details of an ad tag's placement 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 for which you want to update an ad tag's placement.

siteId

Long

Mandatory

Indicates the ID of the publisher's Web site for which you want to update an ad tag's placement.

adTAdTagPlacement

AdTagPlacement

Mandatory

Indicates the details of the ad tag placement whose details you want to modify.

 

Output

This method generates the output data as a AdTagPlacement bean.

 

Exception

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

Attachments

    Outcomes