PublisherSiteService

Document created by pubmatic-archivist on Mar 27, 2017Last modified by pubmatic-archivist on Sep 16, 2017
Version 8Show Document
  • View in full screen mode

website's

This interface allows you to retrieve the details of the publisher's site, and the ad categories to be excluded from the PubMatic system.

 

It includes the following methods:

 

Method

Description

createPublisherSiteThis method allows you to add a website's details belonging to a publisher to the PubMatic system.
getMobileApplicationThis method allows you to retrieve the mobile application's details for a specific publisher and its website.

getPublisherSites

This method allows you to retrieve the details of a publisher's site.

getRestrictedAdCategories

This method allows you to retrieve the list of ad categories to be excluded for a specific publisher and its site.

setMobileApplicationThis method allows you to create/delete/update the mobile application’s details only for the given site with platform Type as either MOBLIE_APP_ANDROID or MOBLIE_APP_IOS.

setPublisherSiteAsDefault

This method allows you to mark a specific website as the default site for the given publisher's account.

setRestrictedAdCategories

This method allows you to specify the ad categories restricted for a publisher's website.

updatePublisherSite

This method allows you to modify a website's details belonging to a publisher in the PubMatic system.

createPublisherSite

 

This method allows you to add a website's details belonging to a publisher to the PubMatic system.

Note: After creating a site with platform as either MOBILE_APP_IOS or MOBILE_APP_ANDROID, you can then add or update the live application's details using the setMobileApplication method. Providing this mobile application's information to PubMatic will help to increase the monetization of the inventory.

 

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 whom you want to add a new site.

domainName

String

Mandatory

Indicates the name of the publisher's website.

siteUrl

String

Mandatory

Indicates the URL of the publisher's website.

verticalId

Long

Mandatory for non-IAB publishers

Indicates the ID of the vertical to which the publisher's website belongs.

 

Note: This parameter should be used only by non-IAB publishers. IAB-enabled publishers should use iabPrimaryVerticalId and iabSecondaryVerticalIds.

microVerticalId

Long

Optional for non-IAB publishers

Indicates the ID of the micro-vertical to which the publisher's website belongs.

iabPrimaryVerticalIdStringMandatory for IAB-enabled publishers

Indicates the IAB Category ID[Tier-1] to which the publisher's v belongs. Maximum limit: 1.

Note: This parameter is not required for non-IAB publishers.
iabSecondaryVerticalIdsStringOptional for IAB-enabled publishers

Indicates the IAB Category IDs[Tier-2] to which the publisher's website belongs. Maximum limit: 3.

Example: IAB1-1;IAB1-2;IAB1-3

monthlyImpressions

Long

Mandatory

Indicates the number of impressions received at a monthly level on the publisher's website.

platform

Platform

Mandatory

Indicates the type of platform used to access the publisher's website and for which the PubMatic system will be used to manage the yield optimization.

privacyPolicyUrl

String

Optional

Indicates the URL for the privacy policy of the publisher's website.

isDefault

Boolean

Optional

Indicates whether this website should be marked as the default site for the publisher. Possible options are true and false.

isCoppaCompliantBooleanOptional

Indicates whether this site contains content for children below 13 years of age and the impressions served on this site should be COPPA-compliant or not.

  • The United States Federal Trade Commission has changed the compliance rules for the Children’s Online Privacy Protection Act (“COPPA”), effective July 1, 2013. The proposal effects websites and applications that have been identified as: (1) directed to users under 13 years of age; or (2) collecting information from users actually known to be under 13 (collectively “Children’s Sites”).
  • The FTC has written a comprehensive FAQ on complying with COPPA at http://business.ftc.gov/documents/Complying-with-COPPA-Frequently-Asked-Questions.

 

Output

This method generates the output data as a PublisherSite bean.

 

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.

 

PublisherSite Bean

 

This bean contains the details of a website.

 

Members

                                                             

Field

Type

Description

iabPrimaryVerticalList

IAB Category

Indicates the details of the site's IAB Primary Vertical. (Field will be populated only for IAB-enabled publishers.)
iabSecondaryVerticalList

IAB Category

Indicates the details of the site's IAB Secondary Vertical. (Field will be populated only for IAB-enabled publishers.)

microVertical

MicroVertical

Indicates the details of the site's micro-vertical. (Field will be populated only for non-IAB publishers.)

monthlyImpressions

Long

Indicates the number of impressions available at a monthly level on the new site.

platform

Platform

Indicates the platform on which the ad will be displayed.

privacyPolicyUrl

String

Indicates the URL of the publisher's privacy policy.

publisherId

Long

Indicates the ID of the publisher.

siteDomain

SiteDomain

Indicates the domain details of a website.

siteId

Long

Indicates the ID of the publisher's site.

siteUrl

String

Indicates the URL of the publisher's site.

vertical

Vertical

Indicates the details of the site's vertical. (Field will be populated only for non-IAB publishers.)

 

MicroVertical Bean

This bean contains the details of a micro-vertical.

 

Members

  

Field

Type

Description

microVerticalId

Long

Indicates the unique ID of the micro-vertical.

name

String

Indicates the name of the micro-vertical.

 

SiteDomain Bean

This bean contains the domain details of a website. The SiteDomain bean is included in the PublisherSite bean.

 

Members

                         

Field

Type

Description

domainName

String

Indicates the domain name of the site.

publisherId

Long

