PublisherAccountService

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

This interface allows you to retrieve the publisher's primary information, contact information, payment information, tax information, default currency and basic settings from the PubMatic system.

It includes the following methods:

                                                         

Method

Description

getPublisher

This method allows you to retrieve the primary information of all the publishers or a specific publisher.

getPublisherContact

This method allows you to retrieve the contact information of a specific publisher.

getPublisherCurrency

This method allows you to retrieve the default currency details of a specific publisher.

getPublisherPaymentDetails

This method allows you to retrieve the payment details of a specific publisher.

getPublisherSettings

This method allows you to retrieve the basic settings of a specific publisher.

getPublisherTaxDetail

This method allows you to retrieve the tax details of a specific publisher.

updatePublisher

This method allows you to update the primary information of a specific publisher.

updatePublisherContact

This method allows you to update the contact information of a publisher.

updatePublisherCurrency

This method allows you to update the currency preferences of a publisher.

updatePublisherPaymentContact

This method allows you to update the billing contact information of a publisher.

updatePublisherPaymentMethods

This method allows you to update the payment method details of a publisher.

updatePublisherSetting

This method allows you to update the basic settings of a publisher.

updatePublisherTaxDetails

This method allows you to update the tax details of a publisher.

 

getPublisher

This method allows you to retrieve the primary information of all the publishers or 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 

publisherIds

List of Long

Optional

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

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

 

Output

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

 

Publisher Bean

This bean contains the details of a publisher.

Members  

Field

Type

Description

companyName

String

Indicates the name of the publisher.

email

String

Indicates the e-mail address of the user operating the publisher's account.

firstName

String

Indicates the first name of the user.

lastName

String

Indicates the last name of the user.

publisherId

Long

Indicates the unique ID of the publisher.

publisherType

PublisherType

Indicates the type of the publisher.

signupTime

String

Indicates the timestamp at which the publisher's account was created in the PubMatic system.

url

String

Indicates the URL of the publisher's Web site.

 

PublisherType Enum

 

This enum indicates the type of a publisher.

It supports the following values:

                   

Values

Description

ALL

Indicates all types of publishers.

SELF-SERVED

Indicates a self served publisher.

VIP

Indicates a premium publisher.

 

getPublisherContact

This method allows you to retrieve the contact information of 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.

 

Output

This method generates the output data as a Contact bean.

 

Contact Bean

This bean contains the contact details of a publisher.

Members

  

Field

Type

Description

city

String

Indicates the name of the city of the address.

country

String

Indicates the name of the country of the address.

phone

String

Indicates a phone number.

publisherId

Long

Indicates the ID of the publisher for whom the given contact details are applicable.

state

String

Indicates the name of the state.

streetOne

String

Indicates the first line of the address.

streetTwo

String

Indicates the second line of the address.

streetThree

String

Indicates the third line of the address.

zipcode

String

Indicates the zip code of the address.

 

getPublisherCurrency

 

This method allows you to retrieve the default currency details of 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.

 

Output

This method generates the output data as a Currency enum.

 

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

 

getPublisherPaymentDetails

 

This method allows you to retrieve the payment details of 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.

 

Output

This method generates the output data as a PublisherPaymentDetails bean.

 

PublisherPaymentDetails Bean

 

This bean contains the payment details of a publisher.

Members

  

Field

Type

Description

publisherPaymentContact

Contact

Indicates the contact information of the payer.

publisherPaymentMethods

PublisherPaymentMethods

Indicates the publisher's payment details.

 

getPublisherSettings

This method allows you to retrieve the basic settings of 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.

settingTypes

List of SettingType

Mandatory

Indicates the type of publisher settings which you want to retrieve.

 

Output

This method generates the output data as a PublisherSetting bean.

 

SettingType Enum

This enum indicates the type of settings.

It supports the following values:

               

Values

Description

DEFAULT_HANDLED

Indicates whether handling of defaults has been enabled for the publisher or not.

MANUAL_REPORT_ENABLED

Indicates whether manual reports have been enabled for the publisher or not.

 

PublisherSetting Bean

This bean contains the details of a publisher's basic settings.

 

Members

                    

Field

Type

Description

isEnabled

Boolean

Indicates whether the specified setting is enabled for the publisher or not.

settingType

SettingType

Indicates the type of setting.

 

getPublisherTaxDetails

 

This method allows you to retrieve the tax details of 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.

 

Output

This method generates the output data as a PublisherTaxInfo bean.

 

PublisherTaxInfo Bean

This bean contains the details of a publisher's basic settings.

 

Members

                         

Field

Type

Description

publisherId

Long

Indicates the ID of the publisher whose tax details are included in this bean.

taxType

TaxType

Indicates the type of tax details of a publisher.

taxId

String

Indicates the ID of the type of tax.

TaxType Enum

This enum indicates the type of tax details of a publisher.