Indicates the ID of the publisher.

siteDomainId

Long

Indicates the ID of the site domain.

 

Vertical Bean

This bean contains the details of a vertical.

 

Members

                    

Field

Type

Description

verticalId

Long

Indicates the unique ID of the vertical.

name

String

Indicates the name of the vertical.

 

getMobileApplication

This method allows you to retrieve the mobile application’s details for a specific publisher and its website.

Input Parameters

Parameters

Type

Status

Description

publisherId

Long

Mandatory

Indicates the ID of the publisher whose mobile application's details you want to retrieve.

siteId

Long

Mandatory

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

 

Output

This method generates the output data as a MobileAPP bean.

 

MobileAPP Bean

This bean contains the details of a mobile application.

 

Members

                                                   

Field

Type

Description

applicationIdStringIndicates the unique ID of the application on the application (app) store.
applicationNameStringIndicates the name of the mobile application.
appStoreUrlStringIndicates the app store's URL for the given mobile application.
bundleStringIndicates the bundle name of the application.
primaryCategoryStringIndicates the primary category of the application for the respective platform.
secondaryCategoriesStringIndicates one or more secondary categories (separated by comma) of the application, if available, for the respective platform.
paidbooleanIndicates whether the application is paid or free.
versionStringIndicates the version of the application.
richMediaCompliancesSET<RichMediaCompliance>Indicates the list of rich media compliance supported by the application.

 

RichMediaCompliance Bean

This enum indicates the type of rich media compliance supported by the mobile application. It supports the following values:

 

Values   Description
MRAID_1_0Indicates MRAID 1.0 compliance.
ORMMAIndicates ORMMA compliance.
MRAID_2_0

Indicates MRAID 2.0 compliance.

 

getPublisherSites

This method allows you to retrieve the details of a publisher's 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 whom you want to add a new site.

siteIds

List of Long

Optional

Indicates a list of IDs of specific sites whose information you want to retrieve.

Note: If this value is not specified, then this method retrieves the details of all the sites for the specified publisher from the PubMatic system.

 

Output

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

 

getRestrictedAdCategories

 

This method allows you to retrieve the list of ad categories restricted for a specific publisher and its website.

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 whom you want to add a new site.

siteId

Long

Mandatory

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

 

Output

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

 

AdCategory Bean

This bean contains the details of an ad category.

 

Members

                    

Field

Type

Description

id

Long

Indicates the unique ID of the ad category.

name

String

Indicates the name of the ad category.

 

setMobileApplication

This method allows you to create/delete/update the mobile application’s details only for the given site with platform

Type as either MOBLIE_APP_ANDROID or MOBLIE_APP_IOS.

Input Parameters

Parameters

Type

Status

Description

publisherId

Long

Mandatory

Indicates the ID of the publisher for whom you want to add a new site.

siteId

Long

Mandatory

Indicates the ID of the publisher's website for which you want to mark as the default website for the publisher's account.

appStoreURLStringOptionalApp store URL for live application
NOTE:If this null then we will remove application associated with site.
richMediaCompliancesSET<RichMediaCompliance>OptionalList of rich media compliance for application

 

Output

This method generates the output data as a MobileAPP bean.

 

setPublisherSiteAsDefault

This method allows you to mark a specific website as the default site for the given publisher's account.

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 whom you want to add a new site.

siteId

Long

Mandatory

Indicates the ID of the publisher's website for which you want to mark as the default website for the publisher's account.

 

Output

This method generates the output data as a PublisherSite bean.

 

setRestrictedAdCategories

This method allows you to specify the ad categories restricted for a 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 whom you want to add a new site.

siteId

Long

Mandatory

Indicates the ID of the publisher's Web site for which you want to set the restricted ad categories.

adCategoryIds

List of Long

Mandatory

Indicates a list of IDs of specific ad categories which you want to restrict on the given Web site.

 

Output

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

 

updatePublisherSite

This method allows you to modify a Web site's details belonging to a publisher in the PubMatic system.

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 whom you want to add a new site.

siteId

Long

Mandatory

Indicates the Id of the publisher's Web site whose details you want to update.

domainName

String

Mandatory

Indicates the name of the publisher's Web site.

verticalId

Long

Mandatory for non-IAB publishers

Indicates the ID of the vertical to which the publisher's Web site belongs.

Note: This parameter should be used only by non-IAB publishers. IAB-enabled publishers should use iabPrimaryVerticalId and iabSecondaryVerticalIds.

microVerticalId

Long

Optional for non-IAB publishers

Indicates the ID of the micro-vertical to which the publisher's Web site belongs.

iabPrimaryVerticalIdStringMandatory for IAB-enabled publishers

Indicates the IAB Category ID[Tier-1] to which the publisher's Web site belongs. Maximum limit: 1.

Note: This parameter is not required for non-IAB publishers.
iabSecondaryVerticalIdsStringOptional for IAB-enabled publishers

Indicates the IAB Category IDs[Tier-2] to which the publisher's Web site belongs. Maximum limit: 3.

Example: IAB1-1;IAB1-2;IAB1-3

monthlyImpressions

Long

Mandatory

Indicates the number of impressions received at a monthly level on the publisher's Web site.

privacyPolicyUrl

String

Optional

Indicates the URL for the privacy policy of the publisher's Web site.

 

Output

This method generates the output data as a PublisherSite bean.

 

Exception

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

Attachments

    Outcomes