It supports the following values:

                   

Values

Description

EIN

Indicates the Employer Identification Number (EIN) of the publisher.

SSN

Indicates the Social Security Number (SSN) of the publisher.

TIN

Indicates the Taxpayer Identification Number (TIN) of the publisher.

 

updatePublisher

 

This method allows you to update the primary information of 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.

firstName

String

Mandatory

Indicates the first name of the publisher.

lastName

String

Mandatory

Indicates the last name of the publisher.Publisher Bean

companyName

String

Mandatory

Indicates the name of the publisher's organization.

 

Output

This method generates the output data as a Publisher bean.

 

updatePublisherContact

This method allows you to update the contact information of a 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.

publisherContact

Contact

Mandatory

Indicates the contact information of the publisher.

isPaymentContactDifferent

Boolean

Mandatory

Indicates whether the billing address of the publisher is different from its mailing address or not. Possible options are 0 (no) and 1 (yes).

 

Output

This method generates the output data as a Contact bean.

 

updatePublisherCurrency

This method allows you to update the currency preferences of a 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.

currency

Currency

Mandatory

Indicates the type of currency to be used for this publisher.

 

Output

This method generates the output data as a Currency enum.

 

updatePublisherPaymentContact

This method allows you to update the billing contact information of a 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.

publisherPaymentContact

Contact

Mandatory

Indicates the billing contact information of the publisher.

 

Output

This method generates the output data as a Contact bean.

updatePublisherPaymentMethods

 

This method allows you to update the payment method details of a 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.

paymentMethods

PublisherPaymentMethods

Mandatory

Indicates the payment method details of the publisher.

 

Output

This method generates the output data as a PublisherPaymentMethods bean.

 

PublisherPaymentMethods Bean

This bean contains the payment details of a publisher.

Members

                                        

Field

Type

Description

ach

ACH

Indicates the details of a payment made through an Automated Clearing House (ACH).

check

Check

Indicates the details of a payment made through a check

paypal

PayPal

Indicates the details of a payment made through PayPal.

preferredCurrency

Currency

Indicates the currency preferred for the payment.

preferredPaymentMethod

PaymentMethod

Indicates the method by which the payment has been made to the publisher.

wireTransfer

WireTransfer

Indicates the details of a payment made through a wire transfer

 

ACH Bean

This bean contains the details of a payment made through an Automated Clearing House (ACH). The ACH bean is included in the PublisherPaymentMethods bean.

 

Members

  

Field

Type

Description

beneficiaryName

String

Indicates the name of the publisher in the ACH transaction.

bankName

String

Indicates the name of the publisher's bank.

bankAddress

String

Indicates the address of the publisher's bank.

routingNumber

String

Indicates the routing number of the publisher's bank.

beneficiaryBankAccountNumber

String

Indicates the bank account number of the publisher.

ACHInstructions

String

Indicates the instructions specified for the ACH transaction.

 

Check Bean

This bean contains the details of a payment made through a check. The Check bean is included in the PublisherPaymentMethods bean.

 

Members

  

Field

Type

Description

payableTo

String

Indicates the name of the publisher mentioned in the check.

 

PayPal Bean

This bean contains the details of a payment made through PayPal. The PayPal bean is included in the PublisherPaymentMethods bean. 

 

Members

  

Field

Type

Description

payPalId

String

Indicates the account ID of the publisher's PayPal account.

 

WireTransfer Bean

This bean contains the details of a payment made through a wire transfer. The WireTransfer bean is included in the PublisherPaymentMethods bean.

 

Members

                                             

Field

Type

Description

beneficiaryName

String

Indicates the name of the publisher in the wire transfer.

bankName

String

Indicates the name of the publisher's bank.

bankAddress

String

Indicates the address of the publisher's bank.

routingNumber

String

Indicates the routing number of the publisher's bank.

beneficiaryBankAccountNumber

String

Indicates the bank account number of the publisher.

wireTransferInstructions

String

Indicates the instructions specified for the wire transfer.

SWIFTCode

String

Indicates the Society for Worldwide Interbank Financial Telecommunication (SWIFT) code used for the wire transfer.

 

updatePublisherSetting

This method allows you to update the basic settings of a 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.

settingType

SettingType

Optional

Indicates the type of publisher settings which you want to update.

status

Boolean

Optional

Indicates the status of the publisher setting which you want to update.

 

Output

This method generates the output data as a PublisherSetting bean.

 

updatePublisherTaxDetails

This method allows you to update the tax details of a 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 the Obtaining the PubMatic access token topic.

publisherId

Long

Mandatory

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

taxType

TaxType

Mandatory

Indicates the type of tax details of the publisher which you want to update.

taxId

String

Mandatory

Indicates the value of the tax detail type which you want to update.

 

Output

This method generates the output data as a PublisherTaxInfo bean.

 

Exception

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

Attachments

    Outcomes